|
| 1 | +/** |
| 2 | + * @vitest-environment node |
| 3 | + */ |
| 4 | +import { beforeEach, describe, expect, it, vi } from 'vitest' |
| 5 | + |
| 6 | +const { mockPerformFullDeploy } = vi.hoisted(() => ({ |
| 7 | + mockPerformFullDeploy: vi.fn(), |
| 8 | +})) |
| 9 | + |
| 10 | +vi.mock('@/lib/workflows/orchestration/deploy', () => ({ |
| 11 | + performFullDeploy: mockPerformFullDeploy, |
| 12 | +})) |
| 13 | + |
| 14 | +import { |
| 15 | + backfillTableWorkflowDeployments, |
| 16 | + deployTableWorkflow, |
| 17 | + TABLE_WORKFLOW_DEPLOYMENT_BATCH_SIZE, |
| 18 | + type TableWorkflowDeploymentCandidate, |
| 19 | + type TableWorkflowDeploymentStore, |
| 20 | +} from '@/scripts/backfill-table-workflow-deployments' |
| 21 | + |
| 22 | +function candidate(workflowId: string): TableWorkflowDeploymentCandidate { |
| 23 | + return { |
| 24 | + workflowId, |
| 25 | + workspaceId: 'workspace-1', |
| 26 | + userId: 'user-1', |
| 27 | + } |
| 28 | +} |
| 29 | + |
| 30 | +function store( |
| 31 | + overrides: Partial<TableWorkflowDeploymentStore> = {} |
| 32 | +): TableWorkflowDeploymentStore { |
| 33 | + return { |
| 34 | + assertIntegrity: vi.fn().mockResolvedValue(undefined), |
| 35 | + listCandidates: vi.fn().mockResolvedValue([]), |
| 36 | + isDeployed: vi.fn().mockResolvedValue(false), |
| 37 | + ...overrides, |
| 38 | + } |
| 39 | +} |
| 40 | + |
| 41 | +describe('backfillTableWorkflowDeployments', () => { |
| 42 | + beforeEach(() => { |
| 43 | + vi.clearAllMocks() |
| 44 | + }) |
| 45 | + |
| 46 | + it('deploys bounded keyset pages and verifies the final desired state', async () => { |
| 47 | + const listCandidates = vi |
| 48 | + .fn<TableWorkflowDeploymentStore['listCandidates']>() |
| 49 | + .mockResolvedValueOnce([candidate('workflow-a'), candidate('workflow-b')]) |
| 50 | + .mockResolvedValueOnce([candidate('workflow-c')]) |
| 51 | + .mockResolvedValueOnce([]) |
| 52 | + .mockResolvedValueOnce([]) |
| 53 | + const deploymentState = new Map<string, boolean>() |
| 54 | + const isDeployed = vi |
| 55 | + .fn<TableWorkflowDeploymentStore['isDeployed']>() |
| 56 | + .mockImplementation(async (workflowId) => deploymentState.get(workflowId) ?? false) |
| 57 | + const deploy = vi.fn(async (workflow: TableWorkflowDeploymentCandidate) => { |
| 58 | + deploymentState.set(workflow.workflowId, true) |
| 59 | + return { |
| 60 | + success: true, |
| 61 | + activeDeployment: { |
| 62 | + deploymentVersionId: `version-${workflow.workflowId}`, |
| 63 | + version: 1, |
| 64 | + deployedAt: new Date().toISOString(), |
| 65 | + }, |
| 66 | + } |
| 67 | + }) |
| 68 | + const backfillStore = store({ listCandidates, isDeployed }) |
| 69 | + |
| 70 | + await expect( |
| 71 | + backfillTableWorkflowDeployments(backfillStore, deploy, { batchSize: 2 }) |
| 72 | + ).resolves.toEqual({ |
| 73 | + scanned: 3, |
| 74 | + deployed: 3, |
| 75 | + alreadyDeployed: 0, |
| 76 | + }) |
| 77 | + expect(listCandidates.mock.calls).toEqual([ |
| 78 | + ['', 2], |
| 79 | + ['workflow-b', 2], |
| 80 | + ['workflow-c', 2], |
| 81 | + ['', 1], |
| 82 | + ]) |
| 83 | + expect(backfillStore.assertIntegrity).toHaveBeenCalledTimes(2) |
| 84 | + expect(deploy.mock.calls.map(([workflow]) => workflow.workflowId)).toEqual([ |
| 85 | + 'workflow-a', |
| 86 | + 'workflow-b', |
| 87 | + 'workflow-c', |
| 88 | + ]) |
| 89 | + }) |
| 90 | + |
| 91 | + it('does not redeploy an already deployed workflow', async () => { |
| 92 | + const listCandidates = vi |
| 93 | + .fn<TableWorkflowDeploymentStore['listCandidates']>() |
| 94 | + .mockResolvedValueOnce([candidate('workflow-a')]) |
| 95 | + .mockResolvedValueOnce([]) |
| 96 | + .mockResolvedValueOnce([]) |
| 97 | + const deploy = vi.fn() |
| 98 | + |
| 99 | + await expect( |
| 100 | + backfillTableWorkflowDeployments( |
| 101 | + store({ |
| 102 | + listCandidates, |
| 103 | + isDeployed: vi.fn().mockResolvedValue(true), |
| 104 | + }), |
| 105 | + deploy |
| 106 | + ) |
| 107 | + ).resolves.toEqual({ |
| 108 | + scanned: 1, |
| 109 | + deployed: 0, |
| 110 | + alreadyDeployed: 1, |
| 111 | + }) |
| 112 | + expect(deploy).not.toHaveBeenCalled() |
| 113 | + }) |
| 114 | + |
| 115 | + it('fails fast when canonical deployment fails', async () => { |
| 116 | + const listCandidates = vi |
| 117 | + .fn<TableWorkflowDeploymentStore['listCandidates']>() |
| 118 | + .mockResolvedValueOnce([candidate('workflow-a'), candidate('workflow-b')]) |
| 119 | + const deploy = vi.fn().mockResolvedValue({ |
| 120 | + success: false, |
| 121 | + error: 'invalid trigger configuration', |
| 122 | + }) |
| 123 | + |
| 124 | + await expect( |
| 125 | + backfillTableWorkflowDeployments(store({ listCandidates }), deploy) |
| 126 | + ).rejects.toThrow('Failed to deploy table workflow workflow-a: invalid trigger configuration') |
| 127 | + expect(deploy).toHaveBeenCalledTimes(1) |
| 128 | + }) |
| 129 | + |
| 130 | + it('fails when deployment does not activate or persist a valid active version', async () => { |
| 131 | + const firstList = vi |
| 132 | + .fn<TableWorkflowDeploymentStore['listCandidates']>() |
| 133 | + .mockResolvedValueOnce([candidate('workflow-a')]) |
| 134 | + await expect( |
| 135 | + backfillTableWorkflowDeployments(store({ listCandidates: firstList }), async () => ({ |
| 136 | + success: true, |
| 137 | + activeDeployment: null, |
| 138 | + })) |
| 139 | + ).rejects.toThrow('did not reach an active deployment state') |
| 140 | + |
| 141 | + const secondList = vi |
| 142 | + .fn<TableWorkflowDeploymentStore['listCandidates']>() |
| 143 | + .mockResolvedValueOnce([candidate('workflow-b')]) |
| 144 | + await expect( |
| 145 | + backfillTableWorkflowDeployments(store({ listCandidates: secondList }), async () => ({ |
| 146 | + success: true, |
| 147 | + activeDeployment: { |
| 148 | + deploymentVersionId: 'version-b', |
| 149 | + version: 1, |
| 150 | + deployedAt: new Date().toISOString(), |
| 151 | + }, |
| 152 | + })) |
| 153 | + ).rejects.toThrow('completed without a valid active version') |
| 154 | + }) |
| 155 | + |
| 156 | + it('rejects invalid batch and page behavior before it can loop or skip data', async () => { |
| 157 | + const invalidBatchStore = store() |
| 158 | + await expect( |
| 159 | + backfillTableWorkflowDeployments(invalidBatchStore, vi.fn(), { batchSize: 0 }) |
| 160 | + ).rejects.toThrow('positive integer') |
| 161 | + expect(invalidBatchStore.assertIntegrity).not.toHaveBeenCalled() |
| 162 | + |
| 163 | + const oversizedStore = store({ |
| 164 | + listCandidates: vi.fn().mockResolvedValue([candidate('workflow-a'), candidate('workflow-b')]), |
| 165 | + }) |
| 166 | + await expect( |
| 167 | + backfillTableWorkflowDeployments(oversizedStore, vi.fn(), { batchSize: 1 }) |
| 168 | + ).rejects.toThrow('oversized page') |
| 169 | + |
| 170 | + const duplicateStore = store({ |
| 171 | + listCandidates: vi.fn().mockResolvedValue([candidate('workflow-a'), candidate('workflow-a')]), |
| 172 | + }) |
| 173 | + await expect( |
| 174 | + backfillTableWorkflowDeployments(duplicateStore, vi.fn(), { batchSize: 2 }) |
| 175 | + ).rejects.toThrow('duplicate workflow ids') |
| 176 | + }) |
| 177 | + |
| 178 | + it('uses the canonical deployer with backfill attribution and a stable idempotency key', async () => { |
| 179 | + mockPerformFullDeploy.mockResolvedValue({ |
| 180 | + success: true, |
| 181 | + activeDeployment: { |
| 182 | + deploymentVersionId: 'version-1', |
| 183 | + version: 1, |
| 184 | + deployedAt: new Date().toISOString(), |
| 185 | + }, |
| 186 | + }) |
| 187 | + |
| 188 | + await deployTableWorkflow(candidate('workflow-1')) |
| 189 | + |
| 190 | + expect(mockPerformFullDeploy).toHaveBeenCalledWith({ |
| 191 | + workflowId: 'workflow-1', |
| 192 | + userId: 'user-1', |
| 193 | + actorId: 'table-workflow-deployment-backfill', |
| 194 | + captureAnalytics: false, |
| 195 | + requestId: 'table-workflow-deployment-backfill:v2:workflow-1', |
| 196 | + idempotencyKey: 'table-workflow-deployment-backfill:v2:workflow-1', |
| 197 | + }) |
| 198 | + }) |
| 199 | + |
| 200 | + it('uses the repository batch-size default', async () => { |
| 201 | + const listCandidates = vi.fn().mockResolvedValue([]) |
| 202 | + |
| 203 | + await backfillTableWorkflowDeployments(store({ listCandidates }), vi.fn()) |
| 204 | + |
| 205 | + expect(listCandidates).toHaveBeenNthCalledWith(1, '', TABLE_WORKFLOW_DEPLOYMENT_BATCH_SIZE) |
| 206 | + }) |
| 207 | +}) |
0 commit comments