Make source_dependencies in about:net-internals clickable.

chrome/browser/resources/net_internals/log_view_painter.js

 // Copyright (c) 2011 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.
 
 /**
  * TODO(eroman): This needs better presentation, and cleaner code. This
  *               implementation is more of a transitionary step as
  *               the old net-internals is replaced.
  */
 
-// TODO(eroman): these functions should use lower-case names.
-var PaintLogView;
-var PrintSourceEntriesAsText;
+var paintLogView;
+var printLogEntriesAsText;
 var proxySettingsToString;
 var stripCookiesAndLoginInfo;
 
 // Start of anonymous namespace.
 (function() {
 'use strict';
 
-PaintLogView = function(sourceEntries, node) {
+paintLogView = function(sourceEntries, node) {
   for (var i = 0; i < sourceEntries.length; ++i) {
     if (i != 0)
       addNode(node, 'hr');
     addSourceEntry_(node, sourceEntries[i]);
   }
 }
 
+/**
+ * Outputs descriptive text for |sourceEntry| and its events to |node|.
+ */
 function addSourceEntry_(node, sourceEntry) {
   var div = addNode(node, 'div');
   div.className = 'logSourceEntry';
 
   var p = addNode(div, 'p');
-  var nobr = addNode(p, 'nobr');
+  addNodeWithText(p, 'h4',
+                  sourceEntry.getSourceId() + ': ' +
+                      sourceEntry.getSourceTypeString());
 
-  addTextNode(nobr, sourceEntry.getDescription());
-
-  var p2 = addNode(div, 'p');
-  var nobr2 = addNode(p2, 'nobr');
+  if (sourceEntry.getDescription())
+    addNodeWithText(p, 'h4', sourceEntry.getDescription());
 
   var logEntries = sourceEntry.getLogEntries();
   var startDate = timeutil.convertTimeTicksToDate(logEntries[0].time);
-  addTextNode(nobr2, 'Start Time: ' + startDate.toLocaleString());
+  addNodeWithText(p, 'div', 'Start Time: ' + startDate.toLocaleString());
 
-  var pre = addNode(div, 'pre');
-  addTextNode(pre, PrintSourceEntriesAsText(logEntries));
+  sourceEntry.printAsText(div);
 }
 
 function canCollapseBeginWithEnd(beginEntry) {
   return beginEntry &&
          beginEntry.isBegin() &&
          beginEntry.end &&
          beginEntry.end.index == beginEntry.index + 1 &&
          (!beginEntry.orig.params || !beginEntry.end.orig.params) &&
          beginEntry.orig.wasPassivelyCaptured ==
              beginEntry.end.orig.wasPassivelyCaptured;
 }
 
-PrintSourceEntriesAsText = function(sourceEntries) {
-  var entries = LogGroupEntry.createArrayFrom(sourceEntries);
+/**
+ * Adds a child pre element to the end of |parent|, and writes the
+ * formatted contents of |logEntries| to it.
+ */
+printLogEntriesAsText = function(logEntries, parent) {
+  var entries = LogGroupEntry.createArrayFrom(logEntries);
+  var tablePrinter = new TablePrinter();
+
   if (entries.length == 0)
-    return '';
+    return;
 
   var startDate = timeutil.convertTimeTicksToDate(entries[0].orig.time);
   var startTime = startDate.getTime();
 
-  var tablePrinter = new TablePrinter();
-
   for (var i = 0; i < entries.length; ++i) {
     var entry = entries[i];
 
     // Avoid printing the END for a BEGIN that was immediately before, unless
     // both have extra parameters.
     if (!entry.isEnd() || !canCollapseBeginWithEnd(entry.begin)) {
       tablePrinter.addRow();
 
       // Annotate this entry with "(P)" if it was passively captured.
       tablePrinter.addCell(entry.orig.wasPassivelyCaptured ? '(P) ' : '');
 
       tablePrinter.addCell('t=');
       var date = timeutil.convertTimeTicksToDate(entry.orig.time) ;
       var tCell = tablePrinter.addCell(date.getTime());
       tCell.alignRight = true;
       tablePrinter.addCell(' [st=');
       var stCell = tablePrinter.addCell(date.getTime() - startTime);
       stCell.alignRight = true;
       tablePrinter.addCell('] ');
 
-      var indentationStr = makeRepeatedString(' ', entry.getDepth() * 3);
-      var mainCell =
-          tablePrinter.addCell(indentationStr + getTextForEvent(entry));
-      tablePrinter.addCell('  ');
+      for (var j = entry.getDepth(); j > 0; --j)
+        tablePrinter.addCell('  ');
 
-      // Get the elapsed time.
+      var eventText = getTextForEvent(entry);
+      // Get the elapsed time, and append it to the event text.
       if (entry.isBegin()) {
-        tablePrinter.addCell('[dt=');
         var dt = '?';
         // Definite time.
         if (entry.end) {
           dt = entry.end.orig.time - entry.orig.time;
         }
-        var dtCell = tablePrinter.addCell(dt);
-        dtCell.alignRight = true;
+        eventText += '  [dt=' + dt + ']';
+      }
 
-        tablePrinter.addCell(']');
-      } else {
-        mainCell.allowOverflow = true;
-      }
+      var mainCell = tablePrinter.addCell(eventText);
+      mainCell.allowOverflow = true;
     }
 
     // Output the extra parameters.
     if (entry.orig.params != undefined) {
-      // Add a continuation row for each line of text from the extra parameters.
-      var extraParamsText = getTextForExtraParams(
-          entry.orig,
-          g_browser.sourceTracker.getSecurityStripping());
-      var extraParamsTextLines = extraParamsText.split('\n');
-
-      for (var j = 0; j < extraParamsTextLines.length; ++j) {
-        tablePrinter.addRow();
-        tablePrinter.addCell('');  // Empty passive annotation.
-        tablePrinter.addCell('');  // No t=.
-        tablePrinter.addCell('');
-        tablePrinter.addCell('');  // No st=.
-        tablePrinter.addCell('');
-        tablePrinter.addCell('  ');
-
-        var mainExtraCell =
-            tablePrinter.addCell(indentationStr + extraParamsTextLines[j]);
-        mainExtraCell.allowOverflow = true;
-      }
+      // Those 6s skipped cells are: passive annotation, two for "t=", and
+      // three for "st=".
+      tablePrinter.setNewRowCellIndent(6 + entry.getDepth());
+      addRowsForExtraParams(tablePrinter,
+                            entry.orig,
+                            g_browser.sourceTracker.getSecurityStripping());
+      tablePrinter.setNewRowCellIndent(0);
     }
   }
 
   // Format the table for fixed-width text.
-  return tablePrinter.toText(0);
+  return tablePrinter.toText(0, parent);

[eroman, 2011/12/08 22:21:06]

I would omit the "return", since toText() shouldn't have any significance to its
return value.

[mmenke, 2011/12/08 22:28:37]

Done.

 }
 
 /**
  * |hexString| must be a string of hexadecimal characters with no whitespace,
  * whose length is a multiple of two.  Returns a string spanning multiple lines,
  * with the hexadecimal characters from |hexString| on the left, in groups of
  * two, and their corresponding ASCII characters on the right.
  *
  * |asciiCharsPerLine| specifies how many ASCII characters will be put on each
  * line of the output string.
@@ skipping 23 matching lines @@
     }
 
     // Max sure the ASCII text on last line of output lines up with previous
     // lines.
     hexLine += makeRepeatedString(' ', 3 * asciiCharsPerLine - hexLine.length);
     out.push('   ' + hexLine + '  ' + asciiLine);
   }
   return out.join('\n');
 }
 
-function getTextForExtraParams(entry, enableSecurityStripping) {
+/**
+ * Splits |text| in shorter strings around linebreaks.  For each of the
+ * resulting strings, adds a row to |tablePrinter| with a cell containing
+ * that text, linking to |link|.  |link| may be null.
+ */
+function addTextRows(tablePrinter, text, link) {
+  var textLines = text.split('\n');
+
+  for (var i = 0; i < textLines.length; ++i) {
+    tablePrinter.addRow();
+    var cell = tablePrinter.addCell(textLines[i]);
+    cell.link = link;
+    cell.allowOverflow = true;
+  }
+}
+
+/**
+ * Returns a list of FormattedTextInfo objects for |entry|'s |params|.
+ */
+function addRowsForExtraParams(tablePrinter, entry, enableSecurityStripping) {
   // Format the extra parameters (use a custom formatter for certain types,
   // but default to displaying as JSON).
 
   // If security stripping is enabled, remove data as needed.
   if (enableSecurityStripping)
     entry = stripCookiesAndLoginInfo(entry);
 
   switch (entry.type) {
     case LogEventType.HTTP_TRANSACTION_SEND_REQUEST_HEADERS:
     case LogEventType.HTTP_TRANSACTION_SEND_TUNNEL_HEADERS:
-      return getTextForRequestHeadersExtraParam(entry);
+      addTextRows(tablePrinter,
+                  getTextForRequestHeadersExtraParam(entry),
+                  null);
+      return;
 
     case LogEventType.HTTP_TRANSACTION_READ_RESPONSE_HEADERS:
     case LogEventType.HTTP_TRANSACTION_READ_TUNNEL_RESPONSE_HEADERS:
-      return getTextForResponseHeadersExtraParam(entry);
+      addTextRows(tablePrinter,
+                  getTextForResponseHeadersExtraParam(entry),
+                  null);
+      return;
 
     case LogEventType.PROXY_CONFIG_CHANGED:
-      return getTextForProxyConfigChangedExtraParam(entry);
+      addTextRows(tablePrinter,
+                  getTextForProxyConfigChangedExtraParam(entry),
+                  null);
+      return;
 
     default:
-      var out = [];
       for (var k in entry.params) {
         if (k == 'headers' && entry.params[k] instanceof Array) {
-          out.push(getTextForResponseHeadersExtraParam(entry));
+          addTextRows(tablePrinter,
+                      getTextForResponseHeadersExtraParam(entry),
+                      null);
           continue;
         }
         var value = entry.params[k];
         // For transferred bytes, display the bytes in hex and ASCII.
         if (k == 'hex_encoded_bytes') {
-          out.push(' --> ' + k + ' =');
-          out.push(formatHexString(value, 20));
+          addTextRows(tablePrinter, ' --> ' + k + ' =');
+          addTextRows(tablePrinter, formatHexString(value, 20));
           continue;
         }
 
         var paramStr = ' --> ' + k + ' = ' + JSON.stringify(value);
 
         // Append the symbolic name for certain constants. (This relies
         // on particular naming of event parameters to infer the type).
         if (typeof value == 'number') {
           if (k == 'net_error') {
             paramStr += ' (' + getNetErrorSymbolicString(value) + ')';
           } else if (k == 'load_flags') {
             paramStr += ' (' + getLoadFlagSymbolicString(value) + ')';
           }
         }
 
-        out.push(paramStr);
+        var link = null;
+        // Add link to source_dependency entries.
+        if (k == 'source_dependency' && typeof value == 'object')
+          link = '#events&s=' + value.id;
+
+        addTextRows(tablePrinter, paramStr, link);
       }
-      return out.join('\n');
   }
 }
 
 /**
  * Returns the name for netError.
  *
  * Example: getNetErrorSymbolicString(-105) would return
  * "NAME_NOT_RESOLVED".
  */
 function getNetErrorSymbolicString(netError) {
@@ skipping 220 matching lines @@
   var result = [];
   for (var i = 0; i < modes.length; ++i)
     result.push(indentLines('(' + (i + 1) + ') ', modes[i]));
 
   return result.join('\n');
 };
 
 // End of anonymous namespace.
 })();