-
Notifications
You must be signed in to change notification settings - Fork 3.9k
fix(async-jobs): retain accepted run IDs for immediate lookup #8490
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.
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
+269
−4
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
130 changes: 130 additions & 0 deletions
130
apps/sim/lib/core/async-jobs/backends/trigger-dev.integration.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| import { db } from '@sim/db' | ||
| import { idempotencyKey } from '@sim/db/schema' | ||
| import { asyncJobsRegionMock } from '@sim/testing/mocks/async-jobs-region.mock' | ||
| import { triggerSdkMock, triggerSdkMockFns } from '@sim/testing/mocks/trigger-sdk.mock' | ||
| import { generateId } from '@sim/utils/id' | ||
| import { inArray } from 'drizzle-orm' | ||
| import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest' | ||
| import { TriggerDevJobQueue } from '@/lib/core/async-jobs/backends/trigger-dev' | ||
|
|
||
| vi.mock('@trigger.dev/sdk', () => triggerSdkMock) | ||
| vi.mock('@/lib/core/async-jobs/region', () => asyncJobsRegionMock) | ||
|
|
||
| const receipts: string[] = [] | ||
| const runs = new Map< | ||
| string, | ||
| { id: string; taskIdentifier: string; status: string; payload: unknown; createdAt: Date } | ||
| >() | ||
|
|
||
| beforeEach(() => { | ||
| triggerSdkMockFns.mockRunsList.mockReset() | ||
| runs.clear() | ||
| triggerSdkMockFns.mockTasksTrigger.mockImplementation(async (type, payload) => { | ||
| const id = `run_${generateId()}` | ||
| runs.set(id, { id, taskIdentifier: type, status: 'QUEUED', payload, createdAt: new Date() }) | ||
| return { id } | ||
| }) | ||
| triggerSdkMockFns.mockRunsRetrieve.mockImplementation(async (id) => { | ||
| const run = runs.get(id) | ||
| if (!run) throw new Error('Run not found') | ||
| return run | ||
| }) | ||
| triggerSdkMockFns.mockRunsCancel.mockImplementation(async (id) => { | ||
| const run = runs.get(id) | ||
| if (!run) throw new Error('Run not found') | ||
| run.status = 'CANCELED' | ||
| return run | ||
| }) | ||
| }) | ||
|
|
||
| afterAll(async () => { | ||
| if (receipts.length) await db.delete(idempotencyKey).where(inArray(idempotencyKey.key, receipts)) | ||
| }) | ||
|
|
||
| async function enqueue() { | ||
| const executionId = generateId() | ||
| const workflowId = generateId() | ||
| const rootJobId = `workflow-execution:${executionId}` | ||
| receipts.push(`trigger-job:${rootJobId}`) | ||
| const id = await new TriggerDevJobQueue().enqueue( | ||
| 'workflow-execution', | ||
| { executionId, workflowId }, | ||
| { jobId: rootJobId } | ||
| ) | ||
| return { id, binding: { workflowId, executionId, rootJobId } } | ||
| } | ||
|
|
||
| describe('accepted Trigger runs before tag indexing', () => { | ||
| it('persists a receipt and lets another queue instance read the accepted run', async () => { | ||
| const { id, binding } = await enqueue() | ||
| const reader = new TriggerDevJobQueue() | ||
| expect(await reader.getJob(binding.rootJobId)).toMatchObject({ | ||
| id, | ||
| status: 'pending', | ||
| metadata: { workflowId: binding.workflowId }, | ||
| }) | ||
| const stored = await db | ||
| .select() | ||
| .from(idempotencyKey) | ||
| .where(inArray(idempotencyKey.key, receipts)) | ||
| expect( | ||
| stored.some( | ||
| (row) => | ||
| row.key === `trigger-job:${binding.rootJobId}` && | ||
| (row.result as { runId: string }).runId === id | ||
| ) | ||
| ).toBe(true) | ||
| }) | ||
|
|
||
| it('cancels an accepted run while every tag search is still empty', async () => { | ||
| const { id, binding } = await enqueue() | ||
| expect(await new TriggerDevJobQueue().cancelByExecution(binding, 'standalone')).toBe(1) | ||
| expect(runs.get(id)?.status).toBe('CANCELED') | ||
| }) | ||
|
|
||
| it('keeps a retry discoverable and cancels a run only once when its tags catch up', async () => { | ||
| const { id, binding } = await enqueue() | ||
| triggerSdkMockFns.mockTasksTrigger.mockResolvedValueOnce({ id }) | ||
| await new TriggerDevJobQueue().enqueue( | ||
| 'workflow-execution', | ||
| { | ||
| workflowId: binding.workflowId, | ||
| executionId: binding.executionId, | ||
| }, | ||
| { jobId: binding.rootJobId } | ||
| ) | ||
| triggerSdkMockFns.mockRunsList.mockImplementation(() => ({ | ||
| async *[Symbol.asyncIterator]() { | ||
| yield { | ||
| id, | ||
| taskIdentifier: 'workflow-execution', | ||
| tags: [`workflowId:${binding.workflowId}`, `executionId:${binding.executionId}`], | ||
| } | ||
| }, | ||
| })) | ||
| const queue = new TriggerDevJobQueue() | ||
| expect(await queue.getJob(binding.rootJobId)).toMatchObject({ id }) | ||
| expect(await queue.cancelByExecution(binding, 'standalone')).toBe(1) | ||
| expect(runs.get(id)?.status).toBe('CANCELED') | ||
| }) | ||
|
|
||
| it('does not cancel a receipt belonging to another workflow or cancellation scope', async () => { | ||
| const { id, binding } = await enqueue() | ||
| const queue = new TriggerDevJobQueue() | ||
| expect( | ||
| await queue.cancelByExecution({ ...binding, workflowId: generateId() }, 'standalone') | ||
| ).toBe(0) | ||
| expect( | ||
| await queue.cancelByExecution({ ...binding, executionId: generateId() }, 'standalone') | ||
| ).toBe(0) | ||
| expect(await queue.cancelByExecution(binding, 'resume')).toBe(0) | ||
| expect(runs.get(id)?.status).toBe('QUEUED') | ||
| }) | ||
|
|
||
| it('does not report a completed receipt as a successful cancellation', async () => { | ||
| const { id, binding } = await enqueue() | ||
| runs.get(id)!.status = 'COMPLETED' | ||
| expect(await new TriggerDevJobQueue().cancelByExecution(binding, 'standalone')).toBe(0) | ||
| expect(runs.get(id)?.status).toBe('COMPLETED') | ||
| }) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.