Replace @ndhoulse/defaults with lodash.assign and ES6 spread syntax merging

Author: Bryan Mikaelian

lib/analytics.ts

@@ -5,7 +5,8 @@ import {
   InitOptions,
   SegmentAnalytics,
   SegmentOpts,
-  SegmentIntegration
+  SegmentIntegration,
+  PageDefaults
 } from './types';
 
 var _analytics = global.analytics;
@@ -32,7 +33,6 @@ var extend = require('extend');
 var cookie = require('./cookie');
 var metrics = require('./metrics');
 var debug = require('debug');
-var defaults = require('@ndhoule/defaults');
 var each = require('./utils/each');
 var foldl = require('@ndhoule/foldl');
 var group = require('./group');
@@ -50,6 +50,7 @@ var querystring = require('component-querystring');
 var store = require('./store');
 var user = require('./user');
 var type = require('component-type');
+var assign = require('lodash.assign')
 
 /**
  * Initialize a new `Analytics` instance.
@@ -320,8 +321,13 @@ Analytics.prototype.identify = function(
   });
 
   // Add the initialize integrations so the server-side ones can be disabled too
+  // NOTE: We need to merge integrations, not override them with assign
+  // since it is possible to change the initialized integrations at runtime.
   if (this.options.integrations) {
-    defaults(msg.integrations, this.options.integrations);
+    msg.integrations = {
+      ...this.options.integrations,
+      ...msg.integrations
+    }
   }
 
   this._invoke('identify', new Identify(msg));
@@ -376,8 +382,13 @@ Analytics.prototype.group = function(
   });
 
   // Add the initialize integrations so the server-side ones can be disabled too
+  // NOTE: We need to merge integrations, not override them with assign
+  // since it is possible to change the initialized integrations at runtime.
   if (this.options.integrations) {
-    defaults(msg.integrations, this.options.integrations);
+    msg.integrations = {
+      ...this.options.integrations,
+      ...msg.integrations
+    }
   }
 
   this._invoke('group', new Group(msg));
@@ -441,10 +452,12 @@ Analytics.prototype.track = function(
   }
 
   // Add the initialize integrations so the server-side ones can be disabled too
-  defaults(
-    msg.integrations,
-    this._mergeInitializeAndPlanIntegrations(planIntegrationOptions)
-  );
+  // NOTE: We need to merge integrations, not override them with assign
+  // since it is possible to change the initialized integrations at runtime.
+  msg.integrations = {
+    ...this._mergeInitializeAndPlanIntegrations(planIntegrationOptions),
+    ...msg.integrations
+  }
 
   this._invoke('track', new Track(msg));
 
@@ -590,7 +603,7 @@ Analytics.prototype.page = function(
   // Ensure properties has baseline spec properties.
   // TODO: Eventually move these entirely to `options.context.page`
   var defs = pageDefaults();
-  defaults(properties, defs);
+  assign(properties, defs)
 
   // Mirror user overrides to `options.context.page` (but exclude custom properties)
   // (Any page defaults get applied in `this.normalize` for consistency.)
@@ -610,8 +623,13 @@ Analytics.prototype.page = function(
   });
 
   // Add the initialize integrations so the server-side ones can be disabled too
+  // NOTE: We need to merge integrations, not override them with assign
+  // since it is possible to change the initialized integrations at runtime.
   if (this.options.integrations) {
-    defaults(msg.integrations, this.options.integrations);
+    msg.integrations = {
+      ...this.options.integrations,
+      ...msg.integrations
+    }
   }
 
   this._invoke('page', new Page(msg));
@@ -663,8 +681,13 @@ Analytics.prototype.alias = function(
   });
 
   // Add the initialize integrations so the server-side ones can be disabled too
+  // NOTE: We need to merge integrations, not override them with assign
+  // since it is possible to change the initialized integrations at runtime.
   if (this.options.integrations) {
-    defaults(msg.integrations, this.options.integrations);
+    msg.integrations = {
+      ...this.options.integrations,
+      ...msg.integrations
+    }
   }
 
   this._invoke('alias', new Alias(msg));
@@ -958,15 +981,18 @@ Analytics.prototype._parseQuery = function(query: string): SegmentAnalytics {
  */
 
 Analytics.prototype.normalize = function(msg: {
-  context: { page };
+  context: { page: Partial<PageDefaults> };
   anonymousId: string;
 }): object {
   msg = normalize(msg, keys(this._integrations));
   if (msg.anonymousId) user.anonymousId(msg.anonymousId);
   msg.anonymousId = user.anonymousId();
 
   // Ensure all outgoing requests include page data in their contexts.
-  msg.context.page = defaults(msg.context.page || {}, pageDefaults());
+  msg.context.page = {
+    ...pageDefaults(),
+    ...msg.context.page
+  };
 
   return msg;
 };

lib/cookie.ts

@@ -10,8 +10,10 @@ var bindAll = require('bind-all');
 var clone = require('./utils/clone');
 var cookie = require('@segment/cookie');
 var debug = require('debug')('analytics.js:cookie');
-var defaults = require('@ndhoule/defaults');
 var topDomain = require('@segment/top-domain');
+var assign = require('lodash.assign')
+
+const MAX_AGE_ONE_YEAR = 31536000000
 
 /**
  * Initialize a new `Cookie` with `options`.
@@ -32,16 +34,17 @@ Cookie.prototype.options = function(options?: CookieOptions) {
 
   options = options || {};
 
-  var domain = '.' + topDomain(window.location.href);
+  let domain = '.' + topDomain(window.location.href);
   if (domain === '.') domain = null;
 
-  this._options = defaults(options, {
-    // default to a year
-    maxage: 31536000000,
-    path: '/',
+  const defaults: CookieOptions  = {
+    maxage: MAX_AGE_ONE_YEAR,
     domain: domain,
+    path: '/',
     sameSite: 'Lax'
-  });
+  }
+
+  this._options = assign(defaults, options);
 
   // http://curl.haxx.se/rfc/cookie_spec.html
   // https://publicsuffix.org/list/effective_tld_names.dat

lib/entity.ts

@@ -9,7 +9,6 @@ import { InitOptions } from './types';
 var clone = require('./utils/clone');
 var cookie = require('./cookie');
 var debug = require('debug')('analytics:entity');
-var defaults = require('@ndhoule/defaults');
 var extend = require('@ndhoule/extend');
 var memory = require('./memory');
 var store = require('./store');
@@ -74,7 +73,10 @@ Entity.prototype.storage = function() {
 
 Entity.prototype.options = function(options?: InitOptions) {
   if (arguments.length === 0) return this._options;
-  this._options = defaults(options || {}, this.defaults || {});
+  this._options = {
+    ...this.defaults,
+    ...options
+  }
 };
 
 /**

lib/normalize.ts

@@ -7,13 +7,14 @@ import { Message } from './types';
  */
 
 var debug = require('debug')('analytics.js:normalize');
-var defaults = require('@ndhoule/defaults');
 var each = require('./utils/each');
 var includes = require('@ndhoule/includes');
 var map = require('./utils/map');
 var type = require('component-type');
 var uuid = require('uuid/v4');
 var md5 = require('spark-md5').hash;
+var assign = require('lodash.assign')
+
 
 /**
  * HOP.
@@ -92,7 +93,7 @@ function normalize(msg: Message, list: Array<any>): NormalizedMessage {
   delete msg.options;
   ret.integrations = integrations;
   ret.context = context;
-  ret = defaults(ret, msg);
+  ret = assign(msg, ret);
   debug('->', ret);
   return ret;
 

lib/store.ts

@@ -1,12 +1,14 @@
 'use strict';
 
+import { StoreOptions } from './types';
+
 /*
  * Module dependencies.
  */
 
 var bindAll = require('bind-all');
-var defaults = require('@ndhoule/defaults');
 var store = require('@segment/store');
+var assign = require('lodash.assign')
 
 /**
  * Initialize a new `Store` with `options`.
@@ -22,11 +24,11 @@ function Store(options?: { enabled: boolean }) {
  * Set the `options` for the store.
  */
 
-Store.prototype.options = function(options?: { enabled?: boolean }) {
+Store.prototype.options = function(options?: StoreOptions) {
   if (arguments.length === 0) return this._options;
 
   options = options || {};
-  defaults(options, { enabled: true });
+  options = assign({ enabled: true }, options);
 
   this.enabled = options.enabled && store.enabled;
   this._options = options;

lib/types.ts

@@ -15,6 +15,7 @@ export interface CookieOptions {
   domain?: string;
   path?: string;
   secure?: boolean;
+  sameSite?: string
 }
 
 export interface MetricsOptions {
@@ -24,7 +25,7 @@ export interface MetricsOptions {
   maxQueueSize?: number;
 }
 
-interface StoreOptions {
+export interface StoreOptions {
   enabled?: boolean;
 }
 

test/analytics.test.js

@@ -13,6 +13,7 @@ var pageDefaults = require('../build/pageDefaults');
 var sinon = require('sinon');
 var tick = require('next-tick');
 var trigger = require('compat-trigger-event');
+var assign = require('lodash.assign');
 
 var Identify = Facade.Identify;
 var cookie = Analytics.cookie;
@@ -774,17 +775,6 @@ describe('Analytics', function() {
       assert.deepEqual(page.options('AdRoll'), { opt: true });
     });
 
-    it('should use the initialize .integrations option', function() {
-      analytics.initialize(settings, {
-        integrations: {
-          Test: false
-        }
-      });
-      analytics.page({ prop: true });
-      var page = analytics._invoke.args[0][1];
-      assert.deepEqual(page.obj.integrations, { Test: false });
-    });
-
     it('should be able to override the initialize .integrations option', function() {
       analytics.initialize(settings, {
         integrations: {
@@ -1611,6 +1601,26 @@ describe('Analytics', function() {
       assert.deepEqual(track.context(), { page: contextPage });
     });
 
+    it('should support overwriting context.page fields', function() {
+      analytics.track(
+        'event',
+        {},
+        {
+          context: {
+            page: {
+              title: 'lol'
+            }
+          }
+        }
+      );
+
+      var track = analytics._invoke.args[0][1];
+      assert.deepEqual(
+        track.context().page,
+        assign(contextPage, { title: 'lol' })
+      );
+    });
+
     it('should accept context.traits', function() {
       analytics.track('event', { prop: 1 }, { traits: { trait: true } });
       var track = analytics._invoke.args[0][1];

test/cookie.test.js

@@ -63,6 +63,15 @@ describe('cookie', function() {
       assert(cookie.options().maxage === 31536000000);
     });
 
+    it('should have default options', function() {
+      cookie.options({ domain: '' });
+
+      assert(cookie.options().maxage === 31536000000);
+      assert(cookie.options().path === '/');
+      assert(cookie.options().domain === '');
+      assert(cookie.options().sameSite === 'Lax');
+    });
+
     it('should set the domain correctly', function() {
       cookie.options({ domain: '' });
       assert(cookie.options().domain === '');

test/normalize.test.js

@@ -64,6 +64,18 @@ describe('normalize', function() {
         }
       });
     });
+
+    it('should merge with defaults', function() {
+      opts.context = { foo: 5 };
+      var out = normalize(msg, list);
+      assert.deepEqual(out.integrations, {});
+      assert.deepEqual(out.context, { foo: 5 });
+
+      msg.options = { integrations: { Segment: true }, context: { foo: 6 } };
+      out = normalize(msg, list);
+      assert.deepEqual(out.integrations, { Segment: true });
+      assert.deepEqual(out.context, { foo: 6 });
+    });
   });
 
   describe('integrations', function() {

test/store.test.js

@@ -43,5 +43,11 @@ describe('store', function() {
       assert(store.options().enabled === false);
       assert(store.enabled === false);
     });
+
+    it('should have default options', function() {
+      store.options({});
+
+      assert(store.options().enabled);
+    });
   });
 });