From f9e8a00081a0f62854881bfa8f504aa5e4fded91 Mon Sep 17 00:00:00 2001
From: rodrigopavezi <rodrigopavezi@gmail.com>
Date: Thu, 27 Jul 2017 15:36:21 -0300
Subject: [PATCH 1/3] Implemented ability to tell which storage, local or
 session to be used

---
 bower.json                                    |   2 +-
 package.json                                  |   8 +-
 rise-data.html                                |  73 ++++++++---
 test/unit/rise-data-cache.html                |   2 +-
 .../rise-data-local-storage-rc-running.html   |   2 +-
 test/unit/rise-data-local-storage.html        |   2 +-
 .../rise-data-none-storage-rc-running.html    | 106 +++++++++++++++
 .../rise-data-session-storage-rc-running.html |  99 ++++++++++++++
 test/unit/rise-data-session-storage.html      | 123 ++++++++++++++++++
 test/unit/rise-data.html                      |   2 +-
 10 files changed, 395 insertions(+), 24 deletions(-)
 create mode 100644 test/unit/rise-data-none-storage-rc-running.html
 create mode 100644 test/unit/rise-data-session-storage-rc-running.html
 create mode 100644 test/unit/rise-data-session-storage.html

diff --git a/bower.json b/bower.json
index 6ac37df..42d8cf7 100644
--- a/bower.json
+++ b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "rise-data",
-  "version": "1.3.7",
+  "version": "1.3.8",
   "authors": [
     "Rise Vision"
   ],
diff --git a/package.json b/package.json
index 5f3c07e..b207cd1 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rise-data",
-  "version": "1.3.7",
+  "version": "1.3.8",
   "description": "Web component for storing data",
   "scripts": {
     "test": "gulp test",
@@ -28,7 +28,7 @@
   "devDependencies": {
     "colors": "~1.1.0",
     "del": "~1.1.1",
-    "eslint": "^3.8.1",
+    "eslint": "^3.19.0",
     "eslint-config-idiomatic": "^2.1.0",
     "eslint-plugin-html": "^1.6.0",
     "gulp": "~3.8.10",
@@ -37,7 +37,7 @@
     "gulp-eslint": "^3.0.1",
     "gulp-html-replace": "~1.6.1",
     "run-sequence": "~1.1.0",
-    "web-component-tester": "*",
-    "widget-tester": "git://github.com/Rise-Vision/widget-tester.git"
+    "web-component-tester": "^6.0.0",
+    "widget-tester": "git://github.com/Rise-Vision/widget-tester.git#feature/session-storage-mock"
   }
 }
diff --git a/rise-data.html b/rise-data.html
index c367151..c953ff1 100644
--- a/rise-data.html
+++ b/rise-data.html
@@ -32,7 +32,7 @@
 </dom-module>
 
 <!-- build:version -->
-<script>var dataVersion = "1.3.7";</script>
+<script>var dataVersion = "1.3.8";</script>
 <!-- endbuild -->
 
 <script>
@@ -51,6 +51,14 @@
       }
     }
 
+    function supportsSessionStorage() {
+      try {
+        return "sessionStorage" in window && window.sessionStorage !== null;
+      } catch ( e ) {
+        return false;
+      }
+    }
+
     Polymer( {
       is: "rise-data",
 
@@ -70,8 +78,15 @@
         usage: {
           type: String,
           value: ""
-        }
+        },
 
+        /**
+         * The optional browser local storage type: None, Session or Local
+         */
+        storageType: {
+          type: String,
+          value: "none"
+        }
       },
 
       _isCacheRunning: false,
@@ -100,6 +115,14 @@
         return usage === "standalone" || usage === "widget";
       },
 
+      _isSessionStorage: function() {
+        return this.storageType === "session"
+      },
+
+      _isLocalStorage: function() {
+        return this.storageType === "local"
+      },
+
       _isRiseCacheSchemeEnabled: function() {
         try {
           if ( top.enableRiseCacheScheme ) {
@@ -131,16 +154,24 @@
         return body;
       },
 
-      _getCachedDataFromLocalStorage: function( key, cb ) {
+      _getCachedDataFromStorage: function( key, cb ) {
         var data = null;
 
-        if ( supportsLocalStorage() ) {
-          // retrieve cached data and parse back
-          data = JSON.parse( localStorage.getItem( key ), this._dateReviver );
-          cb( data );
-        } else {
-          cb( data );
+        if ( this._isLocalStorage() && supportsLocalStorage() ) {
+          try {
+            data = JSON.parse( localStorage.getItem( key ), this._dateReviver );
+          } catch ( e ) {
+            console.warn( e ); // eslint-disable-line no-console
+          }
+        } else if ( this._isSessionStorage() && supportsSessionStorage() ) {
+          try {
+            data = JSON.parse( sessionStorage.getItem( key ), this._dateReviver );
+          } catch ( e ) {
+            console.warn( e ); // eslint-disable-line no-console
+          }
         }
+
+        cb( data );
       },
 
       _getParamsForLoggingError: function( message ) {
@@ -165,7 +196,7 @@
         if ( this.$.cache.method === "GET" && this._callback && typeof this._callback === "function" ) {
 
           // fallback to get data from local storage
-          this._getCachedDataFromLocalStorage( this._key, this._callback );
+          this._getCachedDataFromStorage( this._key, this._callback );
 
           // don't continue with logging if 404
           if ( resp.request.status === 404 ) {
@@ -389,11 +420,17 @@
               this._save( key, data );
             }
           }
-          if ( supportsLocalStorage() ) {
+          if ( this._isLocalStorage() && supportsLocalStorage() ) {
             try {
               localStorage.setItem( key, JSON.stringify( data ) );
             } catch ( e ) {
-              // TODO: use logger to log failure?
+              console.warn( e ); // eslint-disable-line no-console
+            }
+          } else if ( this._isSessionStorage() && supportsSessionStorage() ) {
+            try {
+              sessionStorage.setItem( key, JSON.stringify( data ) );
+            } catch ( e ) {
+              console.warn( e ); // eslint-disable-line no-console
             }
           }
         }
@@ -429,7 +466,7 @@
         if ( this._pingReceived && key && cb && typeof cb === "function" ) {
           if ( !this._isCacheRunning ) {
 
-            this._getCachedDataFromLocalStorage( key, cb );
+            this._getCachedDataFromStorage( key, cb );
 
           } else {
             if ( this.endpoint ) {
@@ -454,11 +491,17 @@
             }
           }
 
-          if ( supportsLocalStorage() ) {
+          if ( this._isLocalStorage() && supportsLocalStorage() ) {
             try {
               localStorage.removeItem( key );
             } catch ( ex ) {
-              // TODO: use logger to log failure?
+              console.warn( ex ); // eslint-disable-line no-console
+            }
+          } else if ( this._isSessionStorage() && supportsSessionStorage() ) {
+            try {
+              sessionStorage.removeItem( key );
+            } catch ( ex ) {
+              console.warn( ex ); // eslint-disable-line no-console
             }
           }
         }
diff --git a/test/unit/rise-data-cache.html b/test/unit/rise-data-cache.html
index 35040b3..7220833 100644
--- a/test/unit/rise-data-cache.html
+++ b/test/unit/rise-data-cache.html
@@ -12,7 +12,7 @@
 </head>
 <body>
 
-<rise-data id="request"></rise-data>
+<rise-data id="request" storage-type="local"></rise-data>
 
 <script src="../data/sheet.js"></script>
 <script src="../../node_modules/widget-tester/mocks/localStorage-mock.js"></script>
diff --git a/test/unit/rise-data-local-storage-rc-running.html b/test/unit/rise-data-local-storage-rc-running.html
index f5e55bb..26032e7 100644
--- a/test/unit/rise-data-local-storage-rc-running.html
+++ b/test/unit/rise-data-local-storage-rc-running.html
@@ -12,7 +12,7 @@
 </head>
 <body>
 
-<rise-data id="request"></rise-data>
+<rise-data id="request" storage-type="local"></rise-data>
 
 <script src="../data/sheet.js"></script>
 <script src="../../node_modules/widget-tester/mocks/localStorage-mock.js"></script>
diff --git a/test/unit/rise-data-local-storage.html b/test/unit/rise-data-local-storage.html
index 72a489e..39b9c0a 100644
--- a/test/unit/rise-data-local-storage.html
+++ b/test/unit/rise-data-local-storage.html
@@ -12,7 +12,7 @@
 </head>
 <body>
 
-<rise-data id="request"></rise-data>
+<rise-data id="request" storage-type="local"></rise-data>
 
 <script src="../data/sheet.js"></script>
 <script src="../../node_modules/widget-tester/mocks/localStorage-mock.js"></script>
diff --git a/test/unit/rise-data-none-storage-rc-running.html b/test/unit/rise-data-none-storage-rc-running.html
new file mode 100644
index 0000000..53ef809
--- /dev/null
+++ b/test/unit/rise-data-none-storage-rc-running.html
@@ -0,0 +1,106 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
+  <title>rise-data</title>
+
+  <script src="../../bower_components/webcomponentsjs/webcomponents.min.js"></script>
+  <script src="../../bower_components/web-component-tester/browser.js"></script>
+
+  <link rel="import" href="../../rise-data.html">
+</head>
+<body>
+
+<rise-data id="request"></rise-data>
+
+<script src="../data/sheet.js"></script>
+<script src="../../node_modules/widget-tester/mocks/localStorage-mock.js"></script>
+<script src="../../node_modules/widget-tester/mocks/sessionStorage-mock.js"></script>
+
+<script>
+  /* global sinon, suite, test, assert, suiteSetup, suiteTeardown, setup, teardown, sheetKey, sheetData */
+
+  var dataRequest = document.querySelector( "#request" );
+
+  // mock logger getting display id and force RC running
+  sinon.stub( dataRequest.$.logger.$.displayId, "generateRequest", function() {
+    dataRequest.$.logger._onDisplayIdResponse( null, { response: { displayId: "abc123" } } );
+  } );
+
+  // mock ping and force RC running
+  sinon.stub( dataRequest.$.ping, "generateRequest", function() {
+    dataRequest._handlePingResponse( null, { response: { name: "rise-cache-v2", version: "0.0.0" } } );
+  } );
+
+  suite( "sessionStorage when RC is running", function() {
+    suiteSetup( function() {
+      dataRequest.endpoint = "spreadsheets"
+    } );
+
+    suiteTeardown( function() {
+      dataRequest.$.logger.$.displayId.generateRequest.restore();
+      dataRequest.$.ping.generateRequest.restore();
+    } );
+
+    suite( "RC running", function() {
+
+      test( "should not save to session or local storage even though it saves to RC", function() {
+
+        var sessionStorageSetItemStub = sinon.stub( sessionStorage, "setItem" ),
+          localStorageSetItemStub = sinon.stub( localStorage, "setItem" );
+
+        dataRequest.saveItem( sheetKey, { results: sheetData.values } );
+
+        assert.isFalse( sessionStorageSetItemStub.called );
+        assert.isFalse( localStorageSetItemStub.called );
+
+      } );
+    } );
+
+    suite( "RC fail to get", function() {
+
+      setup( function() {
+        // mock ping and force RC running
+        sinon.stub( dataRequest.$.cache, "generateRequest", function() {
+          var resp = { request: { status: 404 } };
+
+          dataRequest._handleCacheError( null, resp );
+        } );
+
+        sessionStorage.setItem( sheetKey, JSON.stringify( { results: sheetData.values } ) );
+        localStorage.setItem( sheetKey, JSON.stringify( { results: sheetData.values } ) );
+      } );
+
+      teardown( function() {
+        window.sessionStorageError = false;
+        sessionStorage.removeItem( sheetKey );
+
+        window.localStorageError = false;
+        localStorage.removeItem( sheetKey );
+        dataRequest.$.cache.generateRequest.restore();
+      } );
+
+      test( "should not get data from session or local storage if it fails to get from RC", function() {
+
+        var sessionStorageGetItemStub = sinon.stub( sessionStorage, "getItem", function() {
+            return JSON.stringify( { results: sheetData.values } );
+          } ),
+          localStorageGetItemStub = sinon.stub( localStorage, "getItem", function() {
+            return JSON.stringify( { results: sheetData.values } );
+          } );
+
+        dataRequest.getItem( sheetKey, function() {} );
+
+        assert.isFalse( sessionStorageGetItemStub.called );
+        assert.isFalse( localStorageGetItemStub.called );
+
+      } );
+    } );
+
+
+
+  } );
+</script>
+</body>
+</html>
diff --git a/test/unit/rise-data-session-storage-rc-running.html b/test/unit/rise-data-session-storage-rc-running.html
new file mode 100644
index 0000000..bae2d50
--- /dev/null
+++ b/test/unit/rise-data-session-storage-rc-running.html
@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
+  <title>rise-data</title>
+
+  <script src="../../bower_components/webcomponentsjs/webcomponents.min.js"></script>
+  <script src="../../bower_components/web-component-tester/browser.js"></script>
+
+  <link rel="import" href="../../rise-data.html">
+</head>
+<body>
+
+<rise-data id="request" storage-type="session"></rise-data>
+
+<script src="../data/sheet.js"></script>
+<script src="../../node_modules/widget-tester/mocks/sessionStorage-mock.js"></script>
+
+<script>
+  /* global sinon, suite, test, assert, suiteSetup, suiteTeardown, setup, teardown, sheetKey, sheetData */
+
+  var dataRequest = document.querySelector( "#request" );
+
+  // mock logger getting display id and force RC running
+  sinon.stub( dataRequest.$.logger.$.displayId, "generateRequest", function() {
+    dataRequest.$.logger._onDisplayIdResponse( null, { response: { displayId: "abc123" } } );
+  } );
+
+  // mock ping and force RC running
+  sinon.stub( dataRequest.$.ping, "generateRequest", function() {
+    dataRequest._handlePingResponse( null, { response: { name: "rise-cache-v2", version: "0.0.0" } } );
+  } );
+
+  suite( "sessionStorage when RC is running", function() {
+    suiteSetup( function() {
+      dataRequest.endpoint = "spreadsheets"
+    } );
+
+    suiteTeardown( function() {
+      dataRequest.$.logger.$.displayId.generateRequest.restore();
+      dataRequest.$.ping.generateRequest.restore();
+    } );
+
+    suite( "RC running", function() {
+
+      teardown( function() {
+        window.sessionStorageError = false;
+        sessionStorage.removeItem( sheetKey );
+        sessionStorage.setItem.restore();
+      } );
+
+      test( "should save to session storage even though it saves to RC", function() {
+
+        var sessionStorageSetItemStub = sinon.stub( sessionStorage, "setItem" );
+
+        dataRequest.saveItem( sheetKey, { results: sheetData.values } );
+
+        assert( sessionStorageSetItemStub.called );
+      } );
+    } );
+
+    suite( "RC fail to get", function() {
+
+      setup( function() {
+        // mock ping and force RC running
+        sinon.stub( dataRequest.$.cache, "generateRequest", function() {
+          var resp = { request: { status: 404 } };
+
+          dataRequest._handleCacheError( null, resp );
+        } );
+
+        sessionStorage.setItem( sheetKey, JSON.stringify( { results: sheetData.values } ) );
+      } );
+
+      teardown( function() {
+        window.sessionStorageError = false;
+        sessionStorage.removeItem( sheetKey );
+        dataRequest.$.cache.generateRequest.restore();
+      } );
+
+      test( "should get data from session storage if it fails to get from RC", function() {
+
+        var sessionStorageGetItemStub = sinon.stub( sessionStorage, "getItem", function() {
+          return JSON.stringify( { results: sheetData.values } );
+        } );
+
+        dataRequest.getItem( sheetKey, function() {} );
+
+        assert( sessionStorageGetItemStub.called );
+      } );
+    } );
+
+
+
+  } );
+</script>
+</body>
+</html>
diff --git a/test/unit/rise-data-session-storage.html b/test/unit/rise-data-session-storage.html
new file mode 100644
index 0000000..daff227
--- /dev/null
+++ b/test/unit/rise-data-session-storage.html
@@ -0,0 +1,123 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
+  <title>rise-data</title>
+
+  <script src="../../bower_components/webcomponentsjs/webcomponents.min.js"></script>
+  <script src="../../bower_components/web-component-tester/browser.js"></script>
+
+  <link rel="import" href="../../rise-data.html">
+</head>
+<body>
+
+<rise-data id="request" storage-type="session"></rise-data>
+
+<script src="../data/sheet.js"></script>
+<script src="../../node_modules/widget-tester/mocks/sessionStorage-mock.js"></script>
+
+<script>
+  /* global sinon, suite, test, assert, setup, teardown, sheetKey, sheetData */
+
+  var dataRequest = document.querySelector( "#request" );
+
+  // mock logger getting display id and force handler RC not running
+  sinon.stub( dataRequest.$.logger.$.displayId, "generateRequest", function() {
+    dataRequest.$.logger._onDisplayIdError();
+  } );
+
+  // mock ping and force handler of RC not running
+  sinon.stub( dataRequest.$.ping, "generateRequest", function() {
+    dataRequest._handlePingError();
+  } );
+
+  suite( "sessionStorage", function() {
+
+    suite( "saveItem", function() {
+
+      teardown( function() {
+        window.sessionStorageError = false;
+        sessionStorage.removeItem( sheetKey );
+      } );
+
+      test( "should ensure data passed in sessionStorage.setItem() is stringified", function() {
+        var value;
+
+        dataRequest.saveItem( sheetKey, { results: sheetData.values } );
+
+        value = sessionStorage.getItem( sheetKey );
+
+        assert.isString( value );
+      } );
+
+    } );
+
+    suite( "getItem", function() {
+      teardown( function() {
+        sessionStorage.removeItem( sheetKey );
+      } );
+
+      test( "should not execute callback without key param", function() {
+        var spy = sinon.spy();
+
+        dataRequest.getItem( false, spy );
+
+        assert.equal( spy.callCount, 0 );
+      } );
+
+      test( "should execute callback with null value when no data stored", function() {
+        var spy = sinon.spy();
+
+        dataRequest.getItem( sheetKey, spy );
+
+        assert.isTrue( spy.calledWith( null ) );
+      } );
+
+      test( "should execute callback providing data", function() {
+        var spy = sinon.spy();
+
+        sessionStorage.setItem( sheetKey, JSON.stringify( { data: { results: sheetData.values }, timestamp: "" } ) );
+
+        dataRequest.getItem( sheetKey, spy );
+
+        assert.isTrue( spy.calledWith( { data: { results: sheetData.values }, timestamp: "" } ) );
+      } );
+
+      test( "should return date object when a date string is saved", function() {
+        var spy = sinon.spy();
+
+        sessionStorage.setItem( sheetKey, JSON.stringify( { data: { results: sheetData.date }, timestamp: "" } ) );
+
+        dataRequest.getItem( sheetKey, spy );
+
+        assert.isTrue( spy.calledWith( { data: { results: sheetData.date }, timestamp: "" } ) );
+      } );
+    } );
+
+    suite( "deleteItem", function() {
+      setup( function() {
+        sessionStorage.setItem( sheetKey, JSON.stringify( { data: { results: sheetData.values }, timestamp: "" } ) );
+      } );
+
+      teardown( function() {
+        sessionStorage.removeItem( sheetKey );
+      } );
+
+      test( "Should not delete data when no key provided", function() {
+        dataRequest.deleteItem();
+
+        assert.isNotNull( sessionStorage.getItem( sheetKey ) );
+      } );
+
+      test( "Should ensure data is removed", function() {
+        dataRequest.deleteItem( sheetKey );
+
+        assert.isNull( sessionStorage.getItem( sheetKey ) );
+      } );
+    } );
+
+  } );
+</script>
+</body>
+</html>
diff --git a/test/unit/rise-data.html b/test/unit/rise-data.html
index e59d094..e88cb36 100644
--- a/test/unit/rise-data.html
+++ b/test/unit/rise-data.html
@@ -12,7 +12,7 @@
 </head>
 <body>
 
-<rise-data id="request"></rise-data>
+<rise-data id="request" storage-type="local"></rise-data>
 
 <script src="../data/sheet.js"></script>
 <script src="../../node_modules/widget-tester/mocks/localStorage-mock.js"></script>

From b7b26ce836c92e04a6a703161b8701a1b1b51781 Mon Sep 17 00:00:00 2001
From: rodrigopavezi <rodrigopavezi@gmail.com>
Date: Thu, 27 Jul 2017 15:40:08 -0300
Subject: [PATCH 2/3] Updated web-testers

---
 package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/package.json b/package.json
index b207cd1..35f8e53 100644
--- a/package.json
+++ b/package.json
@@ -38,6 +38,6 @@
     "gulp-html-replace": "~1.6.1",
     "run-sequence": "~1.1.0",
     "web-component-tester": "^6.0.0",
-    "widget-tester": "git://github.com/Rise-Vision/widget-tester.git#feature/session-storage-mock"
+    "widget-tester": "git://github.com/Rise-Vision/widget-tester.git"
   }
 }

From c818600264d75a888e52894b4c38c95af1052b3b Mon Sep 17 00:00:00 2001
From: rodrigopavezi <rodrigopavezi@gmail.com>
Date: Thu, 27 Jul 2017 16:20:27 -0300
Subject: [PATCH 3/3] removed support checks

---
 rise-data.html | 28 ++++++----------------------
 1 file changed, 6 insertions(+), 22 deletions(-)

diff --git a/rise-data.html b/rise-data.html
index c953ff1..34425ae 100644
--- a/rise-data.html
+++ b/rise-data.html
@@ -43,22 +43,6 @@
 
     var BQ_TABLE_NAME = "component_data_events";
 
-    function supportsLocalStorage() {
-      try {
-        return "localStorage" in window && window.localStorage !== null;
-      } catch ( e ) {
-        return false;
-      }
-    }
-
-    function supportsSessionStorage() {
-      try {
-        return "sessionStorage" in window && window.sessionStorage !== null;
-      } catch ( e ) {
-        return false;
-      }
-    }
-
     Polymer( {
       is: "rise-data",
 
@@ -157,13 +141,13 @@
       _getCachedDataFromStorage: function( key, cb ) {
         var data = null;
 
-        if ( this._isLocalStorage() && supportsLocalStorage() ) {
+        if ( this._isLocalStorage() ) {
           try {
             data = JSON.parse( localStorage.getItem( key ), this._dateReviver );
           } catch ( e ) {
             console.warn( e ); // eslint-disable-line no-console
           }
-        } else if ( this._isSessionStorage() && supportsSessionStorage() ) {
+        } else if ( this._isSessionStorage() ) {
           try {
             data = JSON.parse( sessionStorage.getItem( key ), this._dateReviver );
           } catch ( e ) {
@@ -420,13 +404,13 @@
               this._save( key, data );
             }
           }
-          if ( this._isLocalStorage() && supportsLocalStorage() ) {
+          if ( this._isLocalStorage() ) {
             try {
               localStorage.setItem( key, JSON.stringify( data ) );
             } catch ( e ) {
               console.warn( e ); // eslint-disable-line no-console
             }
-          } else if ( this._isSessionStorage() && supportsSessionStorage() ) {
+          } else if ( this._isSessionStorage() ) {
             try {
               sessionStorage.setItem( key, JSON.stringify( data ) );
             } catch ( e ) {
@@ -491,13 +475,13 @@
             }
           }
 
-          if ( this._isLocalStorage() && supportsLocalStorage() ) {
+          if ( this._isLocalStorage() ) {
             try {
               localStorage.removeItem( key );
             } catch ( ex ) {
               console.warn( ex ); // eslint-disable-line no-console
             }
-          } else if ( this._isSessionStorage() && supportsSessionStorage() ) {
+          } else if ( this._isSessionStorage() ) {
             try {
               sessionStorage.removeItem( key );
             } catch ( ex ) {