@cplieger/deadset-ts 8.0.0-dev.2 → 8.0.0-dev.21

package/src/load/classify.ts

@@ -0,0 +1,433 @@
+import type { SourceFile } from "@typescript/native/ast";
+import { conventionFailuresFor } from "../entries/conventions.ts";
+import type { Host } from "../host.ts";
+import { relativePath, resolvePath } from "../paths.ts";
+import { diagnosticsOf, ownedAs, type Engine, type ProjectView } from "../session.ts";
+import { skipAt, type Skip } from "../type-errors.ts";
+import {
+  classOf,
+  MISSING_GLOBAL_TYPE,
+  projectErrors,
+  renderDiagnostic,
+  type LocatedDiagnostic,
+} from "./diagnostics.ts";
+import {
+  targetRelative,
+  unreadableDetail,
+  type LoadedConsumer,
+  type NotBuilt,
+  type Origin,
+} from "./discover.ts";
+import { missingModule, pathsOf, type ModuleContext } from "./expected-module.ts";
+import { FailureExit, failureLine, type Failure } from "../failure.ts";
+import type { ProgramPlan, RunPlan } from "./plan.ts";
+import { JAVASCRIPT_FILE } from "../javascript-file.ts";
+import { readSpecifiers, type UnresolvedSpecifier } from "./specifiers.ts";
+import { ownErrors } from "./workspace-run.ts";
+
+/** What keeps one configuration from being analyzed. */
+type Failed =
+  /** Its project carries an error that leaves it unloaded, its configuration unreadable or not. */
+  | {
+      readonly kind: "load";
+      readonly errors: readonly [LocatedDiagnostic, ...LocatedDiagnostic[]];
+      readonly unreadable: boolean;
+    }
+  | { readonly kind: "setup"; readonly failures: readonly [Failure, ...Failure[]] }
+  /** The snapshot opened no project for it. */
+  | { readonly kind: "unopened" };
+
+/** What a failure ends or drops, by where the configuration comes from. */
+const POLICY: Readonly<Record<Origin, Readonly<Record<Failed["kind"], "drop" | "end">>>> = {
+  declared: { load: "end", setup: "end", unopened: "end" },
+  scope: { load: "end", setup: "end", unopened: "end" },
+  derived: { load: "drop", setup: "drop", unopened: "drop" },
+  consumer: { load: "end", setup: "end", unopened: "end" },
+};
+
+/** One library an analyzed configuration names that the compiler cannot find. */
+export interface LibraryUnfound {
+  readonly configFile: string;
+  /** The compiler's error, rendered as a dropped configuration's is. */
+  readonly error: string;
+}
+
+/** One target project the run analyzes, as classification leaves it. */
+interface Analyzed<Brand> {
+  readonly plan: ProgramPlan;
+  /** The project, its own files the target's. */
+  readonly project: ProjectView<Brand>;
+  /** Every type error of its own files, with the unit it skips. */
+  readonly skips: readonly Skip[];
+  /** Whether it holds one file only for the references that file makes. */
+  readonly referenceOnly: (file: string) => boolean;
+  /** The relative specifiers of its unchecked JavaScript files that resolve to no file. */
+  readonly unresolved: readonly UnresolvedSpecifier[];
+}
+
+/** One consumer project the run reads the references of. */
+interface Consumed<Brand> {
+  readonly project: ProjectView<Brand>;
+  readonly consumer: LoadedConsumer;
+}
+
+/** Every opened project of a run that may be read, and what the run notes about the others. */
+export interface Classified {
+  readonly analyzed: readonly Analyzed<unknown>[];
+  readonly consumed: readonly Consumed<unknown>[];
+  /** The derived configurations dropped, discovery's first, then in configuration order. */
+  readonly notBuilt: readonly NotBuilt[];
+  readonly librariesUnfound: readonly LibraryUnfound[];
+  /** The unresolved specifiers of every analyzed project, each once, in configuration order. */
+  readonly unresolvedSpecifiers: readonly UnresolvedSpecifier[];
+}
+
+/**
+ * The errors of one project's own files: an import of a module the project expects and
+ * nothing provides is a setup failure, every other error a type error skipping its unit.
+ * Where `plan`'s options do not check JavaScript, an unfound module of a JavaScript file is
+ * none of them, a file `// @ts-check` checks included: {@link readSpecifiers} reads it.
+ */
+function readErrors<Brand>(
+  project: ProjectView<Brand>,
+  plan: ProgramPlan,
+  errors: readonly LocatedDiagnostic[],
+  context: ModuleContext,
+): { readonly missing: readonly Failure[]; readonly skips: readonly Skip[] } {
+  const files = new Map<string, SourceFile>(
+    project.ownSourceFiles().map((file) => [file.fileName, file]),
+  );
+  const missing: Failure[] = [];
+  const skips: Skip[] = [];
+  for (const { diagnostic, at } of errors) {
+    const file = diagnostic.fileName === undefined ? undefined : files.get(diagnostic.fileName);
+    const kind = classOf(diagnostic, true);
+    if (
+      file === undefined ||
+      kind === "ignored" ||
+      ((kind === "module-not-found" || kind === "side-effect-module-not-found") &&
+        !checksJavaScript(plan) &&
+        JAVASCRIPT_FILE.test(file.fileName))
+    ) {
+      continue;
+    }
+
+    const line = at?.line ?? 1;
+    const path = relativePath(context.targetRoot, file.fileName) ?? file.fileName;
+    const expected =
+      kind === "module-not-found" ? missingModule(context, file, diagnostic.pos) : undefined;
+    if (expected !== undefined) {
+      missing.push({
+        failureClass: "missing-module",
+        detail: `${path}:${String(line)}: ${path} imports ${JSON.stringify(expected.specifier)}, ${expected.reason}`,
+      });
+      continue;
+    }
+    const skip = skipAt(file, diagnostic.pos, line, diagnostic.text, context.targetRoot);
+    if (skip !== undefined) {
+      skips.push(skip);
+    }
+  }
+  return { missing, skips };
+}
+
+function checksJavaScript(plan: ProgramPlan): boolean {
+  return plan.options.checkJs === true;
+}
+
+function nonEmpty<T>(items: readonly T[]): readonly [T, ...T[]] | undefined {
+  const [first, ...rest] = items;
+  return first === undefined ? undefined : [first, ...rest];
+}
+
+/** One target project read for what keeps it from being analyzed, or the skips it is analyzed with. */
+function classifyTarget<Brand>(
+  engine: Engine,
+  host: Host,
+  run: RunPlan,
+  plan: ProgramPlan,
+  view: ProjectView<Brand>,
+  unfound: LibraryUnfound[],
+): Failed | Analyzed<Brand> {
+  const { workspace, root } = run;
+  const unbuildable = workspace?.unbuildable(plan.configFile);
+  if (unbuildable !== undefined) {
+    return {
+      kind: "setup",
+      failures: [{ failureClass: "workspace-member-without-source", detail: unbuildable }],
+    };
+  }
+  const referenceOnly =
+    workspace === undefined
+      ? () => false
+      : workspace.referenceOnly(plan.configFile, view.rootFiles);
+  // A file outside the target root that a program reaches is no file of the target's, so no
+  // position below the root names it.
+  const project = ownedAs(
+    view,
+    (file, external) =>
+      relativePath(root, file) !== undefined &&
+      (workspace === undefined ? !external : workspace.ownFile(file, external)),
+  );
+  const raw = projectErrors(diagnosticsOf(project));
+  const load = nonEmpty(raw.load);
+  if (load !== undefined) {
+    return { kind: "load", errors: load, unreadable: raw.unreadable };
+  }
+  const reading = readErrors(project, plan, ownErrors(raw.check, referenceOnly), {
+    host,
+    targetRoot: root,
+    paths: pathsOf(plan.configFile, plan.parsed.options),
+    member: (manifest) => workspace?.workspace.memberOf(manifest) !== undefined,
+  });
+  const specifiers = readSpecifiers(engine, host, project, {
+    checked: checksJavaScript(plan),
+    root,
+    outputs: run.outputs,
+  });
+  const failures =
+    nonEmpty(reading.missing) ??
+    nonEmpty(specifiers.uninstalled === undefined ? [] : [specifiers.uninstalled]) ??
+    nonEmpty(
+      conventionFailuresFor(
+        run.conventions,
+        plan.configFile,
+        project.ownSourceFiles().map((file) => file.fileName),
+      ),
+    );
+  if (failures !== undefined) {
+    return { kind: "setup", failures };
+  }
+  const display = (path: string): string => relativePath(root, path) ?? path;
+  unfound.push(
+    ...raw.unfound.map((one) => ({
+      configFile: plan.configFile,
+      error: renderDiagnostic(one, display),
+    })),
+  );
+  const missingGlobal = raw.unfound.find(
+    ({ diagnostic }) => diagnostic.code === MISSING_GLOBAL_TYPE,
+  );
+  // The checker types every use of a missing global against nothing and places no error in
+  // a file, so every file of the project is skipped whole.
+  const skips =
+    missingGlobal === undefined
+      ? reading.skips
+      : [
+          ...reading.skips,
+          ...project.ownSourceFiles().map((file) => ({
+            record: {
+              path: display(file.fileName),
+              line: 1,
+              message: missingGlobal.diagnostic.text,
+            },
+            file,
+            unit: file,
+          })),
+        ];
+  return { plan, project, skips, referenceOnly, unresolved: specifiers.unresolved };
+}
+
+/**
+ * One consumer project read for what keeps its references from being read: a missing module, or
+ * JavaScript whose imported dependencies are none of them installed, as a target's are. A workspace
+ * declaration that cannot be read fails it where an import asks whether a package is a member.
+ */
+function classifyConsumer<Brand>(
+  engine: Engine,
+  host: Host,
+  run: RunPlan,
+  plan: ProgramPlan,
+  consumer: LoadedConsumer,
+  project: ProjectView<Brand>,
+): Failed | Consumed<Brand> {
+  const place = run.consumerWorkspaces.get(consumer.path);
+  const consumerRoot = resolvePath(host.workingDirectory(), consumer.path);
+  const raw = projectErrors(diagnosticsOf(project));
+  const load = nonEmpty(raw.load);
+  if (load !== undefined) {
+    return { kind: "load", errors: load, unreadable: raw.unreadable };
+  }
+  let faulted: string | undefined;
+  const reading = readErrors(project, plan, raw.check, {
+    host,
+    targetRoot: consumerRoot,
+    paths: pathsOf(plan.configFile, plan.parsed.options),
+    member: (manifest) => {
+      if (place !== undefined && "fault" in place) {
+        faulted = place.fault;
+        return false;
+      }
+      return place?.workspace?.memberOf(manifest) !== undefined;
+    },
+  });
+  const { uninstalled } = readSpecifiers(engine, host, project, {
+    checked: checksJavaScript(plan),
+    root: consumerRoot,
+    outputs: run.outputs,
+  });
+  const details =
+    faulted === undefined
+      ? [...reading.missing, ...(uninstalled === undefined ? [] : [uninstalled])].map(
+          (one) =>
+            `the consumer ${consumer.path} does not build, its dependencies not installed: ${one.detail}`,
+        )
+      : [
+          `the consumer ${consumer.path} imports a dependency a package below it declares, and its workspace declaration cannot be read to tell whether that package is a member: ${faulted}`,
+        ];
+  const failures = nonEmpty(
+    details.map((detail) => ({ failureClass: "missing-consumer" as const, detail })),
+  );
+  return failures === undefined ? { project, consumer } : { kind: "setup", failures };
+}
+
+/** The setup failure one failed configuration ends the run with, its located errors printed first. */
+function ending(plan: ProgramPlan, failed: Failed, root: string): readonly Failure[] {
+  if (failed.kind === "setup") {
+    return failed.failures;
+  }
+  const what =
+    failed.kind === "load"
+      ? `the configuration ${relativePath(root, plan.configFile) ?? plan.configFile} does not load, its errors printed above`
+      : `the compiler opened no project for ${plan.configFile}`;
+  return plan.consumer === undefined
+    ? [
+        {
+          failureClass:
+            failed.kind === "load" && failed.unreadable ? "unreadable-configuration" : "no-program",
+          detail: `${what}: correct the configuration, or name the configurations to analyze`,
+        },
+      ]
+    : [
+        {
+          failureClass: "missing-consumer",
+          detail: `${what}, for the consumer ${plan.consumer.path}: check the consumer out at ${plan.consumer.path} and install its dependencies`,
+        },
+      ];
+}
+
+/** The setup failures a dropped derived configuration counts as, where it counts as any. */
+function droppedFailures(
+  failed: Failed,
+  plan: ProgramPlan,
+  root: string,
+): { readonly failures?: readonly [Failure, ...Failure[]] } {
+  if (failed.kind === "setup") {
+    return { failures: failed.failures };
+  }
+  return failed.kind === "load" && failed.unreadable
+    ? {
+        failures: [
+          {
+            failureClass: "unreadable-configuration",
+            detail: unreadableDetail(
+              plan.id,
+              `cannot be read as a compiler configuration: ${droppedBy(failed, root)}`,
+            ),
+          },
+        ],
+      }
+    : {};
+}
+
+/** The first line of the error that drops one derived configuration. */
+function droppedBy(failed: Failed, root: string): string {
+  return failed.kind === "load"
+    ? targetRelative(
+        renderDiagnostic(failed.errors[0], (path) => relativePath(root, path) ?? path),
+        root,
+      )
+    : failed.kind === "setup"
+      ? targetRelative(failureLine(failed.failures[0]), root)
+      : "the compiler opened no project for the configuration";
+}
+
+/**
+ * Every opened project of the run classified as analyzed, dropped or failing by the policy
+ * table, before any stage reads one. A failure that ends the run is one {@link FailureExit}, by
+ * this precedence: a configuration the snapshot opened nothing for, then the setup failures,
+ * then the configurations that did not load with their errors, then, where every derived
+ * configuration was dropped, their setup failures or the first reason.
+ */
+export function classify(
+  engine: Engine,
+  host: Host,
+  run: RunPlan,
+  views: ReadonlyMap<string, ProjectView<unknown>>,
+): Classified {
+  const { root } = run;
+  const notBuilt: NotBuilt[] = [...run.discovery.notBuilt];
+  const librariesUnfound: LibraryUnfound[] = [];
+  const analyzed: Analyzed<unknown>[] = [];
+  const consumed: Consumed<unknown>[] = [];
+  const ended = new Map<Failed["kind"], { plan: ProgramPlan; failed: Failed }[]>();
+  const unopened = run.plans.filter((plan) => !views.has(plan.configFile));
+  const outcomes = [
+    ...run.plans.flatMap((plan) => {
+      const view = views.get(plan.configFile);
+      return view === undefined
+        ? []
+        : [
+            {
+              plan,
+              outcome:
+                plan.consumer === undefined
+                  ? classifyTarget(engine, host, run, plan, view, librariesUnfound)
+                  : classifyConsumer(engine, host, run, plan, plan.consumer, view),
+            },
+          ];
+    }),
+    ...unopened.map((plan) => ({ plan, outcome: { kind: "unopened" } as const })),
+  ];
+  for (const { plan, outcome } of outcomes) {
+    if (!("kind" in outcome)) {
+      if ("consumer" in outcome) {
+        consumed.push(outcome);
+      } else {
+        analyzed.push(outcome);
+      }
+    } else if (POLICY[plan.origin][outcome.kind] === "end") {
+      ended.set(outcome.kind, [...(ended.get(outcome.kind) ?? []), { plan, failed: outcome }]);
+    } else {
+      notBuilt.push({
+        id: plan.id,
+        configFile: plan.configFile,
+        error: droppedBy(outcome, root),
+        ...droppedFailures(outcome, plan, root),
+      });
+    }
+  }
+  for (const kind of ["unopened", "setup", "load"] as const) {
+    const all = ended.get(kind) ?? [];
+    const failures = nonEmpty(all.flatMap(({ plan, failed }) => ending(plan, failed, root)));
+    if (failures !== undefined) {
+      throw new FailureExit(
+        kind === "unopened" ? [failures[0]] : failures,
+        all.flatMap(({ failed }) => (failed.kind === "load" ? failed.errors : [])),
+      );
+    }
+  }
+  const setupDropped = nonEmpty(notBuilt.flatMap((one) => one.failures ?? []));
+  const [first] = notBuilt;
+  if (analyzed.length === 0 && first !== undefined) {
+    throw new FailureExit(
+      setupDropped ?? [
+        {
+          failureClass: "no-program",
+          detail: `no configuration discovery derived could be built; ${first.id}: ${first.error}`,
+        },
+      ],
+    );
+  }
+  const unresolvedSpecifiers = [
+    ...new Map(
+      analyzed
+        .flatMap((one) => one.unresolved)
+        .map((one) => {
+          const { path, line, column } = one.position;
+          return [JSON.stringify([path, line, column, one.specifier]), one] as const;
+        }),
+    ).values(),
+  ];
+  return { analyzed, consumed, notBuilt, librariesUnfound, unresolvedSpecifiers };
+}

package/src/load/diagnostics.ts

@@ -0,0 +1,154 @@
+import { DiagnosticCategory } from "@typescript/native/sync";
+import type { Diagnostic } from "@typescript/native/sync";
+import type { ProjectDiagnostics } from "../session.ts";
+
+/** What one error diagnostic of an opened project does to the run. */
+type DiagnosticClass =
+  /** The project did not load, whatever its files say. */
+  | "load"
+  /** A library the configuration names that the compiler cannot find; the project loads. */
+  | "unfound-library"
+  /** An import of a module the compiler cannot find, a setup failure where the project expects it. */
+  | "module-not-found"
+  /** A side-effect import of a module the compiler cannot find, a type error in a TypeScript file. */
+  | "side-effect-module-not-found"
+  /** A type error: the unit holding it is skipped. */
+  | "type-error"
+  /** No error of the program's: the compiler checks the whole program all the same. */
+  | "ignored";
+
+/** One row of the diagnostic table: the codes it covers, for errors placed in a file or in none. */
+interface DiagnosticRow {
+  readonly placed: boolean;
+  readonly codes: ReadonlySet<number> | { readonly from: number; readonly below: number };
+  readonly class: DiagnosticClass;
+}
+
+/** The code of a global type the checker finds in no library the program holds. */
+export const MISSING_GLOBAL_TYPE = 2318;
+
+/**
+ * What each error diagnostic does, first matching row first. In no file: an unfound type library
+ * or lib (https://github.com/microsoft/typescript-go/blob/89d5d5b2849a0db0957065889ca58536fa6d2e4a/internal/compiler/processingDiagnostic.go),
+ * then the semantic band from 2000; the option band from 5000 leaves the program whole
+ * (https://github.com/microsoft/TypeScript/wiki/Coding-guidelines#diagnostic-message-codes).
+ * In a file: an unfound module, and where the configuration places the file (5055, 5056, 6059,
+ * 6307), which changes no type a statement carries.
+ */
+const DIAGNOSTIC_TABLE: readonly DiagnosticRow[] = [
+  {
+    placed: false,
+    codes: new Set([MISSING_GLOBAL_TYPE, 2688, 2726, 2727]),
+    class: "unfound-library",
+  },
+  { placed: false, codes: { from: 2000, below: 3000 }, class: "load" },
+  { placed: true, codes: new Set([2307, 2792]), class: "module-not-found" },
+  { placed: true, codes: new Set([2882]), class: "side-effect-module-not-found" },
+  { placed: true, codes: new Set([5055, 5056, 6059, 6307]), class: "ignored" },
+];
+
+/** The category an error diagnostic carries, which the protocol sends as a number. */
+const ERROR_CATEGORY: number = DiagnosticCategory.Error;
+
+function isError(diagnostic: Diagnostic): boolean {
+  return diagnostic.category === ERROR_CATEGORY;
+}
+
+/**
+ * What one diagnostic does, placed in one of the project's own files or in none. A diagnostic
+ * the compiler marks as reporting unnecessary code in a file is no error of the program's.
+ */
+export function classOf(diagnostic: Diagnostic, placed: boolean): DiagnosticClass {
+  if (!isError(diagnostic) || (placed && diagnostic.reportsUnnecessary === true)) {
+    return "ignored";
+  }
+  const row = DIAGNOSTIC_TABLE.find(
+    ({ placed: where, codes }) =>
+      where === placed &&
+      ("has" in codes
+        ? codes.has(diagnostic.code)
+        : diagnostic.code >= codes.from && diagnostic.code < codes.below),
+  );
+  return row?.class ?? (placed ? "type-error" : "ignored");
+}
+
+/** One diagnostic, with the line and column its offset falls on where it names a file. */
+export interface LocatedDiagnostic {
+  readonly diagnostic: Diagnostic;
+  /** Where the diagnostic starts, counted from one; absent where it names no position. */
+  readonly at?: { readonly line: number; readonly column: number } | undefined;
+}
+
+/**
+ * One diagnostic as `path:line:column: TScode: message`, the position left out where it names
+ * none and the file where it names none. `display` spells the file's path.
+ */
+export function renderDiagnostic(
+  located: LocatedDiagnostic,
+  display: (path: string) => string = (path) => path,
+): string {
+  const { diagnostic, at } = located;
+  const message = `TS${String(diagnostic.code)}: ${diagnostic.text}`;
+  if (diagnostic.fileName === undefined) {
+    return message;
+  }
+  const where = display(diagnostic.fileName);
+  return at === undefined
+    ? `${where}: ${message}`
+    : `${where}:${String(at.line)}:${String(at.column)}: ${message}`;
+}
+
+function locatedIn(
+  diagnostics: readonly Diagnostic[],
+  locate: ProjectDiagnostics["locate"],
+): readonly LocatedDiagnostic[] {
+  return diagnostics.map((diagnostic) => ({
+    diagnostic,
+    at: diagnostic.fileName === undefined ? undefined : locate(diagnostic.fileName, diagnostic.pos),
+  }));
+}
+
+/**
+ * Every error a project's three diagnostic sets carry, in the order the compiler reported
+ * them. A resolved configuration carries no diagnostics of its own, so a configuration written
+ * with an unreadable option resolves and is refused here, once its project is open.
+ */
+export function diagnosticErrors(sets: {
+  readonly syntactic: readonly Diagnostic[];
+  readonly semantic: readonly Diagnostic[];
+  readonly configParsing: readonly Diagnostic[];
+}): readonly Diagnostic[] {
+  return [...sets.configParsing, ...sets.syntactic, ...sets.semantic].filter(isError);
+}
+
+/**
+ * The code of a configuration whose only parse error is that its inputs name no file: it reads
+ * as written and holds no program.
+ */
+const NO_INPUTS = 18003;
+
+/** Why one open project cannot be analyzed as it stands, split by whether it loaded at all. */
+interface ProjectErrors {
+  /** The configuration's own errors and the errors in no file the table reads as a load failure. */
+  readonly load: readonly LocatedDiagnostic[];
+  /** Whether the compiler cannot read the configuration: a parse error other than {@link NO_INPUTS}. */
+  readonly unreadable: boolean;
+  /** The errors in the files of a project that loaded. */
+  readonly check: readonly LocatedDiagnostic[];
+  /** The libraries the configuration names that the compiler cannot find, of a project that loaded. */
+  readonly unfound: readonly LocatedDiagnostic[];
+}
+
+/** The errors one open project carries, each located in the file it names. */
+export function projectErrors(sets: ProjectDiagnostics): ProjectErrors {
+  const unplaced = (kind: DiagnosticClass): readonly Diagnostic[] =>
+    sets.unplaced.filter((diagnostic) => classOf(diagnostic, false) === kind);
+  const parsing = sets.configParsing.filter(isError);
+  const load = [...parsing, ...unplaced("load")];
+  return {
+    load: locatedIn(load, sets.locate),
+    unreadable: parsing.some(({ code }) => code !== NO_INPUTS),
+    check: load.length > 0 ? [] : locatedIn(diagnosticErrors(sets), sets.locate),
+    unfound: load.length > 0 ? [] : locatedIn(unplaced("unfound-library"), sets.locate),
+  };
+}