DevTools: [Persistence] validate persistence binding.

third_party/WebKit/Source/devtools/front_end/persistence/Persistence.js

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 /**
  * @unrestricted
  */
 Persistence.Persistence = class extends Common.Object {
   /**
    * @param {!Workspace.Workspace} workspace
    * @param {!Bindings.BreakpointManager} breakpointManager
@@ skipping 14 matching lines @@
     } else {
       this._mapping = new Persistence.DefaultMapping(
           workspace, fileSystemMapping, this._onBindingCreated.bind(this), this._onBindingRemoved.bind(this));
     }
   }
 
   /**
    * @param {!Persistence.PersistenceBinding} binding
    */
   _onBindingCreated(binding) {
-    if (binding.network.isDirty()) {
-      Common.console.log(
-          Common.UIString('%s can not be persisted to file system due to unsaved changes.', binding.network.name()));
+    if (!binding.network.contentLoaded() && !binding.fileSystem.contentLoaded() && !binding.network.isDirty() &&
+        !binding.fileSystem.isDirty()) {
+      this._establishBinding(binding);
       return;
     }
-    if (binding.fileSystem.isDirty())
-      binding.network.setWorkingCopy(binding.fileSystem.workingCopy());
 
+    if (binding[Persistence.Persistence._prevalidatePromise])
+      return;
+    var promise = this._validateBinding(binding).then(onBindingValidated.bind(this));
+    binding[Persistence.Persistence._prevalidatePromise] = promise;
+
+    /**
+     * @this {Persistence.Persistence}
+     */
+    function onBindingValidated(isValid) {

[dgozman, 2016/12/07 01:45:41]

@param

+      if (binding[Persistence.Persistence._prevalidatePromise] !== promise)
+        return;
+      binding[Persistence.Persistence._prevalidatePromise] = null;
+
+      if (isValid)
+        this._establishBinding(binding);
+      else
+        this._prevalidationFailedForTest(binding);
+    }
+  }
+
+  /**
+   * @param {!Persistence.PersistenceBinding} binding
+   */
+  _prevalidationFailedForTest(binding) {
+  }
+
+  /**
+   * @param {!Persistence.PersistenceBinding} binding

[dgozman, 2016/12/07 01:45:41]

@return promise.....

+   */
+  _validateBinding(binding) {
+    return Promise.all([binding.network.requestContent(), binding.fileSystem.requestContent()]).then(onContentsLoaded);
+
+    function onContentsLoaded() {

[dgozman, 2016/12/07 01:45:41]

@return boolean

+      var target = Bindings.NetworkProject.targetForUISourceCode(binding.network);
+      if (target.isNodeJS()) {
+        var fileSystemContent = binding.fileSystem.workingCopy();
+        var networkContent = binding.network.workingCopy();
+        var rewrappedNetworkContent = Persistence.Persistence._rewrapNodeJSContent(
+            binding, binding.fileSystem, fileSystemContent, networkContent);
+        return fileSystemContent === rewrappedNetworkContent;
+      }
+      // Trim trailing whitespaces because V8 adds trailing newline.
+      var fileSystemContent = binding.fileSystem.workingCopy().replace(/\s*$/, '');

[dgozman, 2016/12/07 01:45:41]

.trimRight()

+      var networkContent = binding.network.workingCopy().replace(/\s*$/, '');
+      return fileSystemContent === networkContent;
+    }
+  }
+
+  /**
+   * @param {!Persistence.PersistenceBinding} binding
+   */
+  _establishBinding(binding) {
     binding.network[Persistence.Persistence._binding] = binding;
     binding.fileSystem[Persistence.Persistence._binding] = binding;
 
     binding.fileSystem.forceLoadOnCheckContent();
 
+    binding.network.addEventListener(Workspace.UISourceCode.Events.ContentLoaded, this._onContentLoaded, this);
+    binding.fileSystem.addEventListener(Workspace.UISourceCode.Events.ContentLoaded, this._onContentLoaded, this);
     binding.network.addEventListener(
         Workspace.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
     binding.fileSystem.addEventListener(
         Workspace.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
     binding.network.addEventListener(
         Workspace.UISourceCode.Events.WorkingCopyChanged, this._onWorkingCopyChanged, this);
     binding.fileSystem.addEventListener(
         Workspace.UISourceCode.Events.WorkingCopyChanged, this._onWorkingCopyChanged, this);
 
     this._addFilePathBindingPrefixes(binding.fileSystem.url());
 
     this._moveBreakpoints(binding.fileSystem, binding.network);
     this.dispatchEventToListeners(Persistence.Persistence.Events.BindingCreated, binding);
   }
 
   /**
    * @param {!Persistence.PersistenceBinding} binding
    */
   _onBindingRemoved(binding) {
+    binding[Persistence.Persistence._postvalidatePromise] = null;
+    if (binding[Persistence.Persistence._prevalidatePromise]) {
+      binding[Persistence.Persistence._prevalidatePromise] = null;
+      return;

[dgozman, 2016/12/07 01:45:41]

Drop this return, and the if.

+    }
+    if (!binding.network[Persistence.Persistence._binding] || !binding.fileSystem[Persistence.Persistence._binding])
+      return;
+
     binding.network[Persistence.Persistence._binding] = null;
     binding.fileSystem[Persistence.Persistence._binding] = null;
 
+    binding.network.removeEventListener(Workspace.UISourceCode.Events.ContentLoaded, this._onContentLoaded, this);
+    binding.fileSystem.removeEventListener(Workspace.UISourceCode.Events.ContentLoaded, this._onContentLoaded, this);
     binding.network.removeEventListener(
         Workspace.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
     binding.fileSystem.removeEventListener(
         Workspace.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
     binding.network.removeEventListener(
         Workspace.UISourceCode.Events.WorkingCopyChanged, this._onWorkingCopyChanged, this);
     binding.fileSystem.removeEventListener(
         Workspace.UISourceCode.Events.WorkingCopyChanged, this._onWorkingCopyChanged, this);
 
     this._removeFilePathBindingPrefixes(binding.fileSystem.url());
 
     this._breakpointManager.copyBreakpoints(binding.network.url(), binding.fileSystem);
     this.dispatchEventToListeners(Persistence.Persistence.Events.BindingRemoved, binding);
   }
 
   /**
    * @param {!Common.Event} event
    */
+  _onContentLoaded(event) {
+    var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.target);
+    var binding = uiSourceCode[Persistence.Persistence._binding];
+    if (!binding || binding[Persistence.Persistence._postvalidatePromise])
+      return;
+    var promise = this._validateBinding(binding).then(onBindingValidated.bind(this));
+    binding[Persistence.Persistence._postvalidatePromise] = promise;
+
+    /**
+     * @this {Persistence.Persistence}
+     */
+    function onBindingValidated(isValid) {
+      if (binding[Persistence.Persistence._postvalidatePromise] !== promise)
+        return;
+      binding[Persistence.Persistence._postvalidatePromise] = null;
+      if (!isValid)
+        this._onBindingRemoved(binding);
+    }
+  }
+
+  /**
+   * @param {!Common.Event} event
+   */
   _onWorkingCopyChanged(event) {
     var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.target);
     var binding = uiSourceCode[Persistence.Persistence._binding];
     if (!binding || binding[Persistence.Persistence._muteWorkingCopy])
       return;
     var other = binding.network === uiSourceCode ? binding.fileSystem : binding.network;
     var target = Bindings.NetworkProject.targetForUISourceCode(binding.network);
     if (target.isNodeJS()) {
       var newContent = uiSourceCode.workingCopy();
       other.requestContent().then(() => {
-        var nodeJSContent = this._rewrapNodeJSContent(binding, other, other.workingCopy(), newContent);
+        var nodeJSContent =
+            Persistence.Persistence._rewrapNodeJSContent(binding, other, other.workingCopy(), newContent);
         setWorkingCopy.call(this, () => nodeJSContent);
       });
       return;
     }
 
     setWorkingCopy.call(this, () => uiSourceCode.workingCopy());
 
     /**
      * @param {function():string} workingCopyGetter
      * @this {Persistence.Persistence}
@@ skipping 12 matching lines @@
   _onWorkingCopyCommitted(event) {
     var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.target);
     var binding = uiSourceCode[Persistence.Persistence._binding];
     if (!binding || binding[Persistence.Persistence._muteCommit])
       return;
     var newContent = /** @type {string} */ (event.data.content);
     var other = binding.network === uiSourceCode ? binding.fileSystem : binding.network;
     var target = Bindings.NetworkProject.targetForUISourceCode(binding.network);
     if (target.isNodeJS()) {
       other.requestContent().then(currentContent => {
-        var nodeJSContent = this._rewrapNodeJSContent(binding, other, currentContent, newContent);
+        var nodeJSContent = Persistence.Persistence._rewrapNodeJSContent(binding, other, currentContent, newContent);
         setContent.call(this, nodeJSContent);
       });
       return;
     }
     setContent.call(this, newContent);
 
     /**
      * @param {string} newContent
      * @this {Persistence.Persistence}
      */
     function setContent(newContent) {
       binding[Persistence.Persistence._muteCommit] = true;
       other.addRevision(newContent);
       binding[Persistence.Persistence._muteCommit] = false;
       this._contentSyncedForTest();
     }
   }
 
   /**
    * @param {!Persistence.PersistenceBinding} binding
    * @param {!Workspace.UISourceCode} uiSourceCode
    * @param {string} currentContent
    * @param {string} newContent
    * @return {string}
    */
-  _rewrapNodeJSContent(binding, uiSourceCode, currentContent, newContent) {
+  static _rewrapNodeJSContent(binding, uiSourceCode, currentContent, newContent) {
     if (uiSourceCode === binding.fileSystem) {
       if (newContent.startsWith(Persistence.Persistence._NodePrefix) &&
           newContent.endsWith(Persistence.Persistence._NodeSuffix)) {
         newContent = newContent.substring(
             Persistence.Persistence._NodePrefix.length, newContent.length - Persistence.Persistence._NodeSuffix.length);
       }
       if (currentContent.startsWith(Persistence.Persistence._NodeShebang))
         newContent = Persistence.Persistence._NodeShebang + newContent;
     } else {
       if (newContent.startsWith(Persistence.Persistence._NodeShebang))
@@ skipping 118 matching lines @@
    * @param {!Workspace.UISourceCode} fileSystem
    * @param {boolean} exactMatch
    */
   constructor(network, fileSystem, exactMatch) {
     this.network = network;
     this.fileSystem = fileSystem;
     this.exactMatch = exactMatch;
   }
 };
 
+Persistence.Persistence._prevalidatePromise = Symbol('Persistence.prevalidatePromise');

[dgozman, 2016/12/07 01:45:41]

Let's have private fields instead.

+Persistence.Persistence._postvalidatePromise = Symbol('Persistence.postvalidatePromise');
+
 /** @type {!Persistence.Persistence} */
 Persistence.persistence;