feat(javascript): add requester-fetch

.github/actions/restore-artifacts/action.yml

@@ -52,6 +52,13 @@ runs:
         name: client-javascript-utils-requester-node-http
         path: clients/algoliasearch-client-javascript/packages/requester-node-http/
 
+    - name: client-javascript-utils-requester-fetch
+      if: ${{ (inputs.javascript == 'true' && inputs.type == 'all') || inputs.type == 'js_utils' }}
+      uses: actions/download-artifact@v3
+      with:
+        name: client-javascript-utils-requester-fetch
+        path: clients/algoliasearch-client-javascript/packages/requester-fetch/
+
     # JavaScript
     - name: Download clients-javascript artifact
       if: ${{ inputs.javascript == 'true' && inputs.type == 'all' }}

.github/workflows/check.yml

@@ -134,6 +134,7 @@ jobs:
           - client-common
           - requester-browser-xhr
           - requester-node-http
+          - requester-fetch
     steps:
       - uses: actions/checkout@v2
 

clients/README.md

@@ -19,8 +19,9 @@ This folder hosts the generated clients.
 - [@algolia/client-query-suggestions](./algoliasearch-client-javascript/packages/client-query-suggestions/): The Algolia query suggestions client.
 - [@algolia/client-search](./algoliasearch-client-javascript/packages/client-search/): The Algolia search client.
 - [@algolia/recommend](./algoliasearch-client-javascript/packages/recommend/): The Algolia recommend client.
-- [@algolia/sources](./algoliasearch-client-javascript/packages/client-sources/): The Algolia sources client.
+- [@algolia/client-sources](./algoliasearch-client-javascript/packages/client-sources/): The Algolia sources client.
 - [@algolia/predict](./algoliasearch-client-javascript/packages/predict/): The Algolia predict client.
 - [@algolia/client-common](./algoliasearch-client-javascript/packages/client-common/): The JavaScript clients common files.
 - [@algolia/requester-browser-xhr](./algoliasearch-client-javascript/packages/requester-browser-xhr/): Browser XHR requester for the Algolia JavaScript clients.
+- [@algolia/requester-fetch](./algoliasearch-client-javascript/packages/requester-fetch/): Requester for the Algolia JavaScript clients using Fetch.
 - [@algolia/requester-node-http](./algoliasearch-client-javascript/packages/requester-node-http/): Node.js HTTP requester for the Algolia JavaScript clients.

clients/algoliasearch-client-javascript/base.rollup.config.js

@@ -16,6 +16,10 @@ const UTILS = {
     external: ['dom'],
     dependencies: [`${NPM_ORG}client-common`],
   },
+  'requester-fetch': {
+    external: ['dom'],
+    dependencies: [`${NPM_ORG}client-common`],
+  },
   'requester-node-http': {
     external: ['https', 'http', 'url'],
     dependencies: [`${NPM_ORG}client-common`],

clients/algoliasearch-client-javascript/package.json

@@ -9,7 +9,7 @@
     "build:all": "./scripts/build_all.sh",
     "build:utils": "yarn build utils",
     "clean": "rm -rf packages/*/dist || true",
-    "clean:utils": "yarn workspace @algolia/client-common clean && yarn workspace @algolia/requester-node-http clean && yarn workspace @algolia/requester-browser-xhr clean",
+    "clean:utils": "yarn workspace @algolia/client-common clean && yarn workspace @algolia/requester-node-http clean && yarn workspace @algolia/requester-browser-xhr clean && yarn workspace @algolia/requester-fetch clean",
     "release:bump": "lerna version ${0:-patch} --no-changelog --no-git-tag-version --no-push --exact --force-publish --yes",
     "release:publish": "ts-node --project tsconfig.script.json scripts/publish.ts",
     "test:lint": "eslint . --ext .js,.ts",

clients/algoliasearch-client-javascript/packages/requester-browser-xhr/src/__tests__/browser-xhr-requester.test.ts

@@ -1,41 +1,20 @@
-import http from 'http';
+import type http from 'http';
 
-import type { EndRequest, Headers } from '@algolia/client-common';
+import type { EndRequest } from '@algolia/client-common';
 import type { MockRequest, MockResponse } from 'xhr-mock';
 import mock from 'xhr-mock';
 
 import { createXhrRequester } from '../..';
+import {
+  BASE_URL,
+  headers,
+  timeoutRequest,
+  requestStub,
+  getStringifiedBody,
+  createTestServer,
+} from '../../../../tests/utils';
 
 const requester = createXhrRequester();
-const BASE_URL = 'https://algolia-dns.net/foo?x-algolia-header=bar';
-
-function getStringifiedBody(
-  body: Record<string, any> = { foo: 'bar' }
-): string {
-  return JSON.stringify(body);
-}
-
-const headers: Headers = {
-  'content-type': 'text/plain',
-};
-
-const timeoutRequest: EndRequest = {
-  url: 'missing-url-here',
-  data: '',
-  headers: {},
-  method: 'GET',
-  responseTimeout: 2000,
-  connectTimeout: 1000,
-};
-
-const requestStub: EndRequest = {
-  url: BASE_URL,
-  method: 'POST',
-  headers,
-  data: getStringifiedBody(),
-  responseTimeout: 1000,
-  connectTimeout: 2000,
-};
 
 describe('status code handling', () => {
   beforeEach(() => mock.setup());
@@ -123,24 +102,7 @@ describe('timeout handling', () => {
   let server: http.Server;
   // setup http server to test timeout
   beforeAll(() => {
-    server = http.createServer(function (_req, res) {
-      res.writeHead(200, {
-        'content-type': 'text/plain',
-        'access-control-allow-origin': '*',
-        'x-powered-by': 'nodejs',
-      });
-
-      res.write('{"foo":');
-
-      setTimeout(() => {
-        res.write(' "bar"');
-      }, 1000);
-
-      setTimeout(() => {
-        res.write('}');
-        res.end();
-      }, 5000);
-    });
+    server = createTestServer();
 
     server.listen('1111');
   });

clients/algoliasearch-client-javascript/packages/requester-fetch/index.ts

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

clients/algoliasearch-client-javascript/packages/requester-fetch/jest.config.ts

@@ -0,0 +1,9 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+  preset: 'ts-jest',
+  roots: ['src/__tests__'],
+  testEnvironment: 'jsdom',
+};
+
+export default config;

clients/algoliasearch-client-javascript/packages/requester-fetch/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@algolia/requester-fetch",
+  "version": "5.0.0-alpha.0",
+  "description": "Promise-based request library using Fetch.",
+  "repository": "algolia/algoliasearch-client-javascript",
+  "license": "MIT",
+  "author": "Algolia",
+  "main": "dist/requester-fetch.cjs.js",
+  "module": "dist/requester-fetch.esm.node.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "index.ts"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist/",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@algolia/client-common": "5.0.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/jest": "28.1.4",
+    "@types/node": "16.11.45",
+    "cross-fetch": "3.1.5",
+    "jest": "28.1.2",
+    "nock": "13.2.8",
+    "ts-jest": "28.0.5",
+    "typescript": "4.7.4"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  }
+}