browser-safety.test.ts

browser-safety.test.tspackages/shared/src/dto/browser-safety.test.tsraw ← dto2,832 B← Back to the app
1import { existsSync, readFileSync, readdirSync } from "node:fs";
2import { fileURLToPath } from "node:url";
3import { dirname, join, resolve } from "node:path";
4import { describe, expect, it } from "vitest";
5 
6/**
7 * GUARD: `@factory/shared/dto` is the browser-safe DTO surface — the web
8 * bundle (Next.js/webpack) imports it, so it must never pull a Node builtin
9 * (`node:crypto`, `node:fs`, …) into the browser. A Node-only import here
10 * fails the web build with `UnhandledSchemeError` (regression: the
11 * `webhook.dto.ts → events.ts → node:crypto` edge that broke every page).
12 *
13 * We scan every `dto/*.ts` file and its (recursive) relative-import closure
14 * — the barrel transitively reaches `constants.ts`, `positions.ts`,
15 * `webhook-events.ts`, `formula-ast.ts`, … — and assert none of them import
16 * a Node builtin. Only REAL import/export-from statements are considered
17 * (comments, including JSDoc examples, are stripped first).
18 */
19describe("@factory/shared/dto browser safety (no Node builtins in the web bundle)", () => {
20  const dtoDir = dirname(fileURLToPath(import.meta.url));
21 
22  /** Specifiers of every real import/export-from statement in the file. */
23  const importSpecifiersOf = (file: string): string[] => {
24    const src = readFileSync(file, "utf8");
25    // Strip comments so doc examples (e.g. JSDoc quoting an import) are ignored.
26    const code = src.replace(/\/\*[\s\S]*?\*\//g, "").replace(/^\s*\/\/.*$/gm, "");
27    const specs = new Set<string>();
28    for (const m of code.matchAll(/\b(?:import|export)\b[\s\S]*?\bfrom\s*["']([^"']+)["']/g)) {
29      const spec = m[1];
30      if (spec) specs.add(spec);
31    }
32    for (const m of code.matchAll(/^\s*import\s*["']([^"']+)["']/gm)) {
33      const spec = m[1];
34      if (spec) specs.add(spec);
35    }
36    return [...specs];
37  };
38 
39  it("contains no file that imports a node: builtin (directly or transitively)", () => {
40    const seen = new Set<string>();
41    const queue = readdirSync(dtoDir)
42      .filter((f) => f.endsWith(".ts") && !f.endsWith(".test.ts"))
43      .map((f) => join(dtoDir, f));
44    const offenders: string[] = [];
45    while (queue.length) {
46      const file = queue.pop()!;
47      if (seen.has(file)) continue;
48      seen.add(file);
49      for (const spec of importSpecifiersOf(file)) {
50        if (spec.startsWith("node:") || /^(crypto|fs|path|os|stream|buffer)$/.test(spec)) {
51          offenders.push(`${file} → "${spec}"`);
52          continue;
53        }
54        if (spec.startsWith(".")) {
55          const target = resolve(dirname(file), spec.replace(/\.js$/, ".ts"));
56          if (!existsSync(target)) {
57            offenders.push(`${file} → "${spec}" (unresolvable relative import)`);
58            continue;
59          }
60          queue.push(target);
61        }
62      }
63    }
64    expect(offenders).toEqual([]);
65  });
66});
67