flagsmith-nodejs 2.4.1 → 2.5.1

package/build/flagsmith-engine/segments/constants.d.ts

@@ -15,6 +15,7 @@ export declare const PERCENTAGE_SPLIT = "PERCENTAGE_SPLIT";
 export declare const IS_SET = "IS_SET";
 export declare const IS_NOT_SET = "IS_NOT_SET";
 export declare const MODULO = "MODULO";
+export declare const IN = "IN";
 export declare const CONDITION_OPERATORS: {
     EQUAL: string;
     GREATER_THAN: string;
@@ -29,4 +30,5 @@ export declare const CONDITION_OPERATORS: {
     IS_SET: string;
     IS_NOT_SET: string;
     MODULO: string;
+    IN: string;
 };

package/build/flagsmith-engine/segments/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CONDITION_OPERATORS = exports.MODULO = exports.IS_NOT_SET = exports.IS_SET = exports.PERCENTAGE_SPLIT = exports.REGEX = exports.NOT_EQUAL = exports.NOT_CONTAINS = exports.GREATER_THAN_INCLUSIVE = exports.CONTAINS = exports.LESS_THAN_INCLUSIVE = exports.LESS_THAN = exports.GREATER_THAN = exports.EQUAL = exports.RULE_TYPES = exports.NONE_RULE = exports.ANY_RULE = exports.ALL_RULE = void 0;
+exports.CONDITION_OPERATORS = exports.IN = exports.MODULO = exports.IS_NOT_SET = exports.IS_SET = exports.PERCENTAGE_SPLIT = exports.REGEX = exports.NOT_EQUAL = exports.NOT_CONTAINS = exports.GREATER_THAN_INCLUSIVE = exports.CONTAINS = exports.LESS_THAN_INCLUSIVE = exports.LESS_THAN = exports.GREATER_THAN = exports.EQUAL = exports.RULE_TYPES = exports.NONE_RULE = exports.ANY_RULE = exports.ALL_RULE = void 0;
 // Segment Rules
 exports.ALL_RULE = 'ALL';
 exports.ANY_RULE = 'ANY';
@@ -20,6 +20,7 @@ exports.PERCENTAGE_SPLIT = 'PERCENTAGE_SPLIT';
 exports.IS_SET = 'IS_SET';
 exports.IS_NOT_SET = 'IS_NOT_SET';
 exports.MODULO = 'MODULO';
+exports.IN = 'IN';
 exports.CONDITION_OPERATORS = {
     EQUAL: exports.EQUAL,
     GREATER_THAN: exports.GREATER_THAN,
@@ -33,5 +34,6 @@ exports.CONDITION_OPERATORS = {
     PERCENTAGE_SPLIT: exports.PERCENTAGE_SPLIT,
     IS_SET: exports.IS_SET,
     IS_NOT_SET: exports.IS_NOT_SET,
-    MODULO: exports.MODULO
+    MODULO: exports.MODULO,
+    IN: exports.IN
 };

package/build/flagsmith-engine/segments/models.js

@@ -69,6 +69,7 @@ var SegmentConditionModel = /** @class */ (function () {
             _a[constants_1.NOT_CONTAINS] = 'evaluateNotContains',
             _a[constants_1.REGEX] = 'evaluateRegex',
             _a[constants_1.MODULO] = 'evaluateModulo',
+            _a[constants_1.IN] = 'evaluateIn',
             _a);
         this.operator = operator;
         this.value = value;
@@ -90,7 +91,11 @@ var SegmentConditionModel = /** @class */ (function () {
                 var parts = (_this.value).split("|");
                 var _a = __read([parseFloat(parts[0]), parseFloat(parts[1])], 2), divisor = _a[0], reminder = _a[1];
                 return traitValue % divisor === reminder;
-            }
+            },
+            evaluateIn: function (traitValue) {
+                var _a;
+                return (_a = _this.value) === null || _a === void 0 ? void 0 : _a.split(',').includes(traitValue.toString());
+            },
         };
         // TODO: move this logic to the evaluator module
         if (this.EXCEPTION_OPERATOR_METHODS[this.operator]) {

package/build/sdk/analytics.d.ts

@@ -1,3 +1,4 @@
+import { Logger } from 'pino';
 export declare class AnalyticsProcessor {
     private analyticsEndpoint;
     private environmentKey;
@@ -6,6 +7,7 @@ export declare class AnalyticsProcessor {
         [key: string]: any;
     };
     private requestTimeoutMs;
+    private logger;
     /**
      * AnalyticsProcessor is used to track how often individual Flags are evaluated within
      * the Flagsmith SDK. Docs: https://docs.flagsmith.com/advanced-use/flag-analytics.
@@ -19,6 +21,7 @@ export declare class AnalyticsProcessor {
         environmentKey: string;
         baseApiUrl: string;
         requestTimeoutMs?: number;
+        logger?: Logger;
     });
     /**
      * Sends all the collected data to the api asynchronously and resets the timer

package/build/sdk/analytics.js

@@ -41,6 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AnalyticsProcessor = void 0;
 var node_fetch_1 = __importDefault(require("node-fetch"));
+var pino_1 = __importDefault(require("pino"));
 var ANALYTICS_ENDPOINT = 'analytics/flags/';
 // Used to control how often we send data(in seconds)
 var ANALYTICS_TIMER = 10;
@@ -61,18 +62,23 @@ var AnalyticsProcessor = /** @class */ (function () {
         this.lastFlushed = Date.now();
         this.analyticsData = {};
         this.requestTimeoutMs = data.requestTimeoutMs || this.requestTimeoutMs;
+        this.logger = data.logger || (0, pino_1.default)();
     }
     /**
      * Sends all the collected data to the api asynchronously and resets the timer
      */
     AnalyticsProcessor.prototype.flush = function () {
         return __awaiter(this, void 0, void 0, function () {
+            var error_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (!Object.keys(this.analyticsData).length) {
                             return [2 /*return*/];
                         }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
                         return [4 /*yield*/, (0, node_fetch_1.default)(this.analyticsEndpoint, {
                                 method: 'POST',
                                 body: JSON.stringify(this.analyticsData),
@@ -82,8 +88,16 @@ var AnalyticsProcessor = /** @class */ (function () {
                                     'X-Environment-Key': this.environmentKey
                                 }
                             })];
-                    case 1:
+                    case 2:
                         _a.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        error_1 = _a.sent();
+                        // We don't want failing to write analytics to cause any exceptions in the main
+                        // thread so we just swallow them here.
+                        this.logger.warn('Failed to post analytics to Flagsmith API. Not clearing data, will retry.');
+                        return [2 /*return*/];
+                    case 4:
                         this.analyticsData = {};
                         this.lastFlushed = Date.now();
                         return [2 /*return*/];

package/build/sdk/index.d.ts

@@ -31,6 +31,7 @@ export declare class Flagsmith {
     private cache?;
     private onEnvironmentChange?;
     private analyticsProcessor?;
+    private logger;
     /**
      * A Flagsmith client.
      *
@@ -60,6 +61,7 @@ export declare class Flagsmith {
         @param data.defaultFlagHandler: callable which will be used in the case where
             flags cannot be retrieved from the API or a non existent feature is
             requested
+        @param data.logger: an instance of the pino Logger class to use for logging
      */
     constructor(data: FlagsmithConfig);
     /**

package/build/sdk/index.js

@@ -62,6 +62,9 @@ var __read = (this && this.__read) || function (o, n) {
     }
     return ar;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Flagsmith = exports.EnvironmentDataPollingManager = exports.Flags = exports.DefaultFlag = exports.FlagsmithClientError = exports.FlagsmithAPIError = exports.AnalyticsProcessor = void 0;
 var flagsmith_engine_1 = require("../flagsmith-engine");
@@ -74,6 +77,7 @@ var models_3 = require("./models");
 var polling_manager_1 = require("./polling_manager");
 var utils_1 = require("./utils");
 var evaluators_1 = require("../flagsmith-engine/segments/evaluators");
+var pino_1 = __importDefault(require("pino"));
 var analytics_2 = require("./analytics");
 Object.defineProperty(exports, "AnalyticsProcessor", { enumerable: true, get: function () { return analytics_2.AnalyticsProcessor; } });
 var errors_2 = require("./errors");
@@ -115,6 +119,7 @@ var Flagsmith = /** @class */ (function () {
         @param data.defaultFlagHandler: callable which will be used in the case where
             flags cannot be retrieved from the API or a non existent feature is
             requested
+        @param data.logger: an instance of the pino Logger class to use for logging
      */
     function Flagsmith(data) {
         this.apiUrl = DEFAULT_API_URL;
@@ -137,6 +142,7 @@ var Flagsmith = /** @class */ (function () {
         this.identitiesUrl = "".concat(this.apiUrl, "identities/");
         this.environmentUrl = "".concat(this.apiUrl, "environment-document/");
         this.onEnvironmentChange = data.onEnvironmentChange;
+        this.logger = data.logger || (0, pino_1.default)();
         if (!!data.cache) {
             var missingMethods = ['has', 'get', 'set'].filter(function (method) { return data.cache && !data.cache[method]; });
             if (missingMethods.length > 0) {
@@ -156,7 +162,8 @@ var Flagsmith = /** @class */ (function () {
             ? new analytics_1.AnalyticsProcessor({
                 environmentKey: this.environmentKey,
                 baseApiUrl: this.apiUrl,
-                requestTimeoutMs: this.requestTimeoutMs
+                requestTimeoutMs: this.requestTimeoutMs,
+                logger: this.logger
             })
             : undefined;
     }
@@ -216,6 +223,9 @@ var Flagsmith = /** @class */ (function () {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
+                        if (!identifier) {
+                            throw new Error("`identifier` argument is missing or invalid.");
+                        }
                         _a = !!this.cache;
                         if (!_a) return [3 /*break*/, 2];
                         return [4 /*yield*/, this.cache.get("flags-".concat(identifier))];
@@ -253,6 +263,9 @@ var Flagsmith = /** @class */ (function () {
      */
     Flagsmith.prototype.getIdentitySegments = function (identifier, traits) {
         var _this = this;
+        if (!identifier) {
+            throw new Error("`identifier` argument is missing or invalid.");
+        }
         traits = traits || {};
         if (this.enableLocalEvaluation) {
             return new Promise(function (resolve, reject) {
@@ -416,7 +429,7 @@ var Flagsmith = /** @class */ (function () {
                             featureStates: featureStates,
                             analyticsProcessor: this.analyticsProcessor,
                             defaultFlagHandler: this.defaultFlagHandler,
-                            identityID: identityModel.djangoID || identityModel.identityUuid
+                            identityID: identityModel.djangoID || identityModel.compositeKey
                         });
                         if (!!!this.cache) return [3 /*break*/, 2];
                         // @ts-ignore node-cache types are incorrect, ttl should be optional

package/build/sdk/types.d.ts

@@ -1,6 +1,7 @@
 import { DefaultFlag, Flags } from "./models";
 import { EnvironmentModel } from "../flagsmith-engine";
 import { RequestInit } from "node-fetch";
+import { Logger } from "pino";
 export interface FlagsmithCache {
     get(key: string): Promise<Flags | undefined> | undefined;
     set(key: string, value: Flags, ttl: string | number): boolean | Promise<boolean>;
@@ -22,4 +23,5 @@ export interface FlagsmithConfig {
     defaultFlagHandler?: (featureName: string) => DefaultFlag;
     cache?: FlagsmithCache;
     onEnvironmentChange?: (error: Error | null, result: EnvironmentModel) => void;
+    logger?: Logger;
 }

package/examples/api-proxy/package-lock.json

@@ -1783,9 +1783,9 @@
       }
     },
     "node_modules/decode-uri-component": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
-      "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz",
+      "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==",
       "dev": true,
       "optional": true,
       "engines": {
@@ -3923,13 +3923,10 @@
       "dev": true
     },
     "node_modules/json5": {
-      "version": "2.1.0",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-2.1.0.tgz",
-      "integrity": "sha512-8Mh9h6xViijj36g7Dxi+Y4S6hNGV96vcJZr/SrlHh1LR/pEn/8j/+qIBbs44YKl69Lrfctp4QD+AdWLTMqEZAQ==",
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
+      "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
       "dev": true,
-      "dependencies": {
-        "minimist": "^1.2.0"
-      },
       "bin": {
         "json5": "lib/cli.js"
       },
@@ -4114,9 +4111,9 @@
       }
     },
     "node_modules/minimatch": {
-      "version": "3.0.4",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
-      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
       "dev": true,
       "dependencies": {
         "brace-expansion": "^1.1.7"
@@ -7515,9 +7512,9 @@
       }
     },
     "decode-uri-component": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
-      "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz",
+      "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==",
       "dev": true,
       "optional": true
     },
@@ -9208,13 +9205,10 @@
       "dev": true
     },
     "json5": {
-      "version": "2.1.0",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-2.1.0.tgz",
-      "integrity": "sha512-8Mh9h6xViijj36g7Dxi+Y4S6hNGV96vcJZr/SrlHh1LR/pEn/8j/+qIBbs44YKl69Lrfctp4QD+AdWLTMqEZAQ==",
-      "dev": true,
-      "requires": {
-        "minimist": "^1.2.0"
-      }
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
+      "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
+      "dev": true
     },
     "kind-of": {
       "version": "6.0.3",
@@ -9351,9 +9345,9 @@
       "dev": true
     },
     "minimatch": {
-      "version": "3.0.4",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
-      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
       "dev": true,
       "requires": {
         "brace-expansion": "^1.1.7"

package/examples/basic/package-lock.json

@@ -1750,9 +1750,9 @@
       }
     },
     "node_modules/decode-uri-component": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
-      "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz",
+      "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==",
       "dev": true,
       "optional": true,
       "engines": {
@@ -3857,13 +3857,10 @@
       "dev": true
     },
     "node_modules/json5": {
-      "version": "2.1.0",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-2.1.0.tgz",
-      "integrity": "sha512-8Mh9h6xViijj36g7Dxi+Y4S6hNGV96vcJZr/SrlHh1LR/pEn/8j/+qIBbs44YKl69Lrfctp4QD+AdWLTMqEZAQ==",
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
+      "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
       "dev": true,
-      "dependencies": {
-        "minimist": "^1.2.0"
-      },
       "bin": {
         "json5": "lib/cli.js"
       },
@@ -4048,9 +4045,9 @@
       }
     },
     "node_modules/minimatch": {
-      "version": "3.0.4",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
-      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
       "dev": true,
       "dependencies": {
         "brace-expansion": "^1.1.7"
@@ -4060,10 +4057,13 @@
       }
     },
     "node_modules/minimist": {
-      "version": "1.2.6",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
-      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
-      "dev": true
+      "version": "1.2.7",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.7.tgz",
+      "integrity": "sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g==",
+      "dev": true,
+      "funding": {
+        "url": "https://github.com/sponsors/ljharb"
+      }
     },
     "node_modules/mixin-deep": {
       "version": "1.3.2",
@@ -7426,9 +7426,9 @@
       }
     },
     "decode-uri-component": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
-      "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz",
+      "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==",
       "dev": true,
       "optional": true
     },
@@ -9095,13 +9095,10 @@
       "dev": true
     },
     "json5": {
-      "version": "2.1.0",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-2.1.0.tgz",
-      "integrity": "sha512-8Mh9h6xViijj36g7Dxi+Y4S6hNGV96vcJZr/SrlHh1LR/pEn/8j/+qIBbs44YKl69Lrfctp4QD+AdWLTMqEZAQ==",
-      "dev": true,
-      "requires": {
-        "minimist": "^1.2.0"
-      }
+      "version": "2.2.3",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
+      "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==",
+      "dev": true
     },
     "kind-of": {
       "version": "6.0.3",
@@ -9238,18 +9235,18 @@
       "dev": true
     },
     "minimatch": {
-      "version": "3.0.4",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
-      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
       "dev": true,
       "requires": {
         "brace-expansion": "^1.1.7"
       }
     },
     "minimist": {
-      "version": "1.2.6",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
-      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
+      "version": "1.2.7",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.7.tgz",
+      "integrity": "sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g==",
       "dev": true
     },
     "mixin-deep": {