[Devtools] Prepare network log view for grouping support

third_party/WebKit/Source/devtools/front_end/network/NetworkLogView.js

 /*
  * Copyright (C) 2007, 2008 Apple Inc.  All rights reserved.
  * Copyright (C) 2008, 2009 Anthony Ricaud <rik@webkit.org>
  * Copyright (C) 2011 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:
  *
  * 1.  Redistributions of source code must retain the above copyright
@@ skipping 62 matching lines @@
 
     /** @type {!Map.<string, !Network.NetworkDataGridNode>} */
     this._nodesByRequestId = new Map();
     /** @type {!Object.<string, boolean>} */
     this._staleRequestIds = {};
     /** @type {number} */
     this._mainRequestLoadTime = -1;
     /** @type {number} */
     this._mainRequestDOMContentLoadedTime = -1;
     this._matchedRequestCount = 0;
+    /** @type {!Array<!Array<!Object>>} */
     this._highlightedSubstringChanges = [];
 
     /** @type {!Array.<!Network.NetworkLogView.Filter>} */
     this._filters = [];
     /** @type {?Network.NetworkLogView.Filter} */
     this._timeFilter = null;
+    /** @type {?Network.NetworkDataGridNode} */
     this._hoveredNode = null;
 
-    this._currentMatchedRequestNode = null;
-    this._currentMatchedRequestIndex = -1;
+    /** @type {?Network.NetworkDataGridNode} */
+    this._currentMatchedNode = null;
+    this._currentMatchedNodeIndex = -1;
 
     /** @type {!Components.Linkifier} */
     this.linkifier = new Components.Linkifier();
 
     this._recording = false;
     this._preserveLog = false;
 
     this._headerHeight = 0;
 
     this._addFilters();
@@ skipping 396 matching lines @@
    */
   elementsToRestoreScrollPositionsFor() {
     if (!this._dataGrid)  // Not initialized yet.
       return [];
     return [this._dataGrid.scrollContainer];
   }
 
   _setupDataGrid() {
     /** @type {!UI.SortableDataGrid} */
     this._dataGrid = this._columns.dataGrid();
+    var contextHandler = this.handleContextMenuForNode.bind(this);
     this._dataGrid.setRowContextMenuCallback(
-        (contextMenu, node) => this.handleContextMenuForRequest(contextMenu, node.request()));
+        (contextMenu, node) => contextHandler(contextMenu, /** @type {!Network.NetworkDataGridNode} */ (node)));
     this._dataGrid.setStickToBottom(true);
     this._dataGrid.setName('networkLog');
     this._dataGrid.setResizeMethod(UI.DataGrid.ResizeMethod.Last);
     this._dataGrid.element.classList.add('network-log-grid');
     this._dataGrid.element.addEventListener('mousedown', this._dataGridMouseDown.bind(this), true);
     this._dataGrid.element.addEventListener('mousemove', this._dataGridMouseMove.bind(this), true);
     this._dataGrid.element.addEventListener('mouseleave', this._dataGridMouseLeave.bind(this), true);
   }
 
   /**
    * @param {!Event} event
    */
   _dataGridMouseMove(event) {
     var node = /** @type {?Network.NetworkDataGridNode} */ (
         this._dataGrid.dataGridNodeFromNode(/** @type {!Node} */ (event.target)));
     var highlightInitiatorChain = event.shiftKey;
     this._setHoveredNode(node, highlightInitiatorChain);
+    // TODO(allada) Support groupping initiator chain instead of first request.
     this._highlightInitiatorChain((highlightInitiatorChain && node) ? node.request() : null);
   }
 
   _dataGridMouseLeave() {
     this._setHoveredNode(null);
     this._highlightInitiatorChain(null);
   }
 
   /**
-   * @param {?Network.NetworkLogEntry} logEntry
+   * @param {?Network.NetworkDataGridNode} node
    * @param {boolean} highlightInitiatorChain
    */
-  setHoveredLogEntry(logEntry, highlightInitiatorChain) {
-    // TODO(allada) Move this into LogEntry/NetworkDataGridNode.
-    this._setHoveredNode(/** @type {?Network.NetworkDataGridNode} */ (logEntry), highlightInitiatorChain);
-    this._highlightInitiatorChain((logEntry && highlightInitiatorChain) ? logEntry.request() : null);
+  setHoveredNode(node, highlightInitiatorChain) {
+    // TODO(allada) Move this into NetworkDataGridNode.
+    this._setHoveredNode(node, highlightInitiatorChain);
+    // TODO(allada) Support groupping initiator chain instead of first request.
+    this._highlightInitiatorChain((node && highlightInitiatorChain) ? node.request() : null);
   }
 
   /**
    * @param {?Network.NetworkDataGridNode} node
    * @param {boolean=} highlightInitiatorChain
    */
   _setHoveredNode(node, highlightInitiatorChain) {
     if (this._hoveredNode)
       this._hoveredNode.element().classList.remove('hover');
     this._hoveredNode = node;
     if (this._hoveredNode)
       this._hoveredNode.element().classList.add('hover');
-    this._columns.setHoveredLogEntry(this._hoveredNode, !!highlightInitiatorChain);
+    this._columns.setHoveredNode(this._hoveredNode, !!highlightInitiatorChain);
   }
 
   /**
    * @param {!Event} event
    */
   _dataGridMouseDown(event) {
     if (!this._dataGrid.selectedNode && event.button)
       event.consume();
   }
 
   /**
    * @param {?SDK.NetworkRequest} request
    */
   _highlightInitiatorChain(request) {
+    // TODO(allada) This should be converted into Node instead of request.
     if (this._requestWithHighlightedInitiators === request)
       return;
     this._requestWithHighlightedInitiators = request;
 
     if (!request) {
       for (var node of this._nodesByRequestId.values()) {
         if (!node.dataGrid)
           continue;
         node.element().classList.remove('network-node-on-initiator-path', 'network-node-on-initiated-path');
       }
@@ skipping 197 matching lines @@
   /**
    * @override
    */
   willHide() {
     this._columns.willHide();
   }
 
   /**
    * @return {!Array<!Network.NetworkDataGridNode>}
    */
-  flatNodesList() {
-    return this._dataGrid.rootNode().flattenChildren();
+  flattenVisibleNodes() {
+    return /** @type {!Array<!Network.NetworkDataGridNode>} */ (this._dataGrid.rootNode().flattenChildren());
+  }
+
+  /**
+   * @return {!Array<!Network.NetworkDataGridNode>}
+   */
+  flattenAllNodes() {
+    return /** @type {!Array<!Network.NetworkDataGridNode>} */ (this._dataGrid.rootNode().flattenChildren(true));
   }
 
   _refresh() {
     this._needsRefresh = false;
 
     if (this._refreshRequestId) {
       this.element.window().cancelAnimationFrame(this._refreshRequestId);
       delete this._refreshRequestId;
     }
 
@@ skipping 27 matching lines @@
         if (!node[Network.NetworkLogView._isFilteredOutSymbol])
           nodesToInsert.push(node);
       }
       if (!isFilteredOut)
         nodesToRefresh.push(node);
       var request = node.request();
       this._timeCalculator.updateBoundaries(request);
       this._durationCalculator.updateBoundaries(request);
     }
 
-    for (var i = 0; i < nodesToInsert.length; ++i) {
-      var node = nodesToInsert[i];
-      var request = node.request();
+    for (var node of nodesToInsert) {
       dataGrid.insertChild(node);
-      node[Network.NetworkLogView._isMatchingSearchQuerySymbol] = this._matchRequest(request);
+      var matched = this._nodeHasDirectMatch(node);
+      node[Network.NetworkLogView._isMatchingSearchQuerySymbol] = matched;
+      var parent = /** @type {?Network.NetworkDataGridNode} */ (node.parent);
+      while (matched && parent && parent[Network.NetworkLogView._isMatchingSearchQuerySymbol] === false) {

[dgozman, 2016/11/30 23:25:19]

"=== false" may be error-prone if that symbol is not set.

+        parent[Network.NetworkLogView._isMatchingSearchQuerySymbol] = true;
+        parent = /** @type {?Network.NetworkDataGridNode} */ (parent.parent);
+      }
     }
 
     for (var node of nodesToRefresh)
       node.refresh();
 
-    this._highlightNthMatchedRequestForSearch(
-        this._updateMatchCountAndFindMatchIndex(this._currentMatchedRequestNode), false);
+    this._highlightNthMatchedNodeForSearch(this._updateMatchCountAndFindMatchIndex(this._currentMatchedNode), false);
 
     this._staleRequestIds = {};
     this._updateSummaryBar();
 
     this._columns.dataChanged();
   }
 
   reset() {
     this._requestWithHighlightedInitiators = null;
     this.dispatchEventToListeners(Network.NetworkLogView.Events.RequestSelected, null);
@@ skipping 49 matching lines @@
    * @param {!SDK.NetworkRequest} request
    */
   _appendRequest(request) {
     var node = new Network.NetworkDataGridNode(this, request);
     node[Network.NetworkLogView._isFilteredOutSymbol] = true;
     node[Network.NetworkLogView._isMatchingSearchQuerySymbol] = false;
 
     // In case of redirect request id is reassigned to a redirected
     // request and we need to update _nodesByRequestId and search results.
     var originalRequestNode = this._nodesByRequestId.get(request.requestId);
-    if (originalRequestNode)
-      this._nodesByRequestId.set(originalRequestNode.request().requestId, originalRequestNode);
+    var originalRequest = originalRequestNode ? originalRequestNode.request() : null;
+    if (originalRequest)
+      this._nodesByRequestId.set(originalRequest.requestId, originalRequestNode);
+
     this._nodesByRequestId.set(request.requestId, node);
 
     // Pull all the redirects of the main request upon commit load.
-    if (request.redirects) {
-      for (var i = 0; i < request.redirects.length; ++i)
-        this._refreshRequest(request.redirects[i]);
-    }
+    if (request.redirects)
+      request.redirects.forEach(this._refreshRequest.bind(this));
 
     this._refreshRequest(request);
   }
 
   /**
    * @param {!Common.Event} event
    */
   _onRequestUpdated(event) {
     var request = /** @type {!SDK.NetworkRequest} */ (event.data);
     this._refreshRequest(request);
@@ skipping 90 matching lines @@
 
   /**
    * @param {boolean} gridMode
    */
   switchViewMode(gridMode) {
     this._columns.switchViewMode(gridMode);
   }
 
   /**
    * @param {!UI.ContextMenu} contextMenu
-   * @param {!SDK.NetworkRequest} request
+   * @param {!Network.NetworkDataGridNode} node
    */
-  handleContextMenuForRequest(contextMenu, request) {
+  handleContextMenuForNode(contextMenu, node) {
+    // TODO(allada) Support groupped items context menu.
+    var request = node.request();
+    if (!request)
+      return;
     contextMenu.appendApplicableItems(request);
     var copyMenu = contextMenu.appendSubMenuItem(Common.UIString('Copy'));
     if (request) {
       copyMenu.appendItem(
           UI.copyLinkAddressLabel(), InspectorFrontendHost.copyText.bind(InspectorFrontendHost, request.contentURL()));
       copyMenu.appendSeparator();
 
       if (request.requestHeadersText()) {
         copyMenu.appendItem(
             Common.UIString.capitalize('Copy ^request ^headers'), this._copyRequestHeaders.bind(this, request));
@@ skipping 48 matching lines @@
       }
     }
 
     if (request && request.resourceType() === Common.resourceTypes.XHR) {
       contextMenu.appendSeparator();
       contextMenu.appendItem(Common.UIString('Replay XHR'), request.replayXHR.bind(request));
       contextMenu.appendSeparator();
     }
   }
 
+  /**
+   * @return {!Array<!SDK.NetworkRequest>}
+   */
+  _allRequests() {
+    return this.flattenAllNodes().map(node => node.request());

[dgozman, 2016/11/30 23:25:19]

There could be nulls in this array which you should filter out.

+  }
+
   _harRequests() {
-    var requests = this._nodesByRequestId.valuesArray().map(function(node) {
-      return node.request();
-    });
-    var httpRequests = requests.filter(Network.NetworkLogView.HTTPRequestsFilter);
+    var httpRequests = this._allRequests().filter(Network.NetworkLogView.HTTPRequestsFilter);
     return httpRequests.filter(Network.NetworkLogView.FinishedRequestsFilter);
   }
 
   _copyAll() {
     var harArchive = {log: (new SDK.HARLog(this._harRequests())).build()};
     InspectorFrontendHost.copyText(JSON.stringify(harArchive, null, 2));
   }
 
   /**
    * @param {!SDK.NetworkRequest} request
@@ skipping 22 matching lines @@
    */
   _copyResponseHeaders(request) {
     InspectorFrontendHost.copyText(request.responseHeadersText);
   }
 
   /**
    * @param {!SDK.NetworkRequest} request
    * @param {string} platform
    */
   _copyCurlCommand(request, platform) {
-    InspectorFrontendHost.copyText(this._generateCurlCommand(request, platform));
+    InspectorFrontendHost.copyText(this._generateCurlCommand(platform, request));
   }
 
   /**
    * @param {string} platform
    */
   _copyAllCurlCommand(platform) {
-    var requests = this._nodesByRequestId.valuesArray().map(node => node.request());
-    var commands = [];
-    for (var request of requests)
-      commands.push(this._generateCurlCommand(request, platform));
+    var commands = this._allRequests().map(this._generateCurlCommand.bind(this, platform));
     if (platform === 'win')
       InspectorFrontendHost.copyText(commands.join(' &\r\n'));
     else
       InspectorFrontendHost.copyText(commands.join(' ;\n'));
   }
 
   _exportAll() {
     var url = SDK.targetManager.mainTarget().inspectedURL();
     var parsedURL = url.asParsedURL();
     var filename = parsedURL ? parsedURL.host : 'network-log';
@@ skipping 18 matching lines @@
     if (confirm(Common.UIString('Are you sure you want to clear browser cache?')))
       SDK.multitargetNetworkManager.clearBrowserCache();
   }
 
   _clearBrowserCookies() {
     if (confirm(Common.UIString('Are you sure you want to clear browser cookies?')))
       SDK.multitargetNetworkManager.clearBrowserCookies();
   }
 
   /**
-   * @param {!SDK.NetworkRequest} request
+   * @param {!Network.NetworkDataGridNode} node
    * @return {boolean}
    */
-  _matchRequest(request) {
+  _nodeHasDirectMatch(node) {
     var re = this._searchRegex;
     if (!re)
       return false;
 
+    var request = node.request();
     var text = this._networkLogLargeRowsSetting.get() ? request.path() + '/' + request.name() : request.name();
-    return re.test(text);
+    if (re.test(text))
+      return true;
+    return false;
   }
 
   _clearSearchMatchedList() {
     this._matchedRequestCount = -1;
-    this._currentMatchedRequestNode = null;
+    this._currentMatchedNode = null;
     this._removeAllHighlights();
   }
 
   _removeAllHighlights() {
     this.removeAllNodeHighlights();
     for (var i = 0; i < this._highlightedSubstringChanges.length; ++i)
       UI.revertDomChanges(this._highlightedSubstringChanges[i]);
     this._highlightedSubstringChanges = [];
   }
 
   dataGridSorted() {
-    this._highlightNthMatchedRequestForSearch(
-        this._updateMatchCountAndFindMatchIndex(this._currentMatchedRequestNode), false);
+    this._highlightNthMatchedNodeForSearch(this._updateMatchCountAndFindMatchIndex(this._currentMatchedNode), false);
   }
 
   /**
    * @param {number} n
    * @param {boolean} reveal
    */
-  _highlightNthMatchedRequestForSearch(n, reveal) {
+  _highlightNthMatchedNodeForSearch(n, reveal) {
     this._removeAllHighlights();
 
-    /** @type {!Array.<!Network.NetworkDataGridNode>} */
-    var nodes = this._dataGrid.rootNode().children;
     var matchCount = 0;
+    var request = null;
     var node = null;
-    for (var i = 0; i < nodes.length; ++i) {
-      if (nodes[i][Network.NetworkLogView._isMatchingSearchQuerySymbol]) {
-        if (matchCount === n) {
-          node = nodes[i];
-          break;
-        }
-        matchCount++;
+    for (node of this.flattenAllNodes()) {
+      if (!node[Network.NetworkLogView._isMatchingSearchQuerySymbol])
+        continue;
+      if (matchCount === n) {
+        // TODO(allada) This should support multiple requests.
+        request = node.request();
+        break;
       }
+      matchCount++;
     }
-    if (!node) {
-      this._currentMatchedRequestNode = null;
+    if (!request || !node) {
+      this._currentMatchedNode = null;
       return;
     }
 
-    var request = node.request();
     if (reveal)
       Common.Revealer.reveal(request);
     var highlightedSubstringChanges = node.highlightMatchedSubstring(this._searchRegex);
     this._highlightedSubstringChanges.push(highlightedSubstringChanges);
 
-    this._currentMatchedRequestNode = node;
-    this._currentMatchedRequestIndex = n;
+    this._currentMatchedNode = node;
+    this._currentMatchedNodeIndex = n;
     this.dispatchEventToListeners(Network.NetworkLogView.Events.SearchIndexUpdated, n);
   }
 
   /**
    * @override
    * @param {!UI.SearchableView.SearchConfig} searchConfig
    * @param {boolean} shouldJump
    * @param {boolean=} jumpBackwards
    */
   performSearch(searchConfig, shouldJump, jumpBackwards) {
     var query = searchConfig.query;
-    var currentMatchedRequestNode = this._currentMatchedRequestNode;
+    var currentMatchedNode = this._currentMatchedNode;
     this._clearSearchMatchedList();
     this._searchRegex = createPlainTextSearchRegex(query, 'i');
 
-    /** @type {!Array.<!Network.NetworkDataGridNode>} */
-    var nodes = this._dataGrid.rootNode().children;
-    for (var i = 0; i < nodes.length; ++i)
-      nodes[i][Network.NetworkLogView._isMatchingSearchQuerySymbol] = this._matchRequest(nodes[i].request());
-    var newMatchedRequestIndex = this._updateMatchCountAndFindMatchIndex(currentMatchedRequestNode);
-    if (!newMatchedRequestIndex && jumpBackwards)
-      newMatchedRequestIndex = this._matchedRequestCount - 1;
-    this._highlightNthMatchedRequestForSearch(newMatchedRequestIndex, shouldJump);
+    var node = this._dataGrid.rootNode();
+    while ((node = /** @type {?Network.NetworkDataGridNode} */ (node.traverseNextNode(false)))) {
+      var matched = this._nodeHasDirectMatch(node);
+      node[Network.NetworkLogView._isMatchingSearchQuerySymbol] = matched;
+      var parent = /** @type {?Network.NetworkDataGridNode} */ (node.parent);
+      while (matched && parent && parent[Network.NetworkLogView._isMatchingSearchQuerySymbol] === false) {
+        parent[Network.NetworkLogView._isMatchingSearchQuerySymbol] = true;
+        parent = /** @type {?Network.NetworkDataGridNode} */ (parent.parent);
+      }
+    }
+
+    var newMatchedIndex = this._updateMatchCountAndFindMatchIndex(currentMatchedNode);
+    if (!newMatchedIndex && jumpBackwards)
+      newMatchedIndex = this._matchedRequestCount - 1;
+    this._highlightNthMatchedNodeForSearch(newMatchedIndex, shouldJump);
   }
 
   /**
    * @override
    * @return {boolean}
    */
   supportsCaseSensitiveSearch() {
     return false;
   }
 
   /**
    * @override
    * @return {boolean}
    */
   supportsRegexSearch() {
     return true;
   }
 
   /**
    * @param {?Network.NetworkDataGridNode} node
    * @return {number}
    */
   _updateMatchCountAndFindMatchIndex(node) {
     /** @type {!Array.<!Network.NetworkDataGridNode>} */
-    var nodes = this._dataGrid.rootNode().children;
+    var nodes = this.flattenAllNodes();
     var matchCount = 0;
     var matchIndex = 0;
     for (var i = 0; i < nodes.length; ++i) {
       if (!nodes[i][Network.NetworkLogView._isMatchingSearchQuerySymbol])
         continue;
       if (node === nodes[i])
         matchIndex = matchCount;
       matchCount++;
     }
     if (this._matchedRequestCount !== matchCount) {
       this._matchedRequestCount = matchCount;
       this.dispatchEventToListeners(Network.NetworkLogView.Events.SearchCountUpdated, matchCount);
     }
     return matchIndex;
   }
 
   /**
    * @param {number} index
    * @return {number}
    */
   _normalizeSearchResultIndex(index) {
     return (index + this._matchedRequestCount) % this._matchedRequestCount;
   }
 
   /**
    * @param {!Network.NetworkDataGridNode} node
    * @return {boolean}
    */
   _applyFilter(node) {
-    var request = node.request();
-    if (this._timeFilter && !this._timeFilter(request))
-      return false;
-    var categoryName = request.resourceType().category().title;
-    if (!this._resourceCategoryFilterUI.accept(categoryName))
-      return false;
-    if (this._dataURLFilterUI.checked() && request.parsedURL.isDataURL())
-      return false;
-    if (request.statusText === 'Service Worker Fallback Required')
-      return false;
-    for (var i = 0; i < this._filters.length; ++i) {
-      if (!this._filters[i](request))
-        return false;
+    for (var request of node.requests()) {
+      if (this._timeFilter && !this._timeFilter(request))
+        continue;
+      var categoryName = request.resourceType().category().title;
+      if (!this._resourceCategoryFilterUI.accept(categoryName))
+        continue;
+      if (this._dataURLFilterUI.checked() && request.parsedURL.isDataURL())
+        continue;
+      if (request.statusText === 'Service Worker Fallback Required')
+        continue;
+      if (this._filters.some(filter => !filter(request)))
+        continue;
+      return true;
     }
-    return true;
+    return false;
   }
 
   /**
    * @param {string} query
    */
   _parseFilterQuery(query) {
     var parsedQuery;
     if (this._textFilterUI.isRegexChecked() && query !== '')
       parsedQuery = {text: [query], filters: []};
     else
@@ skipping 120 matching lines @@
     this._removeAllHighlights();
     this._invalidateAllItems();
   }
 
   /**
    * @override
    */
   jumpToPreviousSearchResult() {
     if (!this._matchedRequestCount)
       return;
-    var index = this._normalizeSearchResultIndex(this._currentMatchedRequestIndex - 1);
-    this._highlightNthMatchedRequestForSearch(index, true);
+    var index = this._normalizeSearchResultIndex(this._currentMatchedNodeIndex - 1);
+    this._highlightNthMatchedNodeForSearch(index, true);
   }
 
   /**
    * @override
    */
   jumpToNextSearchResult() {
     if (!this._matchedRequestCount)
       return;
-    var index = this._normalizeSearchResultIndex(this._currentMatchedRequestIndex + 1);
-    this._highlightNthMatchedRequestForSearch(index, true);
+    var index = this._normalizeSearchResultIndex(this._currentMatchedNodeIndex + 1);
+    this._highlightNthMatchedNodeForSearch(index, true);
   }
 
   /**
    * @override
    */
   searchCanceled() {
     delete this._searchRegex;
     this._clearSearchMatchedList();
     this.dispatchEventToListeners(Network.NetworkLogView.Events.SearchCountUpdated, 0);
   }
@@ skipping 20 matching lines @@
 
   /**
    * @param {!Network.NetworkDataGridNode} node
    */
   _highlightNode(node) {
     UI.runCSSAnimationOnce(node.element(), 'highlighted-row');
     this._highlightedNode = node;
   }
 
   /**
+   * @param {string} platform
    * @param {!SDK.NetworkRequest} request
-   * @param {string} platform
    * @return {string}
    */
-  _generateCurlCommand(request, platform) {
+  _generateCurlCommand(platform, request) {
     var command = ['curl'];
     // These headers are derived from URL (except "version") and would be added by cURL anyway.
     var ignoredHeaders = {'host': 1, 'method': 1, 'path': 1, 'scheme': 1, 'version': 1};
 
     function escapeStringWin(str) {
       /* If there are no new line characters do not escape the " characters
                since it only uglifies the command.
 
                Because cmd.exe parser and MS Crt arguments parsers use some of the
                same escape characters, they can interact with each other in
@@ skipping 150 matching lines @@
   Running: 'running',
   FromCache: 'from-cache'
 };
 
 /** @type {!Array<string>} */
 Network.NetworkLogView._searchKeys =
     Object.keys(Network.NetworkLogView.FilterType).map(key => Network.NetworkLogView.FilterType[key]);
 
 /** @typedef {function(!SDK.NetworkRequest): boolean} */
 Network.NetworkLogView.Filter;