fix(stats): preserve dashboard product assets

bhdicaire · bhdicaire · commit 7ac48f89caeb · 2026-06-01T15:59:56.000-04:00
diff --git a/defaults/public/llms-full.txt b/defaults/public/llms-full.txt
@@ -56,7 +56,7 @@ The default policy rejects risky destinations such as credentialed URLs, non-HTT
 
 Product defaults live in `defaults/`. Instance-owned files live in `custom/` and are not overwritten automatically during updates. The build copies defaults first, overlays `custom/public`, and then generates runtime files.
 
-Use `npm run doctor` to detect stale copied public assets, unsupported copied language folders, stale branding, and missing shared head assets. Use `./scripts/v8s-fix --assets`, `--head-assets`, `--languages`, `--branding`, or `--all` to apply explicit maintenance fixes to copied public files.
+Use `npm run doctor` to detect stale copied public assets, stale copied product pages, unsupported copied language folders, stale branding, and missing shared head assets. Use `./scripts/v8s-fix --assets`, `--head-assets`, `--product-pages`, `--languages`, `--branding`, or `--all` to apply explicit maintenance fixes to copied public files.
 
 ## Useful Files
 
diff --git a/scripts/build.mjs b/scripts/build.mjs
@@ -485,6 +485,8 @@ function applyPublicBranding(siteConfig) {
   if (!hasWordmark && !hasSlogan) return;
 
   rewriteHtmlFiles(BUILD_DIR, (html, filePath) => {
+    if (isStatsDashboardFile(filePath)) return html;
+
     let brandedHtml = html;
     const brandLabel = hasWordmark ? `${wordmark.black || ""}${wordmark.green || ""}` : "";
 
@@ -525,6 +527,10 @@ function applyPublicBranding(siteConfig) {
   });
 }
 
+function isStatsDashboardFile(filePath) {
+  return path.relative(BUILD_DIR, filePath).split(path.sep).join("/") === "_stats/index.html";
+}
+
 function languageForBuildHtmlFile(filePath) {
   const [firstSegment] = path.relative(BUILD_DIR, filePath).split(path.sep);
   return LANGUAGE_METADATA[firstSegment] ? firstSegment : "en";
diff --git a/scripts/doctor.mjs b/scripts/doctor.mjs
@@ -38,7 +38,7 @@ function main() {
 }
 
 function printRecommendedFixes(issues) {
-  const fixes = [...new Set(issues.map((issue) => issue.fix))];
+  const fixes = [...new Set(issues.map((issue) => issue.fix))].sort(compareFixes);
   const fixCounts = fixes.map((fix) => ({
     fix,
     count: issues.filter((issue) => issue.fix === fix).length
@@ -55,6 +55,11 @@ function printRecommendedFixes(issues) {
   }
 }
 
+function compareFixes(left, right) {
+  const order = ["product-pages", "head-assets", "assets", "branding", "languages", "public"];
+  return order.indexOf(left) - order.indexOf(right);
+}
+
 try {
   main();
 } catch (error) {
diff --git a/scripts/install.mjs b/scripts/install.mjs
@@ -773,9 +773,10 @@ function customizePublicPages(args) {
   fs.rmSync(CUSTOM_PUBLIC_DIR, { recursive: true, force: true });
   copyDirectory(DEFAULT_PUBLIC_DIR, CUSTOM_PUBLIC_DIR);
   pruneUnsupportedLanguageDirs(CUSTOM_PUBLIC_DIR, args.languages);
-  rewriteHtmlFiles(CUSTOM_PUBLIC_DIR, (html, filePath) =>
-    normalizeHtmlHead(applyBranding(html, args, languageForPublicFile(filePath)))
-  );
+  rewriteHtmlFiles(CUSTOM_PUBLIC_DIR, (html, filePath) => {
+    if (isProductPublicFile(filePath)) return html;
+    return normalizeHtmlHead(applyBranding(html, args, languageForPublicFile(filePath)));
+  });
   formatFiles(CUSTOM_PUBLIC_DIR, [".html"]);
 }
 
@@ -895,6 +896,11 @@ function languageForPublicFile(filePath) {
   return DEFAULT_LANGUAGES.includes(language) ? language : "en";
 }
 
+function isProductPublicFile(filePath) {
+  const relative = path.relative(CUSTOM_PUBLIC_DIR, filePath).split(path.sep).join("/");
+  return relative === "_stats/index.html" || relative === "_tests/index.html";
+}
+
 function applyBranding(html, args, language = "en") {
   const brandLabel = `${args.wordmarkBlack}${args.wordmarkGreen}`;
   const wordmarkSpans = `<span>${escapeHtml(args.wordmarkBlack)}</span><span>${escapeHtml(args.wordmarkGreen)}</span>`;
diff --git a/scripts/install.test.mjs b/scripts/install.test.mjs
@@ -157,6 +157,10 @@ function runSetup(cwd, extraArgs) {
   const builtIndex = fs.readFileSync(path.join(fixture, "build", "index.html"), "utf8");
   assert.match(builtIndex, /<span>v8s\.<\/span><span>link<\/span>/);
   assert.match(builtIndex, /The official demo for <a href="https:\/\/example\.com">Example Inc\.<\/a> projects/);
+
+  const builtStats = fs.readFileSync(path.join(fixture, "build", "_stats", "index.html"), "utf8");
+  assert.match(builtStats, /<img src="\/logo\.svg" alt="VanityURLs" \/>/);
+  assert.doesNotMatch(builtStats, /<a class="brand-mark brand-mark-wordmark"/);
 }
 
 console.log("install tests ok");
diff --git a/scripts/lib/custom-public-maintenance.mjs b/scripts/lib/custom-public-maintenance.mjs
@@ -53,6 +53,7 @@ export function diagnoseCustomPublic(context) {
 
   issues.push(...diagnoseHtmlHeadAssets(context));
   issues.push(...diagnoseSharedAssets(context));
+  issues.push(...diagnoseProductPages(context));
   issues.push(...diagnoseBranding(context));
 
   const supported = new Set(languages);
@@ -95,9 +96,10 @@ export function reconcileCustomPublic(context, options = {}) {
     fs.rmSync(customPublicDir, { recursive: true, force: true });
     copyDirectory(defaultPublicDir, customPublicDir);
     pruneUnsupportedLanguageDirs(context);
-    rewriteHtmlFiles(customPublicDir, (html, filePath) =>
-      normalizeHtmlHead(applyBranding(html, context, languageForPublicFile(context, filePath)))
-    );
+    rewriteHtmlFiles(customPublicDir, (html, filePath) => {
+      if (isProductPublicFile(context, filePath)) return html;
+      return normalizeHtmlHead(applyBranding(html, context, languageForPublicFile(context, filePath)));
+    });
     actions.push("recreated custom/public from defaults");
   } else {
     if (options.languages) {
@@ -110,15 +112,24 @@ export function reconcileCustomPublic(context, options = {}) {
       actions.push("synced shared CSS, script, logo, icon, font, and badge assets from defaults");
     }
 
+    if (options.productPages) {
+      syncProductPages(context);
+      actions.push("synced product dashboard and QA pages from defaults");
+    }
+
     if (options.branding) {
-      rewriteHtmlFiles(customPublicDir, (html, filePath) =>
-        applyBranding(html, context, languageForPublicFile(context, filePath))
-      );
+      rewriteHtmlFiles(customPublicDir, (html, filePath) => {
+        if (isProductPublicFile(context, filePath)) return html;
+        return applyBranding(html, context, languageForPublicFile(context, filePath));
+      });
       actions.push("refreshed branding in custom/public HTML");
     }
 
     if (options.headAssets) {
-      rewriteHtmlFiles(customPublicDir, (html) => normalizeHtmlHead(html));
+      rewriteHtmlFiles(customPublicDir, (html, filePath) => {
+        if (isProductPublicFile(context, filePath)) return html;
+        return normalizeHtmlHead(html);
+      });
       actions.push("normalized favicon and theme head assets in custom/public HTML");
     }
   }
@@ -134,6 +145,7 @@ export function parseReconcileArgs(argv) {
     dryRun: false,
     headAssets: false,
     languages: false,
+    productPages: false,
     public: false
   };
 
@@ -143,6 +155,7 @@ export function parseReconcileArgs(argv) {
       options.branding = true;
       options.headAssets = true;
       options.languages = true;
+      options.productPages = true;
     } else if (arg === "--assets") {
       options.assets = true;
     } else if (arg === "--branding") {
@@ -153,6 +166,8 @@ export function parseReconcileArgs(argv) {
       options.headAssets = true;
     } else if (arg === "--languages") {
       options.languages = true;
+    } else if (arg === "--product-pages") {
+      options.productPages = true;
     } else if (arg === "--public") {
       options.public = true;
     } else {
@@ -165,6 +180,7 @@ export function parseReconcileArgs(argv) {
 
 function diagnoseHtmlHeadAssets(context) {
   return listHtmlFiles(context.customPublicDir)
+    .filter((filePath) => !isProductPublicFile(context, filePath))
     .filter((filePath) => normalizeHtmlHead(fs.readFileSync(filePath, "utf8")) !== fs.readFileSync(filePath, "utf8"))
     .map((filePath) => ({
       code: "html-head-assets-stale",
@@ -193,10 +209,29 @@ function diagnoseSharedAssets(context) {
     });
 }
 
+function diagnoseProductPages(context) {
+  return listProductDefaultPages(context)
+    .filter((defaultPath) => {
+      const customPath = path.join(context.customPublicDir, path.relative(context.defaultPublicDir, defaultPath));
+      return fs.existsSync(customPath) && !sameFile(defaultPath, customPath);
+    })
+    .map((defaultPath) => {
+      const customPath = path.join(context.customPublicDir, path.relative(context.defaultPublicDir, defaultPath));
+      return {
+        code: "product-page-stale",
+        severity: "warn",
+        fix: "product-pages",
+        path: relativePath(context, customPath),
+        message: "Product-managed dashboard or QA page differs from defaults."
+      };
+    });
+}
+
 function diagnoseBranding(context) {
   if (!hasBrandingConfig(context.siteConfig)) return [];
 
   return listHtmlFiles(context.customPublicDir)
+    .filter((filePath) => !isProductPublicFile(context, filePath))
     .filter((filePath) => {
       const html = fs.readFileSync(filePath, "utf8");
       const brandedHtml = applyBranding(html, context, languageForPublicFile(context, filePath));
@@ -242,6 +277,28 @@ function syncSharedAssets(context) {
   }
 }
 
+function syncProductPages(context) {
+  for (const defaultPath of listProductDefaultPages(context)) {
+    const relative = path.relative(context.defaultPublicDir, defaultPath);
+    const customPath = path.join(context.customPublicDir, relative);
+    if (!fs.existsSync(customPath)) continue;
+    fs.mkdirSync(path.dirname(customPath), { recursive: true });
+    fs.copyFileSync(defaultPath, customPath);
+  }
+}
+
+function listProductDefaultPages(context) {
+  return [
+    path.join(context.defaultPublicDir, "_stats", "index.html"),
+    path.join(context.defaultPublicDir, "_tests", "index.html")
+  ].filter((filePath) => fs.existsSync(filePath));
+}
+
+function isProductPublicFile(context, filePath) {
+  const relative = path.relative(context.customPublicDir, filePath).split(path.sep).join("/");
+  return relative === "_stats/index.html" || relative === "_tests/index.html";
+}
+
 function listSharedDefaultAssets(context) {
   const supported = new Set(context.languages);
   return listFiles(context.defaultPublicDir).filter((filePath) => {
diff --git a/scripts/maintenance.test.mjs b/scripts/maintenance.test.mjs
@@ -191,4 +191,52 @@ function runCommand(cwd, args) {
   );
 }
 
+{
+  const fixture = makeFixture();
+  run(fixture, [
+    "scripts/install.mjs",
+    "--no-check",
+    "--domain",
+    "go.example",
+    "--worker-name",
+    "go-example",
+    "--owner",
+    "team",
+    "--languages",
+    "en,fr",
+    "--operator-timezone",
+    "America/Toronto",
+    "--operator-legal-name",
+    "Example Inc.",
+    "--operator-domain",
+    "example.com",
+    "--operator-abuse-contact",
+    "abuse@example.com",
+    "--operator-security-contact",
+    "security@example.com",
+    "--branding-slogan",
+    "A short-link service for Example Inc.'s projects",
+    "--customize-public"
+  ]);
+
+  const statsPath = path.join(fixture, "custom", "public", "_stats", "index.html");
+  fs.writeFileSync(statsPath, "<!doctype html><title>Old dashboard</title>\n");
+
+  const doctorJson = JSON.parse(run(fixture, ["scripts/doctor.mjs", "--json"]));
+  assert(
+    doctorJson.issues.some(
+      (issue) =>
+        issue.code === "product-page-stale" &&
+        issue.fix === "product-pages" &&
+        issue.path === "custom/public/_stats/index.html"
+    )
+  );
+
+  runCommand(fixture, ["scripts/v8s-fix", "--product-pages"]);
+  assert.equal(
+    fs.readFileSync(statsPath, "utf8"),
+    fs.readFileSync(path.join(fixture, "defaults", "public", "_stats", "index.html"), "utf8")
+  );
+}
+
 console.log("maintenance tests ok");
diff --git a/scripts/v8s-fix.mjs b/scripts/v8s-fix.mjs
@@ -9,9 +9,17 @@ import {
 
 function main() {
   const options = parseReconcileArgs(process.argv.slice(2));
-  const selected = options.public || options.languages || options.assets || options.branding || options.headAssets;
+  const selected =
+    options.public ||
+    options.languages ||
+    options.assets ||
+    options.branding ||
+    options.headAssets ||
+    options.productPages;
   if (!selected) {
-    throw new Error("Choose at least one fix: --head-assets, --assets, --languages, --branding, --public, or --all.");
+    throw new Error(
+      "Choose at least one fix: --head-assets, --assets, --product-pages, --languages, --branding, --public, or --all."
+    );
   }
 
   const context = loadMaintenanceContext();

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ function main() {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`function printRecommendedFixes(issues) {`
`41`		`- const fixes = [...new Set(issues.map((issue) => issue.fix))];`
	`41`	`+ const fixes = [...new Set(issues.map((issue) => issue.fix))].sort(compareFixes);`
`42`	`42`	`const fixCounts = fixes.map((fix) => ({`
`43`	`43`	`fix,`
`44`	`44`	`count: issues.filter((issue) => issue.fix === fix).length`
`@@ -55,6 +55,11 @@ function printRecommendedFixes(issues) {`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`
	`58`	`+function compareFixes(left, right) {`
	`59`	`+ const order = ["product-pages", "head-assets", "assets", "branding", "languages", "public"];`
	`60`	`+ return order.indexOf(left) - order.indexOf(right);`
	`61`	`+}`
	`62`	`+`
`58`	`63`	`try {`
`59`	`64`	`main();`
`60`	`65`	`} catch (error) {`