flagsmith-nodejs 2.1.2 → 2.2.2-beta.1

package/build/index.d.ts

@@ -1,2 +1,2 @@
-export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags } from './sdk';
+export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags, default } from './sdk';
 export { EnvironmentModel, IntegrationModel, FeatureStateModel, IdentityModel, TraitModel, SegmentModel, OrganisationModel } from './flagsmith-engine';

package/build/index.js

@@ -3,15 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.IntegrationModel = exports.EnvironmentModel = exports.Flags = exports.DefaultFlag = exports.EnvironmentDataPollingManager = exports.FlagsmithClientError = exports.FlagsmithAPIError = exports.AnalyticsProcessor = void 0;
-var sdk_1 = __importDefault(require("./sdk"));
-var sdk_2 = require("./sdk");
-Object.defineProperty(exports, "AnalyticsProcessor", { enumerable: true, get: function () { return sdk_2.AnalyticsProcessor; } });
-Object.defineProperty(exports, "FlagsmithAPIError", { enumerable: true, get: function () { return sdk_2.FlagsmithAPIError; } });
-Object.defineProperty(exports, "FlagsmithClientError", { enumerable: true, get: function () { return sdk_2.FlagsmithClientError; } });
-Object.defineProperty(exports, "EnvironmentDataPollingManager", { enumerable: true, get: function () { return sdk_2.EnvironmentDataPollingManager; } });
-Object.defineProperty(exports, "DefaultFlag", { enumerable: true, get: function () { return sdk_2.DefaultFlag; } });
-Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return sdk_2.Flags; } });
+exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.IntegrationModel = exports.EnvironmentModel = exports.default = exports.Flags = exports.DefaultFlag = exports.EnvironmentDataPollingManager = exports.FlagsmithClientError = exports.FlagsmithAPIError = exports.AnalyticsProcessor = void 0;
+var sdk_1 = require("./sdk");
+Object.defineProperty(exports, "AnalyticsProcessor", { enumerable: true, get: function () { return sdk_1.AnalyticsProcessor; } });
+Object.defineProperty(exports, "FlagsmithAPIError", { enumerable: true, get: function () { return sdk_1.FlagsmithAPIError; } });
+Object.defineProperty(exports, "FlagsmithClientError", { enumerable: true, get: function () { return sdk_1.FlagsmithClientError; } });
+Object.defineProperty(exports, "EnvironmentDataPollingManager", { enumerable: true, get: function () { return sdk_1.EnvironmentDataPollingManager; } });
+Object.defineProperty(exports, "DefaultFlag", { enumerable: true, get: function () { return sdk_1.DefaultFlag; } });
+Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return sdk_1.Flags; } });
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(sdk_1).default; } });
 var flagsmith_engine_1 = require("./flagsmith-engine");
 Object.defineProperty(exports, "EnvironmentModel", { enumerable: true, get: function () { return flagsmith_engine_1.EnvironmentModel; } });
 Object.defineProperty(exports, "IntegrationModel", { enumerable: true, get: function () { return flagsmith_engine_1.IntegrationModel; } });
@@ -20,4 +20,3 @@ Object.defineProperty(exports, "IdentityModel", { enumerable: true, get: functio
 Object.defineProperty(exports, "TraitModel", { enumerable: true, get: function () { return flagsmith_engine_1.TraitModel; } });
 Object.defineProperty(exports, "SegmentModel", { enumerable: true, get: function () { return flagsmith_engine_1.SegmentModel; } });
 Object.defineProperty(exports, "OrganisationModel", { enumerable: true, get: function () { return flagsmith_engine_1.OrganisationModel; } });
-module.exports = sdk_1.default;

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;
@@ -113,6 +114,7 @@ export declare class Flagsmith {
      * You only need to call this if you wish to bypass environmentRefreshIntervalSeconds.
      */
     updateEnvironment(): Promise<void>;
+    close(): Promise<void>;
     private getJSONResponse;
     /**
      * This promise ensures that the environment is retrieved before attempting to locally evaluate.

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;
     }
@@ -182,10 +183,10 @@ var Flagsmith = /** @class */ (function () {
                             return [2 /*return*/, cachedItem];
                         }
                         if (this.enableLocalEvaluation) {
-                            return [2 /*return*/, new Promise(function (resolve) {
+                            return [2 /*return*/, new Promise(function (resolve, reject) {
                                     return _this.environmentPromise.then(function () {
                                         resolve(_this.getEnvironmentFlagsFromDocument());
-                                    });
+                                    }).catch(function (e) { return reject(e); });
                                 })];
                         }
                         if (this.environment) {
@@ -227,10 +228,10 @@ var Flagsmith = /** @class */ (function () {
                         }
                         traits = traits || {};
                         if (this.enableLocalEvaluation) {
-                            return [2 /*return*/, new Promise(function (resolve) {
+                            return [2 /*return*/, new Promise(function (resolve, reject) {
                                     return _this.environmentPromise.then(function () {
                                         resolve(_this.getIdentityFlagsFromDocument(identifier, traits || {}));
-                                    });
+                                    }).catch(function (e) { return reject(e); });
                                 })];
                         }
                         return [2 /*return*/, this.getIdentityFlagsFromApi(identifier, traits)];
@@ -253,15 +254,15 @@ var Flagsmith = /** @class */ (function () {
         var _this = this;
         traits = traits || {};
         if (this.enableLocalEvaluation) {
-            return this.environmentPromise.then(function () {
-                return new Promise(function (resolve) {
+            return new Promise(function (resolve, reject) {
+                return _this.environmentPromise.then(function () {
                     var identityModel = _this.buildIdentityModel(identifier, Object.keys(traits || {}).map(function (key) { return ({
                         key: key,
                         value: traits === null || traits === void 0 ? void 0 : traits[key]
                     }); }));
                     var segments = (0, evaluators_1.getIdentitySegments)(_this.environment, identityModel);
                     return resolve(segments);
-                });
+                }).catch(function (e) { return reject(e); });
             });
         }
         console.error('This function is only permitted with local evaluation.');
@@ -311,6 +312,15 @@ var Flagsmith = /** @class */ (function () {
             });
         });
     };
+    Flagsmith.prototype.close = function () {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_b) {
+                (_a = this.environmentDataPollingManager) === null || _a === void 0 ? void 0 : _a.stop();
+                return [2 /*return*/];
+            });
+        });
+    };
     Flagsmith.prototype.getJSONResponse = function (url, method, body) {
         return __awaiter(this, void 0, void 0, function () {
             var headers, _a, _b, _c, k, v, data;
@@ -339,10 +349,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/index.ts

@@ -1,5 +1,3 @@
-import Flagsmith from './sdk';
-
 export {
   AnalyticsProcessor,
   FlagsmithAPIError,
@@ -7,7 +5,8 @@ export {
   EnvironmentDataPollingManager,
   FlagsmithCache,
   DefaultFlag,
-  Flags
+  Flags,
+  default
 } from './sdk';
 
 export {
@@ -19,5 +18,3 @@ export {
   SegmentModel,
   OrganisationModel
 } from './flagsmith-engine';
-
-module.exports = Flagsmith;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "2.1.2",
+  "version": "2.2.2-beta.1",
   "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;
     }
@@ -150,10 +152,10 @@ export class Flagsmith {
             return cachedItem;
         }
         if (this.enableLocalEvaluation) {
-            return new Promise(resolve =>
+            return new Promise((resolve, reject) =>
                 this.environmentPromise!.then(() => {
                     resolve(this.getEnvironmentFlagsFromDocument());
-                })
+                }).catch((e) => reject(e))
             );
         }
         if (this.environment) {
@@ -180,10 +182,10 @@ export class Flagsmith {
         }
         traits = traits || {};
         if (this.enableLocalEvaluation) {
-            return new Promise(resolve =>
+            return new Promise((resolve, reject) =>
                 this.environmentPromise!.then(() => {
                     resolve(this.getIdentityFlagsFromDocument(identifier, traits || {}));
-                })
+                }).catch(e => reject(e))
             );
         }
         return this.getIdentityFlagsFromApi(identifier, traits);
@@ -206,8 +208,8 @@ export class Flagsmith {
     ): Promise<SegmentModel[]> {
         traits = traits || {};
         if (this.enableLocalEvaluation) {
-            return this.environmentPromise!.then(() => {
-                return new Promise(resolve => {
+            return new Promise((resolve, reject) => {
+                return this.environmentPromise!.then(() => {
                     const identityModel = this.buildIdentityModel(
                         identifier,
                         Object.keys(traits || {}).map(key => ({
@@ -218,7 +220,7 @@ export class Flagsmith {
 
                     const segments = getIdentitySegments(this.environment, identityModel);
                     return resolve(segments);
-                });
+                }).catch((e) => reject(e));
             });
         }
         console.error('This function is only permitted with local evaluation.');
@@ -251,6 +253,10 @@ export class Flagsmith {
         }
     }
 
+    async close() {
+        this.environmentDataPollingManager?.stop();
+    }
+
     private async getJSONResponse(
         url: string,
         method: string,
@@ -271,12 +277,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
     });
 });