flagsmith-nodejs 3.0.0 → 3.1.0

package/build/sdk/models.js

@@ -0,0 +1,149 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Flags = exports.Flag = exports.DefaultFlag = exports.BaseFlag = void 0;
+var BaseFlag = /** @class */ (function () {
+    function BaseFlag(value, enabled, isDefault) {
+        this.value = value;
+        this.enabled = enabled;
+        this.isDefault = isDefault;
+    }
+    return BaseFlag;
+}());
+exports.BaseFlag = BaseFlag;
+var DefaultFlag = /** @class */ (function (_super) {
+    __extends(DefaultFlag, _super);
+    function DefaultFlag(value, enabled) {
+        return _super.call(this, value, enabled, true) || this;
+    }
+    return DefaultFlag;
+}(BaseFlag));
+exports.DefaultFlag = DefaultFlag;
+var Flag = /** @class */ (function (_super) {
+    __extends(Flag, _super);
+    function Flag(params) {
+        var _this = _super.call(this, params.value, params.enabled, !!params.isDefault) || this;
+        _this.featureId = params.featureId;
+        _this.featureName = params.featureName;
+        return _this;
+    }
+    Flag.fromFeatureStateModel = function (fsm, identityId) {
+        return new Flag({
+            value: fsm.getValue(identityId),
+            enabled: fsm.enabled,
+            featureId: fsm.feature.id,
+            featureName: fsm.feature.name
+        });
+    };
+    Flag.fromAPIFlag = function (flagData) {
+        return new Flag({
+            enabled: flagData['enabled'],
+            value: flagData['feature_state_value'] || flagData['value'],
+            featureId: flagData['feature']['id'],
+            featureName: flagData['feature']['name']
+        });
+    };
+    return Flag;
+}(BaseFlag));
+exports.Flag = Flag;
+var Flags = /** @class */ (function () {
+    function Flags(data) {
+        this.flags = {};
+        this.flags = data.flags;
+        this.defaultFlagHandler = data.defaultFlagHandler;
+        this.analyticsProcessor = data.analyticsProcessor;
+    }
+    Flags.fromFeatureStateModels = function (data) {
+        var e_1, _a;
+        var flags = {};
+        try {
+            for (var _b = __values(data.featureStates), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var fs = _c.value;
+                flags[fs.feature.name] = Flag.fromFeatureStateModel(fs, data.identityID);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return new Flags({
+            flags: flags,
+            defaultFlagHandler: data.defaultFlagHandler,
+            analyticsProcessor: data.analyticsProcessor
+        });
+    };
+    Flags.fromAPIFlags = function (data) {
+        var e_2, _a;
+        var flags = {};
+        try {
+            for (var _b = __values(data.apiFlags), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var flagData = _c.value;
+                flags[flagData['feature']['name']] = Flag.fromAPIFlag(flagData);
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+        return new Flags({
+            flags: flags,
+            defaultFlagHandler: data.defaultFlagHandler,
+            analyticsProcessor: data.analyticsProcessor
+        });
+    };
+    Flags.prototype.allFlags = function () {
+        return Object.values(this.flags);
+    };
+    Flags.prototype.getFlag = function (featureName) {
+        var flag = this.flags[featureName];
+        if (!flag) {
+            if (this.defaultFlagHandler) {
+                return this.defaultFlagHandler(featureName);
+            }
+            return { enabled: false, isDefault: true, value: undefined };
+        }
+        if (this.analyticsProcessor && flag.featureId) {
+            this.analyticsProcessor.trackFeature(flag.featureName);
+        }
+        return flag;
+    };
+    Flags.prototype.getFeatureValue = function (featureName) {
+        return this.getFlag(featureName).value;
+    };
+    Flags.prototype.isFeatureEnabled = function (featureName) {
+        return this.getFlag(featureName).enabled;
+    };
+    return Flags;
+}());
+exports.Flags = Flags;

package/build/sdk/polling_manager.d.ts

@@ -0,0 +1,9 @@
+import Flagsmith from '.';
+export declare class EnvironmentDataPollingManager {
+    private interval?;
+    private main;
+    private refreshIntervalSeconds;
+    constructor(main: Flagsmith, refreshIntervalSeconds: number);
+    start(): void;
+    stop(): void;
+}

package/build/sdk/polling_manager.js

@@ -0,0 +1,72 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentDataPollingManager = void 0;
+var EnvironmentDataPollingManager = /** @class */ (function () {
+    function EnvironmentDataPollingManager(main, refreshIntervalSeconds) {
+        this.main = main;
+        this.refreshIntervalSeconds = refreshIntervalSeconds;
+    }
+    EnvironmentDataPollingManager.prototype.start = function () {
+        var _this = this;
+        var updateEnvironment = function () {
+            if (_this.interval)
+                clearInterval(_this.interval);
+            _this.interval = setInterval(function () { return __awaiter(_this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, this.main.updateEnvironment()];
+                        case 1:
+                            _a.sent();
+                            return [2 /*return*/];
+                    }
+                });
+            }); }, _this.refreshIntervalSeconds * 1000);
+        };
+        this.main.updateEnvironment();
+        updateEnvironment();
+    };
+    EnvironmentDataPollingManager.prototype.stop = function () {
+        if (!this.interval) {
+            return;
+        }
+        clearInterval(this.interval);
+    };
+    return EnvironmentDataPollingManager;
+}());
+exports.EnvironmentDataPollingManager = EnvironmentDataPollingManager;

package/build/sdk/types.d.ts

@@ -0,0 +1,27 @@
+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>;
+    has(key: string): boolean | Promise<boolean>;
+    [key: string]: any;
+}
+export interface FlagsmithConfig {
+    environmentKey: string;
+    apiUrl?: string;
+    agent?: RequestInit['agent'];
+    customHeaders?: {
+        [key: string]: any;
+    };
+    requestTimeoutSeconds?: number;
+    enableLocalEvaluation?: boolean;
+    environmentRefreshIntervalSeconds?: number;
+    retries?: number;
+    enableAnalytics?: boolean;
+    defaultFlagHandler?: (featureName: string) => DefaultFlag;
+    cache?: FlagsmithCache;
+    onEnvironmentChange?: (error: Error | null, result: EnvironmentModel) => void;
+    logger?: Logger;
+}

package/build/sdk/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/sdk/utils.d.ts

@@ -0,0 +1,12 @@
+import { RequestInit, Response } from 'node-fetch';
+export declare function generateIdentitiesData(identifier: string, traits: {
+    [key: string]: any;
+}): {
+    identifier: string;
+    traits: {
+        trait_key: string;
+        trait_value: any;
+    }[];
+};
+export declare const delay: (ms: number) => Promise<unknown>;
+export declare const retryFetch: (url: string, fetchOptions: RequestInit, retries?: number, timeout?: number) => Promise<Response>;

package/build/sdk/utils.js

@@ -0,0 +1,100 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retryFetch = exports.delay = exports.generateIdentitiesData = void 0;
+var node_fetch_1 = __importDefault(require("node-fetch"));
+// @ts-ignore
+if (typeof node_fetch_1.default.default !== 'undefined')
+    node_fetch_1.default = node_fetch_1.default.default;
+function generateIdentitiesData(identifier, traits) {
+    var traitsGenerated = Object.entries(traits).map(function (trait) { return ({
+        trait_key: trait[0],
+        trait_value: trait[1]
+    }); });
+    return {
+        identifier: identifier,
+        traits: traitsGenerated
+    };
+}
+exports.generateIdentitiesData = generateIdentitiesData;
+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 // set an overall timeout for this function
+) {
+    if (retries === void 0) { retries = 3; }
+    if (timeout === void 0) { timeout = 10; }
+    return new Promise(function (resolve, reject) {
+        var retryWrapper = function (n) {
+            requestWrapper()
+                .then(function (res) { return resolve(res); })
+                .catch(function (err) { return __awaiter(void 0, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            if (!(n > 0)) return [3 /*break*/, 2];
+                            return [4 /*yield*/, (0, exports.delay)(1000)];
+                        case 1:
+                            _a.sent();
+                            retryWrapper(--n);
+                            return [3 /*break*/, 3];
+                        case 2:
+                            reject(err);
+                            _a.label = 3;
+                        case 3: return [2 /*return*/];
+                    }
+                });
+            }); });
+        };
+        var requestWrapper = function () {
+            return new Promise(function (resolve, reject) {
+                if (timeout)
+                    setTimeout(function () { return reject('error: timeout'); }, timeout);
+                return (0, node_fetch_1.default)(url, fetchOptions)
+                    .then(function (res) { return resolve(res); })
+                    .catch(function (err) { return reject(err); });
+            });
+        };
+        retryWrapper(retries);
+    });
+};
+exports.retryFetch = retryFetch;

package/flagsmith-engine/features/models.ts

@@ -96,18 +96,27 @@ export class FeatureStateModel {
         }
         return this.featureSegment.priority < other.featureSegment.priority;
     }
-    
-    getMultivariateValue(identityID: number | string) {
-        const percentageValue = getHashedPercentateForObjIds([
-            this.djangoID || this.featurestateUUID,
-            identityID
-        ]);
 
+    getMultivariateValue(identityID: number | string) {
+        let percentageValue: number | undefined;
         let startPercentage = 0;
-        const sortedF = this.multivariateFeatureStateValues.sort((a, b) =>{
+        const sortedF = this.multivariateFeatureStateValues.sort((a, b) => {
             return a.id - b.id;
         });
         for (const myValue of sortedF) {
+            switch (myValue.percentageAllocation) {
+                case 0:
+                    continue;
+                case 100:
+                    return myValue.multivariateFeatureOption.value;
+                default:
+                    if (percentageValue === undefined) {
+                        percentageValue = getHashedPercentateForObjIds([
+                            this.djangoID || this.featurestateUUID,
+                            identityID
+                        ]);
+                    }
+            }
             const limit = myValue.percentageAllocation + startPercentage;
             if (startPercentage <= percentageValue && percentageValue < limit) {
                 return myValue.multivariateFeatureOption.value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "3.0.0",
+  "version": "3.1.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/index.ts

@@ -30,7 +30,7 @@ export class Flagsmith {
     environmentKey?: string;
     apiUrl: string = DEFAULT_API_URL;
     customHeaders?: { [key: string]: any };
-    requestTimeoutSeconds?: number;
+    requestTimeoutSeconds?: number = 10;
     agent: RequestInit['agent'];
     requestTimeoutMs?: number;
     enableLocalEvaluation?: boolean = false;

package/sdk/utils.ts

@@ -19,8 +19,8 @@ export const delay = (ms: number) =>
 export const retryFetch = (
     url: string,
     fetchOptions: RequestInit,
-    retries = 3,
-    timeout?: number // set an overall timeout for this function
+    retries: number = 3,
+    timeout: number = 10// set an overall timeout for this function
 ): Promise<Response> => {
     return new Promise((resolve, reject) => {
         const retryWrapper = (n: number) => {