|
1 | | -import { expect, test } from 'vitest'; |
2 | | -import { arraysEqualShallow } from './utils'; |
| 1 | +import { expect, test, describe, vi, beforeEach, afterEach } from 'vitest'; |
| 2 | +import { arraysEqualShallow, fetchWithRetry } from './utils'; |
3 | 3 | import { isRemotePath } from '@sourcebot/shared'; |
| 4 | +import { Logger } from 'winston'; |
| 5 | +import { RequestError } from '@octokit/request-error'; |
| 6 | + |
| 7 | +vi.mock('@sentry/node', () => ({ |
| 8 | + captureException: vi.fn(), |
| 9 | +})); |
| 10 | + |
| 11 | +const createMockLogger = (): Logger => ({ |
| 12 | + warn: vi.fn(), |
| 13 | + error: vi.fn(), |
| 14 | + info: vi.fn(), |
| 15 | + debug: vi.fn(), |
| 16 | +} as unknown as Logger); |
4 | 17 |
|
5 | 18 | test('should return true for identical arrays', () => { |
6 | 19 | expect(arraysEqualShallow([1, 2, 3], [1, 2, 3])).toBe(true); |
@@ -69,3 +82,214 @@ test('isRemotePath should return false for non HTTP paths', () => { |
69 | 82 | expect(isRemotePath('')).toBe(false); |
70 | 83 | expect(isRemotePath(' ')).toBe(false); |
71 | 84 | }); |
| 85 | + |
| 86 | +describe('fetchWithRetry', () => { |
| 87 | + beforeEach(() => { |
| 88 | + vi.useFakeTimers(); |
| 89 | + }); |
| 90 | + |
| 91 | + afterEach(() => { |
| 92 | + vi.useRealTimers(); |
| 93 | + }); |
| 94 | + |
| 95 | + test('returns result on successful fetch', async () => { |
| 96 | + const logger = createMockLogger(); |
| 97 | + const fetchFn = vi.fn().mockResolvedValue('success'); |
| 98 | + |
| 99 | + const result = await fetchWithRetry(fetchFn, 'test', logger); |
| 100 | + |
| 101 | + expect(result).toBe('success'); |
| 102 | + expect(fetchFn).toHaveBeenCalledTimes(1); |
| 103 | + }); |
| 104 | + |
| 105 | + test('throws immediately for non-retryable errors (e.g., 404)', async () => { |
| 106 | + const logger = createMockLogger(); |
| 107 | + const error = { status: 404, message: 'Not Found' }; |
| 108 | + const fetchFn = vi.fn().mockRejectedValue(error); |
| 109 | + |
| 110 | + await expect(fetchWithRetry(fetchFn, 'test', logger)).rejects.toEqual(error); |
| 111 | + expect(fetchFn).toHaveBeenCalledTimes(1); |
| 112 | + }); |
| 113 | + |
| 114 | + test('throws immediately for non-retryable errors (e.g., 401)', async () => { |
| 115 | + const logger = createMockLogger(); |
| 116 | + const error = { status: 401, message: 'Unauthorized' }; |
| 117 | + const fetchFn = vi.fn().mockRejectedValue(error); |
| 118 | + |
| 119 | + await expect(fetchWithRetry(fetchFn, 'test', logger)).rejects.toEqual(error); |
| 120 | + expect(fetchFn).toHaveBeenCalledTimes(1); |
| 121 | + }); |
| 122 | + |
| 123 | + test('retries on 429 (Too Many Requests) and succeeds', async () => { |
| 124 | + const logger = createMockLogger(); |
| 125 | + const error = { status: 429, message: 'Too Many Requests' }; |
| 126 | + const fetchFn = vi.fn() |
| 127 | + .mockRejectedValueOnce(error) |
| 128 | + .mockResolvedValueOnce('success'); |
| 129 | + |
| 130 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger); |
| 131 | + |
| 132 | + // Advance timer to trigger retry |
| 133 | + await vi.advanceTimersByTimeAsync(3000); |
| 134 | + |
| 135 | + const result = await resultPromise; |
| 136 | + expect(result).toBe('success'); |
| 137 | + expect(fetchFn).toHaveBeenCalledTimes(2); |
| 138 | + expect(logger.warn).toHaveBeenCalled(); |
| 139 | + }); |
| 140 | + |
| 141 | + test('retries on 403 (Forbidden) and succeeds', async () => { |
| 142 | + const logger = createMockLogger(); |
| 143 | + const error = { status: 403, message: 'Forbidden' }; |
| 144 | + const fetchFn = vi.fn() |
| 145 | + .mockRejectedValueOnce(error) |
| 146 | + .mockResolvedValueOnce('success'); |
| 147 | + |
| 148 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger); |
| 149 | + |
| 150 | + await vi.advanceTimersByTimeAsync(3000); |
| 151 | + |
| 152 | + const result = await resultPromise; |
| 153 | + expect(result).toBe('success'); |
| 154 | + expect(fetchFn).toHaveBeenCalledTimes(2); |
| 155 | + }); |
| 156 | + |
| 157 | + test('retries on 503 (Service Unavailable) and succeeds', async () => { |
| 158 | + const logger = createMockLogger(); |
| 159 | + const error = { status: 503, message: 'Service Unavailable' }; |
| 160 | + const fetchFn = vi.fn() |
| 161 | + .mockRejectedValueOnce(error) |
| 162 | + .mockResolvedValueOnce('success'); |
| 163 | + |
| 164 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger); |
| 165 | + |
| 166 | + await vi.advanceTimersByTimeAsync(3000); |
| 167 | + |
| 168 | + const result = await resultPromise; |
| 169 | + expect(result).toBe('success'); |
| 170 | + expect(fetchFn).toHaveBeenCalledTimes(2); |
| 171 | + }); |
| 172 | + |
| 173 | + test('retries on 500 (Internal Server Error) and succeeds', async () => { |
| 174 | + const logger = createMockLogger(); |
| 175 | + const error = { status: 500, message: 'Internal Server Error' }; |
| 176 | + const fetchFn = vi.fn() |
| 177 | + .mockRejectedValueOnce(error) |
| 178 | + .mockResolvedValueOnce('success'); |
| 179 | + |
| 180 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger); |
| 181 | + |
| 182 | + await vi.advanceTimersByTimeAsync(3000); |
| 183 | + |
| 184 | + const result = await resultPromise; |
| 185 | + expect(result).toBe('success'); |
| 186 | + expect(fetchFn).toHaveBeenCalledTimes(2); |
| 187 | + }); |
| 188 | + |
| 189 | + test('throws after max attempts exceeded', async () => { |
| 190 | + const logger = createMockLogger(); |
| 191 | + const error = { status: 429, message: 'Too Many Requests' }; |
| 192 | + const fetchFn = vi.fn().mockRejectedValue(error); |
| 193 | + |
| 194 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger, 3); |
| 195 | + // Prevent unhandled rejection warning while we advance timers |
| 196 | + resultPromise.catch(() => {}); |
| 197 | + |
| 198 | + // Advance through all retry attempts |
| 199 | + await vi.advanceTimersByTimeAsync(3000); // 1st retry |
| 200 | + await vi.advanceTimersByTimeAsync(6000); // 2nd retry |
| 201 | + |
| 202 | + await expect(resultPromise).rejects.toEqual(error); |
| 203 | + expect(fetchFn).toHaveBeenCalledTimes(3); |
| 204 | + }); |
| 205 | + |
| 206 | + test('uses exponential backoff for wait times', async () => { |
| 207 | + const logger = createMockLogger(); |
| 208 | + const error = { status: 429, message: 'Too Many Requests' }; |
| 209 | + const fetchFn = vi.fn() |
| 210 | + .mockRejectedValueOnce(error) |
| 211 | + .mockRejectedValueOnce(error) |
| 212 | + .mockResolvedValueOnce('success'); |
| 213 | + |
| 214 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger, 4); |
| 215 | + |
| 216 | + // First retry: 3000 * 2^0 = 3000ms |
| 217 | + await vi.advanceTimersByTimeAsync(3000); |
| 218 | + expect(fetchFn).toHaveBeenCalledTimes(2); |
| 219 | + |
| 220 | + // Second retry: 3000 * 2^1 = 6000ms |
| 221 | + await vi.advanceTimersByTimeAsync(6000); |
| 222 | + expect(fetchFn).toHaveBeenCalledTimes(3); |
| 223 | + |
| 224 | + const result = await resultPromise; |
| 225 | + expect(result).toBe('success'); |
| 226 | + }); |
| 227 | + |
| 228 | + test('respects x-ratelimit-reset header for Octokit errors', async () => { |
| 229 | + const logger = createMockLogger(); |
| 230 | + const now = Date.now(); |
| 231 | + const resetTime = Math.floor((now + 5000) / 1000); // 5 seconds from now |
| 232 | + |
| 233 | + const error = new RequestError('Rate limit exceeded', 429, { |
| 234 | + response: { |
| 235 | + headers: { |
| 236 | + 'x-ratelimit-reset': String(resetTime), |
| 237 | + }, |
| 238 | + status: 429, |
| 239 | + url: 'https://api.github.com/test', |
| 240 | + data: {}, |
| 241 | + }, |
| 242 | + request: { |
| 243 | + method: 'GET', |
| 244 | + url: 'https://api.github.com/test', |
| 245 | + headers: {}, |
| 246 | + }, |
| 247 | + }); |
| 248 | + |
| 249 | + const fetchFn = vi.fn() |
| 250 | + .mockRejectedValueOnce(error) |
| 251 | + .mockResolvedValueOnce('success'); |
| 252 | + |
| 253 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger); |
| 254 | + |
| 255 | + // Should wait approximately 5000ms based on the reset header |
| 256 | + await vi.advanceTimersByTimeAsync(5000); |
| 257 | + |
| 258 | + const result = await resultPromise; |
| 259 | + expect(result).toBe('success'); |
| 260 | + expect(fetchFn).toHaveBeenCalledTimes(2); |
| 261 | + }); |
| 262 | + |
| 263 | + test('respects custom maxAttempts parameter', async () => { |
| 264 | + const logger = createMockLogger(); |
| 265 | + const error = { status: 503, message: 'Service Unavailable' }; |
| 266 | + const fetchFn = vi.fn().mockRejectedValue(error); |
| 267 | + |
| 268 | + const resultPromise = fetchWithRetry(fetchFn, 'test', logger, 2); |
| 269 | + // Prevent unhandled rejection warning while we advance timers |
| 270 | + resultPromise.catch(() => {}); |
| 271 | + |
| 272 | + await vi.advanceTimersByTimeAsync(3000); |
| 273 | + |
| 274 | + await expect(resultPromise).rejects.toEqual(error); |
| 275 | + expect(fetchFn).toHaveBeenCalledTimes(2); |
| 276 | + }); |
| 277 | + |
| 278 | + test('logs warning on each retry attempt', async () => { |
| 279 | + const logger = createMockLogger(); |
| 280 | + const error = { status: 429, message: 'Too Many Requests' }; |
| 281 | + const fetchFn = vi.fn() |
| 282 | + .mockRejectedValueOnce(error) |
| 283 | + .mockResolvedValueOnce('success'); |
| 284 | + |
| 285 | + const resultPromise = fetchWithRetry(fetchFn, 'test-identifier', logger); |
| 286 | + |
| 287 | + await vi.advanceTimersByTimeAsync(3000); |
| 288 | + await resultPromise; |
| 289 | + |
| 290 | + expect(logger.warn).toHaveBeenCalledTimes(1); |
| 291 | + expect(logger.warn).toHaveBeenCalledWith( |
| 292 | + expect.stringContaining('test-identifier') |
| 293 | + ); |
| 294 | + }); |
| 295 | +}); |
0 commit comments