DevTools: DOMStorage action history must be reset once page/script modifies the DOM storage

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 94 matching lines @@
     undo: function()
     {
         this._storageHistory.undo();
     },
 
     redo: function()
     {
         this._storageHistory.redo();
     },
 
+    resetUndoHistory: function()
+    {
+        this._storageHistory.reset();
+    },
+
     __proto__: WebInspector.Object.prototype
 }
 
 /**
  * @constructor
  * @param {WebInspector.DOMStorage} domStorage
  */
 WebInspector.DOMStorageAction = function(domStorage)
 {
     this._domStorage = domStorage;
@@ skipping 49 matching lines @@
             this.redo();
             callback();
         }
     },
 
     /**
      * @override
      */
     undo: function()
     {
+        this._domStorage._inspectorInitiated = true;
         DOMStorageAgent.setDOMStorageItem(this._domStorage.id, this._key, this._value);
     },
 
     /**
      * @override
      */
     redo: function()
     {
+        this._domStorage._inspectorInitiated = true;
         DOMStorageAgent.removeDOMStorageItem(this._domStorage.id, this._key);
     },
 
     __proto__: WebInspector.DOMStorageAction.prototype
 }
 
 /**
  * @constructor
  * @extends {WebInspector.DOMStorageAction}
  * @param {WebInspector.DOMStorage} domStorage
@@ skipping 33 matching lines @@
             this.redo();
             callback();
         }
     },
 
     /**
      * @override
      */
     undo: function()
     {
+        this._domStorage._inspectorInitiated = true;
         if (!this._exists)
             DOMStorageAgent.removeDOMStorageItem(this._domStorage.id, this._key);
         else
             DOMStorageAgent.setDOMStorageItem(this._domStorage.id, this._key, this._oldValue);
     },
 
     /**
      * @override
      */
     redo: function()
     {
+        this._domStorage._inspectorInitiated = true;
         DOMStorageAgent.setDOMStorageItem(this._domStorage.id, this._key, this._value);
     },
 
     __proto__: WebInspector.DOMStorageAction.prototype
 }
 
 /**
  * @constructor
  * @param {WebInspector.DOMStorage} domStorage
  */
@@ skipping 43 matching lines @@
     },
 
     redo: function()
     {
         if (this._undoableActionIndex >= this._actions.length - 1)
             return;
 
         var action = this._actions[++this._undoableActionIndex];
         console.assert(action);
         action.redo();
+    },
+
+    reset: function()
+    {
+        this._actions.splice(0, this._actions.length);
+        this._undoableActionIndex = -1;
     }
 }
 
 /**
  * @constructor
  * @extends {WebInspector.Object}
  */
 WebInspector.DOMStorageModel = function()
 {
     /** @type {!Object.<string, !WebInspector.DOMStorage>} */
@@ skipping 60 matching lines @@
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      */
     _domStorageItemsCleared: function(storageId)
     {
         var domStorage = this.storageForId(storageId);
         if (!domStorage)
             return;
+        if (typeof domStorage._inspectorInitiated === "undefined")
+            domStorage.resetUndoHistory();
+        delete domStorage._inspectorInitiated;
 
         var eventData = {};
         domStorage.dispatchEventToListeners(WebInspector.DOMStorage.Events.DOMStorageItemsCleared, eventData);
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      * @param {string} key
      */
     _domStorageItemRemoved: function(storageId, key)
     {
         var domStorage = this.storageForId(storageId);
         if (!domStorage)
             return;
+        if (typeof domStorage._inspectorInitiated === "undefined")
+            domStorage.resetUndoHistory();

[pfeldman, 2013/08/27 14:27:34]

Due to async nature of things, it is not necessarily initiated by inspector.
Consider the following case:

1) User clicks "remove item" in the inspector on key "a"
2) While request is going over the wire, page removes "b" from localStorage 
3) this method is invoked and it thinks that "b" removal was initiated by the
inspector

and vice versa. The only way to figure out who initiated the mutation is to
process it on backend synchronously.

+        delete domStorage._inspectorInitiated;
 
         var eventData = { key: key };
         domStorage.dispatchEventToListeners(WebInspector.DOMStorage.Events.DOMStorageItemRemoved, eventData);
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      * @param {string} key
      * @param {string} value
      */
     _domStorageItemAdded: function(storageId, key, value)
     {
         var domStorage = this.storageForId(storageId);
         if (!domStorage)
             return;
+        if (typeof domStorage._inspectorInitiated === "undefined")
+            domStorage.resetUndoHistory();
+        delete domStorage._inspectorInitiated;
 
         var eventData = { key: key, value: value };
         domStorage.dispatchEventToListeners(WebInspector.DOMStorage.Events.DOMStorageItemAdded, eventData);
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      * @param {string} key
      * @param {string} oldValue
      * @param {string} value
      */
     _domStorageItemUpdated: function(storageId, key, oldValue, value)
     {
         var domStorage = this.storageForId(storageId);
         if (!domStorage)
             return;
+        if (typeof domStorage._inspectorInitiated === "undefined")
+            domStorage.resetUndoHistory();
+        delete domStorage._inspectorInitiated;
 
         var eventData = { key: key, oldValue: oldValue, value: value };
         domStorage.dispatchEventToListeners(WebInspector.DOMStorage.Events.DOMStorageItemUpdated, eventData);
     },
 
     /**
      * @param {DOMStorageAgent.StorageId} storageId
      * @return {WebInspector.DOMStorage}
      */
     storageForId: function(storageId)
@@ skipping 63 matching lines @@
     domStorageItemUpdated: function(storageId, key, oldValue, value)
     {
         this._model._domStorageItemUpdated(storageId, key, oldValue, value);
     },
 }
 
 /**
  * @type {WebInspector.DOMStorageModel}
  */
 WebInspector.domStorageModel = null;