@cplieger/deadset-ts 8.0.0-dev.7 → 8.0.0-dev.9

package/src/scope.ts

@@ -1,13 +1,12 @@
-import { ConfigError } from "./config.ts";
+import { SCOPE_SCHEMA } from "./contract/config.generated.ts";
 import type { Host } from "./host.ts";
+import { dotted, locatedFault, placeIn, readStrict, StrictJSONError } from "./json-document.ts";
 import { dirnamePath, isAbsolutePath, joinPath, resolvePath } from "./paths.ts";
-import { checkDocument, type KeyNode } from "./schema.ts";
-import { isRecord } from "./json-document.ts";
+import { MARKERS } from "./load/discover.ts";
+import { failureExit } from "./failure.ts";
 import { message } from "./product.ts";
-
-/** The roles a scope document declares for a module. */
-const ROLE_TARGET = "target";
-const ROLE_CONSUMER = "consumer";
+import { firstRefusal } from "./schema.ts";
+import { UsageError } from "./usage.ts";
 
 /**
  * A scope document above this length is refused rather than decoded. It names one
@@ -16,23 +15,14 @@ const ROLE_CONSUMER = "consumer";
 const MAX_DOCUMENT_LENGTH = 1 << 20;
 
 /**
- * A scope document that cannot be read as one. It ends the run with the failure
- * code: the run could not learn what to analyze, so it produced no answer.
+ * The bytes read of a scope document. A UTF-16 unit decodes from at most three bytes,
+ * so a document past the bound is past it within these.
  */
-export class ScopeError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = "ScopeError";
-  }
-}
+const MAX_DOCUMENT_BYTES = 3 * (MAX_DOCUMENT_LENGTH + 1);
 
 /**
- * One module the run reads: the target or a declared consumer.
- *
- * The role a document declares is not carried here, because the resolved scope
- * holds exactly one target and a list of consumers, so a module's role is where it
- * sits. What a document declares is read and refused where it contradicts that
- * position, which is the only place the declaration can be wrong.
+ * One module the run reads: the target or a declared consumer. The role a document
+ * declares is not carried, because a module's role is where the scope holds it.
  */
 export interface Module {
   /** The package name. A document may state it; otherwise it is empty. */
@@ -47,142 +37,66 @@ export interface Scope {
   readonly consumers: readonly Module[];
 }
 
-const MODULE: KeyNode = {
-  kind: "section",
-  members: { id: { kind: "leaf" }, role: { kind: "leaf" }, path: { kind: "leaf" } },
-};
-
-/** The closed key list of the scope document, compared as bytes. */
-const SCOPE_ROOT: KeyNode = {
-  kind: "section",
-  members: {
-    target: MODULE,
-    workspace: { kind: "leaf" },
-    consumers: { kind: "list", members: MODULE.members ?? {} },
-  },
-};
-
-/**
- * One string member, or undefined where the document omits it. A member the
- * document writes is a string holding at least one character, so `null` and `""`
- * are refused rather than read as absent.
- */
-function stringMember(
-  parent: Record<string, unknown>,
-  name: string,
-  at: string,
-): string | undefined {
-  if (!Object.hasOwn(parent, name)) {
-    return undefined;
-  }
-  const value = parent[name];
-  if (typeof value !== "string") {
-    throw new ScopeError(`scope: ${at === "" ? name : `${at}.${name}`} is not a string`);
-  }
-  if (value === "") {
-    throw new ScopeError(`scope: ${at === "" ? name : `${at}.${name}`} names nothing`);
-  }
-  return value;
-}
-
-function readModule(value: unknown, at: string, role: string, documentDir: string): Module {
-  if (!isRecord(value)) {
-    throw new ScopeError(`scope: ${at} is not an object`);
-  }
-  const declared = stringMember(value, "role", at);
-  if (declared !== undefined && declared !== role) {
-    throw new ScopeError(
-      `scope: ${at}.role is ${JSON.stringify(declared)}, want ${JSON.stringify(role)}`,
-    );
-  }
-  const path = stringMember(value, "path", at);
-  if (path === undefined) {
-    throw new ScopeError(`scope: ${at}.path names nothing`);
-  }
-  return {
-    id: stringMember(value, "id", at) ?? "",
-    path: isAbsolutePath(path) ? path : joinPath(documentDir, path),
-  };
+interface DeclaredModule {
+  readonly id?: string;
+  readonly path: string;
 }
 
-/**
- * Walks the document's text against the closed key list, refusing a key the list
- * does not declare, compared as bytes, and a key one object writes twice, which a
- * parse cannot report because it keeps the last value.
- */
-function checkKeys(text: string, file: string): void {
-  try {
-    checkDocument(text, SCOPE_ROOT, `scope: ${file}`);
-  } catch (error: unknown) {
-    if (error instanceof ConfigError) {
-      // The configuration's refusal names the nearest configuration key, which a
-      // scope document does not have.
-      throw new ScopeError(
-        error.kind === "unimplemented-key"
-          ? `scope: ${file}: ${error.key} is not a declared key`
-          : error.message,
-      );
-    }
-    throw error;
-  }
+function refusal(file: string, place: string, reason: string): UsageError {
+  return new UsageError(`scope: ${file}: ${place === "" ? "" : `${place}: `}${reason}`);
 }
 
 /**
- * Decodes the scope document at `file`. Decoding is strict: an undeclared key, a
- * key written twice in one object, and a value of a type the document does not
- * admit, `null` included, are errors, and a relative path inside the document
- * resolves against the document's own directory.
- *
- * The `workspace` key the format declares is checked and carries nothing here: it
- * names the file a Go consumer resolves the target through, and a TypeScript
- * project resolves one through its own compiler configuration.
+ * Decodes the scope document at `file`, held to the Contract's scope schema, a relative
+ * path resolved against the document's own directory. A document that cannot be read or is
+ * refused is a usage error, as any document the invocation names. `workspace` is read by Go consumers
+ * alone: a TypeScript project resolves the target through its own compiler configuration.
  */
 export function readScope(host: Host, file: string): Scope {
   const absolute = resolvePath(host.workingDirectory(), file);
   let text: string;
   try {
-    text = host.readFile(absolute);
+    text = host.readFile(absolute, MAX_DOCUMENT_BYTES);
   } catch (error: unknown) {
-    throw new ScopeError(`scope: ${file}: ${message(error)}`);
+    throw new UsageError(`scope: ${file}: ${message(error)}`);
   }
   if (text.length > MAX_DOCUMENT_LENGTH) {
-    throw new ScopeError(`scope: ${file} is longer than ${String(MAX_DOCUMENT_LENGTH)} characters`);
+    throw new UsageError(`scope: ${file} is longer than ${String(MAX_DOCUMENT_LENGTH)} characters`);
   }
   let value: unknown;
   try {
-    value = JSON.parse(text);
+    value = readStrict(text).value;
   } catch (error: unknown) {
-    throw new ScopeError(`scope: ${file}: ${message(error)}`);
+    if (!(error instanceof StrictJSONError)) {
+      throw error;
+    }
+    throw refusal(file, dotted(error.place), locatedFault(text, error));
   }
-  if (!isRecord(value)) {
-    throw new ScopeError(`scope: ${file} is not one JSON object`);
+  const refused = firstRefusal(SCOPE_SCHEMA, value);
+  if (refused !== undefined) {
+    throw refusal(file, dotted(placeIn(value, refused.pointer, refused.member)), refused.reason);
   }
-  checkKeys(text, file);
-  stringMember(value, "workspace", "");
+  const declared = value as { target: DeclaredModule; consumers?: readonly DeclaredModule[] };
   const documentDir = dirnamePath(absolute);
-  if (!Object.hasOwn(value, "target")) {
-    throw new ScopeError(`scope: ${file} names no target`);
-  }
-  const target = readModule(value["target"], "target", ROLE_TARGET, documentDir);
-  const listed = Object.hasOwn(value, "consumers") ? value["consumers"] : [];
-  if (!Array.isArray(listed)) {
-    throw new ScopeError(`scope: ${file}: consumers is not an array`);
-  }
-  const consumers = (listed as unknown[]).map((entry, index) =>
-    readModule(entry, `consumers[${String(index)}]`, ROLE_CONSUMER, documentDir),
-  );
-  return { target, consumers };
+  const moduleOf = (module: DeclaredModule): Module => ({
+    id: module.id ?? "",
+    path: isAbsolutePath(module.path) ? module.path : joinPath(documentDir, module.path),
+  });
+  return { target: moduleOf(declared.target), consumers: (declared.consumers ?? []).map(moduleOf) };
 }
 
-/** The single-package scope one directory is, when no scope document is given. */
+/**
+ * The single-package scope one directory is, when no scope document is given. A target that is
+ * no directory holds no program.
+ */
 export function scopeForDir(host: Host, dir: string): Scope {
   const path = resolvePath(host.workingDirectory(), dir);
   const kind = host.kindOf(path);
-  if (kind === "absent") {
-    throw new ScopeError(`scope: ${path} does not exist`);
-  }
   if (kind !== "directory") {
-    throw new ScopeError(`scope: ${path} is not a directory`);
+    throw failureExit(
+      "no-program",
+      `the target ${path} ${kind === "absent" ? "does not exist" : "is not a directory"}, so it holds no compiler configuration, no file named ${MARKERS.join(", ")}: name the directory that holds one`,
+    );
   }
   return { target: { id: "", path }, consumers: [] };
 }

package/src/serialization-contract.ts

@@ -82,7 +82,7 @@ import { erasedStores, type ErasedStores } from "./erased-stores.ts";
 import { checkedTypes, CONVERSION_MEMBERS, valueReach, type Reached } from "./value-reach.ts";
 
 /** The serializer every run reads, whatever the configuration names. */
-const JSON_STRINGIFY: DeclarationEntry = { shape: "global", global: "JSON.stringify" };
+const JSON_STRINGIFY: DeclarationEntry = { global: "JSON.stringify" };
 
 /** The methods a serializer and a formatter resolve by name on a value that left the analysis. */
 const CONVERSIONS: ReadonlySet<string> = new Set(["toJSON", "toString"]);

package/src/session.ts

@@ -15,9 +15,7 @@ import type {
 } from "@typescript/native/sync";
 import type { Node, SourceFile } from "@typescript/native/ast";
 import { componentLayer, mapperManifest } from "./component-layer.ts";
-import { DiscoveryError } from "./discover.ts";
 import type { Host, TemporaryDirectory } from "./host.ts";
-import type { WorkspaceProgram } from "./workspace-programs.ts";
 import { joinPath } from "./paths.ts";
 import {
   queriesOf,
@@ -37,8 +35,8 @@ import { MANIFEST } from "./fs/manifest.ts";
 export interface Engine {
   /**
    * Resolves one compiler configuration file, or throws with the reason it cannot
-   * be read. The result is spelled through the client's own signature: the type
-   * the compiler package returns here is not one of its exported names.
+   * be read. The result is spelled through the client's own signature: the type the
+   * compiler package returns here is not one of its exported names.
    */
   parseConfigFile(file: DocumentIdentifier): ReturnType<API["parseConfigFile"]>;
   /** Resolves one configuration's JSON as if `configFile` held it, which no file need. */
@@ -272,13 +270,6 @@ export interface ProjectView<Brand> {
  */
 export type ProjectVisitor<Result> = <Brand>(project: ProjectView<Brand>) => Result;
 
-/** One project a session opened: its configuration and the files of its own program. */
-export interface OpenedFiles {
-  readonly configFile: string;
-  /** The program's source files no default library and no external library holds. */
-  readonly fileNames: () => readonly string[];
-}
-
 /**
  * The source files of one program that `own` admits, in the program's order, none of
  * them one of the compiler's default libraries.
@@ -472,19 +463,30 @@ export function diagnosticsOf<Brand>(project: ProjectView<Brand>): ProjectDiagno
   };
 }
 
+/** How a snapshot builds one configuration other than by opening the project it names. */
+export type ProgramBuild =
+  | { readonly kind: "program"; readonly params: CreateSnapshotProgramParams }
+  /** A configuration only the snapshot holds, at a path no file has. */
+  | { readonly kind: "configuration"; readonly file: string; readonly text: string };
+
 /** One run's result: what the visitor answered for each project, and what it cost. */
 export interface SessionResult<Result> {
-  /** One answer per configuration the snapshot opened a project for, in the order named. */
+  /** One answer per configuration, in the order named. */
   readonly projects: readonly Result[];
-  /** The configurations the snapshot opened no project for, in the order named. */
-  readonly unopened: readonly string[];
   readonly timing: TimingInfo;
-  /** Every question the checker could not answer, each once, in the order first asked. */
-  readonly unanswered: readonly UnansweredQuestion[];
 }
 
-/** What a run does about a configuration the snapshot opened no project for. */
-type Unopened = "refuse" | "record";
+/** One open snapshot's projects, valid only while the session that handed it out runs. */
+export interface OpenedSession {
+  /** One view per configuration the snapshot opened a project for, in the order named. */
+  readonly views: readonly ProjectView<unknown>[];
+}
+
+/** How one session opens its configurations. */
+export interface SessionOptions {
+  /** How the snapshot builds each configuration it does not open as its project. */
+  readonly programs?: ReadonlyMap<string, ProgramBuild> | undefined;
+}
 
 /**
  * The projects one snapshot holds for the configurations named, by configuration file. A
@@ -513,22 +515,18 @@ function projectsOf(
 }
 
 /**
- * Runs `visit` over every project the compiler configurations name, inside one never updated
- * snapshot of one client, and answers in their order. A configuration `programs` describes is
- * built as that program, or opened from the configuration it writes. One the snapshot holds
- * nothing for ends the run under `"refuse"` and is named in the result under `"record"`.
- * `first` runs over every opened project before the first visit and `last` after the last,
- * both while the client answers; the snapshot and the client are then released.
+ * Opens every project the compiler configurations name in one never updated snapshot of one
+ * client, and hands them to `use` while the client answers; the snapshot and the client are
+ * then released. A configuration `options.programs` describes is built as that program, or
+ * opened from the configuration it writes. One the snapshot holds nothing for has no view.
  */
-export function runSession<Result>(
+export function openSession<Result>(
   engine: Engine,
   configFiles: readonly string[],
-  visit: ProjectVisitor<Result>,
-  unopened: Unopened = "refuse",
-  programs: ReadonlyMap<string, WorkspaceProgram> = new Map(),
-  last: () => void = () => undefined,
-  first: (opened: readonly OpenedFiles[]) => void = () => undefined,
-): SessionResult<Result> {
+  options: SessionOptions,
+  use: (opened: OpenedSession, unanswered: () => readonly UnansweredQuestion[]) => Result,
+): Result {
+  const programs = options.programs ?? new Map<string, ProgramBuild>();
   try {
     const built: string[] = [];
     const params: CreateSnapshotProgramParams[] = [];
@@ -553,32 +551,13 @@ export function runSession<Result>(
       const opened = projectsOf(snapshot, built, written);
       const log = new UnansweredLog();
       const views: ProjectView<unknown>[] = [];
-      const missing: string[] = [];
       for (const configFile of configFiles) {
         const project = opened.get(configFile);
-        if (project === undefined) {
-          if (unopened === "refuse") {
-            throw new DiscoveryError(`${configFile} opened no project`, []);
-          }
-          missing.push(configFile);
-          continue;
+        if (project !== undefined) {
+          views.push(viewOf(project, configFile, engine, log));
         }
-        views.push(viewOf(project, configFile, engine, log));
       }
-      first(
-        views.map((view) => ({
-          configFile: view.configFile,
-          fileNames: () => view.ownSourceFiles().map((file) => file.fileName),
-        })),
-      );
-      const projects = views.map((view) => visit(view));
-      last();
-      return {
-        projects,
-        unopened: missing,
-        timing: engine.getTimingInfo(),
-        unanswered: log.questions,
-      };
+      return use({ views }, () => log.questions);
     } finally {
       snapshot.dispose();
     }
@@ -586,3 +565,23 @@ export function runSession<Result>(
     engine.close();
   }
 }
+
+/**
+ * Runs `visit` over the project {@link openSession} opens for each configuration, and answers
+ * in their order; a configuration the snapshot opens nothing for throws before any visit.
+ */
+export function runSession<Result>(
+  engine: Engine,
+  configFiles: readonly string[],
+  visit: ProjectVisitor<Result>,
+): SessionResult<Result> {
+  return openSession(engine, configFiles, {}, (opened) => {
+    const unopened = configFiles.find(
+      (configFile) => !opened.views.some((view) => view.configFile === configFile),
+    );
+    if (unopened !== undefined) {
+      throw new Error(`${unopened} opened no project`);
+    }
+    return { projects: opened.views.map((view) => visit(view)), timing: engine.getTimingInfo() };
+  });
+}

package/src/source-files.ts

@@ -5,7 +5,7 @@
  */
 
 import type { SourceFile } from "@typescript/native/ast";
-import { commonDirectory, emittedFrom } from "./emit-map.ts";
+import { commonDirectory, emittedFrom } from "./load/emit-map.ts";
 import { dirnamePath, joinPath, relativePath, resolvePath } from "./paths.ts";
 import type { ProjectView } from "./session.ts";
 

package/src/suppress-file.ts

@@ -8,9 +8,9 @@
 import { CODE } from "./contract/contract.generated.ts";
 import type { Host } from "./host.ts";
 import type { InventorySymbol } from "./inventory.ts";
+import { readTargetDocument } from "./fs/document.ts";
 import { jsonChunks } from "./json-chunks.ts";
-import { joinPath } from "./paths.ts";
-import { isRecord, positionAt, walkDocument } from "./json-document.ts";
+import { isRecord, positionAt, readStrict, StrictJSONError } from "./json-document.ts";
 import type { Position } from "./position.ts";
 import { declarationKey } from "./ref.ts";
 import {
@@ -185,30 +185,26 @@ function readDocument(
   symbols: readonly InventorySymbol[],
   shape: Shape,
 ): Suppressions {
-  const file = joinPath(targetRoot, shape.file);
-  if (host.kindOf(file) === "absent") {
+  const text = readTargetDocument(host, targetRoot, shape.file);
+  if (text === undefined) {
     return { records: [], refusals: [] };
   }
-  const text = host.readFile(file);
   const malformed = (detail: string, site = documentSite(shape)): never => {
     throw new SuppressionError(shape.mechanism, siteText(site), detail, shape.documentWant);
   };
-  let parsed: unknown;
+  let document;
   try {
-    parsed = JSON.parse(text);
+    document = readStrict(text, shape.array);
   } catch (error: unknown) {
-    return malformed(`${shape.file}: ${message(error)}`);
+    if (!(error instanceof StrictJSONError)) {
+      throw error;
+    }
+    return malformed(error.message, positionAt(text, shape.file, error.offset));
   }
+  const parsed = document.value;
   if (!isRecord(parsed)) {
     return malformed(shape.file);
   }
-  const walk = walkDocument(text, shape.array);
-  if (walk.twice !== undefined) {
-    malformed(
-      `the member ${JSON.stringify(walk.twice.name)} is written twice, so neither value is chosen`,
-      positionAt(text, shape.file, walk.twice.offset),
-    );
-  }
   for (const key of Object.keys(parsed)) {
     if (key !== "description" && key !== shape.array) {
       malformed(`the member ${JSON.stringify(key)} is not one the grammar declares`);
@@ -224,7 +220,7 @@ function readDocument(
   const records: SuppressionRecord[] = [];
   const refusals: Refusal[] = [];
   (held as readonly unknown[]).forEach((value, index) => {
-    const offset = walk.starts[index];
+    const offset = document.starts.get(index);
     const site = offset === undefined ? documentSite(shape) : positionAt(text, shape.file, offset);
     const read = readRecord(value, site, byReference, shape);
     records.push(...read.records);
@@ -382,10 +378,9 @@ function* separatorsEscaped(pieces: Iterable<string>): Generator<string, void, u
  * A baseline holding one row per finding, in the order given, which is the report's, and
  * the other language's rows `kept`, Go's rows ahead of TypeScript's and each scheme's in
  * the order given, so two analyzers writing one document in either order write the same
- * bytes, in the form grammar/suppression.md fixes. Every recorded row carries the
- * provenance as its reason. A finding
- * missing a value a row needs, and an identity missing its name or version, are refused
- * rather than written, because the grammar requires a reason on every row.
+ * bytes, in the form grammar/suppression.md fixes. Every row carries the provenance as
+ * its reason, so a finding missing a value a row needs, or an identity missing its name
+ * or version, is refused rather than written.
  */
 export function writeBaseline(
   findings: readonly Recorded[],

package/src/suppress.ts

@@ -13,7 +13,7 @@ import {
   SYMBOL_SUBJECTS,
   type Subject,
 } from "./contract/contract.generated.ts";
-import { ConfigError } from "./config.ts";
+import { UsageError } from "./usage.ts";
 import type { Finding } from "./finding.ts";
 import { positionKey, type Position } from "./position.ts";
 import { isRef } from "./ref.ts";
@@ -68,9 +68,9 @@ export interface Suppressions {
  * instruction the analysis cannot carry out. It is a malformed input, so the command line
  * answers it with the usage code.
  */
-export class SuppressionError extends ConfigError {
+export class SuppressionError extends UsageError {
   constructor(mechanism: Mechanism, at: string, text: string, want: string) {
-    super("malformed", at, `${mechanism} ${at}: ${text}: want ${want}`);
+    super(`${mechanism} ${at}: ${text}: want ${want}`);
     this.name = "SuppressionError";
   }
 }

package/src/template-field.ts

@@ -13,7 +13,7 @@
  */
 
 import { readComponent } from "./component-files.ts";
-import { ConfigError, type Analysis, type TemplateDelimiters } from "./config.ts";
+import type { ResolvedConfig, TemplateDelimiters } from "./config.ts";
 import type { DetectorInput, Evidence } from "./exempt.ts";
 import type { Host } from "./host.ts";
 import type { SymbolKind } from "./inventory.ts";
@@ -22,6 +22,7 @@ import { extensionOf, isAbsolutePath, joinPath, normalizePath, relativePath } fr
 import { isComponentFile, type Position } from "./position.ts";
 import { bytewise } from "./text/compare.ts";
 import { filesBelow } from "./fs/tree.ts";
+import { UsageError } from "./usage.ts";
 
 /** One template, by its path below the target root. */
 interface TemplateFile {
@@ -60,7 +61,11 @@ const IDENTIFIER = /[\p{ID_Start}$_][\p{ID_Continue}$\u200C\u200D]*/uy;
  * exemption it was configured for off. A symbolic link to a directory is not
  * followed.
  */
-export function readTemplates(host: Host, targetRoot: string, analysis: Analysis): Templates {
+export function readTemplates(
+  host: Host,
+  targetRoot: string,
+  analysis: ResolvedConfig["analysis"],
+): Templates {
   const files = new Map<string, string>();
   const read = (dir: string): void => {
     for (const below of filesBelow(host, joinPath(targetRoot, dir), () => true)) {
@@ -71,7 +76,7 @@ export function readTemplates(host: Host, targetRoot: string, analysis: Analysis
       }
     }
   };
-  for (const configured of analysis.templateDirs) {
+  for (const configured of analysis.template_dirs) {
     const dir = normalizePath(configured);
     if (
       isAbsolutePath(dir) ||
@@ -79,16 +84,14 @@ export function readTemplates(host: Host, targetRoot: string, analysis: Analysis
       dir.startsWith("../") ||
       host.kindOf(joinPath(targetRoot, dir)) !== "directory"
     ) {
-      throw new ConfigError(
-        "malformed",
-        "analysis.template_dirs",
+      throw new UsageError(
         `analysis.template_dirs: ${JSON.stringify(configured)} is not a directory below the target root`,
       );
     }
     read(dir);
   }
   return {
-    delimiters: analysis.templateDelimiters,
+    delimiters: analysis.template_delimiters,
     files: [...files]
       .map(([path, text]) => ({ path, text }))
       .sort((a, b) => bytewise(a.path, b.path)),