Files
clean-architecture-frontend…/tests/unit/manual-paired-backend-settings.test.ts
DongHyeonka ceaf316f65
frontend-quality-gates / merge / static checks (pull_request) Canceled after 0s
frontend-quality-gates / merge / tests (pull_request) Canceled after 0s
frontend-quality-gates / merge / browser tests (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-014 / config-compatibility (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-026 / lab-performance (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-028 / manual-accessibility-review (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-015 / immutable-release-candidate (pull_request) Canceled after 0s
frontend-quality-gates / external-vulnerability-provider (pull_request) Canceled after 0s
frontend-quality-gates / external-provenance-provider (pull_request) Canceled after 0s
frontend-quality-gates / promote-verified-immutable-candidate (pull_request) Canceled after 0s
frontend-quality-gates / deploy-promoted-release (pull_request) Canceled after 0s
frontend-quality-gates / main / self-tests and removal drills (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-019 / hosting-header (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-021 / runbook-boot-config (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-022 / runbook-chunk-mismatch (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-023 / runbook-api-degradation (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-024 / runbook-telemetry (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-025 / runbook-release-rollback (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-018 / field-web-vitals (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-017 / diagram-review (pull_request) Canceled after 0s
test(setup): 시험 timeout을 모두 desktop 실측값으로 주고 손 숫자를 거절한다
문제: 자식 프로세스 시험의 timeout은 `childProcessTimeout(<잰 ms>)`로
정한다(docs/work/reference/testing.md 2절). 그런데 기본값이 아니라서
`tests/setup.ts` 검사에 걸리지 않는 손 숫자가 남았다. 리뷰가 센 54곳 중
둘(`browser-soak.contract.test.ts`의 `evaluateSoak` 인자)은 timeout이 아니고,
AST로 다시 세면 80곳이다: 시험·describe·hook에 쓴 숫자, `VERIFY_TIMEOUT`·
`PROCESS_HEAVY_TIMEOUT_MS`(파일 넷에 따로)·`PROVIDER_BASE_FIXTURE_TIMEOUT_MS`
같은 상수, `PROCESS_WATCHDOG_MS * 3` 같은 식. taxonomy는 옛 상수를 예로
들었다. 실측으로 보면 손 숫자 하나가 모자랐다: system 시험의 provider 묶음
30초는 desktop 여섯 번 중 두 번 넘겼다.

고친 것:
- 80곳을 desktop에서 잰 가장 긴 실행으로 `childProcessTimeout(<ms>)`에
  넘긴다. coverage 묶음(maxWorkers=4)·test:unit 각 9회, integration 3회,
  scale(traffic·session·composition·global-local) 3회, 시스템 컨테이너의
  tests/system 6회, JSON reporter로 받았다. hook은 파일 시간에서 시험 합을
  뺀 값이다. 시간 초과로 끝난 실행은 그 시간을 하한으로 넣었다.
- 상수 사본은 지운다. 한 파일 안에서 여럿이 쓰는 값만
  `const X = childProcessTimeout(...)`로 둔다(`VERIFY_TIMEOUT`). guardian
  시험의 lease는 시험 timeout이 아니라 `childProcessTimeout(0)`(helper의 최소
  30초)로 둔다.
- `tests/unit/test-timeout-declarations.test.ts`가 tests/의 Vitest 파일을
  Babel로 읽어 시험·describe·hook의 timeout 인자가 helper 호출(또는 그것을
  담은 파일 상수)이 아니면 파일과 줄로 실패한다. 프로세스 안에서 도는 긴
  시험(scale tier)도 같은 helper를 쓴다.
- taxonomy 예시, testing.md 2절, `.claude/rules/tests.md` 9번, helper 머리
  주석을 같은 방법으로 맞춘다.

버린 대안:
- `tests/setup.ts` 검사를 「helper가 만든 값이 아닌 timeout」까지 넓히기.
  helper 값은 30초 단위 숫자라 손으로 쓴 60_000과 가릴 수 없고, hook과
  프로세스 안 시험은 보지 못한다.
- 프로세스 안 시험은 손 숫자 그대로 두기. 근거 없는 숫자가 남고 검사가
  예외를 가져야 한다.

위험·한계:
- 값이 커진 곳이 있다(15배 규칙): `manual-code-blocks` 300초 → 900초,
  provider 묶음 30초 → 480초 등. hang을 늦게 잡는다. 줄어든 곳도 있다
  (scale traffic 60초 → 30초 등, 잰 값의 15배 안).
- 측정은 desktop 부하 6~35에서 했다. runner가 더 느리면 다시 잰다.
- 검사 시험은 Vitest 파일 전부를 파싱해 coverage 묶음에서 최대 13.5초
  걸렸고, 그 값으로 자기 timeout을 준다. 이름 있는 함수를 콜백으로 넘긴
  시험(`it("x", run, 30_000)`)은 못 찾는다.
- 다운스트림: 손 숫자 timeout이 있는 제품 시험은 test:unit에서 이 검사에
  걸린다. 메시지가 helper를 알린다.

검증(desktop):
- RED: 검사 시험이 고치기 전 80곳을 파일·줄로 내고 실패. GREEN: 검사·
  child-process-timeout 6개 통과. check:types·eslint(바뀐 34파일) rc=0,
  verify:documentation PASS_SCOPED, 노트북 `scripts/verify.sh docs` OK.
- 측정 원자료: /tmp/claude-gates/w2fe2-t08m, -t08m2, -t08m3.
- 게이트 결과는 PR 본문에 적는다.

Refs: 1112/03-08
2026-11-13 06:47:02 +09:00

147 lines
6.2 KiB
TypeScript

import { spawnSync } from "node:child_process";
import { existsSync } from "node:fs";
import { cp, mkdtemp, readFile, rename, 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 { childProcessTimeout } from "../helpers/child-process-timeout.ts";
/**
* 1105/14-02. docs/manual/04-paired-backend-session.md §3.2 is the block a
* product pastes into src/contracts/product-contracts.ts for the OIDC
* settings of the paired backend's jwt mode. Its FE-REG-ENV rows had no
* `defaultValue`, so pasted as written `check:types` failed (TS2322 in
* src/contracts/env.ts) and so did env-registry-coverage. This puts the
* block, unchanged, into a copy of the repository next to the product's own
* settings and runs the app typecheck program and that row check on it.
*/
const MANUAL = "docs/manual/04-paired-backend-session.md";
const PRODUCT_CONTRACTS = "src/contracts/product-contracts.ts";
/** Reserved for this test, so a product's own files are never overwritten. */
const MANUAL_SETTINGS = "src/contracts/manual-04-product-settings.ts";
const KEPT_CONTRACTS = "src/contracts/manual-04-kept-product-contracts.ts";
const ROW_CHECK = "manual-04-env-rows.ts";
/** The first ts block of the manual's §3.2. */
function settingsBlock(manual: string): string {
const section = manual.split(/^### 3\.2 /mu)[1]?.split(/^### /mu)[0] ?? "";
const block = /```ts\n([\s\S]*?)\n```/u.exec(section)?.[1];
if (block === undefined) throw new Error(`${MANUAL} §3.2 has no ts block`);
return `${block}\n`;
}
/** product-contracts.ts: the product's own file, kept beside it, plus the manual's keys. */
const PRODUCT_CONTRACTS_SOURCE = `import {
PRODUCT_ENV_REGISTRY as KEPT_PRODUCT_ENV_REGISTRY,
PRODUCT_RUNTIME_CONFIG_FIELDS as KEPT_PRODUCT_RUNTIME_CONFIG_FIELDS,
} from "./${path.posix.basename(KEPT_CONTRACTS)}";
import {
PRODUCT_ENV_REGISTRY as MANUAL_PRODUCT_ENV_REGISTRY,
PRODUCT_RUNTIME_CONFIG_FIELDS as MANUAL_PRODUCT_RUNTIME_CONFIG_FIELDS,
} from "./${path.posix.basename(MANUAL_SETTINGS)}";
export * from "./${path.posix.basename(KEPT_CONTRACTS)}";
export const PRODUCT_RUNTIME_CONFIG_FIELDS = Object.freeze({
...KEPT_PRODUCT_RUNTIME_CONFIG_FIELDS,
...MANUAL_PRODUCT_RUNTIME_CONFIG_FIELDS,
});
export const PRODUCT_ENV_REGISTRY = Object.freeze({
...KEPT_PRODUCT_ENV_REGISTRY,
...MANUAL_PRODUCT_ENV_REGISTRY,
} as const);
`;
/**
* The rule of tests/unit/env-registry-coverage.test.ts, for the manual's
* keys: each has a runtime row whose `required` and `defaultValue` are what
* the schema field does with an absent key.
*/
const ROW_CHECK_SOURCE = `import { isDeepStrictEqual } from "node:util";
import { ENV_REGISTRY } from "./src/contracts/env.ts";
import { PRODUCT_ENV_REGISTRY } from "./${MANUAL_SETTINGS}";
import { runtimeConfigV2ArtifactSchema } from "./src/contracts/release-artifacts.ts";
const shape = runtimeConfigV2ArtifactSchema.shape as Record<
string,
{ safeParse(value: unknown): { success: boolean; data?: unknown } }
>;
const rows = ENV_REGISTRY as Record<string, { phase: string; required: boolean; defaultValue?: unknown }>;
const problems = Object.keys(PRODUCT_ENV_REGISTRY).flatMap((key) => {
const field = shape[key];
const row = rows[key];
if (field === undefined || row?.phase !== "runtime") return [key + ": no runtime config field or runtime row"];
const parsed = field.safeParse(undefined);
const expected = parsed.success
? { required: false, defaultValue: parsed.data ?? null }
: { required: true, defaultValue: null };
const declared = { required: row.required, defaultValue: row.defaultValue };
return isDeepStrictEqual(declared, expected)
? []
: [key + ": row " + JSON.stringify(declared) + ", schema " + JSON.stringify(expected)];
});
process.stdout.write(JSON.stringify(problems));
`;
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-paired-backend-settings-"));
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;
}
describe("docs/manual/04 §3.2 product settings, pasted as written (1105/14-02)", () => {
it("typechecks and states the FE-REG-ENV rows as the schema reads the keys", async () => {
const block = settingsBlock(await readFile(MANUAL, "utf8"));
expect(block).toContain("PRODUCT_ENV_REGISTRY");
const root = await copyRepository();
for (const reserved of [MANUAL_SETTINGS, KEPT_CONTRACTS, ROW_CHECK]) {
expect(existsSync(path.join(root, reserved)), reserved).toBe(false);
}
await rename(path.join(root, PRODUCT_CONTRACTS), path.join(root, KEPT_CONTRACTS));
await writeFile(path.join(root, MANUAL_SETTINGS), block);
await writeFile(path.join(root, PRODUCT_CONTRACTS), PRODUCT_CONTRACTS_SOURCE);
await writeFile(path.join(root, ROW_CHECK), ROW_CHECK_SOURCE);
const generated = spawnSync(
process.execPath,
[path.resolve("scripts/generate-product-feature-index.ts"), `--root=${root}`],
{ encoding: "utf8" },
);
expect(generated.stderr).toBe("");
expect(generated.status).toBe(0);
const typecheck = spawnSync(
path.resolve("node_modules/.bin/tsc"),
["--project", path.join(root, "tsconfig.app.json")],
{ encoding: "utf8" },
);
expect(typecheck.stdout + typecheck.stderr).toBe("");
expect(typecheck.status).toBe(0);
const rows = spawnSync(process.execPath, [path.join(root, ROW_CHECK)], { cwd: root, encoding: "utf8" });
expect(rows.stderr).toBe("");
expect(JSON.parse(rows.stdout)).toEqual([]);
}, childProcessTimeout(20_052));
});