Remove all properties from storage when the service is reset (#230)

Author: Eric Koleda

package.json

@@ -19,7 +19,7 @@
     "del": "^1.2.1",
     "eslint": "^4.19.1",
     "eslint-config-google": "^0.9.1",
-    "fibers": "^2.0.2",
+    "fibers": "^4.0.2",
     "gas-local": "^1.3.1",
     "gulp": "^3.9.1",
     "gulp-clean": "^0.3.2",

src/Service.js

@@ -476,7 +476,7 @@ Service_.prototype.getIdToken = function() {
  * re-authorized.
  */
 Service_.prototype.reset = function() {
-  this.getStorage().removeValue(null);
+  this.getStorage().reset();
 };
 
 /**

src/Storage.js

@@ -61,7 +61,7 @@ Storage_.prototype.getValue = function(key, optSkipMemoryCheck) {
 
   if (!optSkipMemoryCheck) {
     // Check in-memory cache.
-    if (value = this.memory_[key]) {
+    if (value = this.memory_[prefixedKey]) {
       if (value === Storage_.CACHE_NULL_VALUE) {
         return null;
       }
@@ -72,7 +72,7 @@ Storage_.prototype.getValue = function(key, optSkipMemoryCheck) {
   // Check cache.
   if (this.cache_ && (jsonValue = this.cache_.get(prefixedKey))) {
     value = JSON.parse(jsonValue);
-    this.memory_[key] = value;
+    this.memory_[prefixedKey] = value;
     if (value === Storage_.CACHE_NULL_VALUE) {
       return null;
     }
@@ -87,13 +87,13 @@ Storage_.prototype.getValue = function(key, optSkipMemoryCheck) {
           jsonValue, Storage_.CACHE_EXPIRATION_TIME_SECONDS);
     }
     value = JSON.parse(jsonValue);
-    this.memory_[key] = value;
+    this.memory_[prefixedKey] = value;
     return value;
   }
 
   // Not found. Store a special null value in the memory and cache to reduce
   // hits on the PropertiesService.
-  this.memory_[key] = Storage_.CACHE_NULL_VALUE;
+  this.memory_[prefixedKey] = Storage_.CACHE_NULL_VALUE;
   if (this.cache_) {
     this.cache_.put(prefixedKey, JSON.stringify(Storage_.CACHE_NULL_VALUE),
         Storage_.CACHE_EXPIRATION_TIME_SECONDS);
@@ -116,7 +116,7 @@ Storage_.prototype.setValue = function(key, value) {
     this.cache_.put(prefixedKey, jsonValue,
         Storage_.CACHE_EXPIRATION_TIME_SECONDS);
   }
-  this.memory_[key] = value;
+  this.memory_[prefixedKey] = value;
 };
 
 /**
@@ -125,13 +125,39 @@ Storage_.prototype.setValue = function(key, value) {
  */
 Storage_.prototype.removeValue = function(key) {
   var prefixedKey = this.getPrefixedKey_(key);
+  this.removeValueWithPrefixedKey_(prefixedKey);
+};
+
+/**
+ * Resets the storage, removing all stored data.
+ * @param {string} key The key.
+ */
+Storage_.prototype.reset = function() {
+  var prefix = this.getPrefixedKey_();
+  var prefixedKeys = Object.keys(this.memory_);
+  if (this.properties_) {
+    var props = this.properties_.getProperties();
+    prefixedKeys = Object.keys(props).filter(function(prefixedKey) {
+      return prefixedKey === prefix || prefixedKey.indexOf(prefix + '.') === 0;
+    });
+  }
+  for (var i = 0; i < prefixedKeys.length; i++) {
+    this.removeValueWithPrefixedKey_(prefixedKeys[i]);
+  };
+};
+
+/**
+ * Removes a stored value.
+ * @param {string} key The key.
+ */
+Storage_.prototype.removeValueWithPrefixedKey_ = function(prefixedKey) {
   if (this.properties_) {
     this.properties_.deleteProperty(prefixedKey);
   }
   if (this.cache_) {
     this.cache_.remove(prefixedKey);
   }
-  delete this.memory_[key];
+  delete this.memory_[prefixedKey];
 };
 
 /**

test/mocks/properties.js

@@ -16,4 +16,8 @@ MockProperties.prototype.deleteProperty = function(key) {
   delete this.store[key];
 };
 
+MockProperties.prototype.getProperties = function() {
+  return Object.assign({}, this.store);
+};
+
 module.exports = MockProperties;

test/test.js

@@ -196,6 +196,46 @@ describe('Service', function() {
       assert.notExists(cache.get(key));
       assert.notExists(properties.getProperty(key));
     });
+
+    it('should delete values in storage', function() {
+      var cache = new MockCache();
+      var properties = new MockProperties();
+      var service = OAuth2.createService('test')
+          .setPropertyStore(properties)
+          .setCache(cache);
+      var storage = service.getStorage();
+      storage.setValue('foo', 'bar');
+
+      service.reset();
+
+      assert.notExists(storage.getValue('foo'));
+    });
+
+    it('should not delete values from other services', function() {
+      var cache = new MockCache();
+      var properties = new MockProperties();
+      var service = OAuth2.createService('test')
+          .setPropertyStore(properties)
+          .setCache(cache);
+      var values = {
+        'oauth2.something': 'token',
+        'oauth2.something.foo': 'bar',
+        'oauth2.something.test': 'baz',
+        'oauth2.testing': 'token',
+        'oauth2.testing.foo': 'bar',
+      };
+      for (let [key, value] of Object.entries(values)) {
+        properties.setProperty(key, value);
+        cache.put(key, value);
+      }
+
+      service.reset();
+
+      for (let [key, value] of Object.entries(values)) {
+        assert.equal(cache.get(key), value);
+        assert.equal(properties.getProperty(key), value);
+      }
+    });
   });
 
   describe('#hasAccess()', function() {