ReviewOS

also looking at this

stacks/buddy

fix(review): persist review state where it is read back

#1404
Closed chris wants to merge fix/persist-review-state into main
6 files +176 -14
src/review/run.tsmodified+39-1
Changes to src/review/run.ts
@@ -8,7 +8,8 @@ import { getDefaultLogger } from '../utils/logger'
88import { parseUnifiedDiff } from './diff'
99import { reviewDiff } from './engine'
1010import { composeInstructions, loadGuidelines } from './guidelines'
11import { needsReview, parseReviewState } from './marker'
11import { needsReview, parseReviewState, upsertReviewState } from './marker'
12import type { PreparedReview } from './poster'
1213import { prepareReview } from './poster'
1314
1415/** Inputs to a full review of a pull request. */
@@ -93,6 +94,7 @@ export async function runReviewForPR(options: RunReviewOptions): Promise<string>
9394
9495 assertSupports(provider, 'inlineReviewComments', 'createReview', 'posting a review')
9596 await provider.createReview(prNumber, prepared)
97 await persistReviewState(provider, prNumber, pr.body, prepared.state, state?.paused, logger)
9698 return `Posted ${analysis.findings.length} static-analysis finding(s).`
9799 }
98100
@@ -133,8 +135,44 @@ export async function runReviewForPR(options: RunReviewOptions): Promise<string>
133135
134136 assertSupports(provider, 'inlineReviewComments', 'createReview', 'posting a review')
135137 await provider.createReview(prNumber, prepared)
138 await persistReviewState(provider, prNumber, pr.body, prepared.state, state?.paused, logger)
136139
137140 return result.findings.length === 0
138141 ? 'Reviewed — nothing to report.'
139142 : `Reviewed — ${result.findings.length} finding(s) posted.`
140143}
144
145/**
146 * Write the state a review established back onto the pull request.
147 *
148 * Separated from posting because the review itself has already landed by this
149 * point: if updating the body fails — a token without write access to the
150 * description, say — the findings are still on the pull request, and the worst
151 * case is that the next run reviews the same commit again. That is a better
152 * failure than losing the review to a bookkeeping error.
153 *
154 * @param provider - Git provider to write through
155 * @param prNumber - Pull request to update
156 * @param body - Current pull request body
157 * @param state - State this review established
158 * @param paused - Carried forward so persisting does not silently resume a
159 * paused pull request
160 * @param logger - Logger for the failure path
161 */
162async function persistReviewState(
163 provider: GitProvider,
164 prNumber: number,
165 body: string | null | undefined,
166 state: PreparedReview['state'],
167 paused: boolean | undefined,
168 logger: Logger,
169): Promise<void> {
170 try {
171 await provider.updatePullRequest(prNumber, {
172 body: upsertReviewState(body, { ...state, ...(paused ? { paused: true } : {}) }),
173 })
174 }
175 catch (error) {
176 logger.warn(`Could not record review state on PR #${prNumber}: ${error instanceof Error ? error.message : String(error)}`)
177 }
178}