npm - @cosmicdrift/kumiko-dev-server - Versions diffs - 0.57.2 → 0.59.1 - Mend

@cosmicdrift/kumiko-dev-server 0.57.2 → 0.59.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/package.json +3 -3
package/src/__tests__/build-prod-bundle.test.ts +49 -0
package/src/__tests__/cache-headers.test.ts +8 -1
package/src/build-prod-bundle.ts +62 -5
package/src/run-prod-app.ts +8 -1

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@cosmicdrift/kumiko-dev-server",
-  "version": "0.57.2",
+  "version": "0.59.1",
   "description": "Development server bootstrap for Kumiko apps. Bundles the client, mints dev-JWTs, injects the resolved AppSchema, and seeds an admin. Not for production.",
   "license": "BUSL-1.1",
   "author": "Marc Frost <marc@cosmicdriftgamestudio.com>",
@@ -46,8 +46,8 @@
     "kumiko-schema-check": "./bin/kumiko-schema-check.ts"
   },
   "dependencies": {
-    "@cosmicdrift/kumiko-bundled-features": "0.55.1",
-    "@cosmicdrift/kumiko-framework": "0.55.1",
+    "@cosmicdrift/kumiko-bundled-features": "0.57.2",
+    "@cosmicdrift/kumiko-framework": "0.57.2",
     "ts-morph": "^28.0.0"
   },
   "publishConfig": {

package/src/__tests__/build-prod-bundle.test.ts CHANGED Viewed

@@ -13,6 +13,7 @@ import { tmpdir } from "node:os";
 import { join } from "node:path";
 import {
   type ClientEntry,
+  computeBuildId,
   discoverClientEntries,
   discoverClientEntry,
   discoverHtmlTemplate,
@@ -260,3 +261,51 @@ describe("build-prod-bundle/injectAssetTags", () => {
     );
   });
 });
+describe("build-prod-bundle/computeBuildId", () => {
+  test("identisches Manifest → gleiche id", () => {
+    const manifest = {
+      "client.js": "/assets/client-abc.js",
+      "styles.css": "/assets/styles-xyz.css",
+    };
+    expect(computeBuildId(manifest)).toBe(computeBuildId({ ...manifest }));
+  });
+  test("Key-Reihenfolge egal — nur die URL-Werte zählen", () => {
+    const a = { "client.js": "/assets/client-abc.js", "styles.css": "/assets/styles-xyz.css" };
+    const b = { "styles.css": "/assets/styles-xyz.css", "client.js": "/assets/client-abc.js" };
+    expect(computeBuildId(a)).toBe(computeBuildId(b));
+  });
+  test("geändertes Asset (neuer Hash) → andere id", () => {
+    const before = { "client.js": "/assets/client-abc.js" };
+    const after = { "client.js": "/assets/client-def.js" };
+    expect(computeBuildId(before)).not.toBe(computeBuildId(after));
+  });
+  test("12 Hex-Zeichen", () => {
+    expect(computeBuildId({ "client.js": "/assets/client-abc.js" })).toMatch(/^[0-9a-f]{12}$/);
+  });
+});
+describe("build-prod-bundle/injectAssetTags build-info", () => {
+  test("bäckt window.__KUMIKO_BUILD__ vor </head> wenn buildInfo gesetzt", () => {
+    const html = `<html><head><title>x</title></head><body><script type="module" src="/client.js"></script></body></html>`;
+    const result = injectAssetTags(html, { "client.js": "/assets/client-abc.js" }, clientEntry(), {
+      id: "deadbeef0000",
+      builtAt: "2026-06-18T12:00:00.000Z",
+    });
+    expect(result).toContain(
+      'window.__KUMIKO_BUILD__={"id":"deadbeef0000","builtAt":"2026-06-18T12:00:00.000Z"}',
+    );
+    expect(result.indexOf("__KUMIKO_BUILD__")).toBeLessThan(result.indexOf("</head>"));
+  });
+  test("ohne buildInfo kein __KUMIKO_BUILD__-Script", () => {
+    const html = `<html><head></head><body><script type="module" src="/client.js"></script></body></html>`;
+    const result = injectAssetTags(html, { "client.js": "/assets/client-abc.js" }, clientEntry());
+    expect(result).not.toContain("__KUMIKO_BUILD__");
+  });
+});

package/src/__tests__/cache-headers.test.ts CHANGED Viewed

@@ -4,7 +4,8 @@
 // Strategie (siehe run-prod-app.ts):
 //   /assets/*               → max-age=31536000, immutable
 //   /, /index.html          → no-cache, must-revalidate
-//   /manifest.json, /sw.js  → no-cache
+//   /manifest.json, /sw.js,
+//   /build-info.json        → no-cache
 //   alles andere            → kein expliziter Header
 import { describe, expect, test } from "bun:test";
@@ -53,6 +54,12 @@ describe("cacheHeadersFor", () => {
     });
   });
+  test("/build-info.json → no-cache (sonst pollt UpdateChecker eine veraltete id)", () => {
+    expect(cacheHeadersFor("/build-info.json")).toEqual({
+      "cache-control": "no-cache",
+    });
+  });
   test("public-folder file (favicon) → kein expliziter Header", () => {
     expect(cacheHeadersFor("/favicon.ico")).toEqual({});
   });

package/src/build-prod-bundle.ts CHANGED Viewed

@@ -71,6 +71,20 @@ export type BuildResult = {
    *    { "client.js": "/assets/client-a3f2.js",
    *      "styles.css": "/assets/styles-9b4c.css" } */
   readonly manifest: BuildManifest;
+  /** Build-Identität (Hash über die Asset-URLs) + lesbarer Zeitstempel.
+   *  undefined bei vanilla public-only-Builds (kein Bundle). */
+  readonly buildInfo?: BuildInfo;
+};
+/** In index.html gebacken (`window.__KUMIKO_BUILD__`) UND als
+ *  dist/build-info.json geschrieben. Der UpdateChecker pollt build-info.json
+ *  und vergleicht `id` gegen den geladenen Stand → Reload-Banner bei Drift. */
+export type BuildInfo = {
+  /** Hash über die sortierten (content-gehashten) Asset-URLs. Ändert sich
+   *  gdw. sich ein Asset ändert — selbsttragend, kein Env-Var/Dockerfile. */
+  readonly id: string;
+  /** ISO-Zeitstempel des Builds, lesbare Anzeige-Version (ersetzt den rohen sha). */
+  readonly builtAt: string;
 };
 // Default-HTML wird nur genutzt wenn der App-Author KEIN index.html liefert.
@@ -166,6 +180,17 @@ export async function buildProdBundle(options: BuildProdBundleOptions = {}): Pro
     await copyPublicFolder(publicDir, outDir, templateBasenames);
   }
+  // 5b. Build-Identität: Hash über die content-gehashten Asset-URLs +
+  //     lesbarer Zeitstempel. Wird in index.html gebacken und als
+  //     build-info.json geschrieben (Update-Awareness, default an).
+  //     ponytail: id hängt nur an Assets — ein reiner Server-Deploy ohne
+  //     Client-Bundle-Change behält die id → kein Banner (die UI ist dann
+  //     nicht stale). Bei Bedarf an Server-Versionierung koppeln.
+  const buildInfo: BuildInfo | undefined =
+    Object.keys(manifest).length > 0
+      ? { id: computeBuildId(manifest), builtAt: new Date().toISOString() }
+      : undefined;
   // 6. HTML pro Entry rendern. Convention: ein HTML-File pro Client-Entry,
   //    jede mit ihrem eigenen Script-Tag. Server (runProdApp.hostDispatch)
   //    serviert je nach Host das passende File.
@@ -176,16 +201,24 @@ export async function buildProdBundle(options: BuildProdBundleOptions = {}): Pro
     for (const entry of clientEntries) {
       const templatePath = resolve(cwd, entry.htmlPath);
       const templateExists = existsSync(templatePath);
-      const html = await renderHtml(templateExists ? templatePath : undefined, manifest, entry);
+      const html = await renderHtml(
+        templateExists ? templatePath : undefined,
+        manifest,
+        entry,
+        buildInfo,
+      );
       const outFile = basenameOf(entry.htmlPath);
       await writeFile(join(outDir, outFile), html);
     }
   }
-  // 7. Manifest.
+  // 7. Manifest + Build-Info.
   await writeFile(join(outDir, "manifest.json"), `${JSON.stringify(manifest, null, 2)}\n`);
+  if (buildInfo) {
+    await writeFile(join(outDir, "build-info.json"), `${JSON.stringify(buildInfo)}\n`);
+  }
-  return { outDir, manifest };
+  return { outDir, manifest, ...(buildInfo && { buildInfo }) };
 }
 // ---------------------------------------------------------------------------
@@ -493,6 +526,7 @@ async function renderHtml(
   templatePath: string | undefined,
   manifest: BuildManifest,
   entry: ClientEntry,
+  buildInfo: BuildInfo | undefined,
 ): Promise<string> {
   // Edge-Case: kein eigenes HTML-Template + Bun.build oder Tailwind hat
   // Output produziert. DEFAULT_HTML hat keine Placeholder (vanilla
@@ -502,7 +536,7 @@ async function renderHtml(
     throw new Error(buildMissingTemplateError(manifest, entry));
   }
   const template = templatePath ? await readFile(templatePath, "utf8") : DEFAULT_HTML;
-  return injectAssetTags(template, manifest, entry);
+  return injectAssetTags(template, manifest, entry, buildInfo);
 }
 function buildMissingTemplateError(manifest: BuildManifest, entry: ClientEntry): string {
@@ -545,9 +579,21 @@ function buildMissingTemplateError(manifest: BuildManifest, entry: ClientEntry):
 // Fehlt ein erwarteter Tag, wirft der Build einen Fehler mit dem exakten
 // Snippet zum Reinkopieren — kein silent injection mehr, weil das den
 // Diff zwischen Dev- und Prod-HTML unsichtbar macht.
-export function injectAssetTags(html: string, manifest: BuildManifest, entry: ClientEntry): string {
+export function injectAssetTags(
+  html: string,
+  manifest: BuildManifest,
+  entry: ClientEntry,
+  buildInfo?: BuildInfo,
+): string {
   let result = html;
+  // Build-Stand vor </head> backen. id/builtAt sind Hex bzw. ISO → kein
+  // </script>-Escaping nötig. Ohne </head> (z.B. Fragment) still skip.
+  if (buildInfo && result.includes("</head>")) {
+    const tag = `<script>window.__KUMIKO_BUILD__=${JSON.stringify(buildInfo)};</script>`;
+    result = result.replace("</head>", `    ${tag}\n  </head>`);
+  }
   const cssUrl = manifest["styles.css"];
   if (cssUrl && !result.includes(cssUrl)) {
     const placeholder = /<link\s+rel="stylesheet"\s+href="\/styles\.css"\s*\/?>/.exec(result);
@@ -617,6 +663,17 @@ function shortHash(content: string | Uint8Array): string {
   return createHash("sha256").update(content).digest("hex").slice(0, 8);
 }
+// Build-Identität aus den content-gehashten Asset-URLs. Sortiert →
+// deterministisch (Manifest-Key-Reihenfolge egal). Identischer Source →
+// gleiche id, geändertes Asset → andere id.
+// @internal — exported nur für Unit-Tests.
+export function computeBuildId(manifest: BuildManifest): string {
+  return createHash("sha256")
+    .update(Object.values(manifest).sort().join("\n"))
+    .digest("hex")
+    .slice(0, 12);
+}
 // ---------------------------------------------------------------------------
 // CLI output
 // ---------------------------------------------------------------------------

package/src/run-prod-app.ts CHANGED Viewed

@@ -1161,7 +1161,14 @@ export function cacheHeadersFor(pathname: string): Record<string, string> {
   if (pathname === "/" || pathname === "/index.html") {
     return { "cache-control": "no-cache, must-revalidate" };
   }
-  if (pathname === "/manifest.json" || pathname === "/sw.js") {
+  if (
+    pathname === "/manifest.json" ||
+    pathname === "/sw.js" ||
+    // ponytail: build-info.json ist statisch — kein /api/version-Endpoint
+    // nötig, der Disk-Fallback serviert sie. no-cache, sonst pollt der
+    // UpdateChecker eine veraltete id.
+    pathname === "/build-info.json"
+  ) {
     return { "cache-control": "no-cache" };
   }
   return {};