Merge branch 'master' into james/custom_condition_evaluators_OG

Michael Ng · web-flow · commit 4da5d4a8eb37 · 2019-06-19T15:24:38.000-07:00
diff --git a/packages/datafile-manager/CHANGELOG.md b/packages/datafile-manager/CHANGELOG.md
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 Changes that have landed but are not yet released.
 
+## [0.4.0] - June 12, 2019
+
+### Changed
+- Changed name of top-level exports in index.node.ts and index.browser.ts from `DatafileManager` to `HttpPollingDatafileManager`, to avoid name conflict with `DatafileManager` interface
+
 ## [0.3.0] - May 13, 2019
 
 ### New Features
diff --git a/packages/datafile-manager/__test__/httpPollingDatafileManager.spec.ts b/packages/datafile-manager/__test__/httpPollingDatafileManager.spec.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import HTTPPollingDatafileManager from '../src/httpPollingDatafileManager'
+import HttpPollingDatafileManager from '../src/httpPollingDatafileManager'
 import { Headers, AbortableRequest, Response } from '../src/http'
 import { DatafileManagerConfig } from '../src/datafileManager';
 import { advanceTimersByTime, getTimerCount } from './testUtils'
@@ -34,7 +34,7 @@ import BackoffController from '../src/backoffController'
 
 // Test implementation:
 //   - Does not make any real requests: just resolves with queued responses (tests push onto queuedResponses)
-class TestDatafileManager extends HTTPPollingDatafileManager {
+class TestDatafileManager extends HttpPollingDatafileManager {
   queuedResponses: (Response | Error)[] = []
 
   responsePromises: Promise<Response>[] = []
diff --git a/packages/datafile-manager/package.json b/packages/datafile-manager/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@optimizely/js-sdk-datafile-manager",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Optimizely Full Stack Datafile Manager",
   "license": "Apache-2.0",
   "engines": {
diff --git a/packages/datafile-manager/src/httpPollingDatafileManager.ts b/packages/datafile-manager/src/httpPollingDatafileManager.ts
@@ -34,7 +34,7 @@ function isSuccessStatusCode(statusCode: number): boolean {
   return statusCode >= 200 && statusCode < 400
 }
 
-export default abstract class HTTPPollingDatafileManager implements DatafileManager {
+export default abstract class HttpPollingDatafileManager implements DatafileManager {
   // Make an HTTP get request to the given URL with the given headers
   // Return an AbortableRequest, which has a promise for a Response.
   // If we can't get a response, the promise is rejected.
@@ -208,7 +208,7 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana
     }
   }
 
-  private onRequestComplete(this: HTTPPollingDatafileManager): void {
+  private onRequestComplete(this: HttpPollingDatafileManager): void {
     if (!this.isStarted) {
       return
     }
diff --git a/packages/datafile-manager/src/index.browser.ts b/packages/datafile-manager/src/index.browser.ts
@@ -15,5 +15,5 @@
  */
 
 export * from './datafileManager'
-export { default as DatafileManager } from './browserDatafileManager'
+export { default as HttpPollingDatafileManager } from './browserDatafileManager'
 export { default as StaticDatafileManager } from './staticDatafileManager';
diff --git a/packages/datafile-manager/src/index.node.ts b/packages/datafile-manager/src/index.node.ts
@@ -15,5 +15,5 @@
  */
 
 export * from './datafileManager'
-export { default as DatafileManager } from './nodeDatafileManager'
+export { default as HttpPollingDatafileManager } from './nodeDatafileManager'
 export { default as StaticDatafileManager } from './staticDatafileManager';
diff --git a/packages/event-processor/CHANGELOG.MD b/packages/event-processor/CHANGELOG.MD
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 Changes that have landed but are not yet released.
 
+## [0.2.1] - June 6, 2019
+
+- Wrap the `callback` in `try/catch` when implementing a custom `eventDispatcher`.  This ensures invoking the `callback` will always cleanup any pending retry tasks.
+
 ## [0.2.0] - March 27, 2019
 
 - Add `PendingEventsDispatcher` to wrap another EventDispatcher with retry support for
diff --git a/packages/event-processor/package-lock.json b/packages/event-processor/package-lock.json
diff --git a/packages/event-processor/package.json b/packages/event-processor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@optimizely/js-sdk-event-processor",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Optimizely Full Stack Event Processor",
   "author": "jordangarcia <jordan@optimizely.com>",
   "homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/event-processor",
diff --git a/packages/optimizely-sdk/lib/core/project_config/project_config_manager.js b/packages/optimizely-sdk/lib/core/project_config/project_config_manager.js
@@ -125,7 +125,7 @@ ProjectConfigManager.prototype.__initialize = function(config) {
     if (initialDatafile && this.__configObj) {
       datafileManagerConfig.datafile = initialDatafile;
     }
-    this.datafileManager = new datafileManager.DatafileManager(datafileManagerConfig);
+    this.datafileManager = new datafileManager.HttpPollingDatafileManager(datafileManagerConfig);
     this.datafileManager.start();
     this.__readyPromise = this.datafileManager.onReady().then(
       this.__onDatafileManagerReadyFulfill.bind(this),
diff --git a/packages/optimizely-sdk/lib/core/project_config/project_config_manager.tests.js b/packages/optimizely-sdk/lib/core/project_config/project_config_manager.tests.js
@@ -31,7 +31,7 @@ var LOG_MESSAGES = enums.LOG_MESSAGES;
 describe('lib/core/project_config/project_config_manager', function() {
   var globalStubErrorHandler;
   beforeEach(function() {
-    sinon.stub(datafileManager, 'DatafileManager').returns({
+    sinon.stub(datafileManager, 'HttpPollingDatafileManager').returns({
       start: sinon.stub(),
       stop: sinon.stub(),
       get: sinon.stub().returns(null),
@@ -50,7 +50,7 @@ describe('lib/core/project_config/project_config_manager', function() {
   });
 
   afterEach(function() {
-    datafileManager.DatafileManager.restore();
+    datafileManager.HttpPollingDatafileManager.restore();
     logging.resetErrorHandler();
     logging.resetLogger();
   });
@@ -187,8 +187,8 @@ describe('lib/core/project_config/project_config_manager', function() {
           updateInterval: 10000,
         },
       });
-      sinon.assert.calledOnce(datafileManager.DatafileManager);
-      sinon.assert.calledWithExactly(datafileManager.DatafileManager, sinon.match({
+      sinon.assert.calledOnce(datafileManager.HttpPollingDatafileManager);
+      sinon.assert.calledWithExactly(datafileManager.HttpPollingDatafileManager, sinon.match({
         datafile: testData.getTestProjectConfig(),
         sdkKey: '12345',
         autoUpdate: true,
@@ -199,7 +199,7 @@ describe('lib/core/project_config/project_config_manager', function() {
     describe('when constructed with sdkKey and without datafile', function() {
       it('updates itself when the datafile manager is ready, fulfills its onReady promise with a successful result, and then emits updates', function() {
         var configWithFeatures = testData.getTestProjectConfigWithFeatures();
-        datafileManager.DatafileManager.returns({
+        datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
           get: sinon.stub().returns(configWithFeatures),
@@ -231,7 +231,7 @@ describe('lib/core/project_config/project_config_manager', function() {
             variations: [{ key: 'variation', id: '99977477477747747' }],
           });
           nextDatafile.revision = '36';
-          var fakeDatafileManager = datafileManager.DatafileManager.getCall(0).returnValue;
+          var fakeDatafileManager = datafileManager.HttpPollingDatafileManager.getCall(0).returnValue;
           fakeDatafileManager.get.returns(nextDatafile);
           var updateListener = fakeDatafileManager.on.getCall(0).args[1];
           updateListener({ datafile: nextDatafile });
@@ -243,7 +243,7 @@ describe('lib/core/project_config/project_config_manager', function() {
       });
 
       it('calls onUpdate listeners after becoming ready, and after the datafile manager emits updates', function() {
-        datafileManager.DatafileManager.returns({
+        datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
           get: sinon.stub().returns(testData.getTestProjectConfigWithFeatures()),
@@ -258,7 +258,7 @@ describe('lib/core/project_config/project_config_manager', function() {
         return manager.onReady().then(function() {
           sinon.assert.calledOnce(onUpdateSpy);
 
-          var fakeDatafileManager = datafileManager.DatafileManager.getCall(0).returnValue;
+          var fakeDatafileManager = datafileManager.HttpPollingDatafileManager.getCall(0).returnValue;
           var updateListener = fakeDatafileManager.on.getCall(0).args[1];
           var newDatafile = testData.getTestProjectConfigWithFeatures();
           newDatafile.revision = '36';
@@ -270,7 +270,7 @@ describe('lib/core/project_config/project_config_manager', function() {
       });
 
       it('can remove onUpdate listeners using the function returned from onUpdate', function() {
-        datafileManager.DatafileManager.returns({
+        datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
           get: sinon.stub().returns(testData.getTestProjectConfigWithFeatures()),
@@ -284,7 +284,7 @@ describe('lib/core/project_config/project_config_manager', function() {
           var onUpdateSpy = sinon.spy();
           var unsubscribe = manager.onUpdate(onUpdateSpy);
 
-          var fakeDatafileManager = datafileManager.DatafileManager.getCall(0).returnValue;
+          var fakeDatafileManager = datafileManager.HttpPollingDatafileManager.getCall(0).returnValue;
           var updateListener = fakeDatafileManager.on.getCall(0).args[1];
           var newDatafile = testData.getTestProjectConfigWithFeatures();
           newDatafile.revision = '36';
@@ -308,7 +308,7 @@ describe('lib/core/project_config/project_config_manager', function() {
       it('fulfills its ready promise with an unsuccessful result when the datafile manager emits an invalid datafile', function() {
         var invalidDatafile = testData.getTestProjectConfig();
         delete invalidDatafile['projectId'];
-        datafileManager.DatafileManager.returns({
+        datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
           get: sinon.stub().returns(invalidDatafile),
@@ -327,7 +327,7 @@ describe('lib/core/project_config/project_config_manager', function() {
       });
 
       it('fullfils its ready promise with an unsuccessful result when the datafile manager onReady promise rejects', function() {
-        datafileManager.DatafileManager.returns({
+        datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
           get: sinon.stub().returns(null),
@@ -350,13 +350,13 @@ describe('lib/core/project_config/project_config_manager', function() {
           sdkKey: '12345',
         });
         manager.stop();
-        sinon.assert.calledOnce(datafileManager.DatafileManager.getCall(0).returnValue.stop);
+        sinon.assert.calledOnce(datafileManager.HttpPollingDatafileManager.getCall(0).returnValue.stop);
       });
     });
 
     describe('when constructed with sdkKey and with a valid datafile object', function() {
       it('fulfills its onReady promise with a successful result, and does not call onUpdate listeners after becoming ready', function() {
-        datafileManager.DatafileManager.returns({
+        datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
           get: sinon.stub().returns(testData.getTestProjectConfigWithFeatures()),
@@ -383,7 +383,7 @@ describe('lib/core/project_config/project_config_manager', function() {
 
     describe('when constructed with sdkKey and with a valid datafile string', function() {
       it('fulfills its onReady promise with a successful result, and does not call onUpdate listeners after becoming ready', function() {
-        datafileManager.DatafileManager.returns({
+        datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
           get: sinon.stub().returns(testData.getTestProjectConfigWithFeatures()),
diff --git a/packages/optimizely-sdk/lib/index.browser.js b/packages/optimizely-sdk/lib/index.browser.js
@@ -85,18 +85,26 @@ module.exports = {
         config.skipJSONValidation = true;
       }
 
-      var wrappedEventDispatcher = new eventProcessor.LocalStoragePendingEventsDispatcher({
-        eventDispatcher: config.eventDispatcher || defaultEventDispatcher,
-      });
-      if (!hasRetriedEvents) {
-        wrappedEventDispatcher.sendPendingEvents();
-        hasRetriedEvents = true;
+      var eventDispatcher;
+      // prettier-ignore
+      if (config.eventDispatcher == null) { // eslint-disable-line eqeqeq
+        // only wrap the event dispatcher with pending events retry if the user didnt override
+        eventDispatcher = new eventProcessor.LocalStoragePendingEventsDispatcher({
+          eventDispatcher: defaultEventDispatcher,
+        });
+
+        if (!hasRetriedEvents) {
+          eventDispatcher.sendPendingEvents();
+          hasRetriedEvents = true;
+        }
+      } else {
+        eventDispatcher = config.eventDispatcher;
       }
 
       config = fns.assignIn({
         clientEngine: enums.JAVASCRIPT_CLIENT_ENGINE,
       }, config, {
-        eventDispatcher: wrappedEventDispatcher,
+        eventDispatcher: eventDispatcher,
         // always get the OptimizelyLogger facade from logging
         logger: logger,
         errorHandler: logging.getErrorHandler(),
diff --git a/packages/optimizely-sdk/lib/index.browser.tests.js b/packages/optimizely-sdk/lib/index.browser.tests.js
@@ -62,7 +62,7 @@ describe('javascript-sdk', function() {
           requests.push(req);
         };
 
-        sinon.spy(LocalStoragePendingEventsDispatcher.prototype, 'sendPendingEvents');
+        sinon.stub(LocalStoragePendingEventsDispatcher.prototype, 'sendPendingEvents');
       });
 
       afterEach(function() {
@@ -73,11 +73,39 @@ describe('javascript-sdk', function() {
         xhr.restore();
       });
 
+      describe('when an eventDispatcher is not passed in', function() {
+        it('should wrap the default eventDispatcher and invoke sendPendingEvents', function() {
+          var optlyInstance = optimizelyFactory.createInstance({
+            datafile: {},
+            errorHandler: fakeErrorHandler,
+            logger: silentLogger,
+          });
+          // Invalid datafile causes onReady Promise rejection - catch this error
+          optlyInstance.onReady().catch(function() {});
+
+          sinon.assert.calledOnce(LocalStoragePendingEventsDispatcher.prototype.sendPendingEvents);
+        });
+      });
+
+      describe('when an eventDispatcher is passed in', function() {
+        it('should NOT wrap the default eventDispatcher and invoke sendPendingEvents', function() {
+          var optlyInstance = optimizelyFactory.createInstance({
+            datafile: {},
+            errorHandler: fakeErrorHandler,
+            eventDispatcher: fakeEventDispatcher,
+            logger: silentLogger,
+          });
+          // Invalid datafile causes onReady Promise rejection - catch this error
+          optlyInstance.onReady().catch(function() {});
+
+          sinon.assert.notCalled(LocalStoragePendingEventsDispatcher.prototype.sendPendingEvents);
+        });
+      });
+
       it('should invoke resendPendingEvents at most once', function() {
         var optlyInstance = optimizelyFactory.createInstance({
           datafile: {},
           errorHandler: fakeErrorHandler,
-          eventDispatcher: fakeEventDispatcher,
           logger: silentLogger,
         });
         // Invalid datafile causes onReady Promise rejection - catch this error
@@ -88,7 +116,6 @@ describe('javascript-sdk', function() {
         optlyInstance = optimizelyFactory.createInstance({
           datafile: {},
           errorHandler: fakeErrorHandler,
-          eventDispatcher: fakeEventDispatcher,
           logger: silentLogger,
         });
         optlyInstance.onReady().catch(function() {});
diff --git a/packages/optimizely-sdk/package-lock.json b/packages/optimizely-sdk/package-lock.json
diff --git a/packages/optimizely-sdk/package.json b/packages/optimizely-sdk/package.json
@@ -32,8 +32,8 @@
   },
   "homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/optimizely-sdk",
   "dependencies": {
-    "@optimizely/js-sdk-datafile-manager": "^0.3.0",
-    "@optimizely/js-sdk-event-processor": "^0.2.0",
+    "@optimizely/js-sdk-datafile-manager": "^0.4.0",
+    "@optimizely/js-sdk-event-processor": "^0.2.1",
     "@optimizely/js-sdk-logging": "^0.1.0",
     "@optimizely/js-sdk-utils": "^0.1.0",
     "json-schema": "^0.2.3",
diff --git a/packages/utils/CHANGELOG.MD b/packages/utils/CHANGELOG.MD
@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 Changes that have landed but are not yet released.
 
+### New Features
+- Added `objectEntries`
+
 ## [0.1.0] - March 1, 2019
 
-Initial release
+Initial release
diff --git a/packages/utils/__tests__/utils.spec.ts b/packages/utils/__tests__/utils.spec.ts
@@ -1,5 +1,5 @@
 /// <reference types="jest" />
-import { isValidEnum, groupBy, objectValues, find, keyBy, sprintf } from '../src'
+import { isValidEnum, groupBy, objectEntries, objectValues, find, keyBy, sprintf } from '../src'
 
 describe('utils', () => {
   describe('isValidEnum', () => {
@@ -37,6 +37,12 @@ describe('utils', () => {
     })
   })
 
+  describe('objectEntries', () => {
+    it('should return object entries', () => {
+      expect(objectEntries({ foo: 'bar', bar: 123 })).toEqual([['foo', 'bar'], ['bar', 123]])
+    })
+  })
+
   describe('objectValues', () => {
     it('should return object values', () => {
       expect(objectValues({ foo: 'bar', bar: 123 })).toEqual(['bar', 123])
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@optimizely/js-sdk-datafile-manager",`
`3`		`- "version": "0.3.0",`
	`3`	`+ "version": "0.4.0",`
`4`	`4`	`"description": "Optimizely Full Stack Datafile Manager",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"engines": {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ function isSuccessStatusCode(statusCode: number): boolean {`
`34`	`34`	`return statusCode >= 200 && statusCode < 400`
`35`	`35`	`}`
`36`	`36`
`37`		`-export default abstract class HTTPPollingDatafileManager implements DatafileManager {`
	`37`	`+export default abstract class HttpPollingDatafileManager implements DatafileManager {`
`38`	`38`	`// Make an HTTP get request to the given URL with the given headers`
`39`	`39`	`// Return an AbortableRequest, which has a promise for a Response.`
`40`	`40`	`// If we can't get a response, the promise is rejected.`
`@@ -208,7 +208,7 @@ export default abstract class HTTPPollingDatafileManager implements DatafileMana`
`208`	`208`	`}`
`209`	`209`	`}`
`210`	`210`
`211`		`- private onRequestComplete(this: HTTPPollingDatafileManager): void {`
	`211`	`+ private onRequestComplete(this: HttpPollingDatafileManager): void {`
`212`	`212`	`if (!this.isStarted) {`
`213`	`213`	`return`
`214`	`214`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@optimizely/js-sdk-event-processor",`
`3`		`- "version": "0.2.0",`
	`3`	`+ "version": "0.2.1",`
`4`	`4`	`"description": "Optimizely Full Stack Event Processor",`
`5`	`5`	`"author": "jordangarcia <jordan@optimizely.com>",`
`6`	`6`	`"homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/event-processor",`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ ProjectConfigManager.prototype.__initialize = function(config) {`
`125`	`125`	`if (initialDatafile && this.__configObj) {`
`126`	`126`	`datafileManagerConfig.datafile = initialDatafile;`
`127`	`127`	`}`
`128`		`- this.datafileManager = new datafileManager.DatafileManager(datafileManagerConfig);`
	`128`	`+ this.datafileManager = new datafileManager.HttpPollingDatafileManager(datafileManagerConfig);`
`129`	`129`	`this.datafileManager.start();`
`130`	`130`	`this.__readyPromise = this.datafileManager.onReady().then(`
`131`	`131`	`this.__onDatafileManagerReadyFulfill.bind(this),`