DevTools: proper management of ResourceTreeModel in NetworkProject

third_party/WebKit/Source/devtools/front_end/bindings/NetworkProject.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 64 matching lines @@
     this._resourceTreeModel = resourceTreeModel;
     target[Bindings.NetworkProject._networkProjectSymbol] = this;
 
     this._eventListeners = [];
 
     if (resourceTreeModel) {
       this._eventListeners.push(
           resourceTreeModel.addEventListener(SDK.ResourceTreeModel.Events.ResourceAdded, this._resourceAdded, this),
           resourceTreeModel.addEventListener(
               SDK.ResourceTreeModel.Events.FrameWillNavigate, this._frameWillNavigate, this),
-          resourceTreeModel.addEventListener(
-              SDK.ResourceTreeModel.Events.MainFrameNavigated, this._mainFrameNavigated, this),
           resourceTreeModel.addEventListener(SDK.ResourceTreeModel.Events.FrameDetached, this._frameDetached, this));
     }
 
     this._debuggerModel = target.model(SDK.DebuggerModel);
     if (this._debuggerModel) {
       var runtimeModel = this._debuggerModel.runtimeModel();
       this._eventListeners.push(
           runtimeModel.addEventListener(
               SDK.RuntimeModel.Events.ExecutionContextDestroyed, this._executionContextDestroyed, this),
           this._debuggerModel.addEventListener(
               SDK.DebuggerModel.Events.ParsedScriptSource, this._parsedScriptSource, this),
           this._debuggerModel.addEventListener(
               SDK.DebuggerModel.Events.FailedToParseScriptSource, this._parsedScriptSource, this));
     }
     var cssModel = target.model(SDK.CSSModel);
     if (cssModel) {
       this._eventListeners.push(
           cssModel.addEventListener(SDK.CSSModel.Events.StyleSheetAdded, this._styleSheetAdded, this),
           cssModel.addEventListener(SDK.CSSModel.Events.StyleSheetRemoved, this._styleSheetRemoved, this));
     }
-    this._eventListeners.push(target.targetManager().addEventListener(
-        SDK.TargetManager.Events.SuspendStateChanged, this._suspendStateChanged, this));
   }
 
   /**
    * @param {!SDK.Target} target
    * @param {string} frameId
    * @param {boolean} isContentScripts
    * @return {string}
    */
   static projectId(target, frameId, isContentScripts) {
     return target.id() + ':' + frameId + ':' + (isContentScripts ? 'contentscripts' : '');
@@ skipping 221 matching lines @@
    * @param {!Common.Event} event
    */
   _resourceAdded(event) {
     var resource = /** @type {!SDK.Resource} */ (event.data);
     this._addResource(resource);
   }
 
   /**
    * @param {!SDK.Resource} resource
    */
+  _acceptsResource(resource) {
+    var resourceType = resource.resourceType();
+    // Only load selected resource types from resources.
+    if (resourceType !== Common.resourceTypes.Image && resourceType !== Common.resourceTypes.Font &&
+        resourceType !== Common.resourceTypes.Document && resourceType !== Common.resourceTypes.Manifest)
+      return false;
+
+    // Ignore non-images and non-fonts.
+    if (resourceType === Common.resourceTypes.Image && resource.mimeType && !resource.mimeType.startsWith('image'))
+      return false;
+    if (resourceType === Common.resourceTypes.Font && resource.mimeType && !resource.mimeType.includes('font'))
+      return false;
+    if ((resourceType === Common.resourceTypes.Image || resourceType === Common.resourceTypes.Font) &&
+        resource.contentURL().startsWith('data:'))
+      return false;
+    return true;
+  }
+
+  /**
+   * @param {!SDK.Resource} resource
+   */
   _addResource(resource) {
-    var resourceType = resource.resourceType();
-    // Only load selected resource types from resources.
-    if (resourceType !== Common.resourceTypes.Image && resourceType !== Common.resourceTypes.Font &&
-        resourceType !== Common.resourceTypes.Document && resourceType !== Common.resourceTypes.Manifest)
-      return;
-
-    // Ignore non-images and non-fonts.
-    if (resourceType === Common.resourceTypes.Image && resource.mimeType && !resource.mimeType.startsWith('image'))
-      return;
-    if (resourceType === Common.resourceTypes.Font && resource.mimeType && !resource.mimeType.includes('font'))
-      return;
-    if ((resourceType === Common.resourceTypes.Image || resourceType === Common.resourceTypes.Font) &&
-        resource.contentURL().startsWith('data:'))
-      return;
-
-    // Never load document twice.

[dgozman, 2017/04/20 17:23:17]

What was this about? Why it doesn't happen anymore?

[lushnikov, 2017/04/21 00:51:27]

This was introduced in https://codereview.chromium.org/1409223006
That was before the project-per-frame approach and made sense, not anymore since
we have per-frame distribution (and will have frame attribution later)

-    var projectId = Bindings.NetworkProject.projectId(this._target, resource.frameId, false);
-    var project = this._workspaceProjects.get(projectId);
-    if (project && project.uiSourceCodeForURL(resource.url))
+    if (!this._acceptsResource(resource))
       return;
 
     var uiSourceCode = this._createFile(resource, resource.frameId, false);
     uiSourceCode[Bindings.NetworkProject._resourceSymbol] = resource;
     this._addUISourceCodeWithProvider(uiSourceCode, resource, this._resourceMetadata(resource));
   }
 
   /**
    * @param {!SDK.ResourceTreeFrame} frame
    */
   _removeFrameResources(frame) {
-    var project = this._workspaceProject(frame.id, false);
-    for (var resource of frame.resources())
-      project.removeUISourceCode(resource.url);

[lushnikov, 2017/04/20 02:52:50]

this was a bug: it's incorrect to call project.removeUISourceCode for
ContentProviderBasedProjects. Proper way is calling removeFile.

-    project = this._workspaceProject(frame.id, true);
-    for (var resource of frame.resources())
-      project.removeUISourceCode(resource.url);
+    var regularProject = this._workspaceProject(frame.id, false);
+    var contentScriptsProject = this._workspaceProject(frame.id, true);
+    for (var resource of frame.resources()) {
+      if (!this._acceptsResource(resource))
+        continue;
+      regularProject.removeFile(resource.url);
+      contentScriptsProject.removeFile(resource.url);
+    }
   }
 
   /**
    * @param {!Common.Event} event
    */
   _frameWillNavigate(event) {
     var frame = /** @type {!SDK.ResourceTreeFrame} */ (event.data);
     this._removeFrameResources(frame);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _frameDetached(event) {
     var frame = /** @type {!SDK.ResourceTreeFrame} */ (event.data);
     this._removeFrameResources(frame);
   }
 
   /**
-   * @param {!Common.Event} event
-   */
-  _mainFrameNavigated(event) {
-    this._reset();
-  }
-
-  _suspendStateChanged() {

[dgozman, 2017/04/20 17:23:17]

Let's add a test for this.

[lushnikov, 2017/04/21 00:51:27]

Done in a separate patch.

-    if (this._target.targetManager().allTargetsSuspended())
-      this._reset();
-    else
-      this._populate();
-  }
-
-  /**
    * @param {!Common.ContentProvider} contentProvider
    * @param {string} frameId
    * @param {boolean} isContentScript
    * @return {!Workspace.UISourceCode}
    */
   _createFile(contentProvider, frameId, isContentScript) {
     var url = contentProvider.contentURL();
     var project = this._workspaceProject(frameId, isContentScript);
     var uiSourceCode = project.createUISourceCode(url, contentProvider.contentType());
     uiSourceCode[Bindings.NetworkProject._targetSymbol] = this._target;
@@ skipping 56 matching lines @@
   }
 };
 
 Bindings.NetworkProject._networkProjectSymbol = Symbol('networkProject');
 Bindings.NetworkProject._resourceSymbol = Symbol('resource');
 Bindings.NetworkProject._scriptSymbol = Symbol('script');
 Bindings.NetworkProject._styleSheetSymbol = Symbol('styleSheet');
 Bindings.NetworkProject._targetSymbol = Symbol('target');
 Bindings.NetworkProject._frameSymbol = Symbol('frame');
 Bindings.NetworkProject._frameIdSymbol = Symbol('frameid');