Skip to content

fix(resume): require write access to resume a paused run on the legacy route #8896

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

Open
waleedlatif1 wants to merge 2 commits into
base: staging
Choose a base branch
from
Open

fix(resume): require write access to resume a paused run on the legacy route #8896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6f8799
fix(resume): require write access to resume a paused run on the legac…
waleedlatif1 Oct 10, 2026
a53667e
fix(resume): let unexpected resume failures reach the route handler a…
waleedlatif1 Oct 10, 2026
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
188 changes: 119 additions & 69 deletions apps/sim/app/api/resume/[workflowId]/[executionId]/[contextId]/route.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { createWorkspaceApiKeyPrincipal } from '@sim/testing/factories/principal.factory'
import { createRouteContext } from '@sim/testing/helpers/http'
import { asyncJobsMock, asyncJobsMockFns } from '@sim/testing/mocks/async-jobs.mock'
import { authMockFns } from '@sim/testing/mocks/auth.mock'
import {
executionPreprocessingMock,
executionPreprocessingMockFns,
Expand All @@ -10,20 +12,30 @@ import {
} from '@sim/testing/mocks/human-in-the-loop-manager.mock'
import { idMock, idMockFns } from '@sim/testing/mocks/id.mock'
import { createMockRequest } from '@sim/testing/mocks/request.mock'
import {
workflowContextMock,
workflowContextMockFns,
} from '@sim/testing/mocks/workflow-context.mock'
import { workspaceAuthzMock, workspaceAuthzMockFns } from '@sim/testing/mocks/workspace-authz.mock'
import {
workspacesUtilsMock,
workspacesUtilsMockFns,
} from '@sim/testing/mocks/workspaces-utils.mock'
import { beforeEach, describe, expect, it, vi } from 'vitest'

const { mockValidateWorkflowAccess } = vi.hoisted(() => ({
mockValidateWorkflowAccess: vi.fn(),
const { mockAuthenticateApiKey } = vi.hoisted(() => ({
mockAuthenticateApiKey: vi.fn(),
}))

vi.mock('@/app/api/workflows/middleware', () => ({
validateWorkflowAccess: mockValidateWorkflowAccess,
vi.mock('@/lib/api-key/service', () => ({
authenticateApiKeyFromHeader: mockAuthenticateApiKey,
updateApiKeyLastUsed: vi.fn(),
}))

vi.mock('@sim/platform-authz/workspace', () => workspaceAuthzMock)

vi.mock('@/lib/workflows/application/context', () => workflowContextMock)

vi.mock('@/lib/execution/preprocessing', () => executionPreprocessingMock)

vi.mock('@/lib/core/async-jobs', () => asyncJobsMock)
Expand All @@ -38,11 +50,13 @@ vi.mock('@/lib/workspaces/utils', () => workspacesUtilsMock)

vi.mock('@/lib/workflows/executor/human-in-the-loop-manager', () => humanInTheLoopManagerMock)

import { resumeWorkflowRun } from '@/lib/workflows/application/resume-run'
import { POST } from '@/app/api/resume/[workflowId]/[executionId]/[contextId]/route'
import { handleResumeExecution } from '@/app/api/resume/resume-handler'

const { mockEnqueueOrStartResume, mockGetPausedExecutionDetail } = humanInTheLoopManagerMockFns
const { mockGetWorkspaceBilledAccountUserId: mockGetCurrentPayer } = workspacesUtilsMockFns
const mockResolvePermission = workspaceAuthzMockFns.mockResolveEffectiveWorkspacePermission
const mockResolveRunContext = workflowContextMockFns.mockResolveActiveWorkflowRunApplicationContext

const { mockShouldExecuteInline } = asyncJobsMockFns
mockShouldExecuteInline.mockReturnValue(false)
Expand All @@ -57,6 +71,11 @@ const EXECUTION_ID = 'execution-1'
const CONTEXT_ID = 'context-1'
const WORKSPACE_ID = 'workspace-1'
const PERSISTED_ACTOR_ID = 'original-actor'
const WORKSPACE_BILLING_OWNER_ID = 'current-workspace-owner'
const WORKSPACE_KEY_PRINCIPAL = createWorkspaceApiKeyPrincipal({
workspaceId: WORKSPACE_ID,
keyId: 'workspace-key',
})

const PERSISTED_ATTRIBUTION = {
actorUserId: PERSISTED_ACTOR_ID,
Expand Down Expand Up @@ -139,13 +158,17 @@ function makeRequest(
executionId: EXECUTION_ID,
contextId: CONTEXT_ID,
},
body = JSON.stringify({ input: { approved: true } })
body = JSON.stringify({ input: { approved: true } }),
apiKey: string | null = 'sim_workspace_key'
) {
return {
request: createMockRequest({
method: 'POST',
url: `http://localhost/api/resume/${params.workflowId}/${params.executionId}/${params.contextId}`,
headers: { 'Content-Type': 'application/json' },
headers: {
'Content-Type': 'application/json',
...(apiKey ? { 'x-api-key': apiKey } : {}),
},
rawBody: body,
}),
context: createRouteContext(params),
Expand All @@ -154,20 +177,23 @@ function makeRequest(

describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
beforeEach(() => {
mockValidateWorkflowAccess.mockResolvedValue({
workflow: {
id: WORKFLOW_ID,
workspaceId: WORKSPACE_ID,
},
auth: {
success: true,
userId: 'current-api-key-user',
authType: 'api_key',
apiKeyType: 'workspace',
workspaceId: WORKSPACE_ID,
},
mockAuthenticateApiKey.mockResolvedValue({
success: true,
keyId: WORKSPACE_KEY_PRINCIPAL.keyId,
keyType: 'workspace',
workspaceId: WORKSPACE_ID,
})
mockResolvePermission.mockResolvedValue('write')
mockResolveRunContext.mockResolvedValue({
workflowId: WORKFLOW_ID,
workflow: { id: WORKFLOW_ID, workspaceId: WORKSPACE_ID },
workspaceId: WORKSPACE_ID,
workspaceOrganizationId: null,
allowPersonalApiKeys: true,
billedAccountUserId: WORKSPACE_BILLING_OWNER_ID,
runId: EXECUTION_ID,
})
mockGetCurrentPayer.mockResolvedValue('current-workspace-owner')
mockGetCurrentPayer.mockResolvedValue(WORKSPACE_BILLING_OWNER_ID)
mockGetPausedExecutionDetail.mockResolvedValue(createPausedExecution())
mockPreprocessExecution.mockResolvedValue({
success: true,
Expand All @@ -183,9 +209,7 @@ describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
})

it('returns 401 before validating malformed route input', async () => {
mockValidateWorkflowAccess.mockResolvedValueOnce({
error: { message: 'Unauthorized', status: 401 },
})
mockAuthenticateApiKey.mockResolvedValueOnce({ success: false })
const { request, context } = makeRequest(
{
workflowId: WORKFLOW_ID,
Expand All @@ -198,18 +222,62 @@ describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
const response = await POST(request, context)

expect(response.status).toBe(401)
expect(await response.json()).toEqual({ error: 'Unauthorized' })
expect(mockValidateWorkflowAccess).toHaveBeenCalledWith(request, WORKFLOW_ID, false)
expect(await response.json()).toMatchObject({ error: 'Unauthorized' })
expect(mockResolveRunContext).not.toHaveBeenCalled()
expect(mockGetPausedExecutionDetail).not.toHaveBeenCalled()
expect(mockPreprocessExecution).not.toHaveBeenCalled()
})

it.each([
{
name: 'session',
apiKey: null,
setup: () =>
authMockFns.mockGetSession.mockResolvedValueOnce({
user: { id: 'read-only-member' },
session: { id: 'session-1' },
}),
},
{
name: 'personal API key',
apiKey: 'sim_personal_key',
setup: () =>
mockAuthenticateApiKey.mockResolvedValue({
success: true,
keyId: 'personal-key',
keyType: 'personal',
userId: 'read-only-member',
}),
},
])('refuses a resume from a read-only member over $name auth', async ({ apiKey, setup }) => {
setup()
mockResolvePermission.mockResolvedValue('read')
const { request, context } = makeRequest(undefined, undefined, apiKey)

const response = await POST(request, context)

expect(response.status).toBe(403)
expect(mockGetPausedExecutionDetail).not.toHaveBeenCalled()
expect(mockPreprocessExecution).not.toHaveBeenCalled()
expect(mockEnqueueOrStartResume).not.toHaveBeenCalled()
})

it('answers an unexpected run-context failure with a generic 500', async () => {
mockResolveRunContext.mockRejectedValueOnce(new Error('connection terminated: db-internal'))
const { request, context } = makeRequest()

const response = await POST(request, context)

expect(response.status).toBe(500)
expect(await response.json()).toMatchObject({ error: 'Internal server error' })
expect(mockEnqueueOrStartResume).not.toHaveBeenCalled()
})

it('reuses the persisted actor and payer snapshot for route preflight', async () => {
const { request, context } = makeRequest()

const response = await POST(request, context)

expect(mockValidateWorkflowAccess).toHaveBeenCalledWith(request, WORKFLOW_ID, false)
expect(response.status).toBe(200)
expect(mockGetCurrentPayer).not.toHaveBeenCalled()
expect(mockGetPausedExecutionDetail).toHaveBeenCalledWith({
Expand All @@ -219,7 +287,7 @@ describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
expect(mockPreprocessExecution).toHaveBeenCalledWith(
expect.objectContaining({
workflowId: WORKFLOW_ID,
userId: 'current-api-key-user',
userId: WORKSPACE_BILLING_OWNER_ID,
workspaceId: WORKSPACE_ID,
billingAttribution: PERSISTED_ATTRIBUTION,
executionId: 'resume-preflight-1',
Expand All @@ -234,7 +302,7 @@ describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
workflowId: WORKFLOW_ID,
contextId: CONTEXT_ID,
resumeInput: { approved: true },
userId: 'current-api-key-user',
userId: WORKSPACE_BILLING_OWNER_ID,
allowedPauseKinds: ['human'],
})
})
Expand All @@ -250,7 +318,7 @@ describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
pausedExecution: { id: 'paused-execution-1' },
contextId: CONTEXT_ID,
resumeInput: { approved: true },
userId: 'current-api-key-user',
userId: WORKSPACE_BILLING_OWNER_ID,
})
const { request, context } = makeRequest()

Expand Down Expand Up @@ -286,30 +354,21 @@ describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
pausedExecution: { id: 'paused-execution-1' },
contextId: CONTEXT_ID,
resumeInput: { approved: true },
userId: 'current-api-key-user',
userId: WORKSPACE_BILLING_OWNER_ID,
})
const { request } = makeRequest()

const response = await handleResumeExecution({
request,
workflowId: WORKFLOW_ID,
executionId: EXECUTION_ID,
contextId: CONTEXT_ID,
workspaceId: WORKSPACE_ID,
userId: 'current-api-key-user',
resumeInput: { approved: true },
isApiCaller: true,
pollingSurface: 'v2',
const result = await resumeWorkflowRun.execute({
principal: WORKSPACE_KEY_PRINCIPAL,
input: {
workflowId: WORKFLOW_ID,
runId: EXECUTION_ID,
contextId: CONTEXT_ID,
resumeInput: { approved: true },
surface: 'v2',
},
})

expect(response.status).toBe(202)
await expect(response.json()).resolves.toEqual({
success: true,
async: true,
executionId: 'resume-execution-1',
message: 'Resume execution queued',
statusUrl: 'https://test.sim.ai/api/v2/workflows/workflow-1/runs/resume-execution-1',
})
expect(result).toMatchObject({ kind: 'async', executionId: 'resume-execution-1' })
expect(mockEnqueueResume).toHaveBeenCalledWith(
'resume-execution',
expect.objectContaining({ resumeExecutionId: 'resume-execution-1' }),
Expand All @@ -331,30 +390,21 @@ describe('POST /api/resume/[workflowId]/[executionId]/[contextId]', () => {
pausedExecution: { id: 'paused-execution-1' },
contextId: CONTEXT_ID,
resumeInput: { approved: true },
userId: 'current-api-key-user',
userId: WORKSPACE_BILLING_OWNER_ID,
})
const { request } = makeRequest()

const response = await handleResumeExecution({
request,
workflowId: WORKFLOW_ID,
executionId: EXECUTION_ID,
contextId: CONTEXT_ID,
workspaceId: WORKSPACE_ID,
userId: 'current-api-key-user',
resumeInput: { approved: true },
isApiCaller: true,
pollingSurface: 'v2',
allowStreaming: false,
const result = await resumeWorkflowRun.execute({
principal: WORKSPACE_KEY_PRINCIPAL,
input: {
workflowId: WORKFLOW_ID,
runId: EXECUTION_ID,
contextId: CONTEXT_ID,
resumeInput: { approved: true },
surface: 'v2',
},
})

expect(response.status).toBe(202)
expect(response.headers.get('Content-Type')).toContain('application/json')
await expect(response.json()).resolves.toMatchObject({
async: true,
executionId: 'resume-execution-1',
statusUrl: 'https://test.sim.ai/api/v2/workflows/workflow-1/runs/resume-execution-1',
})
expect(result).toMatchObject({ kind: 'async', executionId: 'resume-execution-1' })
expect(mockEnqueueResume).toHaveBeenCalledWith(
'resume-execution',
expect.objectContaining({ resumeExecutionId: 'resume-execution-1' }),
Expand Down
Loading
Loading