fix(javascript): convert timeouts to ms APIC-512 (#643)

Author: millotp

clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts

@@ -12,6 +12,9 @@ import {
   createMemoryCache,
   createFallbackableCache,
   createBrowserLocalStorageCache,
+  DEFAULT_CONNECT_TIMEOUT_BROWSER,
+  DEFAULT_READ_TIMEOUT_BROWSER,
+  DEFAULT_WRITE_TIMEOUT_BROWSER,
 } from '@experimental-api-clients-automation/client-common';
 import type {
   PersonalizationClient,
@@ -32,19 +35,19 @@ export function algoliasearch(
   apiKey: string,
   options?: { requester?: Requester; hosts?: Host[] }
 ) {
-  if (!appId) {
+  if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }
 
-  if (!apiKey) {
+  if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
 
   const commonOptions: Omit<CreateClientOptions, 'apiKey' | 'appId'> = {
     timeouts: {
-      connect: 1,
-      read: 2,
-      write: 30,
+      connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
+      read: DEFAULT_READ_TIMEOUT_BROWSER,
+      write: DEFAULT_WRITE_TIMEOUT_BROWSER,
     },
     requester: options?.requester ?? createXhrRequester(),
     algoliaAgents: [{ segment: 'Browser' }],

clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts

@@ -9,6 +9,9 @@ import type {
   Requester,
 } from '@experimental-api-clients-automation/client-common';
 import {
+  DEFAULT_CONNECT_TIMEOUT_NODE,
+  DEFAULT_READ_TIMEOUT_NODE,
+  DEFAULT_WRITE_TIMEOUT_NODE,
   createMemoryCache,
   createNullCache,
 } from '@experimental-api-clients-automation/client-common';
@@ -31,19 +34,19 @@ export function algoliasearch(
   apiKey: string,
   options?: { requester?: Requester; hosts?: Host[] }
 ) {
-  if (!appId) {
+  if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }
 
-  if (!apiKey) {
+  if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
 
   const commonOptions: Omit<CreateClientOptions, 'apiKey' | 'appId'> = {
     timeouts: {
-      connect: 2,
-      read: 5,
-      write: 30,
+      connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+      read: DEFAULT_READ_TIMEOUT_NODE,
+      write: DEFAULT_WRITE_TIMEOUT_NODE,
     },
     requester: options?.requester ?? createHttpRequester(),
     algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],

clients/algoliasearch-client-javascript/packages/client-common/index.ts

@@ -6,3 +6,4 @@ export * from './src/transporter';
 export * from './src/createAlgoliaAgent';
 export * from './src/getAlgoliaAgent';
 export * from './src/types';
+export * from './src/constants';

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

@@ -0,0 +1,7 @@
+export const DEFAULT_CONNECT_TIMEOUT_BROWSER = 1000;
+export const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
+export const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
+
+export const DEFAULT_CONNECT_TIMEOUT_NODE = 2000;
+export const DEFAULT_READ_TIMEOUT_NODE = 5000;
+export const DEFAULT_WRITE_TIMEOUT_NODE = 30000;

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

@@ -70,8 +70,19 @@ export type AlgoliaAgent = {
 };
 
 export type Timeouts = {
+  /**
+   * Timeout in milliseconds before the connection is established.
+   */
   connect: number;
+
+  /**
+   * Timeout in milliseconds before reading the response on a read request.
+   */
   read: number;
+
+  /**
+   * Timeout in milliseconds before reading the response on a write request.
+   */
   write: number;
 };
 
@@ -166,7 +177,7 @@ export type Transporter = {
   responsesCache: Cache;
 
   /**
-   * The timeouts used by the requester. The transporter
+   * The timeouts used by the requester (in milliseconds). The transporter
    * layer may increase this timeouts as defined on the
    * retry strategy.
    */

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

@@ -25,7 +25,7 @@ export function createXhrRequester(): Requester {
             content,
             isTimedOut: true,
           });
-        }, timeout * 1000);
+        }, timeout);
       };
 
       const connectTimeout = createTimeout(

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

@@ -65,7 +65,7 @@ export function createHttpRequester(): Requester {
             content,
             isTimedOut: true,
           });
-        }, timeout * 1000);
+        }, timeout);
       };
 
       connectTimeout = createTimeout(

templates/javascript/browser.mustache

@@ -1,4 +1,5 @@
 import type { InitClientOptions } from '@experimental-api-clients-automation/client-common';
+import { DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_BROWSER } from '@experimental-api-clients-automation/client-common';
 import { createMemoryCache, createFallbackableCache, createBrowserLocalStorageCache } from '@experimental-api-clients-automation/client-common';
 import { createXhrRequester } from '@experimental-api-clients-automation/requester-browser-xhr';
 
@@ -43,9 +44,9 @@ export function {{apiName}}(
     appId,
     apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
     timeouts: {
-      connect: 1,
-      read: 2,
-      write: 30,
+      connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
+      read: DEFAULT_READ_TIMEOUT_BROWSER,
+      write: DEFAULT_WRITE_TIMEOUT_BROWSER,
     },
     requester: createXhrRequester(),
     algoliaAgents: [{ segment: 'Browser' }],

templates/javascript/node.mustache

@@ -1,4 +1,5 @@
 import type { InitClientOptions } from '@experimental-api-clients-automation/client-common';
+import { DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE } from '@experimental-api-clients-automation/client-common';
 import { createMemoryCache, createNullCache } from '@experimental-api-clients-automation/client-common';
 import { createHttpRequester } from '@experimental-api-clients-automation/requester-node-http';
 
@@ -43,9 +44,9 @@ export function {{apiName}}(
     appId,
     apiKey,{{#hasRegionalHost}}region,{{/hasRegionalHost}}
     timeouts: {
-      connect: 2,
-      read: 5,
-      write: 30,
+      connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+      read: DEFAULT_READ_TIMEOUT_NODE,
+      write: DEFAULT_WRITE_TIMEOUT_NODE,
     },
     requester: createHttpRequester(),
     algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],

tests/CTS/client/abtesting/api.json

@@ -45,8 +45,8 @@
         "expected": {
           "match": {
             "objectContaining": {
-              "connectTimeout": 2,
-              "responseTimeout": 30
+              "connectTimeout": 2000,
+              "responseTimeout": 30000
             }
           }
         }