also looking at this
fix(review): persist review state where it is read back
#1405
6 files
+176
-14
| @@ -4,7 +4,7 @@ import { describe, expect, it } from 'bun:test' | ||
| 4 | 4 | import { parseUnifiedDiff, renderDiffForReview } from '../src/review/diff' |
| 5 | 5 | import { defaultIncludePath, reviewDiff } from '../src/review/engine' |
| 6 | 6 | import { dedupeFindings, fingerprint, validateFindings } from '../src/review/findings' |
| 7 | import { needsReview, parseReviewState, serializeReviewState } from '../src/review/marker' | |
| 7 | import { needsReview, parseReviewState, serializeReviewState, upsertReviewState } from '../src/review/marker' | |
| 8 | 8 | import { prepareReview, renderFinding } from '../src/review/poster' |
| 9 | 9 | |
| 10 | 10 | const SAMPLE_DIFF = `diff --git a/src/app.ts b/src/app.ts |
| @@ -446,3 +446,73 @@ describe('reviewDiff', () => { | ||
| 446 | 446 | expect(ai.requests[0].system).toContain('less certain') |
| 447 | 447 | }) |
| 448 | 448 | }) |
| 449 | ||
| 450 | describe('review state round-trip', () => { | |
| 451 | it('success case - prepareReview exposes the state for the caller to persist', () => { | |
| 452 | // The marker was only ever written into the review summary, which nothing | |
| 453 | // reads back — so `skipIfReviewed` never skipped and dedupe never engaged. | |
| 454 | const prepared = prepareReview( | |
| 455 | { summary: 'Adds logging.', walkthrough: [], findings: [makeFinding()], effort: 2, omittedFiles: [] }, | |
| 456 | { headSha: 'sha123' }, | |
| 457 | ) | |
| 458 | ||
| 459 | expect(prepared.state.reviewedSha).toBe('sha123') | |
| 460 | expect(prepared.state.fingerprints.length).toBeGreaterThan(0) | |
| 461 | }) | |
| 462 | ||
| 463 | it('success case - state written to a PR body is readable again', () => { | |
| 464 | const prepared = prepareReview( | |
| 465 | { summary: 'x', walkthrough: [], findings: [makeFinding()], effort: 1, omittedFiles: [] }, | |
| 466 | { headSha: 'abc' }, | |
| 467 | ) | |
| 468 | ||
| 469 | const body = upsertReviewState('Original description.', prepared.state) | |
| 470 | const read = parseReviewState(body) | |
| 471 | ||
| 472 | expect(read?.reviewedSha).toBe('abc') | |
| 473 | expect(read?.fingerprints).toEqual(prepared.state.fingerprints) | |
| 474 | expect(body).toContain('Original description.') | |
| 475 | }) | |
| 476 | ||
| 477 | it('success case - the round-trip satisfies needsReview', () => { | |
| 478 | // The whole point: a second run at the same commit must skip. | |
| 479 | const prepared = prepareReview( | |
| 480 | { summary: 'x', walkthrough: [], findings: [], effort: 1, omittedFiles: [] }, | |
| 481 | { headSha: 'head-1' }, | |
| 482 | ) | |
| 483 | ||
| 484 | const state = parseReviewState(upsertReviewState('desc', prepared.state)) | |
| 485 | ||
| 486 | expect(needsReview(state, 'head-1')).toBe(false) | |
| 487 | expect(needsReview(state, 'head-2')).toBe(true) | |
| 488 | }) | |
| 489 | ||
| 490 | it('edge case - replaces the existing marker rather than stacking them', () => { | |
| 491 | const first = upsertReviewState('desc', { reviewedSha: 'one', fingerprints: [], reviewedAt: 'x' }) | |
| 492 | const second = upsertReviewState(first, { reviewedSha: 'two', fingerprints: [], reviewedAt: 'y' }) | |
| 493 | ||
| 494 | expect(second.match(/<!--\s*buddy:review/g)).toHaveLength(1) | |
| 495 | expect(parseReviewState(second)?.reviewedSha).toBe('two') | |
| 496 | expect(second).toContain('desc') | |
| 497 | }) | |
| 498 | ||
| 499 | it('edge case - persisting a review does not resume a paused pull request', () => { | |
| 500 | const paused = upsertReviewState('desc', { reviewedSha: 'one', fingerprints: [], reviewedAt: 'x', paused: true }) | |
| 501 | const previous = parseReviewState(paused) | |
| 502 | ||
| 503 | const next = upsertReviewState(paused, { | |
| 504 | reviewedSha: 'two', | |
| 505 | fingerprints: [], | |
| 506 | reviewedAt: 'y', | |
| 507 | ...(previous?.paused ? { paused: true } : {}), | |
| 508 | }) | |
| 509 | ||
| 510 | expect(parseReviewState(next)?.paused).toBe(true) | |
| 511 | }) | |
| 512 | ||
| 513 | it('edge case - tolerates an empty pull request body', () => { | |
| 514 | const body = upsertReviewState(null, { reviewedSha: 'x', fingerprints: [], reviewedAt: 'y' }) | |
| 515 | ||
| 516 | expect(parseReviewState(body)?.reviewedSha).toBe('x') | |
| 517 | }) | |
| 518 | }) | |