flagsmith-nodejs 2.0.2 → 2.1.0

package/example/package.json

@@ -20,5 +20,8 @@
     "ssg-node-express": "4.16.4",
     "ssg-util": "0.0.3"
   },
-  "keywords": []
+  "keywords": [],
+  "devDependencies": {
+    "nodemon": "^2.0.19"
+  }
 }

package/example/server/api/index.js

@@ -1,6 +1,8 @@
 const Router = require('express').Router;
 const Flagsmith = require('../../../build');
 const environmentKey = '';
+const nodecache = require("node-cache");
+
 if (!environmentKey) {
     throw new Error(
         'Please generate a Server Side SDK Key in environment settings to run the example'
@@ -9,9 +11,10 @@ if (!environmentKey) {
 const flagsmith = new Flagsmith({
     environmentKey,
     enableLocalEvaluation: true,
-    defaultFlagHandler: str => {
-        return { enabled: false, isDefault: true, value: null };
-    }
+    cache: new nodecache({
+        stdTTL: 10,
+        checkperiod: 10,
+    }),
 });
 
 module.exports = () => {

package/example/server/index.js

@@ -15,7 +15,7 @@ app.use(bodyParser.json());
 app.use('/api', api());
 
 app.server.listen(PORT);
-console.log('Server started on port ' + app.server.address().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');

package/flagsmith-engine/index.ts

@@ -6,6 +6,14 @@ import { getIdentitySegments } from './segments/evaluators';
 import { SegmentModel } from './segments/models';
 import { FeatureStateNotFound } from './utils/errors';
 
+export { EnvironmentModel } from './environments/models';
+export { IntegrationModel } from './environments/integrations/models';
+export { FeatureStateModel } from './features/models';
+export { IdentityModel } from './identities/models';
+export { TraitModel } from './identities/traits/models';
+export { SegmentModel } from './segments/models';
+export { OrganisationModel } from './organisations/models';
+
 function getIdentityFeatureStatesDict(
     environment: EnvironmentModel,
     identity: IdentityModel,

package/index.ts

@@ -1,6 +1,23 @@
 import Flagsmith from './sdk';
 
-export { Flagsmith } from './sdk';
-// export default Flagsmith;
+export {
+  AnalyticsProcessor,
+  FlagsmithAPIError,
+  FlagsmithClientError,
+  EnvironmentDataPollingManager,
+  FlagsmithCache,
+  DefaultFlag,
+  Flags
+} from './sdk';
+
+export {
+  EnvironmentModel,
+  IntegrationModel,
+  FeatureStateModel,
+  IdentityModel,
+  TraitModel,
+  SegmentModel,
+  OrganisationModel
+} from './flagsmith-engine';
 
 module.exports = Flagsmith;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "2.0.2",
+  "version": "2.1.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": {
@@ -46,7 +46,8 @@
     "test:watch": "jest --coverage --watch --coverageReporters='text'",
     "test:debug": "node --inspect-brk node_modules/.bin/jest --coverage --watch --coverageReporters='text'",
     "build": "tsc",
-    "prepublish": "npm i && npm run build",
+    "deploy": "npm i && npm run build && npm publish",
+    "deploy:beta": "npm i && npm run build && npm publish --tag beta",
     "prepare": "husky install"
   },
   "dependencies": {

package/sdk/analytics.ts

@@ -49,8 +49,8 @@ export class AnalyticsProcessor {
         this.lastFlushed = Date.now();
     }
 
-    trackFeature(featureId: number) {
-        this.analyticsData[featureId] = (this.analyticsData[featureId] || 0) + 1;
+    trackFeature(featureName: string) {
+        this.analyticsData[featureName] = (this.analyticsData[featureName] || 0) + 1;
         if (Date.now() - this.lastFlushed > ANALYTICS_TIMER * 1000) {
             this.flush();
         }

package/sdk/index.ts

@@ -14,6 +14,13 @@ import { SegmentModel } from '../flagsmith-engine/segments/models';
 import { getIdentitySegments } from '../flagsmith-engine/segments/evaluators';
 import { FlagsmithCache } 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';
+
 const DEFAULT_API_URL = 'https://edge.api.flagsmith.com/api/v1/';
 
 export class Flagsmith {
@@ -298,6 +305,7 @@ export class Flagsmith {
             defaultFlagHandler: this.defaultFlagHandler
         });
         if (!!this.cache) {
+            // @ts-ignore node-cache types are incorrect, ttl should be optional
             await this.cache.set('flags', flags);
         }
         return flags;
@@ -321,6 +329,7 @@ export class Flagsmith {
         });
 
         if (!!this.cache) {
+            // @ts-ignore node-cache types are incorrect, ttl should be optional
             await this.cache.set(`flags-${identifier}`, flags);
         }
 
@@ -336,6 +345,7 @@ export class Flagsmith {
                 defaultFlagHandler: this.defaultFlagHandler
             });
             if (!!this.cache) {
+                // @ts-ignore node-cache types are incorrect, ttl should be optional
                 await this.cache.set('flags', flags);
             }
             return flags;
@@ -361,6 +371,7 @@ export class Flagsmith {
                 defaultFlagHandler: this.defaultFlagHandler
             });
             if (!!this.cache) {
+                // @ts-ignore node-cache types are incorrect, ttl should be optional
                 await this.cache.set(`flags-${identifier}`, flags);
             }
             return flags;
@@ -383,3 +394,4 @@ export class Flagsmith {
 }
 
 export default Flagsmith;
+

package/sdk/models.ts

@@ -129,7 +129,7 @@ export class Flags {
         }
 
         if (this.analyticsProcessor && flag.featureId) {
-            this.analyticsProcessor.trackFeature(flag.featureId);
+            this.analyticsProcessor.trackFeature(flag.featureName);
         }
 
         return flag;

package/sdk/types.ts

@@ -1,8 +1,8 @@
 import { Flags } from "./models";
 
 export interface FlagsmithCache {
-  get(key: string): Promise<Flags>;
-  set(key: string, value: Flags): Promise<void>;
-  has(key: string): Promise<boolean>;
+  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;
-}
+}

package/tests/sdk/analytics.test.ts

@@ -8,28 +8,28 @@ afterEach(() => {
 
 test('test_analytics_processor_track_feature_updates_analytics_data', () => {
     const aP = analyticsProcessor();
-    aP.trackFeature(1);
-    expect(aP.analyticsData[1]).toBe(1);
+    aP.trackFeature("myFeature");
+    expect(aP.analyticsData["myFeature"]).toBe(1);
 
-    aP.trackFeature(1);
-    expect(aP.analyticsData[1]).toBe(2);
+    aP.trackFeature("myFeature");
+    expect(aP.analyticsData["myFeature"]).toBe(2);
 });
 
 test('test_analytics_processor_flush_clears_analytics_data', async () => {
     const aP = analyticsProcessor();
-    aP.trackFeature(1);
+    aP.trackFeature("myFeature");
     await aP.flush();
     expect(aP.analyticsData).toStrictEqual({});
 });
 
 test('test_analytics_processor_flush_post_request_data_match_ananlytics_data', async () => {
     const aP = analyticsProcessor();
-    aP.trackFeature(1);
-    aP.trackFeature(2);
+    aP.trackFeature("myFeature1");
+    aP.trackFeature("myFeature2");
     await aP.flush();
     expect(fetch).toHaveBeenCalledTimes(1);
     expect(fetch).toHaveBeenCalledWith('http://testUrlanalytics/flags/', {
-        body: '{"1":1,"2":1}',
+        body: '{"myFeature1":1,"myFeature2":1}',
         headers: { 'Content-Type': 'application/json', 'X-Environment-Key': 'test-key' },
         method: 'POST',
         timeout: 3
@@ -39,9 +39,9 @@ test('test_analytics_processor_flush_post_request_data_match_ananlytics_data', a
 jest.useFakeTimers()
 test('test_analytics_processor_flush_post_request_data_match_ananlytics_data_test', async () => {
     const aP = analyticsProcessor();
-    aP.trackFeature(1);
+    aP.trackFeature("myFeature1");
     setTimeout(() => {
-        aP.trackFeature(2);
+        aP.trackFeature("myFeature2");
         expect(fetch).toHaveBeenCalledTimes(1);
     }, 15000);
     jest.runOnlyPendingTimers();

package/tests/sdk/utils.ts

@@ -18,8 +18,9 @@ export class TestCache implements FlagsmithCache {
         return !!this.cache[name];
     }
 
-    async set(name: string, value: Flags) {
+    async set(name: string, value: Flags, ttl: number|string) {
         this.cache[name] = value;
+        return true
     }
 }