diff --git a/scripts/lib/risk-coverage.ts b/scripts/lib/risk-coverage.ts index 719c5890..65b08ef0 100644 --- a/scripts/lib/risk-coverage.ts +++ b/scripts/lib/risk-coverage.ts @@ -427,6 +427,13 @@ function statementIsCoverageCounterBearing(value: unknown): boolean { return true; } +function directiveIsCoverageCounterBearing(value: unknown): boolean { + if (!isRecord(value) || !isRecord(value.value) || typeof value.value.value !== "string") { + throw new TypeError("TypeScript parser returned an invalid directive"); + } + return value.value.value !== "use strict"; +} + export function hasCoverageCounterBearingStatements( source: string, relativePath: string, @@ -457,10 +464,20 @@ export function hasCoverageCounterBearingStatements( }); } const program = isRecord(parsed) ? parsed.program : undefined; - if (!isRecord(program) || !Array.isArray(program.body)) { + if ( + !isRecord(program) || + !Array.isArray(program.body) || + !Array.isArray(program.directives) + ) { throw new TypeError("TypeScript parser returned an invalid program"); } - return program.body.some(statementIsCoverageCounterBearing); + // Babel keeps the directive prologue in `directives`, not `body` (ESTree + // put it in `body`). V8 coverage counts a directive as a statement, all but + // "use strict" (check:v8-coverage-counter-semantics runs both). + return ( + program.directives.some(directiveIsCoverageCounterBearing) || + program.body.some(statementIsCoverageCounterBearing) + ); } export async function buildProductionModuleInventory( diff --git a/scripts/lib/v8-coverage-counter-semantics.ts b/scripts/lib/v8-coverage-counter-semantics.ts index 334a9170..9abab270 100644 --- a/scripts/lib/v8-coverage-counter-semantics.ts +++ b/scripts/lib/v8-coverage-counter-semantics.ts @@ -19,8 +19,13 @@ const coverageMetrics = [ "functions", "branches", ] as const; -const runtimeModule = "src/runtime.ts"; +/** Modules V8 gives at least one counter: code, and a directive prologue. */ +const counterBearingModules = Object.freeze([ + "src/directive-use-client.ts", + "src/runtime.ts", +] as const); const counterlessModules = Object.freeze([ + "src/directive-use-strict.ts", "src/import-empty.ts", "src/import-side-effect.ts", "src/import-type-empty.ts", @@ -29,8 +34,8 @@ const counterlessModules = Object.freeze([ "src/reexport-star.ts", "src/type-only.ts", ] as const); -const expectedModules = Object.freeze( - [runtimeModule, ...counterlessModules].sort(), +const expectedModules: readonly string[] = Object.freeze( + [...counterBearingModules, ...counterlessModules].sort(), ); const childOutputLimit = 1_800; /** @@ -156,9 +161,11 @@ export function assertV8CoverageCounterSemantics( `V8 coverage row set mismatch; missing: ${missing.join(", ") || "none"}; additional: ${additional.join(", ") || "none"}`, ); } - const runtimeRow = rows.get(runtimeModule)!; - if (!coverageMetrics.some((metric) => runtimeRow[metric].total > 0)) { - throw new Error(`V8 runtime module is not counter-bearing: ${runtimeModule}`); + for (const modulePath of counterBearingModules) { + const row = rows.get(modulePath)!; + if (!coverageMetrics.some((metric) => row[metric].total > 0)) { + throw new Error(`V8 module is not counter-bearing: ${modulePath}`); + } } for (const modulePath of counterlessModules) { const row = rows.get(modulePath)!; @@ -178,7 +185,7 @@ export function assertV8CoverageCounterSemantics( } } return Object.freeze({ - counterBearingModules: Object.freeze([runtimeModule]), + counterBearingModules: Object.freeze([...counterBearingModules]), counterlessModules: Object.freeze([...counterlessModules]), }); } diff --git a/tests/fixtures/v8-coverage-counter-semantics/counter-semantics.fixture.ts b/tests/fixtures/v8-coverage-counter-semantics/counter-semantics.fixture.ts index 4cd2bb66..fd674599 100644 --- a/tests/fixtures/v8-coverage-counter-semantics/counter-semantics.fixture.ts +++ b/tests/fixtures/v8-coverage-counter-semantics/counter-semantics.fixture.ts @@ -1,5 +1,7 @@ /// +import "./src/directive-use-client.ts"; +import "./src/directive-use-strict.ts"; import "./src/import-empty.ts"; import "./src/import-side-effect.ts"; import "./src/import-type-empty.ts"; diff --git a/tests/fixtures/v8-coverage-counter-semantics/src/directive-use-client.ts b/tests/fixtures/v8-coverage-counter-semantics/src/directive-use-client.ts new file mode 100644 index 00000000..ca7248bb --- /dev/null +++ b/tests/fixtures/v8-coverage-counter-semantics/src/directive-use-client.ts @@ -0,0 +1,4 @@ +"use client"; + +// A directive prologue and types only. V8 counts the directive as a statement. +export type ClientOnly = 1; diff --git a/tests/fixtures/v8-coverage-counter-semantics/src/directive-use-strict.ts b/tests/fixtures/v8-coverage-counter-semantics/src/directive-use-strict.ts new file mode 100644 index 00000000..3351de0c --- /dev/null +++ b/tests/fixtures/v8-coverage-counter-semantics/src/directive-use-strict.ts @@ -0,0 +1,4 @@ +"use strict"; + +// "use strict" and types only. V8 does not count "use strict". +export type StrictOnly = 1; diff --git a/tests/unit/risk-coverage.test.ts b/tests/unit/risk-coverage.test.ts index 46a377a6..168b9a08 100644 --- a/tests/unit/risk-coverage.test.ts +++ b/tests/unit/risk-coverage.test.ts @@ -699,6 +699,14 @@ describe("repository-aware risk coverage", () => { path.join(repositoryRoot, "src/reexport-star.ts"), "export * from './a.ts';\n", ), + writeFile( + path.join(repositoryRoot, "src/directive-use-client.ts"), + "'use client';\nexport type ClientOnly = 1;\n", + ), + writeFile( + path.join(repositoryRoot, "src/directive-use-strict.ts"), + '"use strict";\nexport type StrictOnly = 1;\n', + ), ]); const productionInventory = await buildProductionModuleInventory({ @@ -708,6 +716,7 @@ describe("repository-aware risk coverage", () => { expect(productionInventory.counterlessModules).toEqual([ "src/barrel.ts", + "src/directive-use-strict.ts", "src/import-side-effect.ts", "src/import-type-empty.ts", "src/import-value-empty.ts", @@ -718,6 +727,7 @@ describe("repository-aware risk coverage", () => { ]); expect(productionInventory.counterBearingModules).toEqual([ "src/a.ts", + "src/directive-use-client.ts", "src/nested/b.tsx", "src/runtime-export.ts", "src/side-effect.ts", diff --git a/tests/unit/v8-coverage-counter-semantics.test.ts b/tests/unit/v8-coverage-counter-semantics.test.ts index 34ed249a..1bddd38b 100644 --- a/tests/unit/v8-coverage-counter-semantics.test.ts +++ b/tests/unit/v8-coverage-counter-semantics.test.ts @@ -33,6 +33,7 @@ const zeroMetrics = Object.freeze({ branches: zeroCounter, }); const counterlessPaths = Object.freeze([ + "src/directive-use-strict.ts", "src/import-empty.ts", "src/import-side-effect.ts", "src/import-type-empty.ts", @@ -53,15 +54,15 @@ function fixtureSummary(root: string): Record { branches: zeroCounter, }, ], - [ - path.join(root, "src/runtime.ts"), + ...["src/directive-use-client.ts", "src/runtime.ts"].map((modulePath) => [ + path.join(root, modulePath), { lines: { total: 1, covered: 1, skipped: 0, pct: 100 }, statements: { total: 1, covered: 1, skipped: 0, pct: 100 }, functions: zeroCounter, branches: zeroCounter, }, - ], + ]), ...counterlessPaths.map((modulePath) => [path.join(root, modulePath), zeroMetrics]), ]); } @@ -87,7 +88,7 @@ describe("V8 coverage counter semantics", () => { const root = "/owned-fixture"; expect(assertV8CoverageCounterSemantics(fixtureSummary(root), root)).toEqual({ - counterBearingModules: ["src/runtime.ts"], + counterBearingModules: ["src/directive-use-client.ts", "src/runtime.ts"], counterlessModules: counterlessPaths, }); }); @@ -121,7 +122,13 @@ describe("V8 coverage counter semantics", () => { const runtimeDrift = fixtureSummary(root); runtimeDrift[path.join(root, "src/runtime.ts")] = zeroMetrics; expect(() => assertV8CoverageCounterSemantics(runtimeDrift, root)).toThrow( - /runtime.*counter-bearing/u, + /not counter-bearing: src\/runtime\.ts/u, + ); + + const directiveDrift = fixtureSummary(root); + directiveDrift[path.join(root, "src/directive-use-client.ts")] = zeroMetrics; + expect(() => assertV8CoverageCounterSemantics(directiveDrift, root)).toThrow( + /not counter-bearing: src\/directive-use-client\.ts/u, ); });