DevTools: make StylesSourceMapping in charge of creating and removing UISourceCodes

third_party/WebKit/Source/devtools/front_end/bindings/StylesSourceMapping.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 16 matching lines @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 /**
  * @unrestricted
  */
 Bindings.StylesSourceMapping = class {
   /**
    * @param {!SDK.CSSModel} cssModel
-   * @param {!Workspace.Workspace} workspace
+   * @param {!Bindings.NetworkProject} networkProject
    */
-  constructor(cssModel, workspace) {
+  constructor(cssModel, networkProject) {
     this._cssModel = cssModel;
-    this._workspace = workspace;
+    this._networkProject = networkProject;
 
-    /** @type {!Map<string, !Map<string, !Map<string, !SDK.CSSStyleSheetHeader>>>} */
-    this._urlToHeadersByFrameId = new Map();
     /** @type {!Map.<!Workspace.UISourceCode, !Bindings.StyleFile>} */
     this._styleFiles = new Map();
 
     this._eventListeners = [
-      this._workspace.addEventListener(Workspace.Workspace.Events.ProjectRemoved, this._projectRemoved, this),
-      this._workspace.addEventListener(
-          Workspace.Workspace.Events.UISourceCodeAdded, this._uiSourceCodeAddedToWorkspace, this),
-      this._workspace.addEventListener(Workspace.Workspace.Events.UISourceCodeRemoved, this._uiSourceCodeRemoved, this),
       this._cssModel.addEventListener(SDK.CSSModel.Events.StyleSheetAdded, this._styleSheetAdded, this),
       this._cssModel.addEventListener(SDK.CSSModel.Events.StyleSheetRemoved, this._styleSheetRemoved, this),
-      this._cssModel.addEventListener(SDK.CSSModel.Events.StyleSheetChanged, this._styleSheetChanged, this),
-      SDK.ResourceTreeModel.fromTarget(cssModel.target())
-          .addEventListener(SDK.ResourceTreeModel.Events.MainFrameNavigated, this._unbindAllUISourceCodes, this)

[dgozman, 2017/01/27 23:49:13]

Why we don't need this anymore?

[lushnikov, 2017/01/30 14:19:15]

We receive "styleSheetRemoved" events in this case

+      this._cssModel.addEventListener(SDK.CSSModel.Events.StyleSheetChanged, this._styleSheetChanged, this)
     ];
   }
 
   /**
    * @param {!SDK.CSSLocation} rawLocation
    * @return {?Workspace.UILocation}
    */
   rawLocationToUILocation(rawLocation) {
-    var uiSourceCode =
-        Bindings.NetworkProject.uiSourceCodeForStyleURL(this._workspace, rawLocation.url, rawLocation.header());
+    var uiSourceCode = this._networkProject.getFile(
+        rawLocation.url, SDK.ResourceTreeFrame.fromStyleSheet(rawLocation.header()), false);
     if (!uiSourceCode)
       return null;
     var lineNumber = rawLocation.lineNumber;
     var columnNumber = rawLocation.columnNumber;
-    var header = this._cssModel.styleSheetHeaderForId(rawLocation.styleSheetId);
+    var header = rawLocation.header();
     if (header && header.isInline && header.hasSourceURL) {
       lineNumber -= header.lineNumberInSource(0);
       columnNumber -= header.columnNumberInSource(lineNumber, 0);
     }
     return uiSourceCode.uiLocation(lineNumber, columnNumber);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _styleSheetAdded(event) {
     var header = /** @type {!SDK.CSSStyleSheetHeader} */ (event.data);
+    if (header.isInline && !header.hasSourceURL && header.origin !== 'inspector')
+      return;
+
     var url = header.resourceURL();
     if (!url)
       return;
 
-    var map = this._urlToHeadersByFrameId.get(url);
-    if (!map) {
-      map = /** @type {!Map.<string, !Map.<string, !SDK.CSSStyleSheetHeader>>} */ (new Map());
-      this._urlToHeadersByFrameId.set(url, map);
+    var uiSourceCode = this._networkProject.getFile(url, SDK.ResourceTreeFrame.fromStyleSheet(header), false);
+    if (!uiSourceCode) {
+      uiSourceCode = this._networkProject.createFileForStyleSheetHeader(header);
+      this._styleFiles.set(uiSourceCode, new Bindings.StyleFile(this._cssModel, uiSourceCode));
     }
-    var headersById = map.get(header.frameId);
-    if (!headersById) {
-      headersById = /** @type {!Map.<string, !SDK.CSSStyleSheetHeader>} */ (new Map());
-      map.set(header.frameId, headersById);
-    }
-    headersById.set(header.id, header);
-    var uiSourceCode = Bindings.NetworkProject.uiSourceCodeForStyleURL(this._workspace, url, header);
-    if (uiSourceCode)
-      this._bindUISourceCode(uiSourceCode, header);
+    var styleFile = this._styleFiles.get(uiSourceCode);
+    styleFile.addHeader(header);
+
+    Bindings.cssWorkspaceBinding.updateLocations(header);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _styleSheetRemoved(event) {
     var header = /** @type {!SDK.CSSStyleSheetHeader} */ (event.data);
     var url = header.resourceURL();
-    if (!url)
+    var frame = SDK.ResourceTreeFrame.fromStyleSheet(header);
+    var uiSourceCode = this._networkProject.getFile(url, frame, false);
+    if (!uiSourceCode)
       return;
-
-    var map = this._urlToHeadersByFrameId.get(url);
-    console.assert(map);
-    var headersById = map.get(header.frameId);
-    console.assert(headersById);
-    headersById.delete(header.id);
-
-    if (!headersById.size) {
-      map.delete(header.frameId);
-      if (!map.size) {
-        this._urlToHeadersByFrameId.delete(url);
-        var uiSourceCode = Bindings.NetworkProject.uiSourceCodeForStyleURL(this._workspace, url, header);
-        if (uiSourceCode)
-          this._unbindUISourceCode(uiSourceCode);
-      }
-    }
-  }
-
-  /**
-   * @param {!Workspace.UISourceCode} uiSourceCode
-   */
-  _unbindUISourceCode(uiSourceCode) {
     var styleFile = this._styleFiles.get(uiSourceCode);
-    if (!styleFile)
+    styleFile.removeHeader(header);
+    if (styleFile.hasHeaders())
       return;
     styleFile.dispose();
     this._styleFiles.delete(uiSourceCode);
-  }
-
-  /**
-   * @param {!Common.Event} event
-   */
-  _unbindAllUISourceCodes(event) {
-    if (event.data.target() !== this._cssModel.target())
-      return;
-    for (var styleFile of this._styleFiles.values())
-      styleFile.dispose();
-    this._styleFiles.clear();
-    this._urlToHeadersByFrameId = new Map();
-  }
-
-  /**
-   * @param {!Common.Event} event
-   */
-  _uiSourceCodeAddedToWorkspace(event) {
-    var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.data);
-    if (!this._urlToHeadersByFrameId.has(uiSourceCode.url()))
-      return;
-    this._bindUISourceCode(
-        uiSourceCode, this._urlToHeadersByFrameId.get(uiSourceCode.url()).valuesArray()[0].valuesArray()[0]);
-  }
-
-  /**
-   * @param {!Workspace.UISourceCode} uiSourceCode
-   * @param {!SDK.CSSStyleSheetHeader} header
-   */
-  _bindUISourceCode(uiSourceCode, header) {
-    if (this._styleFiles.get(uiSourceCode) || (header.isInline && !header.hasSourceURL))
-      return;
-    this._styleFiles.set(uiSourceCode, new Bindings.StyleFile(uiSourceCode, this));
-    Bindings.cssWorkspaceBinding.updateLocations(header);
-  }
-
-  /**
-   * @param {!Common.Event} event
-   */
-  _projectRemoved(event) {
-    var project = /** @type {!Workspace.Project} */ (event.data);
-    var uiSourceCodes = project.uiSourceCodes();
-    for (var i = 0; i < uiSourceCodes.length; ++i)
-      this._unbindUISourceCode(uiSourceCodes[i]);
-  }
-
-  /**
-   * @param {!Common.Event} event
-   */
-  _uiSourceCodeRemoved(event) {
-    var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.data);
-    this._unbindUISourceCode(uiSourceCode);
-  }
-
-  /**
-   * @param {!Workspace.UISourceCode} uiSourceCode
-   * @param {string} content
-   * @param {boolean} majorChange
-   * @return {!Promise<?string>}
-   */
-  _setStyleContent(uiSourceCode, content, majorChange) {
-    var styleSheetIds = this._cssModel.styleSheetIdsForURL(uiSourceCode.url());
-    if (!styleSheetIds.length)
-      return Promise.resolve(/** @type {?string} */ ('No stylesheet found: ' + uiSourceCode.url()));
-
-    this._isSettingContent = true;
-
-    /**
-     * @param {?string} error
-     * @this {Bindings.StylesSourceMapping}
-     * @return {?string}
-     */
-    function callback(error) {
-      delete this._isSettingContent;
-      return error || null;
-    }
-
-    var promises = [];
-    for (var i = 0; i < styleSheetIds.length; ++i)
-      promises.push(this._cssModel.setStyleSheetText(styleSheetIds[i], content, majorChange));
-
-    return Promise.all(promises).spread(callback.bind(this));
+    this._networkProject.removeFile(uiSourceCode);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _styleSheetChanged(event) {
-    if (this._isSettingContent)
-      return;
-
-    this._updateStyleSheetTextSoon(event.data.styleSheetId);
-  }
-
-  /**
-   * @param {!Protocol.CSS.StyleSheetId} styleSheetId
-   */
-  _updateStyleSheetTextSoon(styleSheetId) {
-    if (this._updateStyleSheetTextTimer)
-      clearTimeout(this._updateStyleSheetTextTimer);
-
-    this._updateStyleSheetTextTimer = setTimeout(
-        this._updateStyleSheetText.bind(this, styleSheetId), Bindings.StylesSourceMapping.ChangeUpdateTimeoutMs);
-  }
-
-  /**
-   * @param {!Protocol.CSS.StyleSheetId} styleSheetId
-   */
-  _updateStyleSheetText(styleSheetId) {
-    if (this._updateStyleSheetTextTimer) {
-      clearTimeout(this._updateStyleSheetTextTimer);
-      delete this._updateStyleSheetTextTimer;
-    }
-
+    var styleSheetId = event.data.styleSheetId;
     var header = this._cssModel.styleSheetHeaderForId(styleSheetId);
-    if (!header)
-      return;
-    var styleSheetURL = header.resourceURL();
-    if (!styleSheetURL)
-      return;
-    var uiSourceCode = Bindings.NetworkProject.uiSourceCodeForStyleURL(this._workspace, styleSheetURL, header);
-    if (!uiSourceCode)
-      return;
-    header.requestContent().then(callback.bind(this, uiSourceCode));
-
-    /**
-     * @param {!Workspace.UISourceCode} uiSourceCode
-     * @param {?string} content
-     * @this {Bindings.StylesSourceMapping}
-     */
-    function callback(uiSourceCode, content) {
-      var styleFile = this._styleFiles.get(uiSourceCode);
-      if (styleFile)
-        styleFile.addRevision(content || '');
-    }
+    var uiSourceCode =

[dgozman, 2017/01/27 23:49:12]

Why do we have to consult with NetworkProject first?

Can we instead have our own map of StyleFiles, and each of them would
create/destroy UISourceCode and put it into NetworkProject?

[lushnikov, 2017/01/30 14:19:15]

NetworkProject already has the knowledge of creating UISourceCodes-per-frame.
I'd like to keep this logic in one place for now.

+        this._networkProject.getFile(header.resourceURL(), SDK.ResourceTreeFrame.fromStyleSheet(header), false);
+    var styleFile = uiSourceCode ? this._styleFiles.get(uiSourceCode) : null;
+    if (styleFile)
+      styleFile.styleSheetChanged(header);
   }
 
   dispose() {
+    for (var uiSourceCode of this._styleFiles.keys()) {
+      this._networkProject.removeFile(uiSourceCode);
+      var styleFile = this._styleFiles.get(uiSourceCode);
+      styleFile.dispose();
+    }
+    this._styleFiles.clear();
     Common.EventTarget.removeEventListeners(this._eventListeners);
   }
 };
 
-Bindings.StylesSourceMapping.ChangeUpdateTimeoutMs = 200;
-
 /**
  * @unrestricted
  */
 Bindings.StyleFile = class {
   /**
+   * @param {!SDK.CSSModel} cssModel
    * @param {!Workspace.UISourceCode} uiSourceCode
-   * @param {!Bindings.StylesSourceMapping} mapping
    */
-  constructor(uiSourceCode, mapping) {
+  constructor(cssModel, uiSourceCode) {
+    this._cssModel = cssModel;
     this._uiSourceCode = uiSourceCode;
-    this._mapping = mapping;
+    /** @type {!Set<!SDK.CSSStyleSheetHeader>} */
+    this._headers = new Set();
     this._eventListeners = [
       this._uiSourceCode.addEventListener(
           Workspace.UISourceCode.Events.WorkingCopyChanged, this._workingCopyChanged, this),
       this._uiSourceCode.addEventListener(
           Workspace.UISourceCode.Events.WorkingCopyCommitted, this._workingCopyCommitted, this)
     ];
     this._commitThrottler = new Common.Throttler(Bindings.StyleFile.updateTimeout);
     this._terminated = false;
   }
 
   /**
+   * @param {!SDK.CSSStyleSheetHeader} header
+   */
+  addHeader(header) {
+    this._headers.add(header);
+  }
+
+  /**
+   * @param {!SDK.CSSStyleSheetHeader} header
+   */
+  removeHeader(header) {
+    this._headers.delete(header);
+  }
+
+  /**
+   * @return {boolean}
+   */
+  hasHeaders() {
+    return !!this._headers.size;
+  }
+
+  /**
+   * @param {!SDK.CSSStyleSheetHeader} header
+   */
+  styleSheetChanged(header) {
+    if (this._isSettingStyleSheetContents)
+      return;
+
+    this._commitThrottler.schedule(this._syncStyleSheetChange.bind(this, header), false);
+  }
+
+  /**
    * @param {!Common.Event} event
    */
   _workingCopyCommitted(event) {
     if (this._isAddingRevision)
       return;
 
     this._isMajorChangePending = true;
-    this._commitThrottler.schedule(this._commitIncrementalEdit.bind(this), true);
+    this._commitThrottler.schedule(this._syncUISourceCodeChange.bind(this), true);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _workingCopyChanged(event) {
     if (this._isAddingRevision)
       return;
 
-    this._commitThrottler.schedule(this._commitIncrementalEdit.bind(this), false);
+    this._commitThrottler.schedule(this._syncUISourceCodeChange.bind(this), false);
   }
 
-  _commitIncrementalEdit() {
+  /**
+   * @param {!SDK.CSSStyleSheetHeader} header
+   * @return {!Promise}
+   */
+  _syncStyleSheetChange(header) {
+    if (this._terminated || !this._headers.has(header))
+      return Promise.resolve();
+
+    return header.requestContent().then(onHeaderContent.bind(this));
+
+    /**
+     * @param {?string} content
+     * @return {!Promise}
+     * @this {Bindings.StyleFile}
+     */
+    function onHeaderContent(content) {
+      if (this._terminated || content === null)
+        return Promise.resolve();
+      this._isAddingRevision = true;
+      this._uiSourceCode.addRevision(content);
+      delete this._isAddingRevision;
+      return this._setStyleSheetContents(content, header, true);
+    }
+  }
+
+  /**
+   * @return {!Promise}
+   */
+  _syncUISourceCodeChange() {
     if (this._terminated)
-      return;
-    var promise =
-        this._mapping._setStyleContent(this._uiSourceCode, this._uiSourceCode.workingCopy(), this._isMajorChangePending)
-            .then(this._styleContentSet.bind(this));
+      return Promise.resolve();
+    var promise = this._setStyleSheetContents(this._uiSourceCode.workingCopy(), null, this._isMajorChangePending);
     this._isMajorChangePending = false;
     return promise;
   }
 
   /**
-   * @param {?string} error
+   * @param {string} content
+   * @param {?SDK.CSSStyleSheetHeader} skipStyleSheet
+   * @param {boolean} majorChange
+   * @return {!Promise}
    */
-  _styleContentSet(error) {
-    if (error)
-      console.error(error);
-  }
+  _setStyleSheetContents(content, skipStyleSheet, majorChange) {
+    this._isSettingStyleSheetContents = true;
+    var promises = [];
+    for (var header of this._headers) {
+      if (header === skipStyleSheet)
+        continue;
+      promises.push(this._cssModel.setStyleSheetText(header.id, content, majorChange));
+    }
 
-  /**
-   * @param {string} content
-   */
-  addRevision(content) {
-    this._isAddingRevision = true;
-    this._uiSourceCode.addRevision(content);
-    delete this._isAddingRevision;
+    return Promise.all(promises).then(onStyleSheetContentsUpdated.bind(this));
+
+    /**
+     * @param {!Array<?Protocol.Error>} errors
+     * @this {Bindings.StyleFile}
+     */
+    function onStyleSheetContentsUpdated(errors) {
+      delete this._isSettingStyleSheetContents;
+      errors = errors.filter(error => !!error);
+      for (var error of errors) {
+        if (!error)

[dgozman, 2017/01/27 23:49:13]

Filtered them already.

+          continue;
+        console.error(error);
+      }
+    }
   }
 
   dispose() {
     if (this._terminated)
       return;
     this._terminated = true;
     Common.EventTarget.removeEventListeners(this._eventListeners);
   }
 };
 
 Bindings.StyleFile.updateTimeout = 200;