Replace utils/each with Array.prototype.forEach in analytics.ts

Also removes @ndhoule/keys

Author: Bryan Mikaelian

lib/analytics.ts

@@ -70,8 +70,9 @@ function Analytics() {
   this.log = debug('analytics.js');
   bindAll(this);
 
-  var self = this;
-  this.on('initialize', function(settings, options) {
+
+  const self = this;
+  this.on('initialize', function(_, options) {
     if (options.initialPageview) self.page();
     self._parseQuery(window.location.search);
   });
@@ -170,13 +171,16 @@ Analytics.prototype.init = Analytics.prototype.initialize = function(
 
   // clean unknown integrations from settings
   var self = this;
-  each(function(_opts: unknown, name: string | number) {
-    var Integration = self.Integrations[name];
-    if (!Integration) delete settings[name];
-  }, settings);
+  Object.keys(settings).forEach(key => {
+    var Integration = self.Integrations[key];
+    if (!Integration) delete settings[key];
+  });
 
   // add integrations
-  each(function(opts: unknown, name: string | number) {
+  Object.keys(settings).forEach(key => {
+    const opts = settings[key]
+    const name = key
+
     // Don't load disabled integrations
     if (options.integrations) {
       if (
@@ -187,13 +191,13 @@ Analytics.prototype.init = Analytics.prototype.initialize = function(
       }
     }
 
-    var Integration = self.Integrations[name];
-    var clonedOpts = {};
+    const Integration = self.Integrations[name];
+    const clonedOpts = {};
     extend(true, clonedOpts, opts); // deep clone opts
-    var integration = new Integration(clonedOpts);
+    const integration = new Integration(clonedOpts);
     self.log('initialize %o - %o', name, opts);
     self.add(integration);
-  }, settings);
+  });
 
   var integrations = this._integrations;
 
@@ -220,14 +224,15 @@ Analytics.prototype.init = Analytics.prototype.initialize = function(
   // initialize integrations, passing ready
   // create a list of any integrations that did not initialize - this will be passed with all events for replay support:
   this.failedInitializations = [];
-  var initialPageSkipped = false;
-  each(function(integration) {
+  let initialPageSkipped = false;
+  Object.keys(integrations).forEach(key => {
+    const integration = integrations[key]
     if (
       options.initialPageview &&
       integration.options.initialPageview === false
     ) {
       // We've assumed one initial pageview, so make sure we don't count the first page call.
-      var page = integration.page;
+      let page = integration.page;
       integration.page = function() {
         if (initialPageSkipped) {
           return page.apply(this, arguments);
@@ -247,7 +252,7 @@ Analytics.prototype.init = Analytics.prototype.initialize = function(
       });
       integration.initialize();
     } catch (e) {
-      var integrationName = integration.name;
+      let integrationName = integration.name;
       metrics.increment('analytics_js.integration.invoke.error', {
         method: 'initialize',
         integration_name: integration.name
@@ -258,7 +263,7 @@ Analytics.prototype.init = Analytics.prototype.initialize = function(
 
       integration.ready();
     }
-  }, integrations);
+  });
 
   // backwards compat with angular plugin and used for init logic checks
   this.initialized = true;
@@ -467,37 +472,44 @@ Analytics.prototype.track = function(
  */
 
 Analytics.prototype.trackClick = Analytics.prototype.trackLink = function(
-  links: Element | Array<unknown>,
+  links: Element | Array<Element> | JQuery,
   event: any,
   properties?: any
 ): SegmentAnalytics {
+  let elements: Array<Element> = []
   if (!links) return this;
   // always arrays, handles jquery
-  if (type(links) === 'element') links = [links];
+  if (links instanceof Element) {
+    elements = [links]
+  } else if ("toArray" in links) {
+    elements = links.toArray()
+  } else {
+    elements = links as Array<Element>
+  }
 
-  var self = this;
-  each(function(el) {
+  elements.forEach(el => {
     if (type(el) !== 'element') {
       throw new TypeError('Must pass HTMLElement to `analytics.trackLink`.');
     }
-    on(el, 'click', function(e) {
-      var ev = is.fn(event) ? event(el) : event;
-      var props = is.fn(properties) ? properties(el) : properties;
-      var href =
+    on(el, 'click', (e) => {
+      const ev = is.fn(event) ? event(el) : event;
+      const props = is.fn(properties) ? properties(el) : properties;
+      const href =
         el.getAttribute('href') ||
         el.getAttributeNS('http://www.w3.org/1999/xlink', 'href') ||
         el.getAttribute('xlink:href');
 
-      self.track(ev, props);
+      this.track(ev, props);
 
+      // @ts-ignore
       if (href && el.target !== '_blank' && !isMeta(e)) {
         prevent(e);
-        self._callback(function() {
+        this._callback(function() {
           window.location.href = href;
         });
       }
     });
-  }, links);
+  });
 
   return this;
 };
@@ -523,18 +535,19 @@ Analytics.prototype.trackSubmit = Analytics.prototype.trackForm = function(
   // always arrays, handles jquery
   if (type(forms) === 'element') forms = [forms];
 
-  var self = this;
-  each(function(el: { submit: () => void }) {
+  const elements = forms as Array<unknown>
+
+  elements.forEach((el: { submit: () => void }) => {
     if (type(el) !== 'element')
       throw new TypeError('Must pass HTMLElement to `analytics.trackForm`.');
-    function handler(e) {
+    const handler = (e) => {
       prevent(e);
 
-      var ev = is.fn(event) ? event(el) : event;
-      var props = is.fn(properties) ? properties(el) : properties;
-      self.track(ev, props);
+      const ev = is.fn(event) ? event(el) : event;
+      const props = is.fn(properties) ? properties(el) : properties;
+      this.track(ev, props);
 
-      self._callback(function() {
+      this._callback(function() {
         el.submit();
       });
     }
@@ -547,7 +560,7 @@ Analytics.prototype.trackSubmit = Analytics.prototype.trackForm = function(
     } else {
       on(el, 'submit', handler);
     }
-  }, forms);
+  });
 
   return this;
 };
@@ -565,11 +578,11 @@ Analytics.prototype.trackSubmit = Analytics.prototype.trackForm = function(
  */
 
 Analytics.prototype.page = function(
-  category: string,
-  name: string,
-  properties: any,
-  options: any,
-  fn: unknown
+  category?: string,
+  name?: string,
+  properties?: any,
+  options?: any,
+  fn?: unknown
 ): SegmentAnalytics {
   // Argument reshuffling.
   /* eslint-disable no-unused-expressions, no-sequences */
@@ -797,9 +810,11 @@ Analytics.prototype._invoke = function(
   return this;
 
   function applyIntegrationMiddlewares(facade) {
-    var failedInitializations = self.failedInitializations || [];
-    each(function(integration, name) {
-      var facadeCopy = extend(true, new Facade({}), facade);
+    let failedInitializations = self.failedInitializations || [];
+    Object.keys(self._integrations).forEach(key => {
+      const integration = self._integrations[key]
+      const { name } = integration
+      const facadeCopy = extend(true, new Facade({}), facade);
 
       if (!facadeCopy.enabled(name)) return;
       // Check if an integration failed to initialize.
@@ -883,7 +898,7 @@ Analytics.prototype._invoke = function(
           );
         }
       }
-    }, self._integrations);
+    });
   }
 };
 

lib/types.ts

@@ -1,8 +1,30 @@
 export interface SegmentAnalytics {
-  Integrations: { [name: string]: unknown };
+  Integrations: { [name: string]: (options: SegmentOpts) => void };
   options: InitOptions;
   require: any
   VERSION: any
+
+  // Analytics.JS Methods
+  page: (
+    category?: string,
+    name?: string,
+    properties?: any,
+    options?: any,
+    fn?: unknown
+  ) => void
+
+  // Private fields
+  _options: (options: Object) => void
+  _sourceMiddlewares:  unknown
+  _integrationMiddlewares: unknown
+  _destinationMiddlewares: unknown
+  _integrations: unknown
+  _readied: boolean
+  _timeout: number
+  _user: unknown
+  log: (args: string) => void
+  on: (event: string, callback: (settings: unknown, options: InitOptions) => void) => void
+  _parseQuery: (queryString: string) => void
 }
 
 export interface IntegrationsSettings {

package.json

@@ -67,7 +67,10 @@
     "@codeceptjs/mock-request": "^0.3.0",
     "@segment/analytics.js-integration": "^3.2.2",
     "@segment/eslint-config": "^4.0.0",
+    "@types/component-emitter": "^1.2.9",
+    "@types/debug": "^4.1.5",
     "@types/express": "^4.17.6",
+    "@types/jquery": "^3.5.1",
     "@types/lodash": "^4.14.155",
     "@types/mocha": "^7.0.2",
     "@types/node": "^14.0.6",

test/analytics.test.ts

@@ -8,6 +8,7 @@ var bind = require('component-event').bind;
 var createIntegration = require('@segment/analytics.js-integration');
 var extend = require('@ndhoule/extend');
 var type = require('component-type');
+// @ts-ignore
 var jQuery = require('jquery');
 var pageDefaults = require('../build/pageDefaults');
 var sinon = require('sinon');

yarn.lock

@@ -517,13 +517,23 @@
   resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"
   integrity sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==
 
+"@types/component-emitter@^1.2.9":
+  version "1.2.9"
+  resolved "https://registry.yarnpkg.com/@types/component-emitter/-/component-emitter-1.2.9.tgz#a17785a0fa86d934ac8b762bd496c65ff9e47c84"
+  integrity sha512-xaESaDSXQLIGYpXJJ+ubBsDrsbI07Wv9zzDa7qb1RFnQUTeBZjZH9QfEaRn1AkvPdVK2d66vl4sR001vK+lR+g==
+
 "@types/connect@*":
   version "3.4.33"
   resolved "https://registry.yarnpkg.com/@types/connect/-/connect-3.4.33.tgz#31610c901eca573b8713c3330abc6e6b9f588546"
   integrity sha512-2+FrkXY4zllzTNfJth7jOqEHC+enpLeGslEhpnTAkg21GkRrWV4SsAtqchtT4YS9/nODBU2/ZfsBY2X4J/dX7A==
   dependencies:
     "@types/node" "*"
 
+"@types/debug@^4.1.5":
+  version "4.1.5"
+  resolved "https://registry.yarnpkg.com/@types/debug/-/debug-4.1.5.tgz#b14efa8852b7768d898906613c23f688713e02cd"
+  integrity sha512-Q1y515GcOdTHgagaVFhHnIFQ38ygs/kmxdNpvpou+raI9UO3YZcHDngBSYKQklcKlvA7iuQlmIKbzvmxcOE9CQ==
+
 "@types/express-serve-static-core@*":
   version "4.17.7"
   resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.17.7.tgz#dfe61f870eb549dc6d7e12050901847c7d7e915b"
@@ -543,6 +553,13 @@
     "@types/qs" "*"
     "@types/serve-static" "*"
 
+"@types/jquery@^3.5.1":
+  version "3.5.1"
+  resolved "https://registry.yarnpkg.com/@types/jquery/-/jquery-3.5.1.tgz#cebb057acf5071c40e439f30e840c57a30d406c3"
+  integrity sha512-Tyctjh56U7eX2b9udu3wG853ASYP0uagChJcQJXLUXEU6C/JiW5qt5dl8ao01VRj1i5pgXPAf8f1mq4+FDLRQg==
+  dependencies:
+    "@types/sizzle" "*"
+
 "@types/lodash@^4.14.155":
   version "4.14.155"
   resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.155.tgz#e2b4514f46a261fd11542e47519c20ebce7bc23a"
@@ -609,6 +626,11 @@
     "@types/express-serve-static-core" "*"
     "@types/mime" "*"
 
+"@types/sizzle@*":
+  version "2.3.2"
+  resolved "https://registry.yarnpkg.com/@types/sizzle/-/sizzle-2.3.2.tgz#a811b8c18e2babab7d542b3365887ae2e4d9de47"
+  integrity sha512-7EJYyKTL7tFR8+gDbB6Wwz/arpGa0Mywk1TJbNzKzHtzbwVmY4HR9WqS5VV7dsBUKQmPNr192jHr/VpBluj/hg==
+
 "@types/tough-cookie@*":
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/@types/tough-cookie/-/tough-cookie-4.0.0.tgz#fef1904e4668b6e5ecee60c52cc6a078ffa6697d"