More tests and a cookie refactor

Author: blazzy

CHANGELOG.md

@@ -1,3 +1,15 @@
+### 6.0.0 (April 17, 2020)
+* Use a more compact cookie format
+* Fix issue where a cookie key could have a space appear inside of it
+* Allow for localStorage fallback with the `disableCookie` option.
+* Only new and unseen devices will get the compact cookie. `cookieForceUpgrade` will force all browsers to upgrade and delete the old cookie.
+
+### 5.12.0 (April 17, 2020)
+* Use an IIFE build for the snippet. This will issues where the snippet wouldn't load for require js users.
+
+### 5.11.0 (April 6, 2020)
+* Add a `sameSiteCookie` option to set the SameSite cookie. It is set to `None` by default
+
 ### 5.11.0 (April 6, 2020)
 * Add a `sameSiteCookie` option to set the SameSite cookie. It is set to `None` by default
 

src/amplitude-client.js

@@ -1,6 +1,6 @@
 import Constants from './constants';
 import cookieStorage from './cookiestorage';
-import MetadataStorage from './metaDataStorage';
+import MetadataStorage from '../src/metadata-storage';
 import getUtmData from './utm';
 import Identify from './identify';
 import localStorage from './localstorage';  // jshint ignore:line

src/base-cookie.js

@@ -1,9 +1,11 @@
+import Constants from './constants';
+
 const get = (name) => {
   try {
-    var ca = document.cookie.split(';');
-    var value = null;
-    for (var i = 0; i < ca.length; i++) {
-      var c = ca[i];
+    const ca = document.cookie.split(';');
+    let value = null;
+    for (let i = 0; i < ca.length; i++) {
+      let c = ca[i];
       while (c.charAt(0) === ' ') {
         c = c.substring(1, c.length);
       }
@@ -14,21 +16,19 @@ const get = (name) => {
     }
 
     return value;
-
   } catch (e) {
     return null;
   }
 };
 
-
 const set = (name, value, opts) => {
-  var expires = value !== null ? opts.expirationDays : -1 ;
+  let expires = value !== null ? opts.expirationDays : -1 ;
   if (expires) {
-    var date = new Date();
+    const date = new Date();
     date.setTime(date.getTime() + (expires * 24 * 60 * 60 * 1000));
     expires = date;
   }
-  var str = name + '=' + value;
+  let str = name + '=' + value;
   if (expires) {
     str += '; expires=' + expires.toUTCString();
   }
@@ -45,7 +45,21 @@ const set = (name, value, opts) => {
   document.cookie = str;
 };
 
+
+// test that cookies are enabled - navigator.cookiesEnabled yields false positives in IE, need to test directly
+const areCookiesEnabled = () => {
+  const uid = String(new Date());
+  try {
+    set(Constants.COOKIE_TEST, uid, {});
+    const _areCookiesEnabled = get(Constants.COOKIE_TEST + '=') === uid;
+    set(Constants.COOKIE_TEST, null, {});
+    return _areCookiesEnabled;
+  } catch (e) {}
+  return false;
+};
+
 export default {
   set,
   get,
+  areCookiesEnabled
 };

src/cookie.js

@@ -3,10 +3,10 @@
  */
 
 import Base64 from './base64';
-import Constants from './constants';
 import utils from './utils';
 import getLocation from './get-location';
 import baseCookie from './base-cookie';
+import topDomain from './top-domain';
 
 
 var _options = {
@@ -22,51 +22,6 @@ var reset = function() {
   };
 };
 
-const getHost = (url) => {
-  const a = document.createElement('a');
-  a.href = url;
-  return a.hostname || location.hostname; 
-};
-
-let _topDomain = '';
-
-const topDomain = (url) => {
-  if (_topDomain) {
-    return topDomain;
-  }
-  const host = getHost(url);
-  const parts = host.split('.');
-  const last = parts[parts.length - 1];
-  const levels = [];
-
-  if (parts.length === 4 && last === parseInt(last, 10)) {
-    return levels;
-  }
-
-  if (parts.length <= 1) {
-    return levels;
-  }
-
-  for (let i = parts.length - 2; i >= 0; --i) {
-    levels.push(parts.slice(i).join('.'));
-  }
-
-  for (let i = 0; i < levels.length; ++i) {
-    const cname = '__tld_test__';
-    const domain = levels[i];
-    const opts = { domain: '.' + domain };
-
-    baseCookie.set(cname, 1, opts);
-    if (baseCookie.get(cname)) {
-      baseCookie.set(cname, null, opts);
-      return domain;
-    }
-  }
-
-  return '';
-};
-
-
 var options = function(opts) {
   if (arguments.length === 0) {
     return _options;
@@ -151,34 +106,12 @@ var remove = function(name) {
   }
 };
 
-let _areCookiesEnabled = null;
-
-// test that cookies are enabled - navigator.cookiesEnabled yields false positives in IE, need to test directly
-const areCookiesEnabled = () => {
-  if (_areCookiesEnabled !== null) {
-    return _areCookiesEnabled;
-  }
-  var uid = String(new Date());
-  var result;
-  try {
-    set(Constants.COOKIE_TEST, uid);
-    _areCookiesEnabled = get(Constants.COOKIE_TEST) === uid;
-    remove(Constants.COOKIE_TEST);
-    return result;
-  } catch (e) {
-    // cookies are not enabled
-  }
-  return false;
-};
-
 export default {
   reset,
   options,
-  topDomain,
   get,
   set,
   remove,
-  areCookiesEnabled,
   setRaw,
   getRaw
 };

src/metadataStorage.js src/metadata-storage.jssrc/metadataStorage.js renamed to src/metadata-storage.js

@@ -4,36 +4,58 @@
  */
 
 import Base64 from './base64';
-import Cookie from './cookie';
 import baseCookie from './base-cookie';
+import getLocation from './get-location';
 import localStorage from './localstorage'; // jshint ignore:line
+import topDomain from './top-domain';
 
 class MetadataStorage {
   constructor({storageKey, disableCookies, domain, secure, sameSite, expirationDays}) {
     this.storageKey = storageKey;
-    this.disableCookieStorage = !Cookie.areCookiesEnabled() || disableCookies;
+    this.disableCookieStorage = !baseCookie.areCookiesEnabled() || disableCookies;
     this.domain = domain;
     this.secure = secure;
     this.sameSite = sameSite;
     this.expirationDays = expirationDays;
-    this.topDomain = domain || Cookie.topDomain();
+    const writableTopDomain = topDomain(getLocation().href);
+    this.cookieDomain = domain || (writableTopDomain ? '.' + writableTopDomain : null);
   }
 
   getCookieStorageKey() {
-    return `${this.storageKey}${this.domain ? `_${this.domain}` : ''}`;
+    if (!this.domain) {
+      return this.storageKey;
+    }
+
+    const suffix = this.domain.charAt(0) === '.' ? this.domain.substring(1) : this.domain;
+
+    return `${this.storageKey}${suffix ? `_${suffix}` : ''}`;
   }
 
   save({ deviceId, userId, optOut, sessionId, lastEventTime, eventId, identifyId, sequenceNumber }) {
     // do not change the order of these items
-    const value = `${deviceId}.${Base64.encode(userId || '')}.${optOut ? '1' : ''}.${sessionId}.${lastEventTime}.${eventId}.${identifyId}.${sequenceNumber}`;
+    const value = [
+      deviceId,
+      Base64.encode(userId || ''),
+      optOut ? '1' : '',
+      sessionId ? sessionId.toString(32) : '0',
+      lastEventTime ? lastEventTime.toString(32) : '0',
+      eventId ? eventId.toString(32) : '0',
+      identifyId ? identifyId.toString(32) : '0',
+      sequenceNumber ? sequenceNumber.toString(32) : '0'
+    ].join('.');
 
     if (this.disableCookieStorage) {
       localStorage.setItem(this.storageKey, value);
     } else {
       baseCookie.set(
         this.getCookieStorageKey(),
         value,
-        { domain: this.topDomain, secure: this.secure, sameSite: this.sameSite, expirationDays: this.expirationDays }
+        {
+          domain: this.cookieDomain,
+          secure: this.secure,
+          sameSite: this.sameSite,
+          expirationDays: this.expirationDays
+        }
       );
     }
   }
@@ -66,11 +88,11 @@ class MetadataStorage {
       deviceId: values[0],
       userId,
       optOut: values[2] === '1',
-      sessionId: parseInt(values[3], 10),
-      lastEventTime: parseInt(values[4], 10),
-      eventId: parseInt(values[5], 10),
-      identifyId: parseInt(values[6], 10),
-      sequenceNumber: parseInt(values[7], 10)
+      sessionId: parseInt(values[3], 32),
+      lastEventTime: parseInt(values[4], 32),
+      eventId: parseInt(values[5], 32),
+      identifyId: parseInt(values[6], 32),
+      sequenceNumber: parseInt(values[7], 32)
     };
   }
 }

src/top-domain.js

@@ -0,0 +1,33 @@
+import baseCookie from './base-cookie';
+
+const getHost = (url) => {
+  const a = document.createElement('a');
+  a.href = url;
+  return a.hostname || location.hostname; 
+};
+
+const topDomain = (url) => {
+  const host = getHost(url);
+  const parts = host.split('.');
+  const levels = [];
+
+  for (let i = parts.length - 2; i >= 0; --i) {
+    levels.push(parts.slice(i).join('.'));
+  }
+
+  for (let i = 0; i < levels.length; ++i) {
+    const cname = '__tld_test__';
+    const domain = levels[i];
+    const opts = { domain: '.' + domain };
+
+    baseCookie.set(cname, 1, opts);
+    if (baseCookie.get(cname)) {
+      baseCookie.set(cname, null, opts);
+      return domain;
+    }
+  }
+
+  return '';
+};
+
+export default topDomain;