Optional request timeout (#41)

aarsilv · web-flow · commit f679c17e6187 · 2023-11-28T12:37:55.000-07:00
* configurable request timeout

* generated docs

* appease prettier

* tweak warning wording

* check in made with version 16.20
diff --git a/.husky/pre-commit b/.husky/pre-commit
diff --git a/docs/js-client-sdk.eppojsclient.getassignment.md b/docs/js-client-sdk.eppojsclient.getassignment.md
@@ -4,7 +4,7 @@
 
 ## EppoJSClient.getAssignment() method
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 getAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Record<string, any>, assignmentHooks?: IAssignmentHooks): string | null;
@@ -16,10 +16,10 @@ getAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Record<st
 |  --- | --- | --- |
 |  subjectKey | string |  |
 |  flagKey | string |  |
-|  subjectAttributes | Record&lt;string, any&gt; | <i>(Optional)</i> |
-|  assignmentHooks | IAssignmentHooks | <i>(Optional)</i> |
+|  subjectAttributes | Record&lt;string, any&gt; | _(Optional)_ |
+|  assignmentHooks | IAssignmentHooks | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 string \| null
 
diff --git a/docs/js-client-sdk.eppojsclient.getboolassignment.md b/docs/js-client-sdk.eppojsclient.getboolassignment.md
@@ -4,7 +4,7 @@
 
 ## EppoJSClient.getBoolAssignment() method
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 getBoolAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Record<string, any>, assignmentHooks?: IAssignmentHooks): boolean | null;
@@ -16,10 +16,10 @@ getBoolAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Recor
 |  --- | --- | --- |
 |  subjectKey | string |  |
 |  flagKey | string |  |
-|  subjectAttributes | Record&lt;string, any&gt; | <i>(Optional)</i> |
-|  assignmentHooks | IAssignmentHooks | <i>(Optional)</i> |
+|  subjectAttributes | Record&lt;string, any&gt; | _(Optional)_ |
+|  assignmentHooks | IAssignmentHooks | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 boolean \| null
 
diff --git a/docs/js-client-sdk.eppojsclient.getjsonstringassignment.md b/docs/js-client-sdk.eppojsclient.getjsonstringassignment.md
@@ -4,7 +4,7 @@
 
 ## EppoJSClient.getJSONStringAssignment() method
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 getJSONStringAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Record<string, any>, assignmentHooks?: IAssignmentHooks): string | null;
@@ -16,10 +16,10 @@ getJSONStringAssignment(subjectKey: string, flagKey: string, subjectAttributes?:
 |  --- | --- | --- |
 |  subjectKey | string |  |
 |  flagKey | string |  |
-|  subjectAttributes | Record&lt;string, any&gt; | <i>(Optional)</i> |
-|  assignmentHooks | IAssignmentHooks | <i>(Optional)</i> |
+|  subjectAttributes | Record&lt;string, any&gt; | _(Optional)_ |
+|  assignmentHooks | IAssignmentHooks | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 string \| null
 
diff --git a/docs/js-client-sdk.eppojsclient.getnumericassignment.md b/docs/js-client-sdk.eppojsclient.getnumericassignment.md
@@ -4,7 +4,7 @@
 
 ## EppoJSClient.getNumericAssignment() method
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 getNumericAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Record<string, any>, assignmentHooks?: IAssignmentHooks): number | null;
@@ -16,10 +16,10 @@ getNumericAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Re
 |  --- | --- | --- |
 |  subjectKey | string |  |
 |  flagKey | string |  |
-|  subjectAttributes | Record&lt;string, any&gt; | <i>(Optional)</i> |
-|  assignmentHooks | IAssignmentHooks | <i>(Optional)</i> |
+|  subjectAttributes | Record&lt;string, any&gt; | _(Optional)_ |
+|  assignmentHooks | IAssignmentHooks | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 number \| null
 
diff --git a/docs/js-client-sdk.eppojsclient.getparsedjsonassignment.md b/docs/js-client-sdk.eppojsclient.getparsedjsonassignment.md
@@ -4,7 +4,7 @@
 
 ## EppoJSClient.getParsedJSONAssignment() method
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 getParsedJSONAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Record<string, any>, assignmentHooks?: IAssignmentHooks): object | null;
@@ -16,10 +16,10 @@ getParsedJSONAssignment(subjectKey: string, flagKey: string, subjectAttributes?:
 |  --- | --- | --- |
 |  subjectKey | string |  |
 |  flagKey | string |  |
-|  subjectAttributes | Record&lt;string, any&gt; | <i>(Optional)</i> |
-|  assignmentHooks | IAssignmentHooks | <i>(Optional)</i> |
+|  subjectAttributes | Record&lt;string, any&gt; | _(Optional)_ |
+|  assignmentHooks | IAssignmentHooks | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 object \| null
 
diff --git a/docs/js-client-sdk.eppojsclient.getstringassignment.md b/docs/js-client-sdk.eppojsclient.getstringassignment.md
@@ -4,7 +4,7 @@
 
 ## EppoJSClient.getStringAssignment() method
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 getStringAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Record<string, any>, assignmentHooks?: IAssignmentHooks): string | null;
@@ -16,10 +16,10 @@ getStringAssignment(subjectKey: string, flagKey: string, subjectAttributes?: Rec
 |  --- | --- | --- |
 |  subjectKey | string |  |
 |  flagKey | string |  |
-|  subjectAttributes | Record&lt;string, any&gt; | <i>(Optional)</i> |
-|  assignmentHooks | IAssignmentHooks | <i>(Optional)</i> |
+|  subjectAttributes | Record&lt;string, any&gt; | _(Optional)_ |
+|  assignmentHooks | IAssignmentHooks | _(Optional)_ |
 
-<b>Returns:</b>
+**Returns:**
 
 string \| null
 
diff --git a/docs/js-client-sdk.eppojsclient.instance.md b/docs/js-client-sdk.eppojsclient.instance.md
@@ -4,7 +4,7 @@
 
 ## EppoJSClient.instance property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 static instance: EppoJSClient;
diff --git a/docs/js-client-sdk.eppojsclient.md b/docs/js-client-sdk.eppojsclient.md
@@ -6,12 +6,12 @@
 
 Client for assigning experiment variations.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export declare class EppoJSClient extends EppoClient 
 ```
-<b>Extends:</b> EppoClient
+**Extends:** EppoClient
 
 ## Properties
 
diff --git a/docs/js-client-sdk.getinstance.md b/docs/js-client-sdk.getinstance.md
@@ -6,12 +6,12 @@
 
 Used to access a singleton SDK client instance. Use the method after calling init() to initialize the client.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export declare function getInstance(): IEppoClient;
 ```
-<b>Returns:</b>
+**Returns:**
 
 IEppoClient
 
diff --git a/docs/js-client-sdk.iclientconfig.apikey.md b/docs/js-client-sdk.iclientconfig.apikey.md
@@ -6,7 +6,7 @@
 
 Eppo API key
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 apiKey: string;
diff --git a/docs/js-client-sdk.iclientconfig.assignmentlogger.md b/docs/js-client-sdk.iclientconfig.assignmentlogger.md
@@ -6,7 +6,7 @@
 
 Pass a logging implementation to send variation assignments to your data warehouse.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 assignmentLogger: IAssignmentLogger;
diff --git a/docs/js-client-sdk.iclientconfig.baseurl.md b/docs/js-client-sdk.iclientconfig.baseurl.md
@@ -6,7 +6,7 @@
 
 Base URL of the Eppo API. Clients should use the default setting in most cases.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 baseUrl?: string;
diff --git a/docs/js-client-sdk.iclientconfig.md b/docs/js-client-sdk.iclientconfig.md
@@ -6,17 +6,18 @@
 
 Configuration used for initializing the Eppo client
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface IClientConfig 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [apiKey](./js-client-sdk.iclientconfig.apikey.md) | string | Eppo API key |
-|  [assignmentLogger](./js-client-sdk.iclientconfig.assignmentlogger.md) | IAssignmentLogger | Pass a logging implementation to send variation assignments to your data warehouse. |
-|  [baseUrl?](./js-client-sdk.iclientconfig.baseurl.md) | string | <i>(Optional)</i> Base URL of the Eppo API. Clients should use the default setting in most cases. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [apiKey](./js-client-sdk.iclientconfig.apikey.md) |  | string | Eppo API key |
+|  [assignmentLogger](./js-client-sdk.iclientconfig.assignmentlogger.md) |  | IAssignmentLogger | Pass a logging implementation to send variation assignments to your data warehouse. |
+|  [baseUrl?](./js-client-sdk.iclientconfig.baseurl.md) |  | string | _(Optional)_ Base URL of the Eppo API. Clients should use the default setting in most cases. |
+|  [requestTimeoutMs?](./js-client-sdk.iclientconfig.requesttimeoutms.md) |  | number | _(Optional)_ \* Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000) |
 
diff --git a/docs/js-client-sdk.iclientconfig.requesttimeoutms.md b/docs/js-client-sdk.iclientconfig.requesttimeoutms.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [requestTimeoutMs](./js-client-sdk.iclientconfig.requesttimeoutms.md)
+
+## IClientConfig.requestTimeoutMs property
+
+\* Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000)
+
+**Signature:**
+
+```typescript
+requestTimeoutMs?: number;
+```
diff --git a/docs/js-client-sdk.init.md b/docs/js-client-sdk.init.md
@@ -6,7 +6,7 @@
 
 Initializes the Eppo client with configuration parameters. This method should be called once on application startup.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export declare function init(config: IClientConfig): Promise<IEppoClient>;
@@ -18,7 +18,7 @@ export declare function init(config: IClientConfig): Promise<IEppoClient>;
 |  --- | --- | --- |
 |  config | [IClientConfig](./js-client-sdk.iclientconfig.md) | client configuration |
 
-<b>Returns:</b>
+**Returns:**
 
 Promise&lt;IEppoClient&gt;
 
diff --git a/js-client-sdk.api.md b/js-client-sdk.api.md
@@ -40,6 +40,7 @@ export interface IClientConfig {
     apiKey: string;
     assignmentLogger: IAssignmentLogger;
     baseUrl?: string;
+    requestTimeoutMs?: number;
 }
 
 export { IEppoClient }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eppo/js-client-sdk",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Eppo SDK for client-side JavaScript applications",
   "main": "dist/index.js",
   "files": [
@@ -49,7 +49,7 @@
     "prettier": "^2.7.1",
     "terser-webpack-plugin": "^5.3.3",
     "testdouble": "^3.16.6",
-    "ts-jest": "^28.0.5",
+    "ts-jest": "^29.1.1",
     "ts-loader": "^9.3.1",
     "typescript": "^4.7.4",
     "webpack": "^5.73.0",
diff --git a/src/index.ts b/src/index.ts
@@ -33,6 +33,11 @@ export interface IClientConfig {
    * Pass a logging implementation to send variation assignments to your data warehouse.
    */
   assignmentLogger: IAssignmentLogger;
+
+  /***
+   * Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000)
+   */
+  requestTimeoutMs?: number;
 }
 
 export { IAssignmentLogger, IAssignmentEvent, IEppoClient } from '@eppo/js-client-sdk-common';
@@ -133,23 +138,30 @@ export class EppoJSClient extends EppoClient {
  */
 export async function init(config: IClientConfig): Promise<IEppoClient> {
   validation.validateNotBlank(config.apiKey, 'API key required');
-  const axiosInstance = axios.create({
-    baseURL: config.baseUrl || constants.BASE_URL,
-    timeout: constants.REQUEST_TIMEOUT_MILLIS,
-  });
-  const httpClient = new HttpClient(axiosInstance, {
-    apiKey: config.apiKey,
-    sdkName,
-    sdkVersion,
-  });
-  EppoJSClient.instance.setLogger(config.assignmentLogger);
-
-  // default behavior is to use a non-expiring cache.
-  // this can be overridden after initialization.
-  EppoJSClient.instance.useNonExpiringAssignmentCache();
-
-  const configurationRequestor = new ExperimentConfigurationRequestor(localStorage, httpClient);
-  await configurationRequestor.fetchAndStoreConfigurations();
+  try {
+    const axiosInstance = axios.create({
+      baseURL: config.baseUrl || constants.BASE_URL,
+      timeout: config.requestTimeoutMs || constants.REQUEST_TIMEOUT_MILLIS,
+    });
+    const httpClient = new HttpClient(axiosInstance, {
+      apiKey: config.apiKey,
+      sdkName,
+      sdkVersion,
+    });
+    EppoJSClient.instance.setLogger(config.assignmentLogger);
+
+    // default behavior is to use a non-expiring cache.
+    // this can be overridden after initialization.
+    EppoJSClient.instance.useNonExpiringAssignmentCache();
+
+    const configurationRequestor = new ExperimentConfigurationRequestor(localStorage, httpClient);
+    await configurationRequestor.fetchAndStoreConfigurations();
+  } catch (error) {
+    console.warn(
+      'Error encountered initializing the Eppo SDK, assignment calls will return null and not be logged',
+    );
+    throw error;
+  }
   return EppoJSClient.instance;
 }
 
diff --git a/yarn.lock b/yarn.lock
