|
| 1 | +import { MessageQueue } from './queue'; |
| 2 | +import * as transport from './transport'; |
| 3 | +import type { Message } from './types'; |
| 4 | + |
| 5 | +jest.mock('./transport', () => ({ |
| 6 | + sendMessages: jest.fn().mockResolvedValue(true), |
| 7 | +})); |
| 8 | + |
| 9 | +const mockSend = transport.sendMessages as jest.MockedFunction<typeof transport.sendMessages>; |
| 10 | + |
| 11 | +beforeEach(() => { |
| 12 | + jest.clearAllMocks(); |
| 13 | + jest.useFakeTimers(); |
| 14 | + localStorage.clear(); |
| 15 | +}); |
| 16 | + |
| 17 | +afterEach(() => { |
| 18 | + jest.useRealTimers(); |
| 19 | +}); |
| 20 | + |
| 21 | +function makeMessage(overrides: Partial<Message> = {}): Message { |
| 22 | + return { |
| 23 | + type: 'track', |
| 24 | + messageId: `msg-${Math.random()}`, |
| 25 | + eventTimestamp: new Date().toISOString(), |
| 26 | + anonymousId: 'anon-1', |
| 27 | + context: { library: '@imtbl/audience-web-sdk', libraryVersion: '0.1.0' }, |
| 28 | + eventName: 'test', |
| 29 | + surface: 'web', |
| 30 | + ...overrides, |
| 31 | + } as Message; |
| 32 | +} |
| 33 | + |
| 34 | +describe('MessageQueue', () => { |
| 35 | + it('enqueues and flushes messages', async () => { |
| 36 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 37 | + queue.enqueue(makeMessage()); |
| 38 | + queue.enqueue(makeMessage()); |
| 39 | + |
| 40 | + await queue.flush(); |
| 41 | + |
| 42 | + expect(mockSend).toHaveBeenCalledTimes(1); |
| 43 | + const payload = mockSend.mock.calls[0][2]; |
| 44 | + expect(payload.messages).toHaveLength(2); |
| 45 | + }); |
| 46 | + |
| 47 | + it('auto-flushes when reaching flushSize', () => { |
| 48 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 3); |
| 49 | + |
| 50 | + queue.enqueue(makeMessage()); |
| 51 | + queue.enqueue(makeMessage()); |
| 52 | + expect(mockSend).not.toHaveBeenCalled(); |
| 53 | + |
| 54 | + queue.enqueue(makeMessage()); // triggers flush at size 3 |
| 55 | + expect(mockSend).toHaveBeenCalledTimes(1); |
| 56 | + }); |
| 57 | + |
| 58 | + it('flushes on timer interval', () => { |
| 59 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 1000, 100); |
| 60 | + queue.start(); |
| 61 | + |
| 62 | + queue.enqueue(makeMessage()); |
| 63 | + jest.advanceTimersByTime(1000); |
| 64 | + |
| 65 | + expect(mockSend).toHaveBeenCalledTimes(1); |
| 66 | + queue.stop(); |
| 67 | + }); |
| 68 | + |
| 69 | + it('does not flush when empty', async () => { |
| 70 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 71 | + await queue.flush(); |
| 72 | + expect(mockSend).not.toHaveBeenCalled(); |
| 73 | + }); |
| 74 | + |
| 75 | + it('retains messages on failed flush', async () => { |
| 76 | + mockSend.mockResolvedValueOnce(false); |
| 77 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 78 | + queue.enqueue(makeMessage()); |
| 79 | + |
| 80 | + await queue.flush(); |
| 81 | + expect(queue.length).toBe(1); // still in queue |
| 82 | + |
| 83 | + mockSend.mockResolvedValueOnce(true); |
| 84 | + await queue.flush(); |
| 85 | + expect(queue.length).toBe(0); // now drained |
| 86 | + }); |
| 87 | + |
| 88 | + it('clears all messages', () => { |
| 89 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 90 | + queue.enqueue(makeMessage()); |
| 91 | + queue.enqueue(makeMessage()); |
| 92 | + expect(queue.length).toBe(2); |
| 93 | + |
| 94 | + queue.clear(); |
| 95 | + expect(queue.length).toBe(0); |
| 96 | + }); |
| 97 | + |
| 98 | + it('purges messages matching a predicate', () => { |
| 99 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 100 | + queue.enqueue(makeMessage({ type: 'track' } as any)); |
| 101 | + queue.enqueue(makeMessage({ type: 'identify' } as any)); |
| 102 | + queue.enqueue(makeMessage({ type: 'track' } as any)); |
| 103 | + |
| 104 | + queue.purge((m) => m.type === 'identify'); |
| 105 | + expect(queue.length).toBe(2); |
| 106 | + }); |
| 107 | + |
| 108 | + it('transforms messages in place', async () => { |
| 109 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 110 | + queue.enqueue(makeMessage({ userId: 'should-strip' } as any)); |
| 111 | + |
| 112 | + queue.transform((m) => { |
| 113 | + const cleaned = { ...m }; |
| 114 | + delete (cleaned as any).userId; |
| 115 | + return cleaned; |
| 116 | + }); |
| 117 | + |
| 118 | + await queue.flush(); |
| 119 | + const msg = mockSend.mock.calls[0][2].messages[0]; |
| 120 | + expect((msg as any).userId).toBeUndefined(); |
| 121 | + }); |
| 122 | + |
| 123 | + it('calls onFlush callback', async () => { |
| 124 | + const onFlush = jest.fn(); |
| 125 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20, onFlush); |
| 126 | + queue.enqueue(makeMessage()); |
| 127 | + |
| 128 | + await queue.flush(); |
| 129 | + expect(onFlush).toHaveBeenCalledWith(true, 1); |
| 130 | + }); |
| 131 | + |
| 132 | + it('persists messages to localStorage', () => { |
| 133 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 134 | + queue.enqueue(makeMessage()); |
| 135 | + |
| 136 | + const stored = localStorage.getItem('__imtbl_web_queue'); |
| 137 | + expect(stored).not.toBeNull(); |
| 138 | + expect(JSON.parse(stored!)).toHaveLength(1); |
| 139 | + }); |
| 140 | + |
| 141 | + it('restores messages from localStorage on construction', () => { |
| 142 | + // Pre-populate storage |
| 143 | + const msg = makeMessage(); |
| 144 | + localStorage.setItem('__imtbl_web_queue', JSON.stringify([msg])); |
| 145 | + |
| 146 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 147 | + expect(queue.length).toBe(1); |
| 148 | + }); |
| 149 | + |
| 150 | + it('flushUnload sends with keepalive', () => { |
| 151 | + const queue = new MessageQueue('https://test.com/messages', 'pk_test', 5000, 20); |
| 152 | + queue.enqueue(makeMessage()); |
| 153 | + |
| 154 | + queue.flushUnload(); |
| 155 | + |
| 156 | + expect(mockSend).toHaveBeenCalledWith( |
| 157 | + 'https://test.com/messages', |
| 158 | + 'pk_test', |
| 159 | + expect.objectContaining({ messages: expect.any(Array) }), |
| 160 | + true, // keepalive |
| 161 | + ); |
| 162 | + expect(queue.length).toBe(0); |
| 163 | + }); |
| 164 | +}); |
0 commit comments