diff --git a/scripts/lib/dev-release-manifest.ts b/scripts/lib/dev-release-manifest.ts new file mode 100644 index 00000000..4b718ab5 --- /dev/null +++ b/scripts/lib/dev-release-manifest.ts @@ -0,0 +1,42 @@ +import { execFileSync } from "node:child_process"; +import { readFileSync } from "node:fs"; +import path from "node:path"; + +import type { Plugin } from "vite"; + +/** Generated at dev server start; ignored with the rest of src/.generated/. */ +export const DEV_RELEASE_MANIFEST_PATH = "src/.generated/dev-release-manifest.json"; + +/** + * Serve only. The dev server answers the runtime's release-manifest request + * with scripts/write-dev-release-manifest.ts's output instead of the committed + * placeholder, so a feature that `create:feature` just added boots in + * `corepack pnpm dev` and in the dev-server browser tests. The manifest is + * written in a child process because it imports the installed feature + * declarations, which this config must not load. A build never uses it: the + * built manifest comes from scripts/generate-build-manifest.ts. + */ +export function devReleaseManifestPlugin(repositoryRoot = process.cwd()): Plugin { + return { + name: "frontend-dev-release-manifest", + apply: "serve", + configureServer(server) { + execFileSync( + process.execPath, + [path.join(repositoryRoot, "scripts/write-dev-release-manifest.ts")], + { cwd: repositoryRoot, stdio: "inherit" }, + ); + const manifest = path.join(repositoryRoot, DEV_RELEASE_MANIFEST_PATH); + server.middlewares.use((request, response, next) => { + const pathname = new URL(request.url ?? "/", "http://dev.invalid").pathname; + if (request.method !== "GET" || !pathname.endsWith("/release-manifest.json")) { + next(); + return; + } + response.setHeader("content-type", "application/json"); + response.setHeader("cache-control", "no-store"); + response.end(readFileSync(manifest)); + }); + }, + }; +} diff --git a/scripts/write-dev-release-manifest.ts b/scripts/write-dev-release-manifest.ts new file mode 100644 index 00000000..bd194eb4 --- /dev/null +++ b/scripts/write-dev-release-manifest.ts @@ -0,0 +1,27 @@ +import { mkdir, readFile, writeFile } from "node:fs/promises"; +import { dirname } from "node:path"; + +import { buildContractSet } from "./generate-contract-set.ts"; +import { DEV_RELEASE_MANIFEST_PATH } from "./lib/dev-release-manifest.ts"; + +/** + * The release manifest the dev server serves: the committed placeholder + * (public/release-manifest.json) with the contract set of the features + * installed now. Boot checks that set against the installed declarations, so + * a placeholder with a fixed set refused every app with one more feature + * (CONTRACT_SET_PACKAGE_MISSING) until someone edited it by hand. The output + * is generated and ignored, as src/.generated/ is. + */ +export async function writeDevReleaseManifest( + source = "public/release-manifest.json", + output = DEV_RELEASE_MANIFEST_PATH, +): Promise { + const manifest = JSON.parse(await readFile(source, "utf8")) as Record; + manifest["contractSet"] = buildContractSet(); + await mkdir(dirname(output), { recursive: true }); + await writeFile(output, `${JSON.stringify(manifest, null, 2)}\n`, "utf8"); +} + +if (process.argv[1]?.endsWith("write-dev-release-manifest.ts")) { + await writeDevReleaseManifest(); +} diff --git a/tests/unit/dev-release-manifest.test.ts b/tests/unit/dev-release-manifest.test.ts new file mode 100644 index 00000000..061abbff --- /dev/null +++ b/tests/unit/dev-release-manifest.test.ts @@ -0,0 +1,56 @@ +import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises"; +import { tmpdir } from "node:os"; +import path from "node:path"; + +import { afterEach, describe, expect, it } from "vitest"; + +import { buildContractSet } from "../../scripts/generate-contract-set.ts"; +import { writeDevReleaseManifest } from "../../scripts/write-dev-release-manifest.ts"; + +/** + * 1103 X2. `create:feature` declares a contract package; the dev server used + * to serve the committed placeholder with a fixed empty set, so the app it + * had just generated refused to boot in `corepack pnpm dev`. + */ +describe("dev release manifest", () => { + let directory: string | undefined; + afterEach(async () => { + if (directory) await rm(directory, { recursive: true, force: true }); + directory = undefined; + }); + + it("serves the placeholder with the contract set of the installed features", async () => { + directory = await mkdtemp(path.join(tmpdir(), "dev-release-manifest-")); + const source = path.join(directory, "release-manifest.json"); + const output = path.join(directory, "generated", "dev-release-manifest.json"); + await writeFile( + source, + JSON.stringify({ + schemaVersion: 2, + buildId: "local-build", + contractSet: { + setAlgorithm: "CA_CONTRACT_SET_V1", + setDigest: "sha256:stale", + packages: [{ packageId: "@org-contracts/removed" }], + }, + }), + ); + + await writeDevReleaseManifest(source, output); + + const written = JSON.parse(await readFile(output, "utf8")) as Record; + expect(written["buildId"]).toBe("local-build"); + expect(written["contractSet"]).toEqual(JSON.parse(JSON.stringify(buildContractSet()))); + }); + + it("matches the committed placeholder while the template's own features are installed", async () => { + directory = await mkdtemp(path.join(tmpdir(), "dev-release-manifest-")); + const output = path.join(directory, "dev-release-manifest.json"); + + await writeDevReleaseManifest("public/release-manifest.json", output); + + expect(JSON.parse(await readFile(output, "utf8"))).toEqual( + JSON.parse(await readFile("public/release-manifest.json", "utf8")), + ); + }); +}); diff --git a/vite.config.ts b/vite.config.ts index 60053a34..9ae07aee 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -6,6 +6,7 @@ import { defineConfig, loadEnv } from "vite"; import react from "@vitejs/plugin-react"; import tailwindcss from "@tailwindcss/vite"; +import { devReleaseManifestPlugin } from "./scripts/lib/dev-release-manifest.ts"; import { viteModuleInventoryPlugin } from "./scripts/lib/vite-module-inventory.ts"; import { ENV_REGISTRY } from "./src/contracts/env.ts"; @@ -175,7 +176,7 @@ export default defineConfig(({ command, mode }) => { assertRuntimeConfigUnderBase(process.env, base); return { base, - plugins: [react(), tailwindcss(), viteModuleInventoryPlugin()], + plugins: [react(), tailwindcss(), viteModuleInventoryPlugin(), devReleaseManifestPlugin()], // Development keeps the router's warnings. resolve: command === "build" ? { alias: reactRouterProductionAliases(process.cwd()) } : {}, build: {