sentinelayer-cli 0.6.2 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +996 -996
- package/bin/create-sentinelayer.js +5 -5
- package/bin/sentinelayer-cli.js +4 -4
- package/bin/sl.js +5 -5
- package/package.json +64 -63
- package/src/agents/jules/config/definition.js +160 -160
- package/src/agents/jules/config/system-prompt.js +182 -182
- package/src/agents/jules/error-intake.js +51 -51
- package/src/agents/jules/fix-cycle.js +17 -17
- package/src/agents/jules/loop.js +457 -450
- package/src/agents/jules/pulse.js +10 -10
- package/src/agents/jules/stream.js +187 -186
- package/src/agents/jules/swarm/file-scanner.js +74 -74
- package/src/agents/jules/swarm/index.js +11 -11
- package/src/agents/jules/swarm/orchestrator.js +362 -362
- package/src/agents/jules/swarm/pattern-hunter.js +123 -123
- package/src/agents/jules/swarm/sub-agent.js +311 -309
- package/src/agents/jules/tools/aidenid-email.js +189 -189
- package/src/agents/jules/tools/auth-audit.js +1699 -1691
- package/src/agents/jules/tools/dispatch.js +340 -335
- package/src/agents/jules/tools/file-edit.js +2 -2
- package/src/agents/jules/tools/file-read.js +2 -2
- package/src/agents/jules/tools/frontend-analyze.js +570 -570
- package/src/agents/jules/tools/glob.js +2 -2
- package/src/agents/jules/tools/grep.js +2 -2
- package/src/agents/jules/tools/index.js +29 -29
- package/src/agents/jules/tools/path-guards.js +2 -2
- package/src/agents/jules/tools/runtime-audit.js +507 -507
- package/src/agents/jules/tools/shell.js +2 -2
- package/src/agents/jules/tools/url-policy.js +100 -100
- package/src/agents/persona-visuals.js +64 -61
- package/src/agents/shared-tools/dispatch-core.js +320 -315
- package/src/agents/shared-tools/file-edit.js +180 -180
- package/src/agents/shared-tools/file-read.js +100 -100
- package/src/agents/shared-tools/glob.js +168 -168
- package/src/agents/shared-tools/grep.js +228 -228
- package/src/agents/shared-tools/index.js +46 -46
- package/src/agents/shared-tools/path-guards.js +161 -161
- package/src/agents/shared-tools/shell.js +383 -383
- package/src/ai/aidenid.js +1021 -1009
- package/src/ai/client.js +553 -553
- package/src/ai/domain-target-store.js +268 -268
- package/src/ai/identity-store.js +270 -270
- package/src/ai/proxy.js +137 -137
- package/src/ai/site-store.js +145 -145
- package/src/audit/agents/architecture.js +180 -180
- package/src/audit/agents/compliance.js +179 -179
- package/src/audit/agents/documentation.js +165 -165
- package/src/audit/agents/performance.js +145 -145
- package/src/audit/agents/security.js +215 -215
- package/src/audit/agents/testing.js +172 -172
- package/src/audit/orchestrator.js +557 -557
- package/src/audit/package.js +204 -204
- package/src/audit/registry.js +284 -284
- package/src/audit/replay.js +103 -103
- package/src/auth/gate.js +400 -371
- package/src/auth/http.js +681 -611
- package/src/auth/service.js +1106 -1106
- package/src/auth/session-store.js +813 -813
- package/src/cli.js +257 -252
- package/src/commands/ai/identity-lifecycle.js +1338 -1338
- package/src/commands/ai/provision-governance.js +1272 -1272
- package/src/commands/ai/shared.js +147 -147
- package/src/commands/ai.js +11 -11
- package/src/commands/apply.js +12 -12
- package/src/commands/audit.js +1171 -1166
- package/src/commands/auth.js +419 -419
- package/src/commands/chat.js +191 -191
- package/src/commands/config.js +184 -184
- package/src/commands/cost.js +311 -311
- package/src/commands/daemon/core.js +850 -850
- package/src/commands/daemon/extended.js +1048 -1048
- package/src/commands/daemon/shared.js +213 -213
- package/src/commands/daemon.js +11 -11
- package/src/commands/guide.js +174 -174
- package/src/commands/ingest.js +58 -58
- package/src/commands/init.js +55 -55
- package/src/commands/legacy-args.js +10 -10
- package/src/commands/mcp.js +461 -461
- package/src/commands/omargate.js +29 -29
- package/src/commands/persona.js +20 -20
- package/src/commands/plugin.js +260 -260
- package/src/commands/policy.js +132 -132
- package/src/commands/prompt.js +238 -238
- package/src/commands/review.js +704 -704
- package/src/commands/scan.js +872 -872
- package/src/commands/session.js +590 -0
- package/src/commands/spec.js +778 -716
- package/src/commands/swarm.js +651 -651
- package/src/commands/telemetry.js +202 -202
- package/src/commands/watch.js +511 -511
- package/src/config/agent-dictionary.js +182 -182
- package/src/config/io.js +56 -56
- package/src/config/paths.js +18 -18
- package/src/config/schema.js +55 -55
- package/src/config/service.js +184 -184
- package/src/cost/budget.js +235 -235
- package/src/cost/history.js +188 -188
- package/src/cost/tracker.js +171 -171
- package/src/daemon/artifact-lineage.js +534 -534
- package/src/daemon/assignment-ledger.js +966 -770
- package/src/daemon/ast-parser-layer.js +258 -258
- package/src/daemon/budget-governor.js +633 -633
- package/src/daemon/callgraph-overlay.js +646 -646
- package/src/daemon/error-worker.js +1209 -626
- package/src/daemon/fix-cycle.js +384 -377
- package/src/daemon/hybrid-mapper.js +929 -929
- package/src/daemon/ingest-refresh.js +10 -9
- package/src/daemon/jira-lifecycle.js +767 -632
- package/src/daemon/operator-control.js +657 -657
- package/src/daemon/pulse.js +327 -327
- package/src/daemon/reliability-lane.js +471 -471
- package/src/daemon/scope-engine.js +1068 -0
- package/src/daemon/watchdog.js +971 -971
- package/src/events/schema.js +190 -0
- package/src/guide/generator.js +316 -316
- package/src/ingest/engine.js +918 -918
- package/src/interactive/index.js +97 -97
- package/src/legacy-cli.js +3161 -2994
- package/src/mcp/registry.js +695 -695
- package/src/memory/blackboard.js +301 -301
- package/src/memory/retrieval.js +581 -581
- package/src/plugin/manifest.js +553 -553
- package/src/policy/packs.js +144 -144
- package/src/prompt/generator.js +136 -118
- package/src/review/ai-review.js +679 -679
- package/src/review/local-review.js +1351 -1305
- package/src/review/omargate-interactive.js +68 -68
- package/src/review/omargate-orchestrator.js +404 -300
- package/src/review/persona-prompts.js +296 -296
- package/src/review/replay.js +235 -235
- package/src/review/report.js +664 -664
- package/src/review/scan-modes.js +48 -42
- package/src/review/spec-binding.js +487 -487
- package/src/scaffold/generator.js +67 -67
- package/src/scaffold/templates.js +150 -150
- package/src/scan/generator.js +418 -418
- package/src/scan/gh-secrets.js +107 -107
- package/src/session/agent-registry.js +352 -0
- package/src/session/daemon.js +801 -0
- package/src/session/paths.js +33 -0
- package/src/session/runtime-bridge.js +739 -0
- package/src/session/store.js +388 -0
- package/src/session/stream.js +325 -0
- package/src/spec/generator.js +619 -519
- package/src/spec/regenerate.js +237 -237
- package/src/spec/templates.js +91 -91
- package/src/swarm/dashboard.js +247 -247
- package/src/swarm/factory.js +363 -363
- package/src/swarm/pentest.js +934 -934
- package/src/swarm/registry.js +419 -419
- package/src/swarm/report.js +158 -158
- package/src/swarm/runtime.js +576 -576
- package/src/swarm/scenario-dsl.js +272 -272
- package/src/telemetry/ledger.js +302 -302
- package/src/telemetry/session-tracker.js +234 -234
- package/src/telemetry/sync.js +203 -203
- package/src/ui/command-hints.js +13 -13
- package/src/ui/markdown.js +220 -220
package/src/review/report.js
CHANGED
|
@@ -1,664 +1,664 @@
|
|
|
1
|
-
import { spawnSync } from "node:child_process";
|
|
2
|
-
import { createHash } from "node:crypto";
|
|
3
|
-
import fsp from "node:fs/promises";
|
|
4
|
-
import os from "node:os";
|
|
5
|
-
import path from "node:path";
|
|
6
|
-
|
|
7
|
-
import { resolveOutputRoot } from "../config/service.js";
|
|
8
|
-
|
|
9
|
-
const REVIEW_REPORT_JSON = "REVIEW_REPORT.json";
|
|
10
|
-
const REVIEW_REPORT_MD = "REVIEW_REPORT.md";
|
|
11
|
-
const REVIEW_DECISIONS_JSON = "REVIEW_DECISIONS.json";
|
|
12
|
-
|
|
13
|
-
const SEVERITY_RANK = Object.freeze({
|
|
14
|
-
P0: 0,
|
|
15
|
-
P1: 1,
|
|
16
|
-
P2: 2,
|
|
17
|
-
P3: 3,
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
function normalizeString(value) {
|
|
21
|
-
return String(value || "").trim();
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
function normalizeSeverity(value) {
|
|
25
|
-
const normalized = normalizeString(value).toUpperCase();
|
|
26
|
-
if (Object.prototype.hasOwnProperty.call(SEVERITY_RANK, normalized)) {
|
|
27
|
-
return normalized;
|
|
28
|
-
}
|
|
29
|
-
return "P3";
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
function toPosixPath(value) {
|
|
33
|
-
return String(value || "").replace(/\\/g, "/");
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
function runGit(cwd, args) {
|
|
37
|
-
const result = spawnSync("git", args, {
|
|
38
|
-
cwd,
|
|
39
|
-
encoding: "utf-8",
|
|
40
|
-
});
|
|
41
|
-
if (result.status !== 0) {
|
|
42
|
-
return "";
|
|
43
|
-
}
|
|
44
|
-
return normalizeString(result.stdout);
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
function runToolVersion(command, args = []) {
|
|
48
|
-
const result = spawnSync(command, args, {
|
|
49
|
-
encoding: "utf-8",
|
|
50
|
-
});
|
|
51
|
-
if (result.status !== 0) {
|
|
52
|
-
return "";
|
|
53
|
-
}
|
|
54
|
-
return normalizeString(result.stdout || result.stderr);
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
function formatConfidence(value) {
|
|
58
|
-
const normalized = Number(value);
|
|
59
|
-
if (!Number.isFinite(normalized)) {
|
|
60
|
-
return 0.6;
|
|
61
|
-
}
|
|
62
|
-
return Math.max(0, Math.min(1, normalized));
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
function dedupeKeyForFinding(finding = {}) {
|
|
66
|
-
const file = toPosixPath(normalizeString(finding.file) || "unknown");
|
|
67
|
-
const line = Number(finding.line || 1);
|
|
68
|
-
const message = normalizeString(finding.message).toLowerCase().replace(/\s+/g, " ");
|
|
69
|
-
return `${file}:${line}:${message}`;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
function compareFindingPriority(left, right) {
|
|
73
|
-
const leftSeverity = normalizeSeverity(left.severity);
|
|
74
|
-
const rightSeverity = normalizeSeverity(right.severity);
|
|
75
|
-
const severityDelta = SEVERITY_RANK[leftSeverity] - SEVERITY_RANK[rightSeverity];
|
|
76
|
-
if (severityDelta !== 0) {
|
|
77
|
-
return severityDelta;
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
const leftConfidence = formatConfidence(left.confidence);
|
|
81
|
-
const rightConfidence = formatConfidence(right.confidence);
|
|
82
|
-
if (leftConfidence > rightConfidence) {
|
|
83
|
-
return -1;
|
|
84
|
-
}
|
|
85
|
-
if (leftConfidence < rightConfidence) {
|
|
86
|
-
return 1;
|
|
87
|
-
}
|
|
88
|
-
return 0;
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
function summarizeFindings(findings = []) {
|
|
92
|
-
const summary = {
|
|
93
|
-
P0: 0,
|
|
94
|
-
P1: 0,
|
|
95
|
-
P2: 0,
|
|
96
|
-
P3: 0,
|
|
97
|
-
};
|
|
98
|
-
for (const finding of findings) {
|
|
99
|
-
summary[normalizeSeverity(finding.severity)] += 1;
|
|
100
|
-
}
|
|
101
|
-
return {
|
|
102
|
-
...summary,
|
|
103
|
-
blocking: summary.P0 > 0 || summary.P1 > 0,
|
|
104
|
-
};
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
export function reconcileReviewFindings({
|
|
108
|
-
deterministicFindings = [],
|
|
109
|
-
aiFindings = [],
|
|
110
|
-
} = {}) {
|
|
111
|
-
const merged = new Map();
|
|
112
|
-
|
|
113
|
-
const addFinding = (finding, source) => {
|
|
114
|
-
const normalized = {
|
|
115
|
-
findingId: "",
|
|
116
|
-
severity: normalizeSeverity(finding.severity),
|
|
117
|
-
file: toPosixPath(normalizeString(finding.file) || "unknown"),
|
|
118
|
-
line: Math.max(1, Math.floor(Number(finding.line || 1))),
|
|
119
|
-
message: normalizeString(finding.message) || "Unnamed finding",
|
|
120
|
-
excerpt: normalizeString(finding.excerpt),
|
|
121
|
-
ruleId: normalizeString(finding.ruleId),
|
|
122
|
-
suggestedFix: normalizeString(finding.suggestedFix),
|
|
123
|
-
layer: normalizeString(finding.layer),
|
|
124
|
-
confidence: source === "deterministic" ? 1 : formatConfidence(finding.confidence),
|
|
125
|
-
sources: [source],
|
|
126
|
-
adjudication: {
|
|
127
|
-
verdict: "pending",
|
|
128
|
-
note: "",
|
|
129
|
-
timestamp: "",
|
|
130
|
-
actor: "",
|
|
131
|
-
},
|
|
132
|
-
};
|
|
133
|
-
const key = dedupeKeyForFinding(normalized);
|
|
134
|
-
const existing = merged.get(key);
|
|
135
|
-
if (!existing) {
|
|
136
|
-
merged.set(key, normalized);
|
|
137
|
-
return;
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
const nextSources = new Set([...(existing.sources || []), source]);
|
|
141
|
-
const preferred = compareFindingPriority(existing, normalized) <= 0 ? existing : normalized;
|
|
142
|
-
preferred.sources = [...nextSources].sort((left, right) => left.localeCompare(right));
|
|
143
|
-
if (!preferred.excerpt) {
|
|
144
|
-
preferred.excerpt = existing.excerpt || normalized.excerpt;
|
|
145
|
-
}
|
|
146
|
-
if (!preferred.ruleId) {
|
|
147
|
-
preferred.ruleId = existing.ruleId || normalized.ruleId;
|
|
148
|
-
}
|
|
149
|
-
if (!preferred.suggestedFix) {
|
|
150
|
-
preferred.suggestedFix = existing.suggestedFix || normalized.suggestedFix;
|
|
151
|
-
}
|
|
152
|
-
merged.set(key, preferred);
|
|
153
|
-
};
|
|
154
|
-
|
|
155
|
-
for (const finding of deterministicFindings) {
|
|
156
|
-
addFinding(finding, "deterministic");
|
|
157
|
-
}
|
|
158
|
-
for (const finding of aiFindings) {
|
|
159
|
-
addFinding(finding, "ai");
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
const findings = [...merged.values()].sort((left, right) => {
|
|
163
|
-
const severityDelta = SEVERITY_RANK[left.severity] - SEVERITY_RANK[right.severity];
|
|
164
|
-
if (severityDelta !== 0) {
|
|
165
|
-
return severityDelta;
|
|
166
|
-
}
|
|
167
|
-
const fileDelta = left.file.localeCompare(right.file);
|
|
168
|
-
if (fileDelta !== 0) {
|
|
169
|
-
return fileDelta;
|
|
170
|
-
}
|
|
171
|
-
return left.line - right.line;
|
|
172
|
-
});
|
|
173
|
-
|
|
174
|
-
findings.forEach((finding, index) => {
|
|
175
|
-
finding.findingId = `F-${String(index + 1).padStart(3, "0")}`;
|
|
176
|
-
});
|
|
177
|
-
|
|
178
|
-
return {
|
|
179
|
-
findings,
|
|
180
|
-
summary: summarizeFindings(findings),
|
|
181
|
-
};
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
async function resolveSpecMetadata(targetPath, specFile = "") {
|
|
185
|
-
const explicitSpecFile = normalizeString(specFile);
|
|
186
|
-
const candidates = [];
|
|
187
|
-
if (explicitSpecFile) {
|
|
188
|
-
candidates.push(path.resolve(targetPath, explicitSpecFile));
|
|
189
|
-
}
|
|
190
|
-
candidates.push(path.join(targetPath, "SPEC.md"), path.join(targetPath, "docs", "spec.md"));
|
|
191
|
-
for (const candidate of candidates) {
|
|
192
|
-
try {
|
|
193
|
-
const text = await fsp.readFile(candidate, "utf-8");
|
|
194
|
-
const hash = createHash("sha256").update(text).digest("hex");
|
|
195
|
-
return {
|
|
196
|
-
path: candidate,
|
|
197
|
-
sha256: hash,
|
|
198
|
-
};
|
|
199
|
-
} catch {
|
|
200
|
-
continue;
|
|
201
|
-
}
|
|
202
|
-
}
|
|
203
|
-
return {
|
|
204
|
-
path: "",
|
|
205
|
-
sha256: "",
|
|
206
|
-
};
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
function buildSeverityMatrix() {
|
|
210
|
-
return {
|
|
211
|
-
P0: "blocks merge",
|
|
212
|
-
P1: "critical; fix before release",
|
|
213
|
-
P2: "warning; schedule remediation",
|
|
214
|
-
P3: "informational",
|
|
215
|
-
};
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
function buildSWEVerdictTemplate() {
|
|
219
|
-
return {
|
|
220
|
-
truthVerdict: "pending",
|
|
221
|
-
severityVerdict: "pending",
|
|
222
|
-
reproducibilityVerdict: "pending",
|
|
223
|
-
remediationUsefulnessScore: null,
|
|
224
|
-
};
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
function composeReportMarkdown(report = {}) {
|
|
228
|
-
const findingLines =
|
|
229
|
-
report.findings.length > 0
|
|
230
|
-
? report.findings
|
|
231
|
-
.map(
|
|
232
|
-
(finding, index) =>
|
|
233
|
-
`${index + 1}. [${finding.severity}] ${finding.findingId} ${finding.file}:${finding.line} ${finding.message}\n` +
|
|
234
|
-
` confidence: ${(formatConfidence(finding.confidence) * 100).toFixed(0)}%\n` +
|
|
235
|
-
` sources: ${(finding.sources || []).join(", ") || "none"}\n` +
|
|
236
|
-
` verdict: ${finding.adjudication?.verdict || "pending"}\n` +
|
|
237
|
-
` suggested_fix: ${finding.suggestedFix || "Review and remediate as needed."}`
|
|
238
|
-
)
|
|
239
|
-
.join("\n")
|
|
240
|
-
: "- none";
|
|
241
|
-
|
|
242
|
-
return [
|
|
243
|
-
"# REVIEW_REPORT",
|
|
244
|
-
"",
|
|
245
|
-
`Generated: ${report.generatedAt}`,
|
|
246
|
-
`Run ID: ${report.runId}`,
|
|
247
|
-
`Mode: ${report.mode}`,
|
|
248
|
-
"",
|
|
249
|
-
"Summary:",
|
|
250
|
-
`- Findings: P0=${report.summary.P0} P1=${report.summary.P1} P2=${report.summary.P2} P3=${report.summary.P3}`,
|
|
251
|
-
`- Blocking: ${report.summary.blocking ? "yes" : "no"}`,
|
|
252
|
-
`- Total findings: ${report.findings.length}`,
|
|
253
|
-
"",
|
|
254
|
-
"Metadata:",
|
|
255
|
-
`- commit_sha: ${report.metadata.git.commitSha || "unknown"}`,
|
|
256
|
-
`- branch: ${report.metadata.git.branch || "unknown"}`,
|
|
257
|
-
`- dirty: ${report.metadata.git.dirty ? "yes" : "no"}`,
|
|
258
|
-
`- spec_sha256: ${report.metadata.spec.sha256 || "unknown"}`,
|
|
259
|
-
`- model: ${report.metadata.ai.model || "none"}`,
|
|
260
|
-
`- provider: ${report.metadata.ai.provider || "none"}`,
|
|
261
|
-
`- temperature: ${report.metadata.ai.temperature === null ? "n/a" : report.metadata.ai.temperature}`,
|
|
262
|
-
`- node_version: ${report.metadata.tools.node}`,
|
|
263
|
-
"",
|
|
264
|
-
"Severity matrix:",
|
|
265
|
-
`- P0: ${report.severityMatrix.P0}`,
|
|
266
|
-
`- P1: ${report.severityMatrix.P1}`,
|
|
267
|
-
`- P2: ${report.severityMatrix.P2}`,
|
|
268
|
-
`- P3: ${report.severityMatrix.P3}`,
|
|
269
|
-
"",
|
|
270
|
-
"Findings:",
|
|
271
|
-
findingLines,
|
|
272
|
-
"",
|
|
273
|
-
].join("\n");
|
|
274
|
-
}
|
|
275
|
-
|
|
276
|
-
export async function buildUnifiedReviewReport({
|
|
277
|
-
targetPath,
|
|
278
|
-
mode,
|
|
279
|
-
runId,
|
|
280
|
-
deterministic,
|
|
281
|
-
aiLayer = null,
|
|
282
|
-
specFile = "",
|
|
283
|
-
} = {}) {
|
|
284
|
-
const normalizedTargetPath = path.resolve(String(targetPath || "."));
|
|
285
|
-
const normalizedMode = normalizeString(mode) || "full";
|
|
286
|
-
const normalizedRunId = normalizeString(runId) || "review-report";
|
|
287
|
-
const generatedAt = new Date().toISOString();
|
|
288
|
-
|
|
289
|
-
const reconciliation = reconcileReviewFindings({
|
|
290
|
-
deterministicFindings: deterministic?.findings || [],
|
|
291
|
-
aiFindings: aiLayer?.findings || [],
|
|
292
|
-
});
|
|
293
|
-
const spec = await resolveSpecMetadata(normalizedTargetPath, specFile);
|
|
294
|
-
const commitSha = runGit(normalizedTargetPath, ["rev-parse", "HEAD"]);
|
|
295
|
-
const branch = runGit(normalizedTargetPath, ["rev-parse", "--abbrev-ref", "HEAD"]);
|
|
296
|
-
const dirty = normalizeString(runGit(normalizedTargetPath, ["status", "--porcelain"])).length > 0;
|
|
297
|
-
|
|
298
|
-
const report = {
|
|
299
|
-
schemaVersion: "1.0.0",
|
|
300
|
-
generatedAt,
|
|
301
|
-
targetPath: normalizedTargetPath,
|
|
302
|
-
runId: normalizedRunId,
|
|
303
|
-
mode: normalizedMode,
|
|
304
|
-
summary: reconciliation.summary,
|
|
305
|
-
findings: reconciliation.findings,
|
|
306
|
-
severityMatrix: buildSeverityMatrix(),
|
|
307
|
-
metadata: {
|
|
308
|
-
git: {
|
|
309
|
-
commitSha,
|
|
310
|
-
branch,
|
|
311
|
-
dirty,
|
|
312
|
-
},
|
|
313
|
-
spec,
|
|
314
|
-
ai: {
|
|
315
|
-
provider: aiLayer?.provider || "",
|
|
316
|
-
model: aiLayer?.model || "",
|
|
317
|
-
temperature: null,
|
|
318
|
-
dryRun: Boolean(aiLayer?.dryRun),
|
|
319
|
-
},
|
|
320
|
-
tools: {
|
|
321
|
-
node: process.version,
|
|
322
|
-
npm: runToolVersion("npm", ["--version"]) || "unknown",
|
|
323
|
-
git: runToolVersion("git", ["--version"]) || "unknown",
|
|
324
|
-
platform: `${os.platform()}-${os.arch()}`,
|
|
325
|
-
},
|
|
326
|
-
sweFrameworkM2: buildSWEVerdictTemplate(),
|
|
327
|
-
timestamps: {
|
|
328
|
-
deterministicGeneratedAt: deterministic?.generatedAt || "",
|
|
329
|
-
aiGeneratedAt: aiLayer ? generatedAt : "",
|
|
330
|
-
},
|
|
331
|
-
},
|
|
332
|
-
};
|
|
333
|
-
|
|
334
|
-
return {
|
|
335
|
-
report,
|
|
336
|
-
markdown: composeReportMarkdown(report),
|
|
337
|
-
};
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
export async function writeUnifiedReviewArtifacts({
|
|
341
|
-
runDirectory,
|
|
342
|
-
report,
|
|
343
|
-
markdown,
|
|
344
|
-
} = {}) {
|
|
345
|
-
const normalizedRunDirectory = path.resolve(String(runDirectory || "."));
|
|
346
|
-
await fsp.mkdir(normalizedRunDirectory, { recursive: true });
|
|
347
|
-
const reportJsonPath = path.join(normalizedRunDirectory, REVIEW_REPORT_JSON);
|
|
348
|
-
const reportMarkdownPath = path.join(normalizedRunDirectory, REVIEW_REPORT_MD);
|
|
349
|
-
await fsp.writeFile(reportJsonPath, `${JSON.stringify(report, null, 2)}\n`, "utf-8");
|
|
350
|
-
await fsp.writeFile(reportMarkdownPath, `${String(markdown || "").trim()}\n`, "utf-8");
|
|
351
|
-
return {
|
|
352
|
-
reportJsonPath,
|
|
353
|
-
reportMarkdownPath,
|
|
354
|
-
};
|
|
355
|
-
}
|
|
356
|
-
|
|
357
|
-
async function resolveReviewsRoot({ targetPath, outputDir = "", env } = {}) {
|
|
358
|
-
const outputRoot = await resolveOutputRoot({
|
|
359
|
-
cwd: path.resolve(String(targetPath || ".")),
|
|
360
|
-
outputDirOverride: outputDir,
|
|
361
|
-
env,
|
|
362
|
-
});
|
|
363
|
-
return path.join(outputRoot, "reviews");
|
|
364
|
-
}
|
|
365
|
-
|
|
366
|
-
async function resolveRunDirectory({ targetPath, runId = "", outputDir = "", env } = {}) {
|
|
367
|
-
const reviewsRoot = await resolveReviewsRoot({ targetPath, outputDir, env });
|
|
368
|
-
const explicitRunId = normalizeString(runId);
|
|
369
|
-
if (explicitRunId) {
|
|
370
|
-
const explicitDirectory = path.join(reviewsRoot, explicitRunId);
|
|
371
|
-
await fsp.access(path.join(explicitDirectory, REVIEW_REPORT_JSON));
|
|
372
|
-
return explicitDirectory;
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
const entries = await fsp.readdir(reviewsRoot, { withFileTypes: true });
|
|
376
|
-
const candidates = entries
|
|
377
|
-
.filter((entry) => entry.isDirectory() && entry.name.startsWith("review-"))
|
|
378
|
-
.map((entry) => entry.name)
|
|
379
|
-
.sort((left, right) => right.localeCompare(left));
|
|
380
|
-
for (const candidate of candidates) {
|
|
381
|
-
const candidateDirectory = path.join(reviewsRoot, candidate);
|
|
382
|
-
try {
|
|
383
|
-
await fsp.access(path.join(candidateDirectory, REVIEW_REPORT_JSON));
|
|
384
|
-
return candidateDirectory;
|
|
385
|
-
} catch {
|
|
386
|
-
continue;
|
|
387
|
-
}
|
|
388
|
-
}
|
|
389
|
-
throw new Error("No review report found. Run `review` first.");
|
|
390
|
-
}
|
|
391
|
-
|
|
392
|
-
async function loadDecisions(decisionsPath) {
|
|
393
|
-
try {
|
|
394
|
-
const text = await fsp.readFile(decisionsPath, "utf-8");
|
|
395
|
-
const parsed = JSON.parse(text);
|
|
396
|
-
if (!parsed || typeof parsed !== "object" || typeof parsed.decisions !== "object") {
|
|
397
|
-
throw new Error("Invalid review decisions payload.");
|
|
398
|
-
}
|
|
399
|
-
return parsed;
|
|
400
|
-
} catch (error) {
|
|
401
|
-
if (error && typeof error === "object" && error.code === "ENOENT") {
|
|
402
|
-
return {
|
|
403
|
-
version: 1,
|
|
404
|
-
updatedAt: "",
|
|
405
|
-
decisions: {},
|
|
406
|
-
};
|
|
407
|
-
}
|
|
408
|
-
throw error;
|
|
409
|
-
}
|
|
410
|
-
}
|
|
411
|
-
|
|
412
|
-
function applyDecisionsToReport(report, decisions = {}) {
|
|
413
|
-
const next = JSON.parse(JSON.stringify(report));
|
|
414
|
-
for (const finding of next.findings || []) {
|
|
415
|
-
const decision = decisions[finding.findingId];
|
|
416
|
-
if (!decision) {
|
|
417
|
-
continue;
|
|
418
|
-
}
|
|
419
|
-
finding.adjudication = {
|
|
420
|
-
verdict: decision.verdict,
|
|
421
|
-
note: decision.note,
|
|
422
|
-
timestamp: decision.timestamp,
|
|
423
|
-
actor: decision.actor,
|
|
424
|
-
};
|
|
425
|
-
}
|
|
426
|
-
return next;
|
|
427
|
-
}
|
|
428
|
-
|
|
429
|
-
export async function loadUnifiedReviewReport({
|
|
430
|
-
targetPath,
|
|
431
|
-
runId = "",
|
|
432
|
-
outputDir = "",
|
|
433
|
-
env,
|
|
434
|
-
} = {}) {
|
|
435
|
-
const runDirectory = await resolveRunDirectory({ targetPath, runId, outputDir, env });
|
|
436
|
-
const reportJsonPath = path.join(runDirectory, REVIEW_REPORT_JSON);
|
|
437
|
-
const reportMarkdownPath = path.join(runDirectory, REVIEW_REPORT_MD);
|
|
438
|
-
const report = JSON.parse(await fsp.readFile(reportJsonPath, "utf-8"));
|
|
439
|
-
const decisionsPath = path.join(runDirectory, REVIEW_DECISIONS_JSON);
|
|
440
|
-
const decisions = await loadDecisions(decisionsPath);
|
|
441
|
-
const resolvedReport = applyDecisionsToReport(report, decisions.decisions);
|
|
442
|
-
return {
|
|
443
|
-
runDirectory,
|
|
444
|
-
reportJsonPath,
|
|
445
|
-
reportMarkdownPath,
|
|
446
|
-
decisionsPath,
|
|
447
|
-
decisions,
|
|
448
|
-
report: resolvedReport,
|
|
449
|
-
};
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
export async function recordReviewDecision({
|
|
453
|
-
targetPath,
|
|
454
|
-
runId = "",
|
|
455
|
-
outputDir = "",
|
|
456
|
-
findingId,
|
|
457
|
-
verdict,
|
|
458
|
-
note = "",
|
|
459
|
-
actor = "",
|
|
460
|
-
env,
|
|
461
|
-
} = {}) {
|
|
462
|
-
const normalizedVerdict = normalizeString(verdict).toLowerCase();
|
|
463
|
-
if (!["accept", "reject", "defer"].includes(normalizedVerdict)) {
|
|
464
|
-
throw new Error("verdict must be one of: accept, reject, defer.");
|
|
465
|
-
}
|
|
466
|
-
const normalizedFindingId = normalizeString(findingId);
|
|
467
|
-
if (!normalizedFindingId) {
|
|
468
|
-
throw new Error("findingId is required.");
|
|
469
|
-
}
|
|
470
|
-
|
|
471
|
-
const loaded = await loadUnifiedReviewReport({
|
|
472
|
-
targetPath,
|
|
473
|
-
runId,
|
|
474
|
-
outputDir,
|
|
475
|
-
env,
|
|
476
|
-
});
|
|
477
|
-
const finding = (loaded.report.findings || []).find((item) => item.findingId === normalizedFindingId);
|
|
478
|
-
if (!finding) {
|
|
479
|
-
throw new Error(`Finding '${normalizedFindingId}' not found in run ${loaded.report.runId}.`);
|
|
480
|
-
}
|
|
481
|
-
|
|
482
|
-
const decision = {
|
|
483
|
-
verdict: normalizedVerdict,
|
|
484
|
-
note: normalizeString(note),
|
|
485
|
-
timestamp: new Date().toISOString(),
|
|
486
|
-
actor: normalizeString(actor) || "operator",
|
|
487
|
-
};
|
|
488
|
-
const nextDecisions = {
|
|
489
|
-
version: 1,
|
|
490
|
-
updatedAt: decision.timestamp,
|
|
491
|
-
decisions: {
|
|
492
|
-
...(loaded.decisions.decisions || {}),
|
|
493
|
-
[normalizedFindingId]: decision,
|
|
494
|
-
},
|
|
495
|
-
};
|
|
496
|
-
await fsp.writeFile(loaded.decisionsPath, `${JSON.stringify(nextDecisions, null, 2)}\n`, "utf-8");
|
|
497
|
-
|
|
498
|
-
const nextReport = applyDecisionsToReport(loaded.report, nextDecisions.decisions);
|
|
499
|
-
const nextMarkdown = composeReportMarkdown(nextReport);
|
|
500
|
-
await fsp.writeFile(loaded.reportJsonPath, `${JSON.stringify(nextReport, null, 2)}\n`, "utf-8");
|
|
501
|
-
await fsp.writeFile(loaded.reportMarkdownPath, `${nextMarkdown.trim()}\n`, "utf-8");
|
|
502
|
-
|
|
503
|
-
return {
|
|
504
|
-
runId: nextReport.runId,
|
|
505
|
-
runDirectory: loaded.runDirectory,
|
|
506
|
-
findingId: normalizedFindingId,
|
|
507
|
-
decision,
|
|
508
|
-
reportJsonPath: loaded.reportJsonPath,
|
|
509
|
-
reportMarkdownPath: loaded.reportMarkdownPath,
|
|
510
|
-
decisionsPath: loaded.decisionsPath,
|
|
511
|
-
};
|
|
512
|
-
}
|
|
513
|
-
|
|
514
|
-
function normalizeExportFormat(format) {
|
|
515
|
-
const normalized = normalizeString(format).toLowerCase() || "md";
|
|
516
|
-
const allowed = ["sarif", "json", "md", "github-annotations"];
|
|
517
|
-
if (!allowed.includes(normalized)) {
|
|
518
|
-
throw new Error(`format must be one of: ${allowed.join(", ")}.`);
|
|
519
|
-
}
|
|
520
|
-
return normalized;
|
|
521
|
-
}
|
|
522
|
-
|
|
523
|
-
function mapSeverityToAnnotationLevel(severity) {
|
|
524
|
-
const normalized = normalizeSeverity(severity);
|
|
525
|
-
if (normalized === "P0" || normalized === "P1") {
|
|
526
|
-
return "error";
|
|
527
|
-
}
|
|
528
|
-
if (normalized === "P2") {
|
|
529
|
-
return "warning";
|
|
530
|
-
}
|
|
531
|
-
return "notice";
|
|
532
|
-
}
|
|
533
|
-
|
|
534
|
-
function buildSarif(report) {
|
|
535
|
-
const rules = [];
|
|
536
|
-
const seenRules = new Set();
|
|
537
|
-
const results = [];
|
|
538
|
-
|
|
539
|
-
for (const finding of report.findings || []) {
|
|
540
|
-
const ruleId = normalizeString(finding.ruleId) || finding.findingId;
|
|
541
|
-
if (!seenRules.has(ruleId)) {
|
|
542
|
-
rules.push({
|
|
543
|
-
id: ruleId,
|
|
544
|
-
name: finding.message,
|
|
545
|
-
shortDescription: {
|
|
546
|
-
text: finding.message,
|
|
547
|
-
},
|
|
548
|
-
});
|
|
549
|
-
seenRules.add(ruleId);
|
|
550
|
-
}
|
|
551
|
-
|
|
552
|
-
results.push({
|
|
553
|
-
ruleId,
|
|
554
|
-
level: mapSeverityToAnnotationLevel(finding.severity),
|
|
555
|
-
message: {
|
|
556
|
-
text: `[${finding.findingId}] ${finding.message}`,
|
|
557
|
-
},
|
|
558
|
-
locations: [
|
|
559
|
-
{
|
|
560
|
-
physicalLocation: {
|
|
561
|
-
artifactLocation: {
|
|
562
|
-
uri: finding.file,
|
|
563
|
-
},
|
|
564
|
-
region: {
|
|
565
|
-
startLine: finding.line,
|
|
566
|
-
},
|
|
567
|
-
},
|
|
568
|
-
},
|
|
569
|
-
],
|
|
570
|
-
properties: {
|
|
571
|
-
severity: finding.severity,
|
|
572
|
-
confidence: formatConfidence(finding.confidence),
|
|
573
|
-
verdict: finding.adjudication?.verdict || "pending",
|
|
574
|
-
},
|
|
575
|
-
});
|
|
576
|
-
}
|
|
577
|
-
|
|
578
|
-
return {
|
|
579
|
-
version: "2.1.0",
|
|
580
|
-
$schema: "https://json.schemastore.org/sarif-2.1.0.json",
|
|
581
|
-
runs: [
|
|
582
|
-
{
|
|
583
|
-
tool: {
|
|
584
|
-
driver: {
|
|
585
|
-
name: "sentinelayer-review",
|
|
586
|
-
informationUri: "https://github.com/mrrCarter/create-sentinelayer",
|
|
587
|
-
rules,
|
|
588
|
-
},
|
|
589
|
-
},
|
|
590
|
-
invocations: [
|
|
591
|
-
{
|
|
592
|
-
executionSuccessful: true,
|
|
593
|
-
startTimeUtc: report.generatedAt,
|
|
594
|
-
},
|
|
595
|
-
],
|
|
596
|
-
results,
|
|
597
|
-
},
|
|
598
|
-
],
|
|
599
|
-
};
|
|
600
|
-
}
|
|
601
|
-
|
|
602
|
-
function buildGithubAnnotations(report) {
|
|
603
|
-
return (report.findings || [])
|
|
604
|
-
.map((finding) => {
|
|
605
|
-
const level = mapSeverityToAnnotationLevel(finding.severity);
|
|
606
|
-
return `::${level} file=${finding.file},line=${finding.line}::[${finding.findingId}] ${finding.message}`;
|
|
607
|
-
})
|
|
608
|
-
.join("\n");
|
|
609
|
-
}
|
|
610
|
-
|
|
611
|
-
function resolveDefaultExportPath(runDirectory, format) {
|
|
612
|
-
if (format === "json") {
|
|
613
|
-
return path.join(runDirectory, REVIEW_REPORT_JSON);
|
|
614
|
-
}
|
|
615
|
-
if (format === "md") {
|
|
616
|
-
return path.join(runDirectory, REVIEW_REPORT_MD);
|
|
617
|
-
}
|
|
618
|
-
if (format === "sarif") {
|
|
619
|
-
return path.join(runDirectory, "REVIEW_REPORT.sarif.json");
|
|
620
|
-
}
|
|
621
|
-
return path.join(runDirectory, "REVIEW_REPORT.github-annotations.txt");
|
|
622
|
-
}
|
|
623
|
-
|
|
624
|
-
export async function exportUnifiedReviewReport({
|
|
625
|
-
targetPath,
|
|
626
|
-
runId = "",
|
|
627
|
-
outputDir = "",
|
|
628
|
-
format = "md",
|
|
629
|
-
outputFile = "",
|
|
630
|
-
env,
|
|
631
|
-
} = {}) {
|
|
632
|
-
const normalizedFormat = normalizeExportFormat(format);
|
|
633
|
-
const loaded = await loadUnifiedReviewReport({
|
|
634
|
-
targetPath,
|
|
635
|
-
runId,
|
|
636
|
-
outputDir,
|
|
637
|
-
env,
|
|
638
|
-
});
|
|
639
|
-
const resolvedOutputPath = normalizeString(outputFile)
|
|
640
|
-
? path.resolve(path.resolve(String(targetPath || ".")), outputFile)
|
|
641
|
-
: resolveDefaultExportPath(loaded.runDirectory, normalizedFormat);
|
|
642
|
-
|
|
643
|
-
let serialized = "";
|
|
644
|
-
if (normalizedFormat === "json") {
|
|
645
|
-
serialized = `${JSON.stringify(loaded.report, null, 2)}\n`;
|
|
646
|
-
} else if (normalizedFormat === "md") {
|
|
647
|
-
serialized = `${composeReportMarkdown(loaded.report).trim()}\n`;
|
|
648
|
-
} else if (normalizedFormat === "sarif") {
|
|
649
|
-
serialized = `${JSON.stringify(buildSarif(loaded.report), null, 2)}\n`;
|
|
650
|
-
} else {
|
|
651
|
-
serialized = `${buildGithubAnnotations(loaded.report)}\n`;
|
|
652
|
-
}
|
|
653
|
-
|
|
654
|
-
await fsp.mkdir(path.dirname(resolvedOutputPath), { recursive: true });
|
|
655
|
-
await fsp.writeFile(resolvedOutputPath, serialized, "utf-8");
|
|
656
|
-
|
|
657
|
-
return {
|
|
658
|
-
runId: loaded.report.runId,
|
|
659
|
-
runDirectory: loaded.runDirectory,
|
|
660
|
-
format: normalizedFormat,
|
|
661
|
-
outputPath: resolvedOutputPath,
|
|
662
|
-
};
|
|
663
|
-
}
|
|
664
|
-
|
|
1
|
+
import { spawnSync } from "node:child_process";
|
|
2
|
+
import { createHash } from "node:crypto";
|
|
3
|
+
import fsp from "node:fs/promises";
|
|
4
|
+
import os from "node:os";
|
|
5
|
+
import path from "node:path";
|
|
6
|
+
|
|
7
|
+
import { resolveOutputRoot } from "../config/service.js";
|
|
8
|
+
|
|
9
|
+
const REVIEW_REPORT_JSON = "REVIEW_REPORT.json";
|
|
10
|
+
const REVIEW_REPORT_MD = "REVIEW_REPORT.md";
|
|
11
|
+
const REVIEW_DECISIONS_JSON = "REVIEW_DECISIONS.json";
|
|
12
|
+
|
|
13
|
+
const SEVERITY_RANK = Object.freeze({
|
|
14
|
+
P0: 0,
|
|
15
|
+
P1: 1,
|
|
16
|
+
P2: 2,
|
|
17
|
+
P3: 3,
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
function normalizeString(value) {
|
|
21
|
+
return String(value || "").trim();
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
function normalizeSeverity(value) {
|
|
25
|
+
const normalized = normalizeString(value).toUpperCase();
|
|
26
|
+
if (Object.prototype.hasOwnProperty.call(SEVERITY_RANK, normalized)) {
|
|
27
|
+
return normalized;
|
|
28
|
+
}
|
|
29
|
+
return "P3";
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
function toPosixPath(value) {
|
|
33
|
+
return String(value || "").replace(/\\/g, "/");
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function runGit(cwd, args) {
|
|
37
|
+
const result = spawnSync("git", args, {
|
|
38
|
+
cwd,
|
|
39
|
+
encoding: "utf-8",
|
|
40
|
+
});
|
|
41
|
+
if (result.status !== 0) {
|
|
42
|
+
return "";
|
|
43
|
+
}
|
|
44
|
+
return normalizeString(result.stdout);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
function runToolVersion(command, args = []) {
|
|
48
|
+
const result = spawnSync(command, args, {
|
|
49
|
+
encoding: "utf-8",
|
|
50
|
+
});
|
|
51
|
+
if (result.status !== 0) {
|
|
52
|
+
return "";
|
|
53
|
+
}
|
|
54
|
+
return normalizeString(result.stdout || result.stderr);
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
function formatConfidence(value) {
|
|
58
|
+
const normalized = Number(value);
|
|
59
|
+
if (!Number.isFinite(normalized)) {
|
|
60
|
+
return 0.6;
|
|
61
|
+
}
|
|
62
|
+
return Math.max(0, Math.min(1, normalized));
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function dedupeKeyForFinding(finding = {}) {
|
|
66
|
+
const file = toPosixPath(normalizeString(finding.file) || "unknown");
|
|
67
|
+
const line = Number(finding.line || 1);
|
|
68
|
+
const message = normalizeString(finding.message).toLowerCase().replace(/\s+/g, " ");
|
|
69
|
+
return `${file}:${line}:${message}`;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
function compareFindingPriority(left, right) {
|
|
73
|
+
const leftSeverity = normalizeSeverity(left.severity);
|
|
74
|
+
const rightSeverity = normalizeSeverity(right.severity);
|
|
75
|
+
const severityDelta = SEVERITY_RANK[leftSeverity] - SEVERITY_RANK[rightSeverity];
|
|
76
|
+
if (severityDelta !== 0) {
|
|
77
|
+
return severityDelta;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
const leftConfidence = formatConfidence(left.confidence);
|
|
81
|
+
const rightConfidence = formatConfidence(right.confidence);
|
|
82
|
+
if (leftConfidence > rightConfidence) {
|
|
83
|
+
return -1;
|
|
84
|
+
}
|
|
85
|
+
if (leftConfidence < rightConfidence) {
|
|
86
|
+
return 1;
|
|
87
|
+
}
|
|
88
|
+
return 0;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
function summarizeFindings(findings = []) {
|
|
92
|
+
const summary = {
|
|
93
|
+
P0: 0,
|
|
94
|
+
P1: 0,
|
|
95
|
+
P2: 0,
|
|
96
|
+
P3: 0,
|
|
97
|
+
};
|
|
98
|
+
for (const finding of findings) {
|
|
99
|
+
summary[normalizeSeverity(finding.severity)] += 1;
|
|
100
|
+
}
|
|
101
|
+
return {
|
|
102
|
+
...summary,
|
|
103
|
+
blocking: summary.P0 > 0 || summary.P1 > 0,
|
|
104
|
+
};
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
export function reconcileReviewFindings({
|
|
108
|
+
deterministicFindings = [],
|
|
109
|
+
aiFindings = [],
|
|
110
|
+
} = {}) {
|
|
111
|
+
const merged = new Map();
|
|
112
|
+
|
|
113
|
+
const addFinding = (finding, source) => {
|
|
114
|
+
const normalized = {
|
|
115
|
+
findingId: "",
|
|
116
|
+
severity: normalizeSeverity(finding.severity),
|
|
117
|
+
file: toPosixPath(normalizeString(finding.file) || "unknown"),
|
|
118
|
+
line: Math.max(1, Math.floor(Number(finding.line || 1))),
|
|
119
|
+
message: normalizeString(finding.message) || "Unnamed finding",
|
|
120
|
+
excerpt: normalizeString(finding.excerpt),
|
|
121
|
+
ruleId: normalizeString(finding.ruleId),
|
|
122
|
+
suggestedFix: normalizeString(finding.suggestedFix),
|
|
123
|
+
layer: normalizeString(finding.layer),
|
|
124
|
+
confidence: source === "deterministic" ? 1 : formatConfidence(finding.confidence),
|
|
125
|
+
sources: [source],
|
|
126
|
+
adjudication: {
|
|
127
|
+
verdict: "pending",
|
|
128
|
+
note: "",
|
|
129
|
+
timestamp: "",
|
|
130
|
+
actor: "",
|
|
131
|
+
},
|
|
132
|
+
};
|
|
133
|
+
const key = dedupeKeyForFinding(normalized);
|
|
134
|
+
const existing = merged.get(key);
|
|
135
|
+
if (!existing) {
|
|
136
|
+
merged.set(key, normalized);
|
|
137
|
+
return;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
const nextSources = new Set([...(existing.sources || []), source]);
|
|
141
|
+
const preferred = compareFindingPriority(existing, normalized) <= 0 ? existing : normalized;
|
|
142
|
+
preferred.sources = [...nextSources].sort((left, right) => left.localeCompare(right));
|
|
143
|
+
if (!preferred.excerpt) {
|
|
144
|
+
preferred.excerpt = existing.excerpt || normalized.excerpt;
|
|
145
|
+
}
|
|
146
|
+
if (!preferred.ruleId) {
|
|
147
|
+
preferred.ruleId = existing.ruleId || normalized.ruleId;
|
|
148
|
+
}
|
|
149
|
+
if (!preferred.suggestedFix) {
|
|
150
|
+
preferred.suggestedFix = existing.suggestedFix || normalized.suggestedFix;
|
|
151
|
+
}
|
|
152
|
+
merged.set(key, preferred);
|
|
153
|
+
};
|
|
154
|
+
|
|
155
|
+
for (const finding of deterministicFindings) {
|
|
156
|
+
addFinding(finding, "deterministic");
|
|
157
|
+
}
|
|
158
|
+
for (const finding of aiFindings) {
|
|
159
|
+
addFinding(finding, "ai");
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
const findings = [...merged.values()].sort((left, right) => {
|
|
163
|
+
const severityDelta = SEVERITY_RANK[left.severity] - SEVERITY_RANK[right.severity];
|
|
164
|
+
if (severityDelta !== 0) {
|
|
165
|
+
return severityDelta;
|
|
166
|
+
}
|
|
167
|
+
const fileDelta = left.file.localeCompare(right.file);
|
|
168
|
+
if (fileDelta !== 0) {
|
|
169
|
+
return fileDelta;
|
|
170
|
+
}
|
|
171
|
+
return left.line - right.line;
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
findings.forEach((finding, index) => {
|
|
175
|
+
finding.findingId = `F-${String(index + 1).padStart(3, "0")}`;
|
|
176
|
+
});
|
|
177
|
+
|
|
178
|
+
return {
|
|
179
|
+
findings,
|
|
180
|
+
summary: summarizeFindings(findings),
|
|
181
|
+
};
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
async function resolveSpecMetadata(targetPath, specFile = "") {
|
|
185
|
+
const explicitSpecFile = normalizeString(specFile);
|
|
186
|
+
const candidates = [];
|
|
187
|
+
if (explicitSpecFile) {
|
|
188
|
+
candidates.push(path.resolve(targetPath, explicitSpecFile));
|
|
189
|
+
}
|
|
190
|
+
candidates.push(path.join(targetPath, "SPEC.md"), path.join(targetPath, "docs", "spec.md"));
|
|
191
|
+
for (const candidate of candidates) {
|
|
192
|
+
try {
|
|
193
|
+
const text = await fsp.readFile(candidate, "utf-8");
|
|
194
|
+
const hash = createHash("sha256").update(text).digest("hex");
|
|
195
|
+
return {
|
|
196
|
+
path: candidate,
|
|
197
|
+
sha256: hash,
|
|
198
|
+
};
|
|
199
|
+
} catch {
|
|
200
|
+
continue;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
return {
|
|
204
|
+
path: "",
|
|
205
|
+
sha256: "",
|
|
206
|
+
};
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
function buildSeverityMatrix() {
|
|
210
|
+
return {
|
|
211
|
+
P0: "blocks merge",
|
|
212
|
+
P1: "critical; fix before release",
|
|
213
|
+
P2: "warning; schedule remediation",
|
|
214
|
+
P3: "informational",
|
|
215
|
+
};
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
function buildSWEVerdictTemplate() {
|
|
219
|
+
return {
|
|
220
|
+
truthVerdict: "pending",
|
|
221
|
+
severityVerdict: "pending",
|
|
222
|
+
reproducibilityVerdict: "pending",
|
|
223
|
+
remediationUsefulnessScore: null,
|
|
224
|
+
};
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
function composeReportMarkdown(report = {}) {
|
|
228
|
+
const findingLines =
|
|
229
|
+
report.findings.length > 0
|
|
230
|
+
? report.findings
|
|
231
|
+
.map(
|
|
232
|
+
(finding, index) =>
|
|
233
|
+
`${index + 1}. [${finding.severity}] ${finding.findingId} ${finding.file}:${finding.line} ${finding.message}\n` +
|
|
234
|
+
` confidence: ${(formatConfidence(finding.confidence) * 100).toFixed(0)}%\n` +
|
|
235
|
+
` sources: ${(finding.sources || []).join(", ") || "none"}\n` +
|
|
236
|
+
` verdict: ${finding.adjudication?.verdict || "pending"}\n` +
|
|
237
|
+
` suggested_fix: ${finding.suggestedFix || "Review and remediate as needed."}`
|
|
238
|
+
)
|
|
239
|
+
.join("\n")
|
|
240
|
+
: "- none";
|
|
241
|
+
|
|
242
|
+
return [
|
|
243
|
+
"# REVIEW_REPORT",
|
|
244
|
+
"",
|
|
245
|
+
`Generated: ${report.generatedAt}`,
|
|
246
|
+
`Run ID: ${report.runId}`,
|
|
247
|
+
`Mode: ${report.mode}`,
|
|
248
|
+
"",
|
|
249
|
+
"Summary:",
|
|
250
|
+
`- Findings: P0=${report.summary.P0} P1=${report.summary.P1} P2=${report.summary.P2} P3=${report.summary.P3}`,
|
|
251
|
+
`- Blocking: ${report.summary.blocking ? "yes" : "no"}`,
|
|
252
|
+
`- Total findings: ${report.findings.length}`,
|
|
253
|
+
"",
|
|
254
|
+
"Metadata:",
|
|
255
|
+
`- commit_sha: ${report.metadata.git.commitSha || "unknown"}`,
|
|
256
|
+
`- branch: ${report.metadata.git.branch || "unknown"}`,
|
|
257
|
+
`- dirty: ${report.metadata.git.dirty ? "yes" : "no"}`,
|
|
258
|
+
`- spec_sha256: ${report.metadata.spec.sha256 || "unknown"}`,
|
|
259
|
+
`- model: ${report.metadata.ai.model || "none"}`,
|
|
260
|
+
`- provider: ${report.metadata.ai.provider || "none"}`,
|
|
261
|
+
`- temperature: ${report.metadata.ai.temperature === null ? "n/a" : report.metadata.ai.temperature}`,
|
|
262
|
+
`- node_version: ${report.metadata.tools.node}`,
|
|
263
|
+
"",
|
|
264
|
+
"Severity matrix:",
|
|
265
|
+
`- P0: ${report.severityMatrix.P0}`,
|
|
266
|
+
`- P1: ${report.severityMatrix.P1}`,
|
|
267
|
+
`- P2: ${report.severityMatrix.P2}`,
|
|
268
|
+
`- P3: ${report.severityMatrix.P3}`,
|
|
269
|
+
"",
|
|
270
|
+
"Findings:",
|
|
271
|
+
findingLines,
|
|
272
|
+
"",
|
|
273
|
+
].join("\n");
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
export async function buildUnifiedReviewReport({
|
|
277
|
+
targetPath,
|
|
278
|
+
mode,
|
|
279
|
+
runId,
|
|
280
|
+
deterministic,
|
|
281
|
+
aiLayer = null,
|
|
282
|
+
specFile = "",
|
|
283
|
+
} = {}) {
|
|
284
|
+
const normalizedTargetPath = path.resolve(String(targetPath || "."));
|
|
285
|
+
const normalizedMode = normalizeString(mode) || "full";
|
|
286
|
+
const normalizedRunId = normalizeString(runId) || "review-report";
|
|
287
|
+
const generatedAt = new Date().toISOString();
|
|
288
|
+
|
|
289
|
+
const reconciliation = reconcileReviewFindings({
|
|
290
|
+
deterministicFindings: deterministic?.findings || [],
|
|
291
|
+
aiFindings: aiLayer?.findings || [],
|
|
292
|
+
});
|
|
293
|
+
const spec = await resolveSpecMetadata(normalizedTargetPath, specFile);
|
|
294
|
+
const commitSha = runGit(normalizedTargetPath, ["rev-parse", "HEAD"]);
|
|
295
|
+
const branch = runGit(normalizedTargetPath, ["rev-parse", "--abbrev-ref", "HEAD"]);
|
|
296
|
+
const dirty = normalizeString(runGit(normalizedTargetPath, ["status", "--porcelain"])).length > 0;
|
|
297
|
+
|
|
298
|
+
const report = {
|
|
299
|
+
schemaVersion: "1.0.0",
|
|
300
|
+
generatedAt,
|
|
301
|
+
targetPath: normalizedTargetPath,
|
|
302
|
+
runId: normalizedRunId,
|
|
303
|
+
mode: normalizedMode,
|
|
304
|
+
summary: reconciliation.summary,
|
|
305
|
+
findings: reconciliation.findings,
|
|
306
|
+
severityMatrix: buildSeverityMatrix(),
|
|
307
|
+
metadata: {
|
|
308
|
+
git: {
|
|
309
|
+
commitSha,
|
|
310
|
+
branch,
|
|
311
|
+
dirty,
|
|
312
|
+
},
|
|
313
|
+
spec,
|
|
314
|
+
ai: {
|
|
315
|
+
provider: aiLayer?.provider || "",
|
|
316
|
+
model: aiLayer?.model || "",
|
|
317
|
+
temperature: null,
|
|
318
|
+
dryRun: Boolean(aiLayer?.dryRun),
|
|
319
|
+
},
|
|
320
|
+
tools: {
|
|
321
|
+
node: process.version,
|
|
322
|
+
npm: runToolVersion("npm", ["--version"]) || "unknown",
|
|
323
|
+
git: runToolVersion("git", ["--version"]) || "unknown",
|
|
324
|
+
platform: `${os.platform()}-${os.arch()}`,
|
|
325
|
+
},
|
|
326
|
+
sweFrameworkM2: buildSWEVerdictTemplate(),
|
|
327
|
+
timestamps: {
|
|
328
|
+
deterministicGeneratedAt: deterministic?.generatedAt || "",
|
|
329
|
+
aiGeneratedAt: aiLayer ? generatedAt : "",
|
|
330
|
+
},
|
|
331
|
+
},
|
|
332
|
+
};
|
|
333
|
+
|
|
334
|
+
return {
|
|
335
|
+
report,
|
|
336
|
+
markdown: composeReportMarkdown(report),
|
|
337
|
+
};
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
export async function writeUnifiedReviewArtifacts({
|
|
341
|
+
runDirectory,
|
|
342
|
+
report,
|
|
343
|
+
markdown,
|
|
344
|
+
} = {}) {
|
|
345
|
+
const normalizedRunDirectory = path.resolve(String(runDirectory || "."));
|
|
346
|
+
await fsp.mkdir(normalizedRunDirectory, { recursive: true });
|
|
347
|
+
const reportJsonPath = path.join(normalizedRunDirectory, REVIEW_REPORT_JSON);
|
|
348
|
+
const reportMarkdownPath = path.join(normalizedRunDirectory, REVIEW_REPORT_MD);
|
|
349
|
+
await fsp.writeFile(reportJsonPath, `${JSON.stringify(report, null, 2)}\n`, "utf-8");
|
|
350
|
+
await fsp.writeFile(reportMarkdownPath, `${String(markdown || "").trim()}\n`, "utf-8");
|
|
351
|
+
return {
|
|
352
|
+
reportJsonPath,
|
|
353
|
+
reportMarkdownPath,
|
|
354
|
+
};
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
async function resolveReviewsRoot({ targetPath, outputDir = "", env } = {}) {
|
|
358
|
+
const outputRoot = await resolveOutputRoot({
|
|
359
|
+
cwd: path.resolve(String(targetPath || ".")),
|
|
360
|
+
outputDirOverride: outputDir,
|
|
361
|
+
env,
|
|
362
|
+
});
|
|
363
|
+
return path.join(outputRoot, "reviews");
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
async function resolveRunDirectory({ targetPath, runId = "", outputDir = "", env } = {}) {
|
|
367
|
+
const reviewsRoot = await resolveReviewsRoot({ targetPath, outputDir, env });
|
|
368
|
+
const explicitRunId = normalizeString(runId);
|
|
369
|
+
if (explicitRunId) {
|
|
370
|
+
const explicitDirectory = path.join(reviewsRoot, explicitRunId);
|
|
371
|
+
await fsp.access(path.join(explicitDirectory, REVIEW_REPORT_JSON));
|
|
372
|
+
return explicitDirectory;
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
const entries = await fsp.readdir(reviewsRoot, { withFileTypes: true });
|
|
376
|
+
const candidates = entries
|
|
377
|
+
.filter((entry) => entry.isDirectory() && entry.name.startsWith("review-"))
|
|
378
|
+
.map((entry) => entry.name)
|
|
379
|
+
.sort((left, right) => right.localeCompare(left));
|
|
380
|
+
for (const candidate of candidates) {
|
|
381
|
+
const candidateDirectory = path.join(reviewsRoot, candidate);
|
|
382
|
+
try {
|
|
383
|
+
await fsp.access(path.join(candidateDirectory, REVIEW_REPORT_JSON));
|
|
384
|
+
return candidateDirectory;
|
|
385
|
+
} catch {
|
|
386
|
+
continue;
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
throw new Error("No review report found. Run `review` first.");
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
async function loadDecisions(decisionsPath) {
|
|
393
|
+
try {
|
|
394
|
+
const text = await fsp.readFile(decisionsPath, "utf-8");
|
|
395
|
+
const parsed = JSON.parse(text);
|
|
396
|
+
if (!parsed || typeof parsed !== "object" || typeof parsed.decisions !== "object") {
|
|
397
|
+
throw new Error("Invalid review decisions payload.");
|
|
398
|
+
}
|
|
399
|
+
return parsed;
|
|
400
|
+
} catch (error) {
|
|
401
|
+
if (error && typeof error === "object" && error.code === "ENOENT") {
|
|
402
|
+
return {
|
|
403
|
+
version: 1,
|
|
404
|
+
updatedAt: "",
|
|
405
|
+
decisions: {},
|
|
406
|
+
};
|
|
407
|
+
}
|
|
408
|
+
throw error;
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
function applyDecisionsToReport(report, decisions = {}) {
|
|
413
|
+
const next = JSON.parse(JSON.stringify(report));
|
|
414
|
+
for (const finding of next.findings || []) {
|
|
415
|
+
const decision = decisions[finding.findingId];
|
|
416
|
+
if (!decision) {
|
|
417
|
+
continue;
|
|
418
|
+
}
|
|
419
|
+
finding.adjudication = {
|
|
420
|
+
verdict: decision.verdict,
|
|
421
|
+
note: decision.note,
|
|
422
|
+
timestamp: decision.timestamp,
|
|
423
|
+
actor: decision.actor,
|
|
424
|
+
};
|
|
425
|
+
}
|
|
426
|
+
return next;
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
export async function loadUnifiedReviewReport({
|
|
430
|
+
targetPath,
|
|
431
|
+
runId = "",
|
|
432
|
+
outputDir = "",
|
|
433
|
+
env,
|
|
434
|
+
} = {}) {
|
|
435
|
+
const runDirectory = await resolveRunDirectory({ targetPath, runId, outputDir, env });
|
|
436
|
+
const reportJsonPath = path.join(runDirectory, REVIEW_REPORT_JSON);
|
|
437
|
+
const reportMarkdownPath = path.join(runDirectory, REVIEW_REPORT_MD);
|
|
438
|
+
const report = JSON.parse(await fsp.readFile(reportJsonPath, "utf-8"));
|
|
439
|
+
const decisionsPath = path.join(runDirectory, REVIEW_DECISIONS_JSON);
|
|
440
|
+
const decisions = await loadDecisions(decisionsPath);
|
|
441
|
+
const resolvedReport = applyDecisionsToReport(report, decisions.decisions);
|
|
442
|
+
return {
|
|
443
|
+
runDirectory,
|
|
444
|
+
reportJsonPath,
|
|
445
|
+
reportMarkdownPath,
|
|
446
|
+
decisionsPath,
|
|
447
|
+
decisions,
|
|
448
|
+
report: resolvedReport,
|
|
449
|
+
};
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
export async function recordReviewDecision({
|
|
453
|
+
targetPath,
|
|
454
|
+
runId = "",
|
|
455
|
+
outputDir = "",
|
|
456
|
+
findingId,
|
|
457
|
+
verdict,
|
|
458
|
+
note = "",
|
|
459
|
+
actor = "",
|
|
460
|
+
env,
|
|
461
|
+
} = {}) {
|
|
462
|
+
const normalizedVerdict = normalizeString(verdict).toLowerCase();
|
|
463
|
+
if (!["accept", "reject", "defer"].includes(normalizedVerdict)) {
|
|
464
|
+
throw new Error("verdict must be one of: accept, reject, defer.");
|
|
465
|
+
}
|
|
466
|
+
const normalizedFindingId = normalizeString(findingId);
|
|
467
|
+
if (!normalizedFindingId) {
|
|
468
|
+
throw new Error("findingId is required.");
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
const loaded = await loadUnifiedReviewReport({
|
|
472
|
+
targetPath,
|
|
473
|
+
runId,
|
|
474
|
+
outputDir,
|
|
475
|
+
env,
|
|
476
|
+
});
|
|
477
|
+
const finding = (loaded.report.findings || []).find((item) => item.findingId === normalizedFindingId);
|
|
478
|
+
if (!finding) {
|
|
479
|
+
throw new Error(`Finding '${normalizedFindingId}' not found in run ${loaded.report.runId}.`);
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
const decision = {
|
|
483
|
+
verdict: normalizedVerdict,
|
|
484
|
+
note: normalizeString(note),
|
|
485
|
+
timestamp: new Date().toISOString(),
|
|
486
|
+
actor: normalizeString(actor) || "operator",
|
|
487
|
+
};
|
|
488
|
+
const nextDecisions = {
|
|
489
|
+
version: 1,
|
|
490
|
+
updatedAt: decision.timestamp,
|
|
491
|
+
decisions: {
|
|
492
|
+
...(loaded.decisions.decisions || {}),
|
|
493
|
+
[normalizedFindingId]: decision,
|
|
494
|
+
},
|
|
495
|
+
};
|
|
496
|
+
await fsp.writeFile(loaded.decisionsPath, `${JSON.stringify(nextDecisions, null, 2)}\n`, "utf-8");
|
|
497
|
+
|
|
498
|
+
const nextReport = applyDecisionsToReport(loaded.report, nextDecisions.decisions);
|
|
499
|
+
const nextMarkdown = composeReportMarkdown(nextReport);
|
|
500
|
+
await fsp.writeFile(loaded.reportJsonPath, `${JSON.stringify(nextReport, null, 2)}\n`, "utf-8");
|
|
501
|
+
await fsp.writeFile(loaded.reportMarkdownPath, `${nextMarkdown.trim()}\n`, "utf-8");
|
|
502
|
+
|
|
503
|
+
return {
|
|
504
|
+
runId: nextReport.runId,
|
|
505
|
+
runDirectory: loaded.runDirectory,
|
|
506
|
+
findingId: normalizedFindingId,
|
|
507
|
+
decision,
|
|
508
|
+
reportJsonPath: loaded.reportJsonPath,
|
|
509
|
+
reportMarkdownPath: loaded.reportMarkdownPath,
|
|
510
|
+
decisionsPath: loaded.decisionsPath,
|
|
511
|
+
};
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
function normalizeExportFormat(format) {
|
|
515
|
+
const normalized = normalizeString(format).toLowerCase() || "md";
|
|
516
|
+
const allowed = ["sarif", "json", "md", "github-annotations"];
|
|
517
|
+
if (!allowed.includes(normalized)) {
|
|
518
|
+
throw new Error(`format must be one of: ${allowed.join(", ")}.`);
|
|
519
|
+
}
|
|
520
|
+
return normalized;
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
function mapSeverityToAnnotationLevel(severity) {
|
|
524
|
+
const normalized = normalizeSeverity(severity);
|
|
525
|
+
if (normalized === "P0" || normalized === "P1") {
|
|
526
|
+
return "error";
|
|
527
|
+
}
|
|
528
|
+
if (normalized === "P2") {
|
|
529
|
+
return "warning";
|
|
530
|
+
}
|
|
531
|
+
return "notice";
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
function buildSarif(report) {
|
|
535
|
+
const rules = [];
|
|
536
|
+
const seenRules = new Set();
|
|
537
|
+
const results = [];
|
|
538
|
+
|
|
539
|
+
for (const finding of report.findings || []) {
|
|
540
|
+
const ruleId = normalizeString(finding.ruleId) || finding.findingId;
|
|
541
|
+
if (!seenRules.has(ruleId)) {
|
|
542
|
+
rules.push({
|
|
543
|
+
id: ruleId,
|
|
544
|
+
name: finding.message,
|
|
545
|
+
shortDescription: {
|
|
546
|
+
text: finding.message,
|
|
547
|
+
},
|
|
548
|
+
});
|
|
549
|
+
seenRules.add(ruleId);
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
results.push({
|
|
553
|
+
ruleId,
|
|
554
|
+
level: mapSeverityToAnnotationLevel(finding.severity),
|
|
555
|
+
message: {
|
|
556
|
+
text: `[${finding.findingId}] ${finding.message}`,
|
|
557
|
+
},
|
|
558
|
+
locations: [
|
|
559
|
+
{
|
|
560
|
+
physicalLocation: {
|
|
561
|
+
artifactLocation: {
|
|
562
|
+
uri: finding.file,
|
|
563
|
+
},
|
|
564
|
+
region: {
|
|
565
|
+
startLine: finding.line,
|
|
566
|
+
},
|
|
567
|
+
},
|
|
568
|
+
},
|
|
569
|
+
],
|
|
570
|
+
properties: {
|
|
571
|
+
severity: finding.severity,
|
|
572
|
+
confidence: formatConfidence(finding.confidence),
|
|
573
|
+
verdict: finding.adjudication?.verdict || "pending",
|
|
574
|
+
},
|
|
575
|
+
});
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
return {
|
|
579
|
+
version: "2.1.0",
|
|
580
|
+
$schema: "https://json.schemastore.org/sarif-2.1.0.json",
|
|
581
|
+
runs: [
|
|
582
|
+
{
|
|
583
|
+
tool: {
|
|
584
|
+
driver: {
|
|
585
|
+
name: "sentinelayer-review",
|
|
586
|
+
informationUri: "https://github.com/mrrCarter/create-sentinelayer",
|
|
587
|
+
rules,
|
|
588
|
+
},
|
|
589
|
+
},
|
|
590
|
+
invocations: [
|
|
591
|
+
{
|
|
592
|
+
executionSuccessful: true,
|
|
593
|
+
startTimeUtc: report.generatedAt,
|
|
594
|
+
},
|
|
595
|
+
],
|
|
596
|
+
results,
|
|
597
|
+
},
|
|
598
|
+
],
|
|
599
|
+
};
|
|
600
|
+
}
|
|
601
|
+
|
|
602
|
+
function buildGithubAnnotations(report) {
|
|
603
|
+
return (report.findings || [])
|
|
604
|
+
.map((finding) => {
|
|
605
|
+
const level = mapSeverityToAnnotationLevel(finding.severity);
|
|
606
|
+
return `::${level} file=${finding.file},line=${finding.line}::[${finding.findingId}] ${finding.message}`;
|
|
607
|
+
})
|
|
608
|
+
.join("\n");
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
function resolveDefaultExportPath(runDirectory, format) {
|
|
612
|
+
if (format === "json") {
|
|
613
|
+
return path.join(runDirectory, REVIEW_REPORT_JSON);
|
|
614
|
+
}
|
|
615
|
+
if (format === "md") {
|
|
616
|
+
return path.join(runDirectory, REVIEW_REPORT_MD);
|
|
617
|
+
}
|
|
618
|
+
if (format === "sarif") {
|
|
619
|
+
return path.join(runDirectory, "REVIEW_REPORT.sarif.json");
|
|
620
|
+
}
|
|
621
|
+
return path.join(runDirectory, "REVIEW_REPORT.github-annotations.txt");
|
|
622
|
+
}
|
|
623
|
+
|
|
624
|
+
export async function exportUnifiedReviewReport({
|
|
625
|
+
targetPath,
|
|
626
|
+
runId = "",
|
|
627
|
+
outputDir = "",
|
|
628
|
+
format = "md",
|
|
629
|
+
outputFile = "",
|
|
630
|
+
env,
|
|
631
|
+
} = {}) {
|
|
632
|
+
const normalizedFormat = normalizeExportFormat(format);
|
|
633
|
+
const loaded = await loadUnifiedReviewReport({
|
|
634
|
+
targetPath,
|
|
635
|
+
runId,
|
|
636
|
+
outputDir,
|
|
637
|
+
env,
|
|
638
|
+
});
|
|
639
|
+
const resolvedOutputPath = normalizeString(outputFile)
|
|
640
|
+
? path.resolve(path.resolve(String(targetPath || ".")), outputFile)
|
|
641
|
+
: resolveDefaultExportPath(loaded.runDirectory, normalizedFormat);
|
|
642
|
+
|
|
643
|
+
let serialized = "";
|
|
644
|
+
if (normalizedFormat === "json") {
|
|
645
|
+
serialized = `${JSON.stringify(loaded.report, null, 2)}\n`;
|
|
646
|
+
} else if (normalizedFormat === "md") {
|
|
647
|
+
serialized = `${composeReportMarkdown(loaded.report).trim()}\n`;
|
|
648
|
+
} else if (normalizedFormat === "sarif") {
|
|
649
|
+
serialized = `${JSON.stringify(buildSarif(loaded.report), null, 2)}\n`;
|
|
650
|
+
} else {
|
|
651
|
+
serialized = `${buildGithubAnnotations(loaded.report)}\n`;
|
|
652
|
+
}
|
|
653
|
+
|
|
654
|
+
await fsp.mkdir(path.dirname(resolvedOutputPath), { recursive: true });
|
|
655
|
+
await fsp.writeFile(resolvedOutputPath, serialized, "utf-8");
|
|
656
|
+
|
|
657
|
+
return {
|
|
658
|
+
runId: loaded.report.runId,
|
|
659
|
+
runDirectory: loaded.runDirectory,
|
|
660
|
+
format: normalizedFormat,
|
|
661
|
+
outputPath: resolvedOutputPath,
|
|
662
|
+
};
|
|
663
|
+
}
|
|
664
|
+
|