add env var info to the diagnostics page

pkg/analysis_server/lib/src/status/diagnostics.dart

 // Copyright (c) 2017, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 
 import 'package:analysis_server/protocol/protocol_generated.dart';
 import 'package:analysis_server/src/analysis_server.dart';
@@ skipping 93 matching lines @@
 
 .menu-item .counter {
   float: right;
   margin-left: 5px;
 }
 
 td.right {
   text-align: right;
 }
 
+table td {
+  max-width: 600px;
+  vertical-align: text-top;
+}
+
 td.pre {
   white-space: pre;
 }
 
 .nowrap {
   white-space: nowrap;
 }
 
 .scroll-table {
   max-height: 190px;
@@ skipping 46 matching lines @@
       return;
     }
     AnalysisDriver driver = server.getAnalysisDriver(path);
     if (driver == null) {
       p('The file <code>${escape(path)}</code> is not being analyzed.',
           raw: true);
       return;
     }
     AnalysisResult result = await driver.getResult(path);
     if (result == null) {
-      p('An AST could not be produced for the file <code>${escape(path)}</code>.',
+      p(
+          'An AST could not be produced for the file <code>${escape(
+          path)}</code>.',
           raw: true);
       return;
     }
 
     AstWriter writer = new AstWriter(buf);
     result.unit.accept(writer);
   }
 
   @override
   Future<Null> generatePage(Map<String, String> params) async {
@@ skipping 108 matching lines @@
     List<CompletionPerformance> completions =
         completionDomain.performanceList.items.toList();
 
     if (completions.isEmpty) {
       blankslate('No completions recorded.');
       return;
     }
 
     int fastCount =
         completions.where((c) => c.elapsedInMilliseconds <= 100).length;
-    p('${completions.length} results; ${printPercentage(fastCount / completions.length)} within 100ms.');
+    p('${completions.length} results; ${printPercentage(
+        fastCount / completions.length)} within 100ms.');
 
     // draw a chart
     buf.writeln(
         '<div id="chart-div" style="width: 700px; height: 300px;"></div>');
     StringBuffer rowData = new StringBuffer();
     for (int i = completions.length - 1; i >= 0; i--) {
       // [' ', 101.5]
       if (rowData.isNotEmpty) {
         rowData.write(',');
       }
@@ skipping 14 matching lines @@
       }
       </script>
 ''');
 
     // emit the data as a table
     buf.writeln('<table>');
     buf.writeln(
         '<tr><th>Time</th><th>Results</th><th>Source</th><th>Snippet</th></tr>');
     for (CompletionPerformance completion in completions) {
       buf.writeln('<tr>'
-          '<td class="pre right">${printMilliseconds(completion.elapsedInMilliseconds)}</td>'
+          '<td class="pre right">${printMilliseconds(
+          completion.elapsedInMilliseconds)}</td>'
           '<td class="right">${completion.suggestionCount}</td>'
           '<td>${escape(completion.source.shortName)}</td>'
           '<td><code>${escape(completion.snippet)}</code></td>'
           '</tr>');
     }
     buf.writeln('</table>');
   }
 }
 
 class ContextsPage extends DiagnosticPageWithNav {
@@ skipping 103 matching lines @@
         .join(', '));
 
     List<String> priorityFiles = driver.priorityFiles;
     List<String> addedFiles = driver.addedFiles.toList();
     List<String> implicitFiles =
         driver.knownFiles.difference(driver.addedFiles).toList();
     addedFiles.sort();
     implicitFiles.sort();
 
     String lenCounter(List list) {
-      return '<span class="counter" style="float: right;">${list.length}</span>';
+      return '<span class="counter" style="float: right;">${list
+          .length}</span>';
     }
 
     h3('Context files');
 
     void writeFile(String file) {
       String astPath = '/ast?file=${Uri.encodeQueryComponent(file)}';
       String elementPath = '/element?file=${Uri.encodeQueryComponent(file)}';
 
       buf.write(file);
       buf.writeln(' <a href="$astPath">ast</a>');
@@ skipping 106 matching lines @@
     buf.writeln('''
     <header class="masthead">
     <div class="container">
       <span class="masthead-logo">
       <span class="mega-octicon octicon-dashboard"></span>
         ${site.title} Diagnostics
       </span>
 
       <nav class="masthead-nav">
         <a href="/status" ${isNavPage ? ' class="active"' : ''}>Diagnostics</a>
-        <a href="/feedback" ${isCurrentPage('/feedback') ? ' class="active"' : ''}>Feedback</a>
+        <a href="/feedback" ${isCurrentPage('/feedback')
+        ? ' class="active"'
+        : ''}>Feedback</a>
         <a href="https://www.dartlang.org/tools/analyzer" target="_blank">Docs</a>
         <a href="https://htmlpreview.github.io/?https://github.com/dart-lang/sdk/blob/master/pkg/analysis_server/doc/api.html" target="_blank">Spec</a>
       </nav>
     </div>
     </header>
 ''');
   }
 
   Future<Null> generatePage(Map<String, String> params) async {
     buf.writeln('<!DOCTYPE html><html lang="en">');
@@ skipping 72 matching lines @@
   SocketServer socketServer;
 
   /// The last few lines printed.
   List<String> lastPrintedLines = <String>[];
 
   DiagnosticsSite(this.socketServer, this.lastPrintedLines)
       : super('Analysis Server') {
     pages.add(new CompletionPage(this));
     pages.add(new CommunicationsPage(this));
     pages.add(new ContextsPage(this));
+    pages.add(new EnvironmentVariablesPage(this));
     pages.add(new ExceptionsPage(this));
     pages.add(new InstrumentationPage(this));
     pages.add(new OverlaysPage(this));
     pages.add(new PluginsPage(this));
     pages.add(new ProfilePage(this));
     pages.add(new SubscriptionsPage(this));
 
     ProcessProfiler profiler = ProcessProfiler.getProfilerForPlatform();
     if (profiler != null) {
       pages.add(new MemoryAndCpuPage(this, profiler));
@@ skipping 41 matching lines @@
       return;
     }
     AnalysisDriver driver = server.getAnalysisDriver(path);
     if (driver == null) {
       p('The file <code>${escape(path)}</code> is not being analyzed.',
           raw: true);
       return;
     }
     AnalysisResult result = await driver.getResult(path);
     if (result == null) {
-      p('An element model could not be produced for the file <code>${escape(path)}</code>.',
+      p(
+          'An element model could not be produced for the file <code>${escape(
+          path)}</code>.',
           raw: true);
       return;
     }
 
     ElementWriter writer = new ElementWriter(buf);
     result.unit.element.accept(writer);
   }
 
   @override
   Future<Null> generatePage(Map<String, String> params) async {
@@ skipping 10 matching lines @@
   final StackTrace trace;
 
   ExceptionPage(Site site, String message, this.trace)
       : super(site, '', '500 Oops', description: message);
 
   void generateContent(Map<String, String> params) {
     p(trace.toString(), style: 'white-space: pre');
   }
 }
 
+class EnvironmentVariablesPage extends DiagnosticPageWithNav {
+  EnvironmentVariablesPage(DiagnosticsSite site)
+      : super(site, 'environment', 'Environment Variables',
+            description:
+                'System environment variables as seen from the analysis server.');
+
+  @override
+  void generateContent(Map<String, String> params) {
+    buf.writeln('<table>');
+    buf.writeln('<tr><th>Variable</th><th>Value</th></tr>');
+    for (String key in Platform.environment.keys.toList()..sort()) {
+      String value = Platform.environment[key];
+      buf.writeln('<tr><td>${escape(key)}</td><td>${escape(value)}</td></tr>');
+    }
+    buf.writeln('</table>');
+  }
+}
+
 class ExceptionsPage extends DiagnosticPageWithNav {
   ExceptionsPage(DiagnosticsSite site)
       : super(site, 'exceptions', 'Exceptions',
             description: 'Exceptions from the analysis server.');
 
   Iterable<ServerException> get exceptions => server.exceptions.items;
 
   String get navDetail => printInteger(exceptions.length);
 
   @override
@@ skipping 36 matching lines @@
     if (server.options.clientId != null) {
       ideInfo.add(server.options.clientId);
     }
     if (server.options.clientVersion != null) {
       ideInfo.add(server.options.clientVersion);
     }
     String ideText = ideInfo.map((str) => '<code>$str</code>').join(', ');
 
     p('Other data to include:');
     ul([
-      "the IDE you are using and it's version${ideText.isEmpty ? '' : ' ($ideText)'}",
+      "the IDE you are using and it's version${ideText.isEmpty
+          ? ''
+          : ' ($ideText)'}",
       'the Dart SDK version (<code>${escape(_sdkVersion)}</code>)',
-      'your operating system (<code>${escape(Platform.operatingSystem)}</code>)',
+      'your operating system (<code>${escape(
+          Platform.operatingSystem)}</code>)',
     ], (line) => buf.writeln(line));
 
     p('Thanks!');
   }
 }
 
 class InstrumentationPage extends DiagnosticPageWithNav {
   InstrumentationPage(DiagnosticsSite site)
       : super(site, 'instrumentation', 'Instrumentation',
             description:
@@ skipping 86 matching lines @@
         p('<code>${escape(overlayPath)}</code> not found.', raw: true);
       }
 
       return;
     }
 
     if (paths.isEmpty) {
       blankslate('No overlays.');
     } else {
       String lenCounter(List list) {
-        return '<span class="counter" style="float: right;">${list.length}</span>';
+        return '<span class="counter" style="float: right;">${list
+            .length}</span>';
       }
 
       h3('Overlays ${lenCounter(paths)}', raw: true);
       ul(paths, (String overlayPath) {
         String uri = '$path?overlay=${Uri.encodeQueryComponent(overlayPath)}';
         buf.writeln('<a href="$uri">${escape(overlayPath)}</a>');
       });
     }
   }
 }
@@ skipping 25 matching lines @@
 
     List<Plugin> plugins = [
       AnalysisEngine.instance.enginePlugin,
       server.serverPlugin
     ];
     plugins.addAll(server.userDefinedPlugins);
     ul(plugins, writePlugin);
   }
 }
 
+// TODO(devoncarew): We're not currently tracking the time spent in specific
+// lints by default (analysisOptions / driverOptions enableTiming)
+final bool _showLints = false;

[Brian Wilkerson, 2017/07/19 21:51:09]

It would be nice to be able to see the timing information when it exists, rather
than permanently disabling it.

[devoncarew, 2017/07/19 22:02:13]

I don't think it's ever enabled in the context of the analysis server though? I
think that flag only gets flipped when run from the CLI?

Happy to update this if there's something I should be checking at runtime.

+
 class ProfilePage extends DiagnosticPageWithNav {
   ProfilePage(DiagnosticsSite site)
       : super(site, 'profile', 'Profiling Info',
-            description: 'Profiling performance tag data and lint timings.');
+            description: 'Profiling performance tag data.');
 
   @override
   void generateContent(Map<String, String> params) {
     h3('Profiling performance tag data');
 
     // prepare sorted tags
     List<PerformanceTag> tags = PerformanceTag.all.toList();
     tags.remove(ServerPerformanceStatistics.idle);
     tags.remove(PerformanceTag.unknown);
     tags.removeWhere((tag) => tag.elapsedMs == 0);
@@ skipping 50 matching lines @@
       _writeRow([
         tag.label,
         printMilliseconds(tag.elapsedMs),
         printPercentage(percent)
       ]);
     }
 
     tags.forEach(writeRow);
     buf.write('</table>');
 
-    h3('Lint rule timings');
-    List<LintRule> rules = Registry.ruleRegistry.rules.toList();
-    int totalLintTime = rules.fold(0,
-        (sum, rule) => sum + lintRegistry.getTimer(rule).elapsedMilliseconds);
-    p('Total time spent in lints: ${printMilliseconds(totalLintTime)}');
+    if (_showLints) {
+      h3('Lint rule timings');
+      List<LintRule> rules = Registry.ruleRegistry.rules.toList();
+      int totalLintTime = rules.fold(0,
+          (sum, rule) => sum + lintRegistry.getTimer(rule).elapsedMilliseconds);
+      p('Total time spent in lints: ${printMilliseconds(totalLintTime)}');
 
-    rules.sort((first, second) {
-      int firstTime = lintRegistry.getTimer(first).elapsedMilliseconds;
-      int secondTime = lintRegistry.getTimer(second).elapsedMilliseconds;
-      if (firstTime == secondTime) {
-        return first.lintCode.name.compareTo(second.lintCode.name);
+      rules.sort((first, second) {
+        int firstTime = lintRegistry.getTimer(first).elapsedMilliseconds;
+        int secondTime = lintRegistry.getTimer(second).elapsedMilliseconds;
+        if (firstTime == secondTime) {
+          return first.lintCode.name.compareTo(second.lintCode.name);
+        }
+        return secondTime - firstTime;
+      });
+      buf.write('<table>');
+      _writeRow(['Lint code', 'Time (in ms)'], header: true);
+      for (var rule in rules) {
+        int time = lintRegistry.getTimer(rule).elapsedMilliseconds;
+        _writeRow([rule.lintCode.name, printMilliseconds(time)]);
       }
-      return secondTime - firstTime;
-    });
-    buf.write('<table>');
-    _writeRow(['Lint code', 'Time (in ms)'], header: true);
-    for (var rule in rules) {
-      int time = lintRegistry.getTimer(rule).elapsedMilliseconds;
-      _writeRow([rule.lintCode.name, printMilliseconds(time)]);
+      buf.write('</table>');
     }
-    buf.write('</table>');
   }
 }
 
 class StatusPage extends DiagnosticPageWithNav {
   StatusPage(DiagnosticsSite site)
       : super(site, 'status', 'Status',
             description:
                 'General status and diagnostics for the analysis server.');
 
   @override
@@ skipping 57 matching lines @@
     h3('Execution domain');
     ul(ExecutionService.VALUES, (item) {
       if (domain.onFileAnalyzed != null) {
         buf.write('$item (has subscriptions)');
       } else {
         buf.write('$item (no subscriptions)');
       }
     });
   }
 }