@decocms/start 4.3.0 → 4.5.0

package/scripts/migrate/templates/package-json.ts

@@ -1,6 +1,17 @@
 import { execSync } from "node:child_process";
 import type { MigrationContext } from "../types";
 
+/**
+ * Fleet-wide canonical bun version. Bumped here propagates to all newly
+ * migrated sites via the `packageManager` field AND the
+ * `lockfile-check.yml` workflow's `bun-version` input. See
+ * MIGRATION_TOOLING_PLAN.md for the bun-canonical decision.
+ *
+ * Exported because the lockfile-check workflow template reads it
+ * directly to keep both files in lockstep.
+ */
+export const CANONICAL_BUN_VERSION = "1.3.5";
+
 /**
  * Get the latest published version of an npm package.
  * Falls back to the provided default if the lookup fails.
@@ -120,7 +131,7 @@ export function generatePackageJson(ctx: MigrationContext): string {
       "format:check": 'prettier --check "src/**/*.{ts,tsx}"',
       knip: "knip",
       clean:
-        "rm -rf node_modules .cache dist .wrangler/state node_modules/.vite && npm install",
+        "rm -rf node_modules .cache dist .wrangler/state node_modules/.vite && bun install",
       "tailwind:lint":
         "tsx scripts/tailwind-lint.ts",
       "tailwind:fix":
@@ -128,6 +139,7 @@ export function generatePackageJson(ctx: MigrationContext): string {
     },
     author: "deco.cx",
     license: "MIT",
+    packageManager: `bun@${CANONICAL_BUN_VERSION}`,
     dependencies: {
       "@decocms/apps": `^${appsVersion}`,
       "@decocms/start": `^${startVersion}`,

package/scripts/migrate/templates/server-entry.ts

@@ -42,11 +42,23 @@ function generateWorkerEntry(ctx: MigrationContext): string {
   return `/**
  * Cloudflare Worker entry point.
  *
- * Wraps TanStack Start with admin protocol handlers and edge caching.
+ * Wraps TanStack Start with admin protocol handlers, edge caching, and
+ * the @decocms/start observability stack:
+ *   - structured JSON logger (console.log) -> Cloudflare Workers Logs ->
+ *     CF-managed OTLP push when wrangler.jsonc has the
+ *     observability.logs.destinations block
+ *   - @opentelemetry/api global tracer bridge (so withTracing() spans flow
+ *     to whichever destination CF tracing pushes to)
+ *   - request/cache metrics to AE (DECO_METRICS binding)
+ *
+ * Run \`npx -p @decocms/start deco-cf-observability --write\` after wiring
+ * wrangler.jsonc to add the CF-native observability block. See
+ * https://github.com/decocms/deco-start#observability
  */
 import "./setup";
 import handler, { createServerEntry } from "@tanstack/react-start/server-entry";
 import { createDecoWorkerEntry } from "@decocms/start/sdk/workerEntry";
+import { instrumentWorker } from "@decocms/start/sdk/observability";
 import {
   handleMeta,
   handleDecofileRead,
@@ -60,7 +72,7 @@ ${isCommerce ? `
 ` : ""}
 const serverEntry = createServerEntry({ fetch: handler.fetch });
 
-export default createDecoWorkerEntry(serverEntry, {
+const decoWorker = createDecoWorkerEntry(serverEntry, {
   admin: {
     handleMeta,
     handleDecofileRead,
@@ -69,6 +81,10 @@ export default createDecoWorkerEntry(serverEntry, {
     corsHeaders,
   },
 });
+
+export default instrumentWorker(decoWorker, {
+  serviceName: "${ctx.siteName}",
+});
 `;
 }
 
@@ -78,6 +94,7 @@ function generateVtexWorkerEntry(ctx: MigrationContext): string {
   return `import "./setup";
 import handler, { createServerEntry } from "@tanstack/react-start/server-entry";
 import { createDecoWorkerEntry } from "@decocms/start/sdk/workerEntry";
+import { instrumentWorker } from "@decocms/start/sdk/observability";
 import {
   handleMeta,
   handleDecofileRead,
@@ -164,7 +181,7 @@ const decoWorker = createDecoWorkerEntry(serverEntry, {
 // A/B wrapper — KV-driven traffic split between TanStack and legacy origin
 // ---------------------------------------------------------------------------
 
-export default withABTesting(decoWorker, {
+const abTestedWorker = withABTesting(decoWorker, {
   kvBinding: "SITES_KV",
   preHandler: (request, url) => {
     const redirect = matchRedirect(url.pathname, cmsRedirects);
@@ -183,6 +200,25 @@ export default withABTesting(decoWorker, {
     return shouldProxyToVtex(url.pathname);
   },
 });
+
+// ---------------------------------------------------------------------------
+// Observability wrap (outermost layer)
+//
+// As of @decocms/start 4.4.0, instrumentWorker uses Cloudflare-native
+// observability by default:
+//   - logs:   console.* -> CF Workers Logs -> CF-managed OTLP push
+//             (when wrangler.jsonc has observability.logs.destinations)
+//   - traces: @opentelemetry/api global tracer (bridged from withTracing)
+//             -> CF Workers Tracing -> CF-managed OTLP push
+//   - metrics: AE (DECO_METRICS) + app-side OTLP (until CF ships
+//              OTLP metrics export)
+//
+// Run \`npx -p @decocms/start deco-cf-observability --write\` after
+// wiring wrangler.jsonc to inject the CF-native observability block.
+// ---------------------------------------------------------------------------
+export default instrumentWorker(abTestedWorker, {
+  serviceName: "${ctx.siteName}",
+});
 `;
 }
 

package/scripts/migrate-post-cleanup.ts

@@ -78,9 +78,11 @@ function showHelp() {
     --fix            Auto-apply mechanical fixes for the safe rules
                      (dead-lib-shims, dead-runtime-shim, local-widgets-types,
                      vtex-shim-regression swap subset, obsolete-vite-plugins,
-                     local-framework-duplicate auto-fixable subset).
-                     Other rules — including htmx-residue and the warn-only
-                     entries of local-framework-duplicate — stay detect-only.
+                     local-framework-duplicate auto-fixable subset,
+                     lockfile-multiple, package-manager-missing).
+                     Other rules — including htmx-residue, lockfile-missing,
+                     lockfile-drift, and the warn-only entries of
+                     local-framework-duplicate — stay detect-only.
     --json           Emit machine-readable JSON instead of pretty text
     --strict         Exit code 2 if any warning-severity findings exist
     --help, -h       Show this help

package/scripts/migrate-to-cf-observability.test.ts

@@ -0,0 +1,169 @@
+/**
+ * Smoke tests for the `migrate-to-cf-observability.ts` codemod.
+ *
+ * Drives the script as a child process against tmp wrangler.jsonc fixtures.
+ * Verifies the three behaviors that matter operationally:
+ *  - replacing an existing `observability.logs` block (lebiscuit shape)
+ *  - appending a new `observability` block when none exists
+ *  - second run is a no-op (idempotency / CI guard)
+ *  - result is valid JSONC (parses after stripping comments)
+ */
+import * as cp from "node:child_process";
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+
+const SCRIPT = path.resolve(__dirname, "migrate-to-cf-observability.ts");
+
+function runCodemod(args: string[]): { stdout: string; stderr: string; code: number } {
+  const r = cp.spawnSync("npx", ["tsx", SCRIPT, ...args], { encoding: "utf8" });
+  return { stdout: r.stdout || "", stderr: r.stderr || "", code: r.status ?? 0 };
+}
+
+function stripJsoncComments(s: string): string {
+  return s.replace(/\/\*[\s\S]*?\*\//g, "").replace(/\/\/[^\n]*/g, "");
+}
+
+describe("migrate-to-cf-observability codemod", () => {
+  let tmpDir: string;
+  let wranglerPath: string;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "cf-codemod-"));
+    wranglerPath = path.join(tmpDir, "wrangler.jsonc");
+  });
+
+  afterEach(() => {
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  it("replaces an existing observability.logs block in lebiscuit-shape config", () => {
+    fs.writeFileSync(
+      wranglerPath,
+      `{
+  "name": "lebiscuit-tanstack",
+  "compatibility_date": "2026-02-14",
+  "main": "./src/worker-entry.ts",
+  "kv_namespaces": [{ "binding": "SITES_KV", "id": "abc" }],
+  "version_metadata": { "binding": "CF_VERSION_METADATA" },
+  "analytics_engine_datasets": [
+    { "binding": "DECO_METRICS", "dataset": "deco_metrics_lebiscuit" }
+  ],
+  "observability": {
+    "logs": {
+      "enabled": true,
+      "invocation_logs": true
+    }
+  }
+}
+`,
+    );
+
+    const r = runCodemod(["--source", tmpDir, "--write"]);
+    expect(r.code).toBe(0);
+
+    const result = fs.readFileSync(wranglerPath, "utf8");
+    expect(result).toContain('"destinations": ["hyperdx-logs"]');
+    expect(result).toContain('"destinations": ["hyperdx-traces"]');
+    expect(result).toContain('"head_sampling_rate": 0.1');
+
+    // Result must be valid JSONC.
+    expect(() => JSON.parse(stripJsoncComments(result))).not.toThrow();
+
+    // Original key context preserved.
+    expect(result).toContain('"name": "lebiscuit-tanstack"');
+    expect(result).toContain('"binding": "DECO_METRICS"');
+  });
+
+  it("appends a new observability block when none exists", () => {
+    fs.writeFileSync(
+      wranglerPath,
+      `{
+  "name": "fresh-site",
+  "compatibility_date": "2026-02-14",
+  "main": "./src/worker-entry.ts"
+}
+`,
+    );
+
+    const r = runCodemod(["--source", tmpDir, "--write"]);
+    expect(r.code).toBe(0);
+
+    const result = fs.readFileSync(wranglerPath, "utf8");
+    expect(result).toContain('"observability"');
+    expect(result).toContain('"destinations": ["hyperdx-logs"]');
+    expect(() => JSON.parse(stripJsoncComments(result))).not.toThrow();
+  });
+
+  it("is idempotent: second run is a no-op", () => {
+    fs.writeFileSync(
+      wranglerPath,
+      `{
+  "name": "lebiscuit-tanstack",
+  "main": "./src/worker-entry.ts",
+  "observability": {
+    "logs": { "enabled": true }
+  }
+}
+`,
+    );
+
+    runCodemod(["--source", tmpDir, "--write"]);
+    const after1 = fs.readFileSync(wranglerPath, "utf8");
+
+    const r = runCodemod(["--source", tmpDir, "--write"]);
+    expect(r.code).toBe(0);
+    expect(r.stdout).toContain("already on CF-native");
+
+    const after2 = fs.readFileSync(wranglerPath, "utf8");
+    expect(after2).toBe(after1);
+  });
+
+  it("dry-run exits 1 and does not modify the file (CI signal)", () => {
+    const before = `{
+  "name": "site",
+  "main": "./src/worker-entry.ts"
+}
+`;
+    fs.writeFileSync(wranglerPath, before);
+
+    const r = runCodemod(["--source", tmpDir]);
+    expect(r.code).toBe(1);
+    expect(r.stdout).toContain("Dry-run");
+
+    expect(fs.readFileSync(wranglerPath, "utf8")).toBe(before);
+  });
+
+  it("respects --logs / --traces / --traces-rate / --persist flags", () => {
+    fs.writeFileSync(
+      wranglerPath,
+      `{
+  "name": "site",
+  "main": "./src/worker-entry.ts"
+}
+`,
+    );
+
+    runCodemod([
+      "--source",
+      tmpDir,
+      "--logs",
+      "my-logs",
+      "--traces",
+      "my-traces",
+      "--traces-rate",
+      "0.05",
+      "--persist",
+      "--write",
+    ]);
+
+    const result = fs.readFileSync(wranglerPath, "utf8");
+    expect(result).toContain('"destinations": ["my-logs"]');
+    expect(result).toContain('"destinations": ["my-traces"]');
+    expect(result).toContain('"head_sampling_rate": 0.05');
+    // Both blocks set persist:true (no logs-only persist flag).
+    const persistTrueCount = (result.match(/"persist": true/g) ?? []).length;
+    expect(persistTrueCount).toBe(2);
+  });
+}, 30_000);