Implement invalidation tracking in devtools

Source/devtools/front_end/timeline/TracingTimelineUIUtils.js

 // Copyright 2014 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.
 
 /**
  * @constructor
  * @extends {WebInspector.TimelineUIUtils}
  */
 WebInspector.TracingTimelineUIUtils = function()
 {
@@ skipping 468 matching lines @@
  * @param {!WebInspector.TracingModel.Event} event
  * @param {!WebInspector.TracingTimelineModel} model
  * @param {!WebInspector.Linkifier} linkifier
  * @param {function(!DocumentFragment)} callback
  */
 WebInspector.TracingTimelineUIUtils.buildTraceEventDetails = function(event, model, linkifier, callback)
 {
     var target = event.thread.target();
     var relatedNode = null;
     var barrier = new CallbackBarrier();
-    if (!event.previewElement && target) {
+    var invalidationBackendNodeIds;
+    if (!event.previewElement) {
         if (event.imageURL)
             WebInspector.DOMPresentationUtils.buildImagePreviewContents(target, event.imageURL, false, barrier.createCallback(saveImage));
         else if (event.picture)
             WebInspector.TracingTimelineUIUtils.buildPicturePreviewContent(event, barrier.createCallback(saveImage));
     }
-    if (event.backendNodeId && target)
+    if (event.backendNodeId)
         target.domModel.pushNodesByBackendIdsToFrontend([event.backendNodeId], barrier.createCallback(setRelatedNode));
+    if (event.invalidationTrackingEvents)
+        invalidationBackendNodeIds = WebInspector.TracingTimelineUIUtils._pushInvalidationNodeIdsToFrontend(event, barrier.createCallback(updateInvalidationNodeIds));

[caseq, 2014/10/17 15:48:55]

nit: I would make this function pass a map from backend to front-end node to
callback instead.

[pdr., 2014/10/20 21:38:05]

Done.

     barrier.callWhenDone(callbackWrapper);
 
     /**
      * @param {!Element=} element
      */
     function saveImage(element)
     {
         event.previewElement = element || null;
     }
 
     /**
      * @param {?Array.<!DOMAgent.NodeId>} nodeIds
      */
     function setRelatedNode(nodeIds)
     {
         if (nodeIds)
             relatedNode = target.domModel.nodeForId(nodeIds[0]);
     }
 
+    /**
+     * @param {?Array.<!DOMAgent.NodeId>} frontendNodeIds
+     */
+    function updateInvalidationNodeIds(frontendNodeIds)
+    {
+        if (!frontendNodeIds)
+            return;
+        if (frontendNodeIds.length != invalidationBackendNodeIds.length) {

[caseq, 2014/10/17 15:48:55]

!==

[pdr., 2014/10/20 21:38:05]

Done.

+            console.error("Did not resolve the correct number of invalidation node ids.");
+            return;
+        }
+
+        var backendToFrontendNodeIdMap = {};
+        invalidationBackendNodeIds.forEach(function(backendNodeId, index) {
+            backendToFrontendNodeIdMap[backendNodeId] = frontendNodeIds[index];
+        });
+
+        if (event.nodeId)
+            event.frontendNodeId = backendToFrontendNodeIdMap[event.nodeId];
+        event.invalidationTrackingEvents.forEach(function(invalidation) {
+            if (invalidation.nodeId)
+                invalidation.frontendNodeId = backendToFrontendNodeIdMap[invalidation.nodeId];
+        });
+    }
+
     function callbackWrapper()
     {
         callback(WebInspector.TracingTimelineUIUtils._buildTraceEventDetailsSynchronously(event, model, linkifier, relatedNode));
     }
 }
 
 /**
  * @param {!WebInspector.TracingModel.Event} event
  * @param {!WebInspector.TracingTimelineModel} model
  * @param {!WebInspector.Linkifier} linkifier
@@ skipping 129 matching lines @@
 
     var warning = event.warning;
     if (warning) {
         var div = document.createElement("div");
         div.textContent = warning;
         contentHelper.appendElementRow(WebInspector.UIString("Warning"), div);
     }
     if (event.previewElement)
         contentHelper.appendElementRow(WebInspector.UIString("Preview"), event.previewElement);
 
-    if (event.stackTrace || (event.initiator && event.initiator.stackTrace))
+    if (event.stackTrace || (event.initiator && event.initiator.stackTrace) || event.invalidationTrackingEvents)
         WebInspector.TracingTimelineUIUtils._generateCauses(event, contentHelper);
 
     fragment.appendChild(contentHelper.element);
     return fragment;
 }
 
 /**
  * @param {!WebInspector.TracingModel.Event} event
  * @param {!WebInspector.TimelineDetailsContentHelper} contentHelper
  */
 WebInspector.TracingTimelineUIUtils._generateCauses = function(event, contentHelper)
 {
     var recordTypes = WebInspector.TracingTimelineModel.RecordType;
 
     var callSiteStackLabel;
     var stackLabel;
+    var initiator = event.initiator;
 
     switch (event.name) {
     case recordTypes.TimerFire:
         callSiteStackLabel = WebInspector.UIString("Timer installed");
         break;
     case recordTypes.FireAnimationFrame:
         callSiteStackLabel = WebInspector.UIString("Animation frame requested");
         break;
     case recordTypes.RecalculateStyles:
         stackLabel = WebInspector.UIString("Stack when style recalculation was forced");
         break;
     case recordTypes.Layout:
         callSiteStackLabel = WebInspector.UIString("First layout invalidation");
         stackLabel = WebInspector.UIString("Stack when layout was forced");
         break;
     }
 
     // Direct cause.
     if (event.stackTrace)
         contentHelper.appendStackTrace(stackLabel || WebInspector.UIString("Stack when this event occurred"), event.stackTrace);
 
-    // Indirect cause / invalidation.
-    var initiator = event.initiator;
-    if (initiator && initiator.stackTrace)
+    // Indirect causes.
+    if (event.invalidationTrackingEvents) { // Full invalidation tracking (experimental).
+        WebInspector.TracingTimelineUIUtils._generateInvalidations(event, contentHelper);
+    } else if (initiator && initiator.stackTrace) { // Partial invalidation tracking.
         contentHelper.appendStackTrace(callSiteStackLabel || WebInspector.UIString("Stack when first invalidated"), initiator.stackTrace);
+    }
 }
 
 /**
+ * @param {!WebInspector.TracingModel.Event} event
+ * @param {!WebInspector.TimelineDetailsContentHelper} contentHelper
+ */
+WebInspector.TracingTimelineUIUtils._generateInvalidations = function(event, contentHelper)
+{
+    if (!event.invalidationTrackingEvents)
+        return;
+
+    var target = event.thread.target();
+    var invalidations = {};
+    event.invalidationTrackingEvents.forEach(function(invalidation) {
+        if (invalidations[invalidation.type] === undefined)

[caseq, 2014/10/17 15:48:55]

nit:  if (!invalidations[invalidation.type]) ...

[pdr., 2014/10/20 21:38:05]

Done

+            invalidations[invalidation.type] = [invalidation];
+        else
+            invalidations[invalidation.type].push(invalidation);
+    });
+
+    Object.keys(invalidations).forEach(function(type) {
+        WebInspector.TracingTimelineUIUtils._generateInvalidationsForType(
+            type, target, invalidations[type], contentHelper);
+    });
+}
+
+/**
+ * @param {string} type
+ * @param {?WebInspector.Target} target
+ * @param {!Object} invalidationEvents
+ * @param {!WebInspector.TimelineDetailsContentHelper} contentHelper
+ */
+WebInspector.TracingTimelineUIUtils._generateInvalidationsForType = function(type, target, invalidationEvents, contentHelper)
+{
+    var title;
+    switch (type) {
+    case WebInspector.TracingTimelineModel.RecordType.StyleRecalcInvalidationTracking:
+        title = WebInspector.UIString("Style invalidations");
+        break;
+    case WebInspector.TracingTimelineModel.RecordType.LayoutInvalidationTracking:
+        title = WebInspector.UIString("Layout invalidations");
+        break;
+    default:
+        title = WebInspector.UIString("Other invalidations");
+        break;
+    }
+
+    var detailsNode = document.createElement("div");
+    detailsNode.className = "timeline-details-view-row";
+    var titleElement = detailsNode.createChild("span", "timeline-details-view-row-title");
+    titleElement.textContent = WebInspector.UIString("%s: ", title);
+    var eventsList = detailsNode.createChild("ol");
+    invalidationEvents.forEach(appendInvalidations);
+
+    contentHelper.element.appendChild(detailsNode);
+
+
+    function appendInvalidations(invalidation, index)
+    {
+        var row = eventsList.createChild("li");
+        var nodeRow = row.createChild("div");
+        var node = target.domModel.nodeForId(invalidation.frontendNodeId);
+        if (node)
+            nodeRow.appendChild(WebInspector.DOMPresentationUtils.linkifyNodeReference(node));
+        else if (invalidation.nodeName)
+            nodeRow.textContent = WebInspector.UIString("[ %s ]", invalidation.nodeName);
+        else
+            nodeRow.textContent = WebInspector.UIString("[ unknown node ]");
+
+        if (invalidation.reason) {
+            var reasonRow = row.createChild("div");
+            var reason = invalidation.reason;
+            // We should clean up invalidation strings so they are consistent: crbug.com/424451.
+            if (!invalidation.reason.endsWith("."))
+                reason += ".";
+            reasonRow.textContent = WebInspector.UIString("Reason: %s", reason);
+        }
+
+        if (invalidation.stackTrace)
+            contentHelper.createChildStackTraceElement(row, invalidation.stackTrace);
+    }
+}
+
+/**
+ * @param {!WebInspector.TracingModel.Event} event
+ * @param {function(!Array.<number>)} callback
+ * @return {?Array.<number>} backend node ids
+ */
+WebInspector.TracingTimelineUIUtils._pushInvalidationNodeIdsToFrontend = function(event, callback)
+{
+    var backendNodeIds = [];
+
+    var dedupedNodeIds = {};
+    if (event.nodeId) {
+        backendNodeIds.push(event.nodeId);
+        dedupedNodeIds[event.nodeId] = true;
+    }
+    event.invalidationTrackingEvents.forEach(function(invalidation) {
+        if (invalidation.nodeId && !dedupedNodeIds[invalidation.nodeId]) {
+            backendNodeIds.push(invalidation.nodeId);
+            dedupedNodeIds[invalidation.nodeId] = true;
+        }
+    });
+
+    var target = event.thread.target();
+    target.domModel.pushNodesByBackendIdsToFrontend(backendNodeIds, callback);
+    return backendNodeIds;
+}
+
+/**
  * @param {!Object} total
  * @param {!WebInspector.TracingTimelineModel} model
  * @param {!WebInspector.TracingModel.Event} event
  * @return {boolean}
  */
 WebInspector.TracingTimelineUIUtils._aggregatedStatsForTraceEvent = function(total, model, event)
 {
     var events = model.inspectedTargetEvents();
     /**
      * @param {number} startTime
@@ skipping 115 matching lines @@
     return result;
 }
 
 /**
  * @return {!WebInspector.TracingTimelineModel.Filter}
  */
 WebInspector.TracingTimelineUIUtils.hiddenEventsFilter = function()
 {
     return new WebInspector.TracingTimelineModel.InclusiveEventNameFilter(WebInspector.TracingTimelineUIUtils._visibleTypes());
 }