flagsmith-nodejs 1.0.9 → 2.0.0-beta.1

package/tests/sdk/polling.test.ts

@@ -0,0 +1,34 @@
+import { Flagsmith } from '../../sdk';
+import { EnvironmentDataPollingManager } from '../../sdk/polling_manager';
+import { delay } from '../../sdk/utils';
+jest.mock('../../sdk');
+jest.mock('node-fetch');
+
+beforeEach(() => {
+    // @ts-ignore
+    Flagsmith.mockClear();
+});
+
+test('test_polling_manager_calls_update_environment_on_start', async () => {
+    const flagsmith = new Flagsmith({
+        environmentKey: 'key'
+    });
+
+    const pollingManager = new EnvironmentDataPollingManager(flagsmith, 0.1);
+    pollingManager.start();
+    await delay(500);
+    pollingManager.stop();
+    expect(flagsmith.updateEnvironment).toHaveBeenCalled();
+});
+
+test('test_polling_manager_calls_update_environment_on_each_refresh', async () => {
+    const flagsmith = new Flagsmith({
+        environmentKey: 'key'
+    });
+
+    const pollingManager = new EnvironmentDataPollingManager(flagsmith, 0.1);
+    pollingManager.start();
+    await delay(450);
+    pollingManager.stop();
+    expect(flagsmith.updateEnvironment).toHaveBeenCalledTimes(5);
+});

package/tests/sdk/utils.ts

@@ -0,0 +1,39 @@
+import { readFileSync } from 'fs';
+import { buildEnvironmentModel } from '../../flagsmith-engine/environments/util';
+import { AnalyticsProcessor } from '../../sdk/analytics';
+import { Flagsmith } from '../../sdk';
+
+const DATA_DIR = __dirname + '/data/';
+
+export function analyticsProcessor() {
+    return new AnalyticsProcessor({
+        environmentKey: 'test-key',
+        baseApiUrl: 'http://testUrl'
+    });
+}
+
+export function apiKey(): string {
+    return 'sometestfakekey';
+}
+
+export function flagsmith() {
+    return new Flagsmith({
+        environmentKey: apiKey()
+    });
+}
+
+export function environmentJSON() {
+    return readFileSync(DATA_DIR + 'environment.json', 'utf-8');
+}
+
+export function environmentModel(environmentJSON: any) {
+    return buildEnvironmentModel(environmentJSON);
+}
+
+export function flagsJSON() {
+    return readFileSync(DATA_DIR + 'flags.json', 'utf-8');
+}
+
+export function identitiesJSON() {
+    return readFileSync(DATA_DIR + 'identities.json', 'utf-8');
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "include": [
+    "./flagsmith-engine",
+    "./sdk",
+    "./index.ts"
+  ],
+  "compilerOptions": {
+    "outDir": "./build",
+    "target": "ESNext",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "declaration": true,
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}

package/flagsmith-core.js

@@ -1,238 +0,0 @@
-let fetch;
-
-const FlagsmithCore = class {
-
-    constructor(props) {
-        fetch = props.fetch;
-
-        this.checkFeatureEnabled = this.checkFeatureEnabled.bind(this);
-        this.getFlags = this.getFlags.bind(this);
-        this.getFlagsForUser = this.getFlagsForUser.bind(this);
-        this.getUserIdentity = this.getUserIdentity.bind(this);
-        this.getValue = this.getValue.bind(this);
-        this.getValueFromFeatures = this.getValueFromFeatures.bind(this);
-        this.hasFeature = this.hasFeature.bind(this);
-        this.init = this.init.bind(this);
-
-        this.getJSON = function (url, method, body) {
-            const { environmentID } = this;
-            const options = {
-                method: method || 'GET',
-                body,
-                headers: {
-                    'x-environment-key': environmentID
-                }
-            };
-            if (method !== "GET") {
-                options.headers['Content-Type'] = 'application/json; charset=utf-8';
-            }
-            return fetch(url, options)
-                .then(res => {
-                    return res.json()
-                    .then(result => {
-                        if (res.status < 200 || res.status >= 400) {
-                            Promise.reject(new Error(result.detail))
-                        } else return result;
-                    })
-                });
-        };
-    }
-
-    getFlagsForUser (identity) {
-        const { onError, api } = this;
-
-        if (!identity) {
-            onError && onError({message: 'getFlagsForUser() called without a user identity'});
-            return Promise.reject('getFlagsForUser() called without a user identity');
-        }
-
-        const handleResponse = (res) => {
-            // Handle server response
-            let flags = {};
-            res.flags.forEach(feature => {
-                flags[feature.feature.name.toLowerCase().replace(/ /g, '_')] = {
-                    enabled: feature.enabled,
-                    value: feature.feature_state_value
-                };
-            });
-            return flags;
-        };
-
-        return this.getJSON(api + 'identities/?identifier=' + identity)
-            .then(res => {
-                return handleResponse(res);
-            }).catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-
-    getUserIdentity (identity) {
-        const { onError, api } = this;
-
-        if (!identity) {
-            onError && onError({message: 'getUserIdentity() called without a user identity'});
-            return Promise.reject('getUserIdentity() called without a user identity');
-        }
-
-        const handleResponse = (res) => {
-            // Handle server response
-            let flags = {};
-            let traits = {};
-            res.flags.forEach(feature => {
-                flags[feature.feature.name.toLowerCase().replace(/ /g, '_')] = {
-                    enabled: feature.enabled,
-                    value: feature.feature_state_value
-                };
-            });
-            res.traits.forEach(({trait_key, trait_value}) => {
-                traits[trait_key.toLowerCase().replace(/ /g, '_')] = trait_value;
-            });
-            return { flags, traits };
-        };
-
-        return this.getJSON(api + 'identities/?identifier=' + identity)
-            .then(res => {
-                return handleResponse(res);
-            }).catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-
-    getFlags() {
-        const { onError, api } = this;
-
-        const handleResponse = (res) => {
-            // Handle server response
-            let flags = {};
-            res.forEach(feature => {
-                flags[feature.feature.name.toLowerCase().replace(/ /g, '_')] = {
-                    enabled: feature.enabled,
-                    value: feature.feature_state_value
-                };
-            });
-            return flags;
-        };
-
-        return this.getJSON(api + "flags/")
-            .then(res => {
-                return handleResponse(res);
-            }).catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    };
-
-    init({
-             environmentID,
-             api,
-             disableCache,
-             onError,
-         }) {
-        if (!environmentID) {
-            throw new Error('Please specify a environment id');
-        }
-
-        this.environmentID = environmentID;
-
-        this.api = api || "https://api.bullet-train.io/api/v1/";
-        this.disableCache = disableCache;
-        this.onError = onError;
-    }
-
-    getValue (key, userId) {
-        if (userId) {
-            return this.getFlagsForUser(userId).then((flags) => {
-                return this.getValueFromFeatures(key, flags);
-            })
-        } else {
-            return this.getFlags().then((flags) => {
-                return this.getValueFromFeatures(key, flags);
-            });
-        }
-    }
-
-    hasFeature (key, userId) {
-        if (userId) {
-            return this.getFlagsForUser(userId).then((flags) => {
-                return this.checkFeatureEnabled(key, flags);
-            })
-        } else {
-            return this.getFlags().then((flags) => {
-                return this.checkFeatureEnabled(key, flags);
-            });
-        }
-    }
-
-    getValueFromFeatures (key, flags) {
-        if (!flags) {
-            return null;
-        }
-        const flag = flags[key];
-        let res = null;
-        if (flag) {
-            res = flag.value;
-        }
-        //todo record check for value
-
-        return res;
-    }
-
-    checkFeatureEnabled (key, flags) {
-        if (!flags) {
-            return false;
-        }
-        const flag = flags[key];
-        let res = false;
-        if (flag && flag.enabled) {
-            res = true;
-        }
-
-        return res;
-    }
-
-    getTrait (identity, key) {
-        const { onError } = this;
-
-        if (!identity || !key) {
-            onError && onError({message: `getTrait() called without a ${!identity ? 'user identity' : 'trait key'}`});
-            return Promise.reject(`getTrait() called without a ${!identity ? 'user identity' : 'trait key'}`);
-        }
-
-        return this.getUserIdentity(identity)
-            .then(({traits}) => traits[key])
-            .catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-
-    setTrait (identity, key, value) {
-        const { onError, api } = this;
-
-        if (!identity || !key) {
-            onError && onError({message: `setTrait() called without a ${!identity ? 'user identity' : 'trait key'}`});
-            return Promise.reject(`setTrait() called without a ${!identity ? 'user identity' : 'trait key'}`);
-        }
-
-        const body = {
-            "identity": {
-                "identifier": identity
-            },
-            "trait_key": key,
-            "trait_value": value
-        }
-
-        return this.getJSON(`${api}traits/`, 'POST', JSON.stringify(body))
-            .then(() => this.getUserIdentity(identity))
-            .catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-};
-
-module.exports = function ({ fetch }) {
-    return new FlagsmithCore({ fetch });
-};

package/index.d.ts

@@ -1,78 +0,0 @@
-declare module 'flagsmith-nodejs' {
-    /**
-     * Initialise the sdk against a particular environment
-     */
-    export function init(config: {
-        environmentID: string
-        onError?: Function
-        defaultFlags?: string[]
-        api?: string
-    }): void
-
-    /**
-     * Get the whether a flag is enabled e.g. flagsmith.hasFeature("powerUserFeature")
-     */
-    export function hasFeature(key: string): Promise<boolean>
-
-    /**
-     * Get the value of a whether a flag is enabled for a user e.g. flagsmith.hasFeature("powerUserFeature", 1234)
-     */
-    export function hasFeature(key: string, userId: string): Promise<boolean>
-
-    /**
-     * Get the value of a particular remote config e.g. flagsmith.getValue("font_size")
-     */
-    export function getValue(key: string): Promise<string|number|boolean>
-
-    /**
-     * Get the value of a particular remote config for a specified user e.g. flagsmith.getValue("font_size", 1234)
-     */
-    export function getValue(key: string, userId: string): Promise<string|number|boolean>
-
-    /**
-     * Trigger a manual fetch of the environment features
-     */
-    export function getFlags(): Promise<IFlags>
-
-    /**
-     * Trigger a manual fetch of the environment features for a given user id
-     */
-    export function getFlagsForUser(userId: string): Promise<IFlags>
-
-    /**
-     * Trigger a manual fetch of both the environment features and users' traits for a given user id
-     */
-    export function getUserIdentity(userId: string): Promise<IUserIdentity>
-
-    /**
-     * Trigger a manual fetch of a specific trait for a given user id
-     */
-    export function getTrait(userId: string, key: string): Promise<ITraits>
-
-    /**
-     * Set a specific trait for a given user id
-     */
-    export function setTrait(
-        userId: string,
-        key: string,
-        value: string|number|boolean
-    ): IUserIdentity
-
-    interface IFeature {
-        enabled: boolean
-        value?: string|number|boolean
-    }
-
-    interface IFlags {
-        [key: string]: IFeature
-    }
-
-    interface ITraits {
-        [key: string]: string
-    }
-
-    interface IUserIdentity {
-        flags: IFeature
-        traits: ITraits
-    }
-}

package/index.js

@@ -1,5 +0,0 @@
-const fetch = require('node-fetch').default;
-const core = require('./flagsmith-core');
-const flagsmith = core({fetch: fetch});
-
-module.exports = flagsmith;