fix(javascript): ensure requesters work as in v4

Author: shortcuts

.github/workflows/check.yml

@@ -163,9 +163,9 @@ jobs:
         if: ${{ steps.cache.outputs.cache-hit != 'true' }}
         run: cd clients/algoliasearch-client-javascript && yarn build ${{ matrix.client }}
 
-      - name: Run tests for 'client-common'
-        if: ${{ steps.cache.outputs.cache-hit != 'true' && matrix.client == 'client-common' }}
-        run: cd clients/algoliasearch-client-javascript && yarn workspace @algolia/client-common test
+      - name: Run tests for '${{ matrix.client }}'
+        if: ${{ steps.cache.outputs.cache-hit != 'true' }}
+        run: cd clients/algoliasearch-client-javascript && yarn workspace @algolia/${{ matrix.client }} test
 
       - name: Store '${{ matrix.client }}' JavaScript utils package
         uses: actions/upload-artifact@v3

clients/algoliasearch-client-javascript/packages/client-common/src/createEchoRequester.ts

@@ -1,4 +1,4 @@
-import type { EchoResponse, EndRequest, Request, Response } from './types';
+import type { EchoResponse, EndRequest, Requester, Response } from './types';
 
 export type EchoRequesterParams = {
   getURL: (url: string) => URL;
@@ -8,7 +8,8 @@ export type EchoRequesterParams = {
 function getUrlParams({
   host,
   searchParams: urlSearchParams,
-}: URL): Pick<EchoResponse, 'algoliaAgent' | 'host' | 'searchParams'> {
+  pathname,
+}: URL): Pick<EchoResponse, 'algoliaAgent' | 'host' | 'path' | 'searchParams'> {
   const algoliaAgent = urlSearchParams.get('x-algolia-agent') || '';
   const searchParams = {};
 
@@ -25,39 +26,34 @@ function getUrlParams({
     algoliaAgent,
     searchParams:
       Object.keys(searchParams).length === 0 ? undefined : searchParams,
+    path: pathname,
   };
 }
 
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function createEchoRequester({
   getURL,
   status = 200,
-}: EchoRequesterParams) {
-  function send(
-    { headers, url, connectTimeout, responseTimeout }: EndRequest,
-    { data, ...originalRequest }: Request
-  ): Promise<Response> {
-    const { host, searchParams, algoliaAgent } = getUrlParams(getURL(url));
-    const originalData =
-      data && Object.keys(data).length > 0 ? data : undefined;
+}: EchoRequesterParams): Requester {
+  function send(request: EndRequest): Promise<Response> {
+    const { host, searchParams, algoliaAgent, path } = getUrlParams(
+      getURL(request.url)
+    );
+
+    const content: EchoResponse = {
+      ...request,
+      data: request.data ? JSON.parse(request.data) : undefined,
+      path,
+      host,
+      algoliaAgent: encodeURI(algoliaAgent),
+      searchParams,
+    };
 
     return Promise.resolve({
-      content: JSON.stringify({
-        ...originalRequest,
-        host,
-        headers,
-        connectTimeout,
-        responseTimeout,
-        algoliaAgent: encodeURI(algoliaAgent),
-        searchParams,
-        data: originalData,
-      }),
+      content: JSON.stringify(content),
       isTimedOut: false,
       status,
     });
   }
 
   return { send };
 }
-
-export type EchoRequester = ReturnType<typeof createEchoRequester>;

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts

@@ -176,7 +176,7 @@ export function createTransporter({
         return stackFrame;
       };
 
-      const response = await requester.send(payload, request);
+      const response = await requester.send(payload);
 
       if (isRetryable(response)) {
         const stackFrame = pushToStackTrace(response);

clients/algoliasearch-client-javascript/packages/client-common/src/types/Requester.ts

@@ -1,9 +1,15 @@
 import type { Headers, QueryParameters } from './Transporter';
 
+/**
+ * The method of the request.
+ */
 export type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
 
 export type Request = {
   method: Method;
+  /**
+   * The path of the REST API to send the request to.
+   */
   path: string;
   queryParameters: QueryParameters;
   data?: Array<Record<string, any>> | Record<string, any>;
@@ -20,33 +26,47 @@ export type Request = {
   useReadTransporter?: boolean;
 };
 
-export type EndRequest = {
-  method: Method;
+export type EndRequest = Pick<Request, 'headers' | 'method'> & {
+  /**
+   * The full URL of the REST API.
+   */
   url: string;
+  /**
+   * The connection timeout, in milliseconds.
+   */
   connectTimeout: number;
+  /**
+   * The response timeout, in milliseconds.
+   */
   responseTimeout: number;
-  headers: Headers;
   data?: string;
 };
 
 export type Response = {
+  /**
+   * The body of the response.
+   */
   content: string;
+  /**
+   * Wether the API call is timed out or not.
+   */
   isTimedOut: boolean;
+  /**
+   * The status code of the response.
+   */
   status: number;
 };
 
 export type Requester = {
   /**
    * Sends the given `request` to the server.
    */
-  send: (request: EndRequest, originalRequest: Request) => Promise<Response>;
+  send: (request: EndRequest) => Promise<Response>;
 };
 
-export type EchoResponse = Request & {
-  connectTimeout: number;
-  host: string;
-  headers: Headers;
-  responseTimeout: number;
-  algoliaAgent: string;
-  searchParams?: Record<string, string>;
-};
+export type EchoResponse = Omit<EndRequest, 'data'> &
+  Pick<Request, 'data' | 'path'> & {
+    host: string;
+    algoliaAgent: string;
+    searchParams?: Record<string, string>;
+  };

clients/algoliasearch-client-javascript/packages/client-common/src/types/Transporter.ts

@@ -26,7 +26,7 @@ export type RequestOptions = Pick<Request, 'cacheable'> & {
   queryParameters?: QueryParameters;
 
   /**
-   * Custom data for the request. This data are
+   * Custom data for the request. This data is
    * going to be merged the transporter data.
    */
   data?: Array<Record<string, any>> | Record<string, any>;

clients/algoliasearch-client-javascript/packages/requester-browser-xhr/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-browser-xhr/package.json

@@ -14,15 +14,20 @@
     "index.ts"
   ],
   "scripts": {
-    "build": "tsc",
-    "clean": "rm -rf dist/"
+    "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",
-    "typescript": "4.7.4"
+    "jest": "28.1.2",
+    "jest-environment-jsdom": "28.1.2",
+    "ts-jest": "28.0.5",
+    "typescript": "4.7.4",
+    "xhr-mock": "2.5.1"
   },
   "engines": {
     "node": ">= 14.0.0"