GitNexus/gitnexus/test/unit/integrations/resilient-fetch.test.ts

574 lines
22 KiB
TypeScript

import { describe, it, expect, beforeEach, vi } from 'vitest';
import {
CircuitBreaker,
CircuitOpenError,
parseRetryAfter,
resilientFetch,
ResilientFetchExhaustedError,
RETRY_AFTER_CAP_MS,
} from 'gitnexus-shared';
import { __resetBreakerRegistry__, classifyOutcome } from 'gitnexus-shared/test-helpers';
describe('parseRetryAfter', () => {
it('parses delta-seconds form', () => {
expect(parseRetryAfter('30')).toBe(30_000);
expect(parseRetryAfter('0')).toBe(0);
});
it('returns null on negative or non-numeric garbage', () => {
expect(parseRetryAfter(null)).toBeNull();
expect(parseRetryAfter('')).toBeNull();
expect(parseRetryAfter(' ')).toBeNull();
expect(parseRetryAfter('not-a-number')).toBeNull();
});
it('parses HTTP-date form against an injected clock', () => {
const now = () => Date.parse('Wed, 21 Oct 2025 07:28:00 GMT');
expect(parseRetryAfter('Wed, 21 Oct 2025 07:28:30 GMT', now)).toBe(30_000);
});
it('returns 0 (not negative) on past HTTP-date', () => {
const now = () => Date.parse('Wed, 21 Oct 2025 08:00:00 GMT');
expect(parseRetryAfter('Wed, 21 Oct 2025 07:28:00 GMT', now)).toBe(0);
});
});
describe('classifyOutcome', () => {
const now = () => 1_700_000_000_000;
it('classifies 2xx as success', () => {
const resp = new Response(null, { status: 204 });
const out = classifyOutcome({ kind: 'response', resp }, now);
expect(out.kind).toBe('success');
});
it('classifies 5xx as retryable-status without afterMs', () => {
const resp = new Response(null, { status: 503 });
const out = classifyOutcome({ kind: 'response', resp }, now);
expect(out.kind).toBe('retryable-status');
if (out.kind === 'retryable-status') expect(out.afterMs).toBeUndefined();
});
it('classifies 429 with Retry-After (capped) as retryable-status', () => {
const resp = new Response(null, { status: 429, headers: { 'Retry-After': '99999' } });
const out = classifyOutcome({ kind: 'response', resp }, now);
expect(out.kind).toBe('retryable-status');
if (out.kind === 'retryable-status') expect(out.afterMs).toBe(RETRY_AFTER_CAP_MS);
});
it('classifies 429 from a header-less fetch mock without throwing', () => {
// Tests sometimes stub `fetch` with a plain `{ ok, status }` object
// (e.g. http-embedder.test.ts). Real `Response` always carries
// `Headers`, but the helper must not crash when the stub does not.
// Falls through to exponential-backoff retry like a 429 with no
// Retry-After header.
const resp = { ok: false, status: 429 } as unknown as Response;
const out = classifyOutcome({ kind: 'response', resp }, now);
expect(out.kind).toBe('retryable-status');
if (out.kind === 'retryable-status') expect(out.afterMs).toBeUndefined();
});
it('classifies 401/403/404/422 as terminal-client', () => {
for (const status of [401, 403, 404, 422, 400]) {
const resp = new Response(null, { status });
const out = classifyOutcome({ kind: 'response', resp }, now);
expect(out.kind).toBe('terminal-client');
}
});
it('classifies TimeoutError as terminal-network', () => {
const err = new DOMException('aborted', 'TimeoutError');
const out = classifyOutcome({ kind: 'error', err }, now);
expect(out.kind).toBe('terminal-network');
});
it('classifies generic network throw as retryable-network', () => {
const err = new TypeError('fetch failed');
const out = classifyOutcome({ kind: 'error', err }, now);
expect(out.kind).toBe('retryable-network');
});
});
describe('resilientFetch', () => {
const URL_STR = 'https://example.test/api/dispatch';
beforeEach(() => __resetBreakerRegistry__());
function jsonResp(status: number, headers?: Record<string, string>): Response {
return new Response(null, { status, headers });
}
function makeBreaker(opts: Partial<ConstructorParameters<typeof CircuitBreaker>[0]> = {}) {
let t = 1_700_000_000_000;
const breaker = new CircuitBreaker({
failureThreshold: 3,
cooldownMs: 30_000,
key: 'test',
now: () => t,
...opts,
});
return { breaker, advance: (ms: number) => (t += ms) };
}
it('204 returns immediately, no retries, breaker stays closed', async () => {
const fetchImpl = vi.fn(async () => jsonResp(204));
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
const resp = await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep },
});
expect(resp.status).toBe(204);
expect(fetchImpl).toHaveBeenCalledTimes(1);
expect(sleep).not.toHaveBeenCalled();
expect(breaker.getState()).toBe('closed');
expect(breaker.getConsecutiveFailures()).toBe(0);
});
it('one 503 then 204 → retried once, returns 204, breaker stays closed', async () => {
let n = 0;
const fetchImpl = vi.fn(async () => {
n += 1;
return n === 1 ? jsonResp(503) : jsonResp(204);
});
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
const resp = await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep, random: () => 0.5, baseDelayMs: 100, capDelayMs: 1000 },
});
expect(resp.status).toBe(204);
expect(fetchImpl).toHaveBeenCalledTimes(2);
expect(sleep).toHaveBeenCalledTimes(1);
expect(breaker.getConsecutiveFailures()).toBe(0);
});
it('429 with Retry-After honored (capped at RETRY_AFTER_CAP_MS)', async () => {
let n = 0;
const fetchImpl = vi.fn(async () => {
n += 1;
return n === 1 ? jsonResp(429, { 'Retry-After': '1' }) : jsonResp(204);
});
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep },
});
expect(sleep).toHaveBeenCalledWith(1000); // 1s
});
it('429 with absurd Retry-After is capped to RETRY_AFTER_CAP_MS', async () => {
let n = 0;
const fetchImpl = vi.fn(async () => {
n += 1;
return n === 1 ? jsonResp(429, { 'Retry-After': '99999' }) : jsonResp(204);
});
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep, capDelayMs: 999_999 }, // ensure cap comes from RETRY_AFTER_CAP_MS, not retry config
});
expect(sleep).toHaveBeenCalledWith(RETRY_AFTER_CAP_MS);
});
it('429 without Retry-After falls back to exponential-backoff delay', async () => {
let n = 0;
const fetchImpl = vi.fn(async () => {
n += 1;
return n === 1 ? jsonResp(429) : jsonResp(204);
});
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep, baseDelayMs: 100, capDelayMs: 1000, random: () => 0.5 },
});
// attempt 0: full-jitter upper = min(1000, 100*1) = 100; floor(0.5*100) = 50
expect(sleep).toHaveBeenCalledWith(50);
});
it('lets a caller set a stricter Retry-After cap', async () => {
let n = 0;
const fetchImpl = vi.fn(async () => {
n += 1;
return n === 1 ? jsonResp(429, { 'Retry-After': '60' }) : jsonResp(204);
});
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep, capDelayMs: 2500, retryAfterCapMs: 2500 },
});
expect(sleep).toHaveBeenCalledWith(2500);
});
it('401 returned as Response, no retry, breaker not incremented', async () => {
const fetchImpl = vi.fn(async () => jsonResp(401));
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
const resp = await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep },
});
expect(resp.status).toBe(401);
expect(fetchImpl).toHaveBeenCalledTimes(1);
expect(breaker.getConsecutiveFailures()).toBe(0);
});
it('422 returned as Response, no retry', async () => {
const fetchImpl = vi.fn(async () => jsonResp(422));
const { breaker } = makeBreaker();
const resp = await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {} },
});
expect(resp.status).toBe(422);
expect(fetchImpl).toHaveBeenCalledTimes(1);
});
it('TimeoutError rethrown immediately, no retry, breaker not incremented', async () => {
const fetchImpl = vi.fn(async () => {
throw new DOMException('aborted', 'TimeoutError');
});
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
await expect(
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep },
}),
).rejects.toThrow(DOMException);
expect(fetchImpl).toHaveBeenCalledTimes(1);
expect(sleep).not.toHaveBeenCalled();
expect(breaker.getConsecutiveFailures()).toBe(0);
});
it('three consecutive 503 throws ResilientFetchExhaustedError; breaker increments by 1', async () => {
const fetchImpl = vi.fn(async () => jsonResp(503));
const sleep = vi.fn(async () => {});
const { breaker } = makeBreaker();
await expect(
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep, maxAttempts: 3 },
}),
).rejects.toBeInstanceOf(ResilientFetchExhaustedError);
expect(fetchImpl).toHaveBeenCalledTimes(3);
expect(breaker.getConsecutiveFailures()).toBe(1);
});
it('after three exhausted 503 batches, breaker opens and fails fast', async () => {
const fetchImpl = vi.fn(async () => jsonResp(503));
const { breaker } = makeBreaker({ failureThreshold: 3, cooldownMs: 60_000 });
for (let i = 0; i < 3; i++) {
await expect(
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 3 },
}),
).rejects.toBeInstanceOf(ResilientFetchExhaustedError);
}
expect(breaker.getState()).toBe('open');
// 4th call: breaker open, no fetch invoked.
const fetchCallsBefore = fetchImpl.mock.calls.length;
await expect(
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 3 },
}),
).rejects.toBeInstanceOf(CircuitOpenError);
expect(fetchImpl.mock.calls.length).toBe(fetchCallsBefore);
});
it('retryable-network error retries, breaker counts only on exhaustion', async () => {
const fetchImpl = vi.fn(async () => {
throw new TypeError('fetch failed');
});
const { breaker } = makeBreaker();
await expect(
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 3 },
}),
).rejects.toBeInstanceOf(TypeError);
expect(fetchImpl).toHaveBeenCalledTimes(3);
expect(breaker.getConsecutiveFailures()).toBe(1);
});
describe('U2: terminal outcomes route through recordNeutral', () => {
it('401 does not erase prior partial-failure progress on the breaker', async () => {
const { breaker } = makeBreaker();
// Pre-seed the breaker with 2 failures (still closed; threshold 3).
breaker.recordFailure();
breaker.recordFailure();
expect(breaker.getConsecutiveFailures()).toBe(2);
const fetchImpl = vi.fn(async () => jsonResp(401));
await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {} },
});
// Counter MUST stay at 2 — under the old behaviour recordSuccess
// would have reset to 0 and the next 5xx batch would have started
// from scratch instead of tipping over the threshold.
expect(breaker.getConsecutiveFailures()).toBe(2);
expect(breaker.getState()).toBe('closed');
});
it('TimeoutError does not erase prior partial-failure progress', async () => {
const { breaker } = makeBreaker();
breaker.recordFailure();
breaker.recordFailure();
const fetchImpl = vi.fn(async () => {
throw new DOMException('aborted by timeout', 'TimeoutError');
});
await expect(
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {} },
}),
).rejects.toBeInstanceOf(DOMException);
expect(breaker.getConsecutiveFailures()).toBe(2);
});
it('external AbortError is terminal: no retry, breaker untouched', async () => {
const { breaker } = makeBreaker();
breaker.recordFailure();
const fetchImpl = vi.fn(async () => {
throw new DOMException('aborted by caller', 'AbortError');
});
const sleep = vi.fn(async () => {});
await expect(
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep, maxAttempts: 3 },
}),
).rejects.toMatchObject({ name: 'AbortError' });
expect(fetchImpl).toHaveBeenCalledTimes(1);
expect(sleep).not.toHaveBeenCalled();
// Counter unchanged — neither incremented (no failure) nor reset
// (no synthetic success).
expect(breaker.getConsecutiveFailures()).toBe(1);
});
it('interleaved 5xx + 401 + 5xx + 401 + 5xx opens breaker on third real failure', async () => {
const { breaker } = makeBreaker({ failureThreshold: 3 });
const sequence = [503, 401, 503, 401, 503];
let i = 0;
const fetchImpl = vi.fn(async () => jsonResp(sequence[i++]));
// Each call uses maxAttempts:1 so each surfaces a single response
// (5xx → ResilientFetchExhaustedError; 4xx → returned Response).
const driveOne = () =>
resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
await expect(driveOne()).rejects.toBeInstanceOf(ResilientFetchExhaustedError); // 5xx fail #1
await driveOne(); // 401 neutral
await expect(driveOne()).rejects.toBeInstanceOf(ResilientFetchExhaustedError); // 5xx fail #2
await driveOne(); // 401 neutral
await expect(driveOne()).rejects.toBeInstanceOf(ResilientFetchExhaustedError); // 5xx fail #3 → opens
expect(breaker.getState()).toBe('open');
expect(fetchImpl).toHaveBeenCalledTimes(5);
});
});
describe('half-open single-probe gating (U2)', () => {
/** Test helper: a fetch mock whose Response is controlled by the test. */
function deferredFetch(): {
promise: Promise<Response>;
resolve: (resp: Response) => void;
reject: (err: unknown) => void;
} {
let resolve!: (resp: Response) => void;
let reject!: (err: unknown) => void;
const promise = new Promise<Response>((res, rej) => {
resolve = res;
reject = rej;
});
return { promise, resolve, reject };
}
/** Builds a clock-injected breaker pre-opened with cooldown elapsed. */
function preOpenedBreaker(opts: { cooldownMs: number; halfOpenRetryAfterMs?: number }): {
breaker: CircuitBreaker;
advance: (ms: number) => void;
} {
let t = 1_700_000_000_000;
const breaker = new CircuitBreaker({
failureThreshold: 1,
cooldownMs: opts.cooldownMs,
halfOpenRetryAfterMs: opts.halfOpenRetryAfterMs ?? 1_000,
key: 'test',
now: () => t,
});
breaker.recordFailure();
t += opts.cooldownMs + 1; // cooldown elapsed
return { breaker, advance: (ms) => (t += ms) };
}
it('happy: 3 concurrent calls — exactly 1 hits fetch, others throw CircuitOpenError', async () => {
const { breaker } = preOpenedBreaker({ cooldownMs: 10 });
const deferred = deferredFetch();
const fetchImpl = vi.fn(() => deferred.promise);
// Synchronous portion of each `resilientFetch` runs eagerly up to
// the first await, so by the time r2/r3 are constructed the probe
// permit is already consumed by r1 and they reject synchronously.
const r1 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
const r2 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
const r3 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
// Resolve the probe with 200; r1 should now settle.
deferred.resolve(new Response(null, { status: 200 }));
const results = await Promise.allSettled([r1, r2, r3]);
expect(results[0].status).toBe('fulfilled');
if (results[0].status === 'fulfilled') {
expect(results[0].value.status).toBe(200);
}
expect(results[1].status).toBe('rejected');
if (results[1].status === 'rejected') {
expect(results[1].reason).toBeInstanceOf(CircuitOpenError);
}
expect(results[2].status).toBe('rejected');
if (results[2].status === 'rejected') {
expect(results[2].reason).toBeInstanceOf(CircuitOpenError);
}
// Only ONE underlying fetch was invoked.
expect(fetchImpl).toHaveBeenCalledTimes(1);
// Breaker closed after the probe's success.
expect(breaker.getState()).toBe('closed');
});
it('error: probe gets 503 — exhausted error; subsequent caller sees fresh full cooldown', async () => {
const { breaker } = preOpenedBreaker({ cooldownMs: 10_000, halfOpenRetryAfterMs: 1_000 });
const deferred = deferredFetch();
const fetchImpl = vi.fn(() => deferred.promise);
const r1 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
const r2 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
const r3 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
// Probe fails with 503 → exhausted (maxAttempts: 1) → recordFailure → reopen.
deferred.resolve(new Response(null, { status: 503 }));
const results = await Promise.allSettled([r1, r2, r3]);
expect(results[0].status).toBe('rejected');
if (results[0].status === 'rejected') {
expect(results[0].reason).toBeInstanceOf(ResilientFetchExhaustedError);
}
expect(results[1].status).toBe('rejected');
if (results[1].status === 'rejected') {
expect(results[1].reason).toBeInstanceOf(CircuitOpenError);
// Blocked-while-half-open used the halfOpenRetryAfterMs default.
expect((results[1].reason as CircuitOpenError).retryAfterMs).toBe(1_000);
}
// Breaker has re-opened with a fresh openedAt.
expect(breaker.getState()).toBe('open');
// r4: should see the fresh full cooldown, NOT the probe-in-flight 1000ms.
let r4Caught: CircuitOpenError | null = null;
try {
await resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
} catch (err) {
r4Caught = err as CircuitOpenError;
}
expect(r4Caught).toBeInstanceOf(CircuitOpenError);
expect(r4Caught?.retryAfterMs).toBe(10_000);
});
it('cancellation: probe AbortError releases permit; next caller becomes new probe', async () => {
const { breaker } = preOpenedBreaker({ cooldownMs: 10_000 });
const deferred1 = deferredFetch();
const deferred2 = deferredFetch();
let callIdx = 0;
const fetchImpl = vi.fn(() => (callIdx++ === 0 ? deferred1.promise : deferred2.promise));
// r1 admitted as the probe; r2 blocked while r1 still in flight.
const r1 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
const r2 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
await expect(r2).rejects.toBeInstanceOf(CircuitOpenError);
// Cancel the probe — `AbortError` routes through terminal-network →
// `recordNeutral` → permit released, state stays half-open.
deferred1.reject(new DOMException('aborted by caller', 'AbortError'));
await expect(r1).rejects.toMatchObject({ name: 'AbortError' });
expect(breaker.isProbeInFlight()).toBe(false);
expect(breaker.getState()).toBe('half-open');
// r3: now succeeds and becomes the new probe.
const r3 = resilientFetch(URL_STR, undefined, {
fetchImpl: fetchImpl as unknown as typeof fetch,
breaker,
retry: { sleep: async () => {}, maxAttempts: 1 },
});
deferred2.resolve(new Response(null, { status: 200 }));
const r3Resp = await r3;
expect(r3Resp.status).toBe(200);
expect(breaker.getState()).toBe('closed');
// Two fetches total: the cancelled probe + the recovery probe.
expect(fetchImpl).toHaveBeenCalledTimes(2);
});
});
});