@cplieger/deadset-ts 7.2.0-dev.3 → 8.0.0-dev.1

package/src/sweep.ts

@@ -8,6 +8,7 @@
 
 import type { TSExemptionClass } from "./exempt-classes.ts";
 import { namesACaller, OUTSIDE, type Edge, type Graph } from "./graph.ts";
+import type { InventorySymbol } from "./inventory.ts";
 import type { Position } from "./position.ts";
 
 /** The liveness relation that decided a declaration, as a finding spells it. */
@@ -178,17 +179,32 @@ export function sweep(graph: Graph, input: SweepInput): Liveness {
   return { liveUnder: live, candidates };
 }
 
+/**
+ * The directory a test runner reads a manual mock from, whose exports it puts in place of
+ * the module's: https://jestjs.io/docs/manual-mocks
+ */
+const MANUAL_MOCKS = "__mocks__";
+
+/** Whether a test runner calls or reads one export of a test file: a function, or any export of a manual mock. */
+export function runnerCalls(symbol: InventorySymbol): boolean {
+  return symbol.kind === "function" || symbol.position.path.split("/").includes(MANUAL_MOCKS);
+}
+
 /**
  * Per declaration of the graph, whether the run that counts test references reaches it.
- * That run's roots are the graph's own and each test file, being the file's top level
- * and every declaration it exports, which a test runner may call; `held` seeds it as a
- * mark or an exemption seeds a sweep.
+ * That run's roots are the graph's own and, of each test file, its top level and every
+ * function it exports, which a test runner may call, and every export of a manual mock,
+ * which the runner reads; any other export of a test file, and test-support code, which
+ * runs where a test imports it, are judged as any file's are.
+ * `held` seeds it as a mark or an exemption seeds a sweep.
  */
 export function reachedWithTheTests(graph: Graph, held: readonly string[]): readonly boolean[] {
   const tests = graph.symbols.flatMap((symbol, at) => {
-    const top =
-      symbol.kind === "file" || graph.symbols[graph.parent[at] ?? OUTSIDE]?.kind === "file";
-    return graph.test[at] === true && top && (symbol.kind === "file" || symbol.exported)
+    const exported = symbol.exported && graph.symbols[graph.parent[at] ?? OUTSIDE]?.kind === "file";
+    const called = exported && runnerCalls(symbol);
+    return graph.test[at] === true &&
+      graph.support[at] !== true &&
+      (symbol.kind === "file" || called)
       ? [{ at, kind: "test-runner" as const }]
       : [];
   });
@@ -277,10 +293,11 @@ function reachable(graph: Graph, held: readonly boolean[], mode: Mode): readonly
 
 /**
  * Admits every test declaration whose set of referenced production declarations is
- * non-empty and wholly dead, and returns which it admitted. The set is read from every
- * reference the test makes, which a production sweep does not count. A test-support
- * declaration that a test referencing a live target also references is a live target of
- * every test referencing it. A marked or exempt test is never admitted.
+ * non-empty and wholly dead, and returns which it admitted. An ambient declaration describes
+ * code the target does not implement, so it is no production declaration here. The set is
+ * read from every reference the test makes, which a production sweep does not count. A
+ * test-support declaration a test referencing a live target also references is a live
+ * target of every test referencing it. A marked or exempt test is never admitted.
  */
 function admitTestsOfDeadCode(
   graph: Graph,
@@ -293,7 +310,11 @@ function admitTestsOfDeadCode(
     let live = 0;
     if (testCode(at) && graph.subject[at] === true && held[at] !== true) {
       for (const edge of graph.out[at] ?? []) {
-        if (testCode(edge.to) || graph.subject[edge.to] !== true) {
+        if (
+          testCode(edge.to) ||
+          graph.subject[edge.to] !== true ||
+          graph.ambient[edge.to] === true
+        ) {
           continue;
         }
         targets += 1;

package/src/symbol-keys.ts

@@ -2,24 +2,31 @@
  * The members a unique symbol keys, used through element accesses. `value[key]`, where
  * `key` is a constant of a `unique symbol` type, reads the member of the receiver's type
  * whose computed name is that same constant, and a store through the access writes it.
- * No name node resolves to such a member: the key's name resolves to the constant.
+ * No name node resolves to such a member: the key's name resolves to the constant. An
+ * iteration reads the member its well-known iteration symbol keys.
  */
 
 import {
   isComputedPropertyName,
+  isForOfStatement,
   isIdentifier,
   isNoSubstitutionTemplateLiteral,
   isNumericLiteral,
   isParenthesizedExpression,
   isPropertyAccessExpression,
+  isSpreadElement,
   isStringLiteral,
   type ElementAccessExpression,
+  type Expression,
   type Node,
+  type SourceFile,
 } from "@typescript/native/ast";
 import type { Symbol as TSSymbol, Type } from "@typescript/native/sync";
 import type { AliasChains } from "./alias-chain.ts";
-import type { InventorySymbol } from "./inventory.ts";
+import { nodeKey, type Inventory, type InventorySymbol } from "./inventory.ts";
+import { renderPosition } from "./position.ts";
 import { isAnswered, type PropertyTables } from "./query.ts";
+import type { Reference } from "./references.ts";
 import type { ProjectView } from "./session.ts";
 
 /** One element access whose key is a name, and how the access uses the member it selects. */
@@ -170,3 +177,123 @@ export function keyedUses<Brand>(
     return ids.length === 0 ? [] : [{ access: one.access, ids: [...new Set(ids)] }];
   });
 }
+
+/** The well-known symbol a value's iteration calls, by the construct that iterates it. */
+type Protocol = "iterator" | "asyncIterator";
+
+/** The member name `[Symbol.<name>]` spells, where a computed name spells one. */
+function wellKnownName(name: Node | undefined): string | undefined {
+  if (name === undefined || !isComputedPropertyName(name)) {
+    return undefined;
+  }
+  const key = name.expression;
+  return isPropertyAccessExpression(key) &&
+    isIdentifier(key.expression) &&
+    key.expression.text === "Symbol" &&
+    isIdentifier(key.name)
+    ? key.name.text
+    : undefined;
+}
+
+/**
+ * The references the iterations of one project's own files make to the iteration members
+ * of the values they iterate: a `for…of` statement and a spread element read
+ * `[Symbol.iterator]`, and a `for await…of` statement reads `[Symbol.asyncIterator]` and,
+ * which it falls back to, `[Symbol.iterator]`. Each is made by the declaration holding it.
+ */
+export function iterationReferences<Brand>(
+  project: ProjectView<Brand>,
+  held: Inventory,
+  chains: AliasChains,
+  root: string,
+  testFiles: ReadonlySet<string>,
+): readonly Reference[] {
+  const queries = project.queries;
+  const ownPaths = project.ownPaths();
+  const iterated: {
+    readonly file: SourceFile;
+    readonly from: string;
+    readonly operand: Expression;
+    readonly protocols: readonly Protocol[];
+  }[] = [];
+  for (const file of project.ownSourceFiles()) {
+    const fileId = held.declarations.get(nodeKey(file, file));
+    if (fileId === undefined) {
+      continue;
+    }
+    const visit = (node: Node, from: string): void => {
+      const holder = held.declarations.get(nodeKey(file, node)) ?? from;
+      if (isForOfStatement(node)) {
+        const protocols: readonly Protocol[] =
+          node.awaitModifier === undefined ? ["iterator"] : ["asyncIterator", "iterator"];
+        iterated.push({ file, from: holder, operand: node.expression, protocols });
+      } else if (isSpreadElement(node)) {
+        iterated.push({ file, from: holder, operand: node.expression, protocols: ["iterator"] });
+      }
+      node.forEachChild((child) => {
+        visit(child, holder);
+      });
+    };
+    file.forEachChild((child) => {
+      visit(child, fileId);
+    });
+  }
+  if (iterated.length === 0) {
+    return [];
+  }
+  const types = queries.typesAt(iterated.map((one) => one.operand));
+  const members = new Map<
+    number,
+    readonly { readonly name: string; readonly ids: readonly string[] }[]
+  >();
+  const membersOf = (
+    type: Type,
+  ): readonly { readonly name: string; readonly ids: readonly string[] }[] => {
+    const known = members.get(type.id);
+    if (known !== undefined) {
+      return known;
+    }
+    const keyed: { name: string; ids: readonly string[] }[] = [];
+    const properties = queries.propertiesOf(type);
+    for (const property of isAnswered(properties) ? properties : []) {
+      for (const handle of property.declarations) {
+        const node = ownPaths.has(handle.path) ? project.declarationAt(handle)?.node : undefined;
+        const name = wellKnownName((node as { readonly name?: Node } | undefined)?.name);
+        if (name !== undefined) {
+          keyed.push({ name, ids: chains.declarationsOf(property) });
+          break;
+        }
+      }
+    }
+    members.set(type.id, keyed);
+    return keyed;
+  };
+  const found: Reference[] = [];
+  iterated.forEach((one, index) => {
+    const type = types[index];
+    if (type === undefined || !isAnswered(type)) {
+      return;
+    }
+    const parts =
+      type.isUnionType() || type.isIntersectionType() ? queries.constituents(type) : [type];
+    const position = renderPosition(one.file, root, one.operand.getStart());
+    for (const part of isAnswered(parts) ? parts : []) {
+      for (const member of membersOf(part)) {
+        if (!(one.protocols as readonly string[]).includes(member.name)) {
+          continue;
+        }
+        for (const to of member.ids) {
+          found.push({
+            from: one.from,
+            to,
+            position,
+            use: "read",
+            resolution: "keyed",
+            test: testFiles.has(position.path),
+          });
+        }
+      }
+    }
+  });
+  return found;
+}

package/src/template-field.ts

@@ -18,7 +18,7 @@ import type { DetectorInput, Evidence } from "./exempt.ts";
 import type { Host } from "./host.ts";
 import type { SymbolKind } from "./inventory.ts";
 import { memberNames } from "./member-names.ts";
-import { isAbsolutePath, joinPath, normalizePath, relativePath } from "./paths.ts";
+import { extensionOf, isAbsolutePath, joinPath, normalizePath, relativePath } from "./paths.ts";
 import { isComponentFile, type Position } from "./position.ts";
 
 /** One template, by its path below the target root. */
@@ -125,7 +125,10 @@ function stringEnd(text: string, from: number): number {
   return at + 1;
 }
 
-/** The end of the `${` substitution whose expression starts at `from`, past its closing brace. */
+/**
+ * The end of the `${` substitution whose expression starts at `from`: past its closing brace,
+ * or one past the text's end where none closes it, so the expression is the text to its end.
+ */
 function substitutionEnd(text: string, from: number): number {
   let depth = 1;
   let at = from;
@@ -149,7 +152,7 @@ function substitutionEnd(text: string, from: number): number {
     }
     at += 1;
   }
-  return at;
+  return text.length + 1;
 }
 
 /** The end of the template literal at `from`; each `${…}` expression goes to `substitution`. */
@@ -243,8 +246,8 @@ function namesOf(text: string, delimiters: TemplateDelimiters): readonly Named[]
 }
 
 /** Every identifier the markup of one component file writes in an action. */
-function markupNamesOf(text: string): readonly Named[] {
-  return readComponent(text).markup.flatMap((one) =>
+function markupNamesOf(file: TemplateFile): readonly Named[] {
+  return readComponent(file.text, extensionOf(file.path)).markup.flatMap((one) =>
     identifiersOf(one.text, true).map(({ name, offset }) => ({
       name,
       offset: one.start + offset,
@@ -287,7 +290,7 @@ export function templateField<Brand>(input: DetectorInput<Brand>): readonly Evid
       names: namesOf(file.text, templates.delimiters),
       markup: false,
     })),
-    ...components.map((file) => ({ file, names: markupNamesOf(file.text), markup: true })),
+    ...components.map((file) => ({ file, names: markupNamesOf(file), markup: true })),
   ];
   for (const { file, names, markup } of scanned) {
     for (const named of names) {

package/src/test-support.ts

@@ -1,10 +1,13 @@
 /**
- * Test-support code: the files only tests reach. A test reaches each one through a chain
- * of references, and every reference to a declaration of one, an import for its effects
- * included, is written in a test file or in another such file, so it is judged with the
- * tests: what it references is referenced by test code.
+ * Test-support code: the files only tests reach that carry test evidence of their own. A
+ * test reaches each one through a chain of references, and every reference to a
+ * declaration of one, an import for its effects included, is written in a test file or in
+ * another such file, so it is judged with the tests: what it references is referenced by
+ * test code.
  */
 
+import { CONVENTION_ROWS } from "./convention-rows.ts";
+import { packageOfSpecifier } from "./dependencies.ts";
 import type { InventorySymbol } from "./inventory.ts";
 import type { Reference } from "./references.ts";
 import type { Root } from "./roots.ts";
@@ -12,18 +15,139 @@ import type { Root } from "./roots.ts";
 /** The root kind that never takes a file out of test-support code: the skip only withholds. */
 const SKIP_ROOT = "type-error";
 
+/**
+ * The test runners and test libraries an import of which is test evidence: each runner a
+ * convention row reads test files for, the platform's own runner, and the libraries below.
+ */
+const TEST_PACKAGES: ReadonlySet<string> = new Set([
+  ...CONVENTION_ROWS.filter((row) => row.testFiles !== undefined).map((row) => row.package),
+  "node:test",
+  "@playwright/test",
+]);
+
+/** The scopes every package of which is a test library. */
+const TEST_SCOPES = ["@testing-library/"] as const;
+
+/**
+ * The Node.js built-in modules a bare specifier names, which are no package. The set is
+ * closed: Node.js adds a new built-in under the `node:` scheme alone
+ * (https://nodejs.org/api/modules.html#built-in-modules-with-mandatory-node-prefix).
+ */
+const NODE_BUILTINS: ReadonlySet<string> = new Set([
+  "assert",
+  "async_hooks",
+  "buffer",
+  "child_process",
+  "cluster",
+  "console",
+  "constants",
+  "crypto",
+  "dgram",
+  "diagnostics_channel",
+  "dns",
+  "domain",
+  "events",
+  "fs",
+  "http",
+  "http2",
+  "https",
+  "inspector",
+  "module",
+  "net",
+  "os",
+  "path",
+  "perf_hooks",
+  "process",
+  "punycode",
+  "querystring",
+  "readline",
+  "repl",
+  "stream",
+  "string_decoder",
+  "sys",
+  "timers",
+  "tls",
+  "trace_events",
+  "tty",
+  "url",
+  "util",
+  "v8",
+  "vm",
+  "wasi",
+  "worker_threads",
+  "zlib",
+]);
+
+/** What a file imports, read for test evidence. */
+export interface TestEvidence {
+  /** Per file below the target root, the module specifiers its imports write. */
+  readonly imports: ReadonlyMap<string, readonly string[]>;
+  /**
+   * Whether the manifest nearest the file, below the target root, that declares the
+   * package declares it under `devDependencies`.
+   */
+  readonly devDependency: (path: string, name: string) => boolean;
+}
+
+/** Whether a specifier names a test runner or a test library. */
+function namesTestPackage(specifier: string): boolean {
+  const name = specifier.startsWith("node:") ? specifier : packageOfSpecifier(specifier);
+  return (
+    name !== undefined &&
+    (TEST_PACKAGES.has(name) || TEST_SCOPES.some((scope) => name.startsWith(scope)))
+  );
+}
+
+/**
+ * Whether a file carries test evidence: an import of a test runner or a test library, or
+ * package imports, Node built-ins aside, that are all devDependencies no file imports
+ * outside the test files and `onlyTests`, the files only tests reach.
+ */
+function evidenceReader(
+  tests: ReadonlySet<string>,
+  evidence: TestEvidence,
+): (onlyTests: ReadonlySet<string>, path: string) => boolean {
+  const importers = new Map<string, string[]>();
+  for (const [path, specifiers] of evidence.imports) {
+    for (const specifier of specifiers) {
+      const name = packageOfSpecifier(specifier);
+      if (name !== undefined) {
+        importers.set(name, [...(importers.get(name) ?? []), path]);
+      }
+    }
+  }
+  return (onlyTests, path) => {
+    const specifiers = evidence.imports.get(path) ?? [];
+    if (specifiers.some(namesTestPackage)) {
+      return true;
+    }
+    const names = specifiers.flatMap((one) => packageOfSpecifier(one) ?? []);
+    const packages = names.filter((name) => !NODE_BUILTINS.has(name));
+    return (
+      packages.length > 0 &&
+      packages.every(
+        (name) =>
+          evidence.devDependency(path, name) &&
+          (importers.get(name) ?? []).every((one) => tests.has(one) || onlyTests.has(one)),
+      )
+    );
+  };
+}
+
 /**
  * The files of one project that are test-support code, below the target root: the
  * largest set of files a test file reaches, none of them a test file or holding a root,
- * whose every user outside the set is a test file. A root has a caller outside the
- * reference graph: a runtime, a tool, a configuration, or a consumer of a library's
- * published API. `testFiles` are the files the test-file rules classified.
+ * each carrying test evidence of its own, whose every user outside the set is a test
+ * file. A root has a caller outside the reference graph: a runtime, a tool, a
+ * configuration, or a consumer of a library's published API. `testFiles` are the files
+ * the test-file rules classified.
  */
 export function testSupportFiles(
   symbols: readonly InventorySymbol[],
   references: readonly Reference[],
   roots: readonly Root[],
   testFiles: readonly string[],
+  evidence: TestEvidence,
 ): ReadonlySet<string> {
   const fileOf = new Map(symbols.map((symbol) => [symbol.id, symbol.position.path]));
   const users = new Map<string, Set<string>>();
@@ -59,17 +183,26 @@ export function testSupportFiles(
       }
     }
   }
-  const support = new Set([...reached].filter((path) => !rooted.has(path)));
-  for (let changed = true; changed;) {
-    changed = false;
-    for (const path of support) {
-      const from = users.get(path) ?? new Set<string>();
-      if (![...from].every((one) => tests.has(one) || support.has(one))) {
-        support.delete(path);
-        changed = true;
+  const withoutOutsideUsers = (files: Set<string>): Set<string> => {
+    for (let changed = true; changed;) {
+      changed = false;
+      for (const path of files) {
+        const from = users.get(path) ?? new Set<string>();
+        if (![...from].every((one) => tests.has(one) || files.has(one))) {
+          files.delete(path);
+          changed = true;
+        }
       }
     }
-  }
+    return files;
+  };
+  // Evidence reads the files only tests reach, evidence or none, so it is fixed before the
+  // files without evidence leave the set.
+  const onlyTests = withoutOutsideUsers(new Set([...reached].filter((path) => !rooted.has(path))));
+  const carries = evidenceReader(tests, evidence);
+  const support = withoutOutsideUsers(
+    new Set([...onlyTests].filter((path) => carries(onlyTests, path))),
+  );
   return support;
 }