improvement(workflows): unify run cancellation

Author: j15z

apps/docs/openapi-v2-workflows.json

@@ -9986,7 +9986,7 @@
           },
           "durablyRecorded": {
             "type": "boolean",
-            "description": "Whether this request durably recorded a cancellation. Always false for a run that was already terminal, where the request is satisfied but nothing was written."
+            "description": "Whether this request durably recorded a cancellation. False when an already-cancelled run needed no further durable write."
           },
           "locallyAborted": {
             "type": "boolean",
@@ -9997,7 +9997,7 @@
             "description": "Whether a paused execution was cancelled."
           },
           "reason": {
-            "description": "Machine-readable cancellation outcome, present on every cancellation including full successes. `recorded` is the success value. `already_cancelled`, `already_completed`, and `already_failed` mean the run had already reached that terminal state, so nothing was cancelled and `durablyRecorded` is false. `redis_unavailable` and `redis_write_failed` mean the distributed cancellation signal was not written, so an already-running execution may not observe the cancellation. `paused_event_publish_failed` and `paused_database_cancel_failed` name the failing step for a paused run.",
+            "description": "Machine-readable cancellation outcome. `recorded`, `queue_cancelled`, and `already_cancelled` are successful outcomes; the remaining values identify a degraded or incomplete cancellation step.",
             "type": "string",
             "enum": [
               "recorded",
@@ -10007,7 +10007,10 @@
               "redis_unavailable",
               "redis_write_failed",
               "paused_event_publish_failed",
-              "paused_database_cancel_failed"
+              "paused_database_cancel_failed",
+              "queue_cancelled",
+              "active_resume_signal_failed",
+              "cancellation_not_finalized"
             ]
           }
         },
@@ -10021,7 +10024,7 @@
         ],
         "additionalProperties": false,
         "title": "Cancel workflow run result",
-        "description": "Outcome of a workflow run cancellation request. Cancellation is best-effort: a run already in a terminal state succeeds with no effect, reported as `durablyRecorded: false` with an `already_*` reason naming the state observed."
+        "description": "Outcome of the shared workflow-run cancellation lifecycle used by internal UI, Copilot, and v2 callers."
       },
       "CancelWorkflowRunResponse": {
         "type": "object",

apps/sim/app/api/v2/workflows/[workflowId]/runs/[runId]/cancel/route.test.ts

@@ -14,12 +14,10 @@ import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 const mocks = vi.hoisted(() => ({
   cancel: vi.fn(),
-  capture: vi.fn(),
 }))
 
 vi.mock('@/lib/api/server/routes/v2-api-key-auth', () => v2ApiKeyAuthModuleMock)
 vi.mock('@/lib/core/rate-limiter', () => v2RateLimiterModuleMock)
-vi.mock('@/lib/posthog/server', () => ({ captureServerEvent: mocks.capture }))
 vi.mock('@/lib/workflows/application/cancel-run', () => ({
   cancelWorkflowRun: { operation: { id: 'workflows.runs.cancel' }, execute: mocks.cancel },
 }))
@@ -91,18 +89,10 @@ describe('POST /api/v2/workflows/[workflowId]/runs/[runId]/cancel', () => {
     })
   })
 
-  /**
-   * The published outcome of a cancel against a run that had already finished.
-   * `durablyRecorded: true` here is the defect this suite pins: nothing was
-   * written, so a caller reconciling on that flag would trust a write that never
-   * happened.
-   */
-  it.each([
-    ['cancelled', 'already_cancelled'],
-    ['completed', 'already_completed'],
-    ['failed', 'already_failed'],
-  ])('reports a terminal %s run as a no-op the caller can tell apart', async (_status, reason) => {
-    mocks.cancel.mockResolvedValue(serviceResult({ success: true, durablyRecorded: false, reason }))
+  it('reports an already-cancelled run as an idempotent no-op', async () => {
+    mocks.cancel.mockResolvedValue(
+      serviceResult({ success: true, durablyRecorded: false, reason: 'already_cancelled' })
+    )
 
     const response = await POST(request(), context)
 
@@ -111,7 +101,7 @@ describe('POST /api/v2/workflows/[workflowId]/runs/[runId]/cancel', () => {
       success: true,
       runId: RUN_ID,
       durablyRecorded: false,
-      reason,
+      reason: 'already_cancelled',
     })
   })
 })

apps/sim/app/api/v2/workflows/[workflowId]/runs/[runId]/cancel/route.ts

@@ -1,6 +1,5 @@
 import { v2CancelWorkflowRunContract } from '@/lib/api/contracts/v2/workflows'
 import { defineV2JsonRoute, v2ApiKeyAuth, v2RateLimits } from '@/lib/api/server/routes'
-import { captureServerEvent } from '@/lib/posthog/server'
 import { v2WorkflowErrorPolicies } from '@/lib/workflows/api'
 import { cancelWorkflowRun } from '@/lib/workflows/application/cancel-run'
 import { workflowOperations } from '@/lib/workflows/application/operations'
@@ -27,21 +26,4 @@ export const POST = defineV2JsonRoute({
       reason: result.reason,
     },
   }),
-  /**
-   * Reports a cancellation, so it needs the run to have actually been
-   * cancelled. `success` alone no longer implies that: a cancel against an
-   * already-terminal run satisfies the request without writing anything, and
-   * reports `success: true` with `durablyRecorded: false`. Requiring both also
-   * keeps the event off a cancellation that reached the row but failed its
-   * paused reconciliation, which reports the inverse pair.
-   */
-  onSuccess: ({ principal, result }) => {
-    if (!result.success || !result.durablyRecorded || principal.kind !== 'personal_api_key') return
-    captureServerEvent(
-      principal.userId,
-      'workflow_execution_cancelled',
-      { workflow_id: result.workflowId, workspace_id: result.workspaceId },
-      { groups: { workspace: result.workspaceId } }
-    )
-  },
 })