-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnotification.service.test.ts
More file actions
421 lines (341 loc) · 12.2 KB
/
notification.service.test.ts
File metadata and controls
421 lines (341 loc) · 12.2 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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
import { beforeEach, describe, expect, it } from "@jest/globals";
import type { MockRepository, MockSender } from "../../test/test-utils";
import {
createFailingNotificationServiceWithDeps,
createNotificationServiceWithDeps,
defaultNotificationDto,
MockTemplateEngine,
} from "../../test/test-utils";
import {
MaxRetriesExceededError,
NotificationNotFoundError,
SenderNotAvailableError,
TemplateError,
} from "./errors";
import { NotificationService } from "./notification.service";
import type { INotificationEventEmitter, ITemplateEngine } from "./ports";
import { NotificationChannel, NotificationPriority, NotificationStatus } from "./types";
describe("NotificationService - Create", () => {
let service: NotificationService;
let _repository: MockRepository;
beforeEach(() => {
const ctx = createNotificationServiceWithDeps();
service = ctx.service;
_repository = ctx.repository;
});
it("should create a notification with PENDING status", async () => {
const notification = await service.create(defaultNotificationDto);
expect(notification.id).toBeDefined();
expect(notification.status).toBe(NotificationStatus.QUEUED);
expect(notification.channel).toBe(NotificationChannel.EMAIL);
expect(notification.retryCount).toBe(0);
expect(notification.createdAt).toBeDefined();
expect(typeof notification.createdAt).toBe("string");
});
it("should create notification with optional metadata", async () => {
const dto = {
channel: NotificationChannel.SMS,
priority: NotificationPriority.HIGH,
recipient: {
id: "user-456",
phone: "+1234567890",
},
content: {
title: "Alert",
body: "Important message",
},
maxRetries: 5,
metadata: {
source: "api",
campaign: "summer-sale",
},
};
const notification = await service.create(dto);
expect(notification.metadata).toEqual({
source: "api",
campaign: "summer-sale",
});
expect(notification.maxRetries).toBe(5);
});
it("should create scheduled notification", async () => {
const futureDate = "2024-12-31T23:59:59Z";
const dto = {
channel: NotificationChannel.PUSH,
priority: NotificationPriority.NORMAL,
recipient: {
id: "user-789",
deviceToken: "device-abc",
},
content: {
title: "Scheduled",
body: "Future notification",
},
scheduledFor: futureDate,
maxRetries: 3,
};
const notification = await service.create(dto);
expect(notification.scheduledFor).toBe(futureDate);
expect(notification.status).toBe(NotificationStatus.PENDING);
});
});
describe("NotificationService - Send", () => {
let service: NotificationService;
let _sender: MockSender;
let repository: MockRepository;
beforeEach(() => {
const ctx = createNotificationServiceWithDeps();
_sender = ctx.sender;
repository = ctx.repository;
service = ctx.service;
});
it("should send notification successfully", async () => {
const result = await service.send(defaultNotificationDto);
expect(result.success).toBe(true);
expect(result.providerMessageId).toBe("mock-msg-123");
// Fetch notification to verify it was updated (find the latest one)
const notifications = await repository.find({});
const notification = notifications[0];
expect(notification).not.toBeNull();
expect(notification!.status).toBe(NotificationStatus.SENT);
expect(notification!.sentAt).toBeDefined();
});
it("should throw error if sender not available", async () => {
const dto = {
channel: NotificationChannel.SMS, // No SMS sender configured
priority: NotificationPriority.NORMAL,
recipient: {
id: "user-123",
phone: "+1234567890",
},
content: {
title: "Test",
body: "Test message",
},
maxRetries: 3,
};
await expect(service.send(dto)).rejects.toThrow(SenderNotAvailableError);
});
it("should handle send failure and mark as FAILED", async () => {
const { service: failingService } = createFailingNotificationServiceWithDeps();
await expect(failingService.send(defaultNotificationDto)).rejects.toThrow();
});
});
describe("NotificationService - SendById", () => {
let service: NotificationService;
let repository: MockRepository;
beforeEach(() => {
const ctx = createNotificationServiceWithDeps();
service = ctx.service;
repository = ctx.repository;
});
it("should send existing notification by ID", async () => {
// First create a notification
const created = await service.create(defaultNotificationDto);
// Then send it by ID
const result = await service.sendById(created.id);
expect(result.success).toBe(true);
// Verify notification was updated
const notification = await repository.findById(created.id);
expect(notification!.status).toBe(NotificationStatus.SENT);
});
it("should throw error if notification not found", async () => {
await expect(service.sendById("nonexistent-id")).rejects.toThrow(NotificationNotFoundError);
});
});
describe("NotificationService - Query", () => {
let service: NotificationService;
beforeEach(() => {
const ctx = createNotificationServiceWithDeps();
service = ctx.service;
});
it("should query notifications", async () => {
// Create some notifications with different priorities
await service.create(defaultNotificationDto);
await service.create({ ...defaultNotificationDto, priority: NotificationPriority.HIGH });
const results = await service.query({ limit: 10, offset: 0 });
expect(results.length).toBe(2);
});
it("should count notifications", async () => {
await service.create(defaultNotificationDto);
const count = await service.count({});
expect(count).toBe(1);
});
});
describe("NotificationService - Retry", () => {
let _service: NotificationService;
beforeEach(() => {
const ctx = createNotificationServiceWithDeps();
_service = ctx.service;
});
it("should retry failed notification", async () => {
// Create a failed notification
const { service: failingService, repository: failingRepo } =
createFailingNotificationServiceWithDeps();
try {
await failingService.send(defaultNotificationDto);
} catch (_error) {
// Expected to fail
}
// Find the failed notification
const notifications = await failingRepo.find({});
const failedNotification = notifications[0];
expect(failedNotification).toBeDefined();
expect(failedNotification!.status).toBe(NotificationStatus.FAILED);
expect(failedNotification!.retryCount).toBe(1);
// Now retry with working service using same repository
const ctx = createNotificationServiceWithDeps();
// Override the repository to use the failing service's repository
const workingService = new NotificationService(
failingRepo,
ctx.idGenerator,
ctx.dateTimeProvider,
[ctx.sender],
);
const retryResult = await workingService.retry(failedNotification!.id);
expect(retryResult.success).toBe(true);
// Verify notification was updated
const retriedNotification = await failingRepo.findById(failedNotification!.id);
expect(retriedNotification!.status).toBe(NotificationStatus.SENT);
expect(retriedNotification!.retryCount).toBe(1); // Still 1 since retry succeeded
});
it("should throw error if max retries exceeded", async () => {
const { service: failingService, repository: failingRepo } =
createFailingNotificationServiceWithDeps();
try {
await failingService.send({ ...defaultNotificationDto, maxRetries: 1 });
} catch (_error) {
// Expected to fail
}
// Find the failed notification
const notifications = await failingRepo.find({});
const failedNotification = notifications[0];
expect(failedNotification).toBeDefined();
// Try to retry twice (exceeds maxRetries of 1)
try {
await failingService.retry(failedNotification!.id);
} catch (_error) {
// First retry also fails
}
await expect(failingService.retry(failedNotification!.id)).rejects.toThrow(
MaxRetriesExceededError,
);
});
});
describe("NotificationService - Cancel", () => {
let service: NotificationService;
beforeEach(() => {
const ctx = createNotificationServiceWithDeps();
service = ctx.service;
});
it("should cancel pending notification", async () => {
const created = await service.create(defaultNotificationDto);
const cancelled = await service.cancel(created.id);
expect(cancelled.status).toBe(NotificationStatus.CANCELLED);
});
it("should throw error if notification not found", async () => {
await expect(service.cancel("nonexistent-id")).rejects.toThrow(NotificationNotFoundError);
});
});
describe("NotificationService - MarkAsDelivered", () => {
let service: NotificationService;
let _repository: MockRepository;
beforeEach(() => {
const ctx = createNotificationServiceWithDeps();
service = ctx.service;
_repository = ctx.repository;
});
it("should mark notification as delivered", async () => {
// Create a notification first, then send it
const created = await service.create(defaultNotificationDto);
await service.sendById(created.id);
const metadata = { deliveryTime: "500ms" };
const delivered = await service.markAsDelivered(created.id, metadata);
expect(delivered.status).toBe(NotificationStatus.DELIVERED);
expect(delivered.deliveredAt).toBeDefined();
});
});
describe("NotificationService - Template Rendering", () => {
it("should render template if template engine provided", async () => {
const ctx = createNotificationServiceWithDeps();
const templateEngine = new MockTemplateEngine();
const service = new NotificationService(
ctx.repository,
ctx.idGenerator,
ctx.dateTimeProvider,
[ctx.sender],
templateEngine,
);
const dto = {
...defaultNotificationDto,
content: {
title: "Welcome",
body: "Welcome {{name}}",
templateVars: { name: "John" },
},
};
const result = await service.send(dto);
expect(result.success).toBe(true);
});
it("should handle template rendering errors", async () => {
class FailingTemplateEngine implements ITemplateEngine {
async render(
_templateId: string,
_variables: Record<string, unknown>,
): Promise<{ title: string; body: string; html?: string }> {
throw new Error("Template not found");
}
async hasTemplate(_templateId: string): Promise<boolean> {
return false;
}
async validateVariables(
_templateId: string,
_variables: Record<string, unknown>,
): Promise<boolean> {
return false;
}
}
const ctx = createNotificationServiceWithDeps();
const templateEngine = new FailingTemplateEngine();
const service = new NotificationService(
ctx.repository,
ctx.idGenerator,
ctx.dateTimeProvider,
[ctx.sender],
templateEngine,
);
const dto = {
...defaultNotificationDto,
content: {
title: "Test",
body: "Body",
templateId: "welcome",
templateVars: { name: "John" },
},
};
await expect(service.send(dto)).rejects.toThrow(TemplateError);
});
});
describe("NotificationService - Event Emission", () => {
it("should emit events if event emitter provided", async () => {
const emittedEvents: unknown[] = [];
class TestEventEmitter implements INotificationEventEmitter {
async emit(event: unknown): Promise<void> {
emittedEvents.push(event);
}
}
const ctx = createNotificationServiceWithDeps();
const eventEmitter = new TestEventEmitter();
const service = new NotificationService(
ctx.repository,
ctx.idGenerator,
ctx.dateTimeProvider,
[ctx.sender],
undefined,
eventEmitter,
);
await service.send(defaultNotificationDto);
expect(emittedEvents.length).toBeGreaterThan(0);
expect(emittedEvents.some((e) => (e as any).type === "notification.created")).toBe(true);
expect(emittedEvents.some((e) => (e as any).type === "notification.sent")).toBe(true);
});
});