DevTools: Implement undo, redo operations for the DOMStorage views.

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 18 matching lines @@
 
 /**
  * @constructor
  * @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 };
@@ skipping 26 matching lines @@
     {
         DOMStorageAgent.getDOMStorageItems(this.id, callback);
     },
 
     /**
      * @param {string} key
      * @param {string} value
      */
     setItem: function(key, value)
     {
-        DOMStorageAgent.setDOMStorageItem(this.id, key, value);
+        this._storageHistory.perform(new WebInspector.DOMStorageSetItemAction(this, key, value));
     },
 
     /**
      * @param {string} key
      */
     removeItem: function(key)
     {
-        DOMStorageAgent.removeDOMStorageItem(this.id, key);
+        this._storageHistory.perform(new WebInspector.DOMStorageRemoveItemAction(this, key));
+    },
+
+    undo: function()
+    {
+        this._storageHistory.undo();
+    },
+
+    redo: function()
+    {
+        this._storageHistory.redo();
     }
 }
 
+/**
+ * @constructor
+ * @param {WebInspector.DOMStorage} domStorage
+ */
+WebInspector.DOMStorageAction = function(domStorage)
+{
+    this._domStorage = domStorage;
+}
+
+WebInspector.DOMStorageAction.prototype = {
+    /**
+     * @param {function()} callback
+     */
+    perform: function(callback)
+    {
+    },
+
+    undo: function()
+    {
+    },
+
+    redo: function()
+    {
+    }
+}
+
+/**
+ * @constructor
+ * @extends {WebInspector.DOMStorageAction}
+ * @param {WebInspector.DOMStorage} domStorage
+ * @param {string} key
+ */
+WebInspector.DOMStorageRemoveItemAction = function(domStorage, key)
+{
+    WebInspector.DOMStorageAction.call(this, domStorage);
+    this._key = key;
+}
+
+WebInspector.DOMStorageRemoveItemAction.prototype = {
+    /**
+     * @override
+     */
+    perform: function(callback)
+    {
+        DOMStorageAgent.getDOMStorageItemValue(this._domStorage.id, this._key, valueReceived.bind(this));
+
+        /**
+         * @param {?Protocol.Error} error
+         * @param {string=} value
+         */
+        function valueReceived(error, value)
+        {
+            this._value = value;

[apavlov, 2013/08/05 09:53:00]

Ugh... hm... this doesn't handle the error, it seems.

[vivekg__, 2013/08/05 10:16:58]

Oops had missed this one. Sorry! Corrected now!

+            this.redo();
+            callback();
+        }
+    },
+
+    /**
+     * @override
+     */
+    undo: function()
+    {
+        DOMStorageAgent.setDOMStorageItem(this._domStorage.id, this._key, this._value);
+    },
+
+    /**
+     * @override
+     */
+    redo: function()
+    {
+        DOMStorageAgent.removeDOMStorageItem(this._domStorage.id, this._key);
+    },
+
+    __proto__: WebInspector.DOMStorageAction.prototype
+}
+
+/**
+ * @constructor
+ * @extends {WebInspector.DOMStorageAction}
+ * @param {WebInspector.DOMStorage} domStorage
+ * @param {string} key
+ * @param {string} value
+ */
+WebInspector.DOMStorageSetItemAction = function(domStorage, key, value)
+{
+    WebInspector.DOMStorageAction.call(this, domStorage);
+    this._key = key;
+    this._value = value;
+}
+
+WebInspector.DOMStorageSetItemAction.prototype = {
+    /**
+     * @override
+     */
+    perform: function(callback)
+    {
+        DOMStorageAgent.getDOMStorageItemValue(this._domStorage.id, this._key, valueReceived.bind(this));
+
+        /**
+         * @param {?Protocol.Error} error
+         * @param {string=} value
+         */
+        function valueReceived(error, value)
+        {
+            if (error)
+                return;

[apavlov, 2013/08/05 09:53:00]

So, you are leaving the callback to hang around forever in the event of error? I
seem to have given a sample of code to handle errors. It included the callback
invocation...

[vivekg__, 2013/08/05 10:16:58]

The history only processes the action only upon completion. No special error
handling is done by the history object. Hence in case of error, simply
returning!

+
+            if (typeof value === "undefined")
+                delete this._exists;
+            else {
+                this._exists = true;
+                this._oldValue = value;
+            }
+            this.redo();
+            callback();
+        }
+    },
+
+    /**
+     * @override
+     */
+    undo: function()
+    {
+        if (!this._exists)
+            DOMStorageAgent.removeDOMStorageItem(this._domStorage.id, this._key);
+        else
+            DOMStorageAgent.setDOMStorageItem(this._domStorage.id, this._key, this._oldValue);
+    },
+
+    /**
+     * @override
+     */
+    redo: function()
+    {
+        DOMStorageAgent.setDOMStorageItem(this._domStorage.id, this._key, this._value);
+    },
+
+    __proto__: WebInspector.DOMStorageAction.prototype
+}
+
+/**
+ * @constructor
+ * @param {WebInspector.DOMStorage} domStorage
+ */
+WebInspector.DOMStorageHistory = function(domStorage)
+{
+    this._domStorage = domStorage;
+
+    /** @type {!Array.<!WebInspector.DOMStorageAction>} */
+    this._actions = [];
+    this._redoableActionIndex = -1;
+}
+
+WebInspector.DOMStorageHistory.MAX_UNDO_STACK_DEPTH = 20;
+
+WebInspector.DOMStorageHistory.prototype = {
+    /**
+     * @param {WebInspector.DOMStorageAction} action
+     */
+    perform: function(action)
+    {
+        if (!action)
+            return;
+
+        action.perform(actionCompleted.bind(this));
+        function actionCompleted()
+        {
+            if (this._redoableActionIndex + 1 === WebInspector.DOMStorageHistory.MAX_UNDO_STACK_DEPTH) {
+                this._actions.shift();
+                --this._redoableActionIndex;
+            } else if (this._redoableActionIndex + 1 < this._actions.length)
+                this._actions.splice(this._redoableActionIndex + 1);
+
+            this._actions.push(action);
+            ++this._redoableActionIndex;
+        }
+    },
+
+    undo: function()
+    {
+        if (this._redoableActionIndex < 0)

[apavlov, 2013/08/05 09:53:00]

ugh... I got confused by the naming, sorry. This seems to actually be the
_undoable_ action index, right?

[vivekg__, 2013/08/05 10:16:58]

Done.

+            return;
+
+        var action = this._actions[this._redoableActionIndex];
+        console.assert(action);
+        action.undo();
+        --this._redoableActionIndex;
+    },
+
+    redo: function()
+    {
+        if (this._redoableActionIndex >= this._actions.length - 1)
+            return;
+
+        var action = this._actions[++this._redoableActionIndex];

[apavlov, 2013/08/05 09:53:00]

This confirms the previous comment. In order to redo an action, you increment
the index first.

[vivekg__, 2013/08/05 10:16:58]

Done.

+        console.assert(action);
+        action.redo();
+    }
+}
+
 /**
  * @constructor
  * @extends {WebInspector.Object}
  */
 WebInspector.DOMStorageModel = function()
 {
     this._storages = {};
     InspectorBackend.registerDOMStorageDispatcher(new WebInspector.DOMStorageDispatcher(this));
     DOMStorageAgent.enable();
     WebInspector.resourceTreeModel.addEventListener(WebInspector.ResourceTreeModel.EventTypes.SecurityOriginAdded, this._securityOriginAdded, this);
@@ skipping 190 matching lines @@
     domStorageItemUpdated: function(storageId, key, oldValue, newValue)
     {
         this._model._domStorageItemUpdated(storageId, key, oldValue, newValue);
     },
 }
 
 /**
  * @type {WebInspector.DOMStorageModel}
  */
 WebInspector.domStorageModel = null;