Add onInit hook, drop json3, update build dependencies (#178)

blazzy · web-flow · commit cd7bfce22d16 · 2019-03-12T16:35:52.000-07:00
* Drop json3 polyfill and update build dependencies

* fix uri tests and build

* add onInit hook to invoke callbacks after init

* Add onInit to snippet

* Clear onInit queue
diff --git a/.babelrc b/.babelrc
@@ -1,8 +1,8 @@
 {
   "presets": [
-    ["env", {
+    ["@babel/env", {
       "targets": {
-        "browsers": ["ie >= 9"]
+        "browsers": ["ie >= 8"]
       },
       "modules": false
     }]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,20 @@
-### 5.0.0 (February 27, 2019)
+### 5.0.0 (Unreleased)
 
-* Stop committing generated files to the git repository
+* Add `onInit` method that accepts a callback that will be invoked after init
+* Allow for api endpoints that do not end with a trailing slash
 * Sync with upstream ua-parser for user agent parsing
+* Upgrade rollup/babel dependencies
+
+## Breaking Changes
+* Drop JSON polyfill. This will break IE 7 and older. You can install your own JSON polyfill before loading amplitude.
+* Stop committing generated files to the master branch in the git repository (do not install amplitude from git).
 * Drop custom user agent parsing for symbian and blackberry
 
+
+### 4.7.0 (March 12, 2019)
+
+* Cherry-picked from 5.0.0: Add `onInit` method that accepts a callback that will be invoked after init
+
 ### 4.6.0 (February 25, 2019)
 
 * Add support for unsetting utm params when a new session is created
diff --git a/amplitude-segment-snippet.min.js b/amplitude-segment-snippet.min.js
@@ -7,7 +7,7 @@ var i=function(){this._q=[];return this}
 ;return this}
 ;var u=["setProductId","setQuantity","setPrice","setRevenueType","setEventProperties"]
 ;for(var c=0;c<u.length;c++){r(a,u[c])}n.Revenue=a
-;var p=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties","identify","clearUserProperties","setGroup","logRevenueV2","regenerateDeviceId","groupIdentify","logEventWithTimestamp","logEventWithGroups","setSessionId","resetSessionId"]
+;var p=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties","identify","clearUserProperties","setGroup","logRevenueV2","regenerateDeviceId","groupIdentify","onInit","logEventWithTimestamp","logEventWithGroups","setSessionId","resetSessionId"]
 ;function l(e){function t(t){e[t]=function(){
 e._q.push([t].concat(Array.prototype.slice.call(arguments,0)))}}
 for(var n=0;n<p.length;n++){t(p[n])}}l(n);n.getInstance=function(e){
diff --git a/package.json b/package.json
@@ -13,15 +13,13 @@
   "dependencies": {
     "@amplitude/ua-parser-js": "0.7.20",
     "blueimp-md5": "^2.10.0",
-    "json3": "^3.3.2",
     "query-string": "5"
   },
   "devDependencies": {
-    "babel-core": "6",
-    "babel-plugin-external-helpers": "^6.22.0",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-polyfill": "^6.26.0",
-    "babel-preset-env": "1",
+    "@babel/core": "^7.3.4",
+    "@babel/plugin-external-helpers": "^7.2.0",
+    "@babel/plugin-proposal-object-rest-spread": "^7.3.4",
+    "@babel/preset-env": "^7.3.4",
     "chai": "^4.1.2",
     "express": "^4.16.2",
     "fs-extra": "^4.0.2",
@@ -37,14 +35,14 @@
     "karma-sinon": "^1.0.5",
     "karma-sourcemap-loader": "^0.3.7",
     "mocha": "^4.0.1",
-    "rollup": "^0.56.0",
-    "rollup-plugin-babel": "^3.0.2",
-    "rollup-plugin-commonjs": "8.4.1",
+    "requirejs": "^2.3.6",
+    "rollup": "^1.4.1",
+    "rollup-plugin-babel": "^4.3.2",
+    "rollup-plugin-commonjs": "^9.2.1",
     "rollup-plugin-legacy": "^1.0.0",
-    "rollup-plugin-node-resolve": "^3.0.0",
+    "rollup-plugin-node-resolve": "^4.0.1",
     "rollup-plugin-replace": "^2.1.0",
-    "rollup-plugin-uglify": "^2.0.1",
-    "saucelabs": "^1.5.0",
+    "rollup-plugin-uglify": "^6.0.2",
     "sinon": "^4.1.2",
     "uglify-js": "^2.0.0"
   },
diff --git a/rollup.config.js b/rollup.config.js
@@ -4,7 +4,7 @@ import replace from 'rollup-plugin-replace';
 import babel from 'rollup-plugin-babel';
 
 export default {
-  input: 'src/index.compat.js',
+  input: 'src/index.js',
   output: {
     name: 'amplitude',
     file: 'amplitude.js',
@@ -13,8 +13,7 @@ export default {
   plugins: [
     babel({
       exclude: 'node_modules/**',
-      externalHelpersWhitelist: ['defineProperty', 'extends', 'typeof'],
-      plugins: ['external-helpers', 'transform-object-rest-spread'],
+      plugins: ['@babel/plugin-proposal-object-rest-spread'],
     }),
     resolve({
       browser: true,
@@ -26,4 +25,4 @@ export default {
     }),
     commonjs(),
   ],
-}
+};
diff --git a/rollup.min.js b/rollup.min.js
@@ -1,5 +1,5 @@
 import config from './rollup.config.js';
-import uglify from 'rollup-plugin-uglify';
+import { uglify } from 'rollup-plugin-uglify';
 
 config.plugins.push(uglify());
 config.output.file = 'amplitude.min.js';
diff --git a/rollup.nocompat.js b/rollup.nocompat.js
@@ -13,8 +13,7 @@ export default {
   plugins: [
     babel({
       exclude: 'node_modules/**',
-      externalHelpersWhitelist: ['defineProperty', 'extends', 'typeof'],
-      plugins: ['external-helpers', 'transform-object-rest-spread'],
+      plugins: ['@babel/plugin-proposal-object-rest-spread'],
     }),
     resolve({
       browser: true,
@@ -24,6 +23,12 @@ export default {
       BUILD_COMPAT_2_0: 'false',
       BUILD_COMPAT_LOCAL_STORAGE: 'false',
     }),
-    commonjs(),
+    commonjs({
+      include: [
+        'node_modules/query-string/**',
+        'node_modules/@amplitude/ua-parser-js/**',
+        'node_modules/blueimp-md5/**',
+      ],
+    }),
   ],
-}
+};
diff --git a/rollup.nocompat.min.js b/rollup.nocompat.min.js
@@ -1,5 +1,5 @@
 import config from './rollup.nocompat.js';
-import uglify from 'rollup-plugin-uglify';
+import { uglify } from 'rollup-plugin-uglify';
 
 config.plugins.push(uglify());
 config.output.file = 'amplitude.nocompat.min.js';
diff --git a/src/amplitude-client.js b/src/amplitude-client.js
@@ -31,6 +31,7 @@ var AmplitudeClient = function AmplitudeClient(instanceName) {
   this._q = []; // queue for proxied functions before script load
   this._sending = false;
   this._updateScheduled = false;
+  this._onInit = [];
 
   // event meta data
   this._eventId = 0;
@@ -149,6 +150,11 @@ AmplitudeClient.prototype.init = function init(apiKey, opt_userId, opt_config, o
       opt_callback(this);
     }
   }
+
+  for (let i = 0; i < this._onInit.length; i++) {
+    this._onInit[i]();
+  }
+  this._onInit = [];
 };
 
 /**
@@ -285,6 +291,14 @@ AmplitudeClient.prototype.isNewSession = function isNewSession() {
   return this._newSession;
 };
 
+/**
+ * Store callbacks to call after init
+ * @private
+ */
+AmplitudeClient.prototype.onInit = function (callback) {
+  this._onInit.push(callback);
+};
+
 /**
  * Returns the id of the current session.
  * @public
diff --git a/src/amplitude-snippet.js b/src/amplitude-snippet.js
@@ -23,7 +23,7 @@
   var funcs = ['init', 'logEvent', 'logRevenue', 'setUserId', 'setUserProperties',
                'setOptOut', 'setVersionName', 'setDomain', 'setDeviceId',
                'setGlobalUserProperties', 'identify', 'clearUserProperties',
-               'setGroup', 'logRevenueV2', 'regenerateDeviceId', 'groupIdentify',
+               'setGroup', 'logRevenueV2', 'regenerateDeviceId', 'groupIdentify', 'onInit',
                'logEventWithTimestamp', 'logEventWithGroups', 'setSessionId', 'resetSessionId'];
   function setUpProxy(instance) {
     function proxyMain(fn) {
diff --git a/src/index.compat.js b/src/index.compat.js
diff --git a/src/options.js b/src/options.js
@@ -2,7 +2,7 @@ import language from './language';
 
 // default options
 export default {
-  apiEndpoint: 'api.amplitude.com/',
+  apiEndpoint: 'api.amplitude.com',
   batchEvents: false,
   cookieExpiration: 365 * 10,
   cookieName: 'amplitude_id',
diff --git a/test/amplitude-client.js b/test/amplitude-client.js
@@ -54,6 +54,27 @@ describe('AmplitudeClient', function() {
       assert.equal(new AmplitudeClient('$DEFAULT_INSTANCE')._instanceName, '$default_instance');
     });
 
+    it('should invoke onInit callbacks', function() {
+      let onInitCalled = false;
+      let onInit2Called = false;
+      amplitude.onInit(() => { onInitCalled = true; });
+      amplitude.onInit(() => { onInit2Called = true; });
+
+      amplitude.init(apiKey);
+      assert.ok(onInitCalled);
+      assert.ok(onInit2Called);
+    });
+
+    it('should clear the onInitQueue', function() {
+      let onInitCalled = false;
+      let onInit2Called = false;
+      amplitude.onInit(() => { onInitCalled = true; });
+      amplitude.onInit(() => { onInit2Called = true; });
+
+      amplitude.init(apiKey);
+      assert.lengthOf(amplitude._onInit, 0);
+    });
+
     it('fails on invalid apiKeys', function() {
       amplitude.init(null);
       assert.equal(amplitude.options.apiKey, undefined);
@@ -1413,7 +1434,7 @@ describe('setVersionName', function() {
       amplitude.options.forceHttps = false;
       amplitude.logEvent('Event Type 1');
       assert.lengthOf(server.requests, 1);
-      assert.equal(server.requests[0].url, 'http://api.amplitude.com/');
+      assert.equal(server.requests[0].url, 'http://api.amplitude.com');
       assert.equal(server.requests[0].method, 'POST');
       assert.equal(server.requests[0].async, true);
     });
@@ -1422,7 +1443,7 @@ describe('setVersionName', function() {
       amplitude.options.forceHttps = true;
       amplitude.logEvent('Event Type 1');
       assert.lengthOf(server.requests, 1);
-      assert.equal(server.requests[0].url, 'https://api.amplitude.com/');
+      assert.equal(server.requests[0].url, 'https://api.amplitude.com');
       assert.equal(server.requests[0].method, 'POST');
       assert.equal(server.requests[0].async, true);
     });
@@ -1431,7 +1452,7 @@ describe('setVersionName', function() {
       amplitude.init(apiKey, null, { forceHttps: true });
       amplitude.logEvent('Event Type 1');
       assert.lengthOf(server.requests, 1);
-      assert.equal(server.requests[0].url, 'https://api.amplitude.com/');
+      assert.equal(server.requests[0].url, 'https://api.amplitude.com');
       assert.equal(server.requests[0].method, 'POST');
       assert.equal(server.requests[0].async, true);
     });
diff --git a/test/amplitude.js b/test/amplitude.js
@@ -1087,7 +1087,7 @@ describe('setVersionName', function() {
       amplitude.options.forceHttps = false;
       amplitude.logEvent('Event Type 1');
       assert.lengthOf(server.requests, 1);
-      assert.equal(server.requests[0].url, 'http://api.amplitude.com/');
+      assert.equal(server.requests[0].url, 'http://api.amplitude.com');
       assert.equal(server.requests[0].method, 'POST');
       assert.equal(server.requests[0].async, true);
     });
@@ -1096,7 +1096,7 @@ describe('setVersionName', function() {
       amplitude.options.forceHttps = true;
       amplitude.logEvent('Event Type 1');
       assert.lengthOf(server.requests, 1);
-      assert.equal(server.requests[0].url, 'https://api.amplitude.com/');
+      assert.equal(server.requests[0].url, 'https://api.amplitude.com');
       assert.equal(server.requests[0].method, 'POST');
       assert.equal(server.requests[0].async, true);
     });
@@ -1105,7 +1105,7 @@ describe('setVersionName', function() {
       amplitude.init(apiKey, null, { forceHttps: true });
       amplitude.logEvent('Event Type 1');
       assert.lengthOf(server.requests, 1);
-      assert.equal(server.requests[0].url, 'https://api.amplitude.com/');
+      assert.equal(server.requests[0].url, 'https://api.amplitude.com');
       assert.equal(server.requests[0].method, 'POST');
       assert.equal(server.requests[0].async, true);
     });
diff --git a/test/browser/amplitudejs-requirejs.html b/test/browser/amplitudejs-requirejs.html
@@ -4,7 +4,7 @@
 <script>
     requirejs.config({
       paths: {
-        'amplitude': 'https://cdn.amplitude.com/libs/amplitude-3.8.0-min.gz'
+        'amplitude': '/amplitude'
       }
     });
 
diff --git a/test/browser/index.html b/test/browser/index.html
@@ -3,18 +3,15 @@
 <head>
     <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
     <title>Amplitude Tests</title>
-    <link rel="stylesheet" href="../../node_modules/mocha/mocha.css"/>
 </head>
 <body>
-<div id="mocha"></div>
-<script src="../../node_modules/mocha/mocha.js"></script>
-<script>
-    mocha.ui('bdd');
-    var assert = chai.assert;
-    var expect = chai.expect;
-</script>
-<script src="../../amplitude.js"></script>
-<script src="../../build/tests.js"></script>
-<script>(window.mochaPhantomJS || mocha).run();</script>
+  <div style="display: flex; flex-direction: column">
+    <a href="./mocha-tests.html">mocha</a>
+    <a href="amplitudejs-requirejs.html">require js</a>
+    <a href="amplitudejs-segment.html">segment </a>
+    <a href="amplitudejs.html">amplitude js</a>
+    <a href="amplitudejs2.html">amplitude js 2</a>
+    <a href="snippet.html">snippet</a>
+  </div>
 </body>
 </html>
diff --git a/test/browser/mocha-tests.html b/test/browser/mocha-tests.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
+    <title>Amplitude Tests</title>
+    <link rel="stylesheet" href="../../node_modules/mocha/mocha.css"/>
+</head>
+<body>
+<div id="mocha"></div>
+<script src="../../node_modules/mocha/mocha.js"></script>
+<script>
+    mocha.ui('bdd');
+    var assert = chai.assert;
+    var expect = chai.expect;
+</script>
+<script src="../../amplitude.js"></script>
+<script src="../../build/tests.js"></script>
+<script>(window.mochaPhantomJS || mocha).run();</script>
+</body>
+</html>
diff --git a/test/browser/server.js b/test/browser/server.js
@@ -9,7 +9,7 @@ const app = express();
 app.use(express.static(__dirname + '/../..'));
 app.use(express.static(__dirname));
 app.listen(port);
-console.log('Listening on port ' + port + '...');
+console.log(`Listening on http://localhost:${port}`);
 
 if (!!process.env.USE_SSL) {
   const options = {
diff --git a/test/snippet-tests.js b/test/snippet-tests.js
@@ -54,6 +54,15 @@ describe('Snippet', function() {
     assert.deepEqual(amplitude._iq['instance2']._q[1], ['logEvent', 'Event']);
   });
 
+  it('amplitude object should proxy onInit', function() {
+    const callback = () => { };
+    amplitude.getInstance('onInit').onInit(callback);
+    amplitude.getInstance('onInit').init('API_KEY');
+    amplitude.getInstance('onInit').logEvent('Event', {prop: 1});
+    assert.lengthOf(amplitude._iq['oninit']._q, 3);
+    assert.deepEqual(amplitude._iq['oninit']._q[0], ['onInit', callback]);
+  });
+
   it('amplitude object should proxy resetSessionId', function() {
     amplitude.getInstance('reset_session_id_instance').init('API_KEY');
     amplitude.getInstance('reset_session_id_instance').resetSessionId();
diff --git a/yarn.lock b/yarn.lock
