@boxxy/verifier-wringer 0.2.7 → 0.2.9

package/README.md

@@ -29,13 +29,16 @@ The package runs on [Bun](https://bun.sh) 1.3 or newer.
 - `createWringerVerifier({ forge, gateCheck })` returns a `Verifier`. The app passes its forge and
   the name of the gate check, such as `verify / gate`.
 - `readAt(pullRequest, head)` reads the latest run of the gate check at `head`. A passed gate reads
-  `verified` and a failed gate reads `incomplete`, each with the features of the report.
+  `verified` and a failed gate reads `incomplete`, each with the features of the report: one
+  `verified` feature for each claim, and none for a failed gate.
 - A head with no gate check run, or one still running, cancelled or skipped, reads `not-covered`.
   The adapter then never reads the body. A commit status of the gate's name never counts.
-- A finished gate with no report in the body, or a report that does not parse, reads `incomplete`
-  with no features.
-- The adapter does no I/O of its own. It reads the forge, and parses the report with wringer's
-  `parseReportBlock`.
+- A finished gate with no data comment of version 2 in the body, or one that does not parse, reads
+  `incomplete` with no features and a `note` that holds the parser's refusal. A report of version 1,
+  from before `bun verify publish` wrote version 2, reads the same, and its note says to run
+  `bun verify publish` again.
+- The adapter does no I/O of its own. It reads the forge, and reads the data comment with wringer's
+  `parseReportComment`.
 
 ## Documentation
 

package/dist/test-utils/build-mock-wringer-comment.d.ts

@@ -0,0 +1,2 @@
+import type { Report } from '@wringer/core';
+export declare function buildMockWringerComment(report: Report): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxxy/verifier-wringer",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "boxxy's verifier on wringer: reads the verify gate check and the report in a pull request",
   "homepage": "https://github.com/zgeoff/boxxy/tree/main/adapters/verifier-wringer#readme",
   "bugs": "https://github.com/zgeoff/boxxy/issues",
@@ -30,11 +30,11 @@
     "typecheck": "tsrs --noEmit"
   },
   "dependencies": {
-    "@boxxy/model": "0.2.7",
-    "@wringer/core": "0.2.0"
+    "@boxxy/model": "0.2.9",
+    "@wringer/core": "0.3.1"
   },
   "devDependencies": {
-    "@boxxy/dispatch": "0.2.7",
+    "@boxxy/dispatch": "0.2.9",
     "@faker-js/faker": "10.6.0"
   },
   "peerDependencies": {

package/src/create-wringer-verifier.ts

@@ -1,5 +1,5 @@
 import type { CheckReading, CommitSha, Verifier, VerifyReading } from '@boxxy/model';
-import { parseReportBlock } from '@wringer/core';
+import { parseReportComment } from '@wringer/core';
 import type { WringerVerifierOptions } from './types.ts';
 
 // The `Verifier` port on wringer. The gate check in CI computes the fingerprint, which needs a
@@ -32,23 +32,35 @@ function pickGateState(gate: CheckReading | undefined): 'success' | 'failure' |
   return gate.state === 'success' || gate.state === 'failure' ? gate.state : null;
 }
 
+// A claim in the data comment carries no feature status, because staleness needs the diff that
+// only the gate has. A passed gate reads each claim as `verified`, and a failed gate reads no
+// feature. A comment that does not parse reads `incomplete`, with its refusal as the note.
 function buildVerifyReading(
   head: CommitSha,
   gate: 'success' | 'failure',
   body: string,
 ): VerifyReading {
-  const parsed = parseReportBlock(body);
+  const parsed = parseReportComment(body);
 
   if (!parsed.ok) {
+    const note =
+      parsed.reason === 'version-1'
+        ? `${parsed.message} Run \`bun verify publish\` again.`
+        : parsed.message;
+
+    return { status: 'incomplete', head, features: [], note };
+  }
+
+  if (gate === 'failure') {
     return { status: 'incomplete', head, features: [] };
   }
 
   return {
-    status: gate === 'success' ? 'verified' : 'incomplete',
+    status: 'verified',
     head,
-    features: parsed.report.features.map((feature) => ({
-      name: feature.name,
-      status: feature.status,
+    features: parsed.comment.claims.map((claim) => ({
+      name: claim.feature,
+      status: 'verified',
     })),
   };
 }

package/src/test-utils/build-mock-wringer-comment.ts

@@ -0,0 +1,7 @@
+import type { Report } from '@wringer/core';
+import { renderReportComment, toReportComment } from '@wringer/core';
+
+// The data comment that `bun verify publish` writes into a pull request body for the report.
+export function buildMockWringerComment(report: Report): string {
+  return renderReportComment(toReportComment(report, 'boxxy-verify'));
+}

package/src/test-utils/build-mock-wringer-report.ts

@@ -8,10 +8,9 @@ interface MockWringerReportInput {
 // A wringer report against `origin/main` at a random fingerprint. A `verified` or `stale` feature
 // carries a verdict, and only an `unchanged` feature is unchanged.
 export function buildMockWringerReport(input: MockWringerReportInput): Report {
-  const fingerprint = faker.string.hexadecimal({ length: 16, casing: 'lower', prefix: '' });
+  const fingerprint = faker.string.hexadecimal({ length: 40, casing: 'lower', prefix: '' });
 
   return {
-    version: 1,
     base: 'origin/main',
     fingerprint,
     complete: input.features.every(
@@ -25,12 +24,15 @@ export function buildMockWringerReport(input: MockWringerReportInput): Report {
         feature.status === 'verified' || feature.status === 'stale'
           ? {
               feature: feature.name,
-              fingerprint:
+              fingerprint,
+              featureFingerprint:
                 feature.status === 'verified'
                   ? fingerprint
-                  : faker.string.hexadecimal({ length: 16, casing: 'lower', prefix: '' }),
+                  : faker.string.hexadecimal({ length: 40, casing: 'lower', prefix: '' }),
               run: `run-${faker.string.alphanumeric(8)}`,
               at: faker.date.recent().toISOString(),
+              target: { name: 'local', evidence: 'local' as const },
+              pin: { kind: 'local' as const },
               evidence: [],
             }
           : null,