|
| 1 | +import { createSuccess } from './test-helpers/factories' |
| 2 | + |
| 3 | +const fetcher = jest.fn().mockReturnValue(createSuccess()) |
| 4 | +jest.mock('node-fetch', () => fetcher) |
| 5 | + |
| 6 | +import { AnalyticsNode, NodeSegmentEvent } from '../app/analytics-node' |
| 7 | +import { sleep } from './test-helpers/sleep' |
| 8 | +import { CoreContext, CorePlugin } from '@segment/analytics-core' |
| 9 | + |
| 10 | +const testPlugin: CorePlugin = { |
| 11 | + type: 'after', |
| 12 | + load: () => Promise.resolve(), |
| 13 | + name: 'foo', |
| 14 | + version: 'bar', |
| 15 | + isLoaded: () => true, |
| 16 | +} |
| 17 | + |
| 18 | +describe('Ability for users to exit without losing events', () => { |
| 19 | + let ajs!: AnalyticsNode |
| 20 | + beforeEach(async () => { |
| 21 | + jest.resetAllMocks() |
| 22 | + ajs = new AnalyticsNode({ |
| 23 | + writeKey: 'abc123', |
| 24 | + }) |
| 25 | + }) |
| 26 | + const _helpers = { |
| 27 | + makeTrackCall: (analytics = ajs, cb?: (...args: any[]) => void) => { |
| 28 | + analytics.track({ userId: 'foo', event: 'Thing Updated', callback: cb }) |
| 29 | + }, |
| 30 | + } |
| 31 | + |
| 32 | + describe('drained emitted event', () => { |
| 33 | + test('emits a drained event if only one event is dispatched', async () => { |
| 34 | + _helpers.makeTrackCall() |
| 35 | + return expect( |
| 36 | + new Promise((resolve) => ajs.once('drained', () => resolve(undefined))) |
| 37 | + ).resolves.toBe(undefined) |
| 38 | + }) |
| 39 | + |
| 40 | + test('emits a drained event if multiple events are dispatched', async () => { |
| 41 | + let drainedCalls = 0 |
| 42 | + ajs.on('drained', () => { |
| 43 | + drainedCalls++ |
| 44 | + }) |
| 45 | + _helpers.makeTrackCall() |
| 46 | + _helpers.makeTrackCall() |
| 47 | + _helpers.makeTrackCall() |
| 48 | + await sleep(200) |
| 49 | + expect(drainedCalls).toBe(1) |
| 50 | + }) |
| 51 | + |
| 52 | + test('all callbacks should be called ', async () => { |
| 53 | + const cb = jest.fn() |
| 54 | + ajs.track({ userId: 'foo', event: 'bar', callback: cb }) |
| 55 | + expect(cb).not.toHaveBeenCalled() |
| 56 | + await ajs.closeAndFlush() |
| 57 | + expect(cb).toBeCalled() |
| 58 | + }) |
| 59 | + |
| 60 | + test('all async callbacks should be called', async () => { |
| 61 | + const trackCall = new Promise<CoreContext>((resolve) => |
| 62 | + ajs.track({ |
| 63 | + userId: 'abc', |
| 64 | + event: 'def', |
| 65 | + callback: (ctx) => { |
| 66 | + return sleep(100).then(() => resolve(ctx)) |
| 67 | + }, |
| 68 | + }) |
| 69 | + ) |
| 70 | + const res = await Promise.race([ajs.closeAndFlush(), trackCall]) |
| 71 | + expect(res instanceof CoreContext).toBe(true) |
| 72 | + }) |
| 73 | + }) |
| 74 | + |
| 75 | + describe('.closeAndFlush()', () => { |
| 76 | + test('should force resolve if method call execution time exceeds specified timeout', async () => { |
| 77 | + const TIMEOUT = 300 |
| 78 | + await ajs.register({ |
| 79 | + ...testPlugin, |
| 80 | + track: async (ctx) => { |
| 81 | + await sleep(1000) |
| 82 | + return ctx |
| 83 | + }, |
| 84 | + }) |
| 85 | + _helpers.makeTrackCall(ajs) |
| 86 | + const startTime = Date.now() |
| 87 | + await ajs.closeAndFlush({ timeout: TIMEOUT }) |
| 88 | + const elapsedTime = Math.round(Date.now() - startTime) |
| 89 | + expect(elapsedTime).toBeLessThanOrEqual(TIMEOUT + 10) |
| 90 | + expect(elapsedTime).toBeGreaterThan(TIMEOUT - 10) |
| 91 | + }) |
| 92 | + |
| 93 | + test('no new events should be accepted (but existing ones should be flushed)', async () => { |
| 94 | + let trackCallCount = 0 |
| 95 | + ajs.on('track', () => { |
| 96 | + // track should only happen after successful dispatch |
| 97 | + trackCallCount += 1 |
| 98 | + }) |
| 99 | + _helpers.makeTrackCall() |
| 100 | + const closed = ajs.closeAndFlush() |
| 101 | + _helpers.makeTrackCall() // should not trigger |
| 102 | + _helpers.makeTrackCall() // should not trigger |
| 103 | + await closed |
| 104 | + expect(fetcher).toBeCalledTimes(1) |
| 105 | + expect(trackCallCount).toBe(1) |
| 106 | + }) |
| 107 | + test('any events created after close should be emitted', async () => { |
| 108 | + const events: NodeSegmentEvent[] = [] |
| 109 | + ajs.on('call_after_close', (event) => { |
| 110 | + events.push(event) |
| 111 | + }) |
| 112 | + _helpers.makeTrackCall() |
| 113 | + const closed = ajs.closeAndFlush() |
| 114 | + _helpers.makeTrackCall() // should be emitted |
| 115 | + _helpers.makeTrackCall() // should be emitted |
| 116 | + expect(events.length).toBe(2) |
| 117 | + expect(events.every((e) => e.type === 'track')).toBeTruthy() |
| 118 | + await closed |
| 119 | + }) |
| 120 | + |
| 121 | + test('if queue has multiple track events, all of those items should be dispatched, and drain and track events should be emitted', async () => { |
| 122 | + let drainedCalls = 0 |
| 123 | + ajs.on('drained', () => { |
| 124 | + drainedCalls++ |
| 125 | + }) |
| 126 | + let trackCalls = 0 |
| 127 | + ajs.on('track', () => { |
| 128 | + trackCalls++ |
| 129 | + }) |
| 130 | + await ajs.register({ |
| 131 | + ...testPlugin, |
| 132 | + track: async (ctx) => { |
| 133 | + await sleep(300) |
| 134 | + return ctx |
| 135 | + }, |
| 136 | + }) |
| 137 | + _helpers.makeTrackCall() |
| 138 | + _helpers.makeTrackCall() |
| 139 | + |
| 140 | + await ajs.closeAndFlush() |
| 141 | + |
| 142 | + expect(fetcher.mock.calls.length).toBe(2) |
| 143 | + |
| 144 | + expect(trackCalls).toBe(2) |
| 145 | + |
| 146 | + expect(drainedCalls).toBe(1) |
| 147 | + }) |
| 148 | + |
| 149 | + test('if no pending events, resolves immediately', async () => { |
| 150 | + const startTime = Date.now() |
| 151 | + await ajs.closeAndFlush() |
| 152 | + const elapsedTime = startTime - Date.now() |
| 153 | + expect(elapsedTime).toBeLessThan(20) |
| 154 | + }) |
| 155 | + |
| 156 | + test('if no pending events, drained should not be emitted an extra time when close is called', async () => { |
| 157 | + let called = false |
| 158 | + ajs.on('drained', () => { |
| 159 | + called = true |
| 160 | + }) |
| 161 | + await ajs.closeAndFlush() |
| 162 | + expect(called).toBeFalsy() |
| 163 | + }) |
| 164 | + }) |
| 165 | +}) |
0 commit comments