ENG-1798 Fix website docs search (#1081)

* Fix docs search build and cache Pagefind assets

* Harden Pagefind build config test

Author: mdroidian

apps/website/package.json

@@ -6,8 +6,8 @@
   "license": "Apache-2.0",
   "scripts": {
     "dev": "next dev",
-    "build": "next build",
-    "postbuild": "node ./scripts/build-docs-search-index.mjs",
+    "build": "next build && node ./scripts/build-docs-search-index.mjs",
+    "build:search": "node ./scripts/build-docs-search-index.mjs",
     "start": "next start",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",

apps/website/scripts/build-docs-search-index.test.mjs

@@ -1,12 +1,68 @@
 import test from "node:test";
 import assert from "node:assert/strict";
+import fs from "node:fs";
 import path from "node:path";
 import {
   markdownToSearchText,
   routePathFromContentFile,
   searchFiltersFromContentFile,
 } from "./build-docs-search-index.mjs";
 
+/**
+ * @typedef {{ scripts: { build: string, postbuild?: string } }} WebsitePackageJson
+ * @typedef {{ tasks: { build: { outputs: string[] } } }} TurboJson
+ */
+
+/**
+ * @param {unknown} value
+ * @returns {value is Record<string, unknown>}
+ */
+const isRecord = (value) =>
+  typeof value === "object" && value !== null && !Array.isArray(value);
+
+/**
+ * @param {unknown} value
+ * @returns {value is string[]}
+ */
+const isStringArray = (value) =>
+  Array.isArray(value) && value.every((item) => typeof item === "string");
+
+/**
+ * @param {string} filePath
+ * @returns {unknown}
+ */
+const readJsonFile = (filePath) =>
+  /** @type {unknown} */ (JSON.parse(fs.readFileSync(filePath, "utf8")));
+
+/**
+ * @param {unknown} value
+ * @returns {WebsitePackageJson}
+ */
+const assertWebsitePackageJson = (value) => {
+  assert.ok(isRecord(value));
+  assert.ok(isRecord(value.scripts));
+  assert.equal(typeof value.scripts.build, "string");
+  assert.ok(
+    value.scripts.postbuild === undefined ||
+      typeof value.scripts.postbuild === "string",
+  );
+
+  return /** @type {WebsitePackageJson} */ (value);
+};
+
+/**
+ * @param {unknown} value
+ * @returns {TurboJson}
+ */
+const assertTurboJson = (value) => {
+  assert.ok(isRecord(value));
+  assert.ok(isRecord(value.tasks));
+  assert.ok(isRecord(value.tasks.build));
+  assert.ok(isStringArray(value.tasks.build.outputs));
+
+  return /** @type {TurboJson} */ (value);
+};
+
 void test("routePathFromContentFile maps content files to canonical docs routes", () => {
   assert.equal(
     routePathFromContentFile(
@@ -78,3 +134,25 @@ void test("searchFiltersFromContentFile scopes docs records by platform", () =>
     undefined,
   );
 });
+
+void test("build configuration includes generated Pagefind assets", () => {
+  const packageJson = assertWebsitePackageJson(readJsonFile("package.json"));
+  assert.match(
+    packageJson.scripts.build,
+    /build-docs-search-index\.mjs/u,
+    "website build must generate the Pagefind index when run by Turbo",
+  );
+  assert.doesNotMatch(
+    packageJson.scripts.postbuild ?? "",
+    /build-docs-search-index\.mjs/u,
+    "Turbo does not run package postbuild hooks for this task",
+  );
+
+  const turboJson = assertTurboJson(
+    readJsonFile(path.join("..", "..", "turbo.json")),
+  );
+  assert.ok(
+    turboJson.tasks.build.outputs.includes("public/_pagefind/**"),
+    "Turbo must cache and restore the generated Pagefind assets",
+  );
+});

turbo.json

@@ -48,7 +48,13 @@
       "env": ["ROAM_BUILD_SCRIPT"],
       "dependsOn": ["@repo/database#genenv"],
       "inputs": ["$TURBO_DEFAULT$", ".env*"],
-      "outputs": [".next/**", "!.next/cache/**", "dist/**", "src/dbTypes.ts"]
+      "outputs": [
+        ".next/**",
+        "!.next/cache/**",
+        "dist/**",
+        "public/_pagefind/**",
+        "src/dbTypes.ts"
+      ]
     },
     "build-schema": {
       "inputs": ["$TURBO_DEFAULT$", ".env*"],