featureflow-node-sdk 0.6.4 → 0.6.8

package/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Change log
+## [0.6.4] - 2018-012-18
+### Changed
+- Simplify express middleware
+- Update url to events.featureflow.io for events
+- Improve polling time
+- Update readme
 ## [0.5.5] - 2017-07-14
 ### Changed
 - Updated tests

package/README.md

@@ -2,6 +2,8 @@
 
 [![][npm-img]][npm-url]
 
+[![Featureflow](https://circleci.com/gh/featureflow/featureflow-node-sdk.svg?style=svg)](https://circleci.com/gh/featureflow/featureflow-node-sdk)
+
 [![][dependency-img]][dependency-url]
 
 > Featureflow Node SDK
@@ -12,6 +14,14 @@ Get your Featureflow account at [featureflow.io](http://www.featureflow.io)
 
 The easiest way to get started is to follow the [Featureflow quick start guides](http://docs.featureflow.io/docs)
 
+## Examples
+
+Express: [here](https://github.com/featureflow/featureflow-node-example)
+
+NextJS: [here](https://github.com/featureflow/featureflow-example-nextjs)
+
+5 Minute: [here](https://github.com/featureflow/featureflow-fiveminute-node) [(docs)](https://docs.featureflow.io/docs/nodejs-5-minute-test)
+
 ## Change Log
 
 Please see [CHANGELOG](https://github.com/featureflow/featureflow-node-sdk/blob/master/CHANGELOG.md).

package/dist/Client.js

@@ -105,6 +105,34 @@ var Featureflow = function (_EventEmitter) {
                 });
             }
         }
+    }, {
+        key: 'evaluateAll',
+        value: function (_evaluateAll) {
+            function evaluateAll() {
+                return _evaluateAll.apply(this, arguments);
+            }
+
+            evaluateAll.toString = function () {
+                return _evaluateAll.toString();
+            };
+
+            return evaluateAll;
+        }(function () {
+            return evaluateAll('anonymous');
+        })
+    }, {
+        key: 'evaluateAll',
+        value: function evaluateAll(user) {
+            var evaluatedFeatures = {};
+            var features = this.config.featureStore.getAll();
+            for (var p in features) {
+                if (features.hasOwnProperty(p)) {
+                    var value = this.evaluate(p, user).value();
+                    evaluatedFeatures[p] = value;
+                }
+            }
+            return evaluatedFeatures;
+        }
     }, {
         key: 'evaluate',
         value: function (_evaluate) {

package/dist/Conditions.js

@@ -27,10 +27,20 @@ var operators = {
     return typeof a === 'string' && Array.isArray(b) && b.indexOf(a) < 0;
   },
   before: function before(a, b) {
-    return a < b;
+    a = dateParse(a);
+    b = dateParse(b);
+    if (typeof a === 'number' && typeof b === 'number') {
+      return a < b;
+    }
+    return false;
   },
   after: function after(a, b) {
-    return a > b;
+    a = dateParse(a);
+    b = dateParse(b);
+    if (typeof a === 'number' && typeof b === 'number') {
+      return a > b;
+    }
+    return false;
   },
   greaterThan: function greaterThan(a, b) {
     return a > b;
@@ -46,6 +56,16 @@ var operators = {
   }
 };
 
+function dateParse(date) {
+  if (typeof date === 'string') {
+    return Date.parse(date);
+  }
+  if (date instanceof Date) {
+    return date.getTime();
+  }
+  return date;
+}
+
 var notFound = function notFound() {
   return false;
 };

package/dist/Evaluate.js

@@ -30,13 +30,14 @@ var Evaluate = function () {
       return this.is('on');
     }
   }, {
-    key: 'ifOff',
-    value: function ifOff() {
+    key: 'isOff',
+    value: function isOff() {
       return this.is('off');
     }
   }, {
     key: 'value',
     value: function value() {
+      this.eventsClient.evaluateEvent(this.featureKey, this.evaluatedVariant, null, this.user);
       return this.evaluatedVariant;
     }
   }]);

package/dist/EvaluateHelpers.js

@@ -31,6 +31,14 @@ function featureEvaluation(feature, user) {
   }
 
   if (feature.enabled) {
+    var now = new Date();
+    var hourOfDay = now.getHours();
+    var hArray = new Array(1);
+    hArray[0] = hourOfDay;
+    user.attributes['featureflow.user.id'] = [user.id];
+    user.attributes['featureflow.date'] = [new Date().toISOString()];
+    user.attributes['featureflow.hourofday'] = hArray;
+
     for (var i in feature.rules) {
       var rule = feature.rules[i];
       if (ruleMatches(feature.rules[i], user)) {
@@ -44,7 +52,7 @@ function featureEvaluation(feature, user) {
 }
 
 function ruleMatches(rule, user) {
-  if (rule.defaultRule) {
+  if (!rule.audience) {
     return true;
   } else {
     for (var cKey in rule.audience.conditions) {

package/dist/EventsClient.js

@@ -1,7 +1,7 @@
 'use strict';
 
 Object.defineProperty(exports, "__esModule", {
-  value: true
+    value: true
 });
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
@@ -19,64 +19,97 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 var EventsClient = function () {
-  function EventsClient(apiKey) {
-    var eventsUrl = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "https://events.featureflow.io";
-    var disabled = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-
-    _classCallCheck(this, EventsClient);
-
-    this.DEFAULT_TIMEOUT = 5 * 1000;
-    this.clientVersion = 'NodeJsClient/0.6.4';
-
-    this.apiKey = apiKey;
-    this.eventsUrl = eventsUrl;
-    this.disabled = disabled;
-    this.timeout = this.DEFAULT_TIMEOUT;
-  }
-
-  _createClass(EventsClient, [{
-    key: 'registerFeaturesEvent',
-    value: function registerFeaturesEvent(features) {
-      this.sendEvent('Register Features', 'PUT', this.eventsUrl + '/api/sdk/v1/register', features);
-    }
-  }, {
-    key: 'evaluateEvent',
-    value: function evaluateEvent(featureKey, evaluatedVariant, expectedVariant, user) {
-      this.sendEvent('evaluate', 'POST', this.eventsUrl + '/api/sdk/v1/events', [{
-        featureKey: featureKey,
-        evaluatedVariant: evaluatedVariant,
-        expectedVariant: expectedVariant,
-        user: user
-      }]);
+    function EventsClient(apiKey) {
+        var _this = this;
+
+        var eventsUrl = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "https://events.featureflow.io";
+        var disabled = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+
+        _classCallCheck(this, EventsClient);
+
+        this.SEND_INTERVAL = 5;
+        this.QUEUE_SIZE = 10000;
+        this.clientVersion = 'NodeJsClient/0.6.6';
+        this.queue = [];
+        this.overLimit = false;
+
+        this.apiKey = apiKey;
+        this.eventsUrl = eventsUrl;
+        this.disabled = disabled;
+        this.sendInterval = this.SEND_INTERVAL;
+        this.interval = setInterval(function () {
+            _this.sendQueue();
+        }, this.sendInterval * 1000);
     }
-  }, {
-    key: 'sendEvent',
-    value: function sendEvent(eventType, method, url, json) {
-
-      if (this.disabled) {
-        return;
-      }
-      (0, _request2.default)({
-        method: method,
-        uri: url,
-        json: json,
-        headers: {
-          'Authorization': 'Bearer ' + this.apiKey,
-          'X-Featureflow-Client': this.clientVersion
+
+    _createClass(EventsClient, [{
+        key: 'registerFeaturesEvent',
+        value: function registerFeaturesEvent(features) {
+            this.sendEvent('Register Features', 'PUT', this.eventsUrl + '/api/sdk/v1/register', features);
         }
-      }, function (error, response, body) {
-        if (error) {
-          (0, _debug2.default)('error %s to "%s". message:', method, url, error.message);
-          return;
+    }, {
+        key: 'evaluateEvent',
+        value: function evaluateEvent(featureKey, evaluatedVariant, expectedVariant, user) {
+            this.queueEvaluateEvent({
+                featureKey: featureKey,
+                evaluatedVariant: evaluatedVariant,
+                expectedVariant: expectedVariant,
+                user: user
+            });
         }
-        if (response.statusCode >= 400) {
-          (0, _debug2.default)("unable to send event %s to %s. Failed with response status %d", eventType, url, response.statusCode);
+    }, {
+        key: 'queueEvaluateEvent',
+        value: function queueEvaluateEvent(event) {
+            if (this.queue.length < this.QUEUE_SIZE) {
+                this.queue.push(event);
+                this.overLimit = false;
+            } else {
+                this.overLimit = true;
+                (0, _debug2.default)('Event queue limit exceeded. Increase queue size to prevent dropping events.', method, url, "Event Queue Exceeded");
+            }
         }
-      });
-    }
-  }]);
+    }, {
+        key: 'sendQueue',
+        value: function sendQueue() {
+            if (this.queue.length === 0) return;
+            var sendQueue = this.queue;
+            this.queue = [];
+
+            this.sendEvent('evaluate', 'POST', this.eventsUrl + '/api/sdk/v1/events', sendQueue);
+        }
+    }, {
+        key: 'sendEvent',
+        value: function sendEvent(eventType, method, url, json) {
+
+            if (this.disabled) {
+                return;
+            }
+            (0, _request2.default)({
+                method: method,
+                uri: url,
+                json: json,
+                headers: {
+                    'Authorization': 'Bearer ' + this.apiKey,
+                    'X-Featureflow-Client': this.clientVersion
+                }
+            }, function (error, response, body) {
+                if (error) {
+                    (0, _debug2.default)('error %s to "%s". message:', method, url, error.message);
+                    return;
+                }
+                if (response.statusCode >= 400) {
+                    (0, _debug2.default)("unable to send event %s to %s. Failed with response status %d", eventType, url, response.statusCode);
+                }
+            });
+        }
+    }, {
+        key: 'close',
+        value: function close() {
+            clearInterval(this.interval);
+        }
+    }]);
 
-  return EventsClient;
+    return EventsClient;
 }();
 
 exports.default = EventsClient;

package/dist/FeatureStore.js

@@ -38,6 +38,11 @@ var InMemoryFeatureStore = exports.InMemoryFeatureStore = function () {
         this.features[key] = _extends({}, features[key]);
       }
     }
+  }, {
+    key: "getAll",
+    value: function getAll() {
+      return this.features;
+    }
   }]);
 
   return InMemoryFeatureStore;

package/dist/PollingClient.js

@@ -24,22 +24,25 @@ var PollingClient = function () {
 
     this.DEFAULT_TIMEOUT = 5 * 1000;
     this.DEFAULT_INTERVAL = 10 * 1000;
-    this.clientVersion = 'NodeJsClient/0.6.4';
+    this.clientVersion = 'NodeJsClient/0.6.6';
 
     this.url = url;
     this.apiKey = config.apiKey;
     this.featureStore = config.featureStore;
-
-    this.etag = "";
-
-    this.timeout = this.DEFAULT_TIMEOUT;
     this.interval = this.DEFAULT_INTERVAL;
+    if (config.interval && config.interval > 5 || config.interval == 0) {
+      this.interval = config.interval * 1000;
+    }
+    this.timeout = this.DEFAULT_TIMEOUT;
+    this.etag = "";
 
     this.getFeatures(callback);
-
-    var interval = setInterval(this.getFeatures.bind(this), this.interval);
-
-    return clearInterval.bind(this, interval);
+    if (this.interval > 0) {
+      var interval = setInterval(this.getFeatures.bind(this), this.interval);
+      return clearInterval.bind(this, interval);
+    } else {
+      (0, _debug2.default)("Polling interval set to 0. Featureflow will NOT poll for feature changes.");
+    }
   }
 
   _createClass(PollingClient, [{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "featureflow-node-sdk",
-  "version": "0.6.4",
+  "version": "0.6.8",
   "description": "Featureflow sdk for Node",
   "main": "dist/index.js",
   "engines": {
@@ -14,6 +14,7 @@
     "watch": "babel --watch src -d dist",
     "prepublish": "npm run build",
     "test": "cucumber.js --compiler js:babel-core/register --tags \"not @ignore and not @integration\"",
+    "ci-test": "cucumber.js --format json:./cucumber/tests.cucumber --compiler js:babel-core/register --tags \"not @ignore and not @integration\"",
     "test:integration": "cucumber.js --compiler js:babel-core/register --tags \"@integration\""
   },
   "repository": {
@@ -33,8 +34,8 @@
     "sha1-hex": "^1.0.0"
   },
   "devDependencies": {
-    "babel-cli": "^6.24.0",
-    "babel-core": "^6.24.0",
+    "babel-cli": "^6.26.0",
+    "babel-core": "^6.26.0",
     "babel-plugin-transform-flow-strip-types": "^6.22.0",
     "babel-plugin-transform-object-rest-spread": "^6.23.0",
     "babel-preset-es2015": "^6.24.0",