flagsmith-nodejs 2.0.0-beta.2 → 2.0.0-beta.5

package/build/sdk/index.d.ts

@@ -1,6 +1,7 @@
 import { EnvironmentModel } from '../flagsmith-engine/environments/models';
 import { DefaultFlag, Flags } from './models';
 import { EnvironmentDataPollingManager } from './polling_manager';
+import { SegmentModel } from '../flagsmith-engine/segments/models';
 export declare class Flagsmith {
     environmentKey?: string;
     apiUrl: string;
@@ -10,7 +11,7 @@ export declare class Flagsmith {
     requestTimeoutSeconds?: number;
     enableLocalEvaluation?: boolean;
     environmentRefreshIntervalSeconds: number;
-    retries?: any;
+    retries?: number;
     enableAnalytics: boolean;
     defaultFlagHandler?: (featureName: string) => DefaultFlag;
     environmentFlagsUrl: string;
@@ -58,7 +59,7 @@ export declare class Flagsmith {
         requestTimeoutSeconds?: number;
         enableLocalEvaluation?: boolean;
         environmentRefreshIntervalSeconds?: number;
-        retries?: any;
+        retries?: number;
         enableAnalytics?: boolean;
         defaultFlagHandler?: (featureName: string) => DefaultFlag;
     });
@@ -82,12 +83,31 @@ export declare class Flagsmith {
     getIdentityFlags(identifier: string, traits?: {
         [key: string]: any;
     }): Promise<Flags>;
+    /**
+     * Get the segments for the current environment for a given identity. Will also
+        upsert all traits to the Flagsmith API for future evaluations. Providing a
+        trait with a value of None will remove the trait from the identity if it exists.
+     *
+     * @param  {string} identifier a unique identifier for the identity in the current
+            environment, e.g. email address, username, uuid
+     * @param  {{[key:string]:any}} traits? a dictionary of traits to add / update on the identity in
+            Flagsmith, e.g. {"num_orders": 10}
+     * @returns Segments that the given identity belongs to.
+     */
+    getIdentitySegments(identifier: string, traits?: {
+        [key: string]: any;
+    }): Promise<SegmentModel[]>;
     /**
      * Updates the environment state for local flag evaluation.
+     * Sets a local promise to prevent race conditions in getIdentityFlags / getIdentitySegments.
      * You only need to call this if you wish to bypass environmentRefreshIntervalSeconds.
      */
     updateEnvironment(): Promise<void>;
     private getJSONResponse;
+    /**
+     * This promise ensures that the environment is retrieved before attempting to locally evaluate.
+     */
+    private environmentPromise;
     private getEnvironmentFromApi;
     private getEnvironmentFlagsFromDocument;
     private getIdentityFlagsFromDocument;

package/build/sdk/index.js

@@ -10,6 +10,7 @@ const errors_1 = require("./errors");
 const models_3 = require("./models");
 const polling_manager_1 = require("./polling_manager");
 const utils_1 = require("./utils");
+const evaluators_1 = require("../flagsmith-engine/segments/evaluators");
 const DEFAULT_API_URL = 'https://api.flagsmith.com/api/v1/';
 class Flagsmith {
     environmentKey;
@@ -72,8 +73,12 @@ class Flagsmith {
         this.identitiesUrl = `${this.apiUrl}identities/`;
         this.environmentUrl = `${this.apiUrl}environment-document/`;
         if (this.enableLocalEvaluation) {
+            if (!this.environmentKey.startsWith('ser.')) {
+                console.error('In order to use local evaluation, please generate a server key in the environment settings page.');
+            }
             this.environmentDataPollingManager = new polling_manager_1.EnvironmentDataPollingManager(this, this.environmentRefreshIntervalSeconds);
             this.environmentDataPollingManager.start();
+            this.updateEnvironment();
         }
         this.analyticsProcessor = data.enableAnalytics
             ? new analytics_1.AnalyticsProcessor({
@@ -107,17 +112,57 @@ class Flagsmith {
      */
     getIdentityFlags(identifier, traits) {
         traits = traits || {};
-        if (this.environment) {
-            return new Promise(resolve => resolve(this.getIdentityFlagsFromDocument(identifier, traits || {})));
+        if (this.enableLocalEvaluation) {
+            return new Promise(resolve => this.environmentPromise.then(() => {
+                resolve(this.getIdentityFlagsFromDocument(identifier, traits || {}));
+            }));
         }
         return this.getIdentityFlagsFromApi(identifier, traits);
     }
+    /**
+     * Get the segments for the current environment for a given identity. Will also
+        upsert all traits to the Flagsmith API for future evaluations. Providing a
+        trait with a value of None will remove the trait from the identity if it exists.
+     *
+     * @param  {string} identifier a unique identifier for the identity in the current
+            environment, e.g. email address, username, uuid
+     * @param  {{[key:string]:any}} traits? a dictionary of traits to add / update on the identity in
+            Flagsmith, e.g. {"num_orders": 10}
+     * @returns Segments that the given identity belongs to.
+     */
+    getIdentitySegments(identifier, traits) {
+        traits = traits || {};
+        if (this.enableLocalEvaluation) {
+            return this.environmentPromise.then(() => {
+                return new Promise(resolve => {
+                    const identityModel = this.buildIdentityModel(identifier, Object.keys(traits || {}).map(key => ({
+                        key,
+                        value: traits?.[key]
+                    })));
+                    const segments = (0, evaluators_1.getIdentitySegments)(this.environment, identityModel);
+                    return resolve(segments);
+                });
+            });
+        }
+        console.error('This function is only permitted with local evaluation.');
+        return Promise.resolve([]);
+    }
     /**
      * Updates the environment state for local flag evaluation.
+     * Sets a local promise to prevent race conditions in getIdentityFlags / getIdentitySegments.
      * You only need to call this if you wish to bypass environmentRefreshIntervalSeconds.
      */
     async updateEnvironment() {
-        this.environment = await this.getEnvironmentFromApi();
+        const request = this.getEnvironmentFromApi();
+        if (!this.environmentPromise) {
+            this.environmentPromise = request.then(res => {
+                this.environment = res;
+            });
+            await this.environmentPromise;
+        }
+        else {
+            this.environment = await request;
+        }
     }
     async getJSONResponse(url, method, body) {
         const headers = { 'Content-Type': 'application/json' };
@@ -140,6 +185,10 @@ class Flagsmith {
         }
         return data.json();
     }
+    /**
+     * This promise ensures that the environment is retrieved before attempting to locally evaluate.
+     */
+    environmentPromise;
     async getEnvironmentFromApi() {
         const environment_data = await this.getJSONResponse(this.environmentUrl, 'GET');
         return (0, util_1.buildEnvironmentModel)(environment_data);
@@ -212,4 +261,3 @@ class Flagsmith {
 }
 exports.Flagsmith = Flagsmith;
 exports.default = Flagsmith;
-// export = Flagsmith;

package/build/sdk/models.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Flags = exports.Flag = exports.DefaultFlag = exports.BaseFlag = void 0;
-const errors_1 = require("./errors");
 class BaseFlag {
     enabled;
     value;
@@ -85,7 +84,7 @@ class Flags {
             if (this.defaultFlagHandler) {
                 return this.defaultFlagHandler(featureName);
             }
-            throw new errors_1.FlagsmithClientError(`Feature does not exist: ${featureName}, implement defaultFlagHandler to handle this case.`);
+            return { enabled: false, isDefault: true, value: undefined };
         }
         if (this.analyticsProcessor && flag.featureId) {
             this.analyticsProcessor.trackFeature(flag.featureId);

package/example/server/api/index.js

@@ -29,5 +29,10 @@ module.exports = () => {
         res.json({ fontSize, checkoutV2 });
     });
 
+    api.get('/:user/segments', async (req, res) => {
+        const segments = await flagsmith.getIdentitySegments(req.params.user, { checkout_v2: 1 });
+        res.json(segments.map(v => v.name));
+    });
+
     return api;
 };

package/example/server/index.js

@@ -22,5 +22,8 @@ console.log('To get an example response for getFlags');
 console.log();
 console.log('Go to http://localhost:' + PORT + '/api/flagsmith_sample_user');
 console.log('To get an example feature state for a user');
+console.log();
+console.log('Go to http://localhost:' + PORT + '/api/flagsmith_sample_user/segments');
+console.log('To get the segments which the user belongs to');
 
 module.exports = app;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.5",
   "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": {
@@ -43,6 +43,8 @@
   "scripts": {
     "lint": "prettier --write .",
     "test": "jest --coverage --coverageReporters='text'",
+    "test:watch": "jest --coverage --watch --coverageReporters='text'",
+    "test:debug": "node --inspect-brk node_modules/.bin/jest --coverage --watch --coverageReporters='text'",
     "build": "tsc",
     "prepare": "husky install"
   },

package/sdk/index.ts

@@ -10,6 +10,8 @@ import { FlagsmithAPIError, FlagsmithClientError } from './errors';
 import { DefaultFlag, Flags } from './models';
 import { EnvironmentDataPollingManager } from './polling_manager';
 import { generateIdentitiesData, retryFetch } from './utils';
+import { SegmentModel } from '../flagsmith-engine/segments/models';
+import { getIdentitySegments } from '../flagsmith-engine/segments/evaluators';
 
 const DEFAULT_API_URL = 'https://api.flagsmith.com/api/v1/';
 
@@ -20,7 +22,7 @@ export class Flagsmith {
     requestTimeoutSeconds?: number;
     enableLocalEvaluation?: boolean = false;
     environmentRefreshIntervalSeconds: number = 60;
-    retries?: any;
+    retries?: number;
     enableAnalytics: boolean = false;
     defaultFlagHandler?: (featureName: string) => DefaultFlag;
 
@@ -68,7 +70,7 @@ export class Flagsmith {
         requestTimeoutSeconds?: number;
         enableLocalEvaluation?: boolean;
         environmentRefreshIntervalSeconds?: number;
-        retries?: any;
+        retries?: number;
         enableAnalytics?: boolean;
         defaultFlagHandler?: (featureName: string) => DefaultFlag;
     }) {
@@ -88,11 +90,17 @@ export class Flagsmith {
         this.environmentUrl = `${this.apiUrl}environment-document/`;
 
         if (this.enableLocalEvaluation) {
+            if (!this.environmentKey.startsWith('ser.')) {
+                console.error(
+                    'In order to use local evaluation, please generate a server key in the environment settings page.'
+                );
+            }
             this.environmentDataPollingManager = new EnvironmentDataPollingManager(
                 this,
                 this.environmentRefreshIntervalSeconds
             );
             this.environmentDataPollingManager.start();
+            this.updateEnvironment();
         }
 
         this.analyticsProcessor = data.enableAnalytics
@@ -128,20 +136,67 @@ export class Flagsmith {
      */
     getIdentityFlags(identifier: string, traits?: { [key: string]: any }): Promise<Flags> {
         traits = traits || {};
-        if (this.environment) {
+        if (this.enableLocalEvaluation) {
             return new Promise(resolve =>
-                resolve(this.getIdentityFlagsFromDocument(identifier, traits || {}))
+                this.environmentPromise!.then(() => {
+                    resolve(this.getIdentityFlagsFromDocument(identifier, traits || {}));
+                })
             );
         }
         return this.getIdentityFlagsFromApi(identifier, traits);
     }
 
+    /**
+     * Get the segments for the current environment for a given identity. Will also
+        upsert all traits to the Flagsmith API for future evaluations. Providing a
+        trait with a value of None will remove the trait from the identity if it exists.
+     *
+     * @param  {string} identifier a unique identifier for the identity in the current
+            environment, e.g. email address, username, uuid
+     * @param  {{[key:string]:any}} traits? a dictionary of traits to add / update on the identity in
+            Flagsmith, e.g. {"num_orders": 10}
+     * @returns Segments that the given identity belongs to.
+     */
+    getIdentitySegments(
+        identifier: string,
+        traits?: { [key: string]: any }
+    ): Promise<SegmentModel[]> {
+        traits = traits || {};
+        if (this.enableLocalEvaluation) {
+            return this.environmentPromise!.then(() => {
+                return new Promise(resolve => {
+                    const identityModel = this.buildIdentityModel(
+                        identifier,
+                        Object.keys(traits || {}).map(key => ({
+                            key,
+                            value: traits?.[key]
+                        }))
+                    );
+
+                    const segments = getIdentitySegments(this.environment, identityModel);
+                    return resolve(segments);
+                });
+            });
+        }
+        console.error('This function is only permitted with local evaluation.');
+        return Promise.resolve([]);
+    }
+
     /**
      * Updates the environment state for local flag evaluation.
+     * Sets a local promise to prevent race conditions in getIdentityFlags / getIdentitySegments.
      * You only need to call this if you wish to bypass environmentRefreshIntervalSeconds.
      */
     async updateEnvironment() {
-        this.environment = await this.getEnvironmentFromApi();
+        const request = this.getEnvironmentFromApi();
+        if (!this.environmentPromise) {
+            this.environmentPromise = request.then(res => {
+                this.environment = res;
+            });
+            await this.environmentPromise;
+        } else {
+            this.environment = await request;
+        }
     }
 
     private async getJSONResponse(
@@ -149,7 +204,7 @@ export class Flagsmith {
         method: string,
         body?: { [key: string]: any }
     ): Promise<any> {
-        const headers: { [key: string]: any } = {'Content-Type': 'application/json'};
+        const headers: { [key: string]: any } = { 'Content-Type': 'application/json' };
         if (this.environmentKey) {
             headers['X-Environment-Key'] = this.environmentKey as string;
         }
@@ -182,6 +237,11 @@ export class Flagsmith {
         return data.json();
     }
 
+    /**
+     * This promise ensures that the environment is retrieved before attempting to locally evaluate.
+     */
+    private environmentPromise: Promise<any> | undefined;
+
     private async getEnvironmentFromApi() {
         const environment_data = await this.getJSONResponse(this.environmentUrl, 'GET');
         return buildEnvironmentModel(environment_data);
@@ -267,4 +327,3 @@ export class Flagsmith {
 }
 
 export default Flagsmith;
-// export = Flagsmith;

package/sdk/models.ts

@@ -123,9 +123,9 @@ export class Flags {
             if (this.defaultFlagHandler) {
                 return this.defaultFlagHandler(featureName);
             }
-            throw new FlagsmithClientError(
-                `Feature does not exist: ${featureName}, implement defaultFlagHandler to handle this case.`
-            );
+
+            return { enabled: false, isDefault: true, value: undefined };
+
         }
 
         if (this.analyticsProcessor && flag.featureId) {

package/tests/sdk/data/environment.json

@@ -11,7 +11,44 @@
     },
     "id": 1,
     "hide_disabled_flags": false,
-    "segments": []
+    "segments": [
+      {
+        "name": "regular_segment",
+        "feature_states": [
+          {
+            "feature_state_value": "segment_override",
+            "multivariate_feature_state_values": [],
+            "django_id": 81027,
+            "feature": {
+              "name": "some_feature",
+              "type": "STANDARD",
+              "id": 1
+            },
+            "enabled": false
+          }
+        ],
+        "id": 1,
+        "rules": [
+          {
+            "type": "ALL",
+            "conditions": [],
+            "rules": [
+              {
+                "type": "ANY",
+                "conditions": [
+                  {
+                    "value": "40",
+                    "property_": "age",
+                    "operator": "LESS_THAN"
+                  }
+                ],
+                "rules": []
+              }
+            ]
+          }
+        ]
+      }
+    ]
   },
   "segment_overrides": [],
   "id": 1,
@@ -30,4 +67,4 @@
       "enabled": true
     }
   ]
-}
+}

package/tests/sdk/flagsmith.test.ts

@@ -14,8 +14,10 @@ beforeEach(() => {
 });
 
 test('test_flagsmith_starts_polling_manager_on_init_if_enabled', () => {
+    // @ts-ignore
+    fetch.mockReturnValue(Promise.resolve(new Response(environmentJSON())));
     new Flagsmith({
-        environmentKey: 'key',
+        environmentKey: 'ser.key',
         enableLocalEvaluation: true
     });
     expect(EnvironmentDataPollingManager).toBeCalled();
@@ -31,11 +33,28 @@ test('test_update_environment_sets_environment', async () => {
     // @ts-ignore
     flg.environment.featureStates[0].featurestateUUID = undefined;
     // @ts-ignore
+    flg.environment.project.segments[0].featureStates[0].featurestateUUID = undefined;
+    // @ts-ignore
     const model = environmentModel(JSON.parse(environmentJSON()));
     // @ts-ignore
     model.featureStates[0].featurestateUUID = undefined;
+    // @ts-ignore
+    model.project.segments[0].featureStates[0].featurestateUUID = undefined;
     expect(flg.environment).toStrictEqual(model);
 });
+
+test('test_get_identity_segments', async () => {
+    // @ts-ignore
+    fetch.mockReturnValue(Promise.resolve(new Response(environmentJSON())));
+    const flg = new Flagsmith({
+        environmentKey: 'ser.key',
+        enableLocalEvaluation: true
+    });
+    const segments = await flg.getIdentitySegments('user', { age: 21 });
+    expect(segments[0].name).toEqual('regular_segment');
+    const segments2 = await flg.getIdentitySegments('user', { age: 41 });
+    expect(segments2.length).toEqual(0);
+});
 test('test_get_environment_flags_calls_api_when_no_local_environment', async () => {
     // @ts-ignore
     fetch.mockReturnValue(Promise.resolve(new Response(flagsJSON())));