forked from Disciplr-Org/Disciplr-backend
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathjobs.deadletter.test.ts
More file actions
216 lines (184 loc) · 7.07 KB
/
Copy pathjobs.deadletter.test.ts
File metadata and controls
216 lines (184 loc) · 7.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
import express from 'express'
import request from 'supertest'
import { describe, expect, it, beforeAll, jest } from '@jest/globals'
import { InMemoryJobQueue } from '../jobs/queue.js'
import { generateValidToken, UserRole } from './helpers/rbacTestUtils.js'
import type { QueueMetrics } from '../jobs/queue.js'
import type { RequestHandler } from 'express'
jest.unstable_mockModule('../lib/audit-logs.js', () => ({
createAuditLog: jest.fn(),
}))
let createJobsRouter: any
const noopLimiter: RequestHandler = (_req, _res, next) => next()
const adminToken = generateValidToken({ role: UserRole.ADMIN })
const userToken = generateValidToken({ role: UserRole.USER })
beforeAll(async () => {
const module = await import('../routes/jobs.js')
createJobsRouter = module.createJobsRouter
})
const pause = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))
describe('InMemoryJobQueue dead-letter handling', () => {
it('moves permanently failing jobs to dead letter after exhausting attempts', async () => {
const queue = new InMemoryJobQueue({ pollIntervalMs: 10 })
queue.registerHandler('oracle.call', async () => {
throw new Error('Permanent failure')
})
queue.enqueue('oracle.call', { oracle: 'test', symbol: 'XYZ' }, { maxAttempts: 1 })
queue.start()
await pause(100)
await queue.stop()
const metrics = queue.getMetrics()
expect(metrics.totals.failed).toBe(1)
expect(metrics.deadLetterJobs).toBe(1)
expect(metrics.byType['oracle.call'].deadLetter).toBe(1)
expect(queue.getDeadLetters()).toHaveLength(1)
expect(queue.getDeadLetters()[0].error).toBe('Permanent failure')
})
it('replays a dead-letter job back into the queue and removes it from DLQ', async () => {
const queue = new InMemoryJobQueue({ pollIntervalMs: 10 })
let callCount = 0
queue.registerHandler('oracle.call', async () => {
callCount += 1
if (callCount === 1) {
throw new Error('Intentional failure')
}
})
queue.enqueue('oracle.call', { oracle: 'test', symbol: 'REPLAY' }, { maxAttempts: 1 })
queue.start()
await pause(100)
await queue.stop()
const deadLetters = queue.getDeadLetters()
expect(deadLetters).toHaveLength(1)
const [entry] = deadLetters
const replayReceipt = queue.replayDeadLetter(entry.jobId)
expect(replayReceipt.type).toBe('oracle.call')
expect(replayReceipt.maxAttempts).toBe(1)
queue.start()
await pause(100)
await queue.stop()
expect(callCount).toBe(2)
expect(queue.getDeadLetters()).toHaveLength(0)
expect(queue.getMetrics().totals.completed).toBe(1)
})
})
describe('Jobs router dead-letter endpoints', () => {
const baseMetrics: QueueMetrics = {
running: true,
concurrency: 1,
pollIntervalMs: 10,
uptimeMs: 100,
queueDepth: 0,
delayedJobs: 0,
activeJobs: 0,
deadLetterJobs: 1,
totals: { enqueued: 1, executions: 1, completed: 0, failed: 1, retried: 0 },
byType: {
'notification.send': { queued: 0, delayed: 0, active: 0, completed: 0, failed: 0, deadLetter: 0 },
'deadline.check': { queued: 0, delayed: 0, active: 0, completed: 0, failed: 0, deadLetter: 0 },
'oracle.call': { queued: 0, delayed: 0, active: 0, completed: 0, failed: 1, deadLetter: 1 },
'analytics.recompute': { queued: 0, delayed: 0, active: 0, completed: 0, failed: 0, deadLetter: 0 },
'export.generate': { queued: 0, delayed: 0, active: 0, completed: 0, failed: 0, deadLetter: 0 },
},
recentFailures: [
{
jobId: 'job-1',
type: 'oracle.call',
failedAt: new Date().toISOString(),
attempts: 1,
error: 'Permanent failure',
},
],
}
const makeApp = (deadLetters: Array<Record<string, unknown>>) => {
const mockJobSystem = {
getMetrics: () => baseMetrics,
getDeadLetters: () => deadLetters,
getDeadLetter: (id: string) => deadLetters.find((entry) => entry.jobId === id),
replayDeadLetter: jest.fn((id: string) => {
const entry = deadLetters.find((item) => item.jobId === id)
if (!entry) {
throw new Error('Dead-letter job not found')
}
return { id: `replayed-${id}`, type: 'oracle.call', runAt: new Date().toISOString(), maxAttempts: 1 }
}),
} as unknown as typeof baseMetrics & {
getDeadLetters: () => Array<Record<string, unknown>>
getDeadLetter: (id: string) => Record<string, unknown> | undefined
replayDeadLetter: (id: string) => Record<string, unknown>
}
const app = express()
app.use(express.json())
app.use('/api/jobs', createJobsRouter(mockJobSystem, { enqueueLimiter: noopLimiter }))
return { app, mockJobSystem }
}
it('returns dead-letter listing to admin users', async () => {
const deadLetters = [
{
jobId: 'dlq-1',
type: 'oracle.call',
payload: { oracle: 'test', symbol: 'X' },
createdAt: Date.now(),
runAt: Date.now(),
maxAttempts: 1,
failedAt: new Date().toISOString(),
attempts: 1,
error: 'Permanent failure',
},
]
const { app } = makeApp(deadLetters)
const res = await request(app)
.get('/api/jobs/deadletters')
.set('Authorization', `Bearer ${adminToken}`)
expect(res.status).toBe(200)
expect(res.body.deadLetters).toHaveLength(1)
expect(res.body.deadLetters[0].jobId).toBe('dlq-1')
})
it('returns dead-letter counts in job metrics', async () => {
const { app } = makeApp([])
const res = await request(app)
.get('/api/jobs/metrics')
.set('Authorization', `Bearer ${adminToken}`)
expect(res.status).toBe(200)
expect(res.body.deadLetterJobs).toBe(1)
expect(res.body.byType['oracle.call'].deadLetter).toBe(1)
})
it('replays a dead-letter job and returns a new receipt', async () => {
const { app, mockJobSystem } = makeApp([
{
jobId: 'dlq-2',
type: 'oracle.call',
payload: { oracle: 'test', symbol: 'Y' },
createdAt: Date.now(),
runAt: Date.now(),
maxAttempts: 1,
failedAt: new Date().toISOString(),
attempts: 1,
error: 'Permanent failure',
},
])
const res = await request(app)
.post('/api/jobs/deadletters/dlq-2/replay')
.set('Authorization', `Bearer ${adminToken}`)
.send({})
expect(res.status).toBe(202)
expect(res.body.replayed).toBe(true)
expect(res.body.job.id).toBe('replayed-dlq-2')
expect(mockJobSystem.replayDeadLetter).toHaveBeenCalledWith('dlq-2')
})
it('returns 404 when replaying a missing dead-letter entry', async () => {
const { app } = makeApp([])
const res = await request(app)
.post('/api/jobs/deadletters/unknown/replay')
.set('Authorization', `Bearer ${adminToken}`)
.send({})
expect(res.status).toBe(404)
expect(res.body.error).toBe('Dead-letter job not found')
})
it('returns 403 for non-admin access to dead-letter endpoints', async () => {
const { app } = makeApp([])
const res = await request(app)
.get('/api/jobs/deadletters')
.set('Authorization', `Bearer ${userToken}`)
expect(res.status).toBe(403)
})
})