flagsmith-nodejs 2.3.0 → 2.4.1

package/tests/engine/engine-tests/engine-test-data/readme.md

@@ -0,0 +1,30 @@
+# Engine Test Data
+
+This repository contains a single directory containing json files that can be used to test that any Flagsmith engine
+written in a given language is correct. 
+
+Each JSON file should consist of a single object in the following format.
+
+```json
+{
+  "environment": {...},  // the environment document as found in DynamoDB
+  "identities_and_responses": [
+    {
+      "identity": {...},  // the identity as found in DynamoDB,
+      "response": {...},  // the response that was obtained from the current API
+    }
+  ]
+}
+```
+
+To use this data, you will need to write a test case in the repository which contains the engine code and include 
+this repository as a submodule to get access to the json files.
+
+To add the git submodule: 
+
+```bash
+git submodule add git@github.com:Flagsmith/engine-test-data.git tests/engine_tests/engine-test-data
+```
+
+An example of how to use the test data can be found in the flagsmith-flag-engine repository 
+[here](https://github.com/Flagsmith/flagsmith-engine/blob/main/tests/engine_tests/test_engine.py).  

package/tests/engine/unit/segments/segment_evaluators.test.ts

@@ -0,0 +1,27 @@
+import {
+    CONDITION_OPERATORS,
+} from '../../../../flagsmith-engine/segments/constants';
+import {
+    SegmentConditionModel,
+} from '../../../../flagsmith-engine/segments/models';
+import {traitsMatchSegmentCondition} from "../../../../flagsmith-engine/segments/evaluators";
+import {TraitModel} from "../../../../flagsmith-engine";
+
+let traitExistenceTestCases: [string, string | null | undefined, string | null | undefined, TraitModel [],boolean][] = [
+    [CONDITION_OPERATORS.IS_SET,'foo', null,[] , false],
+    [CONDITION_OPERATORS.IS_SET, 'foo',undefined , [new TraitModel('foo','bar')], true],
+    [CONDITION_OPERATORS.IS_SET, 'foo',undefined , [new TraitModel('foo','bar'), new TraitModel('fooBaz','baz')], true],
+    [CONDITION_OPERATORS.IS_NOT_SET, 'foo', undefined, [], true],
+    [CONDITION_OPERATORS.IS_NOT_SET, 'foo', null, [new TraitModel('foo','bar')], false],
+    [CONDITION_OPERATORS.IS_NOT_SET, 'foo', null, [new TraitModel('foo','bar'), new TraitModel('fooBaz','baz')], false]
+];
+
+test('test_traits_match_segment_condition_for_trait_existence_operators', () => {
+    for (const testCase of traitExistenceTestCases) {
+        const [operator, conditionProperty, conditionValue, traits, expectedResult] = testCase
+        let segmentModel = new SegmentConditionModel(operator, conditionValue, conditionProperty)
+        expect(
+           traitsMatchSegmentCondition (traits, segmentModel, 'any','any')
+        ).toBe(expectedResult);
+    }
+});

package/tests/engine/unit/segments/segments_model.test.ts

@@ -82,6 +82,13 @@ const conditionMatchCases: [string, string | number | boolean, string, boolean][
     [CONDITION_OPERATORS.LESS_THAN_INCLUSIVE, "1.0.0", "1.0.1:semver", true],
     [CONDITION_OPERATORS.LESS_THAN_INCLUSIVE, "1.0.0", "1.0.0:semver", true],
     [CONDITION_OPERATORS.LESS_THAN_INCLUSIVE, "1.0.1", "1.0.0:semver", false],
+    [CONDITION_OPERATORS.MODULO, 1, "2|0", false],
+    [CONDITION_OPERATORS.MODULO, 2, "2|0", true],
+    [CONDITION_OPERATORS.MODULO, 3, "2|0", false],
+    [CONDITION_OPERATORS.MODULO, 34.2, "4|3", false],
+    [CONDITION_OPERATORS.MODULO, 35.0, "4|3", true],
+    [CONDITION_OPERATORS.MODULO, "foo", "4|3", false],
+    [CONDITION_OPERATORS.MODULO, 35.0, "foo|bar", false],
     ['BAD_OP', 'a', 'a', false]
 ];
 
@@ -119,4 +126,4 @@ test('test_segment_rule_matching_function', () => {
     for (const testCase of testCases) {
         expect(new SegmentRuleModel(testCase[0]).matchingFunction()).toBe(testCase[1]);
     }
-});
+});

package/tests/sdk/data/environment.json

@@ -63,8 +63,30 @@
         "type": "STANDARD",
         "id": 1
       },
-      "segment_id": null,
+      "feature_segment": null,
       "enabled": true
+    },
+    {
+      "multivariate_feature_state_values": [
+        {
+          "percentage_allocation": 100,
+          "multivariate_feature_option": {
+            "value": "bar",
+            "id": 1
+          },
+          "mv_fs_value_uuid": "42d5cdf9-8ec9-4b8d-a3ca-fd43c64d5f05",
+          "id": 1
+        }
+      ],
+      "feature_state_value": "foo",
+      "feature": {
+        "name": "mv_feature",
+        "type": "MULTIVARIATE",
+        "id": 2
+      },
+      "feature_segment": null,
+      "featurestate_uuid": "96fc3503-09d7-48f1-a83b-2dc903d5c08a",
+      "enabled": false
     }
   ]
 }

package/tests/sdk/flagsmith-identity-flags.test.ts

@@ -27,7 +27,7 @@ test('test_get_identity_flags_calls_api_when_no_local_environment_no_traits', as
   expect(identityFlags[0].featureName).toBe('some_feature');
 });
 
-test('test_get_identity_flags_calls_api_when_local_environment_no_traits', async () => {
+test('test_get_identity_flags_uses_environment_when_local_environment_no_traits', async () => {
   // @ts-ignore
   fetch.mockReturnValue(Promise.resolve(new Response(environmentJSON())));
   const identifier = 'identifier';
@@ -138,3 +138,20 @@ test('test_default_flag_is_used_when_no_identity_flags_returned_and_no_custom_de
   expect(flag.enabled).toBe(false);
 });
 
+
+test('test_get_identity_flags_multivariate_value_with_local_evaluation_enabled', async () => {
+  // @ts-ignore
+  fetch.mockReturnValue(Promise.resolve(new Response(environmentJSON())));
+  const identifier = 'identifier';
+
+  const flg = flagsmith({
+      environmentKey: 'ser.key',
+      enableLocalEvaluation: true,
+
+  });
+
+  const identityFlags = (await flg.getIdentityFlags(identifier))
+
+  expect(identityFlags.getFeatureValue('mv_feature')).toBe('bar');
+  expect(identityFlags.isFeatureEnabled('mv_feature')).toBe(false);
+});

package/tests/sdk/flagsmith.test.ts

@@ -45,16 +45,11 @@ test('test_update_environment_sets_environment', async () => {
     await flg.updateEnvironment();
     expect(flg.environment).toBeDefined();
 
-    // @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;
+
+    wipeFeatureStateUUIDs(flg.environment)
+    wipeFeatureStateUUIDs(model)
+
     expect(flg.environment).toStrictEqual(model);
 });
 
@@ -231,3 +226,24 @@ test('test onEnvironmentChange is called after error', async () => {
 
     expect(callbackSpy).toBeCalled();
 });
+
+
+
+async function wipeFeatureStateUUIDs (enviromentModel: EnvironmentModel) {
+    // TODO: this has been pulled out of tests above as a helper function.
+    //  I'm not entirely sure why it's necessary, however, we should look to remove.
+    enviromentModel.featureStates.forEach(fs => {
+        // @ts-ignore
+        fs.featurestateUUID = undefined;
+        fs.multivariateFeatureStateValues.forEach(mvfsv => {
+            // @ts-ignore
+            mvfsv.mvFsValueUuid = undefined;
+        })
+    });
+    enviromentModel.project.segments.forEach(s => {
+        s.featureStates.forEach(fs => {
+            // @ts-ignore
+            fs.featurestateUUID = undefined;
+        })
+    })
+}

package/.idea/flagsmith-nodejs-client.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/flagsmith-nodejs-client.iml" filepath="$PROJECT_DIR$/.idea/flagsmith-nodejs-client.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

package/examples/api-proxy/.idea/api-proxy.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/examples/api-proxy/.idea/codeStyles/Project.xml

@@ -1,60 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <HTMLCodeStyleSettings>
-      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
-      <option name="HTML_KEEP_WHITESPACES_INSIDE" value="pre,textarea" />
-      <option name="HTML_ENFORCE_QUOTES" value="true" />
-      <option name="HTML_NEWLINE_AFTER_LAST_ATTRIBUTE" value="When multiline" />
-    </HTMLCodeStyleSettings>
-    <JSCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="Remove" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </JSCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="Remove" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <VueCodeStyleSettings>
-      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
-      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
-    </VueCodeStyleSettings>
-    <codeStyleSettings language="HTML">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="Vue">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

package/examples/api-proxy/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/examples/api-proxy/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/examples/api-proxy/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/api-proxy.iml" filepath="$PROJECT_DIR$/.idea/api-proxy.iml" />
-    </modules>
-  </component>
-</project>

package/examples/api-proxy/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/../.." vcs="Git" />
-  </component>
-</project>