@norskvideo/ctl-dev-kit 0.2.8 → 0.2.9

package/conventions/check-drift.ts

@@ -18,7 +18,7 @@
 // (conventions/* + build/*), resolved package-relative so they work both
 // workspace-symlinked and installed from the published tarball.
 import { execFileSync } from "node:child_process";
-import { existsSync, readFileSync, statSync } from "node:fs";
+import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
 import { join } from "node:path";
 import { parseManifestSeed } from "@norskvideo/ctl-sdk/manifest-seed";
 import { checkTheme } from "../docs-theme/sync.ts";
@@ -340,6 +340,49 @@ export function demoProblems(repoRoot: string, canonicalShim: string): string[]
   return problems;
 }
 
+// Product logs (norsk-mgr docs/internal/design/product-logs.md): every compose
+// service a product template declares must say how it logs, or the node's log
+// agent ships nothing (or garbage) for it. The schema's
+// productTemplateLogsProblems says what is wrong with one template; what this
+// gate pins is that the repo asks it. A repo that packs a product template
+// must have a test that calls it — the packer itself cannot refuse, since
+// products also pack at runtime and a missed entry must not become a 500.
+const PACKS_TEMPLATE = /\bpackProductTemplate\b/;
+const CHECKS_LOGS = /\bproductTemplateLogsProblems\b/;
+const SKIP_DIRS = new Set(["node_modules", ".git", "dist", "build", "lib", "coverage", ".wireit"]);
+
+function sourceFiles(dir: string, out: string[] = []): string[] {
+  let names: string[];
+  try {
+    names = readdirSync(dir);
+  } catch {
+    return out;
+  }
+  for (const name of names) {
+    if (SKIP_DIRS.has(name)) continue;
+    const path = join(dir, name);
+    const st = statSync(path);
+    if (st.isDirectory()) sourceFiles(path, out);
+    else if (/\.(ts|tsx)$/.test(name)) out.push(path);
+  }
+  return out;
+}
+
+export function productLogsProblems(repoRoot: string): string[] {
+  const files = sourceFiles(repoRoot);
+  const read = (f: string) => readFileSync(f, "utf8");
+  if (!files.some((f) => PACKS_TEMPLATE.test(read(f)))) return [];
+  const tested = files.some((f) => /\.test\.tsx?$/.test(f) && CHECKS_LOGS.test(read(f)));
+  return tested
+    ? []
+    : [
+        "this repo packs a product template but no test calls productTemplateLogsProblems " +
+          "(@norskvideo/ctl-product-template-schema). Add one asserting it returns [] for every template " +
+          "the product builds, and give the manifest a `logs:` entry per compose service " +
+          "(norsk-mgr docs/internal/design/product-logs.md).",
+      ];
+}
+
 // A file that must be a verbatim, byte-for-byte copy of its dev-kit canonical.
 function verbatimProblem(
   repoRoot: string,
@@ -737,6 +780,7 @@ export function checkDrift(repoRoot: string, canonical: CanonicalBytes, opts: Ch
   for (const p of docsThemeProblems(repoRoot, opts.themeCanonical)) push(p);
 
   for (const p of demoProblems(repoRoot, canonical.demoShim)) push(p);
+  for (const p of productLogsProblems(repoRoot)) push(p);
 
   return { ok: problems.length === 0, problems };
 }

package/create-product/turnkey.ts

@@ -1104,6 +1104,7 @@ import {
   type ProductTemplateMaterials,
   type ProductTemplateParameter,
   STANDARD_ADVANCED_OVERRIDES,
+  STANDARD_LOGS,
 } from "@norskvideo/ctl-product-template-schema";
 import type { ComponentLibrary } from "@norskvideo/norsk-studio-builder";
 import { stringify as yamlStringify } from "yaml";
@@ -1155,6 +1156,10 @@ ${runtimeScreen}    proxy: {
       expose: [${proxyExpose}],
     },
     advanced: { ...STANDARD_ADVANCED_OVERRIDES, ...opts.advanced },
+    // How each compose service logs, for the node's log agent. A service
+    // added to renderCompose needs its own entry here — the drift gate
+    // requires a test (product-template.test.ts) that says so.
+    logs: STANDARD_LOGS,
   };
 
   return {
@@ -1256,6 +1261,7 @@ import {
   ParametersFileSchema,
   ProductTemplateManifestSchema,
   ProductTemplateMaterialsSchema,
+  productTemplateLogsProblems,
 } from "@norskvideo/ctl-product-template-schema";
 import { packProductTemplate } from "@norskvideo/ctl-product-template-schema/pack";
 import type { ComponentLibrary } from "@norskvideo/norsk-studio-builder";
@@ -1277,6 +1283,11 @@ describe("product-template materials", () => {
     expect(ProductTemplateMaterialsSchema.safeParse(materials).success).toBe(true);
   });
 
+  it("declare how every compose service logs", () => {
+    const materials = buildProductTemplateMaterials(ProductConfigSchema.parse(example), { library });
+    expect(productTemplateLogsProblems(materials)).toEqual([]);
+  });
+
   it("pack to a tar whose entries round-trip through the schema package", () => {
     const materials = buildProductTemplateMaterials(ProductConfigSchema.parse(example), { library });
     const tar = packProductTemplate(materials);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norskvideo/ctl-dev-kit",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "type": "module",
   "exports": {
     "./create-product": "./create-product/create-product.ts",