@algolia/requester-fetch 5.8.1 → 5.9.0

package/dist/requester.fetch.browser.d.ts

@@ -1,8 +1,61 @@
-import { Requester } from '@algolia/client-common';
+// src/createFetchRequester.ts
+function isAbortError(error) {
+  return error instanceof Error && error.name === "AbortError";
+}
+function getErrorMessage(error, abortContent) {
+  if (isAbortError(error)) {
+    return abortContent;
+  }
+  return error instanceof Error ? error.message : "Network request failed";
+}
+function createFetchRequester({ requesterOptions = {} } = {}) {
+  async function send(request) {
+    const abortController = new AbortController();
+    const signal = abortController.signal;
+    const createTimeout = (timeout) => {
+      return setTimeout(() => {
+        abortController.abort();
+      }, timeout);
+    };
+    const connectTimeout = createTimeout(request.connectTimeout);
+    let fetchRes;
+    try {
+      fetchRes = await fetch(request.url, {
+        method: request.method,
+        body: request.data || null,
+        redirect: "manual",
+        signal,
+        ...requesterOptions,
+        headers: {
+          ...requesterOptions.headers,
+          ...request.headers
+        }
+      });
+    } catch (error) {
+      return {
+        status: 0,
+        content: getErrorMessage(error, "Connection timeout"),
+        isTimedOut: isAbortError(error)
+      };
+    }
+    clearTimeout(connectTimeout);
+    createTimeout(request.responseTimeout);
+    try {
+      const content = await fetchRes.text();
+      return {
+        content,
+        isTimedOut: false,
+        status: fetchRes.status
+      };
+    } catch (error) {
+      return {
+        status: 0,
+        content: getErrorMessage(error, "Socket timeout"),
+        isTimedOut: isAbortError(error)
+      };
+    }
+  }
+  return { send };
+}
 
-type FetchRequesterOptions = {
-    readonly requesterOptions?: RequestInit;
-};
-declare function createFetchRequester({ requesterOptions }?: FetchRequesterOptions): Requester;
-
-export { type FetchRequesterOptions, createFetchRequester };
+export { createFetchRequester };

package/dist/requester.fetch.node.d.cts

@@ -1,8 +1,61 @@
-import { Requester } from '@algolia/client-common';
+// src/createFetchRequester.ts
+function isAbortError(error) {
+  return error instanceof Error && error.name === "AbortError";
+}
+function getErrorMessage(error, abortContent) {
+  if (isAbortError(error)) {
+    return abortContent;
+  }
+  return error instanceof Error ? error.message : "Network request failed";
+}
+function createFetchRequester({ requesterOptions = {} } = {}) {
+  async function send(request) {
+    const abortController = new AbortController();
+    const signal = abortController.signal;
+    const createTimeout = (timeout) => {
+      return setTimeout(() => {
+        abortController.abort();
+      }, timeout);
+    };
+    const connectTimeout = createTimeout(request.connectTimeout);
+    let fetchRes;
+    try {
+      fetchRes = await fetch(request.url, {
+        method: request.method,
+        body: request.data || null,
+        redirect: "manual",
+        signal,
+        ...requesterOptions,
+        headers: {
+          ...requesterOptions.headers,
+          ...request.headers
+        }
+      });
+    } catch (error) {
+      return {
+        status: 0,
+        content: getErrorMessage(error, "Connection timeout"),
+        isTimedOut: isAbortError(error)
+      };
+    }
+    clearTimeout(connectTimeout);
+    createTimeout(request.responseTimeout);
+    try {
+      const content = await fetchRes.text();
+      return {
+        content,
+        isTimedOut: false,
+        status: fetchRes.status
+      };
+    } catch (error) {
+      return {
+        status: 0,
+        content: getErrorMessage(error, "Socket timeout"),
+        isTimedOut: isAbortError(error)
+      };
+    }
+  }
+  return { send };
+}
 
-type FetchRequesterOptions = {
-    readonly requesterOptions?: RequestInit;
-};
-declare function createFetchRequester({ requesterOptions }?: FetchRequesterOptions): Requester;
-
-export { type FetchRequesterOptions, createFetchRequester };
+export { createFetchRequester };

package/dist/requester.fetch.node.d.ts

@@ -1,8 +1,61 @@
-import { Requester } from '@algolia/client-common';
+// src/createFetchRequester.ts
+function isAbortError(error) {
+  return error instanceof Error && error.name === "AbortError";
+}
+function getErrorMessage(error, abortContent) {
+  if (isAbortError(error)) {
+    return abortContent;
+  }
+  return error instanceof Error ? error.message : "Network request failed";
+}
+function createFetchRequester({ requesterOptions = {} } = {}) {
+  async function send(request) {
+    const abortController = new AbortController();
+    const signal = abortController.signal;
+    const createTimeout = (timeout) => {
+      return setTimeout(() => {
+        abortController.abort();
+      }, timeout);
+    };
+    const connectTimeout = createTimeout(request.connectTimeout);
+    let fetchRes;
+    try {
+      fetchRes = await fetch(request.url, {
+        method: request.method,
+        body: request.data || null,
+        redirect: "manual",
+        signal,
+        ...requesterOptions,
+        headers: {
+          ...requesterOptions.headers,
+          ...request.headers
+        }
+      });
+    } catch (error) {
+      return {
+        status: 0,
+        content: getErrorMessage(error, "Connection timeout"),
+        isTimedOut: isAbortError(error)
+      };
+    }
+    clearTimeout(connectTimeout);
+    createTimeout(request.responseTimeout);
+    try {
+      const content = await fetchRes.text();
+      return {
+        content,
+        isTimedOut: false,
+        status: fetchRes.status
+      };
+    } catch (error) {
+      return {
+        status: 0,
+        content: getErrorMessage(error, "Socket timeout"),
+        isTimedOut: isAbortError(error)
+      };
+    }
+  }
+  return { send };
+}
 
-type FetchRequesterOptions = {
-    readonly requesterOptions?: RequestInit;
-};
-declare function createFetchRequester({ requesterOptions }?: FetchRequesterOptions): Requester;
-
-export { type FetchRequesterOptions, createFetchRequester };
+export { createFetchRequester };

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist/requester.fetch.node';

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./dist/requester.fetch.node.cjs');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/requester-fetch",
-  "version": "5.8.1",
+  "version": "5.9.0",
   "description": "Promise-based request library using Fetch.",
   "repository": {
     "type": "git",
@@ -37,8 +37,8 @@
   "react-native": "./dist/requester.fetch.browser.js",
   "files": [
     "dist",
-    "src",
-    "index.ts"
+    "index.d.ts",
+    "index.js"
   ],
   "scripts": {
     "build": "yarn clean && yarn tsup",
@@ -47,16 +47,16 @@
     "test:bundle": "publint . && attw --pack ."
   },
   "dependencies": {
-    "@algolia/client-common": "5.8.1"
+    "@algolia/client-common": "5.9.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@types/node": "22.7.4",
+    "@types/node": "22.7.5",
     "cross-fetch": "4.0.0",
     "nock": "13.5.5",
     "publint": "0.2.11",
     "tsup": "8.3.0",
-    "typescript": "5.6.2",
+    "typescript": "5.6.3",
     "vitest": "2.1.2"
   },
   "engines": {

package/index.ts

@@ -1 +0,0 @@
-export * from './src/createFetchRequester';

package/src/__tests__/fetch-requester.test.ts

@@ -1,278 +0,0 @@
-import crossFetch from 'cross-fetch';
-import type http from 'http';
-import nock from 'nock';
-import { Readable } from 'stream';
-import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, test } from 'vitest';
-
-import type { EndRequest } from '@algolia/client-common';
-
-import { createFetchRequester } from '../..';
-import {
-  createTestServer,
-  getStringifiedBody,
-  headers,
-  requestStub,
-  testQueryBaseUrl,
-  testQueryHeader,
-  timeoutRequest,
-} from '../../../../tests/utils';
-
-const originalFetch = window.fetch;
-
-beforeEach(() => {
-  window.fetch = crossFetch;
-});
-
-afterEach(() => {
-  window.fetch = originalFetch;
-});
-
-const requester = createFetchRequester();
-
-describe('status code handling', () => {
-  test('sends requests', async () => {
-    const body = getStringifiedBody();
-
-    nock(testQueryBaseUrl, { reqheaders: headers }).post('/foo').query(testQueryHeader).reply(200, body);
-
-    const response = await requester.send(requestStub);
-
-    expect(response.content).toEqual(body);
-  });
-
-  test('resolves status 200', async () => {
-    const body = getStringifiedBody();
-
-    nock(testQueryBaseUrl, { reqheaders: headers }).post('/foo').query(testQueryHeader).reply(200, body);
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(200);
-    expect(response.content).toBe(body);
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('resolves status 300', async () => {
-    const reason = 'Multiple Choices';
-
-    nock(testQueryBaseUrl, { reqheaders: headers }).post('/foo').query(testQueryHeader).reply(300, reason);
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(300);
-    expect(response.content).toBe(reason);
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('resolves status 400', async () => {
-    const body = getStringifiedBody({
-      message: 'Invalid Application-Id or API-Key',
-    });
-
-    nock(testQueryBaseUrl, { reqheaders: headers }).post('/foo').query(testQueryHeader).reply(400, body);
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(400);
-    expect(response.content).toBe(body);
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('handles chunked responses inside unicode character boundaries', async () => {
-    const data = Buffer.from('äöü');
-
-    // create a test response stream that is chunked inside a unicode character
-    function* generate() {
-      yield data.subarray(0, 3);
-      yield data.subarray(3);
-    }
-
-    const testStream = Readable.from(generate());
-
-    nock(testQueryBaseUrl, { reqheaders: headers }).post('/foo').query(testQueryHeader).reply(200, testStream);
-
-    const response = await requester.send(requestStub);
-
-    expect(response.content).toEqual(data.toString());
-  });
-});
-
-describe('timeout handling', () => {
-  let server: http.Server;
-  // setup http server to test timeout
-  beforeAll(() => {
-    server = createTestServer();
-
-    server.listen('1113');
-  });
-
-  afterAll(
-    () =>
-      new Promise((done) => {
-        done();
-      }),
-  );
-
-  test('timeouts with the given 1 seconds connection timeout', async () => {
-    const before = Date.now();
-    const response = await requester.send({
-      ...timeoutRequest,
-      connectTimeout: 1000,
-      url: 'http://localhost:1113/connection_timeout',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Connection timeout');
-    expect(now - before).toBeGreaterThanOrEqual(999);
-    expect(now - before).toBeLessThanOrEqual(1200);
-  });
-
-  test('connection timeouts with the given 2 seconds connection timeout', async () => {
-    const before = Date.now();
-    const response = await requester.send({
-      ...timeoutRequest,
-      connectTimeout: 2000,
-      url: 'http://localhost:1113/connection_timeout',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Connection timeout');
-    expect(now - before).toBeGreaterThanOrEqual(1999);
-    expect(now - before).toBeLessThanOrEqual(2200);
-  });
-
-  test("socket timeouts if response don't appears before the timeout with 2 seconds timeout", async () => {
-    const before = Date.now();
-
-    const response = await requester.send({
-      ...timeoutRequest,
-      responseTimeout: 2000,
-      url: 'http://localhost:1113',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Socket timeout');
-    expect(now - before).toBeGreaterThanOrEqual(1999);
-    expect(now - before).toBeLessThanOrEqual(2200);
-  });
-
-  test("socket timeouts if response don't appears before the timeout with 3 seconds timeout", async () => {
-    const before = Date.now();
-    const response = await requester.send({
-      ...timeoutRequest,
-      responseTimeout: 3000,
-      url: 'http://localhost:1113',
-    });
-
-    const now = Date.now();
-
-    expect(response.content).toBe('Socket timeout');
-    expect(now - before).toBeGreaterThanOrEqual(2999);
-    expect(now - before).toBeLessThanOrEqual(3200);
-  });
-
-  test('do not timeouts if response appears before the timeout', async () => {
-    const before = Date.now();
-    const response = await requester.send({
-      ...requestStub,
-      url: 'http://localhost:1113',
-      responseTimeout: 6000,
-    });
-
-    const now = Date.now();
-
-    expect(response.isTimedOut).toBe(false);
-    expect(response.status).toBe(200);
-    expect(response.content).toBe('{"foo": "bar"}');
-    expect(now - before).toBeGreaterThanOrEqual(4999);
-    expect(now - before).toBeLessThanOrEqual(5200);
-  }, 10000); // This is a long-running test, default server timeout is set to 5000ms
-});
-
-describe('error handling', (): void => {
-  test('resolves dns not found', async () => {
-    const request: EndRequest = {
-      url: 'https://this-dont-exist.algolia.com',
-      method: 'POST',
-      headers,
-      data: getStringifiedBody(),
-      responseTimeout: 2000,
-      connectTimeout: 1000,
-    };
-
-    const response = await requester.send(request);
-
-    expect(response.status).toBe(0);
-    expect(response.content).toContain('');
-    expect(response.isTimedOut).toBe(false);
-  });
-
-  test('resolves general network errors', async () => {
-    nock(testQueryBaseUrl, { reqheaders: headers })
-      .post('/foo')
-      .query(testQueryHeader)
-      .replyWithError('This is a general error');
-
-    const response = await requester.send(requestStub);
-
-    expect(response.status).toBe(0);
-    expect(response.content).toBe(
-      'request to https://algolia-dns.net/foo?x-algolia-header=bar failed, reason: This is a general error',
-    );
-    expect(response.isTimedOut).toBe(false);
-  });
-});
-
-describe('requesterOptions', () => {
-  test('allows to pass requesterOptions', async () => {
-    const body = getStringifiedBody();
-    const requesterTmp = createFetchRequester({
-      requesterOptions: {
-        headers: testQueryHeader,
-      },
-    });
-
-    nock(testQueryBaseUrl, {
-      reqheaders: {
-        ...headers,
-        ...testQueryHeader,
-      },
-    })
-      .post('/foo')
-      .query(testQueryHeader)
-      .reply(200, body);
-
-    const response = await requesterTmp.send(requestStub);
-
-    expect(response.status).toBe(200);
-    expect(response.content).toBe(body);
-  });
-
-  test('allows overriding default requesterOptions', async () => {
-    const body = getStringifiedBody();
-    const requesterTmp = createFetchRequester({
-      requesterOptions: {
-        headers: testQueryHeader,
-        mode: 'no-cors',
-      },
-    });
-
-    nock(testQueryBaseUrl, {
-      reqheaders: {
-        ...headers,
-        ...testQueryHeader,
-      },
-    })
-      .post('/foo')
-      .query(testQueryHeader)
-      .reply(200, body);
-
-    const response = await requesterTmp.send(requestStub);
-
-    expect(response.status).toBe(200);
-    expect(response.content).toBe(body);
-  });
-});

package/src/createFetchRequester.ts

@@ -1,74 +0,0 @@
-import type { Response as AlgoliaResponse, EndRequest, Requester } from '@algolia/client-common';
-
-function isAbortError(error: unknown): boolean {
-  return error instanceof Error && error.name === 'AbortError';
-}
-
-function getErrorMessage(error: unknown, abortContent: string): string {
-  if (isAbortError(error)) {
-    return abortContent;
-  }
-  return error instanceof Error ? error.message : 'Network request failed';
-}
-
-export type FetchRequesterOptions = {
-  readonly requesterOptions?: RequestInit;
-};
-
-export function createFetchRequester({ requesterOptions = {} }: FetchRequesterOptions = {}): Requester {
-  async function send(request: EndRequest): Promise<AlgoliaResponse> {
-    const abortController = new AbortController();
-    const signal = abortController.signal;
-
-    const createTimeout = (timeout: number): NodeJS.Timeout => {
-      return setTimeout(() => {
-        abortController.abort();
-      }, timeout);
-    };
-
-    const connectTimeout = createTimeout(request.connectTimeout);
-
-    let fetchRes: Response;
-    try {
-      fetchRes = await fetch(request.url, {
-        method: request.method,
-        body: request.data || null,
-        redirect: 'manual',
-        signal,
-        ...requesterOptions,
-        headers: {
-          ...requesterOptions.headers,
-          ...request.headers,
-        },
-      });
-    } catch (error) {
-      return {
-        status: 0,
-        content: getErrorMessage(error, 'Connection timeout'),
-        isTimedOut: isAbortError(error),
-      };
-    }
-
-    clearTimeout(connectTimeout);
-
-    createTimeout(request.responseTimeout);
-
-    try {
-      const content = await fetchRes.text();
-
-      return {
-        content,
-        isTimedOut: false,
-        status: fetchRes.status,
-      };
-    } catch (error) {
-      return {
-        status: 0,
-        content: getErrorMessage(error, 'Socket timeout'),
-        isTimedOut: isAbortError(error),
-      };
-    }
-  }
-
-  return { send };
-}