|
| 1 | +import { afterEach, describe, expect, it, vi } from 'vitest'; |
| 2 | + |
| 3 | +import { |
| 4 | + ActionDeadline, |
| 5 | + DeadlineReached, |
| 6 | + MAX_TIMER_DELAY_MILLISECONDS, |
| 7 | + type DeadlineTiming, |
| 8 | +} from '../src/deadline'; |
| 9 | + |
| 10 | +interface ScheduledTimer { |
| 11 | + callback: () => void; |
| 12 | + milliseconds: number; |
| 13 | +} |
| 14 | + |
| 15 | +const manualTiming = () => { |
| 16 | + let now = 0; |
| 17 | + let nextTimer = 1; |
| 18 | + const timers = new Map<number, ScheduledTimer>(); |
| 19 | + const scheduledDelays: number[] = []; |
| 20 | + const clearedTimers: number[] = []; |
| 21 | + const timing: DeadlineTiming = { |
| 22 | + now: () => now, |
| 23 | + setTimeout: (callback, milliseconds) => { |
| 24 | + const timer = nextTimer++; |
| 25 | + timers.set(timer, { callback, milliseconds }); |
| 26 | + scheduledDelays.push(milliseconds); |
| 27 | + return timer as unknown as ReturnType<typeof setTimeout>; |
| 28 | + }, |
| 29 | + clearTimeout: (timer) => { |
| 30 | + const timerId = timer as unknown as number; |
| 31 | + timers.delete(timerId); |
| 32 | + clearedTimers.push(timerId); |
| 33 | + }, |
| 34 | + }; |
| 35 | + |
| 36 | + return { |
| 37 | + timing, |
| 38 | + advanceTo: (milliseconds: number) => { |
| 39 | + now = milliseconds; |
| 40 | + }, |
| 41 | + deliverNextTimer: () => { |
| 42 | + const entry = timers.entries().next().value as [number, ScheduledTimer] | undefined; |
| 43 | + if (!entry) { |
| 44 | + throw new Error('No timer is scheduled'); |
| 45 | + } |
| 46 | + const [timer, scheduled] = entry; |
| 47 | + timers.delete(timer); |
| 48 | + scheduled.callback(); |
| 49 | + return scheduled.milliseconds; |
| 50 | + }, |
| 51 | + scheduledDelays, |
| 52 | + clearedTimers, |
| 53 | + timerCount: () => timers.size, |
| 54 | + }; |
| 55 | +}; |
| 56 | + |
| 57 | +const deferred = <T>() => { |
| 58 | + let resolve!: (value: T) => void; |
| 59 | + let reject!: (error: unknown) => void; |
| 60 | + const promise = new Promise<T>((resolvePromise, rejectPromise) => { |
| 61 | + resolve = resolvePromise; |
| 62 | + reject = rejectPromise; |
| 63 | + }); |
| 64 | + return { promise, reject, resolve }; |
| 65 | +}; |
| 66 | + |
| 67 | +describe('ActionDeadline', () => { |
| 68 | + afterEach(() => { |
| 69 | + vi.restoreAllMocks(); |
| 70 | + }); |
| 71 | + |
| 72 | + it.each(['continue', 'abort'] as const)( |
| 73 | + 'chunks a long %s deadline without expiring before monotonic time reaches it', |
| 74 | + async (mode) => { |
| 75 | + const fake = manualTiming(); |
| 76 | + const seconds = 2_147_484; |
| 77 | + const deadline = new ActionDeadline({ mode, seconds }, fake.timing); |
| 78 | + |
| 79 | + expect(deadline.signal?.aborted).toBe(false); |
| 80 | + expect(fake.scheduledDelays).toEqual([MAX_TIMER_DELAY_MILLISECONDS]); |
| 81 | + |
| 82 | + fake.advanceTo(MAX_TIMER_DELAY_MILLISECONDS); |
| 83 | + expect(fake.deliverNextTimer()).toBe(MAX_TIMER_DELAY_MILLISECONDS); |
| 84 | + |
| 85 | + expect(deadline.signal?.aborted).toBe(false); |
| 86 | + expect(fake.scheduledDelays).toEqual([MAX_TIMER_DELAY_MILLISECONDS, 353]); |
| 87 | + |
| 88 | + fake.advanceTo(seconds * 1000); |
| 89 | + fake.deliverNextTimer(); |
| 90 | + |
| 91 | + expect(deadline.signal?.aborted).toBe(true); |
| 92 | + await expect(deadline.race(async () => 'too late')).rejects.toEqual( |
| 93 | + new DeadlineReached(mode, seconds), |
| 94 | + ); |
| 95 | + expect(fake.scheduledDelays.every((delay) => delay <= MAX_TIMER_DELAY_MILLISECONDS)).toBe( |
| 96 | + true, |
| 97 | + ); |
| 98 | + }, |
| 99 | + ); |
| 100 | + |
| 101 | + it('clears the currently armed timer during cleanup after a chunk re-arms', () => { |
| 102 | + const fake = manualTiming(); |
| 103 | + const deadline = new ActionDeadline({ mode: 'abort', seconds: 2_147_484 }, fake.timing); |
| 104 | + |
| 105 | + fake.advanceTo(MAX_TIMER_DELAY_MILLISECONDS); |
| 106 | + fake.deliverNextTimer(); |
| 107 | + expect(fake.timerCount()).toBe(1); |
| 108 | + |
| 109 | + deadline.dispose(); |
| 110 | + |
| 111 | + expect(fake.timerCount()).toBe(0); |
| 112 | + expect(fake.clearedTimers).toHaveLength(1); |
| 113 | + }); |
| 114 | + |
| 115 | + it('chunks a long polling sleep without scheduling a timer beyond the Node limit', async () => { |
| 116 | + const fake = manualTiming(); |
| 117 | + const seconds = 2_147_484; |
| 118 | + const deadline = new ActionDeadline(undefined, fake.timing); |
| 119 | + const sleep = deadline.sleepSeconds(seconds); |
| 120 | + |
| 121 | + expect(fake.scheduledDelays).toEqual([MAX_TIMER_DELAY_MILLISECONDS]); |
| 122 | + |
| 123 | + fake.advanceTo(MAX_TIMER_DELAY_MILLISECONDS); |
| 124 | + fake.deliverNextTimer(); |
| 125 | + for (let microtask = 0; microtask < 8; microtask += 1) { |
| 126 | + await Promise.resolve(); |
| 127 | + } |
| 128 | + |
| 129 | + expect(fake.scheduledDelays).toEqual([MAX_TIMER_DELAY_MILLISECONDS, 353]); |
| 130 | + |
| 131 | + fake.advanceTo(seconds * 1000); |
| 132 | + fake.deliverNextTimer(); |
| 133 | + |
| 134 | + await expect(sleep).resolves.toBeUndefined(); |
| 135 | + expect(fake.scheduledDelays.every((delay) => delay <= MAX_TIMER_DELAY_MILLISECONDS)).toBe(true); |
| 136 | + }); |
| 137 | + |
| 138 | + it('re-checks monotonic time when an operation resolves before the timer callback is delivered', async () => { |
| 139 | + const fake = manualTiming(); |
| 140 | + const operation = deferred<string>(); |
| 141 | + const deadline = new ActionDeadline({ mode: 'abort', seconds: 1 }, fake.timing); |
| 142 | + const result = deadline.race(() => operation.promise); |
| 143 | + |
| 144 | + fake.advanceTo(1_001); |
| 145 | + operation.resolve('late value'); |
| 146 | + |
| 147 | + await expect(result).rejects.toEqual(new DeadlineReached('abort', 1)); |
| 148 | + expect(deadline.signal?.aborted).toBe(true); |
| 149 | + }); |
| 150 | + |
| 151 | + it('re-checks monotonic time when an operation rejects before the timer callback is delivered', async () => { |
| 152 | + const fake = manualTiming(); |
| 153 | + const operation = deferred<string>(); |
| 154 | + const deadline = new ActionDeadline({ mode: 'continue', seconds: 1 }, fake.timing); |
| 155 | + const result = deadline.race(() => operation.promise); |
| 156 | + |
| 157 | + fake.advanceTo(1_001); |
| 158 | + operation.reject(new Error('late API failure')); |
| 159 | + |
| 160 | + await expect(result).rejects.toEqual(new DeadlineReached('continue', 1)); |
| 161 | + expect(deadline.signal?.aborted).toBe(true); |
| 162 | + }); |
| 163 | + |
| 164 | + it('allows an operation that resolves immediately before the deadline', async () => { |
| 165 | + const fake = manualTiming(); |
| 166 | + const operation = deferred<string>(); |
| 167 | + const deadline = new ActionDeadline({ mode: 'continue', seconds: 1 }, fake.timing); |
| 168 | + const result = deadline.race(() => operation.promise); |
| 169 | + |
| 170 | + fake.advanceTo(999); |
| 171 | + operation.resolve('on time'); |
| 172 | + |
| 173 | + await expect(result).resolves.toBe('on time'); |
| 174 | + expect(deadline.signal?.aborted).toBe(false); |
| 175 | + }); |
| 176 | + |
| 177 | + it('treats the exact monotonic boundary as expired', async () => { |
| 178 | + const fake = manualTiming(); |
| 179 | + const deadline = new ActionDeadline({ mode: 'continue', seconds: 1 }, fake.timing); |
| 180 | + |
| 181 | + fake.advanceTo(1_000); |
| 182 | + |
| 183 | + await expect(deadline.race(async () => 'boundary value')).rejects.toEqual( |
| 184 | + new DeadlineReached('continue', 1), |
| 185 | + ); |
| 186 | + expect(deadline.signal?.aborted).toBe(true); |
| 187 | + }); |
| 188 | + |
| 189 | + it('cancels pending work idempotently without marking the configured deadline as reached', () => { |
| 190 | + const fake = manualTiming(); |
| 191 | + const deadline = new ActionDeadline({ mode: 'abort', seconds: 10 }, fake.timing); |
| 192 | + const reason = new Error('terminal API failure'); |
| 193 | + |
| 194 | + deadline.cancel(reason); |
| 195 | + deadline.cancel(new Error('later cancellation')); |
| 196 | + |
| 197 | + expect(deadline.signal?.aborted).toBe(true); |
| 198 | + expect(deadline.signal?.reason).toBe(reason); |
| 199 | + expect(() => deadline.throwIfReached()).not.toThrow(); |
| 200 | + expect(fake.timerCount()).toBe(1); |
| 201 | + |
| 202 | + deadline.dispose(); |
| 203 | + expect(fake.timerCount()).toBe(0); |
| 204 | + }); |
| 205 | + |
| 206 | + it('preserves the configured deadline outcome when cancellation follows expiration', async () => { |
| 207 | + const fake = manualTiming(); |
| 208 | + const deadline = new ActionDeadline({ mode: 'continue', seconds: 1 }, fake.timing); |
| 209 | + |
| 210 | + fake.advanceTo(1_000); |
| 211 | + fake.deliverNextTimer(); |
| 212 | + deadline.cancel(new Error('terminal API failure')); |
| 213 | + |
| 214 | + await expect(deadline.race(async () => 'too late')).rejects.toEqual( |
| 215 | + new DeadlineReached('continue', 1), |
| 216 | + ); |
| 217 | + }); |
| 218 | +}); |
0 commit comments