Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@osskit/fetch-enhancers",
"version": "4.7.1",
"version": "4.7.2",
"repository": {
"url": "https://github.com/osskit/fetch-enhancers"
},
Expand All @@ -27,19 +27,20 @@
"node": ">=20.0.0"
},
"devDependencies": {
"@osskit/eslint-config": "^2.0.3",
"@osskit/eslint-config": "^2.2.0",
"@osskit/prettier-config": "^0.0.1",
"@osskit/tsconfig": "^0.0.7",
"@types/async-retry": "^1.4.8",
"@types/node": "^22.5.5",
"eslint": "^9.11.0",
"husky": "^9.1.6",
"lint-staged": "^15.2.10",
"@types/async-retry": "^1.4.9",
"@types/node": "^24.0.14",
"@vitest/ui": "^3.2.4",
"eslint": "^9.31.0",
"husky": "^9.1.7",
"lint-staged": "^16.1.2",
"p-reflect": "^3.1.0",
"prettier": "^3.3.3",
"typescript": "^5.6.2",
"typescript-eslint": "^8.6.0",
"vitest": "^2.1.1"
"prettier": "^3.6.2",
"typescript": "^5.8.3",
"typescript-eslint": "^8.37.0",
"vitest": "^3.2.4"
},
"dependencies": {
"async-retry": "^1.3.3"
Expand Down
3 changes: 2 additions & 1 deletion src/enhancers/withRetry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ export const withRetry =
return retry(
async (_bail, attempt) => {
const isRetry = attempt < (finalOptions.retries ?? 3);
const response = await fetch(url, init);
const request = url instanceof Request ? url.clone() : url;
const response = await fetch(request, init);

if (!finalOptions.shouldRetry(response) || !isRetry) {
return response;
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ export * from './enhancers/withTimeout.js';
export * from './enhancers/withHeaders.js';
export * from './enhancers/withToken.js';
export * from './fetchError.js';
export * from './types.js';
export type * from './types.js';
1 change: 1 addition & 0 deletions tests/specs/fetchError.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ describe('fetchError', () => {
});

const stringifiedError = JSON.stringify(error);

expect(stringifiedError).toBeTypeOf('string');
expect(JSON.parse(stringifiedError)).toMatchObject({
name: 'FetchError',
Expand Down
65 changes: 65 additions & 0 deletions tests/specs/mixed.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,72 @@ describe('mixed', () => {
await waitForServer(server);

const { port } = server.address() as AddressInfo;

await expect(enhancedFetch(`http://127.0.0.1:${port}`)).resolves.toBeInstanceOf(Response);

server.close();
});

it('mixed with Request object', async () => {
const retryOpts = {
onRetry: (_: Error) => {
console.log('hi!');
},
};
const timeoutOpts = {
requestTimeoutMs: 10_000,
};
const basicAuthOpts = {
username: 'hi',
password: 'bye',
};
const enhancedFetch = withThrow(withBasicAuth(withTimeout(withRetry(fetch, retryOpts), timeoutOpts), basicAuthOpts));
const server = createServer((_, res) => {
res.writeHead(200);
res.end();
});

await waitForServer(server);

const { port } = server.address() as AddressInfo;
const request = new Request(`http://127.0.0.1:${port}`);

await expect(enhancedFetch(request)).resolves.toBeInstanceOf(Response);

server.close();
});

it('mixed with Request object, retries and timeout', async () => {
const retryOpts = {
onRetry: (_: Error) => {
console.log('hi!');
},
};
const timeoutOpts = {
requestTimeoutMs: 10_000,
};
let tries = 0;

const enhancedFetch = withRetry(withTimeout(fetch, timeoutOpts), retryOpts);
const server = createServer((_, res) => {
if (tries++ < 2) {
res.writeHead(500);
res.end();
return;
}
res.writeHead(200);
res.end();
});

await waitForServer(server);
const { port } = server.address() as AddressInfo;
const request = new Request(`http://127.0.0.1:${port}`, {
method: 'POST',
body: 'payload',
});

await expect(enhancedFetch(request)).resolves.toBeInstanceOf(Response);

server.close();
});
});
4 changes: 4 additions & 0 deletions tests/specs/withBasicAuth.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ describe('withBasicAuth', () => {
const { port } = server.address() as AddressInfo;
const fetchWithBasicAuth = withBasicAuth(fetch, { username, password });
const res = await fetchWithBasicAuth(`http://127.0.0.1:${port}`);

await expect(res.text()).resolves.toBe(`{"authorization":"${basicAuth}"}`);

server.close();
});

Expand All @@ -40,7 +42,9 @@ describe('withBasicAuth', () => {
const headers = new Headers({ foo: 'bar' });
const fetchWithBasicAuth = withBasicAuth(fetch, { username, password });
const res = await fetchWithBasicAuth(`http://127.0.0.1:${port}`, { headers });

await expect(res.text()).resolves.toBe(`{"authorization":"${basicAuth}","foo":"bar"}`);

server.close();
});
});
14 changes: 14 additions & 0 deletions tests/specs/withHeaders.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ describe('withHeaders', () => {

const { port } = server.address() as AddressInfo;
const res = await fetchWithHeaders(`http://127.0.0.1:${port}`);

await expect(res.text()).resolves.toBe('bar');

server.close();
});

Expand All @@ -37,7 +39,9 @@ describe('withHeaders', () => {

const { port } = server.address() as AddressInfo;
const res = await fetchWithExtraHeaders(`http://127.0.0.1:${port}`, { headers: { id: 'id', bar: 'bar' } });

await expect(res.json()).resolves.toStrictEqual({ id: 'override', bar: 'bar', foo: 'foo' });

server.close();
});

Expand All @@ -52,7 +56,9 @@ describe('withHeaders', () => {
await waitForServer(server);
const { port } = server.address() as AddressInfo;
const res = await fetchWithAsyncHeaders(`http://127.0.0.1:${port}`, { headers: { id: 'id', bar: 'bar' } });

await expect(res.json()).resolves.toStrictEqual({ id: 'override', bar: 'bar', foo: 'foo' });

server.close();
});

Expand All @@ -68,7 +74,9 @@ describe('withHeaders', () => {
const headers = new Headers({ bar: 'baz' });
const fetchWithHeadersInstance = withHeaders(fetch, () => ({ foo: 'bar' }));
const res = await fetchWithHeadersInstance(`http://127.0.0.1:${port}`, { headers });

await expect(res.json()).resolves.toStrictEqual({ foo: 'bar', bar: 'baz' });

server.close();
});

Expand All @@ -84,7 +92,9 @@ describe('withHeaders', () => {
const headers = new Headers({ bar: 'baz' });
const fetchWithHeadersInstance = withHeaders(fetch, () => new Headers({ foo: 'bar' }));
const res = await fetchWithHeadersInstance(`http://127.0.0.1:${port}`, { headers });

await expect(res.json()).resolves.toStrictEqual({ foo: 'bar', bar: 'baz' });

server.close();
});

Expand All @@ -100,7 +110,9 @@ describe('withHeaders', () => {
const headers = new Headers({ bar: 'baz' });
const fetchWithHeadersInstance = withHeaders(fetch, () => new Headers({ foo: 'bar' }));
const res = await fetchWithHeadersInstance(`http://127.0.0.1:${port}`, { headers });

await expect(res.json()).resolves.toStrictEqual({ foo: 'bar', bar: 'baz' });

server.close();
});

Expand All @@ -118,7 +130,9 @@ describe('withHeaders', () => {
});
const fetchWithHeadersInstance = withHeaders(fetch, () => ({ foo: 'foo', bar: 'override-bar' }));
const res = await fetchWithHeadersInstance(request);

await expect(res.json()).resolves.toStrictEqual({ foo: 'foo', bar: 'override-bar', baz: 'baz' });

server.close();
});
});
31 changes: 31 additions & 0 deletions tests/specs/withRetry.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ describe('withRetry', () => {

const { port } = server.address() as AddressInfo;
const res = await retryFetch(`http://127.0.0.1:${port}`);

await expect(res.text()).resolves.toBe('ha');

server.close();
Expand Down Expand Up @@ -64,6 +65,7 @@ describe('withRetry', () => {
onRetry: (error: FetchError) => error,
shouldRetry: () => true,
})(`http://127.0.0.1:${port}`);

await expect(res.text()).resolves.toBe('ha');

server.close();
Expand All @@ -82,7 +84,9 @@ describe('withRetry', () => {

const { port } = server.address() as AddressInfo;
const res = await retryFetch(`http://127.0.0.1:${port}`);

expect(res.status).toBe(500);

server.close();

expect(tries).toBe(retries);
Expand All @@ -101,9 +105,36 @@ describe('withRetry', () => {

const { port } = server.address() as AddressInfo;
const res = await retryFetch(`http://127.0.0.1:${port}`);

expect(res.status).toBe(404);

server.close();

expect(tries).toBe(1);
});

it('retries with a Request object as url and body should clone the request to avoid "already used" errors', async () => {
let tries = 0;

const server = createServer((_, res) => {
if (tries++ < 2) {
res.writeHead(500);
res.end();
return;
}
res.end('ok');
});

await waitForServer(server);
const { port } = server.address() as AddressInfo;
const request = new Request(`http://127.0.0.1:${port}`, {
method: 'POST',
body: 'payload',
});
const res = await retryFetch(request);

await expect(res.text()).resolves.toBe('ok');

server.close();
});
});
2 changes: 2 additions & 0 deletions tests/specs/withThrow.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ describe('withThrow', () => {
const { port } = server.address() as AddressInfo;
const result = await pReflect(throwingFetch(`http://127.0.0.1:${port}`));
const error = result.isRejected ? result.reason : null;

expect(error).toBeInstanceOf(FetchError);
expect((error as FetchError).status).toBe(400);

server.close();
});
});
6 changes: 6 additions & 0 deletions tests/specs/withTimeout.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ describe('withTimeout', () => {
const { port } = server.address() as AddressInfo;
const result = await pReflect(timeoutFetch(`http://127.0.0.1:${port}`));
const error = result.isRejected ? result.reason : null;

expect(error).toBeInstanceOf(FetchError);
expect((error as FetchError).message).toBe('request timeout');

server.close();
});

Expand All @@ -46,8 +48,10 @@ describe('withTimeout', () => {

const result = await pReflect(timeoutFetch(`http://127.0.0.1:${port}`, { signal: controller.signal }));
const error = result.isRejected ? result.reason : null;

expect(error).toBeInstanceOf(FetchError);
expect((error as FetchError).message).toBe('abort requested');

server.close();
});

Expand All @@ -63,8 +67,10 @@ describe('withTimeout', () => {
const request = new Request(`http://127.0.0.1:${port}`);
const result = await pReflect(timeoutFetch(request));
const error = result.isRejected ? result.reason : null;

expect(error).toBeInstanceOf(FetchError);
expect((error as FetchError).message).toBe('request timeout');

server.close();
});
});
3 changes: 3 additions & 0 deletions tests/specs/withToken.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ describe('withToken', () => {
const { port } = server.address() as AddressInfo;
const fetchWithToken = withToken(() => 'mytoken', fetch);
const res = await fetchWithToken(`http://127.0.0.1:${port}`);

await expect(res.text()).resolves.toBe('{"authorization":"Bearer mytoken"}');
});

Expand All @@ -35,7 +36,9 @@ describe('withToken', () => {
const headers = new Headers({ foo: 'bar' });
const fetchWithToken = withToken(() => 'mytoken', fetch);
const res = await fetchWithToken(`http://127.0.0.1:${port}`, { headers });

await expect(res.text()).resolves.toBe('{"authorization":"Bearer mytoken","foo":"bar"}');

server.close();
});
});
Loading