From 3830d67ff374604a88da4297caa45b7d6e4ac1d2 Mon Sep 17 00:00:00 2001 From: Brandon David Date: Thu, 27 Jun 2019 13:56:00 -0700 Subject: [PATCH 1/2] Update lodash dependency to ^4.17.11 (#297) * update lodash dependency to ^4.17.11 * update changelog --- packages/optimizely-sdk/package-lock.json | 45 +++++++++++++++++------ packages/optimizely-sdk/package.json | 2 +- 2 files changed, 34 insertions(+), 13 deletions(-) diff --git a/packages/optimizely-sdk/package-lock.json b/packages/optimizely-sdk/package-lock.json index 88f06ac73..a8ec2314e 100644 --- a/packages/optimizely-sdk/package-lock.json +++ b/packages/optimizely-sdk/package-lock.json @@ -299,6 +299,7 @@ "resolved": "https://registry.npmjs.org/align-text/-/align-text-0.1.4.tgz", "integrity": "sha1-DNkKVhCT810KmSVsIrcGlDP60Rc=", "dev": true, + "optional": true, "requires": { "kind-of": "^3.0.2", "longest": "^1.0.1", @@ -2355,7 +2356,8 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true + "dev": true, + "optional": true }, "aproba": { "version": "1.2.0", @@ -2379,13 +2381,15 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", - "dev": true + "dev": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -2402,19 +2406,22 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", - "dev": true + "dev": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", "integrity": "sha1-PXz0Rk22RG6mRL9LOVB/mFEAjo4=", - "dev": true + "dev": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -2545,7 +2552,8 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", - "dev": true + "dev": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -2559,6 +2567,7 @@ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", "dev": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -2575,6 +2584,7 @@ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", "dev": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } @@ -2583,13 +2593,15 @@ "version": "0.0.8", "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", - "dev": true + "dev": true, + "optional": true }, "minipass": { "version": "2.2.4", "resolved": "https://registry.npmjs.org/minipass/-/minipass-2.2.4.tgz", "integrity": "sha512-hzXIWWet/BzWhYs2b+u7dRHlruXhwdgvlTMDKC6Cb1U7ps6Ac6yQlR39xsbjWJE377YTCtKwIXIpJ5oP+j5y8g==", "dev": true, + "optional": true, "requires": { "safe-buffer": "^5.1.1", "yallist": "^3.0.0" @@ -2610,6 +2622,7 @@ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", "dev": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -2698,7 +2711,8 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", - "dev": true + "dev": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -2712,6 +2726,7 @@ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", "dev": true, + "optional": true, "requires": { "wrappy": "1" } @@ -2807,7 +2822,8 @@ "version": "5.1.1", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz", "integrity": "sha512-kKvNJn6Mm93gAczWVJg7wH+wGYWNrDHdWvpUmHyEsgCtIwwo3bqPtV4tR5tuPaUhTOo/kvhVwd8XwwOllGYkbg==", - "dev": true + "dev": true, + "optional": true }, "safer-buffer": { "version": "2.1.2", @@ -2849,6 +2865,7 @@ "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", "dev": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", @@ -2870,6 +2887,7 @@ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", "dev": true, + "optional": true, "requires": { "ansi-regex": "^2.0.0" } @@ -2918,13 +2936,15 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", - "dev": true + "dev": true, + "optional": true }, "yallist": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.0.2.tgz", "integrity": "sha1-hFK0u36Dx8GI2AQcGoN8dz1ti7k=", - "dev": true + "dev": true, + "optional": true } } }, @@ -4571,7 +4591,8 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/longest/-/longest-1.0.1.tgz", "integrity": "sha1-MKCy2jj3N3DoKUoNIuZiXtd9AJc=", - "dev": true + "dev": true, + "optional": true }, "loud-rejection": { "version": "1.6.0", diff --git a/packages/optimizely-sdk/package.json b/packages/optimizely-sdk/package.json index 8be249a30..b1a27e149 100644 --- a/packages/optimizely-sdk/package.json +++ b/packages/optimizely-sdk/package.json @@ -37,7 +37,7 @@ "@optimizely/js-sdk-logging": "^0.1.0", "@optimizely/js-sdk-utils": "^0.1.0", "json-schema": "^0.2.3", - "lodash": "^4.0.0", + "lodash": "^4.17.11", "murmurhash": "0.0.2", "promise-polyfill": "8.1.0", "uuid": "^3.3.2" From 321deadf172ef66888db2cca96fca87689113333 Mon Sep 17 00:00:00 2001 From: Jordan Garcia Date: Wed, 12 Jun 2019 09:58:24 -0700 Subject: [PATCH 2/2] Dont use pendingEventsDispatcher with user defined eventDispatcher (#289) * Dont use pendingEventsDispatcher with user defined eventDispatcher * Update test --- packages/optimizely-sdk/lib/index.browser.js | 22 +++++++++---- .../optimizely-sdk/lib/index.browser.tests.js | 33 +++++++++++++++++-- 2 files changed, 45 insertions(+), 10 deletions(-) diff --git a/packages/optimizely-sdk/lib/index.browser.js b/packages/optimizely-sdk/lib/index.browser.js index cde323a96..458ef532b 100644 --- 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 index 49bb18af8..aae732d62 100644 --- 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() {});