diff --git a/scripts/lib/feature-residue.ts b/scripts/lib/feature-residue.ts
index 95202ea2..0dbae38c 100644
--- a/scripts/lib/feature-residue.ts
+++ b/scripts/lib/feature-residue.ts
@@ -9,8 +9,16 @@ import path from "node:path";
* - `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).
- * - `tests/`: a file named after the feature, or one that imports from the
+ * 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/
/` or `tests/features//`. 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
@@ -25,14 +33,24 @@ import path from "node:path";
* 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. A spec
- * that names only the feature's routes or URLs is not found; 03's hand list
- * removes the feature's specs.
+ * `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, so a spec
- * that names only a one-word ID is not found either.
+ * 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.
@@ -41,6 +59,18 @@ 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(`(? {
const entries = await readdir(directory, { withFileTypes: true }).catch(() => []);
const nested = await Promise.all(
@@ -52,13 +82,73 @@ async function filesUnder(directory: string): Promise {
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 {
+ 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 {
- const names = [...new Set([featureId, directory])].map(escapeRegExp).join("|");
- const named = new RegExp(names, "iu");
+ 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(`(?
+ 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",
@@ -70,20 +160,47 @@ export async function productFeatureResidue(
specNames.length === 0
? null
: new RegExp(`(? 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 (named.test(`${name}\n${await readFile(file, "utf8")}`)) residue.push(name);
+ 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 (
- named.test(name) ||
+ pathNames(name) ||
imported.test(text) ||
- (wholeName !== null && playwrightSpec.test(name) && wholeName.test(text))
+ (playwrightSpec.test(name) && wholeName !== null && wholeName.test(text)) ||
+ (browserFile(name) && opensRemovedRoute(text))
) {
residue.push(name);
}
diff --git a/scripts/test-sample-removal.ts b/scripts/test-sample-removal.ts
index 9905413c..893a668a 100644
--- a/scripts/test-sample-removal.ts
+++ b/scripts/test-sample-removal.ts
@@ -10,10 +10,11 @@ import { spawnSync } from "node:child_process";
import path from "node:path";
import { fileURLToPath } from "node:url";
-import { ROUTE_FEATURE_OWNER } from "../src/features/installed-feature-contracts.ts";
+import { PLATFORM_ROUTE_REGISTRY } from "../src/contracts/routes.ts";
+import { ROUTE_FEATURE_OWNER, routePath } from "../src/features/installed-feature-contracts.ts";
import { loadCiGateContract } from "./contracts/ci-gates.ts";
import { createFileSystemDeclarationSource } from "./generate-product-feature-index.ts";
-import { productFeatureResidue } from "./lib/feature-residue.ts";
+import { featureNamePattern, type FeatureRoutes, productFeatureResidue } from "./lib/feature-residue.ts";
import { isProductionModulePath } from "./lib/risk-coverage.ts";
import {
createRemovalFixtureRoot,
@@ -164,6 +165,22 @@ const located = await locateFeature(featureId);
const featureRouteIds = Object.entries(ROUTE_FEATURE_OWNER)
.filter(([, owner]) => owner === featureId)
.map(([routeId]) => routeId);
+// 0925 FOLLOW-UP 09-07. A browser test that opens the feature by one of these
+// paths is residue (scripts/lib/feature-residue.ts). A platform route the
+// feature took over (its home) goes back to the platform with the removal.
+const platformRoutePaths = new Set(
+ Object.values(PLATFORM_ROUTE_REGISTRY).map((route) => route.path),
+);
+const featureRoutes: FeatureRoutes = Object.freeze({
+ paths: featureRouteIds.map(routePath).filter((candidate) => !platformRoutePaths.has(candidate)),
+ remainingPaths: [
+ ...platformRoutePaths,
+ ...Object.keys(ROUTE_FEATURE_OWNER)
+ .filter((routeId) => !featureRouteIds.includes(routeId))
+ .map(routePath),
+ ],
+ ids: featureRouteIds.filter((routeId) => !Object.hasOwn(PLATFORM_ROUTE_REGISTRY, routeId)),
+});
const fixtureRoot = await createRemovalFixtureRoot(`${featureId}-removal`);
const pnpmCli = requireRemovalFixtureEnvironment("npm_execpath");
@@ -455,11 +472,17 @@ try {
// 1105/16-04. Template tests use example feature IDs as data; only what
// still points at the removed feature counts (scripts/lib/feature-residue.ts).
- const residue = await productFeatureResidue(fixtureRoot, featureId, located.directory);
- const builtResiduePattern = new RegExp(
- `${escapeRegExp(featureId)}|${escapeRegExp(located.directory)}`,
- "i",
+ // 0925 FOLLOW-UP 09-07. The drill runs no Playwright spec; one that still
+ // opens the feature's URL is found here instead of in FE-GATE-008.
+ const residue = await productFeatureResidue(
+ fixtureRoot,
+ featureId,
+ located.directory,
+ featureRoutes,
);
+ // 1105/16-04. The same whole-name rule as `src`: the template's bundle
+ // holds `data-product-feature`, which a substring search counted.
+ const builtResiduePattern = featureNamePattern(featureId, located.directory);
const missingCommonTests: string[] = [];
for (const testPath of commonTestPaths) {
diff --git a/tests/unit/feature-residue.test.ts b/tests/unit/feature-residue.test.ts
index 7b3f374c..01352019 100644
--- a/tests/unit/feature-residue.test.ts
+++ b/tests/unit/feature-residue.test.ts
@@ -4,7 +4,7 @@ import path from "node:path";
import { afterAll, describe, expect, it } from "vitest";
-import { productFeatureResidue } from "../../scripts/lib/feature-residue.ts";
+import { featureNamePattern, productFeatureResidue } from "../../scripts/lib/feature-residue.ts";
/**
* 1105/16-04. The manual's example ID is `invoice-feature` (01 1단계), and
@@ -85,6 +85,111 @@ describe("product feature residue (1105/16-04)", () => {
]);
});
+ // 0925 FOLLOW-UP 09-07. No step of the drill runs a Playwright spec, so a
+ // spec that opens the removed feature by its URL alone passed the drill and
+ // failed FE-GATE-008 afterwards.
+ it("counts a Playwright spec that opens one of the feature's route paths", async () => {
+ const root = await fixture({
+ "tests/e2e/route-only.spec.ts": 'test("opens", ({ page }) => page.goto("/invoice"));\n',
+ "tests/e2e/detail.spec.ts": "await page.goto(`/invoice/${id}?tab=lines`);\n",
+ "tests/visual/hash.visual.spec.ts": "await page.goto('/invoice#total');\n",
+ "tests/e2e/longer-path.spec.ts": 'await page.goto("/invoices-archive");\n',
+ "tests/e2e/other-base.spec.ts": 'await page.goto("/admin/invoice");\n',
+ // The same text in a vitest test is data (1105/16-04).
+ "tests/unit/route.test.ts": 'const target = "/invoice";\n',
+ });
+
+ expect(await productFeatureResidue(root, ID, ID, { paths: ["/invoice", "/invoice/:invoiceId"] })).toEqual([
+ "tests/e2e/detail.spec.ts",
+ "tests/e2e/route-only.spec.ts",
+ "tests/visual/hash.visual.spec.ts",
+ ]);
+ });
+
+ // Diff review of 09-07. The first feature of a context takes the context's
+ // path (`/invoice`) and a later one a path under it (`/invoice/line`), and
+ // the context stays while another feature is in it.
+ it("leaves a URL to a route still there with a longer prefix, such as a sibling feature's", async () => {
+ const root = await fixture({
+ "tests/e2e/lines.spec.ts": 'await page.goto("/invoice/line");\nawait page.goto("/invoice/line/7");\n',
+ "tests/e2e/detail.spec.ts": 'await page.goto("/invoice/7");\n',
+ "tests/e2e/shared-prefix.spec.ts": 'await page.goto("/report/2026");\n',
+ });
+
+ expect(
+ await productFeatureResidue(root, ID, ID, {
+ paths: ["/invoice", "/report/:year"],
+ remainingPaths: ["/", "/invoice/line", "/report"],
+ }),
+ ).toEqual(["tests/e2e/detail.spec.ts"]);
+ });
+
+ it("stops a route prefix at an optional segment and finds a URL built with a template", async () => {
+ const root = await fixture({
+ "tests/e2e/edit.spec.ts": 'await page.goto("/invoice/edit");\n',
+ "tests/e2e/query.spec.ts": "await page.goto(`/invoice${query}`);\n",
+ });
+
+ expect(await productFeatureResidue(root, ID, ID, { paths: ["/invoice/edit?"] })).toEqual([
+ "tests/e2e/edit.spec.ts",
+ "tests/e2e/query.spec.ts",
+ ]);
+ });
+
+ it("searches a page object in a Playwright testDir, not a mock or a vitest test", async () => {
+ const root = await fixture({
+ "playwright.config.ts": 'export default defineConfig({ testDir: "./tests/e2e" });\n',
+ "tests/e2e/support/invoice-page.ts": 'export const open = (page) => page.goto("/invoice");\n',
+ "tests/e2e/support/route.test.ts": 'const target = "/invoice";\n',
+ "tests/mocks/handlers/routes.ts": 'export const PAGE = "/invoice";\n',
+ });
+
+ expect(await productFeatureResidue(root, ID, ID, { paths: ["/invoice"] })).toEqual([
+ "tests/e2e/support/invoice-page.ts",
+ ]);
+ });
+
+ it("finds the feature's route IDs in source by their whole name", async () => {
+ const root = await fixture({
+ "src/contracts/titles.ts": "export const TITLE = messages.route.INVOICE_LIST.title;\n",
+ "src/contracts/longer.ts": 'export const KEY = "INVOICE_LIST_V2";\n',
+ });
+
+ expect(await productFeatureResidue(root, ID, ID, { ids: ["INVOICE_LIST"] })).toEqual([
+ "src/contracts/titles.ts",
+ ]);
+ });
+
+ it("does not search a route path that is the root before its first parameter", async () => {
+ const root = await fixture({
+ "tests/e2e/home.spec.ts": 'await page.goto("/");\nawait page.goto("/?lang=ko");\n',
+ });
+
+ expect(await productFeatureResidue(root, ID, ID, { paths: ["/", "/:invoiceId", "*"] })).toEqual([]);
+ });
+
+ it("does not count the template's own browser tests for the route paths of a generated feature", async () => {
+ const files: Record = {};
+ for (const entry of await readdir(".")) {
+ if (/^playwright.*\.config\.ts$/u.test(entry)) files[entry] = await readFile(entry, "utf8");
+ }
+ expect(Object.keys(files)).toContain("playwright.config.ts");
+ for (const entry of await readdir("tests", { recursive: true, withFileTypes: true })) {
+ if (!entry.isFile()) continue;
+ const file = path.join(entry.parentPath, entry.name).split(path.sep).join("/");
+ if (!/\.[cm]?[jt]sx?$/u.test(file)) continue;
+ if (/^tests\/(?:e2e|visual|storybook|browser-capabilities)\//u.test(file) || /\.spec\./u.test(file)) {
+ files[file] = await readFile(file, "utf8");
+ }
+ }
+ const root = await fixture(files);
+
+ // create:feature product-feature declares PRODUCT_LIST at /product.
+ expect(
+ await productFeatureResidue(root, "product-feature", "product-feature", { paths: ["/product"] }),
+ ).toEqual([]);
+ });
+
it("does not count a spec whose longer names only contain the ID", async () => {
const root = await fixture({
"tests/e2e/builds.spec.ts": [
@@ -111,7 +216,8 @@ describe("product feature residue (1105/16-04)", () => {
if (/\.spec\.[cm]?[jt]sx?$/u.test(file)) specs[file] = await readFile(file, "utf8");
}
expect(Object.keys(specs)).toContain("tests/e2e/accessibility.spec.ts");
- // A copy of the specs alone: `src` is searched by substring (1105/16-04).
+ // A copy of the specs alone: a one-word ID that the template's source uses
+ // as a word (`status`) is still found in `src` text (feature-residue.ts).
const root = await fixture(specs);
for (const id of ["product-feature", "messages", "status", "reports"]) {
@@ -144,4 +250,42 @@ describe("product feature residue (1105/16-04)", () => {
"tests/unit/x.test.ts",
]);
});
+
+ // 1112 round9 (1105/16-04 remainder). `src` was searched by case-insensitive
+ // substring over path and text, so a legitimate ID such as
+ // `product-feature` counted ten template files (`product-features.ts`,
+ // `product-features-port.ts` and their importers) as residue.
+ it("does not count the template's own source and tests for an ID that longer names contain", async () => {
+ expect(await productFeatureResidue(process.cwd(), "product-feature", "product-feature")).toEqual([]);
+ });
+
+ // 1112 round9 (1105/16-04 remainder). The drill searched the built `dist`
+ // by case-insensitive substring too, so removing `product-feature` failed
+ // on the template's own platform-overview chunk (`data-product-feature`).
+ it("finds the feature in a built chunk by its whole name only", () => {
+ const pattern = featureNamePattern("product-feature", "product-feature");
+ expect(pattern.test('createElement("p",{"data-product-feature":e.featureId})')).toBe(false);
+ expect(pattern.test('const r="product-features";')).toBe(false);
+ expect(pattern.test('const t="Product-Feature";')).toBe(false);
+ expect(pattern.test('chunkId:"route-product",owner:"product-feature"')).toBe(true);
+ expect(featureNamePattern(ID, "invoices").test('import("./invoices/page.js")')).toBe(true);
+ });
+
+ it("counts a source path or text that names the ID as a whole name, and ignores the generated index", async () => {
+ const root = await fixture({
+ "src/contracts/leftover.ts": 'export const OWNER = "product-feature";\n',
+ "src/features/product-feature/stale.ts": "export const STALE = 1;\n",
+ "src/contracts/product-feature-port.ts": "export const PORT = 1;\n",
+ "src/contracts/product-features.ts": 'export const KEY = "data-product-feature";\n',
+ "src/contracts/title-case.ts": 'export const TITLE = "Product-Feature";\n',
+ "src/.generated/product-feature-index.ts": 'export const IDS = ["product-feature"];\n',
+ });
+
+ // A longer file name that starts with the ID is not the feature's file;
+ // the template's own tests/component/product-feature-switch.test.tsx is one.
+ expect(await productFeatureResidue(root, "product-feature", "product-feature")).toEqual([
+ "src/contracts/leftover.ts",
+ "src/features/product-feature/stale.ts",
+ ]);
+ });
});