flagsmith-nodejs 2.1.2 → 2.2.0

package/build/sdk/analytics.d.ts

@@ -5,20 +5,20 @@ export declare class AnalyticsProcessor {
     analyticsData: {
         [key: string]: any;
     };
-    private timeout;
+    private requestTimeoutMs;
     /**
      * AnalyticsProcessor is used to track how often individual Flags are evaluated within
      * the Flagsmith SDK. Docs: https://docs.flagsmith.com/advanced-use/flag-analytics.
      *
      * @param data.environmentKey environment key obtained from the Flagsmith UI
      * @param data.baseApiUrl base api url to override when using self hosted version
-     * @param data.timeout used to tell requests to stop waiting for a response after a
-            given number of seconds
+     * @param data.requestTimeoutMs used to tell requests to stop waiting for a response after a
+            given number of milliseconds
      */
     constructor(data: {
         environmentKey: string;
         baseApiUrl: string;
-        timeout?: number;
+        requestTimeoutMs?: number;
     });
     /**
      * Sends all the collected data to the api asynchronously and resets the timer

package/build/sdk/analytics.js

@@ -51,16 +51,16 @@ var AnalyticsProcessor = /** @class */ (function () {
      *
      * @param data.environmentKey environment key obtained from the Flagsmith UI
      * @param data.baseApiUrl base api url to override when using self hosted version
-     * @param data.timeout used to tell requests to stop waiting for a response after a
-            given number of seconds
+     * @param data.requestTimeoutMs used to tell requests to stop waiting for a response after a
+            given number of milliseconds
      */
     function AnalyticsProcessor(data) {
-        this.timeout = 3;
+        this.requestTimeoutMs = 3000;
         this.analyticsEndpoint = data.baseApiUrl + ANALYTICS_ENDPOINT;
         this.environmentKey = data.environmentKey;
         this.lastFlushed = Date.now();
         this.analyticsData = {};
-        this.timeout = data.timeout || this.timeout;
+        this.requestTimeoutMs = data.requestTimeoutMs || this.requestTimeoutMs;
     }
     /**
      * Sends all the collected data to the api asynchronously and resets the timer
@@ -76,7 +76,7 @@ var AnalyticsProcessor = /** @class */ (function () {
                         return [4 /*yield*/, (0, node_fetch_1.default)(this.analyticsEndpoint, {
                                 method: 'POST',
                                 body: JSON.stringify(this.analyticsData),
-                                timeout: this.timeout,
+                                timeout: this.requestTimeoutMs,
                                 headers: {
                                     'Content-Type': 'application/json',
                                     'X-Environment-Key': this.environmentKey

package/build/sdk/index.d.ts

@@ -15,6 +15,7 @@ export declare class Flagsmith {
         [key: string]: any;
     };
     requestTimeoutSeconds?: number;
+    requestTimeoutMs?: number;
     enableLocalEvaluation?: boolean;
     environmentRefreshIntervalSeconds: number;
     retries?: number;

package/build/sdk/index.js

@@ -125,6 +125,7 @@ var Flagsmith = /** @class */ (function () {
         this.apiUrl = data.apiUrl || this.apiUrl;
         this.customHeaders = data.customHeaders;
         this.requestTimeoutSeconds = data.requestTimeoutSeconds;
+        this.requestTimeoutMs = data.requestTimeoutSeconds ? data.requestTimeoutSeconds * 1000 : undefined;
         this.enableLocalEvaluation = data.enableLocalEvaluation;
         this.environmentRefreshIntervalSeconds =
             data.environmentRefreshIntervalSeconds || this.environmentRefreshIntervalSeconds;
@@ -154,7 +155,7 @@ var Flagsmith = /** @class */ (function () {
             ? new analytics_1.AnalyticsProcessor({
                 environmentKey: this.environmentKey,
                 baseApiUrl: this.apiUrl,
-                timeout: this.requestTimeoutSeconds
+                requestTimeoutMs: this.requestTimeoutMs
             })
             : undefined;
     }
@@ -339,10 +340,10 @@ var Flagsmith = /** @class */ (function () {
                         }
                         return [4 /*yield*/, (0, utils_1.retryFetch)(url, {
                                 method: method,
-                                timeout: this.requestTimeoutSeconds || undefined,
+                                timeout: this.requestTimeoutMs || undefined,
                                 body: JSON.stringify(body),
                                 headers: headers
-                            }, this.retries, (this.requestTimeoutSeconds || 10) * 1000)];
+                            }, this.retries)];
                     case 1:
                         data = _e.sent();
                         if (data.status !== 200) {

package/build/sdk/utils.d.ts

@@ -9,4 +9,4 @@ export declare function generateIdentitiesData(identifier: string, traits: {
     }[];
 };
 export declare const delay: (ms: number) => Promise<unknown>;
-export declare const retryFetch: (url: string, fetchOptions: any, retries: number | undefined, timeout: number) => Promise<Response>;
+export declare const retryFetch: (url: string, fetchOptions: any, retries?: number, timeout?: number | undefined) => Promise<Response>;

package/build/sdk/utils.js

@@ -59,7 +59,8 @@ var delay = function (ms) {
     return new Promise(function (resolve) { return setTimeout(function () { return resolve(undefined); }, ms); });
 };
 exports.delay = delay;
-var retryFetch = function (url, fetchOptions, retries, timeout) {
+var retryFetch = function (url, fetchOptions, retries, timeout // set an overall timeout for this function
+) {
     if (retries === void 0) { retries = 3; }
     return new Promise(function (resolve, reject) {
         // check for timeout

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "Flagsmith lets you manage features flags and remote config across web, mobile and server side applications. Deliver true Continuous Integration. Get builds out faster. Control who has access to new features.",
   "main": "build/index.js",
   "repository": {

package/sdk/analytics.ts

@@ -10,22 +10,22 @@ export class AnalyticsProcessor {
     private environmentKey: string;
     private lastFlushed: number;
     analyticsData: { [key: string]: any };
-    private timeout: number = 3;
+    private requestTimeoutMs: number = 3000;
     /**
      * AnalyticsProcessor is used to track how often individual Flags are evaluated within 
      * the Flagsmith SDK. Docs: https://docs.flagsmith.com/advanced-use/flag-analytics.
      * 
      * @param data.environmentKey environment key obtained from the Flagsmith UI
      * @param data.baseApiUrl base api url to override when using self hosted version
-     * @param data.timeout used to tell requests to stop waiting for a response after a
-            given number of seconds
+     * @param data.requestTimeoutMs used to tell requests to stop waiting for a response after a
+            given number of milliseconds
      */
-    constructor(data: { environmentKey: string; baseApiUrl: string; timeout?: number }) {
+    constructor(data: { environmentKey: string; baseApiUrl: string; requestTimeoutMs?: number }) {
         this.analyticsEndpoint = data.baseApiUrl + ANALYTICS_ENDPOINT;
         this.environmentKey = data.environmentKey;
         this.lastFlushed = Date.now();
         this.analyticsData = {};
-        this.timeout = data.timeout || this.timeout;
+        this.requestTimeoutMs = data.requestTimeoutMs || this.requestTimeoutMs;
     }
     /**
      * Sends all the collected data to the api asynchronously and resets the timer
@@ -38,7 +38,7 @@ export class AnalyticsProcessor {
         await fetch(this.analyticsEndpoint, {
             method: 'POST',
             body: JSON.stringify(this.analyticsData),
-            timeout: this.timeout,
+            timeout: this.requestTimeoutMs,
             headers: {
                 'Content-Type': 'application/json',
                 'X-Environment-Key': this.environmentKey

package/sdk/index.ts

@@ -28,6 +28,7 @@ export class Flagsmith {
     apiUrl: string = DEFAULT_API_URL;
     customHeaders?: { [key: string]: any };
     requestTimeoutSeconds?: number;
+    requestTimeoutMs?: number;
     enableLocalEvaluation?: boolean = false;
     environmentRefreshIntervalSeconds: number = 60;
     retries?: number;
@@ -92,6 +93,7 @@ export class Flagsmith {
         this.apiUrl = data.apiUrl || this.apiUrl;
         this.customHeaders = data.customHeaders;
         this.requestTimeoutSeconds = data.requestTimeoutSeconds;
+        this.requestTimeoutMs = data.requestTimeoutSeconds ? data.requestTimeoutSeconds * 1000 : undefined;
         this.enableLocalEvaluation = data.enableLocalEvaluation;
         this.environmentRefreshIntervalSeconds =
             data.environmentRefreshIntervalSeconds || this.environmentRefreshIntervalSeconds;
@@ -135,7 +137,7 @@ export class Flagsmith {
             ? new AnalyticsProcessor({
                 environmentKey: this.environmentKey,
                 baseApiUrl: this.apiUrl,
-                timeout: this.requestTimeoutSeconds
+                requestTimeoutMs: this.requestTimeoutMs
             })
             : undefined;
     }
@@ -271,12 +273,11 @@ export class Flagsmith {
             url,
             {
                 method: method,
-                timeout: this.requestTimeoutSeconds || undefined,
+                timeout: this.requestTimeoutMs || undefined,
                 body: JSON.stringify(body),
                 headers: headers
             },
-            this.retries,
-            (this.requestTimeoutSeconds || 10) * 1000
+            this.retries
         );
 
         if (data.status !== 200) {

package/sdk/utils.ts

@@ -20,7 +20,7 @@ export const retryFetch = (
     url: string,
     fetchOptions: any,
     retries = 3,
-    timeout: number
+    timeout?: number // set an overall timeout for this function
 ): Promise<Response> => {
     return new Promise((resolve, reject) => {
         // check for timeout

package/tests/sdk/analytics.test.ts

@@ -32,7 +32,7 @@ test('test_analytics_processor_flush_post_request_data_match_ananlytics_data', a
         body: '{"myFeature1":1,"myFeature2":1}',
         headers: { 'Content-Type': 'application/json', 'X-Environment-Key': 'test-key' },
         method: 'POST',
-        timeout: 3
+        timeout: 3000
     });
 });