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

algolia · Jan 7, 2022 · 8a08566 · 8a08566
1 parent b51ff01
commit 8a08566
Show file tree

Hide file tree

Showing 13 changed files with 1,010 additions and 592 deletions.
diff --git a/clients/algoliasearch-client-javascript/client-analytics/utils/requester/EchoRequester.ts b/clients/algoliasearch-client-javascript/client-analytics/utils/requester/EchoRequester.ts
@@ -2,14 +2,53 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  searchParams: string | undefined;
+  userAgent: string | undefined;
+  connectTimeout: number;
+  responseTimeout: number;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): string | undefined {
+  let searchParams = '?';
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams += encodeURI(`${k}=${v}&`);
+  }
+
+  if (searchParams === '?') {
+    return undefined;
+  }
+
+  return searchParams.replace(/&$/, '');
+}
+
 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 additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams: searchParamsWithoutUA(urlSearchParams),
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

diff --git a/clients/algoliasearch-client-javascript/client-insights/utils/requester/EchoRequester.ts b/clients/algoliasearch-client-javascript/client-insights/utils/requester/EchoRequester.ts
@@ -2,14 +2,53 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  searchParams: string | undefined;
+  userAgent: string | undefined;
+  connectTimeout: number;
+  responseTimeout: number;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): string | undefined {
+  let searchParams = '?';
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams += encodeURI(`${k}=${v}&`);
+  }
+
+  if (searchParams === '?') {
+    return undefined;
+  }
+
+  return searchParams.replace(/&$/, '');
+}
+
 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 additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams: searchParamsWithoutUA(urlSearchParams),
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

diff --git a/...s/algoliasearch-client-javascript/client-personalization/utils/requester/EchoRequester.ts b/...s/algoliasearch-client-javascript/client-personalization/utils/requester/EchoRequester.ts
@@ -2,14 +2,53 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  searchParams: string | undefined;
+  userAgent: string | undefined;
+  connectTimeout: number;
+  responseTimeout: number;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): string | undefined {
+  let searchParams = '?';
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams += encodeURI(`${k}=${v}&`);
+  }
+
+  if (searchParams === '?') {
+    return undefined;
+  }
+
+  return searchParams.replace(/&$/, '');
+}
+
 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 additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams: searchParamsWithoutUA(urlSearchParams),
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

diff --git a/clients/algoliasearch-client-javascript/client-search/utils/requester/EchoRequester.ts b/clients/algoliasearch-client-javascript/client-search/utils/requester/EchoRequester.ts
@@ -2,14 +2,53 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  searchParams: string | undefined;
+  userAgent: string | undefined;
+  connectTimeout: number;
+  responseTimeout: number;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): string | undefined {
+  let searchParams = '?';
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams += encodeURI(`${k}=${v}&`);
+  }
+
+  if (searchParams === '?') {
+    return undefined;
+  }
+
+  return searchParams.replace(/&$/, '');
+}
+
 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 additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams: searchParamsWithoutUA(urlSearchParams),
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

diff --git a/clients/algoliasearch-client-javascript/recommend/utils/requester/EchoRequester.ts b/clients/algoliasearch-client-javascript/recommend/utils/requester/EchoRequester.ts
@@ -2,14 +2,53 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  searchParams: string | undefined;
+  userAgent: string | undefined;
+  connectTimeout: number;
+  responseTimeout: number;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): string | undefined {
+  let searchParams = '?';
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams += encodeURI(`${k}=${v}&`);
+  }
+
+  if (searchParams === '?') {
+    return undefined;
+  }
+
+  return searchParams.replace(/&$/, '');
+}
+
 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 additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams: searchParamsWithoutUA(urlSearchParams),
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

diff --git a/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts b/clients/algoliasearch-client-javascript/utils/requester/EchoRequester.ts
@@ -2,14 +2,53 @@ import type { EndRequest, Request, Response } from '../types';
 
 import { Requester } from './Requester';
 
+type AdditionalContent = {
+  headers: Record<string, string>;
+  searchParams: string | undefined;
+  userAgent: string | undefined;
+  connectTimeout: number;
+  responseTimeout: number;
+};
+
+function searchParamsWithoutUA(params: URLSearchParams): string | undefined {
+  let searchParams = '?';
+
+  for (const [k, v] of params) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams += encodeURI(`${k}=${v}&`);
+  }
+
+  if (searchParams === '?') {
+    return undefined;
+  }
+
+  return searchParams.replace(/&$/, '');
+}
+
 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 additionalContent: AdditionalContent = {
+      headers,
+      connectTimeout,
+      responseTimeout,
+      userAgent: userAgent ? encodeURI(userAgent) : undefined,
+      searchParams: searchParamsWithoutUA(urlSearchParams),
+    };
+
     return Promise.resolve({
-      content: JSON.stringify(originalRequest),
+      content: JSON.stringify({ ...originalRequest, ...additionalContent }),
       isTimedOut: false,
       status: this.status,
     });

diff --git a/tests/CTS/templates/javascript.mustache b/tests/CTS/templates/javascript.mustache
@@ -17,11 +17,11 @@ describe('{{operationId}}', () => {
             }{{/hasParameters}}
         );
 
-        expect(req).toMatchObject({
+        expect(req).toEqual(expect.objectContaining({
         path: '{{{request.path}}}',
         method: '{{{request.method}}}',
-        {{#request.data}}data: {{{.}}},{{/request.data}}
-        })
+        {{#request.data}}data: {{{.}}},{{/request.data}}{{#request.searchParams}}searchParams: {{{.}}},{{/request.searchParams}}
+        }))
     });
 
     {{/tests}}

diff --git a/tests/generateCTS.ts b/tests/generateCTS.ts
@@ -30,7 +30,10 @@ type Tests = {
   request: {
     path: string;
     method: string;
+    headers: string;
+    userAgent: string;
     data?: string;
+    searchParams?: string;
   };
 };
 
@@ -128,9 +131,11 @@ async function loadCTSForClient(client: string): Promise<CTSBlock[]> {
       if (test.testName === undefined) {
         test.testName = test.method;
       }
-
       // stringify request.data too
       test.request.data = JSON.stringify(test.request.data);
+      test.request.headers = JSON.stringify(test.request.headers);
+      test.request.searchParams = JSON.stringify(test.request.searchParams);
+      test.request.userAgent = JSON.stringify(test.request.userAgent);
 
       if (Object.keys(test.parameters).length === 0) {
         test.parameters = undefined;
@@ -156,13 +161,14 @@ async function loadCTSForClient(client: string): Promise<CTSBlock[]> {
       test.parametersWithDataType = Object.entries(test.parameters).map(
         ([key, value], i, arr) => {
           const isDate = key === 'startDate' || key === 'endDate';
+          const isArray = Array.isArray(value);
 
           return {
             key,
             value: JSON.stringify(value),
             isString: typeof value === 'string' && isDate === false,
-            isObject: typeof value === 'object',
-            isArray: Array.isArray(value),
+            isObject: typeof value === 'object' && isArray === false,
+            isArray,
             isDate,
             '-last': i === arr.length - 1,
           };