[CSL 24] Use exisiting data from cookie/local storage if it exists (#16)

* Initial implementation, passses all tests

* Add/update tests

* Lint fixes

* Add/Update specs

* Consistent casing.

Co-authored-by: Steve Blaurock <[email protected]>

Author: jjl014

spec/001-initialization.js

@@ -13,6 +13,7 @@ describe('ConstructorioID', function () {
       'generate_client_id',
       'get_local_object',
       'set_local_object',
+      'delete_local_object',
       'generate_session_id'
     ];
     expect(actualKeys).to.eql(expectedKeys);
@@ -97,26 +98,38 @@ describe('ConstructorioID', function () {
       expect(session.client_id).to.match(/(\w|d|-){36}/);
     });
 
-    it('should read the client id from local storage if storage location is set to local', function () {
-      window.localStorage.setItem('dummyname', 'dummyid');
-      var session = new ConstructorioID({ local_name_client_id: 'dummyname', client_id_storage_location: 'local' } );
-      expect(session.client_id).to.equal('dummyid');
-      expect(window.localStorage.getItem('dummyname')).to.equal('dummyid');
-    });
+    describe('when the storage location is set to local', function () {
+      it('should read the client id from local storage', function () {
+        window.localStorage.setItem('dummyname', 'dummyid');
+        var session = new ConstructorioID({ local_name_client_id: 'dummyname', client_id_storage_location: 'local' } );
+        expect(session.client_id).to.equal('dummyid');
+        expect(window.localStorage.getItem('dummyname')).to.equal('dummyid');
+      });
 
-    it('should read the client id from the default local storage name and storage location is set to local', function () {
-      window.localStorage.setItem('_constructorio_search_client_id', 'bummyid');
-      var session = new ConstructorioID({ client_id_storage_location: 'local' });
-      expect(session.client_id).to.equal('bummyid');
-      expect(window.localStorage.getItem('_constructorio_search_client_id')).to.equal('bummyid');
-    });
+      it('should read the client id from the default local storage name', function () {
+        window.localStorage.setItem('_constructorio_search_client_id', 'bummyid');
+        var session = new ConstructorioID({ client_id_storage_location: 'local' });
+        expect(session.client_id).to.equal('bummyid');
+        expect(window.localStorage.getItem('_constructorio_search_client_id')).to.equal('bummyid');
+      });
 
-    it('should set the client id if missing and storage location is set to local', function () {
-      var session = new ConstructorioID({ cookie_name_client_id: 'missingname', client_id_storage_location: 'local' });
-      expect(session.client_id).to.be.a.string;
-      expect(session.client_id).to.match(/(\w|d|-){36}/);
+      it('should read the client id from cookies if it does not exist in local storage and remove it from the cookies', function () {
+        document.cookie = 'ConstructorioID_client_id=chummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
+        var session = new ConstructorioID({ client_id_storage_location: 'local' });
+        var cookieData = JSON.parse(helper.getCookie('ConstructorioID_client_id'));
+        expect(session.client_id).to.equal('chummyid');
+        expect(window.localStorage.getItem('_constructorio_search_client_id')).to.equal('chummyid');
+        expect(cookieData).to.equal(null);
+      });
+
+      it('should set the client id if missing from both local storage and cookies', function () {
+        var session = new ConstructorioID({ client_id_storage_location: 'local' });
+        expect(session.client_id).to.be.a.string;
+        expect(session.client_id).to.match(/(\w|d|-){36}/);
+      });
     });
 
+
     it('should read the session id from local storage data', function () {
       window.localStorage.setItem('_constructorio_search_session', JSON.stringify({
         sessionId: 42,
@@ -183,17 +196,39 @@ describe('ConstructorioID', function () {
       expect(session.session_id).to.equal(1);
     });
 
-    it('should read the session id from cookie if storage location is set to cookie', function () {
-      document.cookie = `ConstructorioID_session={"sessionId":42,"lastTime":${Date.now()}}; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/`;
-      var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
-      expect(session.session_id).to.be.a('number');
-      expect(session.session_id).to.equal(42);
-    });
+    describe('when the storage location is set to cookie', function () {
+      it('should read the session id from cookie', function () {
+        document.cookie = `ConstructorioID_session={"sessionId":42,"lastTime":${Date.now()}}; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/`;
+        var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+        expect(session.session_id).to.be.a('number');
+        expect(session.session_id).to.equal(42);
+      });
 
-    it('should set the session id to 1 if there is no cookie and storage location is set to cookie', function () {
-      var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
-      expect(session.session_id).to.be.a('number');
-      expect(session.session_id).to.equal(1);
+      it('should read the session id from the default cookie name', function () {
+        document.cookie = `ConstructorioID_session={"sessionId":42,"lastTime":${Date.now()}}; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/`;
+        var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+        var cookieData = JSON.parse(helper.getCookie('ConstructorioID_session'));
+        expect(session.session_id).to.equal(42);
+        expect(cookieData.sessionId).to.equal(42);
+      });
+
+      it('should read the session id from local storage if there is no cookie and remove it from local storage', function () {
+        window.localStorage.setItem('_constructorio_search_session', JSON.stringify({
+          sessionId: '11',
+          lastTime: Date.now()
+        }));
+        var session = new ConstructorioID({ session_id_storage_location: 'cookie' } );
+        var cookieData = JSON.parse(helper.getCookie('ConstructorioID_session'));
+        expect(window.localStorage.getItem('_constructorio_search_session')).to.equal(null);
+        expect(session.session_id).to.equal(11);
+        expect(cookieData.sessionId).to.equal(11);
+      });
+
+      it('should set the session id to 1 if missing from both local storage and cookies', function () {
+        var session = new ConstructorioID({ session_id_storage_location: 'cookie' } );
+        expect(session.session_id).to.be.a('number');
+        expect(session.session_id).to.equal(1);
+      });
     });
 
     it('should set the session id if cookie data can be parsed into a number', function () {

spec/005-storage.js

@@ -130,6 +130,45 @@ describe('ConstructorioID', function () {
       set_cookie.restore();
     });
 
+    describe('when the storage location is set to cookie', function () {
+      it('should use session id from local storage if there is no cookie and increment if older than thirty minutes', function () {
+        var now = Date.now();
+        window.localStorage.setItem('_constructorio_search_session', JSON.stringify({ sessionId: 42, lastTime: `${now - 1000 * 60 * 30}` }));
+        var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+
+        var set_cookie = sinon.spy(ConstructorioID.prototype, 'set_cookie');
+        var session_id = session.generate_session_id();
+        expect(session_id).to.be.a('number');
+        expect(session_id).to.equal(43);
+        expect(set_cookie.calledTwice).to.be.true;
+        expect(set_cookie.calledWith('ConstructorioID_session_id')).to.be.true;
+        expect(set_cookie.calledWith('ConstructorioID_session')).to.be.true;
+        expect(JSON.parse(set_cookie.getCall(0).args[1])).to.equal(43);
+        expect(JSON.parse(set_cookie.getCall(1).args[1]).sessionId).to.equal(43);
+        expect(JSON.parse(set_cookie.getCall(1).args[1]).lastTime).to.be.at.least(now);
+
+        set_cookie.restore();
+      });
+
+      it('should set a session id in cookie if missing from both local storage and cookie', function () {
+        var now = Date.now();
+        var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+        document.cookie = '';
+
+        var set_cookie = sinon.spy(ConstructorioID.prototype, 'set_cookie');
+        var session_id = session.generate_session_id();
+        expect(session_id).to.be.a('number');
+        expect(session_id).to.equal(1);
+        expect(set_cookie.calledTwice).to.be.true;
+        expect(set_cookie.calledWith('ConstructorioID_session_id')).to.be.true;
+        expect(set_cookie.calledWith('ConstructorioID_session')).to.be.true;
+        expect(JSON.parse(set_cookie.getCall(0).args[1])).to.equal(1);
+        expect(JSON.parse(set_cookie.getCall(1).args[1]).sessionId).to.equal(1);
+        expect(JSON.parse(set_cookie.getCall(1).args[1]).lastTime).to.be.at.least(now);
+        set_cookie.restore();
+      });
+    });
+
     it('should set a session id in local storage if missing', function () {
       var now = Date.now();
       var session = new ConstructorioID();
@@ -147,23 +186,5 @@ describe('ConstructorioID', function () {
       expect(set_local_object.getCall(1).args[1].lastTime).to.be.at.least(now);
       set_local_object.restore();
     });
-
-    it('should set a session id in cookie if missing and storage location is set to cookie', function () {
-      var now = Date.now();
-      var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
-      document.cookie = '';
-
-      var set_cookie = sinon.spy(ConstructorioID.prototype, 'set_cookie');
-      var session_id = session.generate_session_id();
-      expect(session_id).to.be.a('number');
-      expect(session_id).to.equal(1);
-      expect(set_cookie.calledTwice).to.be.true;
-      expect(set_cookie.calledWith('ConstructorioID_session_id')).to.be.true;
-      expect(set_cookie.calledWith('ConstructorioID_session')).to.be.true;
-      expect(JSON.parse(set_cookie.getCall(0).args[1])).to.equal(1);
-      expect(JSON.parse(set_cookie.getCall(1).args[1]).sessionId).to.equal(1);
-      expect(JSON.parse(set_cookie.getCall(1).args[1]).lastTime).to.be.at.least(now);
-      set_cookie.restore();
-    });
   });
 });

spec/006-cookies.js

@@ -66,12 +66,20 @@ describe('ConstructorioID', function () {
       expect(client_id).to.match(/(\w|d|-){36}/);
     });
 
-    it('should return a client id and set local storage value if storage location is set to local', function () {
-      var session = new ConstructorioID({ local_name_client_id: 'monster', client_id_storage_location: 'local' });
-      var client_id = session.generate_client_id();
-      expect(session.get_local_object('monster')).to.equal(client_id);
-      expect(client_id).to.be.a.string;
-      expect(client_id).to.match(/(\w|d|-){36}/);
+    describe('when the storage location is set to local', function () {
+      it('should return a client id and set local storage value', function () {
+        var session = new ConstructorioID({ local_name_client_id: 'monster', client_id_storage_location: 'local' });
+        var client_id = session.generate_client_id();
+        expect(session.get_local_object('monster')).to.equal(client_id);
+        expect(client_id).to.be.a.string;
+        expect(client_id).to.match(/(\w|d|-){36}/);
+      });
+
+      it('should use client id from cookies if the data is not available in local storage', function () {
+        document.cookie = 'ConstructorioID_client_id=chummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
+        var session = new ConstructorioID({ client_id_storage_location: 'local' });
+        expect(session.get_local_object('_constructorio_search_client_id')).to.equal('chummyid');
+      });
     });
   });
 });

spec/helper.js

@@ -14,6 +14,16 @@ function getStorageMock() {
   };
 }
 
+/*
+ * Returns a value given the cookie name
+ */
+function getCookie(name) {
+  var re = new RegExp(name + '=([^;]+)');
+  var value = re.exec(document.cookie);
+  return (value !== null) ? unescape(value[1]) : null;
+}
+
 module.exports = {
-  getStorageMock: getStorageMock
+  getStorageMock: getStorageMock,
+  getCookie: getCookie
 };

src/constructorio-id.js

@@ -91,18 +91,43 @@
   };
 
   ConstructorioID.prototype.generate_client_id = function () {
-    var client_id = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-      var r = Math.random() * 16 | 0;
-      var v = c === 'x' ? r : (r & 0x3 | 0x8);
-      return v.toString(16);
-    });
-
-    if (this.client_id_storage_location === 'cookie') {
-      this.set_cookie(this.cookie_name_client_id, client_id);
+    var client_id;
+
+    if (!this.on_node) {
+      var cookie_persisted_client_id = this.get_cookie(this.cookie_name_client_id);
+      var local_persisted_client_id = this.get_local_object(this.local_name_client_id);
+
+      if (this.client_id_storage_location === 'cookie') {
+        if (local_persisted_client_id) {
+          client_id = local_persisted_client_id;
+          this.set_cookie(this.cookie_name_client_id, client_id);
+          this.delete_local_object(this.local_name_client_id);
+        }
+      }
+
+      if (this.client_id_storage_location === 'local') {
+        if (cookie_persisted_client_id) {
+          client_id = cookie_persisted_client_id;
+          this.set_local_object(this.local_name_client_id, client_id);
+          this.delete_cookie(this.cookie_name_client_id);
+        }
+      }
     }
 
-    if (this.client_id_storage_location === 'local') {
-      this.set_local_object(this.local_name_client_id, client_id);
+    if (!client_id) {
+      client_id = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+        var r = Math.random() * 16 | 0;
+        var v = c === 'x' ? r : (r & 0x3 | 0x8);
+        return v.toString(16);
+      });
+
+      if (this.client_id_storage_location === 'cookie') {
+        this.set_cookie(this.cookie_name_client_id, client_id);
+      }
+
+      if (this.client_id_storage_location === 'local') {
+        this.set_local_object(this.local_name_client_id, client_id);
+      }
     }
 
     return client_id;
@@ -143,13 +168,33 @@
     }
   };
 
+  ConstructorioID.prototype.delete_local_object = function (key) {
+    var localStorage = window && window.localStorage;
+
+    if (localStorage && typeof key === 'string') {
+      try {
+        localStorage.removeItem(key);
+      } catch (e) {
+        // fail silently
+      }
+    }
+  };
+
   ConstructorioID.prototype.generate_session_id = function () {
+    var cookie_persisted_session_data = this.get_cookie(this.cookie_name_session_data);
+    var local_persisted_session_data = this.get_local_object(this.local_name_session_data);
     var now = Date.now();
     var thirtyMinutes = 1000 * 60 * 30;
     var sessionData;
 
     if (this.session_id_storage_location === 'local') {
       sessionData = this.get_local_object(this.local_name_session_data);
+
+      if (!sessionData && cookie_persisted_session_data) {
+        sessionData = cookie_persisted_session_data;
+
+        this.delete_cookie(this.cookie_name_session_data);
+      }
     }
 
     if (this.session_id_storage_location === 'cookie') {
@@ -160,6 +205,12 @@
       } catch (e) {
         // fail silently
       }
+
+      if (!sessionData && local_persisted_session_data) {
+        sessionData = local_persisted_session_data;
+
+        this.delete_local_object(this.local_name_session_data);
+      }
     }
 
     var sessionId = 1;