Skip to content

docs: a non-running job's cancel emits no job_cancelled - #1485

Merged
brandur merged 2 commits into
riverqueue:masterfrom
JackDanger:docs/job-cancelled-event-scope
Oct 9, 2026
Merged

brandur merged 2 commits into
riverqueue:masterfrom
JackDanger:docs/job-cancelled-event-scope

Conversation

@JackDanger

@JackDanger JackDanger commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

EventKindJobCancelled says it occurs "when a job is cancelled", but events flow from the completer: cancelling an available/scheduled/retryable job finalizes it in the database without an event.

Says so on the event kind; points at the JobRow JobCancel returns.

Found by the river-rs differential verifier.

Client.JobCancel on a job that isn't running (available, scheduled,
retryable) finalizes it in the database and emits no event:
subscribers only see cancellations of jobs a client was working. Say
so on the event kind, and point at the JobRow JobCancel returns.

Signed-off-by: Jack Danger <github@jackcanty.com>
@JackDanger
JackDanger force-pushed the docs/job-cancelled-event-scope branch from 8f84674 to 7077e9c Compare October 9, 2026 04:59
@brandur
brandur marked this pull request as ready for review October 9, 2026 22:39
@brandur

brandur commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

@JackDanger I tweaked the wording a tiny bit here, but yep, looks good to me. Thank you!

@brandur
brandur merged commit e09412c into riverqueue:master Oct 9, 2026
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants