flagsmith-nodejs 2.2.2 → 2.4.0

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/flagsmith.test.ts

@@ -1,10 +1,12 @@
 import Flagsmith from '../../sdk';
 import { EnvironmentDataPollingManager } from '../../sdk/polling_manager';
-import fetch from 'node-fetch';
+import fetch, {RequestInit} from 'node-fetch';
 import { environmentJSON, environmentModel, flagsJSON, flagsmith, identitiesJSON } from './utils';
 import { DefaultFlag } from '../../sdk/models';
-import { delay } from '../../sdk/utils';
+import {delay, retryFetch} from '../../sdk/utils';
+import * as utils from '../../sdk/utils';
 import { EnvironmentModel } from '../../flagsmith-engine/environments/models';
+import https from 'https'
 
 jest.mock('node-fetch');
 jest.mock('../../sdk/polling_manager');
@@ -56,6 +58,26 @@ test('test_update_environment_sets_environment', async () => {
     expect(flg.environment).toStrictEqual(model);
 });
 
+test('test_set_agent_options', async () => {
+    const agent = new https.Agent({})
+
+    // @ts-ignore
+    fetch.mockImplementation((url:string, options:RequestInit)=>{
+        if(options.agent!==agent) {
+            throw new Error("Agent has not been set on retry fetch")
+        }
+        return Promise.resolve(new Response(environmentJSON()))
+    });
+
+    const flg = flagsmith({
+        agent
+    });
+
+    await flg.updateEnvironment();
+    expect(flg.environment).toBeDefined();
+
+});
+
 test('test_get_identity_segments', async () => {
     // @ts-ignore
     fetch.mockReturnValue(Promise.resolve(new Response(environmentJSON())));
@@ -81,11 +103,6 @@ test('test_get_identity_segments_empty_without_local_eval', async () => {
     expect(segments.length).toBe(0);
 });
 
-
-
-
-
-
 test('test_update_environment_uses_req_when_inited', async () => {
     // @ts-ignore
     fetch.mockReturnValue(Promise.resolve(new Response(environmentJSON())));
@@ -160,8 +177,6 @@ test('test_default_flag_used_after_multiple_API_errors', async () => {
     expect(flag.value).toBe(defaultFlag.value);
 });
 
-
-
 test('test_throws_when_no_identity_flags_returned_due_to_error', async () => {
     // @ts-ignore
     fetch.mockReturnValue(Promise.resolve(new Response('bad data')));
@@ -215,4 +230,4 @@ test('test onEnvironmentChange is called after error', async () => {
     await delay(200);
 
     expect(callbackSpy).toBeCalled();
-});
+});

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/es6-example/README.md

@@ -1,62 +0,0 @@
-# Nodejs-ES6-Boilerplate
-[![Made in Indonesia](https://made-in-indonesia.github.io/made-in-indonesia.svg)](https://github.com/made-in-indonesia/made-in-indonesia)
-
-A Node.js boilerplate with ES6, ESLint, and Prettier
-
-## Background
-
-I created this boilerplate because I have several coding interviews that needs to be done using JavaScript.
-
-## Scripts
-
-```bash
-# Run the project without nodemon
-npm run start
-
-# Build the project
-npm run build
-
-# Clean build
-npm run clean
-
-# Check the lint errors
-npm run lint
-
-# Fix the lint errors
-npm run lint:fix
-
-# Run prettier
-npm run format
-
-# Check prettier errors
-npm run format:check
-```
-
-## Usage
-
-1. Clone the repository and init new git project
-
-```bash
-$ git clone git@github.com:vferdiansyah/nodejs-es6-boilerplate.git ./your/project/folder
-$ cd ./your/project/folder
-$ rm -rf .git
-$ git init
-```
-
-2. Change project specific information in the following places
-
-- [package.json](./package.json)
-- [README.md](./README.md)
-
-3. Install dependencies
-
-```bash
-$ npm i
-```
-
-4. Start coding
-
-## License
-
-Copyright (c) 2020 Veri Ferdiansyah  
-Licensed under the MIT license.

package/example/Procfile

@@ -1 +0,0 @@
-web: npm start

package/example/README.md

@@ -1,15 +0,0 @@
-# Flagsmith example
-
-## Getting Started
-
-# Run
-
-`$ npm start`
-
-# Nodemon (Restart server on changes)
-
-`npm run dev`
-
-# The project
-
--   `/server/api` contains a simple express api that interacts with Flagsmith