new asset builder flow

makes use of react suspense to asynchronously build assets on the fly within components (!!!)

packages/docs/package.json

@@ -5,13 +5,14 @@
   "scripts": {
     "prepare": "node ./scripts/fix-heroicons.js",
     "serve": "esmo --experimental-import-meta-resolve --experimental-json-modules --no-warnings --enable-source-maps src/main.tsx | pino-colada",
-    "dev": "nodemon --exec \"pnpm serve\" --watch src --ext ts,tsx,md,css",
+    "dev": "nodemon --inspect --exec \"pnpm serve\" --watch src --ext ts,tsx,md,css",
     "start": "NODE_ENV=production pnpm serve",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@heroicons/react": "^1.0.5",
     "@tailwindcss/typography": "^0.5.0",
+    "alpinejs": "^3.7.1",
     "clsx": "^1.1.1",
     "compression": "^1.7.4",
     "esbuild": "^0.14.10",
@@ -46,6 +47,7 @@
     "browser-sync": "^2.27.7",
     "execa": "^6.0.0",
     "nodemon": "^2.0.15",
+    "react-ssr-prepass": "^1.5.0",
     "rxjs": "^7.5.1",
     "tsup": "^5.11.10",
     "type-fest": "^2.8.0",

packages/docs/src/asset-builder/asset-builder.ts

@@ -1,17 +1,16 @@
-import { RequestHandler } from "express"
+import express, { RequestHandler } from "express"
 import { createHash } from "node:crypto"
-import { readFileSync } from "node:fs"
+import { mkdir, rm, writeFile } from "node:fs/promises"
-import { mkdir, stat, writeFile } from "node:fs/promises"
+import { dirname, join, parse } from "node:path"
-import { dirname, extname, join, parse } from "node:path"
 
-export type Asset = {
+type Asset = {
-  file: string
+  inputFile: string
+  outputFile: string
   url: string
-  content: Buffer
 }
 
 export type AssetTransformer = {
-  transform: (asset: Asset) => Promise<AssetTransformResult | undefined>
+  transform: (inputFile: string) => Promise<AssetTransformResult | undefined>
 }
 
 export type AssetTransformResult = {
@@ -20,68 +19,75 @@ export type AssetTransformResult = {
 }
 
 export class AssetBuilder {
-  // map of asset urls to asset objects
   private library = new Map<string, Asset>()
 
-  constructor(
+  private constructor(
     private cacheFolder: string,
     private transformers: AssetTransformer[],
   ) {}
 
-  // accepts a path to a file, then returns a url to where the built file will be served
+  static async create(cacheFolder: string, transformers: AssetTransformer[]) {
-  // the url will include a hash of the file contents
+    await rm(cacheFolder, { recursive: true })
-  file(file: string | URL): string {
+    return new AssetBuilder(cacheFolder, transformers)
-    if (file instanceof URL) {
+  }
-      file = file.pathname
-    }
 
-    const existing = this.library.get(file)
+  async build(inputFile: string | URL, name?: string): Promise<string> {
+    inputFile = normalizeAsFilePath(inputFile)
+
+    const existing = this.library.get(inputFile)
     if (existing) {
       return existing.url
     }
 
-    const content = readFileSync(file)
+    const transformResult = await this.transform(inputFile)
-    const hash = createHash("sha256").update(content).digest("hex").slice(0, 8)
+
+    const hash = createHash("sha256")
+      .update(transformResult.content)
+      .digest("hex")
+      .slice(0, 8)
+
+    const parsedInputFile = parse(inputFile)
+    const url = `/${name || parsedInputFile.name}.${hash}${parsedInputFile.ext}`
+    const outputFile = join(this.cacheFolder, url)
+
+    await ensureWrite(outputFile, transformResult.content)
+    this.library.set(inputFile, { inputFile, outputFile, url })
 
-    const { name, ext } = parse(file)
-    const url = `/${name}.${hash}${ext}`
-    this.library.set(url, { file, url, content })
     return url
   }
 
-  middleware(): RequestHandler {
+  local(inputFile: string | URL, name?: string): string {
-    return async (req, res, next) => {
+    inputFile = normalizeAsFilePath(inputFile)
-      try {
-        const asset = this.library.get(req.path)
-        if (!asset) return next()
 
-        const file = join(this.cacheFolder, asset.url)
+    const asset = this.library.get(inputFile)
-        const extension = extname(file)
+    if (asset) {
-
+      return asset.url
-        const stats = await stat(file).catch(() => undefined)
-        if (!stats?.isFile()) {
-          const transformResult = await this.transform(asset)
-          if (!transformResult) return next()
-
-          await mkdir(dirname(file), { recursive: true })
-          await writeFile(file, transformResult.content)
-        }
-
-        res
-          .status(200)
-          .type(extension.endsWith("tsx") ? "text/javascript" : extension)
-          .header("Cache-Control", "public, max-age=604800, immutable")
-          .sendFile(file)
-      } catch (error) {
-        next(error)
-      }
     }
+
+    throw this.build(inputFile, name)
   }
 
-  private async transform(asset: Asset) {
+  middleware(): RequestHandler {
+    return express.static(this.cacheFolder, {
+      immutable: true,
+      maxAge: "1y",
+    })
+  }
+
+  private async transform(inputFile: string) {
     for (const transformer of this.transformers) {
-      const result = await transformer.transform(asset)
+      const result = await transformer.transform(inputFile)
       if (result) return result
     }
+    throw new Error(`No transformers found for ${inputFile}`)
   }
 }
+
+async function ensureWrite(file: string, content: string) {
+  await mkdir(dirname(file), { recursive: true })
+  await writeFile(file, content)
+}
+
+function normalizeAsFilePath(file: string | URL) {
+  return new URL(file, "file:").pathname
+}

packages/docs/src/asset-builder/transform-esbuild.ts

@@ -1,19 +1,12 @@
 import { build } from "esbuild"
-import { readFile } from "node:fs/promises"
-import { dirname } from "node:path"
 import { AssetTransformer } from "./asset-builder.js"
 
 export const transformEsbuild: AssetTransformer = {
-  async transform(asset) {
+  async transform(inputFile) {
-    if (asset.file.match(/\.tsx?$/)) {
+    if (inputFile.match(/\.[jt]sx?$/)) {
       const scriptBuild = await build({
+        entryPoints: [inputFile],
         bundle: true,
-        stdin: {
-          contents: await readFile(asset.file, "utf-8"),
-          sourcefile: asset.file,
-          loader: "tsx",
-          resolveDir: dirname(asset.file),
-        },
         target: ["chrome89", "firefox89"],
         format: "esm",
         write: false,

packages/docs/src/asset-builder/transform-postcss.ts

@@ -1,14 +1,17 @@
+import { readFile } from "fs/promises"
 import postcss from "postcss"
 import tailwindcss from "tailwindcss"
 import { AssetTransformer } from "./asset-builder.js"
 
 export const transformPostCss: AssetTransformer = {
-  async transform(asset) {
+  async transform(inputFile) {
-    if (!asset.file.match(/\.css$/)) return
+    if (!inputFile.match(/\.css$/)) return
+
+    const result = await postcss(tailwindcss).process(
+      await readFile(inputFile),
+      { from: inputFile },
+    )
 
-    const result = await postcss(tailwindcss).process(asset.content, {
-      from: asset.file,
-    })
     return {
       content: result.css,
       type: "text/css",

packages/docs/src/html.tsx

@@ -7,6 +7,9 @@ const tailwindCssPath = new URL(
   await import.meta.resolve!("tailwindcss/tailwind.css"),
 ).pathname
 
+const alpineJs = new URL(await import.meta.resolve!("alpinejs/dist/cdn.js"))
+  .pathname
+
 export function Html({
   title = "Reacord",
   description = packageJson.description,
@@ -35,13 +38,15 @@ export function Html({
           as="style"
           href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@500&family=Rubik:ital,wght@0,300;0,400;0,500;1,300;1,400;1,500&display=swap"
         />
-        <link rel="stylesheet" href={assets.file(tailwindCssPath)} />
+        <link rel="stylesheet" href={assets.local(tailwindCssPath)} />
         <link
           rel="stylesheet"
-          href={assets.file(new URL("ui/prism-theme.css", import.meta.url))}
+          href={assets.local(new URL("ui/prism-theme.css", import.meta.url))}
         />
 
         <title>{title}</title>
+
+        <script defer src={assets.local(alpineJs, "alpine")} />
       </head>
       <body>{children}</body>
     </html>

packages/docs/src/main.tsx

@@ -7,6 +7,7 @@ import pino from "pino"
 import pinoHttp from "pino-http"
 import * as React from "react"
 import { renderToStaticMarkup } from "react-dom/server.js"
+import ssrPrepass from "react-ssr-prepass"
 import { AssetBuilderProvider } from "./asset-builder/asset-builder-context.js"
 import { AssetBuilder } from "./asset-builder/asset-builder.js"
 import { transformEsbuild } from "./asset-builder/transform-esbuild.js"
@@ -20,14 +21,15 @@ import { Landing } from "./landing/landing"
 const logger = pino()
 const port = process.env.PORT || 3000
 
-const assets = new AssetBuilder(fromProjectRoot(".asset-cache"), [
+const assets = await AssetBuilder.create(fromProjectRoot(".asset-cache"), [
   transformEsbuild,
   transformPostCss,
 ])
 
-export function sendJsx(res: Response, jsx: React.ReactElement) {
+async function render(res: Response, element: React.ReactElement) {
-  res.set("Content-Type", "text/html")
+  element = <React.Suspense fallback={null}>{element}</React.Suspense>
-  res.send(`<!DOCTYPE html>\n${renderToStaticMarkup(jsx)}`)
+  await ssrPrepass(element)
+  res.type("html").send(`<!DOCTYPE html>\n${renderToStaticMarkup(element)}`)
 }
 
 const errorHandler: ErrorRequestHandler = (error, request, response, next) => {
@@ -44,7 +46,7 @@ const router = Router()
     const { html, data } = await renderMarkdownFile(
       new URL(`guides/${req.params[0]}.md`, import.meta.url).pathname,
     )
-    sendJsx(
+    await render(
       res,
       <AssetBuilderProvider value={assets}>
         <Html title={`${data.title} | Reacord`} description={data.description}>
@@ -54,8 +56,8 @@ const router = Router()
     )
   })
 
-  .get("/", (req, res) => {
+  .get("/", async (req, res) => {
-    sendJsx(
+    await render(
       res,
       <AssetBuilderProvider value={assets}>
         <Html>
@@ -70,7 +72,7 @@ const router = Router()
 const server = express()
   .use(router)
   .listen(port, () => {
-    logger.info(`Server is running on https://localhost:${port}`)
+    logger.info(`Server is running on http://localhost:${port}`)
   })
 
 const terminator = httpTerminator.createHttpTerminator({ server })

pnpm-lock.yaml

@@ -49,6 +49,7 @@ importers:
       '@types/react-dom': ^17.0.9
       '@types/tailwindcss': ^3.0.0
       '@types/wait-on': ^5.3.1
+      alpinejs: ^3.7.1
       autoprefixer: ^10.4.1
       browser-sync: ^2.27.7
       clsx: ^1.1.1
@@ -71,6 +72,7 @@ importers:
       reacord: workspace:*
       react: ^18.0.0-rc.0
       react-dom: ^18.0.0-rc.0
+      react-ssr-prepass: ^1.5.0
       rxjs: ^7.5.1
       tailwindcss: ^3.0.8
       tsup: ^5.11.10
@@ -80,6 +82,7 @@ importers:
     dependencies:
       '@heroicons/react': 1.0.5_react@18.0.0-rc.0
       '@tailwindcss/typography': 0.5.0_tailwindcss@3.0.8
+      alpinejs: 3.7.1
       clsx: 1.1.1
       compression: 1.7.4
       esbuild: 0.14.10
@@ -113,6 +116,7 @@ importers:
       browser-sync: 2.27.7
       execa: 6.0.0
       nodemon: 2.0.15
+      react-ssr-prepass: 1.5.0_react@18.0.0-rc.0
       rxjs: 7.5.1
       tsup: 5.11.10_typescript@4.5.4
       type-fest: 2.8.0
@@ -1370,6 +1374,16 @@ packages:
       eslint-visitor-keys: 3.1.0
     dev: true
 
+  /@vue/reactivity/3.1.5:
+    resolution: {integrity: sha512-1tdfLmNjWG6t/CsPldh+foumYFo3cpyCHgBYQ34ylaMsJ+SNHQ1kApMIa8jN+i593zQuaw3AdWH0nJTARzCFhg==}
+    dependencies:
+      '@vue/shared': 3.1.5
+    dev: false
+
+  /@vue/shared/3.1.5:
+    resolution: {integrity: sha512-oJ4F3TnvpXaQwZJNF3ZK+kLPHKarDmJjJ6jyzVNDKH9md1dptjC7lWR//jrGuLdek/U6iltWxqAnYOu8gCiOvA==}
+    dev: false
+
   /abab/2.0.5:
     resolution: {integrity: sha512-9IK9EadsbHo6jLWIpxpR6pL0sazTXV6+SQv25ZB+F7Bj9mJNaOc4nCRabwd5M/JwmUa8idz6Eci6eKfJryPs6Q==}
     dev: true
@@ -1452,6 +1466,12 @@ packages:
       json-schema-traverse: 0.4.1
       uri-js: 4.4.1
 
+  /alpinejs/3.7.1:
+    resolution: {integrity: sha512-OJDlhOT50+9REa4cpGHr4WlGBE9ysJEZ+IfN2xwmotUANxp1VSrYgBNBfUWJr9uQ1INhodzvi6UfIWoqQqYOnA==}
+    dependencies:
+      '@vue/reactivity': 3.1.5
+    dev: false
+
   /ansi-align/3.0.1:
     resolution: {integrity: sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==}
     dependencies:
@@ -6669,6 +6689,14 @@ packages:
       scheduler: 0.20.2
     dev: false
 
+  /react-ssr-prepass/1.5.0_react@18.0.0-rc.0:
+    resolution: {integrity: sha512-yFNHrlVEReVYKsLI5lF05tZoHveA5pGzjFbFJY/3pOqqjGOmMmqx83N4hIjN2n6E1AOa+eQEUxs3CgRnPmT0RQ==}
+    peerDependencies:
+      react: ^16.8.0 || ^17.0.0 || ^18.0.0
+    dependencies:
+      react: 18.0.0-rc.0
+    dev: true
+
   /react/17.0.2:
     resolution: {integrity: sha512-gnhPt75i/dq/z3/6q/0asP78D0u592D5L1pd7M8P+dck6Fu/jJeL6iVVK23fptSUZj8Vjf++7wXA8UNclGQcbA==}
     engines: {node: '>=0.10.0'}