worker: key the cached document by build id so every deploy computes afresh

Author: rigor789

schemas/compatibility.json

@@ -140,6 +140,10 @@
 			"items": {
 				"$ref": "#/definitions/advisory"
 			}
+		},
+		"build": {
+			"type": "string",
+			"description": "The deployment (commit) that computed this document."
 		}
 	},
 	"definitions": {

shared/compute.ts

@@ -46,6 +46,7 @@ export function collectOverrides(entries: OverrideEntry[]): Overrides {
 
 export function buildDocument(input: {
 	schema?: string;
+	build?: string;
 	generatedAt: string;
 	toolchains: Record<ToolchainKey, ToolchainVersion[]>;
 	packages: Array<{ spec: TrackedPackageSpec; document: PackageDocument }>;
@@ -86,6 +87,7 @@ export function buildDocument(input: {
 	return {
 		...(input.schema ? { $schema: input.schema } : {}),
 		schemaVersion: 1,
+		...(input.build ? { build: input.build } : {}),
 		generatedAt: input.generatedAt,
 		toolchains: input.toolchains,
 		packages,

shared/types.ts

@@ -75,6 +75,8 @@ export interface Advisory {
 export interface CompatibilityDocument {
 	$schema?: string;
 	schemaVersion: 1;
+	/** The deployment that computed this document. */
+	build?: string;
 	generatedAt: string;
 	toolchains: Record<ToolchainKey, ToolchainVersion[]>;
 	packages: Record<string, PackageCompatibility>;

tsconfig.json

@@ -12,5 +12,5 @@
 		"esModuleInterop": true,
 		"isolatedModules": true
 	},
-	"include": ["worker", "shared", "test", "worker-configuration.d.ts"]
+	"include": ["worker", "shared", "test", "worker-configuration.d.ts", "worker/build.d.ts"]
 }

vite.config.ts

@@ -5,7 +5,12 @@ import { defineConfig } from "vite";
 
 // One dev server for everything: Vite serves the Vue app and the Cloudflare
 // plugin runs the Worker (API, KV, cron) in workerd alongside it.
+// Baked into the Worker so each deployment computes a fresh document instead
+// of serving what the previous build cached in KV.
+const buildId = (process.env.GITHUB_SHA ?? "").slice(0, 7) || `local-${Date.now().toString(36)}`;
+
 export default defineConfig({
 	plugins: [vue(), tailwindcss(), cloudflare()],
+	define: { __BUILD_ID__: JSON.stringify(buildId) },
 	server: { port: 8787 },
 });

worker/build.d.ts

@@ -0,0 +1,2 @@
+/** Injected by vite.config.ts: the commit being built, or a local timestamp. */
+declare const __BUILD_ID__: string;

worker/index.ts

@@ -29,7 +29,8 @@ const SCHEMAS: Record<string, unknown> = {
 	"verified.json": verifiedSchema,
 };
 
-const KV_KEY = "document:v1";
+// Keyed by build so a deployment never serves a document computed by an older build.
+const KV_KEY = `document:v1:${__BUILD_ID__}`;
 /** Served copies older than this are refreshed in the background. */
 const STALE_AFTER_MS = 60 * 60 * 1000;
 const KV_TTL_SECONDS = 7 * 24 * 60 * 60;
@@ -120,6 +121,7 @@ async function refresh(env: Env): Promise<CompatibilityDocument> {
 
 	const document = buildDocument({
 		schema: "https://compatibility.nativescript.org/v1/schemas/compatibility.json",
+		build: __BUILD_ID__,
 		generatedAt: new Date().toISOString(),
 		toolchains,
 		packages,