ReviewOS

also looking at this

stacks/buddy

fix(review): give pull request reviews the analyzers and learnings they skipped

#1415
Merged glennmichael123 wants to merge fix/review-parity into main
4 files +316 -106
src/review/run.tsmodified+39-2
Changes to src/review/run.ts
@@ -1,3 +1,4 @@
1import type { AiClient } from '../ai/types'
12import type { GitProvider } from '../git/provider'
23import { assertSupports } from '../git/provider'
34import type { BuddyConfig } from '../types'
@@ -8,6 +9,7 @@ import { getDefaultLogger } from '../utils/logger'
89import { parseUnifiedDiff } from './diff'
910import { reviewDiff } from './engine'
1011import { composeInstructions, loadGuidelines } from './guidelines'
12import type { ReviewProfile } from './engine'
1113import type { ReviewTrigger } from './filters'
1214import { reviewSkipReason } from './filters'
1315import { needsReview, parseReviewState, upsertReviewState } from './marker'
@@ -25,6 +27,18 @@ export interface RunReviewOptions {
2527 summaryOnly?: boolean
2628 /** Skip when the head commit was already reviewed */
2729 skipIfReviewed?: boolean
30 /** Override the configured review profile */
31 profile?: ReviewProfile
32 /** Report what would be posted without posting it */
33 dryRun?: boolean
34 /**
35 * Client to review with; omitted means build one from config.
36 *
37 * Injectable for the same reason `attemptFix` takes one: an orchestration
38 * that constructs its own client cannot be tested without a key, and this
39 * one drifted from its second caller for exactly that long.
40 */
41 ai?: AiClient | null
2842 /**
2943 * Whether Buddy chose to review or was asked to (default: `requested`).
3044 *
@@ -80,7 +94,7 @@ export async function runReviewForPR(options: RunReviewOptions): Promise<string>
8094 return 'Already reviewed at this commit.'
8195 }
8296
83 const ai = createAiClient(config, logger)
97 const ai = options.ai === undefined ? createAiClient(config, logger) : options.ai
8498
8599 // Analyzers run whether or not AI is configured, so a repository without a
86100 // key still gets secret scanning and workflow auditing on its pull requests.
@@ -110,6 +124,11 @@ export async function runReviewForPR(options: RunReviewOptions): Promise<string>
110124 { headSha, requestChangesOn: config.ai?.review?.requestChangesOn },
111125 )
112126
127 if (options.dryRun) {
128 reportDryRun(prepared, logger)
129 return `Would post ${analysis.findings.length} static-analysis finding(s).`
130 }
131
113132 assertSupports(provider, 'inlineReviewComments', 'createReview', 'posting a review')
114133 await provider.createReview(prNumber, prepared)
115134 await persistReviewState(provider, prNumber, pr.body, prepared.state, state?.paused, logger)
@@ -129,7 +148,7 @@ export async function runReviewForPR(options: RunReviewOptions): Promise<string>
129148
130149 const result = await reviewDiff(ai, {
131150 diff,
132 profile: config.ai?.review?.profile,
151 profile: options.profile ?? config.ai?.review?.profile,
133152 summaryOnly: options.summaryOnly ?? config.ai?.review?.summaryOnly,
134153 instructions: composeInstructions({
135154 global: config.ai?.review?.instructions,
@@ -151,6 +170,11 @@ export async function runReviewForPR(options: RunReviewOptions): Promise<string>
151170 seenFingerprints: options.full ? [] : state?.fingerprints ?? [],
152171 })
153172
173 if (options.dryRun) {
174 reportDryRun(prepared, logger)
175 return `Would post ${result.findings.length} finding(s).`
176 }
177
154178 assertSupports(provider, 'inlineReviewComments', 'createReview', 'posting a review')
155179 await provider.createReview(prNumber, prepared)
156180 await persistReviewState(provider, prNumber, pr.body, prepared.state, state?.paused, logger)
@@ -160,6 +184,19 @@ export async function runReviewForPR(options: RunReviewOptions): Promise<string>
160184 : `Reviewed — ${result.findings.length} finding(s) posted.`
161185}
162186
187/**
188 * Print a review instead of posting it.
189 *
190 * @param prepared - The review that would have been posted
191 * @param logger - Where to print
192 */
193function reportDryRun(prepared: PreparedReview, logger: Logger): void {
194 logger.info(`\n${prepared.body}\n`)
195
196 for (const comment of prepared.comments)
197 logger.info(`${comment.path}:${comment.line}\n${comment.body}\n`)
198}
199
163200/**
164201 * Write the state a review established back onto the pull request.
165202 *