@cplieger/deadset-ts 7.2.0-dev.4 → 8.0.0-dev.10

package/src/reporters/sarif.ts

@@ -1,12 +1,19 @@
-import type { Confidence, Severity } from "../config.ts";
 import { jsonChunks } from "../json-chunks.ts";
-import { KINDS, type KindRow } from "../kinds.ts";
+import type { KindRow, Confidence, Severity } from "../contract/contract.generated.ts";
+import { KINDS } from "../kinds.ts";
 import { declarationKey } from "../ref.ts";
-import type { Report, WireFinding, WireStaleSuppression } from "../report.ts";
+import type {
+  ComponentsEntry,
+  Finding,
+  Report,
+  StaleSuppressionsEntry,
+} from "../contract/report.generated.ts";
 import { lineHashes, symbolFingerprint } from "./fingerprint.ts";
 import { RenderError, type RenderOptions } from "./reporter.ts";
 import { utf8Bytes } from "./sha256.ts";
 import { withheldLine } from "./text.ts";
+import { bytewise } from "../text/compare.ts";
+import { message } from "../product.ts";
 
 const SCHEMA =
   "https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json";
@@ -128,9 +135,7 @@ function lineHashCache(read: (path: string) => string): (at: Located) => string
       try {
         text = read(at.path);
       } catch (error: unknown) {
-        throw new RenderError(
-          `read ${at.path} for its line fingerprint: ${error instanceof Error ? error.message : String(error)}`,
-        );
+        throw new RenderError(`read ${at.path} for its line fingerprint: ${message(error)}`);
       }
       hashes = lineHashes(text);
       held.set(at.path, hashes);
@@ -151,8 +156,11 @@ interface Related {
   readonly endLine: number;
 }
 
+/** The members the report lists for one component, none where it lists none. */
+type MembersOf = (id: string) => ComponentsEntry["members"];
+
 /** Every position a finding names beyond its own, in the mapping's order, the first hundred. */
-function relatedOf(found: WireFinding): readonly Related[] {
+function relatedOf(found: Finding, members: MembersOf): readonly Related[] {
   const related: Related[] = [];
   for (const one of found.details.implementations ?? []) {
     related.push({ label: "implementation", at: one.position, endLine: one.position.end_line });
@@ -164,7 +172,7 @@ function relatedOf(found: WireFinding): readonly Related[] {
     const at = found.details.name_literal;
     related.push({ label: "name", at, endLine: at.end_line });
   }
-  for (const one of found.component.members ?? []) {
+  for (const one of members(found.component.id)) {
     if (
       declarationKey(one.ref, one.position.path) !==
       declarationKey(found.symbol.ref, found.position.path)
@@ -188,7 +196,9 @@ function messageWithLinks(message: string, related: readonly Related[]): string
 }
 
 /** Every member of the finding the mapping places nowhere else, under its schema name. */
-function propertiesOf(found: WireFinding): Record<string, unknown> {
+/** A result's member bag, its component holding the members the report lists for it once. */
+function propertiesOf(found: Finding, members: MembersOf): Record<string, unknown> {
+  const listed = members(found.component.id);
   return {
     language: found.language,
     symbol: found.symbol,
@@ -199,7 +209,7 @@ function propertiesOf(found: WireFinding): Record<string, unknown> {
       : { liveness_relation: found.liveness_relation }),
     test_only: found.test_only,
     generated: found.generated,
-    component: found.component,
+    component: listed.length === 0 ? found.component : { ...found.component, members: listed },
     retained_by: found.retained_by,
     configurations: found.configurations,
     consumers_loaded: found.consumers_loaded,
@@ -217,11 +227,12 @@ function ruleIndex(index: ReadonlyMap<string, number>, code: string): number {
 }
 
 function findingResult(
-  found: WireFinding,
+  found: Finding,
   index: ReadonlyMap<string, number>,
   hashOf: (at: Located) => string,
+  members: MembersOf,
 ): Record<string, unknown> {
-  const related = relatedOf(found);
+  const related = relatedOf(found, members);
   return {
     ruleId: found.code,
     ruleIndex: ruleIndex(index, found.code),
@@ -241,13 +252,13 @@ function findingResult(
       primaryLocationLineHash: hashOf(found.position),
       "deadsetSymbolRef/v1": symbolFingerprint(found.code, found.symbol.ref),
     },
-    properties: propertiesOf(found),
+    properties: propertiesOf(found, members),
   };
 }
 
 /** A stale suppression at the failing level, at its own site; it is no finding, so it carries no member bag. */
 function staleResult(
-  stale: WireStaleSuppression,
+  stale: StaleSuppressionsEntry,
   index: ReadonlyMap<string, number>,
   hashOf: (at: Located) => string,
 ): Record<string, unknown> {
@@ -275,11 +286,13 @@ export function sarif(report: Report, options: RenderOptions): Iterable<string>
   const ruleList = rules(kinds);
   const index = new Map(kinds.map((kind, at) => [kind.code, at]));
   const hashOf = lineHashCache(options.readSource);
+  const listed = new Map((report.components ?? []).map((one) => [one.id, one.members]));
+  const members: MembersOf = (id) => listed.get(id) ?? [];
   const results = [
-    ...report.findings.map((found) => findingResult(found, index, hashOf)),
+    ...report.findings.map((found) => findingResult(found, index, hashOf, members)),
     ...report.stale_suppressions.map((stale) => staleResult(stale, index, hashOf)),
   ];
-  const languages = [...report.analyzer.languages].sort().join("+");
+  const languages = [...report.analyzer.languages].sort(bytewise).join("+");
   const withheld = withheldLine(report.totals);
   const log = {
     $schema: SCHEMA,

package/src/reporters/template.ts

@@ -10,6 +10,7 @@
 import { CHUNK_LENGTH } from "../json-chunks.ts";
 import { RenderError } from "./reporter.ts";
 import { utf8Bytes } from "./sha256.ts";
+import { bytewise } from "../text/compare.ts";
 
 /** A template that does not parse, which refuses the invocation before any analysis. */
 export class TemplateError extends Error {
@@ -618,7 +619,7 @@ function formatted(value: Value, nested: boolean): string {
   }
   const object: ValueObject = value;
   const entries = Object.keys(object)
-    .sort()
+    .sort(bytewise)
     .map((key) => `${key}:${formatted(object[key] ?? null, true)}`);
   return `map[${entries.join(" ")}]`;
 }
@@ -647,28 +648,11 @@ function compareBasic(name: string, a: Value, b: Value): number {
     return Number.NaN;
   }
   if (kind === "string") {
-    return byCodePoints(a as string, b as string);
+    return bytewise(a as string, b as string);
   }
   return (a as number) < (b as number) ? -1 : 1;
 }
 
-/**
- * Two strings ordered by the bytes of their UTF-8 encodings, which is the order of their
- * code points: the order of their UTF-16 code units differs above U+FFFF.
- */
-function byCodePoints(a: string, b: string): number {
-  let at = 0;
-  while (at < a.length && at < b.length) {
-    const x = a.codePointAt(at) ?? 0;
-    const y = b.codePointAt(at) ?? 0;
-    if (x !== y) {
-      return x < y ? -1 : 1;
-    }
-    at += x > 0xffff ? 2 : 1;
-  }
-  return a.length - b.length;
-}
-
 /** The escapes `%q` writes for the control characters that have one of their own. */
 const QUOTED_ESCAPES: Readonly<Record<string, string>> = {
   '"': '\\"',
@@ -1022,7 +1006,7 @@ class Execution {
         entries = value.map((one, i) => [i, one]);
       } else if (isObject(value)) {
         entries = Object.keys(value)
-          .sort()
+          .sort(bytewise)
           .map((key) => [key, value[key] ?? null]);
       } else {
         throw new RenderError(`range cannot iterate over a ${kindOf(value)}`);

package/src/reporters/text.ts

@@ -1,5 +1,5 @@
 import { coalesced } from "../json-chunks.ts";
-import type { Report, WireTotals } from "../report.ts";
+import type { Report, Totals } from "../contract/report.generated.ts";
 
 /** The kind token and the confidence a stale suppression is rendered with, both fixed. */
 const STALE_KIND = "suppression";
@@ -11,7 +11,7 @@ function counted(n: number, one: string, many: string): string {
 }
 
 /** The report's totals in one line, in the order the report declares them. */
-function summary(totals: WireTotals): string {
+function summary(totals: Totals): string {
   const { allow, warn, deny } = totals.by_severity;
   return [
     `summary: ${counted(totals.findings, "finding", "findings")} (${String(allow)} allow, ${String(warn)} warn, ${String(deny)} deny)`,
@@ -31,7 +31,7 @@ const WITHHELD_ORDER = ["probable", "possible"] as const;
  * The line naming what the minimum confidence withheld and the setting that shows it all,
  * or undefined where it withheld nothing.
  */
-export function withheldLine(totals: WireTotals): string | undefined {
+export function withheldLine(totals: Totals): string | undefined {
   const named = WITHHELD_ORDER.filter((confidence) => totals.withheld[confidence] > 0);
   const lowest = named.at(-1);
   if (lowest === undefined) {