DevTools: [Persistence] implement Persistence.subscribeForBindingEvents

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
    * @param {!Workspace.FileSystemMapping} fileSystemMapping
    */
   constructor(workspace, breakpointManager, fileSystemMapping) {
     super();
     this._workspace = workspace;
     this._breakpointManager = breakpointManager;
     /** @type {!Map<string, number>} */
     this._filePathPrefixesToBindingCount = new Map();
 
+    /** @type {!Multimap<!Workspace.UISourceCode, function()>} */
+    this._subscribedBindingEventListeners = new Multimap();
+
     if (Runtime.experiments.isEnabled('persistence2')) {
       var linkDecorator = new Persistence.PersistenceUtils.LinkDecorator(this);
       Components.Linkifier.setLinkDecorator(linkDecorator);
       this._mapping =
           new Persistence.Automapping(workspace, this._validateBinding.bind(this), this._onBindingRemoved.bind(this));
     } else {
       this._mapping = new Persistence.DefaultMapping(
           workspace, fileSystemMapping, this._validateBinding.bind(this), this._onBindingRemoved.bind(this));
     }
   }
@@ skipping 57 matching lines @@
     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._notifyBindingEvent(binding.network);
+    this._notifyBindingEvent(binding.fileSystem);
     this.dispatchEventToListeners(Persistence.Persistence.Events.BindingCreated, binding);
   }
 
   /**
    * @param {!Persistence.PersistenceBinding} binding
    */
   _onBindingRemoved(binding) {
     binding._removed = true;
     if (binding.network[Persistence.Persistence._binding] !== binding)
       return;
     console.assert(
         binding.network[Persistence.Persistence._binding] === binding.fileSystem[Persistence.Persistence._binding],
         'ERROR: inconsistent binding for networkURL ' + binding.network.url());
 
     binding.network[Persistence.Persistence._binding] = null;
     binding.fileSystem[Persistence.Persistence._binding] = null;
 
     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._breakpointManager.copyBreakpoints(binding.network.url(), binding.fileSystem);
+    this._notifyBindingEvent(binding.network);
+    this._notifyBindingEvent(binding.fileSystem);
     this.dispatchEventToListeners(Persistence.Persistence.Events.BindingRemoved, binding);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _onWorkingCopyChanged(event) {
     var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.data);
     var binding = uiSourceCode[Persistence.Persistence._binding];
     if (!binding || binding[Persistence.Persistence._muteWorkingCopy])
@@ skipping 125 matching lines @@
   /**
    * @param {!Workspace.UISourceCode} uiSourceCode
    * @return {?Persistence.PersistenceBinding}
    */
   binding(uiSourceCode) {
     return uiSourceCode[Persistence.Persistence._binding] || null;
   }
 
   /**
    * @param {!Workspace.UISourceCode} uiSourceCode
+   * @param {function()} listener
+   * @param {!Object=} thisObject
+   */
+  subscribeForBindingEvent(uiSourceCode, listener, thisObject) {

[lushnikov, 2016/12/20 02:50:02]

I called this "subscribeForBindingEvent" rather then
"subscribeForBindingChanged", because I'm about to add a third binding event,
BindingFailed. It will be needed to display the red-glowing icon when the
network content mismatched the file content.

[dgozman, 2016/12/20 05:47:03]

Let's not support thisObject - this will make code easier.

[lushnikov, 2016/12/20 18:38:35]

Done.

+    listener[Persistence.Persistence._listenerReciever] = thisObject || null;
+    this._subscribedBindingEventListeners.set(uiSourceCode, listener);
+  }
+
+  /**
+   * @param {!Workspace.UISourceCode} uiSourceCode
+   * @param {function()} listener
+   */
+  unsubscribeFromBindingEvent(uiSourceCode, listener) {

[dgozman, 2016/12/20 05:47:03]

... otherwise you have to pass thisObject here as well.

[lushnikov, 2016/12/20 18:38:34]

Done.

+    if (!this._subscribedBindingEventListeners.hasValue(uiSourceCode, listener))
+      return;
+    listener[Persistence.Persistence._listenerReciever] = null;
+    this._subscribedBindingEventListeners.remove(uiSourceCode, listener);
+  }
+
+  /**
+   * @param {!Workspace.UISourceCode} uiSourceCode
+   */
+  _notifyBindingEvent(uiSourceCode) {
+    if (!this._subscribedBindingEventListeners.has(uiSourceCode))
+      return;
+    var listeners = Array.from(this._subscribedBindingEventListeners.get(uiSourceCode));
+    for (var listener of listeners)
+      listener.call(listener[Persistence.Persistence._listenerReciever], uiSourceCode);

[dgozman, 2016/12/20 05:47:03]

Declared listener type doesn't take UISourceCode as a parameter.

[lushnikov, 2016/12/20 18:38:34]

Done.

+  }
+
+  /**
+   * @param {!Workspace.UISourceCode} uiSourceCode
    * @return {?Workspace.UISourceCode}
    */
   fileSystem(uiSourceCode) {
     var binding = this.binding(uiSourceCode);
     return binding ? binding.fileSystem : null;
   }
 
   /**
    * @param {string} filePath
    */
@@ skipping 32 matching lines @@
   }
 
   dispose() {
     this._mapping.dispose();
   }
 };
 
 Persistence.Persistence._binding = Symbol('Persistence.Binding');
 Persistence.Persistence._muteCommit = Symbol('Persistence.MuteCommit');
 Persistence.Persistence._muteWorkingCopy = Symbol('Persistence.MuteWorkingCopy');
+Persistence.Persistence._listenerReciever = Symbol('Persistence.ListenerReciever');
 
 Persistence.Persistence._NodePrefix = '(function (exports, require, module, __filename, __dirname) { ';
 Persistence.Persistence._NodeSuffix = '\n});';
 Persistence.Persistence._NodeShebang = '#!/usr/bin/env node';
 
 Persistence.Persistence.Events = {
   BindingCreated: Symbol('BindingCreated'),
   BindingRemoved: Symbol('BindingRemoved')
 };
 
 /**
  * @unrestricted
  */
 Persistence.PersistenceBinding = class {
   /**
    * @param {!Workspace.UISourceCode} network
    * @param {!Workspace.UISourceCode} fileSystem
    * @param {boolean} exactMatch
    */
   constructor(network, fileSystem, exactMatch) {
     this.network = network;
     this.fileSystem = fileSystem;
     this.exactMatch = exactMatch;
     this._removed = false;
   }
 };
 
 /** @type {!Persistence.Persistence} */
 Persistence.persistence;