@abide/abide 0.58.0 → 0.101.0

package/src/server/seedBuffer.ts

@@ -0,0 +1,293 @@
+// 41.5, 41.7 AND 41.13 — THE SEED BUFFER. A page's render calls its handlers in process; the page then
+// hydrates in a browser, re-executes its setup (41.6), and makes the same calls over the wire. Each
+// of those is answered from the value the render reached rather than by running the handler again
+// — the value itself, so a call arriving while the render's load is still in flight joins it.
+//
+// KEYED BY WHO, WHAT AND WITH WHICH ARGS (41.18): the caller's cookie, the one thing the browser's
+// call carries that the render also saw, and the handler and the `Args` key 11.24 takes. A GET's
+// query arrives as text until 19.7 coerces it, so a render that passed a number misses here and
+// the handler runs — the answer is right and the saving is lost.
+//
+// ONE CALL PER ENTRY (41.16), and a bounded life for the entries nothing takes (41.17): a page read
+// with scripting off, or by a crawler, fills entries no call will ever come for.
+//
+// 16.33 — A STREAM'S TRANSCRIPT IS THE VALUE'S OWN ACCUMULATION, held as chunks and framed when the
+// entry is taken, so it is one transcript whichever framing the call asks for. Where
+// `ABIDE_MAX_STREAM_BUFFER_SIZE` bounds it, the bytes are counted in the chunk type's default framing
+// as the chunks land, and an entry past the bound stops holding the stream — its call is then one the
+// buffer cannot answer.
+//
+// 41.12 — A CALL THE BUFFER CANNOT ANSWER RUNS THE HANDLER, AND WARNS on `abide:hydrate` where the
+// buffer can tell the call was its to answer: an entry left for other args of the same handler, one
+// past its life, or one past the transcript bound. A call for args an entry already answered is a
+// refresh, and says nothing.
+
+import { namedLogger } from '#shared/log.ts'
+import { canonicalKey } from '#shared/reactive/canonicalKey.ts'
+import {
+    chunksOfStream,
+    isReactive,
+    STREAMING,
+    streamingOrSettled,
+} from '#shared/reactive/index.ts'
+import { positiveSetting } from './config.ts'
+import { heldByApp, type PageRender } from './requestScope.ts'
+
+const HYDRATE_LOG = namedLogger('abide:hydrate')
+
+const ENCODER = new TextEncoder()
+
+const NOTHING_HELD = (): void => {}
+
+// 41.17.
+const SEED_LIFE_MS = 30_000
+
+/**
+ * How a handler's call ended, and how long it took from the call to the end.
+ *
+ * What 21.15's `server-timing` reports, whichever call it was that ran it. A stream has no end to
+ * time by then, and its `undefined` is timed where its first chunk is answered.
+ */
+export type Outcome =
+    | { settled: true; value: unknown; duration: number | undefined }
+    | { settled: false; error: unknown; duration: number }
+
+type Entry = {
+    rpc: object
+    key: string
+    // `undefined` once a stream's transcript passed `ABIDE_MAX_STREAM_BUFFER_SIZE` (16.33).
+    outcome: Promise<Outcome> | undefined
+    expires: number
+    // Cleared when the entry is taken, so an answered entry's value is not held for the rest of its life.
+    timer: ReturnType<typeof setTimeout> | undefined
+    // Stops counting a stream's transcript against its bound.
+    release: () => void
+    // 42.11 — unfiles the entry from the app whose render left it, which drops it when it stops.
+    unhold: () => void
+}
+
+// INDEXED BY THE THREE THINGS 41.18 MATCHES ON — caller, handler, args key — so a call finds its entry
+// without reading the others. A caller whose calls never match (a crawler, a render whose args the
+// wire does not reproduce) leaves every entry standing for 30 seconds, and a list read end to end
+// made each of its calls pay for all of them. Several entries under one key are taken oldest first,
+// and a key whose entries are all taken keeps its empty list while the handler has others standing,
+// which is how a refresh of it is told from a call the render never made (41.12).
+const BUFFER = new Map<string, Map<object, Map<string, Entry[]>>>()
+
+/**
+ * The sink a page's render scope reports each call into, for one caller.
+ *
+ * The sink answers `true` where the call was new to this render. A key already reported is
+ * reported once: two components reaching one invoice are one call in the browser too, since the
+ * browser's `Rpc` joins a standing call (1.8).
+ */
+export function seedFor(caller: string): PageRender['seed'] {
+    const reported = new Map<object, Set<string>>()
+    return (rpc, args, reached) => {
+        const key = seedKey(args)
+        if (key === undefined) return false
+        let keys = reported.get(rpc)
+        if (keys === undefined) {
+            keys = new Set()
+            reported.set(rpc, keys)
+        }
+        if (keys.has(key)) return false
+        keys.add(key)
+        const entry: Entry = {
+            rpc,
+            key,
+            // 1.4 — the `Reactive` is thenable, and this is its settling: the production the render
+            // had, or the one it is still waiting on.
+            outcome: outcomeOf(reached),
+            expires: Date.now() + SEED_LIFE_MS,
+            timer: undefined,
+            release: NOTHING_HELD,
+            unhold: NOTHING_HELD,
+        }
+        const bound = positiveSetting(
+            'ABIDE_MAX_STREAM_BUFFER_SIZE',
+            Number.POSITIVE_INFINITY,
+        )
+        if (Number.isFinite(bound) && isReactive(reached))
+            entry.release = boundTranscript(reached, bound, () => {
+                entry.outcome = undefined
+                entry.release = NOTHING_HELD
+            })
+        let byRpc = BUFFER.get(caller)
+        if (byRpc === undefined) {
+            byRpc = new Map()
+            BUFFER.set(caller, byRpc)
+        }
+        let byKey = byRpc.get(rpc)
+        if (byKey === undefined) {
+            byKey = new Map()
+            byRpc.set(rpc, byKey)
+        }
+        let entries = byKey.get(key)
+        if (entries === undefined) {
+            entries = []
+            byKey.set(key, entries)
+        }
+        entries.push(entry)
+        entry.unhold = heldByApp(() => drop(caller, entry))
+        // UNREF'D, so a process with nothing else to do is not kept up by entries nobody will take.
+        entry.timer = setTimeout(
+            () => drop(caller, entry),
+            SEED_LIFE_MS,
+        ).unref()
+        return true
+    }
+}
+
+/**
+ * Counts a stream's transcript as it lands; calls `over` once it passes `bound` bytes.
+ *
+ * 16.33 — IN THE CHUNK TYPE'S DEFAULT FRAMING: a binary chunk's bytes, a value's jsonl line. Read
+ * through the reader an answer uses, so nothing is copied to count it. Returns what stops counting.
+ */
+function boundTranscript(
+    reached: unknown,
+    bound: number,
+    over: () => void,
+): () => void {
+    let counting = true
+    void (async () => {
+        let bytes = 0
+        try {
+            // 9.6 — a value may only turn out to stream once its load resolves.
+            const settled = await streamingOrSettled(reached)
+            if (!counting || settled !== STREAMING) return
+            for await (const chunk of chunksOfStream(reached)) {
+                if (!counting) return
+                bytes +=
+                    chunk instanceof Uint8Array
+                        ? chunk.byteLength
+                        : ENCODER.encode(`${JSON.stringify(chunk)}\n`)
+                              .byteLength
+                if (bytes > bound) {
+                    over()
+                    return
+                }
+            }
+        } catch {
+            // A stream that failed is answered as it failed, by whichever call takes the entry.
+        }
+    })()
+    return () => {
+        counting = false
+    }
+}
+
+/**
+ * Takes the outcome this caller's render left for this handler and these args, or `undefined`.
+ *
+ * `undefined` where there is none, it has been taken, its life is over, or its transcript passed
+ * its bound. The args are keyed only once the caller is known to have entries for this handler,
+ * which a call from a page that was not rendered for it never does.
+ */
+export function takeSeed(
+    caller: string,
+    rpc: object,
+    args: unknown,
+): Promise<Outcome> | undefined {
+    const byKey = BUFFER.get(caller)?.get(rpc)
+    if (byKey === undefined) return undefined
+    const key = seedKey(args)
+    if (key === undefined) return undefined
+    const entries = byKey.get(key)
+    if (entries === undefined) {
+        const standing: string[] = []
+        for (const [other, left] of byKey)
+            if (left.length > 0) standing.push(other)
+        missed(
+            rpc,
+            key,
+            `the render made it with other args: ${standing.join(', ')}`,
+        )
+        return undefined
+    }
+    const entry = entries[0]
+    if (entry === undefined) return undefined
+    drop(caller, entry)
+    // READ AS WELL AS SWEPT: a timer can fire late, and an entry past its life answers nothing.
+    if (entry.expires <= Date.now()) {
+        missed(
+            rpc,
+            key,
+            `its entry outlived its ${SEED_LIFE_MS / 1000} seconds`,
+        )
+        return undefined
+    }
+    if (entry.outcome === undefined)
+        missed(rpc, key, 'its transcript passed ABIDE_MAX_STREAM_BUFFER_SIZE')
+    return entry.outcome
+}
+
+/** 41.12 — the warning a call the buffer was expected to answer, and did not, is logged with. */
+function missed(rpc: object, key: string, why: string): void {
+    const address = (rpc as { address?: string }).address ?? 'a handler'
+    HYDRATE_LOG.warning(
+        `the call to ${address} with args ${key} was not answered from the seed buffer, because ${why}, so the handler ran again. RULEBOOK 41.12.`,
+    )
+}
+
+/** 11.24's key, or `undefined` where 11.64 refuses the args — which the call itself then says. */
+function seedKey(args: unknown): string | undefined {
+    try {
+        return canonicalKey(args)
+    } catch {
+        return undefined
+    }
+}
+
+function drop(caller: string, entry: Entry): void {
+    clearTimeout(entry.timer)
+    entry.release()
+    entry.unhold()
+    const byRpc = BUFFER.get(caller)
+    const byKey = byRpc?.get(entry.rpc)
+    const entries = byKey?.get(entry.key)
+    if (byRpc === undefined || byKey === undefined || entries === undefined)
+        return
+    const at = entries.indexOf(entry)
+    if (at !== -1) entries.splice(at, 1)
+    for (const left of byKey.values()) if (left.length > 0) return
+    byRpc.delete(entry.rpc)
+    if (byRpc.size === 0) BUFFER.delete(caller)
+}
+
+/**
+ * How a call's reached value settles, timed from here.
+ *
+ * 1.4 — a call's `Reactive` is thenable, and this is its settling. 1.6 — A STREAMING one is read by
+ * its brand first and answered as its chunks, which `answerValue` frames as they land: settling it
+ * would be one snapshot, once the run had closed.
+ */
+export function outcomeOf(reached: unknown): Promise<Outcome> {
+    const started = performance.now()
+    // 9.6 — AND ONE THAT TURNS INTO A STREAM when its load resolves to a generator, as a handler
+    // behind rungs does: waited for as far as the turn, and never out to the run's close.
+    return (
+        isReactive(reached)
+            ? streamingOrSettled(reached)
+            : Promise.resolve(reached)
+    ).then(
+        (value): Outcome =>
+            value === STREAMING
+                ? {
+                      settled: true,
+                      value: chunksOfStream(reached),
+                      duration: undefined,
+                  }
+                : {
+                      settled: true,
+                      value,
+                      duration: performance.now() - started,
+                  },
+        (error: unknown): Outcome => ({
+            settled: false,
+            error,
+            duration: performance.now() - started,
+        }),
+    )
+}

package/src/server/serveBuild.ts

@@ -0,0 +1,198 @@
+// 38.6 and 38.11 — `abide start` and a compiled app: the built app, over http. The request path is
+// `answerRequest`'s, shared with `abide dev`; what this module is, is the SUPPLIER — where each part
+// comes from when the parts are what `abide build` produced.
+//
+// THE ROUTE TABLE IS THE BUILD'S, not this module's. `abide build` walks the tree once and writes
+// what it found, so the addresses the server answers and the addresses the client router knows
+// are two readings of one walk rather than two walks that have to agree (30.8).
+
+import { CLIENT_ADDRESS } from '#shared/ADDRESSES.ts'
+import {
+    appSources,
+    type LoadedSources,
+    type ServerTable,
+    type SourceParts,
+} from './answerRequest.ts'
+import type { Mount } from './answerRpc.ts'
+import {
+    CLIENT_DIRECTORY,
+    ENCODING_SUFFIX,
+    MANIFEST,
+    PUBLIC_DIRECTORY,
+} from './CLIENT_BUILD.ts'
+import { componentImports } from './componentImports.ts'
+import { type App, type AppOrigin, bootApp } from './createApp.ts'
+import { stopOnSignalOrFault } from './faultPolicy.ts'
+import type { Manifest } from './manifestOf.ts'
+import { namesUnder } from './namesUnder.ts'
+import {
+    ENCODINGS,
+    type Encoding,
+    negotiateEncoding,
+} from './negotiateEncoding.ts'
+import { shellUnder } from './render.ts'
+
+/**
+ * What `abide build` produced, as the parts an `App` is booted over.
+ *
+ * Read off disk by `abide start` (`loadBuild`), and out of the executable itself by a compiled app
+ * (38.11). ONE SHAPE, so the two are answered by one path and differ only in where a byte is read
+ * from — a file is a PATH in both, and `Bun.file` reads the executable's own the same way it reads
+ * the disk's.
+ */
+export type BuildParts = Omit<SourceParts, 'client' | 'explained'> & {
+    manifest: Manifest
+    /** Every file under `client/`, the precompressed copies among them, by name to its path. */
+    client: Map<string, string>
+}
+
+/**
+ * The app booted (`bootApp`) and listening, stopped on a signal or an unawaited fault.
+ *
+ * Listening on `LISTENING.server`, for the caller to say where.
+ */
+export async function serveApp(
+    origin: AppOrigin,
+    load: () => Promise<LoadedSources>,
+    port: number | undefined,
+): Promise<App> {
+    const app = await bootApp(origin, load)
+    await app.listen(port === undefined ? {} : { port })
+    // ONCE SERVING, and not before: a boot that fails is 37.6's to fail hard.
+    stopOnSignalOrFault(app)
+    return app
+}
+
+/**
+ * A loader for a handler's module, out of the app's source tree.
+ *
+ * `compiled` is where the app's components were compiled to, which a `.abide` the module imports
+ * lands on (`componentImports`).
+ */
+export function sourceModuleLoader(
+    root: string,
+    compiled: string,
+): (source: string) => Promise<Record<string, unknown>> {
+    Bun.plugin(componentImports(root, compiled))
+    return (source) => import(Bun.pathToFileURL(`${root}/${source}`).href)
+}
+
+/** The handler table a build wrote into `directory`. */
+export async function handlersIn(directory: string): Promise<Mount[]> {
+    const rpc = (await import(
+        Bun.pathToFileURL(`${directory}/rpc.ts`).href
+    )) as {
+        handlers: Mount[]
+    }
+    return rpc.handlers
+}
+
+/** What `abide build` left on disk, as the sources an `App` is booted over. */
+export async function loadBuild(options: {
+    /**
+     * The app's source root — the directory `ui/` and `server/` sit under, and the one 35.6's
+     * shell is resolved against.
+     */
+    root: string
+    /** Where `abide build` put its output. */
+    out: string
+}): Promise<LoadedSources> {
+    if (!(await Bun.file(`${options.out}/server.ts`).exists()))
+        throw new Error(
+            `abide: no build at ${options.out}. Run \`abide build\` first.`,
+        )
+    // THE BOOT READS OVERLAP: the route table, the handler table, the shell and the manifest are
+    // independent of each other.
+    //
+    // THE SHELL IS READ ONCE, at boot. `render`'s own note prices the per-render read at 98% of the
+    // op and leaves the caching to whatever server got written; this is that server. The manifest
+    // names the stylesheet only where the bundler collected one, so an app that imports none links
+    // none.
+    const [table, handlers, shell, manifest] = await Promise.all([
+        import(
+            Bun.pathToFileURL(`${options.out}/server.ts`).href
+        ) as Promise<ServerTable>,
+        handlersIn(options.out),
+        shellUnder(options.root),
+        Bun.file(`${options.out}/${MANIFEST}`).json() as Promise<Manifest>,
+    ])
+    return builtSources({
+        table,
+        handlers,
+        handlerModule: sourceModuleLoader(options.root, options.out),
+        shell,
+        manifest,
+        client: pathsUnder(`${options.out}/${CLIENT_DIRECTORY}`),
+        published: pathsUnder(`${options.out}/${PUBLIC_DIRECTORY}`),
+    })
+}
+
+/** Every file under `directory`, by the name below it to its path. */
+export function pathsUnder(directory: string): Map<string, string> {
+    const paths = new Map<string, string>()
+    for (const name of namesUnder(directory))
+        paths.set(name, `${directory}/${name}`)
+    return paths
+}
+
+/** The sources an `App` is booted over, out of the parts `abide build` produced. */
+export function builtSources(parts: BuildParts): Promise<LoadedSources> {
+    // THE BUNDLE, ENUMERATED RATHER THAN RESOLVED. A request names a file in this set or it names
+    // nothing — there is no path to normalise, so `..` is not a case that has to be got right,
+    // and what is servable is exactly what the build produced.
+    //
+    // THE PRECOMPRESSED COPIES ARE NOT ADDRESSES OF THEIR OWN. They are the same file in another
+    // encoding (38.5), so they are found under the name they encode and served as that name.
+    const suffixes = Object.values(ENCODING_SUFFIX) as string[]
+    const assets = new Map<string, Encoding[]>()
+    for (const name of parts.client.keys()) {
+        if (suffixes.some((suffix) => name.endsWith(suffix))) continue
+        const encodings: Encoding[] = []
+        for (const encoding of ENCODINGS)
+            if (parts.client.has(name + ENCODING_SUFFIX[encoding]))
+                encodings.push(encoding)
+        assets.set(name, encodings)
+    }
+
+    const framework = (
+        pathname: string,
+        request: Request,
+    ): Response | undefined => {
+        if (!pathname.startsWith(`${CLIENT_ADDRESS}/`)) return undefined
+        const name = pathname.slice(CLIENT_ADDRESS.length + 1)
+        const encodings = assets.get(name)
+        if (encodings === undefined) return undefined
+        // THE TYPE IS THE NAME'S, not the path's: a compiled app's path carries a hash the
+        // bundler put before the extension, and a `.br`'s extension names nothing.
+        const type = Bun.file(name).type
+        // 21.5 — EVERY NAME IN THE BUNDLE CARRIES A HASH OF ITS BYTES, the entry's too (38.5),
+        // so a name never answers two different files and a year is safe for all of them. A
+        // deploy is new names in a new document, never new bytes at an old address.
+        const headers: Record<string, string> = {
+            'cache-control': 'public, max-age=31536000, immutable',
+            'content-type': type,
+            vary: 'accept-encoding',
+        }
+        // 38.30 — the precompressed copy where the request takes its encoding.
+        const encoding = negotiateEncoding(
+            request.headers.get('accept-encoding'),
+            encodings,
+        )
+        if (encoding === undefined)
+            return new Response(Bun.file(parts.client.get(name) as string), {
+                headers,
+            })
+        headers['content-encoding'] = encoding
+        return new Response(
+            Bun.file(
+                parts.client.get(name + ENCODING_SUFFIX[encoding]) as string,
+            ),
+            { headers },
+        )
+    }
+    return appSources({
+        ...parts,
+        explained: undefined,
+        client: { manifest: parts.manifest, head: '', framework },
+    })
+}