feat(js): pass searchParams to EchoRequester, update CTS

clients/algoliasearch-client-javascript/client-analytics/utils/requester/EchoRequester.ts

@@ -2,14 +2,50 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  connectTimeout: number;
+  responseTimeout: number;
+  userAgent: string | undefined;
+  searchParams: Record<string, any>;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): Record<string, any> {
+  const searchParams = {};
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams[k] = v;
+  }
+
+  return searchParams;
+}
+
 export class EchoRequester extends Requester {
   constructor(private status = 200) {
     super();
   }
 
-  send(_request: EndRequest, originalRequest: Request): Promise<Response> {
+  send(
+    { headers, url, connectTimeout, responseTimeout }: EndRequest,
+    originalRequest: Request
+  ): Promise<Response> {
+    const urlSearchParams = new URL(url).searchParams;
+    const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
+    const searchParams = searchParamsWithoutUA(urlSearchParams);
+    const additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams,
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

clients/algoliasearch-client-javascript/client-insights/utils/requester/EchoRequester.ts

@@ -2,14 +2,50 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  connectTimeout: number;
+  responseTimeout: number;
+  userAgent: string | undefined;
+  searchParams: Record<string, any>;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): Record<string, any> {
+  const searchParams = {};
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams[k] = v;
+  }
+
+  return searchParams;
+}
+
 export class EchoRequester extends Requester {
   constructor(private status = 200) {
     super();
   }
 
-  send(_request: EndRequest, originalRequest: Request): Promise<Response> {
+  send(
+    { headers, url, connectTimeout, responseTimeout }: EndRequest,
+    originalRequest: Request
+  ): Promise<Response> {
+    const urlSearchParams = new URL(url).searchParams;
+    const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
+    const searchParams = searchParamsWithoutUA(urlSearchParams);
+    const additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams,
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

clients/algoliasearch-client-javascript/client-personalization/utils/requester/EchoRequester.ts

@@ -2,14 +2,50 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  connectTimeout: number;
+  responseTimeout: number;
+  userAgent: string | undefined;
+  searchParams: Record<string, any>;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): Record<string, any> {
+  const searchParams = {};
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams[k] = v;
+  }
+
+  return searchParams;
+}
+
 export class EchoRequester extends Requester {
   constructor(private status = 200) {
     super();
   }
 
-  send(_request: EndRequest, originalRequest: Request): Promise<Response> {
+  send(
+    { headers, url, connectTimeout, responseTimeout }: EndRequest,
+    originalRequest: Request
+  ): Promise<Response> {
+    const urlSearchParams = new URL(url).searchParams;
+    const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
+    const searchParams = searchParamsWithoutUA(urlSearchParams);
+    const additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams,
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

clients/algoliasearch-client-javascript/client-search/utils/requester/EchoRequester.ts

@@ -2,14 +2,50 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  connectTimeout: number;
+  responseTimeout: number;
+  userAgent: string | undefined;
+  searchParams: Record<string, any>;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): Record<string, any> {
+  const searchParams = {};
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams[k] = v;
+  }
+
+  return searchParams;
+}
+
 export class EchoRequester extends Requester {
   constructor(private status = 200) {
     super();
   }
 
-  send(_request: EndRequest, originalRequest: Request): Promise<Response> {
+  send(
+    { headers, url, connectTimeout, responseTimeout }: EndRequest,
+    originalRequest: Request
+  ): Promise<Response> {
+    const urlSearchParams = new URL(url).searchParams;
+    const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
+    const searchParams = searchParamsWithoutUA(urlSearchParams);
+    const additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams,
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

clients/algoliasearch-client-javascript/recommend/utils/requester/EchoRequester.ts

@@ -2,14 +2,50 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  connectTimeout: number;
+  responseTimeout: number;
+  userAgent: string | undefined;
+  searchParams: Record<string, any>;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): Record<string, any> {
+  const searchParams = {};
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams[k] = v;
+  }
+
+  return searchParams;
+}
+
 export class EchoRequester extends Requester {
   constructor(private status = 200) {
     super();
   }
 
-  send(_request: EndRequest, originalRequest: Request): Promise<Response> {
+  send(
+    { headers, url, connectTimeout, responseTimeout }: EndRequest,
+    originalRequest: Request
+  ): Promise<Response> {
+    const urlSearchParams = new URL(url).searchParams;
+    const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
+    const searchParams = searchParamsWithoutUA(urlSearchParams);
+    const additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams,
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts

@@ -2,14 +2,50 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  connectTimeout: number;
+  responseTimeout: number;
+  userAgent: string | undefined;
+  searchParams: Record<string, any>;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): Record<string, any> {
+  const searchParams = {};
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams[k] = v;
+  }
+
+  return searchParams;
+}
+
 export class EchoRequester extends Requester {
   constructor(private status = 200) {
     super();
   }
 
-  send(_request: EndRequest, originalRequest: Request): Promise<Response> {
+  send(
+    { headers, url, connectTimeout, responseTimeout }: EndRequest,
+    originalRequest: Request
+  ): Promise<Response> {
+    const urlSearchParams = new URL(url).searchParams;
+    const userAgent = urlSearchParams.get('x-algolia-agent') || undefined;
+    const searchParams = searchParamsWithoutUA(urlSearchParams);
+    const additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams,
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

specs/analytics/paths/common/parameters.yml

@@ -7,6 +7,14 @@ Attribute:
   schema:
     type: string
 
+Search:
+  in: path
+  name: search
+  description: The query term. Must match the exact user input.
+  required: true
+  schema:
+    type: string
+
 # query
 OrderBy:
   in: query
@@ -42,15 +50,7 @@ Limit:
     type: integer
     default: 10
 
-Search:
-  in: path
-  name: search
-  description: The query term. Must match the exact user input.
-  required: true
-  schema:
-    type: string
-
-SearchInPath:
+SearchInQuery:
   in: path
   name: search
   description: The query term. Must match the exact user input.

specs/analytics/paths/search/getTopFilterAttributesForSearch.yml

@@ -6,7 +6,7 @@ get:
   summary: Returns top filter attributes for a given search.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
-    - $ref: '../common/parameters.yml#/SearchInPath'
+    - $ref: '../common/parameters.yml#/SearchInQuery'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
     - $ref: '../common/parameters.yml#/Limit'

specs/analytics/paths/search/getTopFiltersForAttributesSearch.yml

@@ -12,7 +12,7 @@ get:
       schema:
         type: string
     - $ref: '../../../common/parameters.yml#/Index'
-    - $ref: '../common/parameters.yml#/SearchInPath'
+    - $ref: '../common/parameters.yml#/SearchInQuery'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
     - $ref: '../common/parameters.yml#/Limit'

specs/analytics/paths/search/getTopFiltersNoResultsForSearch.yml

@@ -6,7 +6,7 @@ get:
   summary: Returns top filters for the given no result search.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
-    - $ref: '../common/parameters.yml#/SearchInPath'
+    - $ref: '../common/parameters.yml#/SearchInQuery'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
     - $ref: '../common/parameters.yml#/Limit'

specs/analytics/paths/search/getTopHitsForSearch.yml

@@ -6,7 +6,7 @@ get:
   summary: Returns top hits for the given search.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
-    - $ref: '../common/parameters.yml#/SearchInPath'
+    - $ref: '../common/parameters.yml#/SearchInQuery'
     - $ref: '../common/parameters.yml#/ClickAnalytics'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'