flagsmith-nodejs 2.2.2-beta.2 → 2.3.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.5.5",
+    "@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 '../../../build'
+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/index.ts

@@ -1,3 +1,5 @@
+import Flagsmith from "./sdk";
+
 export {
   AnalyticsProcessor,
   FlagsmithAPIError,
@@ -18,3 +20,5 @@ export {
   SegmentModel,
   OrganisationModel
 } from './flagsmith-engine';
+
+module.exports = Flagsmith;

package/package.json

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

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/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