Files
DongHyeonka 03744e19cf
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 / promote-verified-immutable-candidate (pull_request) Canceled after 0s
frontend-quality-gates / deploy-promoted-release (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
frontend-quality-gates / main / self-tests and removal drills (pull_request) Canceled after 0s
frontend-quality-gates / external-provenance-provider (pull_request) Canceled after 0s
fix(scripts): 제거 드릴의 URL 잔여 검사가 남는 route와 page object를 가린다
문제: 새 눈 리뷰(정적 읽기)가 앞 두 커밋에서 넷을 찾았다.
- 같은 context의 첫 기능은 context 경로(`/invoice`)를, 뒤 기능은 그 아래
  경로(`/invoice/line`)를 받는다. 첫 기능을 지우면 context가 남는데도
  형제 기능 spec의 `"/invoice/line"`이 잔여물로 잡혔다.
- 선택 정적 세그먼트(`/invoice/edit?`)는 접두어가 `/invoice/edit?`가 되어
  아무 URL도 맞지 않았다.
- `` `/invoice${query}` ``와 Playwright `testDir` 안의 page object
  (`tests/e2e/support/*.ts`)는 찾지 않았다.
- `src` 검색이 대소문자를 가리게 되면서, 한 단어 ID(`invoices`)의 옛
  부분 문자열 검색이 잡던 route ID 잔여(`route.INVOICES_LIST.title`)를
  놓쳤다.

고친 것: 드릴이 지우기 전에 지울 route 경로, 남는 route 경로(플랫폼 포함),
지울 route ID(넘겨받은 플랫폼 ID 제외)를 함께 넘긴다. URL 문자열은 맞는
접두어 중 가장 긴 것이 지운 route일 때만 센다(남는 route와 접두어가 같으면
세지 않는다). 접두어는 선택 세그먼트 앞에서 끊고, `${`도 이어짐으로 본다.
`playwright*.config.ts`의 `testDir` 안 파일 중 vitest 시험이 아닌 것도
본다. route ID는 `src` 본문에서 이름 단위로 찾는다.

버린 대안: react-router `matchRoutes`로 모든 문자열을 route 표에 맞추기.
드릴 lib가 앱 라우터에 묶이고, 고정 접두어 비교로 같은 판정을 낸다.

위험·한계: 지운 route와 남는 route의 고정 접두어가 같으면(`/invoice/:id`를
지우고 `/invoice`가 남음) `/invoice/7`을 세지 않는다. 조각으로 만든 URL은
여전히 못 찾는다.

검증(desktop): feature-residue·feature-removal-argument 19개 통과,
check:types·eslint rc=0(로그 /tmp/claude-gates/w2fe2-res4/). 변이 다섯
(남는 route 비교, 선택 세그먼트, `${`, testDir 파일, route ID 검색을 하나씩
끔)마다 해당 시험 하나가 실패했다(로그 /tmp/claude-gates/w2fe2-resmut/).

Refs: 0925 FOLLOW-UP 09-07, 1105/16-04
2026-11-13 05:40:54 +09:00

210 lines
9.9 KiB
TypeScript

import { readdir, readFile } from "node:fs/promises";
import path from "node:path";
/**
* 1105/16-04. What a product feature leaves behind after
* `test:sample-removal -- --feature=<id>` deleted its folders, in the copy the
* drill made.
*
* - `src/`: any file whose path or text still names the feature ID or its
* folder. Platform source never names a product feature, so a name left
* there is a reference the type checker cannot see (a catalog key, a
* runtime override, a link). The name counts as a whole name only: in the
* text, case-sensitive with no identifier character (`[A-Za-z0-9_-]`) on
* either side; in the path, a segment equal to it or whose part before the
* first `.` is. A substring search counted ten template files for
* `product-feature` (`product-features.ts`, `product-features-port.ts` and
* their importers). `src/.generated/` is derived from the feature list and
* left out. A one-word ID that is an ordinary word in the template
* (`search`) can still be found in its text.
* - `tests/`: a file named after the feature (the same path rule; the
* template's `product-feature-switch.test.tsx` is not), or one that imports from the
* feature's `src/features/<dir>/` or `tests/features/<dir>/`. A vitest
* test's text is not searched for the bare name: the template's own tests
* use example IDs as data (`tests/unit/create-feature.test.ts` writes
* `invoice-feature`, the manual's example, 51 times), and the drill flagged
* them as residue of a product feature that took that name. A vitest test
* that still depends on the removed feature fails `test:all`, which the
* drill runs.
* - 1106/16-01. `test:all` runs vitest only (the `*.test.ts(x)` files under
* `tests/`, vitest.config.ts), and no step of the drill runs a Playwright
* spec. So a spec (`*.spec.ts`) that names the feature only in its text,
* such as `test.describe("invoice-feature", ...)`, is residue: its text is
* searched for the ID or folder name as written, case-sensitive, with no
* identifier character (`[A-Za-z0-9_-]`) on either side. A longer name
* that contains it (`generate-product-feature-index.ts` for
* `product-feature`, `KO_MESSAGES` for `messages`) does not count.
* Diff review DR-02: only a name with a hyphen is searched. A one-word ID
* or folder (`status`, `reports`, `messages`) is an ordinary word in the
* template's own specs (`status: 200`, `getByRole("status")`, "reports" in
* a test title), and no text rule tells that from a reference.
* - 0925 FOLLOW-UP 09-07. A spec that opens the feature by its URL alone
* (`page.goto("/invoices")`) failed only in FE-GATE-008, after the drill
* passed. `routes.paths` are the removed feature's route paths: a spec, or
* another file in a Playwright `testDir` that is not a vitest test (a page
* object), with a string that opens one is residue. A string opens a route
* when it starts with the route's fixed prefix (`/invoices` of
* `/invoices/:id` or `/invoices/edit?`) followed by the string's end, `/`,
* `?`, `#` or `${`, and no route left behind (`routes.remainingPaths`) has
* a longer prefix that fits it. A prefix that is `/` is not searched.
* `routes.ids`, the feature's route IDs, are searched in `src` text by the
* whole-name rule. What is still not found: a spec that names only a
* one-word ID, or builds the URL from parts. 03's hand list removes the
* feature's specs.
*
* The drill applies the same rule to a sample a project lists in
* scripts/lib/removable-template-features.ts.
*/
function escapeRegExp(value: string): string {
return value.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&");
}
/**
* The feature ID or folder as a whole name: case-sensitive, with no
* identifier character (`[A-Za-z0-9_-]`) on either side. The drill searches
* `src` text and the built `dist` with it; the template's own bundle holds
* `data-product-feature` and `product-features`, which a substring search
* counted for a feature named `product-feature`.
*/
export function featureNamePattern(featureId: string, directory: string): RegExp {
const names = [...new Set([featureId, directory])].map(escapeRegExp).join("|");
return new RegExp(`(?<![A-Za-z0-9_-])(?:${names})(?![A-Za-z0-9_-])`, "u");
}
async function filesUnder(directory: string): Promise<string[]> {
const entries = await readdir(directory, { withFileTypes: true }).catch(() => []);
const nested = await Promise.all(
entries.map((entry) => {
const target = path.join(directory, entry.name);
return entry.isDirectory() ? filesUnder(target) : Promise.resolve([target]);
}),
);
return nested.flat();
}
/**
* The part of a route path before its first parameter, wildcard or optional
* segment (`/invoices` of `/invoices/:id` or `/invoices/edit?`), or null when
* that is `/`.
*/
function staticRoutePrefix(routePath: string): string | null {
const segments: string[] = [];
for (const segment of routePath.split("/").filter(Boolean)) {
if (segment.startsWith(":") || segment.includes("*") || segment.endsWith("?")) break;
segments.push(segment);
}
return segments.length === 0 ? null : `/${segments.join("/")}`;
}
const prefixesOf = (routePaths: readonly string[]) =>
new Set(routePaths.map(staticRoutePrefix).filter((prefix): prefix is string => prefix !== null));
/** `/invoices`, `/invoices/7`, `/invoices?tab=1`, `/invoices#x`, `/invoices${query}` open `/invoices`. */
function opens(value: string, prefix: string): boolean {
if (!value.startsWith(prefix)) return false;
const rest = value.slice(prefix.length);
return rest === "" || /^[/?#]/u.test(rest) || rest.startsWith("${");
}
/** The Playwright `testDir`s the repository's `playwright*.config.ts` files name. */
async function browserTestDirectories(root: string): Promise<string[]> {
const configs = (await readdir(root).catch(() => [])).filter((name) =>
/^playwright(?:\.[\w-]+)?\.config\.[cm]?[jt]s$/u.test(name),
);
const directories = await Promise.all(
configs.map(async (config) =>
/testDir:\s*["']\.?\/?([^"']+)["']/u.exec(await readFile(path.join(root, config), "utf8"))?.[1]
?.replace(/\/$/u, ""),
),
);
return directories.filter((directory): directory is string => directory !== undefined);
}
export type FeatureRoutes = Readonly<{
/** The removed feature's route paths. */
paths?: readonly string[];
/** Every route path left after the removal, platform routes included. */
remainingPaths?: readonly string[];
/** The removed feature's route IDs, platform IDs it took over left out. */
ids?: readonly string[];
}>;
export async function productFeatureResidue(
root: string,
featureId: string,
directory: string,
routes: FeatureRoutes = {},
): Promise<string[]> {
const nameSet = new Set([featureId, directory]);
const names = [...nameSet].map(escapeRegExp).join("|");
const wholeAnyName = featureNamePattern(featureId, directory);
// A route ID left in platform source (a catalog key, `route.INVOICES_LIST`)
// is found by its whole name too.
const routeIds = [...new Set(routes.ids ?? [])].map(escapeRegExp);
const wholeRouteId =
routeIds.length === 0
? null
: new RegExp(`(?<![A-Za-z0-9_-])(?:${routeIds.join("|")})(?![A-Za-z0-9_-])`, "u");
const pathNames = (relativePath: string) =>
relativePath
.split("/")
.some((segment) => nameSet.has(segment) || nameSet.has(segment.split(".")[0] ?? ""));
const imported = new RegExp(
String.raw`(?:\bfrom\s*|\bimport\s*\(\s*|\bimport\s+|\bmock\s*\(\s*)["'][^"'\n]*/features/(?:${names})/`,
"u",
);
const specNames = [...new Set([featureId, directory])]
.filter((name) => name.includes("-"))
.map(escapeRegExp);
const wholeName =
specNames.length === 0
? null
: new RegExp(`(?<![A-Za-z0-9_-])(?:${specNames.join("|")})(?![A-Za-z0-9_-])`, "u");
// A URL opens the route whose fixed prefix is the longest that fits it, so
// a sibling feature's `/invoices/lines` in the same context is not the
// removed `/invoices`. When a route left behind has the same prefix
// (`/invoices` beside a removed `/invoices/:id`), the URL is not counted.
const removed = prefixesOf(routes.paths ?? []);
const remaining = prefixesOf(routes.remainingPaths ?? []);
const candidates = [...new Set([...removed, ...remaining])].sort((a, b) => b.length - a.length);
const opensRemovedRoute = (text: string) => {
if (removed.size === 0) return false;
for (const match of text.matchAll(/["'`](\/[^"'`\s]*)/gu)) {
const best = candidates.find((prefix) => opens(match[1]!, prefix));
if (best !== undefined && removed.has(best) && !remaining.has(best)) return true;
}
return false;
};
const browserDirectories = await browserTestDirectories(root);
const playwrightSpec = /\.spec\.[cm]?[jt]sx?$/u;
// A page object or helper beside the specs (`tests/e2e/support/*.ts`) runs
// only in a browser too; a vitest test (`*.test.*`) does not.
const browserFile = (name: string) =>
playwrightSpec.test(name) ||
(!/\.test\.[cm]?[jt]sx?$/u.test(name) &&
browserDirectories.some((directory) => name.startsWith(`${directory}/`)));
const residue: string[] = [];
const relative = (file: string) => path.relative(root, file).split(path.sep).join("/");
for (const file of await filesUnder(path.join(root, "src"))) {
const name = relative(file);
if (name.startsWith("src/.generated/")) continue;
const text = await readFile(file, "utf8");
if (pathNames(name) || wholeAnyName.test(text) || (wholeRouteId !== null && wholeRouteId.test(text))) {
residue.push(name);
}
}
for (const file of await filesUnder(path.join(root, "tests"))) {
const name = relative(file);
const text = await readFile(file, "utf8");
if (
pathNames(name) ||
imported.test(text) ||
(playwrightSpec.test(name) && wholeName !== null && wholeName.test(text)) ||
(browserFile(name) && opensRemovedRoute(text))
) {
residue.push(name);
}
}
return residue.sort();
}