DevTools: DOMStorage should notify the view about storage modifications instead of DOMStorageModel

Source/devtools/front_end/DOMStorage.js

 /*
  * Copyright (C) 2008 Nokia Inc.  All rights reserved.
  * Copyright (C) 2013 Samsung Electronics. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 11 matching lines @@
  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 /**
  * @constructor
+ * @extends {WebInspector.Object}
  * @param {string} securityOrigin
  * @param {boolean} isLocalStorage
  */
 WebInspector.DOMStorage = function(securityOrigin, isLocalStorage)
 {
     this._securityOrigin = securityOrigin;
     this._isLocalStorage = isLocalStorage;
     this._storageHistory = new WebInspector.DOMStorageHistory(this);
 }
 
 /**
  * @param {string} securityOrigin
  * @param {boolean} isLocalStorage
  * @return {DOMStorageAgent.StorageId}
  */
 WebInspector.DOMStorage.storageId = function(securityOrigin, isLocalStorage)
 {
     return { securityOrigin: securityOrigin, isLocalStorage: isLocalStorage };
 }
 
+WebInspector.DOMStorage.Events = {
+    DOMStorageItemsCleared: "DOMStorageItemsCleared",
+    DOMStorageItemRemoved: "DOMStorageItemRemoved",
+    DOMStorageItemAdded: "DOMStorageItemAdded",
+    DOMStorageItemUpdated: "DOMStorageItemUpdated"
+}
+
 WebInspector.DOMStorage.prototype = {
 
     /** @return {DOMStorageAgent.StorageId} */
     get id()
     {
         return WebInspector.DOMStorage.storageId(this._securityOrigin, this._isLocalStorage);
     },
 
     /** @return {string} */
     get securityOrigin()
@@ skipping 33 matching lines @@
     },
 
     undo: function()
     {
         this._storageHistory.undo();
     },
 
     redo: function()
     {
         this._storageHistory.redo();
-    }
+    },
+
+    __proto__: WebInspector.Object.prototype
 }
 
 /**
  * @constructor
  * @param {WebInspector.DOMStorage} domStorage
  */
 WebInspector.DOMStorageAction = function(domStorage)
 {
     this._domStorage = domStorage;
 }
@@ skipping 202 matching lines @@
     /** @type {!Object.<string, !WebInspector.DOMStorage>} */
     this._storages = {};
     InspectorBackend.registerDOMStorageDispatcher(new WebInspector.DOMStorageDispatcher(this));
     DOMStorageAgent.enable();
     WebInspector.resourceTreeModel.addEventListener(WebInspector.ResourceTreeModel.EventTypes.SecurityOriginAdded, this._securityOriginAdded, this);
     WebInspector.resourceTreeModel.addEventListener(WebInspector.ResourceTreeModel.EventTypes.SecurityOriginRemoved, this._securityOriginRemoved, this);
 }
 
 WebInspector.DOMStorageModel.Events = {
     DOMStorageAdded: "DOMStorageAdded",
-    DOMStorageRemoved: "DOMStorageRemoved",
-    DOMStorageItemsCleared: "DOMStorageItemsCleared",
-    DOMStorageItemRemoved: "DOMStorageItemRemoved",
-    DOMStorageItemAdded: "DOMStorageItemAdded",
-    DOMStorageItemUpdated: "DOMStorageItemUpdated"
+    DOMStorageRemoved: "DOMStorageRemoved"
 }
 
 WebInspector.DOMStorageModel.prototype = {
+    /**
+     * @param {DOMStorageAgent.StorageId} storageId
+     * @param {WebInspector.DOMStorage.Event} eventType
+     * @param {Object} eventData
+     */
+    domStorageModified: function(storageId, eventType, eventData)

[pfeldman, 2013/08/23 12:17:51]

This can be private (private things are private to file, not class). Call it
_fireDOMStorageEvent

+    {
+        var domStorage = this.storageForId(storageId);
+        if (!domStorage)
+            return;
+
+        domStorage.dispatchEventToListeners(eventType, eventData);
+    },
 
     /**
      * @param {WebInspector.Event} event
      */
     _securityOriginAdded: function(event)
     {
         var securityOrigin = /** @type {string} */ (event.data);
         var localStorageKey = this._storageKey(securityOrigin, true);
         console.assert(!this._storages[localStorageKey]);
         var localStorage = new WebInspector.DOMStorage(securityOrigin, true);
@@ skipping 31 matching lines @@
      * @param {boolean} isLocalStorage
      * @return {string}
      */
     _storageKey: function(securityOrigin, isLocalStorage)
     {
         return JSON.stringify(WebInspector.DOMStorage.storageId(securityOrigin, isLocalStorage));
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
-     */
-    _domStorageItemsCleared: function(storageId)
-    {
-        var domStorage = this.storageForId(storageId);
-        var storageData = {
-            storage: domStorage
-        };
-        this.dispatchEventToListeners(WebInspector.DOMStorageModel.Events.DOMStorageItemsCleared, storageData);

[pfeldman, 2013/08/23 12:17:51]

It looks like changing this with domStorage.dispatchEventToListeners will
produce smaller diff and achieve similar result.

[vivekg__, 2013/08/23 13:19:37]

Sounds great. Will revert this. Thanks!

-    },
-
-    /**
-     * @param {DOMStorageAgent.StorageId} storageId
-     * @param {string} key
-     */
-    _domStorageItemRemoved: function(storageId, key)
-    {
-        var domStorage = this.storageForId(storageId);
-        var storageData = {
-            storage: domStorage,
-            key: key
-        };
-        this.dispatchEventToListeners(WebInspector.DOMStorageModel.Events.DOMStorageItemRemoved, storageData);
-    },
-
-    /**
-     * @param {DOMStorageAgent.StorageId} storageId
-     * @param {string} key
-     * @param {string} newValue
-     */
-    _domStorageItemAdded: function(storageId, key, newValue)
-    {
-        var domStorage = this.storageForId(storageId);
-        var storageData = {
-            storage: domStorage,
-            key: key,
-            newValue: newValue
-        };
-        this.dispatchEventToListeners(WebInspector.DOMStorageModel.Events.DOMStorageItemAdded, storageData);
-    },
-
-    /**
-     * @param {DOMStorageAgent.StorageId} storageId
-     * @param {string} key
-     * @param {string} oldValue
-     * @param {string} newValue
-     */
-    _domStorageItemUpdated: function(storageId, key, oldValue, newValue)
-    {
-        var domStorage = this.storageForId(storageId);
-        var storageData = {
-            storage: domStorage,
-            key: key,
-            oldValue: oldValue,
-            newValue: newValue
-        };
-        this.dispatchEventToListeners(WebInspector.DOMStorageModel.Events.DOMStorageItemUpdated, storageData);
-    },
-
-    /**
-     * @param {DOMStorageAgent.StorageId} storageId
      * @return {WebInspector.DOMStorage}
      */
     storageForId: function(storageId)
     {
         return this._storages[JSON.stringify(storageId)];
     },
 
     /**
      * @return {Array.<WebInspector.DOMStorage>}
      */
@@ skipping 18 matching lines @@
     this._model = model;
 }
 
 WebInspector.DOMStorageDispatcher.prototype = {
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      */
     domStorageItemsCleared: function(storageId)
     {
-        this._model._domStorageItemsCleared(storageId);
+        var eventType = WebInspector.DOMStorage.Events.DOMStorageItemsCleared;
+        var eventData = {};
+        this._model.domStorageModified(storageId, eventType, eventData);
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      * @param {string} key
      */
     domStorageItemRemoved: function(storageId, key)
     {
-        this._model._domStorageItemRemoved(storageId, key);
+        var eventType = WebInspector.DOMStorage.Events.DOMStorageItemRemoved;
+        var eventData = { key: key };
+        this._model.domStorageModified(storageId, eventType, eventData);
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      * @param {string} key
-     * @param {string} newValue
+     * @param {string} value
      */
-    domStorageItemAdded: function(storageId, key, newValue)
+    domStorageItemAdded: function(storageId, key, value)
     {
-        this._model._domStorageItemAdded(storageId, key, newValue);
+        var eventType = WebInspector.DOMStorage.Events.DOMStorageItemAdded;
+        var eventData = { key: key, value: value };
+        this._model.domStorageModified(storageId, eventType, eventData);
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      * @param {string} key
      * @param {string} oldValue
-     * @param {string} newValue
+     * @param {string} value
      */
-    domStorageItemUpdated: function(storageId, key, oldValue, newValue)
+    domStorageItemUpdated: function(storageId, key, oldValue, value)
     {
-        this._model._domStorageItemUpdated(storageId, key, oldValue, newValue);
+        var eventType = WebInspector.DOMStorage.Events.DOMStorageItemUpdated;
+        var eventData = { key: key, oldValue: oldValue, value: value };
+        this._model.domStorageModified(storageId, eventType, eventData);
     },
 }
 
 /**
  * @type {WebInspector.DOMStorageModel}
  */
 WebInspector.domStorageModel = null;