Extend storage options (#8)

* Consistent intention on function names, update cookie name to be specific.

* Add new options while preserving default experience.

* Allow setting location based on options.

* Improve tests.

* Finalize forking of functionality based on storage location.

* Add tests to cover setting client ID in local storage.

* Remove update_cookie as it is no longer relevant.

* Add tests for setting the opposite storage location for client and session id's.

* Improve tests.

* Adjust tests to add coverage.

* Get rid of un-necessary if statement.

* Code review feedback.

Author: sblaurock

spec/001-initialization.js

@@ -9,12 +9,11 @@ describe('ConstructorioID', function () {
     var expectedKeys = [
       'set_cookie',
       'get_cookie',
-      'update_cookie',
       'delete_cookie',
       'generate_client_id',
       'get_local_object',
       'set_local_object',
-      'get_session_id'
+      'generate_session_id'
     ];
     expect(actualKeys).to.eql(expectedKeys);
   });
@@ -23,7 +22,12 @@ describe('ConstructorioID', function () {
     var session = new ConstructorioID();
     expect(session.user_agent).to.be.null;
     expect(session.persist).to.be.true;
-    expect(session.cookie_name).to.equal('ConstructorioID_client_id');
+    expect(session.client_id_cookie_name).to.equal('ConstructorioID_client_id');
+    expect(session.session_id_cookie_name).to.equal('ConstructorioID_session_id');
+    expect(session.local_name_client_id).to.equal('_constructorio_search_client');
+    expect(session.local_name_session_id).to.equal('_constructorio_search_session');
+    expect(session.client_id_storage_location).to.equal('cookie');
+    expect(session.session_id_storage_location).to.equal('local');
     expect(session.cookie_domain).to.be.null;
   });
 
@@ -34,18 +38,28 @@ describe('ConstructorioID', function () {
       user_agent: 'dummyagent',
       timeout: 1,
       persist: false,
-      cookie_name: 'dummyname',
+      client_id_cookie_name: 'dummyclientname',
+      session_id_cookie_name: 'dummysessionname',
+      local_name_client_id: 'dummyclientnamelocal',
+      local_name_session_id: 'dummysessionnamelocal',
       cookie_prefix_for_experiment: 'dummyprefix',
-      cookie_domain: 'dummydomain'
+      cookie_domain: 'dummydomain',
+      client_id_storage_location: 'foo',
+      session_id_storage_location: 'bar'
     });
     expect(session.base_url).to.equal('dummyurl');
     expect(session.ip_address).to.equal('dummyip');
     expect(session.user_agent).to.equal('dummyagent');
     expect(session.timeout).to.equal(1);
     expect(session.persist).to.be.false;
-    expect(session.cookie_name).to.equal('dummyname');
+    expect(session.client_id_cookie_name).to.equal('dummyclientname');
+    expect(session.session_id_cookie_name).to.equal('dummysessionname');
+    expect(session.local_name_client_id).to.equal('dummyclientnamelocal');
+    expect(session.local_name_session_id).to.equal('dummysessionnamelocal');
     expect(session.cookie_prefix_for_experiment).to.equal('dummyprefix');
     expect(session.cookie_domain).to.equal('dummydomain');
+    expect(session.client_id_storage_location).to.equal('foo');
+    expect(session.session_id_storage_location).to.equal('bar');
   });
 
   describe('when used in browser', function () {
@@ -65,27 +79,40 @@ describe('ConstructorioID', function () {
 
     it('should read the client id from a named cookie', function () {
       document.cookie = 'dummyname=dummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      var session = new ConstructorioID({ cookie_name: 'dummyname' });
+      var session = new ConstructorioID({ client_id_cookie_name: 'dummyname' });
       expect(session.client_id).to.equal('dummyid');
       expect(document.cookie).to.equal('dummyname=dummyid');
     });
 
-    it('should read the client id from the old cookie', function () {
-      document.cookie = 'ConstructorioAB_client_id=tummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      var session = new ConstructorioID();
-      expect(session.client_id).to.equal('tummyid');
-      expect(document.cookie).to.equal('ConstructorioID_client_id=tummyid');
-    });
-
-    it('should read the client id from the new cookie', function () {
+    it('should set the client id if missing from the default storage location', function () {
       document.cookie = 'ConstructorioID_client_id=bummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
       var session = new ConstructorioID();
       expect(session.client_id).to.equal('bummyid');
       expect(document.cookie).to.equal('ConstructorioID_client_id=bummyid');
     });
 
     it('should set the client id if missing', function () {
-      var session = new ConstructorioID({ cookie_name: 'missingname' });
+      var session = new ConstructorioID({ client_id_cookie_name: 'missingname' });
+      expect(session.client_id).to.be.a.string;
+      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');
+    });
+
+    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', 'bummyid');
+      var session = new ConstructorioID({ client_id_storage_location: 'local' });
+      expect(session.client_id).to.equal('bummyid');
+      expect(window.localStorage.getItem('_constructorio_search_client')).to.equal('bummyid');
+    });
+
+    it('should set the client id if missing and storage location is set to local', function () {
+      var session = new ConstructorioID({ client_id_cookie_name: 'missingname', client_id_storage_location: 'local' });
       expect(session.client_id).to.be.a.string;
       expect(session.client_id).to.match(/(\w|d|-){36}/);
     });
@@ -106,6 +133,19 @@ 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_id={"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 set session_is_new to false if the session is not new', function () {
       window.localStorage.setItem('_constructorio_search_session', JSON.stringify({
         sessionId: 42,
@@ -128,12 +168,34 @@ describe('ConstructorioID', function () {
       expect(session.session_is_new).to.equal(true);
     });
 
+    it('should set session_is_new to false if the session is not new and storage location is set to cookie', function () {
+      document.cookie = `ConstructorioID_session_id={"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.equal(42);
+      expect(session.session_is_new).to.be.a('boolean');
+      expect(session.session_is_new).to.equal(false);
+    });
+
+    it('should set session_is_new to true if the session is new and storage location is set to cookie', function () {
+      document.cookie = `ConstructorioID_session_id={"sessionId":42,"lastTime":${Date.now() - 1000 * 60 * 60 * 24 * 60}}; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/`;
+      var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+      expect(session.session_id).to.equal(43);
+      expect(session.session_is_new).to.be.a('boolean');
+      expect(session.session_is_new).to.equal(true);
+    });
+
     it('should set session_is_new to true if there is no local storage data', function () {
       var session = new ConstructorioID();
       expect(session.session_is_new).to.be.a('boolean');
       expect(session.session_is_new).to.equal(true);
     });
 
+    it('should set session_is_new to true if there is no cookie data and storage location is set to cookie', function () {
+      var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+      expect(session.session_is_new).to.be.a('boolean');
+      expect(session.session_is_new).to.equal(true);
+    });
+
     it('should set the user agent', function () {
       var session = new ConstructorioID();
       expect(session.user_agent).to.match(/jsdom/);

spec/005-storage.js

@@ -28,11 +28,11 @@ describe('ConstructorioID', function () {
       expect(adventuretime.jake).to.be.true;
     });
 
-    it('should not return a non-object', function () {
+    it('should not return a local string', function () {
       window.localStorage.setItem('adventuretime', 'Come on grab your friends');
       var session = new ConstructorioID();
       var adventuretime = session.get_local_object('adventuretime');
-      expect(adventuretime).to.be.undefined;
+      expect(adventuretime).to.equal('Come on grab your friends');
     });
   });
 
@@ -43,15 +43,9 @@ describe('ConstructorioID', function () {
       expect(window.localStorage.adventuretime).to.be.a.string;
       expect(JSON.parse(window.localStorage.adventuretime)).to.deep.equal({ marceline: true });
     });
-
-    it('should not set a non-object', function () {
-      var session = new ConstructorioID();
-      session.set_local_object('adventuretime', 'We\'re going to very distant lands.');
-      expect(window.localStorage.adventuretime).to.be.undefined;
-    });
   });
 
-  describe('get_session_id', function () {
+  describe('generate_session_id', function () {
     it('should return a session id from local storage if recent', function () {
       var now = Date.now();
       var session = new ConstructorioID();
@@ -62,7 +56,7 @@ describe('ConstructorioID', function () {
       }));
 
       var set_local_object = sinon.spy(ConstructorioID.prototype, 'set_local_object');
-      var session_id = session.get_session_id();
+      var session_id = session.generate_session_id();
       expect(session_id).to.be.a('number');
       expect(session_id).to.equal(42);
       expect(set_local_object.calledOnce).to.be.true;
@@ -73,7 +67,24 @@ describe('ConstructorioID', function () {
       set_local_object.restore();
     });
 
-    it('should increment session id from local storage if older than thirty minutes', function () {
+    it('should return the same session id from cookie if recent and the storage location is set to cookie', function () {
+      var now = Date.now();
+      var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+      document.cookie = `ConstructorioID_session_id={"sessionId":42,"lastTime":${now}}; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/`;
+
+      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(42);
+      expect(set_cookie.calledOnce).to.be.true;
+      expect(set_cookie.calledWith('ConstructorioID_session_id')).to.be.true;
+      expect(JSON.parse(set_cookie.getCall(0).args[1]).sessionId).to.equal(42);
+      expect(JSON.parse(set_cookie.getCall(0).args[1]).lastTime).to.be.at.least(now);
+
+      set_cookie.restore();
+    });
+
+    it('should increment session id in local storage if older than thirty minutes', function () {
       var now = Date.now();
       var session = new ConstructorioID();
       window.localStorage.clear();
@@ -83,7 +94,7 @@ describe('ConstructorioID', function () {
       }));
 
       var set_local_object = sinon.spy(ConstructorioID.prototype, 'set_local_object');
-      var session_id = session.get_session_id();
+      var session_id = session.generate_session_id();
       expect(session_id).to.be.a('number');
       expect(session_id).to.equal(43);
       expect(set_local_object.calledOnce).to.be.true;
@@ -94,13 +105,30 @@ describe('ConstructorioID', function () {
       set_local_object.restore();
     });
 
-    it('should set a session id from local storage if missing', function () {
+    it('should increment session id from cookie if older than thirty minutes and storage location is set to cookie', function () {
+      var now = Date.now();
+      var session = new ConstructorioID({ session_id_storage_location: 'cookie' });
+      document.cookie = `ConstructorioID_session_id={"sessionId":42,"lastTime":${Date.now() - 1000 * 60 * 30}}; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/`;
+
+      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.calledOnce).to.be.true;
+      expect(set_cookie.calledWith('ConstructorioID_session_id')).to.be.true;
+      expect(JSON.parse(set_cookie.getCall(0).args[1]).sessionId).to.equal(43);
+      expect(JSON.parse(set_cookie.getCall(0).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();
       window.localStorage.clear();
 
       var set_local_object = sinon.spy(ConstructorioID.prototype, 'set_local_object');
-      var session_id = session.get_session_id();
+      var session_id = session.generate_session_id();
       expect(session_id).to.be.a('number');
       expect(session_id).to.equal(1);
       expect(set_local_object.calledOnce).to.be.true;
@@ -109,5 +137,21 @@ describe('ConstructorioID', function () {
       expect(set_local_object.getCall(0).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.calledOnce).to.be.true;
+      expect(set_cookie.calledWith('ConstructorioID_session_id')).to.be.true;
+      expect(JSON.parse(set_cookie.getCall(0).args[1]).sessionId).to.equal(1);
+      expect(JSON.parse(set_cookie.getCall(0).args[1]).lastTime).to.be.at.least(now);
+      set_cookie.restore();
+    });
   });
 });

spec/006-cookies.js

@@ -39,49 +39,39 @@ describe('ConstructorioID', function () {
     });
   });
 
-  describe('update_cookie', function () {
-    it('should update a matching cookie', function () {
-      document.cookie = 'dummyname=dummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      document.cookie = 'ConstructorioAB_veggie=turnips; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      var session = new ConstructorioID({ cookie_name: 'dummyname' });
-      session.update_cookie('ConstructorioID_veggie');
-      expect(document.cookie).to.equal('dummyname=dummyid; ConstructorioID_veggie=turnips');
-    });
-
-    it('should skip a non matching cookie', function () {
-      document.cookie = 'dummyname=dummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      document.cookie = 'ConstructorioBC_veggie=turnips; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      var session = new ConstructorioID({ cookie_name: 'dummyname' });
-      session.update_cookie('ConstructorioID_veggie');
-      expect(document.cookie).to.equal('dummyname=dummyid; ConstructorioBC_veggie=turnips');
-    });
-  });
-
   describe('delete_cookie', function () {
     it('should remove a matching cookie', function () {
       document.cookie = 'dummyname=dummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
       document.cookie = 'deleteme=now; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      var session = new ConstructorioID({ cookie_name: 'dummyname' });
+      var session = new ConstructorioID({ client_id_cookie_name: 'dummyname' });
       session.delete_cookie('deleteme');
       expect(document.cookie).to.equal('dummyname=dummyid');
     });
 
     it('should skip a non-matching cookie', function () {
       document.cookie = 'dummyname=dummyid; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
       document.cookie = 'skipme=now; expires=Tue, 19 Jan 2038 03:14:07 GMT; path=/';
-      var session = new ConstructorioID({ cookie_name: 'dummyname' });
+      var session = new ConstructorioID({ client_id_cookie_name: 'dummyname' });
       session.delete_cookie('deleteme');
       expect(document.cookie).to.equal('dummyname=dummyid; skipme=now');
     });
   });
 
   describe('generate_client_id', function () {
     it('should return a client id and set the cookie', function () {
-      var session = new ConstructorioID({ cookie_name: 'monster' });
+      var session = new ConstructorioID({ client_id_cookie_name: 'monster' });
       var client_id = session.generate_client_id();
       expect(session.get_cookie('monster')).to.equal(client_id);
       expect(client_id).to.be.a.string;
       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}/);
+    });
   });
 });