Fixes #21: Remove TTL, and store raw values rather than JSON

Author: danielstjules

README.md

@@ -12,7 +12,7 @@ Features an API using ES6 promises.
   * [CrossStorageHub.init(permissions)](#crossstoragehubinitpermissions)
   * [new CrossStorageClient(url, \[opts\])](#new-crossstorageclienturl-opts)
   * [CrossStorageClient.prototype.onConnect()](#crossstorageclientprototypeonconnect)
-  * [CrossStorageClient.prototype.set(key, value, \[ttl\])](#crossstorageclientprototypesetkey-value-ttl)
+  * [CrossStorageClient.prototype.set(key, value)](#crossstorageclientprototypesetkey-value)
   * [CrossStorageClient.prototype.get(key1, \[key2\], \[...\])](#crossstorageclientprototypegetkey1-key2-)
   * [CrossStorageClient.prototype.del(key1, \[key2\], \[...\])](#crossstorageclientprototypedelkey1-key2-)
   * [CrossStorageClient.prototype.getKeys()](#crossstorageclientprototypegetkeys)
@@ -68,8 +68,7 @@ invalid.example.com.malicious.com.
 var storage = new CrossStorageClient('https://store.example.com/hub.html');
 
 storage.onConnect().then(function() {
-  // Set a key with a TTL of 90 seconds
-  return storage.set('newKey', 'foobar', 90000);
+  return storage.set('newKey', 'foobar');
 }).then(function() {
   return storage.get('existingKey', 'newKey');
 }).then(function(res) {
@@ -167,18 +166,15 @@ storage.onConnect().then(function() {
 });
 ```
 
-#### CrossStorageClient.prototype.set(key, value, [ttl])
+#### CrossStorageClient.prototype.set(key, value)
 
-Sets a key to the specified value, optionally accepting a ttl to passively
-expire the key after a number of milliseconds. Returns a promise that is
-fulfilled on success, or rejected if any errors setting the key occurred,
-or the request timed out.
+Sets a key to the specified value. Returns a promise that is fulfilled on
+success, or rejected if any errors setting the key occurred, or the request
+timed out.
 
 ``` javascript
 storage.onConnect().then(function() {
-  return storage.set('key', {foo: 'bar'});
-}).then(function() {
-  return storage.set('expiringKey', 'foobar', 10000);
+  return storage.set('key', JSON.stringify({foo: 'bar'}));
 });
 ```
 
@@ -295,8 +291,7 @@ If you need to maximize your storage space, consider using
 [lz-string](https://github.com/pieroxy/lz-string/). For smaller strings, it's
 not uncommon to see a 50% reduction in size when compressed, which will bring
 you a lot closer to 5 million characters. At that point, you're only limited by
-the average compression rate of your strings, as well as the minor overhead
-produced by the serialization format used by the library: JSON.
+the average compression rate of your strings.
 
 ## Building
 
@@ -311,7 +306,7 @@ the Travis CI build uses Sauce Labs for multi-browser testing as well.
 
 ## Copyright and license
 
-Copyright 2014 Zendesk
+Copyright 2016 Zendesk
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 this file except in compliance with the License.

lib/client.js

@@ -162,21 +162,18 @@
   };
 
   /**
-   * Sets a key to the specified value, optionally accepting a ttl to passively
-   * expire the key after a number of milliseconds. Returns a promise that is
-   * fulfilled on success, or rejected if any errors setting the key occurred,
-   * or the request timed out.
+   * Sets a key to the specified value. Returns a promise that is fulfilled on
+   * success, or rejected if any errors setting the key occurred, or the request
+   * timed out.
    *
    * @param   {string}  key   The key to set
    * @param   {*}       value The value to assign
-   * @param   {int}     ttl   Time to live in milliseconds
    * @returns {Promise} A promise that is settled on hub response or timeout
    */
-  CrossStorageClient.prototype.set = function(key, value, ttl) {
+  CrossStorageClient.prototype.set = function(key, value) {
     return this._request('set', {
       key:   key,
-      value: value,
-      ttl:   ttl
+      value: value
     });
   };
 

lib/hub.js

@@ -150,59 +150,36 @@
   };
 
   /**
-   * Sets a key to the specified value. If a ttl is provided, an expiration
-   * timestamp is added to the object to be stored, prior to serialization.
+   * Sets a key to the specified value.
    *
-   * @param {object} params An object with key, value and optional ttl
+   * @param {object} params An object with key and value
    */
   CrossStorageHub._set = function(params) {
-    var ttl, item;
-
-    ttl = params.ttl;
-    if (ttl && parseInt(ttl, 10) !== ttl) {
-      throw new Error('ttl must be a number');
-    }
-
-    item = {value:  params.value};
-    if (ttl) {
-      item.expire = CrossStorageHub._now() + ttl;
-    }
-
-    window.localStorage.setItem(params.key, JSON.stringify(item));
+    window.localStorage.setItem(params.key, params.value);
   };
 
   /**
    * Accepts an object with an array of keys for which to retrieve their values.
    * Returns a single value if only one key was supplied, otherwise it returns
-   * an array. Any keys not set, or expired, result in a null element in the
-   * resulting array.
+   * an array. Any keys not set result in a null element in the resulting array.
    *
    * @param   {object} params An object with an array of keys
    * @returns {*|*[]}  Either a single value, or an array
    */
   CrossStorageHub._get = function(params) {
-    var storage, result, i, item, key;
+    var storage, result, i, value;
 
     storage = window.localStorage;
     result = [];
 
     for (i = 0; i < params.keys.length; i++) {
-      key = params.keys[i];
-      
       try {
-        item = JSON.parse(storage.getItem(key));
+        value = storage.getItem(params.keys[i]);
       } catch (e) {
-        item = null;
+        value = null;
       }
 
-      if (item === null) {
-        result.push(null);
-      } else if (item.expire && item.expire < CrossStorageHub._now()) {
-        storage.removeItem(key);
-        result.push(null);
-      } else {
-        result.push(item.value);
-      }
+      result.push(value);
     }
 
     return (result.length > 1) ? result : result[0];

test/getOnlyHub.html

@@ -9,6 +9,6 @@
       {origin: /.*/, allow: ['get']}
     ]);
 
-    window.localStorage.setItem('key1', JSON.stringify({value: 'original'}));
+    window.localStorage.setItem('key1', 'original');
   </script>
 </html>

test/invalidOriginHub.html

@@ -9,6 +9,6 @@
       {origin: /^someOtherOrigin$/, allow: ['get', 'set', 'del']}
     ]);
 
-    window.localStorage.setItem('key1', JSON.stringify({value: 'original'}));
+    window.localStorage.setItem('key1', 'original');
   </script>
 </html>

test/test.js

@@ -45,9 +45,9 @@ describe('CrossStorageClient', function() {
     }
   });
 
-  var setGet = function(key, value, ttl) {
+  var setGet = function(key, value) {
     return function() {
-      return storage.set(key, value, ttl).then(function() {
+      return storage.set(key, value).then(function() {
         return storage.get(key);
       });
     };
@@ -205,7 +205,6 @@ describe('CrossStorageClient', function() {
 
     storage.onConnect().then(function() {
       storage.close();
-
       return storage.set('key1', 'new');
     })['catch'](function(err) {
       expect(err.message).to.be('CrossStorageClient has closed');
@@ -219,8 +218,7 @@ describe('CrossStorageClient', function() {
     });
 
     it('returns null when calling get on a non-existent key', function(done) {
-      storage.onConnect()
-      .then(function() {
+      storage.onConnect().then(function() {
         return storage.get('key1');
       }).then(function(res) {
         expect(res).to.be(null);
@@ -240,18 +238,6 @@ describe('CrossStorageClient', function() {
       })['catch'](done);
     });
 
-    it('can set objects as the value', function(done) {
-      var key = 'key1';
-      var object = {foo: 'bar'};
-
-      storage.onConnect()
-      .then(setGet(key, object))
-      .then(function(res) {
-        expect(res).to.eql(object);
-        done();
-      })['catch'](done);
-    });
-
     it('can overwrite existing values', function(done) {
       var key = 'key1';
       var value = 'new';
@@ -266,28 +252,6 @@ describe('CrossStorageClient', function() {
       })['catch'](done);
     });
 
-    it('can set a ttl on the key', function(done) {
-      var key = 'key1';
-      var value = 'foobar';
-
-      var delay = function() {
-        // Delay by 100ms
-        return new Promise(function(resolve, reject) {
-          setTimeout(resolve, 100);
-        });
-      };
-
-      storage.onConnect()
-      .then(setGet(key, value, 50))
-      .then(delay)
-      .then(function() {
-        return storage.get(key);
-      }).then(function(res) {
-        expect(res).to.be(null);
-        done();
-      })['catch'](done);
-    });
-
     it('returns an array of values if get is passed multiple keys', function(done) {
       var keys = ['key1', 'key2'];
       var values = ['foo', 'bar'];