fix JavaScript echoRequester

Author: shortcuts

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/types/Requester.ts

@@ -42,11 +42,9 @@ export type Requester = {
   send: (request: EndRequest, originalRequest: Request) => 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/requester-browser-xhr/src/echoRequester.ts

@@ -1,6 +1,6 @@
 import { createEchoRequester } from '@algolia/client-common';
-import type { EchoRequester } from '@algolia/client-common';
+import type { Requester } from '@algolia/client-common';
 
-export function echoRequester(status: number = 200): EchoRequester {
+export function echoRequester(status: number = 200): Requester {
   return createEchoRequester({ getURL: (url: string) => new URL(url), status });
 }

clients/algoliasearch-client-javascript/packages/requester-node-http/src/echoRequester.ts

@@ -1,8 +1,8 @@
 import { URL } from 'url';
 
 import { createEchoRequester } from '@algolia/client-common';
-import type { EchoRequester } from '@algolia/client-common';
+import type { Requester } from '@algolia/client-common';
 
-export function echoRequester(status: number = 200): EchoRequester {
+export function echoRequester(status: number = 200): Requester {
   return createEchoRequester({ getURL: (url: string) => new URL(url), status });
 }

tests/output/javascript/yarn.lock

@@ -35,12 +35,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-predict@link:../../../clients/algoliasearch-client-javascript/packages/client-predict::locator=javascript-tests%40workspace%3A.":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-predict@link:../../../clients/algoliasearch-client-javascript/packages/client-predict::locator=javascript-tests%40workspace%3A."
-  languageName: node
-  linkType: soft
-
 "@algolia/client-query-suggestions@link:../../../clients/algoliasearch-client-javascript/packages/client-query-suggestions::locator=javascript-tests%40workspace%3A.":
   version: 0.0.0-use.local
   resolution: "@algolia/client-query-suggestions@link:../../../clients/algoliasearch-client-javascript/packages/client-query-suggestions::locator=javascript-tests%40workspace%3A."
@@ -59,6 +53,12 @@ __metadata:
   languageName: node
   linkType: soft
 
+"@algolia/predict@link:../../../clients/algoliasearch-client-javascript/packages/predict::locator=javascript-tests%40workspace%3A.":
+  version: 0.0.0-use.local
+  resolution: "@algolia/predict@link:../../../clients/algoliasearch-client-javascript/packages/predict::locator=javascript-tests%40workspace%3A."
+  languageName: node
+  linkType: soft
+
 "@algolia/recommend@link:../../../clients/algoliasearch-client-javascript/packages/recommend::locator=javascript-tests%40workspace%3A.":
   version: 0.0.0-use.local
   resolution: "@algolia/recommend@link:../../../clients/algoliasearch-client-javascript/packages/recommend::locator=javascript-tests%40workspace%3A."
@@ -2120,10 +2120,10 @@ __metadata:
     "@algolia/client-common": "link:../../../clients/algoliasearch-client-javascript/packages/client-common"
     "@algolia/client-insights": "link:../../../clients/algoliasearch-client-javascript/packages/client-insights"
     "@algolia/client-personalization": "link:../../../clients/algoliasearch-client-javascript/packages/client-personalization"
-    "@algolia/client-predict": "link:../../../clients/algoliasearch-client-javascript/packages/client-predict"
     "@algolia/client-query-suggestions": "link:../../../clients/algoliasearch-client-javascript/packages/client-query-suggestions"
     "@algolia/client-search": "link:../../../clients/algoliasearch-client-javascript/packages/client-search"
     "@algolia/client-sources": "link:../../../clients/algoliasearch-client-javascript/packages/client-sources"
+    "@algolia/predict": "link:../../../clients/algoliasearch-client-javascript/packages/predict"
     "@algolia/recommend": "link:../../../clients/algoliasearch-client-javascript/packages/recommend"
     "@algolia/requester-node-http": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http"
     "@types/jest": 28.1.1