frontend-quality-gates / merge / static checks (pull_request) Successful in 1m44s
frontend-quality-gates / FE-GATE-021 / runbook-boot-config (pull_request) Skipped
frontend-quality-gates / FE-GATE-022 / runbook-chunk-mismatch (pull_request) Skipped
frontend-quality-gates / FE-GATE-023 / runbook-api-degradation (pull_request) Skipped
frontend-quality-gates / FE-GATE-024 / runbook-telemetry (pull_request) Skipped
frontend-quality-gates / FE-GATE-025 / runbook-release-rollback (pull_request) Skipped
frontend-quality-gates / FE-GATE-018 / field-web-vitals (pull_request) Skipped
frontend-quality-gates / FE-GATE-017 / diagram-review (pull_request) Skipped
frontend-quality-gates / main / self-tests and removal drills (pull_request) Skipped
frontend-quality-gates / merge / tests (pull_request) Successful in 14m29s
frontend-quality-gates / merge / browser tests (pull_request) Successful in 6m43s
frontend-quality-gates / FE-GATE-014 / config-compatibility (pull_request) Skipped
frontend-quality-gates / FE-GATE-028 / manual-accessibility-review (pull_request) Skipped
frontend-quality-gates / FE-GATE-026 / lab-performance (pull_request) Skipped
frontend-quality-gates / FE-GATE-015 / immutable-release-candidate (pull_request) Skipped
frontend-quality-gates / external-vulnerability-provider (pull_request) Skipped
frontend-quality-gates / external-provenance-provider (pull_request) Skipped
frontend-quality-gates / promote-verified-immutable-candidate (pull_request) Skipped
frontend-quality-gates / deploy-promoted-release (pull_request) Skipped
frontend-quality-gates / FE-GATE-019 / hosting-header (pull_request) Skipped
# Conflicts: # tests/unit/manual-code-blocks.test.ts # tests/unit/template-feature-removal-documents.test.ts
154 lines
6.7 KiB
TypeScript
154 lines
6.7 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { existsSync } from "node:fs";
|
|
import { cp, mkdir, mkdtemp, readdir, readFile, rm, writeFile } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
|
|
import { afterAll, describe, expect, it } from "vitest";
|
|
|
|
import { linkFixtureNodeModules } from "../../scripts/lib/fixture-node-modules.ts";
|
|
import { REMOVAL_FIXTURE_COPY_TARGETS } from "../../scripts/lib/removal-fixture.ts";
|
|
import { selectRepositoryPaths } from "../../scripts/lib/repository-layout.ts";
|
|
import {
|
|
MANUAL_EXAMPLE_FEATURE_ID,
|
|
MANUAL_PROBE_FEATURE_ID,
|
|
renameFeatureText,
|
|
} from "../../scripts/lib/template-probe-features.ts";
|
|
import { childProcessTimeout } from "../helpers/child-process-timeout.ts";
|
|
|
|
/**
|
|
* 2026-11-07. The template ships no sample feature: what the generated
|
|
* feature does not show, docs/manual shows as code blocks a product copies
|
|
* into its feature folder. Each such block has `<!-- manual-code-block: <path> -->`
|
|
* above it, the path in the feature `create:feature invoice-feature
|
|
* --with-create` writes. Here a copy of the repository gets that feature, each
|
|
* block goes to its path unchanged, and the app and test typecheck programs,
|
|
* lint and the feature's tests run on it. A block that is a test runs as it
|
|
* is; what the other blocks do is checked by tests/fixtures/manual-code-blocks.
|
|
*
|
|
* 1112/08-02. The copy holds the product's own features, and a product may
|
|
* well have built `invoice-feature`. So the copy gets the reserved probe
|
|
* feature instead, and every block and check is renamed to it on the way in
|
|
* (`renameFeatureText`): paths, constants, types and words alike.
|
|
*/
|
|
const MANUAL = "docs/manual";
|
|
const FEATURE_ID = MANUAL_PROBE_FEATURE_ID;
|
|
const toProbe = (text: string) => renameFeatureText(text, MANUAL_EXAMPLE_FEATURE_ID, FEATURE_ID);
|
|
const CHECKS = "tests/fixtures/manual-code-blocks";
|
|
const MARKED_BLOCK = /<!-- manual-code-block: (\S+) -->\n```tsx?\n([\s\S]*?)\n```/gu;
|
|
|
|
async function manualDocuments(directory: string): Promise<string[]> {
|
|
const documents: string[] = [];
|
|
for (const entry of await readdir(directory, { withFileTypes: true })) {
|
|
const target = path.join(directory, entry.name);
|
|
if (entry.isDirectory()) documents.push(...(await manualDocuments(target)));
|
|
else if (entry.name.endsWith(".md")) documents.push(target);
|
|
}
|
|
return documents.sort();
|
|
}
|
|
|
|
/** Each marked block by the path it goes to. */
|
|
async function markedBlocks(): Promise<ReadonlyMap<string, string>> {
|
|
const blocks = new Map<string, string>();
|
|
for (const document of await manualDocuments(MANUAL)) {
|
|
for (const [, target = "", body = ""] of (await readFile(document, "utf8")).matchAll(MARKED_BLOCK)) {
|
|
if (blocks.has(target)) throw new Error(`${target} is marked twice in ${MANUAL}`);
|
|
blocks.set(target, `${body}\n`);
|
|
}
|
|
}
|
|
return blocks;
|
|
}
|
|
|
|
const roots: string[] = [];
|
|
|
|
afterAll(async () => {
|
|
await Promise.all(roots.map((root) => rm(root, { recursive: true, force: true })));
|
|
});
|
|
|
|
async function copyRepository(): Promise<string> {
|
|
const root = await mkdtemp(path.join(tmpdir(), "manual-code-blocks-"));
|
|
roots.push(root);
|
|
for (const entry of REMOVAL_FIXTURE_COPY_TARGETS) {
|
|
// A removal drill runs this test in a copy that has already lost some.
|
|
if (!existsSync(path.resolve(entry))) continue;
|
|
await cp(path.resolve(entry), path.join(root, entry), {
|
|
recursive: true,
|
|
filter: (source) => !source.includes(`${path.sep}.generated`),
|
|
});
|
|
}
|
|
await linkFixtureNodeModules(root);
|
|
return root;
|
|
}
|
|
|
|
function run(root: string, command: string, args: readonly string[]) {
|
|
const result = spawnSync(command, args, { cwd: root, encoding: "utf8", maxBuffer: 64 * 1024 * 1024 });
|
|
return { status: result.status, output: `${result.stdout}${result.stderr}` };
|
|
}
|
|
|
|
describe("docs/manual code blocks, pasted into a generated feature", () => {
|
|
it("marks each block with a path in the feature it is written for", async () => {
|
|
const targets = [...(await markedBlocks()).keys()].sort();
|
|
|
|
expect(targets).toEqual([
|
|
"src/features/invoice-feature/adapters/invoice-problem-mapping.ts",
|
|
"src/features/invoice-feature/contracts/invoice-list-search.ts",
|
|
"src/features/invoice-feature/contracts/invoice-problem-details.ts",
|
|
"src/features/invoice-feature/domain/invoice.ts",
|
|
"src/features/invoice-feature/presentation/use-invoice-failure-action.ts",
|
|
"src/features/invoice-feature/presentation/use-invoice-list-filters.ts",
|
|
"tests/features/invoice-feature/invoice-forbidden.test.tsx",
|
|
]);
|
|
});
|
|
|
|
it("typechecks, lints and does what the manual says", async () => {
|
|
const blocks = await markedBlocks();
|
|
const root = await copyRepository();
|
|
const node = process.execPath;
|
|
|
|
// The generator runs first, as `corepack pnpm create:feature` does.
|
|
const indexed = run(root, node, ["scripts/generate-product-feature-index.ts"]);
|
|
expect(indexed.status, indexed.output).toBe(0);
|
|
const created = run(root, node, ["scripts/create-feature.ts", FEATURE_ID, "--with-create"]);
|
|
expect(created.status, created.output).toBe(0);
|
|
|
|
for (const [target, block] of blocks) {
|
|
const file = path.join(root, toProbe(target));
|
|
// A block adds a file; it never stands in for one the command wrote.
|
|
expect(existsSync(file), `${target} exists before the block is pasted`).toBe(false);
|
|
await mkdir(path.dirname(file), { recursive: true });
|
|
await writeFile(file, toProbe(block));
|
|
}
|
|
const checks = (await readdir(CHECKS)).filter((name) => name.endsWith(".check.tsx"));
|
|
expect(checks.length).toBeGreaterThan(0);
|
|
for (const check of checks) {
|
|
await writeFile(
|
|
path.join(root, "tests/features", FEATURE_ID, check.replace(/\.check\.tsx$/u, ".test.tsx")),
|
|
toProbe((await readFile(path.join(CHECKS, check), "utf8")).replaceAll("{{feature}}", MANUAL_EXAMPLE_FEATURE_ID)),
|
|
);
|
|
}
|
|
|
|
for (const program of selectRepositoryPaths("feature-typecheck")) {
|
|
const typecheck = run(root, path.resolve("node_modules/.bin/tsc"), ["--project", program]);
|
|
expect(typecheck.output, program).toBe("");
|
|
expect(typecheck.status, program).toBe(0);
|
|
}
|
|
const lint = run(root, path.resolve("node_modules/.bin/eslint"), [
|
|
`src/features/${FEATURE_ID}`,
|
|
`tests/features/${FEATURE_ID}`,
|
|
"--max-warnings=0",
|
|
]);
|
|
expect(lint.output).toBe("");
|
|
expect(lint.status).toBe(0);
|
|
const architecture = run(root, node, ["scripts/check-architecture.ts"]);
|
|
expect(architecture.status, architecture.output).toBe(0);
|
|
|
|
const tests = run(root, node, [
|
|
"scripts/run-vitest.ts",
|
|
"run",
|
|
`tests/features/${FEATURE_ID}`,
|
|
"--reporter=dot",
|
|
]);
|
|
expect(tests.status, tests.output).toBe(0);
|
|
}, childProcessTimeout(59_545));
|
|
});
|