DevTools: make CompilerScriptMapping / SASSSourceMapping manage UISourceCodes

third_party/WebKit/Source/devtools/front_end/bindings/SASSSourceMapping.js

 /*
  * Copyright (C) 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 15 matching lines @@
  * 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.
  */
 
 /**
  * @implements {Bindings.CSSWorkspaceBinding.SourceMapping}
  */
 Bindings.SASSSourceMapping = class {
   /**
+   * @param {!SDK.Target} target
+   * @return {string}
+   */
+  static projectId(target) {

[dgozman, 2017/05/10 18:10:33]

inline it

[lushnikov, 2017/05/10 22:24:32]

Done.

+    return 'cssSourceMaps:' + target.id();
+  }
+
+  /**
+   * @param {!SDK.Target} target
    * @param {!SDK.SourceMapManager} sourceMapManager
    * @param {!Workspace.Workspace} workspace
-   * @param {!Bindings.NetworkProject} networkProject
    */
-  constructor(sourceMapManager, workspace, networkProject) {
+  constructor(target, sourceMapManager, workspace) {
     this._sourceMapManager = sourceMapManager;
-    this._networkProject = networkProject;
-    this._workspace = workspace;
+    this._project = new Bindings.ContentProviderBasedProject(
+        workspace, Bindings.SASSSourceMapping.projectId(target), Workspace.projectTypes.Network, '',
+        false /* isServiceProject */);
+    Bindings.NetworkProject.setTargetForProject(this._project, target);
+
     this._eventListeners = [
       this._sourceMapManager.addEventListener(
           SDK.SourceMapManager.Events.SourceMapAttached, this._sourceMapAttached, this),
       this._sourceMapManager.addEventListener(
           SDK.SourceMapManager.Events.SourceMapDetached, this._sourceMapDetached, this),
       this._sourceMapManager.addEventListener(
           SDK.SourceMapManager.Events.SourceMapChanged, this._sourceMapChanged, this)
     ];
-
-    /** @type {!Multimap<string, !SDK.CSSStyleSheetHeader>} */
-    this._sourceMapIdToHeaders = new Multimap();
   }
 
   /**
    * @param {?SDK.SourceMap} sourceMap
    */
   _sourceMapAttachedForTest(sourceMap) {
   }
 
   /**
-   * @param {string} frameId
-   * @param {string} sourceMapURL
-   * @return {string}
-   */
-  static _sourceMapId(frameId, sourceMapURL) {
-    return frameId + ':' + sourceMapURL;
-  }
-
-  /**
    * @param {!Common.Event} event
    */
   _sourceMapAttached(event) {
     var header = /** @type {!SDK.CSSStyleSheetHeader} */ (event.data.client);
     var sourceMap = /** @type {!SDK.SourceMap} */ (event.data.sourceMap);
-    var sourceMapId = Bindings.SASSSourceMapping._sourceMapId(header.frameId, sourceMap.url());
-    if (this._sourceMapIdToHeaders.has(sourceMapId)) {
-      this._sourceMapIdToHeaders.set(sourceMapId, header);
-      this._sourceMapAttachedForTest(sourceMap);
-      return;
-    }
-    this._sourceMapIdToHeaders.set(sourceMapId, header);
+    for (var sassURL of sourceMap.sourceURLs()) {
+      var uiSourceCode = this._project.uiSourceCodeForURL(sassURL);
+      if (uiSourceCode) {
+        var attribution = Bindings.NetworkProject.frameAttribution(uiSourceCode);
+        attribution.add(header.frameId);
+        Bindings.NetworkProject.changeFrameAttribution(uiSourceCode, attribution);
+        continue;
+      }
 
-    for (var sassURL of sourceMap.sourceURLs()) {
       var contentProvider = sourceMap.sourceContentProvider(sassURL, Common.resourceTypes.SourceMapStyleSheet);
       var embeddedContent = sourceMap.embeddedContentByURL(sassURL);
-      var embeddedContentLength = typeof embeddedContent === 'string' ? embeddedContent.length : null;
-      var uiSourceCode =
-          this._networkProject.addSourceMapFile(contentProvider, header.frameId, false, embeddedContentLength);
+      var metadata =
+          typeof embeddedContent === 'string' ? new Workspace.UISourceCodeMetadata(null, embeddedContent.length) : null;
+      uiSourceCode = this._project.createUISourceCode(sassURL, contentProvider.contentType());
+      Bindings.NetworkProject.setInitialFrameAttribution(uiSourceCode, new Set([header.frameId]));
       uiSourceCode[Bindings.SASSSourceMapping._sourceMapSymbol] = sourceMap;
+      this._project.addUISourceCodeWithProvider(uiSourceCode, contentProvider, metadata);
     }
     Bindings.cssWorkspaceBinding.updateLocations(header);
     this._sourceMapAttachedForTest(sourceMap);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _sourceMapDetached(event) {
     var header = /** @type {!SDK.CSSStyleSheetHeader} */ (event.data.client);
     var sourceMap = /** @type {!SDK.SourceMap} */ (event.data.sourceMap);
-    var sourceMapId = Bindings.SASSSourceMapping._sourceMapId(header.frameId, sourceMap.url());
-    this._sourceMapIdToHeaders.remove(sourceMapId, header);
-    if (this._sourceMapIdToHeaders.has(sourceMapId))
+    var headers = this._sourceMapManager.clientsForSourceMap(sourceMap);
+    if (!headers.length) {

[dgozman, 2017/05/10 18:10:33]

Let's rewrite below for clarity:

for (var sassURL of sourceMap.sourceURLS()) {
  if (headers.length) {
    var uiSourceCode = ...;
    changeAttribution
  } else {
    this._project.removeFile(sassURL);
  }
}
updateLocations(header);

[lushnikov, 2017/05/10 22:24:32]

Done.

+      for (var sassURL of sourceMap.sourceURLs())
+        this._project.removeFile(sassURL);
+      Bindings.cssWorkspaceBinding.updateLocations(header);
       return;
-    for (var sassURL of sourceMap.sourceURLs())
-      this._networkProject.removeSourceMapFile(sassURL, header.frameId, false);
+    }
+
+    var attribution = new Set(headers.map(header => header.frameId));

[dgozman, 2017/05/10 18:10:33]

Doing this here looks ugly. Should we instead introduce two methods:
NetworkProject.{add,remove}FrameAttribution ?

[lushnikov, 2017/05/10 22:24:32]

In case of shadowDOM we might have many headers attributed to the same frame.
Given that
frameAttribution is a set, simply having {add/remove}FrameAttribution would not
be enough.
We'd additionally need to have a multimap to count exact number of headers in
frame.

This line neatly addresses this shadowDOM scenario - wdyt?

+    for (var sassURL of sourceMap.sourceURLs()) {
+      var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (this._project.uiSourceCodeForURL(sassURL));
+      Bindings.NetworkProject.changeFrameAttribution(uiSourceCode, attribution);
+    }
     Bindings.cssWorkspaceBinding.updateLocations(header);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _sourceMapChanged(event) {
     var sourceMap = /** @type {!SDK.SourceMap} */ (event.data.sourceMap);
     var newSources = /** @type {!Map<string, string>} */ (event.data.newSources);
     var headers = this._sourceMapManager.clientsForSourceMap(sourceMap);
-    var handledUISourceCodes = new Set();
-    for (var header of headers) {
+    for (var sourceURL of newSources.keys()) {
+      var uiSourceCode = this._project.uiSourceCodeForURL(sourceURL);
+      if (!uiSourceCode) {
+        console.error('Failed to update source for ' + sourceURL);
+        continue;
+      }
+      var sassText = /** @type {string} */ (newSources.get(sourceURL));
+      uiSourceCode.setWorkingCopy(sassText);
+    }
+    for (var header of headers)
       Bindings.cssWorkspaceBinding.updateLocations(header);
-      for (var sourceURL of newSources.keys()) {
-        var uiSourceCode = Bindings.NetworkProject.uiSourceCodeForStyleURL(this._workspace, sourceURL, header);
-        if (!uiSourceCode) {
-          console.error('Failed to update source for ' + sourceURL);
-          continue;
-        }
-        if (handledUISourceCodes.has(uiSourceCode))
-          continue;
-        handledUISourceCodes.add(uiSourceCode);
-        uiSourceCode[Bindings.SASSSourceMapping._sourceMapSymbol] = sourceMap;
-        var sassText = /** @type {string} */ (newSources.get(sourceURL));
-        uiSourceCode.setWorkingCopy(sassText);
-      }
-    }
   }
 
   /**
    * @override
    * @param {!SDK.CSSLocation} rawLocation
    * @return {?Workspace.UILocation}
    */
   rawLocationToUILocation(rawLocation) {
     var header = rawLocation.header();
     if (!header)
       return null;
     var sourceMap = this._sourceMapManager.sourceMapForClient(header);
     if (!sourceMap)
       return null;
     var entry = sourceMap.findEntry(rawLocation.lineNumber, rawLocation.columnNumber);
     if (!entry || !entry.sourceURL)
       return null;
-    var uiSourceCode = Bindings.NetworkProject.uiSourceCodeForStyleURL(this._workspace, entry.sourceURL, header);
+    var uiSourceCode = this._project.uiSourceCodeForURL(entry.sourceURL);
     if (!uiSourceCode)
       return null;
     return uiSourceCode.uiLocation(entry.sourceLineNumber || 0, entry.sourceColumnNumber);
   }
 
   /**
    * @override
    * @param {!Workspace.UILocation} uiLocation
    * @return {!Array<!SDK.CSSLocation>}
    */
   uiLocationToRawLocations(uiLocation) {
     var sourceMap = uiLocation.uiSourceCode[Bindings.SASSSourceMapping._sourceMapSymbol];
     if (!sourceMap)
       return [];
     var entries =
         sourceMap.findReverseEntries(uiLocation.uiSourceCode.url(), uiLocation.lineNumber, uiLocation.columnNumber);
     var locations = [];
     for (var header of this._sourceMapManager.clientsForSourceMap(sourceMap))
       locations.pushAll(entries.map(entry => new SDK.CSSLocation(header, entry.lineNumber, entry.columnNumber)));
     return locations;
   }
 
   dispose() {
+    this._project.dispose();
     Common.EventTarget.removeEventListeners(this._eventListeners);
   }
 };
 
 Bindings.SASSSourceMapping._sourceMapSymbol = Symbol('sourceMap');