Skip to content

Keep committed payload references before summary projection #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmcdaniel merged 1 commit into from
Oct 28, 2026
Merged

Keep committed payload references before summary projection #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions app/Support/ExternalPayloadRetentionCleanup.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,12 +663,16 @@ private function retainedDurableStreamItems(array $deletedRunIds, array $release

/**
* @param list<string> $deletedRunIds
* @return Builder<WorkflowRunSummary>
* @return Builder<WorkflowRun>
*/
private function retainedRunIdsQuery(array $deletedRunIds): Builder
{
return WorkflowRunSummary::query()
// A start commits its run before dispatch publishes the summary. Its
// durable references already protect their objects during that gap.
// Pruned primary rows retain metadata but no longer own payloads.
return WorkflowRun::query()
->select('id')
->whereNull('details_pruned_at')
->whereNotIn('id', $deletedRunIds);
}

Expand Down
39 changes: 34 additions & 5 deletions tests/Feature/WorkflowStreamPayloadRaceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,19 +310,47 @@ public function test_a_workflow_start_holds_its_final_claim_until_its_reference_
&& str_contains($sql, 'runtime_external_payloads');
};

$start = $this->startActor(fn (): array => $this->httpStart('wf-claim-wins-new', $object['reference']), $finalClaim);
$start = $this->startActor(fn (): array => $this->httpStart('wf-claim-wins-new', $object['reference']), [
$finalClaim,
static fn (string $sql, string $driver, int $level): bool => $sql === 'commit' && $level === 0,
]);
$this->runUntilPaused($start);
$cleanup = $this->startActor(fn (): array => HistoryRetentionEnforcer::pruneRun('default', $oldRunId));
$this->release($cleanup);
$this->awaitWait($cleanup, 'runtime_external_payload_object_locks');
$this->resume($start);
$this->assertSame(201, $this->finishActor($start)['status']);
// Cleanup must see the committed reference before the start runs its
// post-commit dispatch/projection work or returns its HTTP response.
$this->resumeUntilPaused($start);
$this->assertTrue($this->finishActor($cleanup)['pruned']);
DB::purge();
DB::reconnect();
$arguments = (string) WorkflowRun::query()->where('workflow_instance_id', 'wf-claim-wins-new')->value('arguments');
$this->assertSame($object['uri'], ExternalPayloads::storedEnvelope($arguments)['external_storage']['uri']);
$this->assertObjectKept($object);
$this->resume($start);
$this->assertSame(201, $this->finishActor($start)['status']);
}

#[DataProvider('drivers')]
public function test_pruned_run_metadata_does_not_keep_a_payload_after_its_last_live_reference_is_pruned(string $driver): void
{
$this->initializeDatabase($driver);
$object = $this->registerObject('pruned-input');
$this->assertSame(201, $this->httpStart('wf-pruned-input', $object['reference'])['status']);
$run = WorkflowRun::query()->where('workflow_instance_id', 'wf-pruned-input')->sole();
$run->forceFill(['status' => RunStatus::Completed, 'closed_at' => now()])->save();
RunSummaryProjector::project($run->fresh());
$otherRunId = $this->summarizedRun('wf-last-input-reference', RunStatus::Completed);
$this->addStream($otherRunId, 'last', [$object['uri']]);

$this->assertTrue(HistoryRetentionEnforcer::pruneRun('default', $run->id)['pruned']);
$pruned = $run->fresh();
$this->assertNotNull($pruned->details_pruned_at);
$this->assertSame($object['uri'], ExternalPayloads::storedEnvelope($pruned->arguments)['external_storage']['uri']);
$this->assertObjectKept($object);

$this->assertTrue(HistoryRetentionEnforcer::pruneRun('default', $otherRunId)['pruned']);
$this->assertObjectDeleted($object);
}

private function httpStart(string $workflowId, array $reference): array
Expand Down Expand Up @@ -415,8 +443,9 @@ protected function tearDown(): void
}

/**
* A run with its summary, as every started run has. Payload cleanup
* counts a reference as retained while its run's summary remains.
* A run with its summary so the retention entry point can locate it.
* Reference checks also cover committed unpruned runs whose dispatch
* has not published a summary yet.
*/
private function summarizedRun(string $workflowId, RunStatus $status = RunStatus::Running): string
{
Expand Down
Loading