@haystackeditor/cli 0.25.1 → 0.26.0

package/dist/commands/verify.js

@@ -555,6 +555,52 @@ export function formatCrawl(view) {
     }
     return lines.join('\n');
 }
+export function verifyReport(view) {
+    const status = reportedStatus(view);
+    const published = results(view);
+    const error = published?.error ?? view.error;
+    const explored = published !== null && view.clocks.crawlStartedAt !== null;
+    const findings = explored ? VERDICTS.flatMap(verdict => published.findings.filter(finding => finding.verdict === verdict)) : [];
+    const ideaWords = { covered: 'tried', blocked: 'could not try', unfinished: 'not finished' };
+    return {
+        runId: view.runId,
+        repository: view.repository,
+        title: view.changeTitle,
+        baseCommit: view.baseCommit,
+        workCommit: view.workCommit,
+        status,
+        headline: headline(view),
+        bugs: published?.bugs ?? view.totals.bugs,
+        findings: findings.map(finding => ({
+            id: finding.id,
+            verdict: finding.verdict,
+            why: finding.why,
+            start: finding.start,
+            steps: finding.steps,
+            outsideServices: finding.standIns && (finding.standIns.old.length > 0 || finding.standIns.new.length > 0)
+                ? { withoutChange: finding.standIns.old, withChange: finding.standIns.new }
+                : null,
+        })),
+        spots: explored ? published.reach.spots.map(spot => ({
+            file: spot.file,
+            line: spot.line,
+            reached: spot.furthest === null ? 'never reached' : SPOT_WORDS[spot.furthest],
+            reachedBy: spot.reachedBy && { start: spot.reachedBy.start, steps: spot.reachedBy.steps, page: spot.reachedBy.page },
+            findingIds: spot.findingIds,
+        })) : [],
+        ideas: explored && published.ideas !== undefined
+            ? published.ideas.map(idea => ({ text: idea.text, result: ideaWords[idea.state], reason: idea.reason, findingIds: idea.findingIds }))
+            : null,
+        neverRan: explored ? {
+            files: published.reach.unreachedChangedFiles,
+            functions: published.reach.blast === null ? null : { ran: published.reach.blast.ran, total: published.reach.blast.functions },
+        } : null,
+        notFinishedInTime: explored ? published.notFinishedInTime : 0,
+        outsideServiceGaps: explored ? published.standIns?.gaps ?? [] : [],
+        error: error ? { code: error.code, message: error.message } : null,
+        machinesNotProvenShutDown: TERMINAL.has(view.status) ? view.totals.cleanupUnproven : 0,
+    };
+}
 /** Case-batch status conventions: 0 finished (or answered: amendment 9, its work
  * is done and only its shutdown remains), or still running with --no-wait;
  * 2 ended without finishing (incomplete, cancelled) or finished with cleanup
@@ -791,9 +837,9 @@ function checkedLine(change) {
 }
 /** Prints the onboarding (and nothing else) as the command's answer: `--json`
  * carries OnboardingStatusV1. A block exits 3: its ask says what to do. */
-function finishWithOnboarding(status, json, change) {
-    if (json)
-        process.stdout.write(`${JSON.stringify(withSchema('verify', { change, onboarding: status, crawl: null }), null, 2)}\n`);
+function finishWithOnboarding(status, options, change) {
+    if (options.json || options.raw)
+        printVerifyJson(options, change, status, null);
     else
         console.log(formatOnboarding(status));
     process.exitCode = onboardingExitCode(status);
@@ -997,7 +1043,7 @@ export async function preVerifyCommand(options) {
     if (options.wait !== false && briefOf(view) === null && !TERMINAL.has(reportedStatus(view)))
         view = await waitForBrief(view, identity, auth.token);
     const brief = briefOf(view);
-    // CAPTURE-V1 rule 7b: the routes the change touches, with their share of captured sessions; null without capture set up.
+    // CAPTURE-V1 rule 7b: the routes the change touches, with their share of captured sessions, per app; null without capture set up.
     const captured = await readPreVerifyCapture(findGitRoot(), identity.repository, auth.token, [...new Set([...(brief?.functions.map(fn => fn.file) ?? []), ...change.files])], new Date());
     if (options.json)
         finish(onboarding, view, captured);
@@ -1014,13 +1060,22 @@ export async function preVerifyCommand(options) {
                 : view.status === 'completed' ? 'It was checked before briefs existed and is not run again: change anything in the checkout and run `haystack pre-verify` again.'
                     : 'Run `haystack pre-verify` again to prepare it again.'));
     if (!options.json && captured !== null)
-        console.log(`\n${formatCapture(captured)}`);
+        for (const section of captured)
+            console.log(`\n${formatCapture(section)}`);
     if (brief === null && TERMINAL.has(reportedStatus(view)))
         process.exitCode = 2;
 }
+/** verify's one JSON document: the report (`--json`) or the service's whole record (`--raw`). */
+function printVerifyJson(options, change, onboarding, view) {
+    const document = options.raw
+        ? withSchema('verify-raw', { change, onboarding, crawl: view })
+        : withSchema('verify', { change, onboarding, crawl: view === null ? null : verifyReport(view) });
+    process.stdout.write(`${JSON.stringify(document, null, 2)}\n`);
+}
 export async function verifyCommand(options) {
+    const json = options.json || options.raw;
     // In --json mode stdout carries the one document; every other line goes to stderr.
-    const note = (line) => { if (options.json)
+    const note = (line) => { if (json)
         console.error(line);
     else
         console.log(line); };
@@ -1030,8 +1085,8 @@ export async function verifyCommand(options) {
     const change = checkedChange(request.baseCommit, request.workCommit);
     if (!request.crawl) {
         note(`Nothing to verify: this checkout has no changes against ${request.baseCommit.slice(0, 12)}.`);
-        if (options.json)
-            process.stdout.write(`${JSON.stringify(withSchema('verify', { change, onboarding: null, crawl: null }), null, 2)}\n`);
+        if (json)
+            printVerifyJson(options, change, null, null);
         return;
     }
     note(checkedLine(change));
@@ -1065,7 +1120,7 @@ export async function verifyCommand(options) {
                 reportOnboardingState(onboarding);
             }
             if (onboarding.state !== 'ready') {
-                finishWithOnboarding(onboarding, options.json, change);
+                finishWithOnboarding(onboarding, options, change);
                 return;
             }
             // Ready: the service admitted the waiting crawl when the record published; this
@@ -1075,8 +1130,8 @@ export async function verifyCommand(options) {
             note(submitted.line);
         }
         if (submitted.runId === null) {
-            if (options.json)
-                process.stdout.write(`${JSON.stringify(withSchema('verify', { change, onboarding, crawl: null }), null, 2)}\n`);
+            if (json)
+                printVerifyJson(options, change, onboarding, null);
             process.exitCode = 1;
             return;
         }
@@ -1089,8 +1144,8 @@ export async function verifyCommand(options) {
     if (options.wait !== false && !TERMINAL.has(reportedStatus(view))) {
         view = await waitForCrawl(view, identity, auth.token);
     }
-    if (options.json)
-        process.stdout.write(`${JSON.stringify(withSchema('verify', { change, onboarding, crawl: view }), null, 2)}\n`);
+    if (json)
+        printVerifyJson(options, change, onboarding, view);
     else {
         console.log(formatCrawl(view));
         const notes = [...(onboarding?.dataAbsences ?? []), ...(onboarding?.versionChoices ?? []), ...(onboarding?.standIns ?? []),