|
| 1 | +import * as events from 'node:events'; |
| 2 | +import { timeout, waiter } from '../time'; |
| 3 | + |
| 4 | +describe('Helper tests', () => { |
| 5 | + test('timeout function should not cause memory leak by accumulating abort listeners on abort', async () => { |
| 6 | + const controller = new AbortController(); |
| 7 | + const { signal } = controller; |
| 8 | + |
| 9 | + const countListeners = () => events.getEventListeners(signal, 'abort').length; |
| 10 | + |
| 11 | + // Ensure the initial listener count is zero |
| 12 | + expect(countListeners()).toBe(0); |
| 13 | + |
| 14 | + // Run enough iterations to detect a pattern |
| 15 | + for (let i = 0; i < 100; i++) { |
| 16 | + try { |
| 17 | + const sleepPromise = timeout(1000, signal); |
| 18 | + controller.abort(); // Abort immediately |
| 19 | + await sleepPromise; |
| 20 | + } catch (err: any) { |
| 21 | + expect(err.toString()).toMatch(/aborted/i); |
| 22 | + } |
| 23 | + |
| 24 | + // Assert that listener count does not increase |
| 25 | + expect(countListeners()).toBeLessThanOrEqual(1); // 1 listener may temporarily be added and removed |
| 26 | + } |
| 27 | + |
| 28 | + // Final check to confirm listeners are cleaned up |
| 29 | + expect(countListeners()).toBe(0); |
| 30 | + }); |
| 31 | + |
| 32 | + test('timeout function should not cause memory leak by accumulating abort listeners on successful completion', async () => { |
| 33 | + const controller = new AbortController(); |
| 34 | + const { signal } = controller; |
| 35 | + |
| 36 | + const countListeners = () => events.getEventListeners(signal, 'abort').length; |
| 37 | + |
| 38 | + // Ensure the initial listener count is zero |
| 39 | + expect(countListeners()).toBe(0); |
| 40 | + |
| 41 | + // Run enough iterations to detect a pattern |
| 42 | + for (let i = 0; i < 100; i++) { |
| 43 | + await timeout(2, signal); // Complete sleep without abort |
| 44 | + |
| 45 | + // Assert that listener count does not increase |
| 46 | + expect(countListeners()).toBe(0); // No listeners should remain after successful sleep completion |
| 47 | + } |
| 48 | + |
| 49 | + // Final check to confirm listeners are cleaned up |
| 50 | + expect(countListeners()).toBe(0); |
| 51 | + }); |
| 52 | + |
| 53 | + test('waiter is resolved', async () => { |
| 54 | + const myWaiter = waiter(); |
| 55 | + myWaiter.resolve(); |
| 56 | + await myWaiter; |
| 57 | + expect(myWaiter.isFinished).toBe(true); |
| 58 | + expect(myWaiter.isRejected).toBe(false); |
| 59 | + expect(myWaiter.isResolved).toBe(true); |
| 60 | + }); |
| 61 | + |
| 62 | + test('waiter is resolved with value', async () => { |
| 63 | + const myWaiter = waiter<string>(); |
| 64 | + const value = 'my resolve result'; |
| 65 | + myWaiter.resolve(value); |
| 66 | + const result = await myWaiter; |
| 67 | + expect(result).toBe(value); |
| 68 | + expect(myWaiter.isFinished).toBe(true); |
| 69 | + expect(myWaiter.isRejected).toBe(false); |
| 70 | + expect(myWaiter.isResolved).toBe(true); |
| 71 | + }); |
| 72 | + |
| 73 | + test('waiter is finished (ensure finish alias works)', async () => { |
| 74 | + const myWaiter = waiter(); |
| 75 | + myWaiter.finish(); |
| 76 | + await myWaiter; |
| 77 | + expect(myWaiter.isFinished).toBe(true); |
| 78 | + expect(myWaiter.isRejected).toBe(false); |
| 79 | + expect(myWaiter.isResolved).toBe(true); |
| 80 | + }); |
| 81 | + |
| 82 | + test('waiter is rejected', async () => { |
| 83 | + const myWaiter = waiter(); |
| 84 | + const error = new Error('Waiter was rejected'); |
| 85 | + myWaiter.reject(error); |
| 86 | + await expect(myWaiter).rejects.toThrow(error); |
| 87 | + expect(myWaiter.isFinished).toBe(true); |
| 88 | + expect(myWaiter.isRejected).toBe(true); |
| 89 | + expect(myWaiter.isResolved).toBe(false); |
| 90 | + }); |
| 91 | + |
| 92 | + test('waiter is rejected with error type', async () => { |
| 93 | + class MyError extends Error { |
| 94 | + readonly name = 'MyError'; |
| 95 | + } |
| 96 | + const myWaiter = waiter<void, MyError>(); |
| 97 | + const error = new MyError('MyError test instance'); |
| 98 | + myWaiter.reject(error); |
| 99 | + await expect(myWaiter).rejects.toThrow(error); |
| 100 | + expect(myWaiter.isFinished).toBe(true); |
| 101 | + expect(myWaiter.isRejected).toBe(true); |
| 102 | + expect(myWaiter.isResolved).toBe(false); |
| 103 | + |
| 104 | + // Expect other error types to cause a typescript error |
| 105 | + class OtherError extends Error { |
| 106 | + readonly name = 'OtherError'; |
| 107 | + } |
| 108 | + // eslint-disable-next-line @typescript-eslint/ban-ts-comment |
| 109 | + // @ts-expect-error |
| 110 | + myWaiter.reject(new OtherError('OtherError test instance')); |
| 111 | + }); |
| 112 | +}); |
0 commit comments