Skip to content

chore(api): describe the settled-pause rule in the run status overlay TSDoc #9957

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
waleedlatif1 merged 1 commit into from
Nov 12, 2026
+11 −10
Merged

chore(api): describe the settled-pause rule in the run status overlay TSDoc #9957

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
10 changes: 5 additions & 5 deletions apps/sim/lib/api/contracts/v2/logs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@ const v2LogDetailCostSchema = z
*
* That pass-through is also why this field disagrees with the run resources for the
* same run, and the disagreement is documented rather than reconciled. The run list
* projects `paused` over the persisted value whenever the run holds a `paused` or
* `partially_resumed` row in `paused_executions` (`executionStatus` in
* `lib/workflows/executor/execution-queries.ts`), so an ordinary human-in-the-loop
* projects `paused` over the persisted value while the run holds a `paused` or
* `partially_resumed` row in `paused_executions` with a point still to resume
* (`executionStatus` in `lib/workflows/executor/execution-queries.ts`), so an ordinary human-in-the-loop
* pause reads `paused` there and `pending` here. Adopting the overlay would need this
* read to join `paused_executions`, and would silently move live runs between the
* `pending` and `paused` buckets of a shipped field that internal log consumers read
* from the same query — a breaking change, not a correction. Callers that need the
* pause distinction read the run resources, which also carry the `paused` object that
* separates "waiting on a human" from "a resume attempt failed".
* pause distinction read the run resources, which also carry the `paused` object with the
* pause kind, resume time, and any automatic-resume waiting reason.
*/
export const v2LogStatusSchema = z
.enum(PERSISTED_WORKFLOW_EXECUTION_STATUSES)
Expand Down
11 changes: 6 additions & 5 deletions apps/sim/lib/api/contracts/v2/workflows.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1988,11 +1988,12 @@ const RUN_STATUS_DESCRIPTION =
/**
* The list projection passes `workflow_execution_logs.status` through except where it
* overlays `paused` for a run holding a `paused` or `partially_resumed` row in
* `paused_executions` — so a reported `paused` is either that overlay or the persisted
* value a failed resume attempt left behind. Both branches land in the persisted set, so the reported enum is
* derived from it — a value missing here fails the response parse, and because list
* validation is whole-page one such row turns an entire page into a 500. `queued` is not
* reportable: a run still only in the job queue has no log row to list.
* `paused_executions` that still has a point to resume (a finished run whose every point
* resumed or failed reads its log status). A reported `paused` is either that overlay or the
Comment on lines +1991 to +1992

@greptile-apps greptile-apps Bot Nov 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Comments narrow the pause rule

The new wording requires an unsettled pause point for every paused overlay. But executionStatus checks whether all points have settled only when the log is completed, failed, or cancelled. For other log statuses, an open pause record still wins regardless of its points.

Describe the actual exception: an open pause record reads paused unless the log has finished and every point has resumed or failed. Use the same wording in logs.ts. This keeps maintainers from copying a stricter rule into another status read.

* persisted value a failed resume attempt left behind. Both branches land in the persisted
* set, so the reported enum is derived from it — a value missing here fails the response
* parse, and because list validation is whole-page one such row turns an entire page into a
* 500. `queued` is not reportable: a run still only in the job queue has no log row to list.
*/
export const v2WorkflowRunListStatusValueSchema = z
.enum(PERSISTED_WORKFLOW_EXECUTION_STATUSES)
Expand Down
Loading