flagsmith-nodejs 2.2.2 → 2.4.0

package/examples/local-evaluation/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "nodejs-es6-boilerplate",
+  "version": "1.0.1",
+  "description": "Node.js boilerplate with ES6, ESLint, and Prettier",
+  "main": "src/index.js",
+  "browserslist": [
+    "last 2 Chrome versions"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "clean": "rm -rf build && mkdir build",
+    "build-babel": "babel -d ./build ./src -s",
+    "build": "npm run clean && npm run build-babel",
+    "dev": "nodemon --exec npm start --ignore ./build",
+    "node-cache": "^5.1.2",
+    "ssg-node-express": "4.16.4",
+    "start": "npm run build && node ./build/index.js",
+    "format": "prettier --write \"src/**/*.js\"",
+    "format:check": "prettier --list-different \"src/**/*.js\"",
+    "lint": "eslint \"src/**/*.js\"",
+    "lint:fix": "eslint --fix \"src/**/*.js\""
+  },
+  "repository": "github:vferdiansyah/nodejs-es6-boilerplate",
+  "keywords": [
+    "javascript",
+    "node",
+    "nodejs",
+    "es6",
+    "eslint",
+    "prettier",
+    "boilerplate"
+  ],
+  "author": {
+    "name": "Veri Ferdiansyah",
+    "email": "veri.ferdi@gmail.com",
+    "url": "https://vferdiansyah.github.io"
+  },
+  "license": "MIT",
+  "bugs": "https://github.com/vferdiansyah/nodejs-es6-boilerplate/issues",
+  "homepage": "https://github.com/vferdiansyah/nodejs-es6-boilerplate#readme",
+  "devDependencies": {
+    "@babel/cli": "^7.18.10",
+    "@babel/core": "^7.5.5",
+    "@babel/preset-env": "^7.5.5",
+    "eslint": "^6.2.1",
+    "eslint-config-prettier": "^6.1.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "express": "^4.18.1",
+    "nodemon": "^2.0.19",
+    "prettier": "^1.18.2"
+  },
+  "dependencies": {
+    "flagsmith-nodejs": "^2.2.2",
+    "node-cache": "^5.1.2"
+  }
+}

package/{es6-example → examples/local-evaluation}/src/api/index.js

@@ -1,8 +1,7 @@
 import {Router}  from 'express'
-import Flagsmith from 'flagsmith-nodejs'
+import Flagsmith from '../../../../build'
 
 const environmentKey = '';
-import nodecache from "node-cache";
 
 if (!environmentKey) {
     throw new Error(
@@ -11,19 +10,9 @@ if (!environmentKey) {
 }
 const flagsmith = new Flagsmith({
     environmentKey,
-    enableLocalEvaluation: true,
-    cache: new nodecache({
-        stdTTL: 10,
-        checkperiod: 10,
-    }),
+    enableLocalEvaluation: true
 });
 
-
-// solicitor
-
-// read only
- // sra authorisation date
-
 const api =  () => {
     const api = Router();
 

package/examples/local-evaluation/src/index.js

@@ -0,0 +1,29 @@
+import http from 'http'
+import express from 'express'
+import bodyParser from 'body-parser'
+import api from './api'
+const PORT = process.env.PORT || 3000;
+const app = express();
+
+app.server = http.createServer(app);
+
+//Apply middleware
+// parse various different custom JSON types as JSON
+app.use(bodyParser.json());
+
+// api router
+app.use('/api', api());
+
+app.server.listen(PORT);
+console.log('Server started on port ' + PORT);
+console.log();
+console.log('Go to http://localhost:' + PORT + '/api');
+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/flagsmith-engine/segments/constants.ts

@@ -16,6 +16,9 @@ export const NOT_CONTAINS = 'NOT_CONTAINS';
 export const NOT_EQUAL = 'NOT_EQUAL';
 export const REGEX = 'REGEX';
 export const PERCENTAGE_SPLIT = 'PERCENTAGE_SPLIT';
+export const IS_SET = 'IS_SET';
+export const IS_NOT_SET = 'IS_NOT_SET';
+export const MODULO = 'MODULO';
 
 export const CONDITION_OPERATORS = {
     EQUAL,
@@ -27,5 +30,8 @@ export const CONDITION_OPERATORS = {
     NOT_CONTAINS,
     NOT_EQUAL,
     REGEX,
-    PERCENTAGE_SPLIT
+    PERCENTAGE_SPLIT,
+    IS_SET,
+    IS_NOT_SET,
+    MODULO
 };

package/flagsmith-engine/segments/evaluators.ts

@@ -2,7 +2,7 @@ import { EnvironmentModel } from '../environments/models';
 import { IdentityModel } from '../identities/models';
 import { TraitModel } from '../identities/traits/models';
 import { getHashedPercentateForObjIds } from '../utils/hashing';
-import { PERCENTAGE_SPLIT } from './constants';
+import { PERCENTAGE_SPLIT, IS_SET, IS_NOT_SET } from './constants';
 import { SegmentConditionModel, SegmentModel, SegmentRuleModel } from './models';
 
 export function getIdentitySegments(
@@ -55,18 +55,22 @@ function traitsMatchSegmentRule(
     );
 }
 
-function traitsMatchSegmentCondition(
+export function traitsMatchSegmentCondition(
     identityTraits: TraitModel[],
     condition: SegmentConditionModel,
     segmentId: number | string,
     identityId: number | string
 ): boolean {
     if (condition.operator == PERCENTAGE_SPLIT) {
-        return getHashedPercentateForObjIds([segmentId, identityId]) <= parseFloat(condition.value);
+        return getHashedPercentateForObjIds([segmentId, identityId]) <= parseFloat(String(condition.value));
     }
-
     const traits = identityTraits.filter(t => t.traitKey === condition.property_);
     const trait = traits.length > 0 ? traits[0] : undefined;
-
+    if (condition.operator === IS_SET ) {
+        return !!trait;
+    } else if (condition.operator === IS_NOT_SET){
+        return trait == undefined;
+    }
     return trait ? condition.matchesTraitValue(trait.traitValue) : false;
-}
+
+}

package/flagsmith-engine/segments/models.ts

@@ -8,6 +8,7 @@ import {
     NONE_RULE,
     NOT_CONTAINS,
     REGEX,
+    MODULO,
     CONDITION_OPERATORS
 } from './constants';
 import { isSemver } from './util';
@@ -44,14 +45,15 @@ export const getMatchingFunctions = (semver: boolean) => (semver ? semverMatchin
 export class SegmentConditionModel {
     EXCEPTION_OPERATOR_METHODS: { [key: string]: string } = {
         [NOT_CONTAINS]: 'evaluateNotContains',
-        [REGEX]: 'evaluateRegex'
+        [REGEX]: 'evaluateRegex',
+        [MODULO]: 'evaluateModulo',
     };
 
     operator: string;
-    value: string;
-    property_: string | undefined;
+    value: string | null | undefined;
+    property_: string | null | undefined;
 
-    constructor(operator: string, value: string, property?: string) {
+    constructor(operator: string, value?: string | null | undefined, property?: string | null | undefined) {
         this.operator = operator;
         this.value = value;
         this.property_ = property;
@@ -63,7 +65,15 @@ export class SegmentConditionModel {
                 return !traitValue.includes(this.value);
             },
             evaluateRegex: (traitValue: any) => {
-                return !!traitValue.match(new RegExp(this.value));
+                return !!this.value && !!traitValue.match(new RegExp(this.value));
+            },
+            evaluateModulo: (traitValue: any) => {
+                if (isNaN(parseFloat(traitValue)) || !this.value) {
+                    return false
+                }
+                const parts = (this.value).split("|");
+                const [divisor, reminder] = [parseFloat(parts[0]), parseFloat(parts[1])];
+                return traitValue % divisor === reminder
             }
         };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "2.2.2",
+  "version": "2.4.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

@@ -1,3 +1,4 @@
+import { RequestInit } from "node-fetch";
 import { getEnvironmentFeatureStates, getIdentityFeatureStates } from '../flagsmith-engine';
 import { EnvironmentModel } from '../flagsmith-engine/environments/models';
 import { buildEnvironmentModel } from '../flagsmith-engine/environments/util';
@@ -12,22 +13,24 @@ import { EnvironmentDataPollingManager } from './polling_manager';
 import { generateIdentitiesData, retryFetch } from './utils';
 import { SegmentModel } from '../flagsmith-engine/segments/models';
 import { getIdentitySegments } from '../flagsmith-engine/segments/evaluators';
-import { FlagsmithCache } from './types';
+import { FlagsmithCache, FlagsmithConfig } from './types';
 
 export { AnalyticsProcessor } from './analytics';
 export { FlagsmithAPIError, FlagsmithClientError } from './errors';
 
 export { DefaultFlag, Flags } from './models';
 export { EnvironmentDataPollingManager } from './polling_manager';
-export { FlagsmithCache } from './types';
+export { FlagsmithCache, FlagsmithConfig } from './types';
 
 const DEFAULT_API_URL = 'https://edge.api.flagsmith.com/api/v1/';
 
+
 export class Flagsmith {
     environmentKey?: string;
     apiUrl: string = DEFAULT_API_URL;
     customHeaders?: { [key: string]: any };
     requestTimeoutSeconds?: number;
+    agent: RequestInit['agent'];
     requestTimeoutMs?: number;
     enableLocalEvaluation?: boolean = false;
     environmentRefreshIntervalSeconds: number = 60;
@@ -76,19 +79,8 @@ export class Flagsmith {
             flags cannot be retrieved from the API or a non existent feature is
             requested
      */
-    constructor(data: {
-        environmentKey: string;
-        apiUrl?: string;
-        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,
-    }) {
+    constructor(data: FlagsmithConfig) {
+        this.agent = data.agent;
         this.environmentKey = data.environmentKey;
         this.apiUrl = data.apiUrl || this.apiUrl;
         this.customHeaders = data.customHeaders;
@@ -276,6 +268,7 @@ export class Flagsmith {
         const data = await retryFetch(
             url,
             {
+                agent: this.agent,
                 method: method,
                 timeout: this.requestTimeoutMs || undefined,
                 body: JSON.stringify(body),

package/sdk/types.ts

@@ -1,8 +1,25 @@
-import { Flags } from "./models";
+import { DefaultFlag, Flags } from "./models";
+import { EnvironmentModel } from "../flagsmith-engine";
+import { RequestInit } from "node-fetch";
 
 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,
+}

package/sdk/utils.ts

@@ -1,4 +1,4 @@
-import fetch, { Response } from 'node-fetch';
+import fetch, { RequestInit, Response } from 'node-fetch';
 // @ts-ignore
 if (typeof fetch.default !== 'undefined') fetch = fetch.default;
 
@@ -18,7 +18,7 @@ export const delay = (ms: number) =>
 
 export const retryFetch = (
     url: string,
-    fetchOptions: any,
+    fetchOptions: RequestInit,
     retries = 3,
     timeout?: number // set an overall timeout for this function
 ): Promise<Response> => {