flagsmith-nodejs 2.5.2 → 3.0.1

package/.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish NPM Package
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  package:
+    runs-on: ubuntu-latest
+    name: Publish NPM Package
+
+    steps:
+      - name: Cloning repo
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm ci
+      - run: npm run deploy
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/build/flagsmith-engine/identities/models.d.ts

@@ -8,7 +8,7 @@ export declare class IdentityModel {
     identityTraits: TraitModel[];
     identityUuid: string;
     djangoID: number | undefined;
-    constructor(created_date: string, identityTraits: TraitModel[], identityFeatures: IdentityFeaturesList, environmentApiKey: string, identifier: string, identityUuid?: string);
+    constructor(created_date: string, identityTraits: TraitModel[], identityFeatures: IdentityFeaturesList, environmentApiKey: string, identifier: string, identityUuid?: string, djangoID?: number);
     get compositeKey(): string;
     static generateCompositeKey(env_key: string, identifier: string): string;
     updateTraits(traits: TraitModel[]): void;

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

@@ -40,13 +40,14 @@ exports.IdentityModel = void 0;
 var collections_1 = require("../utils/collections");
 var uuidv4 = require('uuid').v4;
 var IdentityModel = /** @class */ (function () {
-    function IdentityModel(created_date, identityTraits, identityFeatures, environmentApiKey, identifier, identityUuid) {
+    function IdentityModel(created_date, identityTraits, identityFeatures, environmentApiKey, identifier, identityUuid, djangoID) {
         this.identityUuid = identityUuid || uuidv4();
         this.createdDate = Date.parse(created_date) || Date.now();
         this.identityTraits = identityTraits;
         this.identityFeatures = new (collections_1.IdentityFeaturesList.bind.apply(collections_1.IdentityFeaturesList, __spreadArray([void 0], __read(identityFeatures), false)))();
         this.environmentApiKey = environmentApiKey;
         this.identifier = identifier;
+        this.djangoID = djangoID;
     }
     Object.defineProperty(IdentityModel.prototype, "compositeKey", {
         get: function () {

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

@@ -12,7 +12,7 @@ exports.getIdentitySegments = getIdentitySegments;
 function evaluateIdentityInSegment(identity, segment, overrideTraits) {
     return (segment.rules.length > 0 &&
         segment.rules.filter(function (rule) {
-            return traitsMatchSegmentRule(overrideTraits || identity.identityTraits, rule, segment.id, identity.compositeKey);
+            return traitsMatchSegmentRule(overrideTraits || identity.identityTraits, rule, segment.id, identity.djangoID || identity.compositeKey);
         }).length === segment.rules.length);
 }
 exports.evaluateIdentityInSegment = evaluateIdentityInSegment;
@@ -29,7 +29,8 @@ function traitsMatchSegmentRule(identityTraits, rule, segmentId, identityId) {
 }
 function traitsMatchSegmentCondition(identityTraits, condition, segmentId, identityId) {
     if (condition.operator == constants_1.PERCENTAGE_SPLIT) {
-        return (0, hashing_1.getHashedPercentateForObjIds)([segmentId, identityId]) <= parseFloat(String(condition.value));
+        var hashedPercentage = (0, hashing_1.getHashedPercentateForObjIds)([segmentId, identityId]);
+        return hashedPercentage <= parseFloat(String(condition.value));
     }
     var traits = identityTraits.filter(function (t) { return t.traitKey === condition.property_; });
     var trait = traits.length > 0 ? traits[0] : undefined;

package/examples/README.md

@@ -0,0 +1,3 @@
+# Flagsmith NodeJS Examples
+
+Check out our [NodeJS Examples repository](https://github.com/Flagsmith/flagsmith-nodejs-examples).

package/flagsmith-engine/identities/models.ts

@@ -19,7 +19,8 @@ export class IdentityModel {
         identityFeatures: IdentityFeaturesList,
         environmentApiKey: string,
         identifier: string,
-        identityUuid?: string
+        identityUuid?: string,
+        djangoID?: number
     ) {
         this.identityUuid = identityUuid || uuidv4();
         this.createdDate = Date.parse(created_date) || Date.now();
@@ -27,6 +28,7 @@ export class IdentityModel {
         this.identityFeatures = new IdentityFeaturesList(...identityFeatures);
         this.environmentApiKey = environmentApiKey;
         this.identifier = identifier;
+        this.djangoID = djangoID;
     }
 
     get compositeKey() {

package/flagsmith-engine/segments/evaluators.ts

@@ -27,7 +27,7 @@ export function evaluateIdentityInSegment(
                 overrideTraits || identity.identityTraits,
                 rule,
                 segment.id,
-                identity.compositeKey
+                identity.djangoID || identity.compositeKey
             )
         ).length === segment.rules.length
     );
@@ -62,7 +62,8 @@ export function traitsMatchSegmentCondition(
     identityId: number | string
 ): boolean {
     if (condition.operator == PERCENTAGE_SPLIT) {
-        return getHashedPercentateForObjIds([segmentId, identityId]) <= parseFloat(String(condition.value));
+        var hashedPercentage = getHashedPercentateForObjIds([segmentId, identityId]);
+        return hashedPercentage <= parseFloat(String(condition.value));
     }
     const traits = identityTraits.filter(t => t.traitKey === condition.property_);
     const trait = traits.length > 0 ? traits[0] : undefined;
@@ -73,4 +74,4 @@ export function traitsMatchSegmentCondition(
     }
     return trait ? condition.matchesTraitValue(trait.traitValue) : false;
 
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "2.5.2",
+  "version": "3.0.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/tests/engine/unit/segments/segment_evaluators.test.ts

@@ -1,11 +1,21 @@
 import {
+    ALL_RULE,
     CONDITION_OPERATORS,
+    PERCENTAGE_SPLIT,
 } from '../../../../flagsmith-engine/segments/constants';
-import {
-    SegmentConditionModel,
-} from '../../../../flagsmith-engine/segments/models';
-import {traitsMatchSegmentCondition} from "../../../../flagsmith-engine/segments/evaluators";
-import {TraitModel} from "../../../../flagsmith-engine";
+import {SegmentConditionModel} from '../../../../flagsmith-engine/segments/models';
+import {traitsMatchSegmentCondition, evaluateIdentityInSegment} from "../../../../flagsmith-engine/segments/evaluators";
+import {TraitModel, IdentityModel} from "../../../../flagsmith-engine";
+import {environment} from "../utils";
+import { buildSegmentModel } from '../../../../flagsmith-engine/segments/util';
+import { getHashedPercentateForObjIds } from '../../../../flagsmith-engine/utils/hashing';
+
+
+// todo: work out how to implement this in a test function or before hook
+jest.mock('../../../../flagsmith-engine/utils/hashing', () => ({
+    getHashedPercentateForObjIds: jest.fn(() => 1)
+}));
+
 
 let traitExistenceTestCases: [string, string | null | undefined, string | null | undefined, TraitModel [],boolean][] = [
     [CONDITION_OPERATORS.IS_SET,'foo', null,[] , false],
@@ -24,4 +34,34 @@ test('test_traits_match_segment_condition_for_trait_existence_operators', () =>
            traitsMatchSegmentCondition (traits, segmentModel, 'any','any')
         ).toBe(expectedResult);
     }
-});
+});
+
+
+test('evaluateIdentityInSegment uses django ID for hashed percentage when present', () => {
+    var identityModel = new IdentityModel(Date.now().toString(), [], [], environment().apiKey, 'identity_1', undefined, 1);
+    const segmentDefinition = {
+        id: 1,
+        name: 'percentage_split_segment',
+        rules: [
+            {
+                type: ALL_RULE,
+                conditions: [
+                    {
+                        operator: PERCENTAGE_SPLIT,
+                        property_: null,
+                        value: "10"
+                    }
+                ],
+                rules: []
+            }
+        ],
+        feature_states: []
+    };
+    const segmentModel = buildSegmentModel(segmentDefinition);
+
+    var result = evaluateIdentityInSegment(identityModel, segmentModel);
+
+    expect(result).toBe(true);
+    expect(getHashedPercentateForObjIds).toHaveBeenCalledTimes(1)
+    expect(getHashedPercentateForObjIds).toHaveBeenCalledWith([segmentModel.id, identityModel.djangoID])
+});

package/.vscode/launch.json

@@ -1,18 +0,0 @@
-{
-    "version": "1.0.0",
-    "configurations": [
-      {
-        "type": "node",
-        "request": "launch",
-        "name": "Jest: current file",
-        //"env": { "NODE_ENV": "test" },
-        "program": "${workspaceFolder}/node_modules/.bin/jest",
-        "args": ["${file}", "--config", "jest.config.js"],
-        "console": "integratedTerminal",
-        "disableOptimisticBPs": true,
-        "windows": {
-          "program": "${workspaceFolder}/node_modules/jest/bin/jest"
-        }
-      }
-    ]
-  }

package/examples/api-proxy/.babelrc

@@ -1,3 +0,0 @@
-{
-  "presets": ["@babel/preset-env"]
-}

package/examples/api-proxy/.eslintrc

@@ -1,8 +0,0 @@
-{
-  "extends": ["eslint:recommended", "prettier"],
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module"
-  },
-  "env": { "es6": true, "node": true }
-}

package/examples/api-proxy/README.md

@@ -1,12 +0,0 @@
-<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
-
-# Flagsmith Node.js example with custom fetch agent
-
-This is a simple Flagsmith Node.js example in local evaluation modes with a custom fetch agent. Using a custom fetch agent lets allows you to specify networking related options such as keep alive and socket timeout, read more on this [here](https://github.com/node-fetch/node-fetch#custom-agent).
-
-## Running the example
-
-```shell
-npm i
-npm run dev
-```