mirror of
https://github.com/alibaba/open-code-review.git
synced 2026-08-02 21:14:52 +00:00
Some checks are pending
CI / test (push) Waiting to run
CI / cross-compile (amd64, darwin) (push) Waiting to run
CI / cross-compile (amd64, windows) (push) Waiting to run
CI / cross-compile (arm64, darwin) (push) Waiting to run
CI / cross-compile (arm64, linux) (push) Waiting to run
CI / cross-compile (arm64, windows) (push) Waiting to run
Add category/severity-aware, fail-open publication controls to the reusable GitHub Action: render a CLI-consistent `[category · severity]` badge on every comment, and add one opt-in routing destination that moves low-severity or selected-category findings from inline comments to the PR summary. No finding is ever silently dropped: unknown/malformed metadata on a finding never matches the policy (routes to its normal inline destination), and a malformed policy itself degrades to no-routing. A new `routed` accounting bucket is disjoint from summary/skipped/failed, so destination counts still sum to the raw input total. - buildBadge: byte-matches the CLI's buildBadge degeneration ([cat · sev] / [cat] / [sev] / ""), with control-char sanitization that is intentionally stricter than the CLI (strips \t/\n to defend Markdown layout). - buildPolicy / routeComment: pure fail-open policy decision. A finding matches when its severity is at-or-below the threshold OR its category is in the list; unknown metadata never matches. - Partition loop: routing is a placement decision (route OUT of reviewComments), so routed findings never enter any createReview write path (no double-post on retry) and carry no idempotency id. - Accounting: new comments_routed output and summary bullet; render order is counts -> no-line -> routed -> failed. - action.yml: opt-in route_severity_below and route_categories string inputs (empty defaults = today's behavior) plus the comments_routed output. With no routing input set, behavior is byte-equivalent to today except for the additive badge prefix on comments that carry category/severity metadata.
2129 lines
100 KiB
JavaScript
2129 lines
100 KiB
JavaScript
#!/usr/bin/env node
|
||
"use strict";
|
||
|
||
// Unit tests for scripts/github-actions/post-review-comments.js.
|
||
//
|
||
// Run via: node scripts/github-actions/post-review-comments.test.js
|
||
// (also wired as `npm run test:github-actions`).
|
||
//
|
||
// These tests drive runPostReviewComments directly with an injected mock
|
||
// github/core/fs, replacing the previous approach of regex-extracting the
|
||
// inline script from workflow YAML.
|
||
|
||
const assert = require("assert");
|
||
const path = require("path");
|
||
const { runPostReviewComments, safeFence, fencedBlock, lineSpan, sameCommentSpan, overlapsHistory, resolveThreshold, DEFAULT_OVERLAP_THRESHOLD, newCommentId, getPostedCommentIds, computeRetryDelayMs, formatWarnings, resolveBatchSize, sortToSendDeterministically, chunkArray, buildRunTags, DEFAULT_BATCH_SIZE, buildBadge, sanitizeMetadata, buildPolicy, routeComment, formatComment, formatCommentMarkdown, NO_ROUTING, CATEGORIES, SEVERITIES, SEVERITY_RANK } = require(path.join(__dirname, "post-review-comments.js"));
|
||
|
||
// REVIEW_TAG as the production code builds it for this test's hardcoded run
|
||
// identity (context.runId=undefined -> 0, runAttempt=undefined -> 1). Used as
|
||
// the primary discriminator between batch createReview calls (body ===
|
||
// REVIEW_TAG) and per-comment fallback calls (body === ""). Reconstructed via
|
||
// the exported buildRunTags rather than hardcoded so it tracks any future tag
|
||
// format change. `length > 1` is NOT a safe discriminator once N=1 batches
|
||
// exist (a single-comment batch collides with the per-comment shape).
|
||
const REVIEW_TAG = buildRunTags(undefined, undefined).REVIEW_TAG;
|
||
|
||
// Make all retry/pacing delays effectively zero so tests run fast.
|
||
// computeRetryDelayMs reads OCR_RETRY_MAX_DELAY / OCR_RETRY_BASE_DELAY via
|
||
// parseNonNegInt; "1" keeps the cap/base at 1ms so any transient/rate-limit
|
||
// backoff sleep is effectively instant.
|
||
process.env.OCR_MAX_RETRIES = "0";
|
||
process.env.OCR_SUCCESS_DELAY = "0";
|
||
process.env.OCR_FAILURE_DELAY = "0";
|
||
process.env.OCR_LOW_REMAINING_SPACING = "0";
|
||
process.env.OCR_LOW_REMAINING_THRESHOLD = "0";
|
||
process.env.OCR_RETRY_MAX_DELAY = "1";
|
||
process.env.OCR_RETRY_BASE_DELAY = "1";
|
||
process.env.OCR_READ_SUCCESS_DELAY = "0";
|
||
process.env.OCR_READ_LOW_REMAINING_SPACING = "0";
|
||
|
||
const context = {
|
||
repo: { owner: "owner", repo: "repo" },
|
||
issue: { number: 123 },
|
||
eventName: "pull_request_target",
|
||
payload: { pull_request: { head: { sha: "head-sha" } } },
|
||
};
|
||
|
||
function mockFs(resultText, stderrText) {
|
||
return {
|
||
readFileSync(file) {
|
||
if (file === "/tmp/ocr-result.json") return resultText;
|
||
if (file === "/tmp/ocr-stderr.log") return stderrText;
|
||
throw new Error(`unexpected read: ${file}`);
|
||
},
|
||
};
|
||
}
|
||
|
||
function makeErr(message, status, headers) {
|
||
const e = new Error(message);
|
||
if (status != null) e.status = status;
|
||
if (headers) e.response = { headers };
|
||
return e;
|
||
}
|
||
|
||
// Identity key for a single inline review comment, used to drive per-comment
|
||
// error injection. Two comments on the same path but different lines get
|
||
// different keys, so one can fail (e.g. 422 line-unresolvable) while another on
|
||
// the same file succeeds. Mirrors the (path, line range) identity the bot uses
|
||
// for incremental dedup and the idempotency check.
|
||
function commentKey(rc) {
|
||
if (!rc) return "?";
|
||
return `${rc.path}|${rc.start_line != null ? rc.start_line : "-"}|${rc.line != null ? rc.line : "-"}`;
|
||
}
|
||
|
||
// Temporarily override env vars for a single (sync or async) test body, always
|
||
// restoring originals afterwards. Used for retry/quota tests that need a
|
||
// different OCR_MAX_RETRIES / OCR_LOW_REMAINING_THRESHOLD than the fast default.
|
||
async function withEnv(env, fn) {
|
||
const saved = {};
|
||
for (const k of Object.keys(env)) {
|
||
saved[k] = process.env[k];
|
||
process.env[k] = env[k];
|
||
}
|
||
try {
|
||
return await fn();
|
||
} finally {
|
||
for (const k of Object.keys(env)) {
|
||
if (saved[k] === undefined) delete process.env[k];
|
||
else process.env[k] = saved[k];
|
||
}
|
||
}
|
||
}
|
||
|
||
function makeGithub(opts = {}) {
|
||
const createReviewCalls = [];
|
||
const issueComments = [];
|
||
const updatedComments = [];
|
||
const listCommentsCalls = [];
|
||
const listReviewCommentsCalls = [];
|
||
const listReviewsCalls = [];
|
||
// Interleaved log of write operations (createReview / createComment /
|
||
// updateComment) in call order, so tests can assert positioning invariants
|
||
// such as "summary created before review" without timing the calls.
|
||
const ops = [];
|
||
// Per-comment attempt counter, keyed by commentKey, so perCommentError can be
|
||
// attempt-aware (e.g. "429 on attempt 0, succeed on attempt 1").
|
||
const perCommentAttempts = new Map();
|
||
|
||
function successRemaining() {
|
||
return opts.successRemaining != null ? String(opts.successRemaining) : "5000";
|
||
}
|
||
|
||
// Inline comment objects recorded in BATCH createReview calls only, so tests
|
||
// can simulate "this comment already landed on the server" without predicting
|
||
// the random IDs from newCommentId(). Under multi-batch (N < toSend.length)
|
||
// there are several batch calls (body === REVIEW_TAG), so this scans ALL batch
|
||
// calls — not just createReviewCalls[0]. Scoped to batch calls so batch-level
|
||
// landing (echoPosted) stays disjoint from per-comment landing (landedKeys,
|
||
// which reads per-comment calls with body === "").
|
||
function batchPostedComments() {
|
||
const out = [];
|
||
for (const call of createReviewCalls) {
|
||
if ((call.body || "") !== REVIEW_TAG) continue;
|
||
for (const c of call.comments || []) {
|
||
const m = /<!--\s*(ocr-\d+-\d+-[a-f0-9]+)\s*-->/.exec(c.body || "");
|
||
if (m) {
|
||
out.push({
|
||
path: c.path,
|
||
body: c.body,
|
||
side: c.side || "RIGHT",
|
||
start_line: c.start_line,
|
||
line: c.line,
|
||
});
|
||
}
|
||
}
|
||
}
|
||
return out;
|
||
}
|
||
|
||
// Count of batch createReview calls issued so far (body === REVIEW_TAG), so a
|
||
// per-batch-index error spec can target e.g. "fail batch #2 but not #1".
|
||
function batchCallCount() {
|
||
let n = 0;
|
||
for (const call of createReviewCalls) {
|
||
if ((call.body || "") === REVIEW_TAG) n++;
|
||
}
|
||
return n;
|
||
}
|
||
|
||
return {
|
||
createReviewCalls,
|
||
issueComments,
|
||
updatedComments,
|
||
listCommentsCalls,
|
||
listReviewCommentsCalls,
|
||
listReviewsCalls,
|
||
ops,
|
||
rest: {
|
||
users: {
|
||
getAuthenticated: async () => ({ data: { login: "github-actions[bot]" } }),
|
||
},
|
||
pulls: {
|
||
get: async () => ({ data: { head: { sha: "head-sha" } } }),
|
||
createReview: async (params) => {
|
||
createReviewCalls.push(params);
|
||
ops.push({ type: "createReview", params });
|
||
const callIdx = createReviewCalls.length - 1;
|
||
const successRes = () => ({ data: {}, headers: { "x-ratelimit-remaining": successRemaining() } });
|
||
// Discriminate batch vs per-comment by body, NOT callIdx. Under
|
||
// multi-batch (N < toSend.length) several batch calls precede the
|
||
// per-comment fallbacks, so callIdx === 0 is unsound. Batch calls
|
||
// carry body === REVIEW_TAG; per-comment fallback calls use body === "".
|
||
// (comments.length > 1 is NOT a safe discriminator once N=1 batches
|
||
// exist — a single-comment batch collides with per-comment shape.)
|
||
const isBatch = (params.body || "") === REVIEW_TAG;
|
||
if (isBatch) {
|
||
const batchIdx = batchCallCount() - 1;
|
||
// Per-batch error spec takes precedence (lets a test fail batch #2
|
||
// but not #1); then the legacy bulkError/bulkErrorSpec apply to all
|
||
// batches uniformly.
|
||
if (typeof opts.batchErrorSpec === "function") {
|
||
const spec = opts.batchErrorSpec(batchIdx);
|
||
if (spec) throw makeErr(spec.message, spec.status, spec.headers);
|
||
} else if (Array.isArray(opts.batchErrorSpec)) {
|
||
const spec = opts.batchErrorSpec[batchIdx];
|
||
if (spec) throw makeErr(spec.message, spec.status, spec.headers);
|
||
}
|
||
if (opts.bulkErrorSpec) {
|
||
throw makeErr(opts.bulkErrorSpec.message, opts.bulkErrorSpec.status, opts.bulkErrorSpec.headers);
|
||
}
|
||
if (opts.bulkError) {
|
||
throw makeErr(opts.bulkError, opts.bulkErrorStatus, opts.bulkHeaders);
|
||
}
|
||
return successRes();
|
||
}
|
||
// Per-comment call. perCommentError(rc, attempt) lets a test fail some
|
||
// comments and not others (partial failure), and be attempt-aware
|
||
// (retry-then-succeed). Falls back to the legacy individualError
|
||
// (applies to all per-comment calls) for older tests.
|
||
if (typeof opts.perCommentError === "function") {
|
||
const rc = params.comments && params.comments[0];
|
||
const key = commentKey(rc);
|
||
const attempt = perCommentAttempts.get(key) || 0;
|
||
perCommentAttempts.set(key, attempt + 1);
|
||
const spec = opts.perCommentError(rc, attempt);
|
||
if (spec) throw makeErr(spec.message, spec.status, spec.headers);
|
||
return successRes();
|
||
}
|
||
if (opts.individualError) {
|
||
throw makeErr(opts.individualError, opts.individualErrorStatus, opts.individualHeaders);
|
||
}
|
||
return successRes();
|
||
},
|
||
listReviews: async (params) => {
|
||
listReviewsCalls.push(params);
|
||
// Consume a queued sequence of read errors (e.g. a transient 429 on
|
||
// the read itself) before falling through to the normal response, so
|
||
// withRetry's rate-limit backoff on reads can be exercised.
|
||
if (opts.listReviewsErrorSeq && opts.listReviewsErrorSeq.length) {
|
||
const spec = opts.listReviewsErrorSeq.shift();
|
||
throw makeErr(spec.message, spec.status, spec.headers);
|
||
}
|
||
if (opts.listReviewsThrow) {
|
||
throw makeErr("listReviews unavailable", 503);
|
||
}
|
||
// Simulate the batch review having landed on the server even though
|
||
// createReview threw: echo the batch call's body (which carries the
|
||
// REVIEW_TAG) as an existing review's body so findExistingBatchReview
|
||
// matches it.
|
||
if (opts.batchLanded && createReviewCalls[0]) {
|
||
return { data: [{ id: 999, body: createReviewCalls[0].body || "" }] };
|
||
}
|
||
return { data: opts.reviews || [] };
|
||
},
|
||
listReviewComments: async (params) => {
|
||
listReviewCommentsCalls.push(params);
|
||
if (opts.listReviewCommentsThrow) {
|
||
throw makeErr(opts.listReviewCommentsError || "read api unavailable", 503);
|
||
}
|
||
// Build the visible comment set from two disjoint, deduped sources:
|
||
// - echoPosted: comments carried by the BATCH call (index 0) that
|
||
// "already landed" — drives the batch-level getPostedCommentIds.
|
||
// - landedKeys: per-comment calls (index >= 1) that landed despite
|
||
// a 5xx/network error — drives per-comment isCommentAlreadyPosted.
|
||
// Deduping by embedded comment id keeps them composable.
|
||
if (opts.echoPosted || opts.landedKeys) {
|
||
const byId = new Map();
|
||
const add = (c) => {
|
||
const m = /<!--\s*(ocr-\d+-\d+-[a-f0-9]+)\s*-->/.exec(c.body || "");
|
||
const k = m ? m[1] : `${c.path}|${c.start_line != null ? c.start_line : "-"}|${c.line != null ? c.line : "-"}|${c.body}`;
|
||
if (!byId.has(k)) byId.set(k, c);
|
||
};
|
||
if (opts.echoPosted) {
|
||
const posted = batchPostedComments();
|
||
const n = opts.postedCount != null ? opts.postedCount : posted.length;
|
||
for (const c of posted.slice(0, n)) add(c);
|
||
}
|
||
if (opts.landedKeys) {
|
||
for (let i = 1; i < createReviewCalls.length; i++) {
|
||
const rc = createReviewCalls[i].comments && createReviewCalls[i].comments[0];
|
||
if (rc && opts.landedKeys.has(commentKey(rc))) {
|
||
add({ path: rc.path, body: rc.body, side: rc.side || "RIGHT", start_line: rc.start_line, line: rc.line });
|
||
}
|
||
}
|
||
}
|
||
return { data: [...byId.values()] };
|
||
}
|
||
return { data: opts.history || [] };
|
||
},
|
||
},
|
||
issues: {
|
||
listComments: async (params) => {
|
||
listCommentsCalls.push(params);
|
||
return { data: opts.existingSummary || [] };
|
||
},
|
||
createComment: async (params) => {
|
||
issueComments.push(params);
|
||
ops.push({ type: "createComment", params });
|
||
return { data: { id: 1000 + issueComments.length, html_url: `http://ex/c${issueComments.length}` } };
|
||
},
|
||
updateComment: async (params) => {
|
||
updatedComments.push(params);
|
||
ops.push({ type: "updateComment", params });
|
||
return { data: { id: params.comment_id, html_url: `http://ex/u${updatedComments.length}` } };
|
||
},
|
||
},
|
||
},
|
||
};
|
||
}
|
||
|
||
function mockCore() {
|
||
const outputs = {};
|
||
const logs = [];
|
||
return {
|
||
outputs,
|
||
logs,
|
||
setOutput(name, value) { outputs[name] = value; },
|
||
info(message) { logs.push(message); },
|
||
};
|
||
}
|
||
|
||
async function run({ result, stderr = "", opts = {}, githubOpts = {} }) {
|
||
const resultText = typeof result === "string" ? result : JSON.stringify(result);
|
||
const fs = mockFs(resultText, stderr);
|
||
const github = makeGithub(githubOpts);
|
||
const core = mockCore();
|
||
const options = Object.assign({ stickySummary: true, incremental: false }, opts);
|
||
await runPostReviewComments({
|
||
github,
|
||
context,
|
||
core,
|
||
fs,
|
||
resultPath: "/tmp/ocr-result.json",
|
||
stderrPath: "/tmp/ocr-stderr.log",
|
||
...options,
|
||
});
|
||
return { github, core, outputs: core.outputs };
|
||
}
|
||
|
||
// ---- Test cases (mirror PLAN §7) ----
|
||
|
||
async function testFailedInlineCommentsAreSummarized() {
|
||
const result = {
|
||
comments: [
|
||
{
|
||
path: "docs/no-line.md",
|
||
content:
|
||
"No-line content with a fenced block:\n\n```js\nconsole.log('still visible');\n```",
|
||
existing_code: "",
|
||
suggestion_code: "",
|
||
start_line: 0,
|
||
end_line: 0,
|
||
},
|
||
{
|
||
path: "src/app.js",
|
||
content: "Failed inline content must remain visible in the PR summary.",
|
||
existing_code: "oldCall();",
|
||
suggestion_code: "newCall();",
|
||
start_line: 10,
|
||
end_line: 10,
|
||
},
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: 'Unprocessable Entity: "Line could not be resolved"',
|
||
individualError: 'Unprocessable Entity: "Line could not be resolved"',
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
assert.strictEqual(github.createReviewCalls.length, 2, "bulk + one per-comment attempt");
|
||
assert.strictEqual(github.issueComments.length, 1, "summary anchor created (no existing)");
|
||
assert.strictEqual(github.updatedComments.length, 1, "anchor finalized with the full body");
|
||
const body = github.updatedComments[0].body;
|
||
assert.match(body, /No-line content with a fenced block/);
|
||
assert.match(body, /Failed inline content must remain visible/);
|
||
assert.match(body, /Line could not be resolved/);
|
||
// The no-line comment now carries the same reason line as a posting failure.
|
||
assert.match(body, /GitHub could not post this as an inline comment: No line information provided/);
|
||
// Posting statistics are merged into the leading summary header (the trailing
|
||
// "📊 Posting Statistics" section is gone), so the merged stats must appear
|
||
// BEFORE the per-comment renderings.
|
||
assert.doesNotMatch(body, /Inline comments shown in summary/);
|
||
assert.doesNotMatch(body, /📊 \*\*Posting Statistics:\*\*/);
|
||
const statsIdx = body.indexOf("❌ Failed to post inline");
|
||
const noLineIdx = body.indexOf("No-line content with a fenced block");
|
||
const failedIdx = body.indexOf("Failed inline content must remain visible");
|
||
assert.ok(statsIdx !== -1, "merged stats present in the header");
|
||
assert.ok(statsIdx < noLineIdx, "merged stats rendered before no-line comment");
|
||
assert.ok(statsIdx < failedIdx, "merged stats rendered before failed comment");
|
||
}
|
||
|
||
async function testWarningsListedAfterSummaryComments() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "Inline comment content.", start_line: 1, end_line: 1 },
|
||
{ path: "docs/no-line.md", content: "No-line comment content.", start_line: 0, end_line: 0 },
|
||
],
|
||
warnings: [
|
||
"file too large to review fully",
|
||
{ file: "assets/logo.png", message: "skipped binary asset", type: "binary_asset" },
|
||
],
|
||
};
|
||
|
||
const { github } = await run({ result, opts: { stickySummary: true } });
|
||
|
||
assert.strictEqual(github.updatedComments.length, 1, "anchor finalized with the full body");
|
||
const body = github.updatedComments[0].body;
|
||
// Both the count line and the detailed list must be present...
|
||
assert.match(body, /2 warning\(s\) occurred during review/);
|
||
assert.match(body, /⚠️ \*\*Warnings:\*\*/);
|
||
assert.match(body, /file too large to review fully/);
|
||
// Object warnings surface file, type, and message.
|
||
assert.match(body, /`assets\/logo\.png` \(`binary_asset`\): skipped binary asset/);
|
||
// ...and the list must come AFTER the non-inline (no-line) review comment.
|
||
const noLineIdx = body.indexOf("No-line comment content.");
|
||
const warningsIdx = body.indexOf("⚠️ **Warnings:**");
|
||
assert.ok(noLineIdx !== -1 && warningsIdx > noLineIdx, "warnings list placed after summary comments");
|
||
// The pre-review anchor body must also surface the warning contents.
|
||
assert.match(github.issueComments[0].body, /`assets\/logo\.png` \(`binary_asset`\): skipped binary asset/);
|
||
}
|
||
|
||
function testFormatWarnings() {
|
||
assert.strictEqual(formatWarnings([]), "");
|
||
assert.strictEqual(formatWarnings(null), "");
|
||
assert.strictEqual(formatWarnings(undefined), "");
|
||
// Plain string warnings.
|
||
assert.match(formatWarnings(["a", "b"]), /⚠️ \*\*Warnings:\*\*/);
|
||
assert.match(formatWarnings(["a", "b"]), /\n- a\n- b/);
|
||
// Object warnings surface file, type, and message together.
|
||
assert.match(
|
||
formatWarnings([{ file: "internal/llm/resolver.go", message: "context deadline exceeded", type: "subtask_error" }]),
|
||
/\n- `internal\/llm\/resolver\.go` \(`subtask_error`\): context deadline exceeded/
|
||
);
|
||
// Partial objects: only message.
|
||
assert.match(formatWarnings([{ message: "boom" }]), /\n- boom/);
|
||
// Partial objects: file + message, no type.
|
||
assert.match(formatWarnings([{ file: "a.go", message: "m" }]), /\n- `a\.go`: m/);
|
||
// Unknown object shapes degrade to a stable JSON stringification.
|
||
assert.match(formatWarnings([{ code: 42 }]), /\n- \{"code":42\}/);
|
||
}
|
||
|
||
async function testErrorCommentUsesSafeFence() {
|
||
const { github } = await run({
|
||
result: "not json",
|
||
stderr: "stderr includes a fence\n```js\nbroken();\n```",
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
assert.strictEqual(github.issueComments.length, 1);
|
||
const body = github.issueComments[0].body;
|
||
// stderr contains a 3-backtick fence, so safeFence must use 4 backticks.
|
||
assert.match(body, /\n````\nstderr includes a fence/);
|
||
}
|
||
|
||
async function testStickyUpdatesExistingSummary() {
|
||
const existing = [{ id: 42, body: "<!-- ocr-summary -->\nold summary", user: { login: "github-actions[bot]" } }];
|
||
const result = { comments: [{ path: "src/a.js", content: "x", start_line: 1, end_line: 1 }], warnings: [] };
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: { existingSummary: existing },
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
assert.strictEqual(github.updatedComments.length, 1, "existing summary updated");
|
||
assert.strictEqual(github.issueComments.length, 0, "no new comment created");
|
||
assert.strictEqual(github.updatedComments[0].comment_id, 42);
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
assert.strictEqual(outputs.comments_skipped, "0");
|
||
assert.strictEqual(outputs.summary_comment_url, "http://ex/u1");
|
||
}
|
||
|
||
// Non-sticky + batch fails (e.g. rate-limit) but the per-comment fallback then
|
||
// succeeds for every comment. The summary must still be posted as its own issue
|
||
// comment (the summary never rides in the review body anymore) and finalized
|
||
// with the success statistics.
|
||
async function testNonStickyFallbackAllSuccessStillPostsSummary() {
|
||
const result = { comments: [{ path: "src/a.js", content: "comment A", start_line: 1, end_line: 1 }], warnings: [] };
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
// Batch fails (rate-limit)...
|
||
bulkError: "rate limited",
|
||
bulkErrorStatus: 429,
|
||
// ...but the per-comment fallback succeeds (no individualError).
|
||
},
|
||
opts: { stickySummary: false },
|
||
});
|
||
|
||
// batch (call #1, failed) + one per-comment retry (call #2, succeeded).
|
||
assert.strictEqual(github.createReviewCalls.length, 2, "batch + per-comment fallback");
|
||
assert.strictEqual(github.issueComments.length, 1, "summary anchor posted as issue comment");
|
||
assert.strictEqual(github.updatedComments.length, 1, "anchor finalized with the success stats");
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
}
|
||
|
||
async function testNonStickyCreatesNewCommentOnFallback() {
|
||
const result = { comments: [{ path: "src/a.js", content: "Failed inline content.", start_line: 10, end_line: 10 }], warnings: [] };
|
||
|
||
const { github } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: 'Unprocessable Entity: "Line could not be resolved"',
|
||
individualError: 'Unprocessable Entity: "Line could not be resolved"',
|
||
},
|
||
opts: { stickySummary: false },
|
||
});
|
||
|
||
assert.strictEqual(github.issueComments.length, 1, "anchor summary comment created");
|
||
assert.strictEqual(github.updatedComments.length, 1, "anchor finalized with full body");
|
||
assert.match(github.updatedComments[0].body, /Failed inline content/);
|
||
}
|
||
|
||
async function testNoCommentsStickyUpdate() {
|
||
const existing = [{ id: 7, body: "<!-- ocr-summary -->\nold good", user: { login: "github-actions[bot]" } }];
|
||
const result = { comments: [], message: "All clear." };
|
||
|
||
const { github } = await run({
|
||
result,
|
||
githubOpts: { existingSummary: existing },
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
assert.strictEqual(github.updatedComments.length, 1);
|
||
assert.strictEqual(github.issueComments.length, 0);
|
||
assert.match(github.updatedComments[0].body, /All clear\./);
|
||
}
|
||
|
||
async function testIncrementalSkipsOverlapping() {
|
||
const history = [{ path: "src/a.js", line: 10, start_line: 10, side: "RIGHT", user: { login: "github-actions[bot]" } }];
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "overlap", start_line: 10, end_line: 10 },
|
||
{ path: "src/b.js", content: "new", start_line: 5, end_line: 5 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: { history },
|
||
opts: { stickySummary: true, incremental: true },
|
||
});
|
||
|
||
assert.strictEqual(github.createReviewCalls.length, 1, "one batch review");
|
||
const sent = github.createReviewCalls[0].comments;
|
||
assert.strictEqual(sent.length, 1, "only non-overlapping comment sent");
|
||
assert.strictEqual(sent[0].path, "src/b.js");
|
||
assert.strictEqual(outputs.comments_skipped, "1");
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
}
|
||
|
||
async function testIncrementalAllOverlapPostsNoReview() {
|
||
const history = [{ path: "src/a.js", line: 10, start_line: 10, side: "RIGHT", user: { login: "github-actions[bot]" } }];
|
||
const result = { comments: [{ path: "src/a.js", content: "overlap", start_line: 10, end_line: 10 }], warnings: [] };
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: { history },
|
||
opts: { stickySummary: true, incremental: true },
|
||
});
|
||
|
||
assert.strictEqual(github.createReviewCalls.length, 0, "no review posted");
|
||
assert.strictEqual(github.issueComments.length, 1, "summary anchor created");
|
||
assert.strictEqual(github.updatedComments.length, 1, "anchor finalized with status body");
|
||
assert.match(github.updatedComments[0].body, /nothing new was posted/);
|
||
assert.strictEqual(outputs.comments_skipped, "1");
|
||
assert.strictEqual(outputs.comments_inline, "0");
|
||
}
|
||
|
||
// Multi-line IoU dedup end-to-end at the default threshold (0.6). History
|
||
// covers [8,10]; of the three new multi-line comments, the identical span
|
||
// (IoU 1.0) is skipped while the low-IoU one (0.5) and a different file are
|
||
// posted. Also verifies a single-line comment is NOT suppressed by a prior
|
||
// multi-line block on an overlapping line.
|
||
async function testIncrementalMultiLineIoUDefaultThreshold() {
|
||
const history = [{ path: "src/a.js", line: 10, start_line: 8, side: "RIGHT", user: { login: "github-actions[bot]" } }];
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "identical", start_line: 8, end_line: 10 }, // IoU 1.0 -> skipped
|
||
{ path: "src/a.js", content: "low-iou", start_line: 9, end_line: 11 }, // IoU 0.5 -> posted
|
||
{ path: "src/a.js", content: "single", start_line: 9, end_line: 9 }, // single vs multi -> posted
|
||
{ path: "src/b.js", content: "new", start_line: 1, end_line: 3 }, // other file -> posted
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: { history },
|
||
opts: { stickySummary: true, incremental: true },
|
||
});
|
||
|
||
assert.strictEqual(github.createReviewCalls.length, 1, "one batch review");
|
||
const sent = github.createReviewCalls[0].comments;
|
||
assert.strictEqual(sent.length, 3, "identical multi-line span skipped, rest posted");
|
||
const aJsLow = sent.find((c) => c.path === "src/a.js" && c.start_line === 9 && c.line === 11);
|
||
const aJsSingle = sent.find((c) => c.path === "src/a.js" && c.line === 9 && c.start_line == null);
|
||
assert.ok(aJsLow, "low-IoU multi-line comment was posted");
|
||
assert.ok(aJsSingle, "single-line comment was not suppressed by multi-line history");
|
||
assert.strictEqual(outputs.comments_skipped, "1");
|
||
assert.strictEqual(outputs.comments_inline, "3");
|
||
}
|
||
|
||
// Threshold propagation: lowering incrementalOverlapThreshold to 0.4 makes the
|
||
// previously low-IoU span (0.5) now overlap, so it is skipped. Exercises the
|
||
// runPostReviewComments -> overlapsHistory wiring end-to-end.
|
||
async function testIncrementalOverlapThresholdPropagated() {
|
||
const history = [{ path: "src/a.js", line: 10, start_line: 8, side: "RIGHT", user: { login: "github-actions[bot]" } }];
|
||
const result = {
|
||
comments: [{ path: "src/a.js", content: "low-iou", start_line: 9, end_line: 11 }], // IoU 0.5
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: { history },
|
||
opts: { stickySummary: true, incremental: true, incrementalOverlapThreshold: 0.4 },
|
||
});
|
||
|
||
assert.strictEqual(github.createReviewCalls.length, 0, "no review posted (0.5 > 0.4 now overlaps)");
|
||
assert.strictEqual(outputs.comments_skipped, "1");
|
||
assert.strictEqual(outputs.comments_inline, "0");
|
||
}
|
||
|
||
// ---- Idempotency tests (prevent duplicate review posts on retry) ----
|
||
|
||
// Batch createReview fails with 5xx but the batch actually landed on the
|
||
// server. The retry must post ONLY the comments that are missing, not all of
|
||
// them (which would create duplicates).
|
||
async function testBatchLandedRetriesOnlyMissingComments() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "comment A", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "comment B", start_line: 2, end_line: 2 },
|
||
{ path: "src/c.js", content: "comment C", start_line: 3, end_line: 3 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
// Batch createReview fails with 5xx ...
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
// ... but the batch actually landed on the server (listReviews echoes
|
||
// the batch call's REVIEW_TAG-tagged body back as an existing review).
|
||
batchLanded: true,
|
||
// 2 of the 3 inline comments are already posted (echoed from the batch
|
||
// call's comment bodies via listReviewComments).
|
||
echoPosted: true,
|
||
postedCount: 2,
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// batch (call #1) + only the 1 missing comment retried (call #2). NOT 3
|
||
// per-comment calls -> no duplicates.
|
||
assert.strictEqual(github.createReviewCalls.length, 2, "batch + only the missing comment retried");
|
||
assert.strictEqual(github.createReviewCalls[1].comments.length, 1, "exactly one comment retried");
|
||
assert.strictEqual(github.createReviewCalls[1].comments[0].path, "src/c.js", "the missing comment is retried");
|
||
assert.strictEqual(outputs.comments_inline, "3", "2 already-posted + 1 retried = 3 successes");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
}
|
||
|
||
// Per-comment createReview fails with 5xx but the comment already landed on
|
||
// the server. It must be treated as a success (no retry, no duplicate).
|
||
async function testPerComment5xxAlreadyPostedTreatedAsSuccess() {
|
||
const result = { comments: [{ path: "src/a.js", content: "comment A", start_line: 1, end_line: 1 }], warnings: [] };
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
individualError: "Bad Gateway",
|
||
individualErrorStatus: 502,
|
||
// The comment is already on the server (echoed from the batch call's
|
||
// comment body via listReviewComments).
|
||
echoPosted: true,
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// batch (call #1) + one per-comment attempt (call #2) that 5xx'd. The
|
||
// idempotency check finds the comment already posted -> no retry.
|
||
assert.strictEqual(github.createReviewCalls.length, 2, "no retry after already-posted detection");
|
||
assert.strictEqual(outputs.comments_inline, "1", "already-posted counted as success");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
}
|
||
|
||
// Per-comment createReview fails with 5xx and the read API is unavailable, so
|
||
// the idempotency check cannot tell whether the comment landed. The retry must
|
||
// be SKIPPED (to avoid a duplicate) and the comment recorded as failed.
|
||
async function testPerComment5xxIdempotencyUnavailableSkipsRetry() {
|
||
const result = { comments: [{ path: "src/a.js", content: "comment A", start_line: 1, end_line: 1 }], warnings: [] };
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
individualError: "Bad Gateway",
|
||
individualErrorStatus: 502,
|
||
// Read API unavailable -> isCommentAlreadyPosted returns null (unknown).
|
||
listReviewCommentsThrow: true,
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// batch (call #1) + one per-comment attempt (call #2). No retry despite 5xx
|
||
// (unknown -> skip to avoid duplicate).
|
||
assert.strictEqual(github.createReviewCalls.length, 2, "no retry when idempotency check is unavailable");
|
||
assert.strictEqual(outputs.comments_failed, "1", "recorded as failed, not retried");
|
||
// The uncertainty is surfaced in the finalized summary.
|
||
assert.strictEqual(github.issueComments.length, 1, "anchor created");
|
||
assert.strictEqual(github.updatedComments.length, 1, "anchor finalized");
|
||
assert.match(github.updatedComments[0].body, /idempotency check unavailable/);
|
||
}
|
||
|
||
// A summary comment already exists (e.g. a previous attempt within the run
|
||
// posted it). The anchor phase must reuse it (no duplicate created) and the
|
||
// finalize phase must refresh it in place with the final body.
|
||
async function testSummaryDoesNotDuplicateWhenAlreadyPosted() {
|
||
// context.runId/runAttempt are unset -> RUN_TAG = "0-1" -> SUMMARY_TAG =
|
||
// "<!-- ocr-summary-run:0-1 -->". A real summary carries both the persistent
|
||
// SUMMARY_MARKER and the per-run SUMMARY_TAG.
|
||
const existing = [
|
||
{ id: 5, body: "<!-- ocr-summary -->\n<!-- ocr-summary-run:0-1 -->\nold summary", user: { login: "github-actions[bot]" } },
|
||
];
|
||
const result = { comments: [{ path: "src/a.js", content: "x", start_line: 1, end_line: 1 }], warnings: [] };
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: { existingSummary: existing },
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// Batch review posted normally; the existing summary is reused and refreshed,
|
||
// never duplicated.
|
||
assert.strictEqual(github.createReviewCalls.length, 1, "batch review posted");
|
||
assert.strictEqual(github.issueComments.length, 0, "no duplicate summary created");
|
||
assert.strictEqual(github.updatedComments.length, 1, "existing summary refreshed in place");
|
||
assert.strictEqual(github.updatedComments[0].comment_id, 5, "the existing comment is the one updated");
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
assert.strictEqual(outputs.summary_comment_url, "http://ex/u1");
|
||
assert.match(github.updatedComments[0].body, /Successfully posted inline: 1 comment/, "final body reflects the run outcome");
|
||
}
|
||
|
||
// Cold-start ordering: on the first review on a PR, the summary issue comment
|
||
// must be created BEFORE the batch review so its timeline position is above the
|
||
// review (GitHub orders issue comments oldest-first). It is then finalized
|
||
// (updated in place) after the review lands. This is the core fix for the
|
||
// "summary sandwiched between review blocks" defect on sticky PRs.
|
||
async function testSummaryAnchorCreatedBeforeReviewColdStart() {
|
||
const result = { comments: [{ path: "src/a.js", content: "x", start_line: 1, end_line: 1 }], warnings: [] };
|
||
|
||
const { github } = await run({
|
||
result,
|
||
githubOpts: { existingSummary: [] }, // cold start: no existing summary
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
const types = github.ops.map((o) => o.type);
|
||
const anchorIdx = types.indexOf("createComment");
|
||
const reviewIdx = types.indexOf("createReview");
|
||
const finalizeIdx = types.lastIndexOf("updateComment");
|
||
assert.notStrictEqual(anchorIdx, -1, "summary anchor created");
|
||
assert.notStrictEqual(reviewIdx, -1, "batch review posted");
|
||
assert.notStrictEqual(finalizeIdx, -1, "summary finalized");
|
||
assert.ok(anchorIdx < reviewIdx, "summary anchor created BEFORE the review (cold-start positioning)");
|
||
assert.ok(reviewIdx < finalizeIdx, "summary finalized AFTER the review");
|
||
// The anchor body is a pre-review placeholder; the final body carries stats.
|
||
assert.match(github.issueComments[0].body, /Posting review comments/);
|
||
assert.match(github.updatedComments[0].body, /Successfully posted inline: 1 comment/);
|
||
}
|
||
|
||
// Cold start + non-sticky: the per-run summary is also anchored before the
|
||
// review (non-sticky still creates a fresh comment each run, but within the run
|
||
// it must lead the review for a natural reading order).
|
||
async function testSummaryAnchorCreatedBeforeReviewNonSticky() {
|
||
const result = { comments: [{ path: "src/a.js", content: "x", start_line: 1, end_line: 1 }], warnings: [] };
|
||
|
||
const { github } = await run({
|
||
result,
|
||
githubOpts: { existingSummary: [] },
|
||
opts: { stickySummary: false },
|
||
});
|
||
|
||
const types = github.ops.map((o) => o.type);
|
||
assert.ok(types.indexOf("createComment") < types.indexOf("createReview"), "anchor before review");
|
||
assert.ok(types.indexOf("createReview") < types.lastIndexOf("updateComment"), "finalize after review");
|
||
}
|
||
|
||
function testNewCommentIdFormat() {
|
||
const id = newCommentId("12-3");
|
||
// Format: ocr-<runId>-<attempt>-<16 hex chars> (crypto.randomBytes(8)).
|
||
assert.match(id, /^ocr-12-3-[a-f0-9]{16}$/, "id format is ocr-<run>-<hex>");
|
||
// Random -> two calls produce distinct IDs (so two comments that share
|
||
// path/line/content still get different IDs and the check never mistakes
|
||
// one for the other).
|
||
assert.notStrictEqual(newCommentId("1-1"), newCommentId("1-1"), "IDs are random per call");
|
||
}
|
||
|
||
async function testGetPostedCommentIdsExtractsEmbeddedIds() {
|
||
const github = {
|
||
rest: {
|
||
pulls: {
|
||
listReviewComments: async () => ({
|
||
data: [
|
||
{ body: "<!-- ocr-0-1-aaaa0000bbbb1111 -->\ncontent a" },
|
||
{ body: "no id here" },
|
||
{ body: "<!-- ocr-0-1-cccc2222dddd3333 -->\ncontent c" },
|
||
// User content that mentions the bare id string must NOT match:
|
||
// the regex is anchored to <!-- ... --> wrappers, defending against
|
||
// false positives in the idempotency check.
|
||
{ body: "see ocr-0-1-aaaa0000bbbb1111 somewhere" },
|
||
],
|
||
headers: {},
|
||
}),
|
||
},
|
||
},
|
||
};
|
||
const ids = await getPostedCommentIds({ github, owner: "o", repo: "r", prNumber: 1, log: () => {} });
|
||
assert.strictEqual(ids.size, 2, "only IDs inside HTML comment wrappers are extracted");
|
||
assert.ok(ids.has("ocr-0-1-aaaa0000bbbb1111"));
|
||
assert.ok(ids.has("ocr-0-1-cccc2222dddd3333"));
|
||
assert.ok(!ids.has("ocr-0-1-zzzz0000"), "non-hex tokens do not match");
|
||
}
|
||
|
||
// ---- computeRetryDelayMs unit tests ----
|
||
//
|
||
// The rate-limit retry strategy is a pure function of the error (status +
|
||
// response headers) and attempt number. The integration tests below cap every
|
||
// delay to ~1ms via OCR_RETRY_MAX_DELAY=1, so they cannot assert that specific
|
||
// headers are honored; these unit tests pin down each branch of the strategy
|
||
// directly. They run under realistic cap/base values (overridden locally) so
|
||
// the returned delayMs is meaningful.
|
||
|
||
function testComputeRetryDelayMs() {
|
||
// Use realistic cap/base so delayMs reflects the strategy rather than the
|
||
// 1ms test-harness cap. Restored at the end.
|
||
const realCap = process.env.OCR_RETRY_MAX_DELAY;
|
||
const realBase = process.env.OCR_RETRY_BASE_DELAY;
|
||
process.env.OCR_RETRY_MAX_DELAY = "300000";
|
||
process.env.OCR_RETRY_BASE_DELAY = "60000";
|
||
try {
|
||
// Non-error / non-retryable -> null (no retry).
|
||
assert.strictEqual(computeRetryDelayMs(null, 0), null);
|
||
assert.strictEqual(computeRetryDelayMs(makeErr("validation", 422), 0), null);
|
||
|
||
// 429 honoring retry-after (seconds form): delay = secs * 1000.
|
||
let r = computeRetryDelayMs(makeErr("rate", 429, { "retry-after": "5" }), 0);
|
||
assert.strictEqual(r.source, "retry-after");
|
||
assert.strictEqual(r.delayMs, 5000);
|
||
|
||
// 429 honoring retry-after (HTTP-date form): source tagged accordingly,
|
||
// delay ~ the time until the given date.
|
||
const dateMs = Date.now() + 5000;
|
||
r = computeRetryDelayMs(makeErr("rate", 429, { "retry-after": new Date(dateMs).toUTCString() }), 0);
|
||
assert.strictEqual(r.source, "retry-after (HTTP-date)");
|
||
assert.ok(r.delayMs > 0 && r.delayMs <= 5000, "HTTP-date retry-after within 5s window");
|
||
|
||
// 429 with primary limit exhausted (remaining=0): wait until reset epoch.
|
||
const reset = Math.floor(Date.now() / 1000) + 10;
|
||
r = computeRetryDelayMs(makeErr("rate", 429, { "x-ratelimit-remaining": "0", "x-ratelimit-reset": String(reset) }), 0);
|
||
assert.strictEqual(r.source, "x-ratelimit-reset");
|
||
assert.strictEqual(r.delayMs, 10000);
|
||
|
||
// remaining > 0 must NOT trigger the reset branch even with a reset header.
|
||
r = computeRetryDelayMs(makeErr("rate", 429, { "x-ratelimit-remaining": "1", "x-ratelimit-reset": String(reset) }), 0);
|
||
assert.strictEqual(r.source, "exponential-backoff");
|
||
|
||
// 429 with no hint: exponential backoff, base*2^attempt + 0..999 jitter.
|
||
r = computeRetryDelayMs(makeErr("rate", 429), 0);
|
||
assert.strictEqual(r.source, "exponential-backoff");
|
||
assert.ok(r.delayMs >= 60000 && r.delayMs <= 60999, "attempt 0 backoff = 60000 + jitter");
|
||
r = computeRetryDelayMs(makeErr("rate", 429), 2);
|
||
assert.ok(r.delayMs >= 240000 && r.delayMs <= 240999, "attempt 2 backoff = 240000 + jitter");
|
||
|
||
// 403 is a rate-limit ONLY when the message mentions rate limit/abuse/secondary.
|
||
assert.ok(computeRetryDelayMs(makeErr("rate limit exceeded", 403), 0) != null, "403 + 'rate limit' retryable");
|
||
assert.ok(computeRetryDelayMs(makeErr("abuse detection", 403), 0) != null, "403 + 'abuse' retryable");
|
||
assert.ok(computeRetryDelayMs(makeErr("secondary rate", 403), 0) != null, "403 + 'secondary' retryable");
|
||
assert.strictEqual(computeRetryDelayMs(makeErr("forbidden", 403), 0), null, "plain 403 not retryable");
|
||
|
||
// 5xx transient: shorter base (2000ms) than rate-limit, grows with attempt.
|
||
r = computeRetryDelayMs(makeErr("Bad Gateway", 502), 0);
|
||
assert.strictEqual(r.source, "transient-backoff");
|
||
assert.ok(r.delayMs >= 2000 && r.delayMs <= 2999, "502 attempt 0 = 2000 + jitter");
|
||
// 408 timeout is also treated as transient.
|
||
assert.strictEqual(computeRetryDelayMs(makeErr("timeout", 408), 0).source, "transient-backoff");
|
||
|
||
// Cap: a huge retry-after is clamped to OCR_RETRY_MAX_DELAY.
|
||
r = computeRetryDelayMs(makeErr("rate", 429, { "retry-after": "1000000" }), 0);
|
||
assert.strictEqual(r.delayMs, 300000, "capped to 300000ms");
|
||
assert.match(r.detail, /CAPPED/, "capping is surfaced in detail");
|
||
} finally {
|
||
if (realCap === undefined) delete process.env.OCR_RETRY_MAX_DELAY;
|
||
else process.env.OCR_RETRY_MAX_DELAY = realCap;
|
||
if (realBase === undefined) delete process.env.OCR_RETRY_BASE_DELAY;
|
||
else process.env.OCR_RETRY_BASE_DELAY = realBase;
|
||
}
|
||
}
|
||
|
||
// ---- Cross-scenario integration tests ----
|
||
//
|
||
// rate-limit × partial-invalid-content × landed-on-server intersect on the
|
||
// per-comment fallback loop, where EACH comment can independently succeed,
|
||
// fail with a non-retryable 4xx, retry on 429, or be recovered (or not) via
|
||
// the idempotency check after a 5xx/network error. The mock's perCommentError
|
||
// (comment-keyed, attempt-aware) + landedKeys/echoPosted drive these.
|
||
|
||
// P0-1: batch rate-limit (429) triggers the per-comment fallback, where SOME
|
||
// comments succeed and SOME fail with 422 (invalid content, e.g. line gone).
|
||
// Verifies success/failed counts split correctly and ONLY the failed comment
|
||
// is surfaced in the summary (successful inline comments are not duplicated
|
||
// into the summary).
|
||
async function testBatchRateLimitWithPartialInvalidContent() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "valid A", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "invalid B (line gone)", start_line: 99, end_line: 99 },
|
||
{ path: "src/c.js", content: "valid C", start_line: 3, end_line: 3 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkErrorSpec: { message: "rate limited", status: 429, headers: { "retry-after": "1" } },
|
||
perCommentError: (rc) => {
|
||
// b.js is invalid (422); a.js and c.js succeed.
|
||
if (commentKey(rc) === "src/b.js|-|99") {
|
||
return { status: 422, message: 'Unprocessable Entity: "Line could not be resolved"' };
|
||
}
|
||
return null;
|
||
},
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// batch (429) + 3 per-comment calls (a ok, b 422, c ok).
|
||
assert.strictEqual(github.createReviewCalls.length, 4, "batch + 3 per-comment attempts");
|
||
assert.strictEqual(outputs.comments_inline, "2", "a and c posted");
|
||
assert.strictEqual(outputs.comments_failed, "1", "b failed (invalid content)");
|
||
// Fix B: a pure 429 never reached the server, so the idempotency reads must
|
||
// be skipped entirely (no listReviews / listReviewComments).
|
||
assert.strictEqual(github.listReviewsCalls.length, 0, "429 batch skips listReviews idempotency read");
|
||
assert.strictEqual(github.listReviewCommentsCalls.length, 0, "no per-comment idempotency reads (422 non-retryable, successes need none)");
|
||
// Summary surfaces ONLY the failed comment (in the finalized body).
|
||
assert.strictEqual(github.issueComments.length, 1, "anchor created");
|
||
assert.strictEqual(github.updatedComments.length, 1, "anchor finalized");
|
||
const body = github.updatedComments[0].body;
|
||
assert.match(body, /invalid B/, "failed comment content appears in summary");
|
||
assert.doesNotMatch(body, /valid A/, "successful comment not duplicated into summary");
|
||
assert.doesNotMatch(body, /valid C/, "successful comment not duplicated into summary");
|
||
}
|
||
|
||
// P0-2: per-comment rate-limit with retries. One comment recovers after a
|
||
// retry (429 then success); another stays rate-limited until retries are
|
||
// exhausted. Requires OCR_MAX_RETRIES >= 1 (overridden locally).
|
||
async function testPerCommentRateLimitRetryThenSuccessAndExhausted() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "recovers after retry", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "always rate limited", start_line: 2, end_line: 2 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
return withEnv({ OCR_MAX_RETRIES: "1" }, async () => {
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkErrorSpec: { message: "rate limited", status: 429 },
|
||
perCommentError: (rc, attempt) => {
|
||
if (commentKey(rc) === "src/a.js|-|1") {
|
||
// a.js: 429 on attempt 0, success on attempt 1.
|
||
return attempt === 0 ? { status: 429, message: "rate limited" } : null;
|
||
}
|
||
// b.js: always 429 -> retries exhausted -> failed.
|
||
return { status: 429, message: "rate limited" };
|
||
},
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// batch + a(2 attempts: 429 then ok) + b(2 attempts: 429, 429 exhausted).
|
||
assert.strictEqual(github.createReviewCalls.length, 5, "batch + a(2) + b(2)");
|
||
assert.strictEqual(outputs.comments_inline, "1", "a recovered via retry");
|
||
assert.strictEqual(outputs.comments_failed, "1", "b exhausted all retries");
|
||
});
|
||
}
|
||
|
||
// P0-3: batch 5xx but the batch LANDED on the server. The batch-level
|
||
// idempotency check finds some comments already posted; the MISSING ones are
|
||
// retried per-comment, where one fails with 422 (invalid content). Verifies
|
||
// batch-level dedup and per-comment failure compose without double-counting.
|
||
async function testBatchLandedWithPerCommentPartialInvalid() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "already landed A", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "already landed B", start_line: 2, end_line: 2 },
|
||
{ path: "src/c.js", content: "invalid C", start_line: 99, end_line: 99 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
batchLanded: true,
|
||
echoPosted: true,
|
||
postedCount: 2, // a and b already on the server
|
||
perCommentError: (rc) => {
|
||
if (commentKey(rc) === "src/c.js|-|99") {
|
||
return { status: 422, message: 'Unprocessable Entity: "Line could not be resolved"' };
|
||
}
|
||
return null;
|
||
},
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// batch (502, landed) + only the 1 missing comment (c) retried, which 422s.
|
||
assert.strictEqual(github.createReviewCalls.length, 2, "batch + only missing c retried");
|
||
assert.strictEqual(outputs.comments_inline, "2", "a,b recovered via batch-landing; c failed");
|
||
assert.strictEqual(outputs.comments_failed, "1", "c invalid content");
|
||
}
|
||
|
||
// P0-4: the full four-state mix under a landed batch. Combines batch-level
|
||
// landing with per-comment: success, 422-invalid, 5xx-landed (recovered via
|
||
// idempotency), and 5xx-NOT-landed (failed). This is the most entangled
|
||
// intersection of all three scenarios.
|
||
async function testBatchLandedWithPerCommentMixedStates() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "batch-landed A", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "success B", start_line: 2, end_line: 2 },
|
||
{ path: "src/c.js", content: "invalid C", start_line: 99, end_line: 99 },
|
||
{ path: "src/d.js", content: "5xx landed D", start_line: 4, end_line: 4 },
|
||
{ path: "src/e.js", content: "5xx not landed E", start_line: 5, end_line: 5 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const landedKeys = new Set(["src/d.js|-|4"]);
|
||
const { outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
batchLanded: true,
|
||
echoPosted: true,
|
||
postedCount: 1, // only a batch-landed
|
||
landedKeys, // d lands despite its per-comment 502
|
||
perCommentError: (rc) => {
|
||
const key = commentKey(rc);
|
||
if (key === "src/c.js|-|99") return { status: 422, message: "Line could not be resolved" };
|
||
if (key === "src/d.js|-|4") return { status: 502, message: "Bad Gateway" };
|
||
if (key === "src/e.js|-|5") return { status: 502, message: "Bad Gateway" };
|
||
return null; // b succeeds
|
||
},
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// a(batch-landed) + b(success) + d(5xx-landed) = 3 successes;
|
||
// c(422) + e(5xx-not-landed) = 2 failures.
|
||
assert.strictEqual(outputs.comments_inline, "3", "a+b+d succeed across three different recovery paths");
|
||
assert.strictEqual(outputs.comments_failed, "2", "c(422) + e(5xx not landed) fail");
|
||
}
|
||
|
||
// P1: a network-layer error (no HTTP status) is treated as "maybe reached the
|
||
// server", so the idempotency check runs. A comment that landed is recovered;
|
||
// one that did not is recorded as failed (no blind retry that would duplicate).
|
||
async function testNetworkErrorLandedRecoveredAndNotLandedFailed() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "net landed", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "net not landed", start_line: 2, end_line: 2 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const landedKeys = new Set(["src/a.js|-|1"]);
|
||
const { outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
landedKeys,
|
||
// status omitted -> typeof status !== "number" && status == null ->
|
||
// maybeReachedServer=true -> idempotency check decides.
|
||
perCommentError: () => ({ message: "ECONNRESET" }),
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
assert.strictEqual(outputs.comments_inline, "1", "a recovered (landed) via idempotency check");
|
||
assert.strictEqual(outputs.comments_failed, "1", "b not landed -> failed, no blind retry");
|
||
}
|
||
|
||
// P1: the batch-level idempotency check itself throws (listReviews
|
||
// unavailable). The code degrades to the original fallback (retry ALL
|
||
// comments, accepting duplicate risk) rather than aborting.
|
||
async function testBatchIdempotencyCheckFailureDegradesToFullRetry() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "A", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "B", start_line: 2, end_line: 2 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
listReviewsThrow: true, // findExistingBatchReview fails -> degrade
|
||
perCommentError: () => null, // all per-comment succeed
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// Degrade retries ALL (no filtering) -> batch + 2 per-comment.
|
||
assert.strictEqual(github.createReviewCalls.length, 3, "degraded to full retry of all comments");
|
||
assert.strictEqual(outputs.comments_inline, "2");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
}
|
||
|
||
// P1 (smoke): low remaining quota on a per-comment success triggers the
|
||
// proactive throttle branch. We cannot spy on the internal sleep, so this
|
||
// only verifies the branch executes without breaking the flow or counts.
|
||
async function testLowQuotaProactiveThrottleDoesNotBreakFlow() {
|
||
return withEnv({ OCR_LOW_REMAINING_THRESHOLD: "3" }, async () => {
|
||
const result = { comments: [{ path: "src/a.js", content: "A", start_line: 1, end_line: 1 }], warnings: [] };
|
||
const { outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "rate limited",
|
||
bulkErrorStatus: 429, // force the per-comment fallback path
|
||
successRemaining: 2, // <= threshold -> low-quota branch
|
||
perCommentError: () => null,
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
assert.strictEqual(outputs.comments_inline, "1", "low-quota throttle does not impede success");
|
||
});
|
||
}
|
||
|
||
// Fix B (focused): a pure rate-limit (429) on the batch means the request never
|
||
// reached the server, so the batch did not land. The idempotency reads
|
||
// (listReviews / listReviewComments) must be SKIPPED entirely — querying would
|
||
// be pointless and would pressure the API during an ongoing rate-limit episode.
|
||
// The batch rate-limit cooldown still runs before the per-comment retry.
|
||
async function testBatchRateLimitSkipsIdempotencyReads() {
|
||
const result = {
|
||
comments: [{ path: "src/a.js", content: "A", start_line: 1, end_line: 1 }],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkErrorSpec: { message: "rate limited", status: 429, headers: { "retry-after": "1" } },
|
||
perCommentError: () => null, // per-comment succeeds
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
assert.strictEqual(github.listReviewsCalls.length, 0, "listReviews not called (429 never reached server)");
|
||
assert.strictEqual(github.listReviewCommentsCalls.length, 0, "listReviewComments not called");
|
||
assert.strictEqual(github.createReviewCalls.length, 2, "batch + 1 per-comment");
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
}
|
||
|
||
// Fix A + read self-protection: a 5xx batch MAY have landed, so the idempotency
|
||
// read runs — but only AFTER cooling down. The read itself can also hit a
|
||
// rate-limit; withRetry (wrapping readWithPacing) must back off and recover so
|
||
// the batch-landing detection still works. Requires OCR_MAX_RETRIES >= 1.
|
||
async function testBatchReadRateLimitRetriedViaWithRetry() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "A", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "B", start_line: 2, end_line: 2 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
return withEnv({ OCR_MAX_RETRIES: "1" }, async () => {
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
bulkError: "Bad Gateway",
|
||
bulkErrorStatus: 502,
|
||
batchLanded: true,
|
||
echoPosted: true,
|
||
postedCount: 2, // both comments already on the server
|
||
// The idempotency read (listReviews) itself is rate-limited once, then
|
||
// succeeds: withRetry must honor retry-after and recover.
|
||
listReviewsErrorSeq: [
|
||
{ status: 429, message: "rate limited", headers: { "retry-after": "1" } },
|
||
],
|
||
},
|
||
opts: { stickySummary: true },
|
||
});
|
||
|
||
// listReviews: 1st call 429, 2nd call success -> read recovered via retry.
|
||
assert.strictEqual(github.listReviewsCalls.length, 2, "read retried after its own 429");
|
||
assert.strictEqual(outputs.comments_inline, "2", "both recovered as already-posted");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
assert.strictEqual(github.createReviewCalls.length, 1, "no per-comment retry (all already posted)");
|
||
});
|
||
}
|
||
|
||
// ---- Pure helper unit tests ----
|
||
|
||
function testSafeFenceAndFencedBlock() {
|
||
assert.strictEqual(safeFence("plain"), "```");
|
||
// single backticks -> maxTicks=1 -> max(3, 2) = 3
|
||
assert.strictEqual(safeFence("a `backtick` here"), "```");
|
||
// 5 backticks -> maxTicks=5 -> 6
|
||
assert.strictEqual(safeFence("`````"), "``````");
|
||
const block = fencedBlock("```js\nx\n```");
|
||
assert.ok(block.startsWith("````"));
|
||
assert.ok(block.endsWith("````"));
|
||
}
|
||
|
||
function testLineSpan() {
|
||
assert.deepStrictEqual(lineSpan({ line: 10, start_line: 5 }), { start: 5, end: 10, multiline: true });
|
||
assert.deepStrictEqual(lineSpan({ line: 7 }), { start: 7, end: 7, multiline: false });
|
||
assert.deepStrictEqual(lineSpan({ start_line: 3 }), { start: 3, end: 3, multiline: false });
|
||
// start_line === line collapses to a single-line span.
|
||
assert.deepStrictEqual(lineSpan({ line: 9, start_line: 9 }), { start: 9, end: 9, multiline: false });
|
||
assert.strictEqual(lineSpan({}), null);
|
||
// Invalid line numbers (0, negative, NaN) are dropped by num(); a span with
|
||
// no usable line resolves to null.
|
||
assert.strictEqual(lineSpan({ line: 0 }), null);
|
||
assert.strictEqual(lineSpan({ line: -3 }), null);
|
||
assert.strictEqual(lineSpan({ line: NaN }), null);
|
||
// An invalid start_line but valid line degrades to a single-line span.
|
||
assert.deepStrictEqual(lineSpan({ line: 5, start_line: 0 }), { start: 5, end: 5, multiline: false });
|
||
assert.deepStrictEqual(lineSpan({ line: 5, start_line: -1 }), { start: 5, end: 5, multiline: false });
|
||
// Reversed order (start_line > line) is normalized via min/max.
|
||
assert.deepStrictEqual(lineSpan({ line: 3, start_line: 8 }), { start: 3, end: 8, multiline: true });
|
||
}
|
||
|
||
function testSameCommentSpan() {
|
||
const sl = (n) => ({ start: n, end: n, multiline: false });
|
||
const ml = (a, b) => ({ start: a, end: b, multiline: true });
|
||
// Rule 1: single vs multi never match.
|
||
assert.strictEqual(sameCommentSpan(sl(9), ml(8, 10), 0.6), false);
|
||
assert.strictEqual(sameCommentSpan(ml(8, 10), sl(9), 0.6), false);
|
||
// Rule 2: single-line, same line matches; different line does not.
|
||
assert.strictEqual(sameCommentSpan(sl(9), sl(9), 0.6), true);
|
||
assert.strictEqual(sameCommentSpan(sl(9), sl(10), 0.6), false);
|
||
// Rule 3: multi-line IoU. [8,10] vs [9,11] => overlap 2 / union 4 = 0.5.
|
||
assert.strictEqual(sameCommentSpan(ml(8, 10), ml(9, 11), 0.6), false);
|
||
assert.strictEqual(sameCommentSpan(ml(8, 10), ml(9, 11), 0.4), true);
|
||
// [8,10] vs [8,9] => overlap 2 / union 3 ~= 0.67.
|
||
assert.strictEqual(sameCommentSpan(ml(8, 10), ml(8, 9), 0.6), true);
|
||
// Identical spans => IoU 1.
|
||
assert.strictEqual(sameCommentSpan(ml(8, 10), ml(8, 10), 0.6), true);
|
||
// Disjoint multi-line spans never match.
|
||
assert.strictEqual(sameCommentSpan(ml(1, 3), ml(8, 10), 0.6), false);
|
||
// IoU comparison is strict: exactly at the threshold is NOT a match.
|
||
// [8,10] vs [9,11] => IoU 0.5; threshold 0.5 => 0.5 > 0.5 is false.
|
||
assert.strictEqual(sameCommentSpan(ml(8, 10), ml(9, 11), 0.5), false);
|
||
// Single-line matching (rule 2) ignores threshold entirely: same line still
|
||
// matches even at threshold = 1.
|
||
assert.strictEqual(sameCommentSpan(sl(9), sl(9), 1), true);
|
||
// threshold = 1 is unreachable for multi-line under strict >: even identical
|
||
// spans (IoU 1) do not satisfy 1 > 1, so nothing ever matches. Locks the
|
||
// strict-> semantics.
|
||
assert.strictEqual(sameCommentSpan(ml(8, 10), ml(8, 10), 1), false);
|
||
}
|
||
|
||
function testResolveThreshold() {
|
||
// Valid values in (0, 1] pass through unchanged.
|
||
assert.strictEqual(resolveThreshold(0.6), 0.6);
|
||
assert.strictEqual(resolveThreshold(0.5), 0.5);
|
||
assert.strictEqual(resolveThreshold(1), 1);
|
||
// Numeric strings are accepted (mirrors parseFloat(action input)).
|
||
assert.strictEqual(resolveThreshold("0.4"), 0.4);
|
||
// Out-of-range values fall back to the default.
|
||
assert.strictEqual(resolveThreshold(0), DEFAULT_OVERLAP_THRESHOLD);
|
||
assert.strictEqual(resolveThreshold(-0.5), DEFAULT_OVERLAP_THRESHOLD);
|
||
assert.strictEqual(resolveThreshold(1.5), DEFAULT_OVERLAP_THRESHOLD);
|
||
// Non-numeric / missing values fall back to the default.
|
||
assert.strictEqual(resolveThreshold(NaN), DEFAULT_OVERLAP_THRESHOLD);
|
||
assert.strictEqual(resolveThreshold("abc"), DEFAULT_OVERLAP_THRESHOLD);
|
||
assert.strictEqual(resolveThreshold(undefined), DEFAULT_OVERLAP_THRESHOLD);
|
||
assert.strictEqual(resolveThreshold(null), DEFAULT_OVERLAP_THRESHOLD);
|
||
}
|
||
|
||
function testOverlapsHistory() {
|
||
// Rule 2: single-line, same line => overlap; different line => no overlap.
|
||
const sl = [{ path: "a.js", line: 9, side: "RIGHT" }];
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 9, start_line: 9, side: "RIGHT" }, sl), true);
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 20, start_line: 20, side: "RIGHT" }, sl), false);
|
||
// Rule 1: single-line vs multi-line never overlap.
|
||
const ml = [{ path: "a.js", line: 10, start_line: 8, side: "RIGHT" }];
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 9, start_line: 9, side: "RIGHT" }, ml), false);
|
||
// Rule 3: multi-line IoU vs default threshold 0.6.
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 10, start_line: 8, side: "RIGHT" }, ml), true);
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 11, start_line: 9, side: "RIGHT" }, ml), false);
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 9, start_line: 8, side: "RIGHT" }, ml), true);
|
||
// Threshold argument lowers the bar (IoU 0.5 > 0.4).
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 11, start_line: 9, side: "RIGHT" }, ml, 0.4), true);
|
||
// Different path and LEFT-side history are still ignored.
|
||
assert.strictEqual(overlapsHistory({ path: "b.js", line: 10, start_line: 8, side: "RIGHT" }, ml), false);
|
||
const leftHist = [{ path: "a.js", line: 10, start_line: 8, side: "LEFT" }];
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 10, start_line: 8, side: "RIGHT" }, leftHist), false);
|
||
// An unresolvable current comment (no usable line) never overlaps.
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", side: "RIGHT" }, ml), false);
|
||
// Unresolvable history entries are skipped, not fatal: a later valid entry
|
||
// on the same path can still match.
|
||
const mixedHist = [
|
||
{ path: "a.js", side: "RIGHT" }, // no line info -> lineSpan null
|
||
{ path: "a.js", line: 9, side: "RIGHT" }, // single-line 9
|
||
];
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 9, start_line: 9, side: "RIGHT" }, mixedHist), true);
|
||
// Any-of semantics: multiple history entries, a match on any one wins.
|
||
const multiHist = [
|
||
{ path: "a.js", line: 5, start_line: 5, side: "RIGHT" }, // no match
|
||
{ path: "a.js", line: 10, start_line: 8, side: "RIGHT" }, // matches [8,10]
|
||
];
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 10, start_line: 8, side: "RIGHT" }, multiHist), true);
|
||
// A history entry with no side field still participates (falsy side bypasses
|
||
// the RIGHT-only guard).
|
||
const noSideHist = [{ path: "a.js", line: 9 }];
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 9, start_line: 9, side: "RIGHT" }, noSideHist), true);
|
||
// An invalid threshold falls back to the default (IoU 0.5 < 0.6 -> no match).
|
||
assert.strictEqual(overlapsHistory({ path: "a.js", line: 11, start_line: 9, side: "RIGHT" }, ml, "garbage"), false);
|
||
}
|
||
|
||
// ---- Batching tests (issue #479) ----
|
||
|
||
// Build N synthetic inline-commentable comments with deterministic, distinct
|
||
// (path, line) identities so partitioning/sorting is observable. Line numbers
|
||
// increase with the index so the deterministic sort (path → start_line →
|
||
// end_line → origIndex) reproduces the input order for same-path entries.
|
||
function makeComments(n) {
|
||
const out = [];
|
||
for (let i = 0; i < n; i++) {
|
||
out.push({ path: `src/file${i}.js`, content: `comment ${i}`, start_line: i + 1, end_line: i + 1 });
|
||
}
|
||
return out;
|
||
}
|
||
|
||
// Pure-helper: resolveBatchSize clamps invalid/missing values to the default
|
||
// and passes valid positives through (B1/A2).
|
||
function testResolveBatchSize() {
|
||
assert.strictEqual(resolveBatchSize(1), 1, "minimum valid size");
|
||
assert.strictEqual(resolveBatchSize(50), 50);
|
||
assert.strictEqual(resolveBatchSize(1000), 1000);
|
||
// Invalid: 0, negative, NaN, non-numeric, missing -> default.
|
||
assert.strictEqual(resolveBatchSize(0), DEFAULT_BATCH_SIZE);
|
||
assert.strictEqual(resolveBatchSize(-5), DEFAULT_BATCH_SIZE);
|
||
assert.strictEqual(resolveBatchSize(NaN), DEFAULT_BATCH_SIZE);
|
||
assert.strictEqual(resolveBatchSize("garbage"), DEFAULT_BATCH_SIZE);
|
||
assert.strictEqual(resolveBatchSize(""), DEFAULT_BATCH_SIZE);
|
||
assert.strictEqual(resolveBatchSize(undefined), DEFAULT_BATCH_SIZE);
|
||
assert.strictEqual(resolveBatchSize(null), DEFAULT_BATCH_SIZE);
|
||
// Numeric strings parse (mirrors parseInt of the action input).
|
||
assert.strictEqual(resolveBatchSize("20"), 20);
|
||
}
|
||
|
||
// Pure-helper: chunkArray partitions into contiguous slices; the last slice is
|
||
// the remainder (B1/AS2/AS3).
|
||
function testChunkArray() {
|
||
assert.deepStrictEqual(chunkArray([], 5), []);
|
||
assert.deepStrictEqual(chunkArray([1], 5), [[1]]);
|
||
// Exact multiple: last slice is full-sized.
|
||
assert.deepStrictEqual(chunkArray([1, 2, 3, 4], 2), [[1, 2], [3, 4]]);
|
||
// Remainder: last slice is the leftover.
|
||
assert.deepStrictEqual(chunkArray([1, 2, 3, 4, 5], 2), [[1, 2], [3, 4], [5]]);
|
||
// 71 @ 20 -> [20,20,20,11] (the canonical acceptance scenario AS3).
|
||
const chunks = chunkArray(makeComments(71).map((_, i) => i), 20);
|
||
assert.deepStrictEqual(chunks.map((c) => c.length), [20, 20, 20, 11]);
|
||
}
|
||
|
||
// Pure-helper: sortToSendDeterministically is stable and does not mutate the
|
||
// input (B2/AS4).
|
||
function testSortToSendDeterministically() {
|
||
const items = [
|
||
{ comment: { path: "b.js", start_line: 5, end_line: 5 } },
|
||
{ comment: { path: "a.js", start_line: 10, end_line: 10 } },
|
||
{ comment: { path: "a.js", start_line: 3, end_line: 3 } },
|
||
{ comment: { path: "a.js", start_line: 3, end_line: 7 } },
|
||
];
|
||
const snapshot = items.map((i) => i.comment);
|
||
const sorted = sortToSendDeterministically(items);
|
||
// Input not mutated.
|
||
assert.deepStrictEqual(items.map((i) => i.comment), snapshot, "input array not mutated");
|
||
// Order: a.js:3-3, a.js:3-7, a.js:10-10, b.js:5-5.
|
||
assert.strictEqual(sorted[0].comment.path, "a.js");
|
||
assert.strictEqual(sorted[0].comment.start_line, 3);
|
||
assert.strictEqual(sorted[0].comment.end_line, 3);
|
||
assert.strictEqual(sorted[1].comment.start_line, 3);
|
||
assert.strictEqual(sorted[1].comment.end_line, 7);
|
||
assert.strictEqual(sorted[2].comment.start_line, 10);
|
||
assert.strictEqual(sorted[3].comment.path, "b.js");
|
||
// Determinism: identical input -> identical output across runs.
|
||
const sorted2 = sortToSendDeterministically(items);
|
||
assert.strictEqual(JSON.stringify(sorted2), JSON.stringify(sorted), "deterministic across runs");
|
||
}
|
||
|
||
// AS1/AS2/AS3/AS4: 71 comments @ N=20 -> exactly 4 batch createReview calls
|
||
// with comment counts [20,20,20,11]; all comment bodies present; deterministic
|
||
// across two runs.
|
||
async function testBatchPartitioningDeterministic() {
|
||
const result = { comments: makeComments(71), warnings: [] };
|
||
const run1 = await run({ result, opts: { reviewCommentBatchSize: 20 } });
|
||
const batchCalls = run1.github.createReviewCalls.filter((c) => (c.body || "") === REVIEW_TAG);
|
||
assert.strictEqual(batchCalls.length, 4, "ceil(71/20) = 4 batches");
|
||
assert.deepStrictEqual(
|
||
batchCalls.map((c) => c.comments.length),
|
||
[20, 20, 20, 11],
|
||
"partition sizes [20,20,20,11]"
|
||
);
|
||
// Every comment body (with its fence) appears exactly once across batches.
|
||
const allBodies = batchCalls.flatMap((c) => c.comments.map((rc) => rc.body));
|
||
assert.strictEqual(allBodies.length, 71, "all 71 comments present");
|
||
// AS4: a second run produces byte-identical batch composition (the random
|
||
// fence IDs differ, but the partition — which path/line ends up in which
|
||
// batch — is identical).
|
||
const run2 = await run({ result, opts: { reviewCommentBatchSize: 20 } });
|
||
const batchCalls2 = run2.github.createReviewCalls.filter((c) => (c.body || "") === REVIEW_TAG);
|
||
const paths1 = batchCalls.flatMap((c) => c.comments.map((rc) => rc.path));
|
||
const paths2 = batchCalls2.flatMap((c) => c.comments.map((rc) => rc.path));
|
||
assert.deepStrictEqual(paths2, paths1, "deterministic partition across runs");
|
||
// Telemetry reflects the partition.
|
||
assert.strictEqual(run1.outputs.batches_total, "4");
|
||
assert.strictEqual(run1.outputs.batches_attempted, "4");
|
||
assert.strictEqual(run1.outputs.batches_succeeded, "4");
|
||
assert.strictEqual(run1.outputs.comments_inline, "71");
|
||
}
|
||
|
||
// AS2 edge: N=1 -> one createReview call per comment, each carrying exactly 1.
|
||
async function testBatchSizeOnePerComment() {
|
||
const result = { comments: makeComments(3), warnings: [] };
|
||
const { github, outputs } = await run({ result, opts: { reviewCommentBatchSize: 1 } });
|
||
const batchCalls = github.createReviewCalls.filter((c) => (c.body || "") === REVIEW_TAG);
|
||
assert.strictEqual(batchCalls.length, 3, "N=1 -> 3 single-comment batches");
|
||
for (const c of batchCalls) {
|
||
assert.strictEqual(c.comments.length, 1, "each batch carries exactly one comment");
|
||
}
|
||
assert.strictEqual(outputs.batches_total, "3");
|
||
assert.strictEqual(outputs.comments_inline, "3");
|
||
}
|
||
|
||
// AS2 edge: N >= toSend.length -> a single batch (no regression vs the previous
|
||
// all-in-one behavior).
|
||
async function testBatchSizeLargerThanToSend() {
|
||
const result = { comments: makeComments(3), warnings: [] };
|
||
const { github, outputs } = await run({ result, opts: { reviewCommentBatchSize: 100 } });
|
||
const batchCalls = github.createReviewCalls.filter((c) => (c.body || "") === REVIEW_TAG);
|
||
assert.strictEqual(batchCalls.length, 1, "single batch when N >= toSend.length");
|
||
assert.strictEqual(batchCalls[0].comments.length, 3);
|
||
assert.strictEqual(outputs.batches_total, "1");
|
||
assert.strictEqual(outputs.comments_inline, "3");
|
||
}
|
||
|
||
// AS5: 2 batches; batch #2 throws 5xx but landed on the server. Only batch #2's
|
||
// missing comments are retried; batch #1's comments are untouched (no
|
||
// double-post). Requires the per-batch error spec.
|
||
async function testBatchPartialSuccessReconcilesPerBatch() {
|
||
const result = { comments: makeComments(4), warnings: [] };
|
||
const { github, core, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
// Fail ONLY batch #2 (index 1) with a 5xx; batch #1 (index 0) succeeds.
|
||
batchErrorSpec: (batchIdx) =>
|
||
batchIdx === 1 ? { status: 502, message: "Bad Gateway" } : null,
|
||
// Batch #2's review landed despite the 5xx.
|
||
batchLanded: true,
|
||
// getPostedCommentIds returns a GLOBAL set across all reviews. Batch #1
|
||
// succeeded, so its 2 comments (c0,c1) are genuinely on the server; 1 of
|
||
// batch #2's (c2) also landed. batchPostedComments() scans ALL batch calls
|
||
// in order [c0,c1,c2,c3], so postedCount=3 echoes [c0,c1,c2] -> batch #2's
|
||
// chunk [c2,c3] filters to toRetry=[c3] (only the missing one).
|
||
echoPosted: true,
|
||
postedCount: 3,
|
||
},
|
||
opts: { reviewCommentBatchSize: 2 },
|
||
});
|
||
const batchCalls = github.createReviewCalls.filter((c) => (c.body || "") === REVIEW_TAG);
|
||
assert.strictEqual(batchCalls.length, 2, "two batches issued");
|
||
// Batch #1 (call 0) succeeded wholesale; batch #2 (call 1) failed.
|
||
// Per-comment fallback calls carry body === "".
|
||
const perCommentCalls = github.createReviewCalls.filter((c) => (c.body || "") !== REVIEW_TAG);
|
||
// Only batch #2's missing comment (c3) is retried (not batch #1's, not c2).
|
||
assert.strictEqual(perCommentCalls.length, 1, "only batch #2's missing comment retried");
|
||
assert.strictEqual(perCommentCalls[0].comments.length, 1);
|
||
// The retried comment belongs to batch #2 (c3), never batch #1 (c0/c1).
|
||
const batch1Paths = new Set(batchCalls[0].comments.map((rc) => rc.path));
|
||
assert.strictEqual(
|
||
batch1Paths.has(perCommentCalls[0].comments[0].path),
|
||
false,
|
||
"retried comment is not from batch #1"
|
||
);
|
||
// All 4 end up posted (3 batch-landed + 1 retried), none failed.
|
||
assert.strictEqual(outputs.comments_inline, "4");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
assert.strictEqual(outputs.batches_total, "2");
|
||
assert.strictEqual(outputs.batches_reconciled, "1", "batch #2 reconciled");
|
||
assert.ok(
|
||
core.logs.some((message) => message.includes("may belong to an earlier batch")),
|
||
"reconciliation log clarifies that the matched review may belong to an earlier batch"
|
||
);
|
||
}
|
||
|
||
// B4: 71 comments, one batch partially fails irrecoverably ->
|
||
// comments_inline + comments_failed == 71 (exhaustive, mutually exclusive);
|
||
// batches_total == 4.
|
||
async function testBatchCountsExhaustive() {
|
||
const result = { comments: makeComments(71), warnings: [] };
|
||
const { outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
// Fail batch #4 (index 3, the 11-comment remainder) with a 5xx.
|
||
batchErrorSpec: (batchIdx) =>
|
||
batchIdx === 3 ? { status: 502, message: "Bad Gateway" } : null,
|
||
// Batch #4 did NOT land, and its per-comment retries all fail with a
|
||
// non-retryable 422 (line unresolvable) -> recorded as failed.
|
||
batchLanded: false,
|
||
perCommentError: () => ({ status: 422, message: "Line could not be resolved" }),
|
||
},
|
||
opts: { reviewCommentBatchSize: 20 },
|
||
});
|
||
const inline = parseInt(outputs.comments_inline, 10);
|
||
const failed = parseInt(outputs.comments_failed, 10);
|
||
assert.strictEqual(inline + failed, 71, "inline + failed == 71 (exhaustive)");
|
||
assert.strictEqual(outputs.batches_total, "4");
|
||
// Batches 1-3 (60 comments) all succeed; batch 4 (11) all fail.
|
||
assert.strictEqual(inline, 60);
|
||
assert.strictEqual(failed, 11);
|
||
}
|
||
|
||
// B6 (multi-batch): the idempotency read API is unavailable mid-sequence. The
|
||
// affected batch's comments are recorded as failed (NOT reposted, avoiding
|
||
// duplicates) and earlier/later batches are undisturbed. This is required
|
||
// because the existing single-batch testPerComment5xxIdempotencyUnavailableSkipsRetry
|
||
// does not exercise B6 across batch boundaries.
|
||
async function testBatchReconcileUnavailableStopsVisibly() {
|
||
const result = { comments: makeComments(4), warnings: [] };
|
||
const { github, outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
// Fail batch #2 (index 1) with a 5xx (may have reached the server).
|
||
batchErrorSpec: (batchIdx) =>
|
||
batchIdx === 1 ? { status: 502, message: "Bad Gateway" } : null,
|
||
// The read API (listReviewComments) is unavailable -> the per-comment
|
||
// idempotency check returns null (unknown) -> skip retry, record failed.
|
||
listReviewCommentsThrow: true,
|
||
// Per-comment fallback also 5xx's so the unavailable path is exercised.
|
||
perCommentError: () => ({ status: 502, message: "Bad Gateway" }),
|
||
},
|
||
opts: { reviewCommentBatchSize: 2 },
|
||
});
|
||
const batchCalls = github.createReviewCalls.filter((c) => (c.body || "") === REVIEW_TAG);
|
||
assert.strictEqual(batchCalls.length, 2, "two batches issued");
|
||
// Batch #1 (indices 0,1) succeeded; batch #2 (indices 2,3) failed and could
|
||
// not be reconciled -> its comments are recorded as failed, not retried.
|
||
const perCommentCalls = github.createReviewCalls.filter((c) => (c.body || "") !== REVIEW_TAG);
|
||
// Each of batch #2's 2 comments is attempted once via the per-comment
|
||
// fallback, but the unavailable idempotency read returns null -> the retry
|
||
// is skipped (break) and the comment recorded as failed. Exactly 2 attempts,
|
||
// no blind retries that would duplicate.
|
||
assert.strictEqual(
|
||
perCommentCalls.length,
|
||
2,
|
||
"exactly one fallback attempt per batch #2 comment, no blind retry"
|
||
);
|
||
assert.strictEqual(outputs.comments_inline, "2", "batch #1's 2 comments posted");
|
||
assert.strictEqual(outputs.comments_failed, "2", "batch #2's 2 comments recorded as failed");
|
||
assert.strictEqual(outputs.batches_total, "2");
|
||
}
|
||
|
||
// A2: invalid batch sizes fall back to the default (50), producing a single
|
||
// batch for test-sized input.
|
||
async function testBatchSizeInvalidFallsBackToDefault() {
|
||
for (const bad of [0, -5, "garbage"]) {
|
||
const result = { comments: makeComments(3), warnings: [] };
|
||
const { github, outputs } = await run({ result, opts: { reviewCommentBatchSize: bad } });
|
||
const batchCalls = github.createReviewCalls.filter((c) => (c.body || "") === REVIEW_TAG);
|
||
assert.strictEqual(batchCalls.length, 1, `invalid size ${JSON.stringify(bad)} -> single batch (default 50)`);
|
||
assert.strictEqual(outputs.batches_total, "1");
|
||
}
|
||
}
|
||
|
||
// B7: per-batch telemetry outputs are present and correct.
|
||
async function testBatchTelemetryOutputs() {
|
||
const result = { comments: makeComments(5), warnings: [] };
|
||
const { outputs } = await run({ result, opts: { reviewCommentBatchSize: 2 } });
|
||
// ceil(5/2) = 3 batches.
|
||
assert.strictEqual(outputs.batches_total, "3");
|
||
assert.strictEqual(outputs.batches_attempted, "3");
|
||
assert.strictEqual(outputs.batches_succeeded, "3");
|
||
assert.strictEqual(outputs.batches_reconciled, "0");
|
||
// Existing outputs unchanged.
|
||
assert.strictEqual(outputs.comments_total, "5");
|
||
assert.strictEqual(outputs.comments_inline, "5");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
// batch_summary is valid JSON with the documented shape.
|
||
const summary = JSON.parse(outputs.batch_summary);
|
||
assert.strictEqual(summary.total, 3);
|
||
assert.strictEqual(summary.attempted, 3);
|
||
assert.strictEqual(summary.succeeded, 3);
|
||
assert.strictEqual(summary.reconciled, 0);
|
||
assert.strictEqual(summary.batch_size, 2);
|
||
assert.strictEqual(summary.inline, 5);
|
||
assert.strictEqual(summary.failed, 0);
|
||
}
|
||
|
||
// ---- Badge + publication policy tests (#478) ----
|
||
//
|
||
// I6: buildBadge byte-matches the CLI's buildBadge degeneration
|
||
// (cmd/opencodereview/output.go:98-114). Each degeneration branch is pinned,
|
||
// plus control-char sanitization so a model-emitted newline cannot break the
|
||
// comment body layout.
|
||
function testBuildBadgeMatchesCliDegeneration() {
|
||
// both present -> "[category · severity]" with a middot (U+00B7)
|
||
assert.strictEqual(buildBadge({ category: "bug", severity: "high" }), "[bug · high]");
|
||
// only category -> "[category]"
|
||
assert.strictEqual(buildBadge({ category: "style", severity: "" }), "[style]");
|
||
assert.strictEqual(buildBadge({ category: "style", severity: null }), "[style]");
|
||
assert.strictEqual(buildBadge({ category: "style" }), "[style]");
|
||
// only severity -> "[severity]"
|
||
assert.strictEqual(buildBadge({ category: "", severity: "low" }), "[low]");
|
||
assert.strictEqual(buildBadge({ category: null, severity: "low" }), "[low]");
|
||
assert.strictEqual(buildBadge({ severity: "low" }), "[low]");
|
||
// neither -> "" (no badge rendered)
|
||
assert.strictEqual(buildBadge({}), "");
|
||
assert.strictEqual(buildBadge({ category: "", severity: "" }), "");
|
||
assert.strictEqual(buildBadge({ category: null, severity: null }), "");
|
||
// missing comment object entirely
|
||
assert.strictEqual(buildBadge(null), "");
|
||
assert.strictEqual(buildBadge(undefined), "");
|
||
// The separator is the U+00B7 middot (·), exactly matching the CLI's
|
||
// fmt.Sprintf("[%s · %s]", ...). Pin the exact byte (not "." or "-" or "·"'s
|
||
// decomposition) so a future edit that swaps the separator fails loudly.
|
||
const both = buildBadge({ category: "bug", severity: "low" });
|
||
assert.ok(both.includes("·"), "badge contains the U+00B7 middot");
|
||
assert.strictEqual(both, "[bug · low]", "exact badge string for the common case");
|
||
// control-char sanitization: the Action strips ALL control chars (including
|
||
// \t and \n) from metadata — intentionally STRICTER than the CLI's
|
||
// sanitizeTerminal (which keeps \t/\n), because a newline/tab would break
|
||
// the Markdown comment body layout. Documented divergence from strict OC1
|
||
// byte-parity; clean enum values match exactly across surfaces.
|
||
assert.strictEqual(buildBadge({ category: "bu\ng", severity: "high" }), "[bug · high]");
|
||
assert.strictEqual(buildBadge({ category: "bug", severity: "hi\tgh" }), "[bug · high]");
|
||
assert.strictEqual(buildBadge({ category: "bug\r\n", severity: "high" }), "[bug · high]");
|
||
// a value that is ALL control chars degenerates to "" (badge not rendered),
|
||
// not a label of empty brackets.
|
||
assert.strictEqual(buildBadge({ category: "\n\r\t", severity: "\n" }), "");
|
||
}
|
||
|
||
function testSanitizeMetadataStripsControlChars() {
|
||
assert.strictEqual(sanitizeMetadata("clean"), "clean");
|
||
assert.strictEqual(sanitizeMetadata("a\nb"), "ab");
|
||
assert.strictEqual(sanitizeMetadata("a\tb"), "ab");
|
||
assert.strictEqual(sanitizeMetadata("a\rb"), "ab");
|
||
assert.strictEqual(sanitizeMetadata("a\x00b"), "ab");
|
||
assert.strictEqual(sanitizeMetadata("a\x7fb"), "ab");
|
||
assert.strictEqual(sanitizeMetadata("\n\r\t"), "");
|
||
// null/undefined/numbers degrade safely to their string form.
|
||
assert.strictEqual(sanitizeMetadata(null), "");
|
||
assert.strictEqual(sanitizeMetadata(undefined), "");
|
||
assert.strictEqual(sanitizeMetadata(42), "42");
|
||
}
|
||
|
||
// I1: buildPolicy fails open on any malformed input — a bad policy never routes
|
||
// a finding, so no finding is ever silently dropped because the policy itself
|
||
// was broken. The NO_ROUTING sentinel is returned for every non-routing case.
|
||
function testBuildPolicyFailsOpenOnMalformed() {
|
||
// empty / null inputs -> no routing
|
||
assert.strictEqual(buildPolicy({}), NO_ROUTING);
|
||
assert.strictEqual(buildPolicy({ severityThreshold: "", categories: "" }), NO_ROUTING);
|
||
assert.strictEqual(buildPolicy({ severityThreshold: null, categories: null }), NO_ROUTING);
|
||
assert.strictEqual(buildPolicy(undefined), NO_ROUTING);
|
||
// unknown severity -> severity routing disabled (fail-open)
|
||
assert.strictEqual(buildPolicy({ severityThreshold: "trivial" }), NO_ROUTING);
|
||
assert.strictEqual(buildPolicy({ severityThreshold: "Criticals" }), NO_ROUTING);
|
||
// garbage threshold -> no routing
|
||
assert.strictEqual(buildPolicy({ severityThreshold: "garbage" }), NO_ROUTING);
|
||
// all-unknown categories -> category routing disabled (fail-open)
|
||
assert.strictEqual(buildPolicy({ categories: "unknown,also-unknown" }), NO_ROUTING);
|
||
// a known threshold enables severity routing; the returned rank is correct.
|
||
const lowP = buildPolicy({ severityThreshold: "low" });
|
||
assert.strictEqual(lowP.routeBySeverity, true);
|
||
assert.strictEqual(lowP.routeByCategory, false);
|
||
assert.strictEqual(lowP.severityRank, SEVERITY_RANK.get("low"));
|
||
// case-insensitivity
|
||
const medP = buildPolicy({ severityThreshold: "MeDiUm" });
|
||
assert.strictEqual(medP.routeBySeverity, true);
|
||
assert.strictEqual(medP.severityRank, SEVERITY_RANK.get("medium"));
|
||
// known categories enable category routing; unknown tokens dropped.
|
||
const catP = buildPolicy({ categories: "Style, UNKNOWN, documentation" });
|
||
assert.strictEqual(catP.routeByCategory, true);
|
||
assert.strictEqual(catP.routeBySeverity, false);
|
||
assert.ok(catP.categories.has("style"));
|
||
assert.ok(catP.categories.has("documentation"));
|
||
assert.ok(!catP.categories.has("unknown"));
|
||
// whitespace-only threshold -> no routing
|
||
assert.strictEqual(buildPolicy({ severityThreshold: " " }), NO_ROUTING);
|
||
}
|
||
|
||
// I1: routeComment never routes a finding with unknown/malformed metadata — it
|
||
// falls through to the normal inline path (visible), never dropped. Boundary
|
||
// inclusivity ("at-or-below") is pinned so the threshold value itself routes.
|
||
function testRouteCommentUnknownMetadataNeverRouted() {
|
||
const policy = buildPolicy({ severityThreshold: "medium", categories: "style,documentation" });
|
||
// severity routing: medium threshold routes medium AND low (inclusive-at-or-below)
|
||
assert.strictEqual(routeComment({ severity: "medium" }, policy).routed, true);
|
||
assert.strictEqual(routeComment({ severity: "low" }, policy).routed, true);
|
||
// severity strictly above the threshold stays inline
|
||
assert.strictEqual(routeComment({ severity: "high" }, policy).routed, false);
|
||
assert.strictEqual(routeComment({ severity: "critical" }, policy).routed, false);
|
||
// unknown/empty severity is NEVER routed by severity (fail-open: I1)
|
||
assert.strictEqual(routeComment({ severity: "" }, policy).routed, false);
|
||
assert.strictEqual(routeComment({ severity: "trivial" }, policy).routed, false);
|
||
assert.strictEqual(routeComment({ severity: null }, policy).routed, false);
|
||
assert.strictEqual(routeComment({}, policy).routed, false);
|
||
// category routing: a listed category routes regardless of severity
|
||
assert.strictEqual(routeComment({ category: "style" }, policy).routed, true);
|
||
assert.strictEqual(routeComment({ category: "documentation" }, policy).routed, true);
|
||
// unlisted/unknown category is NEVER routed by category (fail-open: I1)
|
||
assert.strictEqual(routeComment({ category: "bug" }, policy).routed, false);
|
||
assert.strictEqual(routeComment({ category: "unknown" }, policy).routed, false);
|
||
assert.strictEqual(routeComment({ category: "" }, policy).routed, false);
|
||
assert.strictEqual(routeComment({ category: null }, policy).routed, false);
|
||
// case-insensitive category matching
|
||
assert.strictEqual(routeComment({ category: "STYLE" }, policy).routed, true);
|
||
assert.strictEqual(routeComment({ category: "Documentation" }, policy).routed, true);
|
||
// NO_ROUTING sentinel never routes anything
|
||
assert.strictEqual(routeComment({ severity: "low", category: "style" }, NO_ROUTING).routed, false);
|
||
assert.strictEqual(routeComment({ severity: "low", category: "style" }, null).routed, false);
|
||
// routed result carries a reason string
|
||
const r = routeComment({ severity: "low", category: "style" }, policy);
|
||
assert.ok(r.routed);
|
||
assert.ok(typeof r.reason === "string" && r.reason.length > 0);
|
||
assert.match(r.reason, /severity low/);
|
||
assert.match(r.reason, /category style/);
|
||
}
|
||
|
||
// Pins the "at-or-below" boundary explicitly (PLAN_VALIDATION Risk C): the
|
||
// threshold value itself routes, and the floor (low) routes low.
|
||
function testRouteSeverityBelowBoundaryInclusive() {
|
||
const lowP = buildPolicy({ severityThreshold: "low" });
|
||
// threshold = low routes ONLY low (the floor). critical/high/medium stay.
|
||
assert.strictEqual(routeComment({ severity: "low" }, lowP).routed, true);
|
||
assert.strictEqual(routeComment({ severity: "medium" }, lowP).routed, false);
|
||
assert.strictEqual(routeComment({ severity: "high" }, lowP).routed, false);
|
||
assert.strictEqual(routeComment({ severity: "critical" }, lowP).routed, false);
|
||
const critP = buildPolicy({ severityThreshold: "critical" });
|
||
// threshold = critical routes everything (all severities are at-or-below it).
|
||
for (const sev of SEVERITIES) {
|
||
assert.strictEqual(routeComment({ severity: sev }, critP).routed, true);
|
||
}
|
||
}
|
||
|
||
// A finding that matches BOTH the severity and category conditions routes
|
||
// EXACTLY ONCE (no double-count): the severity branch short-circuits, the
|
||
// category branch is never reached, and the partition loop counts the finding
|
||
// in the routed bucket a single time.
|
||
async function testFindingMatchingBothConditionsRoutesOnce() {
|
||
const result = {
|
||
comments: [
|
||
// matches BOTH severity (low <= low) AND category (style in list)
|
||
{ path: "src/both.js", content: "matches both", category: "style", severity: "low", start_line: 1, end_line: 1 },
|
||
// matches only severity
|
||
{ path: "src/sev.js", content: "sev only", category: "bug", severity: "low", start_line: 2, end_line: 2 },
|
||
// matches only category
|
||
{ path: "src/cat.js", content: "cat only", category: "documentation", severity: "critical", start_line: 3, end_line: 3 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
opts: { routeSeverityBelow: "low", routeCategories: "style,documentation" },
|
||
});
|
||
|
||
// All three route (none posted inline); routed count is exactly 3 (no
|
||
// double-count from the "both" finding matching two conditions).
|
||
assert.strictEqual(github.createReviewCalls.length, 0, "no inline posting — all routed");
|
||
assert.strictEqual(outputs.comments_routed, "3", "each finding counted once even when matching both conditions");
|
||
assert.strictEqual(outputs.comments_total, "3");
|
||
assert.strictEqual(outputs.comments_inline, "0");
|
||
}
|
||
|
||
// I6 / additive behavior: formatComment prepends the badge AFTER the id HTML
|
||
// comment, so the idempotency regex (unanchored) still matches and the badge
|
||
// is the first VISIBLE line. No badge when category/severity are absent.
|
||
function testFormatCommentBadgePlacement() {
|
||
// with id and badge: id HTML comment stays first, badge on the next line
|
||
const withBadge = formatComment({ content: "body", category: "bug", severity: "high" }, "ocr-1-1-abcd");
|
||
assert.ok(withBadge.startsWith("<!-- ocr-1-1-abcd -->\n"), "id HTML comment is the first bytes");
|
||
assert.ok(withBadge.startsWith("<!-- ocr-1-1-abcd -->\n[bug · high]\n"), "badge follows id line");
|
||
assert.ok(withBadge.endsWith("body"), "content preserved at the end");
|
||
// without id: badge is the first line
|
||
const noId = formatComment({ content: "body", category: "style", severity: "low" });
|
||
assert.ok(noId.startsWith("[style · low]\n"));
|
||
// no metadata -> no badge line at all (byte-identical to pre-change output)
|
||
const noBadge = formatComment({ content: "body" }, "ocr-1-1-abcd");
|
||
assert.strictEqual(noBadge, "<!-- ocr-1-1-abcd -->\nbody");
|
||
// suggestion block still appends after the badge
|
||
const withSuggestion = formatComment(
|
||
{ content: "c", category: "bug", severity: "high", existing_code: "old", suggestion_code: "new" },
|
||
"ocr-1-1-abcd"
|
||
);
|
||
assert.match(withSuggestion, /\[bug · high\]/);
|
||
assert.match(withSuggestion, /\*\*Suggestion:\*\*/);
|
||
assert.match(withSuggestion, /```suggestion/);
|
||
}
|
||
|
||
// I6: formatCommentMarkdown prepends the badge as a leading line before the
|
||
// path heading (PLAN_VALIDATION Risk A confirmed placement).
|
||
function testFormatCommentMarkdownBadgePlacement() {
|
||
const md = formatCommentMarkdown({ path: "a.js", content: "body", category: "bug", severity: "high" });
|
||
// badge is the first line, before the heading
|
||
assert.ok(md.startsWith("[bug · high]\n"), "badge is the leading line");
|
||
assert.match(md, /### 📄 `a.js`/);
|
||
assert.match(md, /body/);
|
||
// no metadata -> no badge line, heading is first (byte-identical to pre-change)
|
||
const noBadge = formatCommentMarkdown({ path: "a.js", content: "body" });
|
||
assert.ok(noBadge.startsWith("### 📄 `a.js`"));
|
||
assert.ok(!noBadge.includes("·"));
|
||
}
|
||
|
||
// I3: with no routing input set, placement is identical to today (modulo the
|
||
// additive badge prefix, which is "" for findings without metadata). Exercises
|
||
// the full runPostReviewComments path with default empty policy.
|
||
async function testNoRoutingInputPreservesBehavior() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "inline content", start_line: 10, end_line: 10 },
|
||
{ path: "docs/no-line.md", content: "no-line content", start_line: 0, end_line: 0 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({ result });
|
||
|
||
// The inline comment is posted via the batch review (not routed).
|
||
assert.strictEqual(github.createReviewCalls.length, 1, "one batch review");
|
||
const sent = github.createReviewCalls[0].comments;
|
||
assert.strictEqual(sent.length, 1);
|
||
assert.strictEqual(sent[0].path, "src/a.js");
|
||
// no routed bucket (output defaults to 0)
|
||
assert.strictEqual(outputs.comments_routed, "0");
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
assert.strictEqual(outputs.comments_total, "2");
|
||
}
|
||
|
||
// I2 + OC4: severity routing moves at-or-below findings to the summary and
|
||
// counts reconcile to the total.
|
||
async function testRouteSeverityBelowRoutesToSummary() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/critical.js", content: "critical finding", category: "bug", severity: "critical", start_line: 1, end_line: 1 },
|
||
{ path: "src/low.js", content: "low finding", category: "style", severity: "low", start_line: 2, end_line: 2 },
|
||
{ path: "docs/no-line.md", content: "no-line finding", category: "documentation", severity: "low", start_line: 0, end_line: 0 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
opts: { routeSeverityBelow: "low" },
|
||
});
|
||
|
||
// only the critical inline finding is posted (low is routed, no-line stays in summary)
|
||
assert.strictEqual(github.createReviewCalls.length, 1, "one batch review");
|
||
const sent = github.createReviewCalls[0].comments;
|
||
assert.strictEqual(sent.length, 1, "only critical inline finding posted");
|
||
assert.strictEqual(sent[0].path, "src/critical.js");
|
||
// counts reconcile (I2): inline + routed + summary == total (skipped=failed=0)
|
||
assert.strictEqual(outputs.comments_total, "3");
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
assert.strictEqual(outputs.comments_routed, "1");
|
||
assert.strictEqual(outputs.comments_failed, "0");
|
||
assert.strictEqual(outputs.comments_skipped, "0");
|
||
// routed finding rendered in the summary with its reason
|
||
const body = github.updatedComments[0].body;
|
||
assert.match(body, /📋 Routed to summary by policy: 1 comment\(s\)/);
|
||
assert.match(body, /low finding/);
|
||
assert.match(body, /Routed to summary \(severity low/);
|
||
// no-line finding still rendered in summary too
|
||
assert.match(body, /no-line finding/);
|
||
}
|
||
|
||
// OC4: comma-list category routing moves listed categories to the summary.
|
||
async function testRouteCategoriesRoutesToSummary() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/bug.js", content: "bug finding", category: "bug", severity: "high", start_line: 1, end_line: 1 },
|
||
{ path: "src/style.js", content: "style finding", category: "style", severity: "low", start_line: 2, end_line: 2 },
|
||
{ path: "docs/doc.md", content: "doc finding", category: "documentation", severity: "low", start_line: 3, end_line: 3 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
opts: { routeCategories: "style,documentation" },
|
||
});
|
||
|
||
// only the bug finding is posted inline; style + documentation routed
|
||
assert.strictEqual(github.createReviewCalls.length, 1);
|
||
const sent = github.createReviewCalls[0].comments;
|
||
assert.strictEqual(sent.length, 1);
|
||
assert.strictEqual(sent[0].path, "src/bug.js");
|
||
assert.strictEqual(outputs.comments_inline, "1");
|
||
assert.strictEqual(outputs.comments_routed, "2");
|
||
assert.strictEqual(outputs.comments_total, "3");
|
||
const body = github.updatedComments[0].body;
|
||
assert.match(body, /📋 Routed to summary by policy: 2 comment\(s\)/);
|
||
assert.match(body, /style finding/);
|
||
assert.match(body, /doc finding/);
|
||
}
|
||
|
||
// I4: routed findings never enter the createReview write path, so they cannot
|
||
// be double-posted on retry. Verified by inspecting createReviewCalls bodies.
|
||
async function testRoutedFindingsNeverCallCreateReview() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/keep.js", content: "keep inline", category: "bug", severity: "critical", start_line: 1, end_line: 1 },
|
||
{ path: "src/route.js", content: "route me", category: "style", severity: "low", start_line: 2, end_line: 2 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github, outputs } = await run({
|
||
result,
|
||
// Inject a batch error so the per-comment retry path runs; routed findings
|
||
// must STILL not appear in any createReview call (batch or per-comment).
|
||
githubOpts: {
|
||
bulkErrorSpec: { message: "Bad Gateway", status: 502 },
|
||
// No batchLanded / echoPosted -> full retry of toSend (the non-routed set).
|
||
},
|
||
opts: { routeCategories: "style" },
|
||
});
|
||
|
||
// Every createReview call must contain ONLY the kept finding's path, never
|
||
// the routed one. This is the faithful proxy for "cannot be double-posted":
|
||
// a finding absent from every write call cannot land twice.
|
||
for (const call of github.createReviewCalls) {
|
||
const paths = (call.comments || []).map((c) => c.path);
|
||
assert.ok(!paths.includes("src/route.js"), `routed finding appeared in createReview call: ${JSON.stringify(paths)}`);
|
||
assert.ok(paths.includes("src/keep.js"), `kept finding missing from createReview call: ${JSON.stringify(paths)}`);
|
||
}
|
||
assert.strictEqual(outputs.comments_routed, "1");
|
||
// at least the batch + one per-comment retry happened
|
||
assert.ok(github.createReviewCalls.length >= 2, "batch then per-comment retry ran");
|
||
}
|
||
|
||
// I2: accounting reconciles across mixed inputs —
|
||
// inline + summary + skipped + failed + routed == total.
|
||
async function testAccountingReconcilesToTotal() {
|
||
const history = [{ path: "src/overlap.js", line: 5, start_line: 5, side: "RIGHT", user: { login: "github-actions[bot]" } }];
|
||
const result = {
|
||
comments: [
|
||
// routed by severity (low)
|
||
{ path: "src/routed.js", content: "routed", category: "style", severity: "low", start_line: 1, end_line: 1 },
|
||
// inline (posted successfully via per-comment retry)
|
||
{ path: "src/inline.js", content: "inline", category: "bug", severity: "high", start_line: 2, end_line: 2 },
|
||
// skipped by incremental overlap
|
||
{ path: "src/overlap.js", content: "overlap", category: "bug", severity: "high", start_line: 5, end_line: 5 },
|
||
// failed to post (422 non-retryable during per-comment retry)
|
||
{ path: "src/fail.js", content: "fail", category: "bug", severity: "high", start_line: 3, end_line: 3 },
|
||
// no-line (summary)
|
||
{ path: "docs/noline.md", content: "no-line", category: "documentation", severity: "low", start_line: 0, end_line: 0 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { outputs } = await run({
|
||
result,
|
||
githubOpts: {
|
||
history,
|
||
// A 502 on the BATCH call forces the per-comment retry path, where
|
||
// perCommentError actually fires (it only runs on per-comment calls).
|
||
bulkErrorSpec: { message: "Bad Gateway", status: 502 },
|
||
perCommentError: (rc) => {
|
||
if (rc && rc.path === "src/fail.js") {
|
||
return { message: "Line could not be resolved", status: 422 };
|
||
}
|
||
return null;
|
||
},
|
||
},
|
||
opts: { incremental: true, routeSeverityBelow: "low" },
|
||
});
|
||
|
||
const total = Number(outputs.comments_total);
|
||
const inline = Number(outputs.comments_inline);
|
||
const summary = 1; // the no-line finding (always summary)
|
||
const skipped = Number(outputs.comments_skipped);
|
||
const routed = Number(outputs.comments_routed);
|
||
const failed = Number(outputs.comments_failed);
|
||
assert.strictEqual(inline + summary + skipped + routed + failed, total, "counts sum to total (I2)");
|
||
assert.strictEqual(total, 5);
|
||
assert.strictEqual(routed, 1, "low-severity valid-line finding routed");
|
||
assert.strictEqual(inline, 1, "high-severity finding posted inline");
|
||
assert.strictEqual(skipped, 1, "overlap skipped by incremental");
|
||
assert.strictEqual(failed, 1, "fail.js failed to post");
|
||
}
|
||
|
||
// I1 / fail-open for the policy itself: malformed routing inputs degrade to
|
||
// no-routing, so the Action behaves exactly like today (no finding dropped
|
||
// because the policy string was garbage).
|
||
async function testMalformedRoutingPolicyFailsOpen() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/a.js", content: "a", category: "bug", severity: "low", start_line: 1, end_line: 1 },
|
||
{ path: "src/b.js", content: "b", category: "style", severity: "high", start_line: 2, end_line: 2 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
// unknown severity threshold -> no routing; both stay inline
|
||
const { outputs } = await run({
|
||
result,
|
||
opts: { routeSeverityBelow: "trivial" },
|
||
});
|
||
assert.strictEqual(outputs.comments_routed, "0");
|
||
assert.strictEqual(outputs.comments_inline, "2");
|
||
// all-unknown categories -> no routing
|
||
const { outputs: o2 } = await run({
|
||
result,
|
||
opts: { routeCategories: "nonsense,garbage" },
|
||
});
|
||
assert.strictEqual(o2.comments_routed, "0");
|
||
assert.strictEqual(o2.comments_inline, "2");
|
||
}
|
||
|
||
// I4: routed findings carry no id (formatComment called without an id arg),
|
||
// so even a hypothetical leak into a write path could not match the
|
||
// idempotency regex. Defense-in-depth check on the routed item shape.
|
||
async function testRoutedFindingsCarryNoIdempotencyId() {
|
||
const result = {
|
||
comments: [
|
||
{ path: "src/route.js", content: "route me", category: "style", severity: "low", start_line: 2, end_line: 2 },
|
||
],
|
||
warnings: [],
|
||
};
|
||
|
||
const { github } = await run({
|
||
result,
|
||
opts: { routeCategories: "style" },
|
||
});
|
||
// No createReview call at all (the only finding was routed).
|
||
assert.strictEqual(github.createReviewCalls.length, 0);
|
||
// The routed body in the summary must NOT contain an ocr-... id comment.
|
||
const body = github.updatedComments[0].body;
|
||
assert.doesNotMatch(body, /ocr-\d+-\d+-[a-f0-9]+/, "routed summary body carries no idempotency id");
|
||
}
|
||
|
||
async function main() {
|
||
await testFailedInlineCommentsAreSummarized();
|
||
await testWarningsListedAfterSummaryComments();
|
||
await testErrorCommentUsesSafeFence();
|
||
await testStickyUpdatesExistingSummary();
|
||
await testNonStickyCreatesNewCommentOnFallback();
|
||
await testNonStickyFallbackAllSuccessStillPostsSummary();
|
||
await testNoCommentsStickyUpdate();
|
||
await testIncrementalSkipsOverlapping();
|
||
await testIncrementalAllOverlapPostsNoReview();
|
||
await testIncrementalMultiLineIoUDefaultThreshold();
|
||
await testIncrementalOverlapThresholdPropagated();
|
||
// Idempotency
|
||
await testBatchLandedRetriesOnlyMissingComments();
|
||
await testPerComment5xxAlreadyPostedTreatedAsSuccess();
|
||
await testPerComment5xxIdempotencyUnavailableSkipsRetry();
|
||
await testSummaryDoesNotDuplicateWhenAlreadyPosted();
|
||
await testSummaryAnchorCreatedBeforeReviewColdStart();
|
||
await testSummaryAnchorCreatedBeforeReviewNonSticky();
|
||
await testGetPostedCommentIdsExtractsEmbeddedIds();
|
||
// Rate-limit strategy (pure function)
|
||
testComputeRetryDelayMs();
|
||
// Cross-scenario: rate-limit x partial-invalid x landed
|
||
await testBatchRateLimitWithPartialInvalidContent();
|
||
await testPerCommentRateLimitRetryThenSuccessAndExhausted();
|
||
await testBatchLandedWithPerCommentPartialInvalid();
|
||
await testBatchLandedWithPerCommentMixedStates();
|
||
await testNetworkErrorLandedRecoveredAndNotLandedFailed();
|
||
await testBatchIdempotencyCheckFailureDegradesToFullRetry();
|
||
await testLowQuotaProactiveThrottleDoesNotBreakFlow();
|
||
await testBatchRateLimitSkipsIdempotencyReads();
|
||
await testBatchReadRateLimitRetriedViaWithRetry();
|
||
// Pure helpers
|
||
testSafeFenceAndFencedBlock();
|
||
testFormatWarnings();
|
||
testLineSpan();
|
||
testSameCommentSpan();
|
||
testResolveThreshold();
|
||
testOverlapsHistory();
|
||
testNewCommentIdFormat();
|
||
// Batching (issue #479) — pure helpers
|
||
testResolveBatchSize();
|
||
testChunkArray();
|
||
testSortToSendDeterministically();
|
||
// Batching (issue #479) — integration via mock
|
||
await testBatchPartitioningDeterministic();
|
||
await testBatchSizeOnePerComment();
|
||
await testBatchSizeLargerThanToSend();
|
||
await testBatchPartialSuccessReconcilesPerBatch();
|
||
await testBatchCountsExhaustive();
|
||
await testBatchReconcileUnavailableStopsVisibly();
|
||
await testBatchSizeInvalidFallsBackToDefault();
|
||
await testBatchTelemetryOutputs();
|
||
// Badge + publication policy (#478)
|
||
testBuildBadgeMatchesCliDegeneration();
|
||
testSanitizeMetadataStripsControlChars();
|
||
testBuildPolicyFailsOpenOnMalformed();
|
||
testRouteCommentUnknownMetadataNeverRouted();
|
||
testRouteSeverityBelowBoundaryInclusive();
|
||
await testFindingMatchingBothConditionsRoutesOnce();
|
||
testFormatCommentBadgePlacement();
|
||
testFormatCommentMarkdownBadgePlacement();
|
||
await testNoRoutingInputPreservesBehavior();
|
||
await testRouteSeverityBelowRoutesToSummary();
|
||
await testRouteCategoriesRoutesToSummary();
|
||
await testRoutedFindingsNeverCallCreateReview();
|
||
await testAccountingReconcilesToTotal();
|
||
await testMalformedRoutingPolicyFailsOpen();
|
||
await testRoutedFindingsCarryNoIdempotencyId();
|
||
console.log("All post-review-comments tests passed.");
|
||
}
|
||
|
||
main().catch((err) => {
|
||
console.error(err);
|
||
process.exit(1);
|
||
});
|