Spaces:
Runtime error
Runtime error
File size: 49,827 Bytes
46252cd | 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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 | // SSRF protection is now ON by default; resolve any host to a public IP so existing
// dispatch/create tests stay offline. Literal-IP tests (8.8.8.8 / 127.0.0.1) bypass lookup.
jest.mock('dns/promises', () => ({
lookup: jest.fn().mockResolvedValue([{ address: '93.184.216.34', family: 4 }]),
}));
// Webhook delivery goes through undici's fetch (via the SSRF-pinning helper); mock it, not global fetch.
jest.mock('undici', () => {
const actual = jest.requireActual<typeof import('undici')>('undici');
return { __esModule: true, ...actual, fetch: jest.fn() };
});
import { Test, TestingModule } from '@nestjs/testing';
import { getRepositoryToken } from '@nestjs/typeorm';
import { getQueueToken } from '@nestjs/bullmq';
import { In, Repository } from 'typeorm';
import { NotFoundException } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import * as crypto from 'crypto';
import { fetch as undiciFetch } from 'undici';
import { WebhookService, WebhookPayload } from './webhook.service';
import { Webhook } from './entities/webhook.entity';
import { WebhookDeliveryFailure } from './entities/webhook-delivery-failure.entity';
import { WebhookFilters } from './filters/filter-types';
import { LidMappingStoreService } from '../../engine/identity/lid-mapping-store.service';
import { HookManager } from '../../core/hooks';
import { QUEUE_NAMES } from '../queue/queue-names';
import { Session } from '../session/entities/session.entity';
import { getWebhookDeliveryFailuresTotal } from '../../common/metrics/webhook-delivery-metrics';
import { ConcurrencyLimiter } from '../../common/utils/concurrency-limiter';
function createMockWebhook(overrides: Partial<Webhook> = {}): Webhook {
return {
id: 'wh-uuid-1',
sessionId: 'sess-1',
url: 'https://example.com/webhook',
events: ['message.received'],
secret: null,
headers: {},
filters: null,
active: true,
retryCount: 3,
lastTriggeredAt: null,
createdAt: new Date(),
updatedAt: new Date(),
session: undefined as unknown as Session,
...overrides,
};
}
describe('WebhookService', () => {
let service: WebhookService;
let repository: jest.Mocked<Partial<Repository<Webhook>>>;
let failureRepository: jest.Mocked<Partial<Repository<WebhookDeliveryFailure>>>;
let configService: jest.Mocked<Partial<ConfigService>>;
let hookManager: jest.Mocked<Partial<HookManager>>;
let webhookQueue: jest.Mocked<Record<string, jest.Mock>>;
let lidStore: { getCached: jest.Mock };
beforeEach(async () => {
repository = {
find: jest.fn(),
findOne: jest.fn(),
create: jest.fn(),
save: jest.fn(),
remove: jest.fn(),
update: jest.fn(),
};
failureRepository = {
insert: jest.fn().mockResolvedValue({}),
find: jest.fn().mockResolvedValue([]),
delete: jest.fn().mockResolvedValue({ affected: 0 }),
};
configService = {
get: jest.fn().mockImplementation(<T>(key: string, def?: T): T | boolean | number => {
if (key === 'queue.enabled') return false;
if (key === 'webhook.retryDelay') return 100;
// Distinct from the hardcoded 10000 fallback so a regression to a literal timeout is caught.
if (key === 'webhook.timeout') return 25000;
// A small, non-default cap so the fan-out-bound test (5 webhooks) can assert the limiter holds.
if (key === 'webhook.dispatchConcurrency') return 2;
return def as T;
}),
};
hookManager = {
execute: jest.fn().mockResolvedValue({
continue: true,
data: { sessionId: 'sess-1', event: 'message.received', payload: {} },
}),
};
webhookQueue = {
add: jest.fn().mockResolvedValue(undefined),
};
lidStore = { getCached: jest.fn().mockReturnValue(null) };
const module: TestingModule = await Test.createTestingModule({
providers: [
WebhookService,
{ provide: getRepositoryToken(Webhook, 'data'), useValue: repository },
{ provide: getRepositoryToken(WebhookDeliveryFailure, 'data'), useValue: failureRepository },
{ provide: ConfigService, useValue: configService },
{ provide: HookManager, useValue: hookManager },
{ provide: LidMappingStoreService, useValue: lidStore },
{ provide: getQueueToken(QUEUE_NAMES.WEBHOOK), useValue: webhookQueue },
],
}).compile();
service = module.get<WebhookService>(WebhookService);
});
// ββ create ββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe('create', () => {
it('should create a webhook with default events', async () => {
const webhook = createMockWebhook();
(repository.create as jest.Mock).mockReturnValue(webhook);
(repository.save as jest.Mock).mockResolvedValue(webhook);
const result = await service.create('sess-1', {
url: 'https://example.com/webhook',
});
expect(result.sessionId).toBe('sess-1');
expect(repository.create).toHaveBeenCalledWith(
expect.objectContaining({
sessionId: 'sess-1',
events: ['message.received'],
}),
);
});
it('should create webhook with custom events and secret', async () => {
const webhook = createMockWebhook({
events: ['*'],
secret: 'my-secret',
});
(repository.create as jest.Mock).mockReturnValue(webhook);
(repository.save as jest.Mock).mockResolvedValue(webhook);
await service.create('sess-1', {
url: 'https://example.com/webhook',
events: ['*'],
secret: 'my-secret',
});
expect(repository.create).toHaveBeenCalledWith(
expect.objectContaining({
events: ['*'],
secret: 'my-secret',
}),
);
});
// ββ validate URL at registration, default-on ββββββββββ
it('rejects an internal webhook URL at registration with 400 and a generic message (no IP leak)', async () => {
const origProtect = process.env.WEBHOOK_SSRF_PROTECT;
delete process.env.WEBHOOK_SSRF_PROTECT; // default β on
try {
await expect(service.create('sess-1', { url: 'http://127.0.0.1/hook' })).rejects.toMatchObject({
response: { message: 'Destination address is not allowed' },
});
expect(repository.create).not.toHaveBeenCalled();
} finally {
if (origProtect === undefined) delete process.env.WEBHOOK_SSRF_PROTECT;
else process.env.WEBHOOK_SSRF_PROTECT = origProtect;
}
});
it('accepts an internal webhook URL when protection is explicitly disabled', async () => {
const origProtect = process.env.WEBHOOK_SSRF_PROTECT;
process.env.WEBHOOK_SSRF_PROTECT = 'false';
try {
const webhook = createMockWebhook({ url: 'http://127.0.0.1/hook' });
(repository.create as jest.Mock).mockReturnValue(webhook);
(repository.save as jest.Mock).mockResolvedValue(webhook);
await expect(service.create('sess-1', { url: 'http://127.0.0.1/hook' })).resolves.toBeDefined();
} finally {
if (origProtect === undefined) delete process.env.WEBHOOK_SSRF_PROTECT;
else process.env.WEBHOOK_SSRF_PROTECT = origProtect;
}
});
});
// ββ findBySession / findAll / findOne ββββββββββββββββββββββββββββββ
describe('findBySession', () => {
it('should return webhooks for a session', async () => {
const webhooks = [createMockWebhook()];
(repository.find as jest.Mock).mockResolvedValue(webhooks);
const result = await service.findBySession('sess-1');
expect(result).toHaveLength(1);
expect(repository.find).toHaveBeenCalledWith(expect.objectContaining({ where: { sessionId: 'sess-1' } }));
});
});
describe('findAll', () => {
it('should return all webhooks ordered by createdAt DESC', async () => {
(repository.find as jest.Mock).mockResolvedValue([]);
await service.findAll();
expect(repository.find).toHaveBeenCalledWith({ order: { createdAt: 'DESC' }, take: 1000, skip: 0 });
});
it('applies bounded pagination to cross-session listing', async () => {
(repository.find as jest.Mock).mockResolvedValue([]);
await service.findAll(['sess-1'], { limit: 5000, offset: -5 });
expect(repository.find).toHaveBeenCalledWith({
where: { sessionId: In(['sess-1']) },
order: { createdAt: 'DESC' },
take: 1000,
skip: 0,
});
});
});
describe('findOne', () => {
it('should return webhook by id', async () => {
const webhook = createMockWebhook();
(repository.findOne as jest.Mock).mockResolvedValue(webhook);
const result = await service.findOne('sess-1', 'wh-uuid-1');
expect(result.id).toBe('wh-uuid-1');
});
it('should throw NotFoundException if not found', async () => {
(repository.findOne as jest.Mock).mockResolvedValue(null);
await expect(service.findOne('sess-1', 'nonexistent')).rejects.toThrow(NotFoundException);
});
});
// ββ update ββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe('update', () => {
it('should update only provided fields', async () => {
const webhook = createMockWebhook();
(repository.findOne as jest.Mock).mockResolvedValue(webhook);
(repository.save as jest.Mock).mockImplementation(w => Promise.resolve(w));
const result = await service.update('sess-1', 'wh-uuid-1', { url: 'https://new-url.com/hook' });
expect(result.url).toBe('https://new-url.com/hook');
expect(result.events).toEqual(['message.received']); // unchanged
});
});
// ββ delete ββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe('delete', () => {
it('should remove the webhook', async () => {
const webhook = createMockWebhook();
(repository.findOne as jest.Mock).mockResolvedValue(webhook);
(repository.remove as jest.Mock).mockResolvedValue(webhook);
await service.delete('sess-1', 'wh-uuid-1');
expect(repository.remove).toHaveBeenCalledWith(webhook);
});
});
// ββ dispatch (direct mode β queue disabled) βββββββββββββββββββββββ
describe('delivery-failure retention', () => {
afterEach(() => service.onModuleDestroy());
it('pruneDeliveryFailures deletes rows older than the retention window and returns the count', async () => {
(failureRepository.delete as jest.Mock).mockResolvedValue({ affected: 3 });
await expect(service.pruneDeliveryFailures(90)).resolves.toBe(3);
expect(failureRepository.delete).toHaveBeenCalledTimes(1);
});
it('onModuleInit skips scheduling when WEBHOOK_FAILURE_RETENTION_DAYS <= 0 (retention disabled)', () => {
const prev = process.env.WEBHOOK_FAILURE_RETENTION_DAYS;
process.env.WEBHOOK_FAILURE_RETENTION_DAYS = '0';
try {
service.onModuleInit();
expect(failureRepository.delete).not.toHaveBeenCalled();
} finally {
if (prev === undefined) delete process.env.WEBHOOK_FAILURE_RETENTION_DAYS;
else process.env.WEBHOOK_FAILURE_RETENTION_DAYS = prev;
}
});
it('onModuleInit prunes once at startup when retention is enabled', () => {
const prev = process.env.WEBHOOK_FAILURE_RETENTION_DAYS;
process.env.WEBHOOK_FAILURE_RETENTION_DAYS = '30';
try {
service.onModuleInit();
expect(failureRepository.delete).toHaveBeenCalledTimes(1);
} finally {
if (prev === undefined) delete process.env.WEBHOOK_FAILURE_RETENTION_DAYS;
else process.env.WEBHOOK_FAILURE_RETENTION_DAYS = prev;
}
});
});
describe('dispatch (direct mode)', () => {
const mockFetch = undiciFetch as jest.Mock;
beforeEach(() => {
mockFetch.mockResolvedValue({ ok: true, status: 200 });
});
afterEach(() => {
mockFetch.mockReset();
});
it('resolves (never rejects) when the webhook lookup fails β callers fire-and-forget it', async () => {
(repository.find as jest.Mock).mockRejectedValue(new Error('db down'));
await expect(service.dispatch('sess-1', 'message.received', { x: 1 })).resolves.toBeUndefined();
expect(mockFetch).not.toHaveBeenCalled();
});
it('should dispatch to webhooks matching the event', async () => {
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
// Mock hook to return the payload properly
const mockPayload: WebhookPayload = {
event: 'message.received',
timestamp: new Date().toISOString(),
sessionId: 'sess-1',
idempotencyKey: 'test-key',
deliveryId: 'test-delivery',
data: { from: '628123456789@c.us' },
};
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: {
sessionId: 'sess-1',
event: 'message.received',
payload: mockPayload,
},
});
const timeoutSpy = jest.spyOn(AbortSignal, 'timeout');
await service.dispatch('sess-1', 'message.received', { from: '628123456789@c.us' });
expect(mockFetch).toHaveBeenCalledWith(
'https://example.com/webhook',
expect.objectContaining({ method: 'POST' }),
);
// Direct delivery path honors the configured WEBHOOK_TIMEOUT, not a literal 10s.
expect(timeoutSpy).toHaveBeenCalledWith(25000);
timeoutSpy.mockRestore();
});
it('dispatches to sibling webhooks concurrently β a slow receiver does not block the others', async () => {
const wA = createMockWebhook({ id: 'wh-a', url: 'https://a.example/hook', events: ['message.received'] });
const wB = createMockWebhook({ id: 'wh-b', url: 'https://b.example/hook', events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([wA, wB]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
(hookManager.execute as jest.Mock).mockResolvedValue({ continue: true, data: {} });
let resolveSlow: (v: unknown) => void = () => undefined;
const slow = new Promise(r => (resolveSlow = r));
const calledUrls: string[] = [];
mockFetch.mockImplementation((url: string) => {
calledUrls.push(url);
return url.includes('a.example') ? slow : Promise.resolve({ ok: true, status: 200 });
});
const dispatchP = service.dispatch('sess-1', 'message.received', { from: 'x@c.us' });
// Flush until both fetches fire (or give up): with the old sequential loop, only A ever fires while
// it hangs, so this exhausts and the assertion below fails β exactly the regression we guard.
for (let i = 0; i < 20 && calledUrls.length < 2; i++) {
await new Promise(r => setImmediate(r));
}
// B is delivered even though A is still hanging β sequential code would not have reached B yet.
expect(calledUrls).toEqual(expect.arrayContaining(['https://a.example/hook', 'https://b.example/hook']));
resolveSlow({ ok: true, status: 200 });
await dispatchP;
});
it('bounds concurrent delivery to WEBHOOK_DISPATCH_CONCURRENCY (cap=2, 5 webhooks β peak β€ 2)', async () => {
const hooks = Array.from({ length: 5 }, (_, i) =>
createMockWebhook({ id: `wh-${i}`, url: `https://h${i}.example/hook`, events: ['message.received'] }),
);
(repository.find as jest.Mock).mockResolvedValue(hooks);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
(hookManager.execute as jest.Mock).mockResolvedValue({ continue: true, data: {} });
let inFlight = 0;
let peak = 0;
let resolved = 0;
const releasers: Array<() => void> = [];
mockFetch.mockImplementation(
() =>
new Promise(resolve => {
inFlight += 1;
peak = Math.max(peak, inFlight);
releasers.push(() => {
inFlight -= 1;
resolved += 1;
resolve({ ok: true, status: 200 });
});
}),
);
const dispatchP = service.dispatch('sess-1', 'message.received', { from: 'x@c.us' });
// Let the limiter admit up to the cap (2) and each reach fetch. The other 3 stay parked.
for (let i = 0; i < 20 && releasers.length < 2; i++) {
await new Promise(r => setImmediate(r));
}
expect(inFlight).toBeLessThanOrEqual(2);
// Release in a macrotask loop: freeing a slot lets the limiter admit the next webhook, whose fetch
// pushes a fresh releaser on the NEXT tick β a single synchronous drain would miss it and hang.
for (let i = 0; i < 50 && resolved < 5; i++) {
while (releasers.length) (releasers.shift() as () => void)();
await new Promise(r => setImmediate(r));
}
await dispatchP;
// Peak across the whole run never exceeded the cap. (An unbounded fan-out would reach 5.)
expect(peak).toBeLessThanOrEqual(2);
expect(mockFetch).toHaveBeenCalledTimes(5);
});
it('records a durable failure when the bounded dispatch queue is full', async () => {
const wA = createMockWebhook({ id: 'wh-a', url: 'https://a.example/hook', events: ['message.received'] });
const wB = createMockWebhook({ id: 'wh-b', url: 'https://b.example/hook', events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([wA, wB]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
(hookManager.execute as jest.Mock).mockImplementation((_event: string, data: unknown) =>
Promise.resolve({ continue: true, data }),
);
(service as unknown as { dispatchLimiter: ConcurrencyLimiter }).dispatchLimiter = new ConcurrencyLimiter(1, 0);
let release: (value: unknown) => void = () => undefined;
mockFetch.mockImplementation(() => new Promise(resolve => (release = resolve)));
const pending = service.dispatch('sess-1', 'message.received', { from: 'x@c.us' });
for (let i = 0; i < 20 && mockFetch.mock.calls.length === 0; i++) await new Promise(r => setImmediate(r));
release({ ok: true, status: 200 });
await pending;
expect(failureRepository.insert).toHaveBeenCalledWith(
expect.objectContaining({
webhookId: 'wh-b',
attempts: 0,
lastError: 'ConcurrencyLimiter queue full',
}),
);
expect(mockFetch).toHaveBeenCalledTimes(1);
});
it('salts each sibling webhook with a distinct idempotency key so one receiver cannot dedupe out another', async () => {
const wA = createMockWebhook({ id: 'wh-a', url: 'https://a.example/hook', events: ['message.received'] });
const wB = createMockWebhook({ id: 'wh-b', url: 'https://b.example/hook', events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([wA, wB]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
(hookManager.execute as jest.Mock).mockResolvedValue({ continue: true, data: {} });
mockFetch.mockResolvedValue({ ok: true, status: 200 });
await service.dispatch('sess-1', 'message.received', { from: 'x@c.us' });
const keyByUrl = new Map<string, string>();
for (const call of mockFetch.mock.calls as [string, { headers: Record<string, string> }][]) {
keyByUrl.set(call[0], call[1].headers['X-OpenWA-Idempotency-Key']);
}
const keyA = keyByUrl.get('https://a.example/hook');
const keyB = keyByUrl.get('https://b.example/hook');
// Same event + payload, but two distinct endpoints must not collide on the dedupe header.
expect(keyA).toBeTruthy();
expect(keyB).toBeTruthy();
expect(keyA).not.toBe(keyB);
});
it('falls back to the original payload when a before-hook omits payload (no undefined body)', async () => {
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
// A misbehaving plugin returns continue:true but no `payload` key on the result.
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: { sessionId: 'sess-1', event: 'message.received' },
});
await service.dispatch('sess-1', 'message.received', { from: '628123456789@c.us' });
expect(mockFetch).toHaveBeenCalled();
const callArgs = mockFetch.mock.calls[0] as [unknown, { body: string }];
const body = JSON.parse(callArgs[1].body) as WebhookPayload;
expect(body).not.toBeUndefined();
expect(body.event).toBe('message.received');
expect(body.data).toEqual({ from: '628123456789@c.us' });
});
it('falls back to the original payload when a before-hook returns null data', async () => {
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
(hookManager.execute as jest.Mock).mockResolvedValue({ continue: true, data: null });
await service.dispatch('sess-1', 'message.received', { from: '628123456789@c.us' });
const callArgs = mockFetch.mock.calls[0] as [unknown, { body: string }];
const body = JSON.parse(callArgs[1].body) as WebhookPayload;
expect(body.event).toBe('message.received');
expect(body.data).toEqual({ from: '628123456789@c.us' });
});
it('keeps the server-canonical idempotency/delivery ids on the signed body, overriding a tampering plugin', async () => {
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
// A webhook:before plugin returns a payload with forged identifiers (other hook events pass through).
(hookManager.execute as jest.Mock).mockImplementation((event: string, ctx: { payload?: WebhookPayload }) =>
event === 'webhook:before' && ctx.payload
? Promise.resolve({
continue: true,
data: { payload: { ...ctx.payload, idempotencyKey: 'PLUGIN-FORGED', deliveryId: 'PLUGIN-FORGED' } },
})
: Promise.resolve({ continue: true, data: {} }),
);
await service.dispatch('sess-1', 'message.received', { from: '628123456789@c.us' });
const call = mockFetch.mock.calls[0] as [unknown, { headers: Record<string, string>; body: string }];
const headers = call[1].headers;
const body = JSON.parse(call[1].body) as WebhookPayload;
// Receivers dedupe on the header, so the signed body field must equal the header β and both must
// be the server's value, not the plugin's forgery.
expect(body.idempotencyKey).toBe(headers['X-OpenWA-Idempotency-Key']);
expect(body.deliveryId).toBe(headers['X-OpenWA-Delivery-Id']);
expect(body.idempotencyKey).not.toBe('PLUGIN-FORGED');
expect(body.deliveryId).not.toBe('PLUGIN-FORGED');
});
it("isolates each webhook's data so an in-place before-hook mutation cannot bleed across webhooks", async () => {
const a = createMockWebhook({ id: 'wh-a', events: ['message.received'] });
const b = createMockWebhook({ id: 'wh-b', events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([a, b]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
// The hook mutates payload.data in place every time it runs (returns no payload key β finalPayload
// is the mutated input). With a shared data object the second webhook would see the first's tag.
(hookManager.execute as jest.Mock).mockImplementation((event: string, ctx: { payload?: WebhookPayload }) => {
if (event === 'webhook:before' && ctx.payload) {
const d = ctx.payload.data as { tag?: number };
d.tag = (d.tag ?? 0) + 1;
return Promise.resolve({ continue: true, data: { payload: ctx.payload } });
}
return Promise.resolve({ continue: true, data: {} });
});
await service.dispatch('sess-1', 'message.received', { from: 'x@c.us' });
const bodyA = JSON.parse((mockFetch.mock.calls[0] as [unknown, { body: string }])[1].body) as {
data: { tag: number };
};
const bodyB = JSON.parse((mockFetch.mock.calls[1] as [unknown, { body: string }])[1].body) as {
data: { tag: number };
};
// Each webhook starts from its own clone of the original data, so both see exactly one increment.
expect(bodyA.data.tag).toBe(1);
expect(bodyB.data.tag).toBe(1);
});
it('test() probes the receiver using the configured WEBHOOK_TIMEOUT', async () => {
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.findOne as jest.Mock).mockResolvedValue(webhook);
const timeoutSpy = jest.spyOn(AbortSignal, 'timeout');
await service.test('sess-1', webhook.id);
expect(mockFetch).toHaveBeenCalled();
expect(timeoutSpy).toHaveBeenCalledWith(25000);
timeoutSpy.mockRestore();
});
// A literal link-local IP is rejected synchronously by the SSRF guard before any fetch/DNS, so this
// is fully offline. The raw SsrfBlockedError message names the resolved internal IP β an SSRF
// disclosure oracle β so the test() response must surface the generic constant instead.
it('test() does not leak the resolved internal IP when the SSRF guard blocks the URL', async () => {
const origProtect = process.env.WEBHOOK_SSRF_PROTECT;
delete process.env.WEBHOOK_SSRF_PROTECT; // default β on
try {
const webhook = createMockWebhook({ url: 'https://169.254.169.254/' });
(repository.findOne as jest.Mock).mockResolvedValue(webhook);
const result = await service.test('sess-1', webhook.id);
expect(result.success).toBe(false);
expect(result.error).toBe('Destination address is not allowed');
expect(result.error).not.toMatch(/169\.254\.169\.254/);
expect(mockFetch).not.toHaveBeenCalled(); // blocked before any network
} finally {
if (origProtect === undefined) delete process.env.WEBHOOK_SSRF_PROTECT;
else process.env.WEBHOOK_SSRF_PROTECT = origProtect;
}
});
it('should NOT dispatch to webhooks that do not match the event', async () => {
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
await service.dispatch('sess-1', 'session.ready', { phone: '628123456789' });
expect(mockFetch).not.toHaveBeenCalled();
});
it('should dispatch to webhooks with wildcard (*) event filter', async () => {
const webhook = createMockWebhook({ events: ['*'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
const wildcardPayload: WebhookPayload = {
event: 'anything.goes',
timestamp: '',
sessionId: 'sess-1',
idempotencyKey: '',
deliveryId: '',
data: {},
};
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: {
sessionId: 'sess-1',
event: 'anything.goes',
payload: wildcardPayload,
},
});
await service.dispatch('sess-1', 'anything.goes', {});
expect(mockFetch).toHaveBeenCalled();
});
it('should skip dispatch when plugin cancels via hook', async () => {
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(hookManager.execute as jest.Mock).mockResolvedValue({ continue: false, data: {} });
await service.dispatch('sess-1', 'message.received', {});
expect(mockFetch).not.toHaveBeenCalled();
});
});
describe('dispatch (queued mode) β serialization safety', () => {
it('catches an unserializable webhook:before payload instead of aborting the loop / rejecting', async () => {
(service as unknown as { queueEnabled: boolean }).queueEnabled = true;
// A plugin's webhook:before returns a payload JSON.stringify cannot serialize (BigInt). With the
// secret set, the queued branch signs JSON.stringify(finalPayload) β which throws.
(hookManager.execute as jest.Mock).mockResolvedValue({ continue: true, data: { payload: { x: 1n } } });
const webhook = createMockWebhook({ secret: 'sek', events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
// Must NOT reject (the loop/dispatch promise stays settled); the throw is caught + logged.
await expect(service.dispatch('sess-1', 'message.received', { ok: true })).resolves.toBeUndefined();
expect(webhookQueue.add).not.toHaveBeenCalled(); // never enqueued the un-signable job
expect(hookManager.execute).toHaveBeenCalledWith('webhook:error', expect.anything(), expect.anything());
});
});
// ββ dispatch (smart filters) ββββββββββββββββββββββββββββββββββββββ
// The event still has to match `events[]`; filters then refine WHETHER it fires based
// on the payload. A webhook with no filters behaves exactly as before (fires on match).
describe('dispatch (smart filters)', () => {
const mockFetch = undiciFetch as jest.Mock;
beforeEach(() => {
mockFetch.mockResolvedValue({ ok: true, status: 200 });
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
});
afterEach(() => mockFetch.mockReset());
const conds = (...conditions: WebhookFilters['conditions']): WebhookFilters => ({ conditions });
// events:['*'] isolates the filter logic from event-name matching. Returns the number
// of outbound HTTP deliveries the dispatch performed (1 = fired, 0 = filtered out).
async function deliveries(
filters: WebhookFilters | null,
event: string,
data: Record<string, unknown>,
): Promise<number> {
mockFetch.mockClear();
const webhook = createMockWebhook({ events: ['*'], filters });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
await service.dispatch('sess-1', event, data);
return mockFetch.mock.calls.length;
}
it('fires with no filters (additive: zero-config behaviour is unchanged)', async () => {
expect(await deliveries(null, 'message.received', { from: '111@c.us' })).toBe(1);
expect(await deliveries(conds(), 'message.received', { from: '111@c.us' })).toBe(1);
});
it('sender "is": fires on a match, filters out a mismatch', async () => {
const f = conds({ field: 'sender', operator: 'is', value: ['111@c.us'] });
expect(await deliveries(f, 'message.received', { from: '111@c.us' })).toBe(1);
expect(await deliveries(f, 'message.received', { from: '222@c.us' })).toBe(0);
});
it('sender "isNot": filters out the named sender, fires for everyone else', async () => {
const f = conds({ field: 'sender', operator: 'isNot', value: ['spammer@c.us'] });
expect(await deliveries(f, 'message.received', { from: 'spammer@c.us' })).toBe(0);
expect(await deliveries(f, 'message.received', { from: 'friend@c.us' })).toBe(1);
});
it('resolves sender to the group participant (author), not the group JID', async () => {
const f = conds({ field: 'sender', operator: 'is', value: ['part@c.us'] });
const data = { from: '120@g.us', author: 'part@c.us', isGroup: true };
expect(await deliveries(f, 'message.received', data)).toBe(1);
});
it('ANDs multiple conditions (all must match)', async () => {
const f = conds(
{ field: 'sender', operator: 'is', value: ['boss@c.us'] },
{ field: 'body', operator: 'contains', value: 'invoice' },
);
expect(await deliveries(f, 'message.received', { from: 'boss@c.us', body: 'the invoice is ready' })).toBe(1);
expect(await deliveries(f, 'message.received', { from: 'boss@c.us', body: 'lunch?' })).toBe(0);
expect(await deliveries(f, 'message.received', { from: 'other@c.us', body: 'invoice' })).toBe(0);
});
it('body "contains" is case-insensitive by default and respects caseSensitive', async () => {
const ci = conds({ field: 'body', operator: 'contains', value: 'ping' });
expect(await deliveries(ci, 'message.received', { body: 'PING me' })).toBe(1);
const cs = conds({ field: 'body', operator: 'contains', value: 'ping', caseSensitive: true });
expect(await deliveries(cs, 'message.received', { body: 'PING me' })).toBe(0);
});
it('body "equals" fires only on an exact match', async () => {
const f = conds({ field: 'body', operator: 'equals', value: 'order 42' });
expect(await deliveries(f, 'message.received', { body: 'order 42' })).toBe(1);
expect(await deliveries(f, 'message.received', { body: 'order 4242' })).toBe(0);
});
it('type "is" matches one of the listed message types', async () => {
const f = conds({ field: 'type', operator: 'is', value: ['image', 'video'] });
expect(await deliveries(f, 'message.received', { type: 'image' })).toBe(1);
expect(await deliveries(f, 'message.received', { type: 'text' })).toBe(0);
});
it('boolean fields: fromMe and hasMedia', async () => {
const fromMe = conds({ field: 'fromMe', operator: 'is', value: true });
expect(await deliveries(fromMe, 'message.received', { fromMe: true })).toBe(1);
expect(await deliveries(fromMe, 'message.received', { fromMe: false })).toBe(0);
const hasMedia = conds({ field: 'hasMedia', operator: 'is', value: true });
expect(await deliveries(hasMedia, 'message.received', { media: { mimetype: 'image/png' } })).toBe(1);
expect(await deliveries(hasMedia, 'message.received', { body: 'just text' })).toBe(0);
});
it('filters message.edited through a wildcard subscription using its normalized message fields', async () => {
const f = conds(
{ field: 'sender', operator: 'is', value: ['part@c.us'] },
{ field: 'body', operator: 'contains', value: 'invoice' },
{ field: 'type', operator: 'is', value: ['image'] },
{ field: 'hasMedia', operator: 'is', value: true },
);
const data = {
from: '120@g.us',
author: 'part@c.us',
body: 'Updated invoice',
type: 'image',
hasMedia: true,
};
expect(await deliveries(f, 'message.edited', data)).toBe(1);
expect(await deliveries(f, 'message.edited', { ...data, body: 'lunch?', hasMedia: false })).toBe(0);
});
it('mentions: fires when the message mentions one of the listed JIDs', async () => {
const f = conds({ field: 'mentions', operator: 'is', value: ['boss@c.us'] });
expect(await deliveries(f, 'message.received', { mentionedIds: ['boss@c.us', 'x@c.us'] })).toBe(1);
expect(await deliveries(f, 'message.received', { mentionedIds: ['x@c.us'] })).toBe(0);
});
it('skips message-only conditions on a non-message event (so it still fires)', async () => {
// A webhook subscribed to '*' with message filters must not suppress non-message events.
const f = conds({ field: 'sender', operator: 'is', value: ['nobody@c.us'] });
expect(await deliveries(f, 'session.status', { status: 'connected' })).toBe(1);
expect(await deliveries(f, 'message.received', { from: 'someone@c.us' })).toBe(0);
});
it('resolves a lid sender to its phone via the table, so a phone filter fires (else a silent miss)', async () => {
const f = conds({ field: 'sender', operator: 'is', value: ['628999'] });
const data = { from: '120@g.us', author: '111@lid', isGroup: true };
// No mapping yet -> the lid author never matches the phone filter.
lidStore.getCached.mockReturnValue(null);
expect(await deliveries(f, 'message.received', data)).toBe(0);
// Table maps lid 111 -> 628999 -> the same message now fires.
lidStore.getCached.mockImplementation((lid: string) => (lid === '111' ? '628999' : null));
expect(await deliveries(f, 'message.received', data)).toBe(1);
});
});
// ββ custom-header sanitization βββββββββββββββββββββββββββββββ
describe('custom header merge', () => {
it('drops reserved custom headers so the system headers always win', async () => {
const webhook = createMockWebhook({
events: ['message.received'],
headers: { 'X-OpenWA-Event': 'forged', 'Content-Type': 'text/plain', 'X-Custom': 'ok' },
});
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
const captured: Record<string, string> = {};
const mockFetch = undiciFetch as jest.Mock;
mockFetch.mockImplementation((_url: string, opts: RequestInit) => {
Object.assign(captured, opts.headers as Record<string, string>);
return Promise.resolve({ ok: true, status: 200 });
});
const payload: WebhookPayload = {
event: 'message.received',
data: {},
timestamp: '',
sessionId: 'sess-1',
idempotencyKey: 'k',
deliveryId: 'd',
};
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: { sessionId: 'sess-1', event: 'message.received', payload },
});
await service.dispatch('sess-1', 'message.received', {});
expect(captured['X-OpenWA-Event']).toBe('message.received'); // system value, not 'forged'
expect(captured['Content-Type']).toBe('application/json');
expect(captured['X-Custom']).toBe('ok'); // legitimate custom header preserved
mockFetch.mockReset();
});
});
// ββ redirect refusal βββββββββββββββββββββββββββββββββββββββββ
describe('dispatch β redirect refusal', () => {
const mockFetch = undiciFetch as jest.Mock;
const origProtect = process.env.WEBHOOK_SSRF_PROTECT;
beforeEach(() => {
process.env.WEBHOOK_SSRF_PROTECT = 'true';
});
afterEach(() => {
mockFetch.mockReset();
if (origProtect === undefined) delete process.env.WEBHOOK_SSRF_PROTECT;
else process.env.WEBHOOK_SSRF_PROTECT = origProtect;
});
it('does NOT follow a redirect and treats it as a delivery failure when protection is on', async () => {
// Public literal IP β assertSafeFetchUrl passes with no DNS lookup; retryCount:1 β no retry loop.
const webhook = createMockWebhook({
url: 'https://8.8.8.8/webhook',
events: ['message.received'],
retryCount: 1,
});
(repository.find as jest.Mock).mockResolvedValue([webhook]);
// Simulate undici's redirect:'manual' result β an opaque redirect, never followed.
mockFetch.mockResolvedValue({ ok: false, status: 0, type: 'opaqueredirect' });
const payload: WebhookPayload = {
event: 'message.received',
timestamp: '',
sessionId: 'sess-1',
idempotencyKey: 'k',
deliveryId: 'd',
data: {},
};
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: { sessionId: 'sess-1', event: 'message.received', payload },
});
await service.dispatch('sess-1', 'message.received', {});
// fetch was issued with redirect:'manual' and the redirect was NOT followed (no success path)
expect(mockFetch).toHaveBeenCalledWith(
'https://8.8.8.8/webhook',
expect.objectContaining({ redirect: 'manual' }),
);
expect(repository.update).not.toHaveBeenCalled(); // lastTriggeredAt never set β delivery failed
expect(hookManager.execute).toHaveBeenCalledWith('webhook:error', expect.anything(), expect.anything());
});
});
// ββ generateSignature (via dispatch) ββββββββββββββββββββββββββββββ
describe('generateSignature', () => {
it('should produce valid HMAC-SHA256 signature', async () => {
const webhook = createMockWebhook({
events: ['message.received'],
secret: 'test-secret-123',
});
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
const capturedHeaders: Record<string, string> = {};
const mockFetch = undiciFetch as jest.Mock;
mockFetch.mockImplementation((_url: string, opts: RequestInit) => {
Object.assign(capturedHeaders, opts.headers as Record<string, string>);
return Promise.resolve({ ok: true, status: 200 });
});
const sigPayload: WebhookPayload = {
event: 'message.received',
data: {},
timestamp: '',
sessionId: 'sess-1',
idempotencyKey: 'k',
deliveryId: 'd',
};
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: {
sessionId: 'sess-1',
event: 'message.received',
payload: sigPayload,
},
});
await service.dispatch('sess-1', 'message.received', {});
// Verify signature format
expect(capturedHeaders['X-OpenWA-Signature']).toMatch(/^sha256=[a-f0-9]{64}$/);
// Verify signature correctness against the ACTUAL delivered body. The body now carries the
// server-canonical idempotency/delivery ids (re-asserted over the plugin's 'k'/'d'), so the
// signature is checked against what the receiver actually gets β the real verification contract.
const sentBody = (mockFetch.mock.calls[0] as [unknown, { body: string }])[1].body;
const expected = `sha256=${crypto.createHmac('sha256', 'test-secret-123').update(sentBody).digest('hex')}`;
expect(capturedHeaders['X-OpenWA-Signature']).toBe(expected);
mockFetch.mockReset();
});
});
// ββ dispatch (queue mode) βββββββββββββββββββββββββββββββββββββββββ
describe('dispatch (queue mode)', () => {
afterEach(() => (undiciFetch as jest.Mock).mockReset());
it('should add job to queue when queue is enabled', async () => {
// Create a new service with queue enabled
const queueModule: TestingModule = await Test.createTestingModule({
providers: [
WebhookService,
{ provide: getRepositoryToken(Webhook, 'data'), useValue: repository },
{ provide: getRepositoryToken(WebhookDeliveryFailure, 'data'), useValue: failureRepository },
{
provide: ConfigService,
useValue: {
get: jest.fn().mockImplementation(<T>(key: string, def?: T): T | boolean | number => {
if (key === 'queue.enabled') return true;
if (key === 'webhook.retryDelay') return 5000;
return def as T;
}),
},
},
{ provide: HookManager, useValue: hookManager },
{ provide: getQueueToken(QUEUE_NAMES.WEBHOOK), useValue: webhookQueue },
],
}).compile();
const queueService = queueModule.get<WebhookService>(WebhookService);
const webhook = createMockWebhook({ events: ['message.received'] });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
const queuePayload: WebhookPayload = {
event: 'message.received',
data: {},
timestamp: '',
sessionId: 'sess-1',
idempotencyKey: 'k',
deliveryId: 'd',
};
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: {
sessionId: 'sess-1',
event: 'message.received',
payload: queuePayload,
},
});
await queueService.dispatch('sess-1', 'message.received', {});
expect(webhookQueue.add).toHaveBeenCalledWith(
expect.stringContaining('webhook-'),
expect.objectContaining({
webhookId: 'wh-uuid-1',
url: 'https://example.com/webhook',
event: 'message.received',
}),
expect.objectContaining({
attempts: 3,
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
backoff: expect.objectContaining({ type: 'exponential' }),
}),
);
});
it('falls back to direct delivery when queue add fails', async () => {
const queueModule: TestingModule = await Test.createTestingModule({
providers: [
WebhookService,
{ provide: getRepositoryToken(Webhook, 'data'), useValue: repository },
{ provide: getRepositoryToken(WebhookDeliveryFailure, 'data'), useValue: failureRepository },
{
provide: ConfigService,
useValue: {
get: jest.fn().mockImplementation(<T>(key: string, def?: T): T | boolean | number => {
if (key === 'queue.enabled') return true;
if (key === 'webhook.retryDelay') return 5000;
if (key === 'webhook.timeout') return 25000;
return def as T;
}),
},
},
{ provide: HookManager, useValue: hookManager },
{ provide: getQueueToken(QUEUE_NAMES.WEBHOOK), useValue: webhookQueue },
],
}).compile();
const queueService = queueModule.get<WebhookService>(WebhookService);
const webhook = createMockWebhook({ events: ['message.received'], retryCount: 1 });
const queuePayload: WebhookPayload = {
event: 'message.received',
data: {},
timestamp: '',
sessionId: 'sess-1',
idempotencyKey: 'k',
deliveryId: 'd',
};
const mockFetch = undiciFetch as jest.Mock;
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(repository.update as jest.Mock).mockResolvedValue({ affected: 1 });
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: { sessionId: 'sess-1', event: 'message.received', payload: queuePayload },
});
webhookQueue.add.mockRejectedValueOnce(new Error('redis down'));
mockFetch.mockResolvedValue({ ok: true, status: 200 });
await queueService.dispatch('sess-1', 'message.received', {});
expect(webhookQueue.add).toHaveBeenCalled();
expect(mockFetch).toHaveBeenCalledWith(
'https://example.com/webhook',
expect.objectContaining({ method: 'POST' }),
);
expect(hookManager.execute).toHaveBeenCalledWith(
'webhook:delivered',
expect.objectContaining({ webhookId: webhook.id, fallback: 'queue_failed' }),
expect.anything(),
);
});
});
describe('delivery-failure dead-letter', () => {
it('records a durable failure when a direct delivery exhausts its retries', async () => {
const webhook = createMockWebhook({ events: ['message.received'], retryCount: 1 });
(repository.find as jest.Mock).mockResolvedValue([webhook]);
(hookManager.execute as jest.Mock).mockResolvedValue({
continue: true,
data: {
payload: {
event: 'message.received',
timestamp: '',
sessionId: 'sess-1',
idempotencyKey: 'k',
deliveryId: 'd',
data: {},
},
},
});
const mockFetch = undiciFetch as jest.Mock;
mockFetch.mockResolvedValue({ ok: false, status: 500, statusText: 'Server Error' });
const failuresBefore = getWebhookDeliveryFailuresTotal();
await service.dispatch('sess-1', 'message.received', {});
expect(failureRepository.insert).toHaveBeenCalledWith(
expect.objectContaining({
webhookId: webhook.id,
attempts: 1,
lastStatusCode: 500,
lastError: 'HTTP 500: Server Error',
}),
);
// The terminal failure also bumps the Prometheus counter exactly once.
expect(getWebhookDeliveryFailuresTotal()).toBe(failuresBefore + 1);
mockFetch.mockReset();
});
it('listDeliveryFailures queries most-recent-first, optionally scoped to a session', async () => {
(failureRepository.find as jest.Mock).mockResolvedValue([{ id: 'f1' }]);
const out = await service.listDeliveryFailures({ sessionId: 's1', limit: 10 });
expect(out).toHaveLength(1);
// sessionId resolves through resolveSessionScope, so the WHERE is an IN over the effective scope
// ([s1] here for an unrestricted key narrowing to one session) β behaviourally the same rows.
expect(failureRepository.find).toHaveBeenCalledWith(
expect.objectContaining({ where: { sessionId: In(['s1']) }, order: { createdAt: 'DESC' } }),
);
});
});
});
|