Add analytics to analyzer-cli and analysis server.

pkg/analyzer_cli/lib/src/options.dart

 // Copyright (c) 2015, 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:io';
 
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/src/command_line/arguments.dart';
 import 'package:analyzer/src/context/builder.dart';
 import 'package:analyzer/src/util/sdk.dart';
 import 'package:analyzer_cli/src/ansi.dart' as ansi;
 import 'package:analyzer_cli/src/driver.dart';
 import 'package:args/args.dart';
+import 'package:telemetry/telemetry.dart' as telemetry;
 
 const _binaryName = 'dartanalyzer';
 
 /// Shared exit handler.
 ///
 /// *Visible for testing.*
 ExitHandler exitHandler = exit;
 
 /// Print the given [message] to stderr and exit with the given [exitCode].
 void printAndFail(String message, {int exitCode: 15}) {
@@ skipping 84 matching lines @@
   final bool log;
 
   /// Whether to use machine format for error display
   final bool machineFormat;
 
   /// The path to a file to write a performance log.
   /// (Or null if not enabled.)
   final String perfReport;
 
   /// Batch mode (for unit testing)
-  final bool shouldBatch;
+  final bool batchMode;
 
   /// Whether to show package: warnings
   final bool showPackageWarnings;
 
   /// If not null, show package: warnings only for matching packages.
   final String showPackageWarningsPrefix;
 
   /// Whether to show SDK warnings
   final bool showSdkWarnings;
 
@@ skipping 48 matching lines @@
         disableCacheFlushing = args['disable-cache-flushing'],
         disableHints = args['no-hints'],
         displayVersion = args['version'],
         enableTypeChecks = args['enable_type_checks'],
         enableAssertInitializer = args['enable-assert-initializers'],
         ignoreUnrecognizedFlags = args['ignore-unrecognized-flags'],
         lints = args[lintsFlag],
         log = args['log'],
         machineFormat = args['format'] == 'machine',
         perfReport = args['x-perf-report'],
-        shouldBatch = args['batch'],
+        batchMode = args['batch'],
         showPackageWarnings = args['show-package-warnings'] ||
             args['package-warnings'] ||
             args['x-package-warnings-prefix'] != null,
         showPackageWarningsPrefix = args['x-package-warnings-prefix'],
         showSdkWarnings = args['sdk-warnings'],
         _sourceFiles = args.rest,
         infosAreFatal = args['fatal-infos'] || args['fatal-hints'],
         warningsAreFatal = args['fatal-warnings'],
         lintsAreFatal = args['fatal-lints'],
         strongMode = args['strong'],
@@ skipping 33 matching lines @@
 
   /// Replace the sourceFiles parsed from the command line.
   void rewriteSourceFiles(List<String> newSourceFiles) {
     _sourceFiles = newSourceFiles;
   }
 
   /// Parse [args] into [CommandLineOptions] describing the specified
   /// analyzer options. In case of a format error, calls [printAndFail], which
   /// by default prints an error message to stderr and exits.
   static CommandLineOptions parse(List<String> args,
-      [printAndFail(String msg) = printAndFail]) {
+      {printAndFail(String msg) = printAndFail}) {
     CommandLineOptions options = _parse(args);
+
+    /// Only happens in testing.
+    if (options == null) {
+      return null;
+    }
+
     // Check SDK.
     if (!options.buildModePersistentWorker) {
       // Infer if unspecified.
       options.dartSdkPath ??= getSdkPath(args);
 
       String sdkPath = options.dartSdkPath;
 
       // Check that SDK is specified.
       if (sdkPath == null) {
         printAndFail('No Dart SDK found.');
@@ skipping 86 matching lines @@
       ..addFlag('no-hints',
           help: 'Do not show hint results.',
           defaultsTo: false,
           negatable: false)
       ..addFlag('fatal-infos',
           help: 'Treat infos as fatal.', defaultsTo: false, negatable: false)
       ..addFlag('fatal-warnings',
           help: 'Treat non-type warnings as fatal.',
           defaultsTo: false,
           negatable: false)
+      ..addFlag('analytics',
+          help: 'Enable or disable sending analytics information to Google.')
       ..addFlag('help',
           abbr: 'h',
           help:
               'Display this help message. Add --verbose to show hidden options.',
           defaultsTo: false,
           negatable: false)
       ..addFlag('verbose',
           abbr: 'v',
           defaultsTo: false,
           help: 'Verbose output.',
@@ skipping 162 matching lines @@
           printAndFail('The --persistent_worker flag should be used with and '
               'only with the --build-mode flag, and possibly the --dart-sdk '
               'option. Got: $args');
           return null; // Only reachable in testing.
         }
         return new CommandLineOptions._fromArgs(results);
       }
 
       // Help requests.
       if (results['help']) {
-        _showUsage(parser);
+        _showUsage(parser, analytics, fromHelp: true);
         exitHandler(0);
         return null; // Only reachable in testing.
       }
+
+      // Enable / disable analytics.
+      if (results.wasParsed('analytics')) {
+        analytics.enabled = results['analytics'];
+        outSink
+            .writeln(telemetry.createAnalyticsStatusMessage(analytics.enabled));
+        exitHandler(0);
+        return null; // Only reachable in testing.
+      }
+
       // Batch mode and input files.
       if (results['batch']) {
         if (results.rest.isNotEmpty) {
           errorSink.writeln('No source files expected in the batch mode.');
-          _showUsage(parser);
+          _showUsage(parser, analytics);
           exitHandler(15);
           return null; // Only reachable in testing.
         }
       } else if (results['persistent_worker']) {
         if (results.rest.isNotEmpty) {
           errorSink.writeln(
               'No source files expected in the persistent worker mode.');
-          _showUsage(parser);
+          _showUsage(parser, analytics);
           exitHandler(15);
           return null; // Only reachable in testing.
         }
       } else if (results['version']) {
         outSink.writeln('$_binaryName version ${_getVersion()}');
         exitHandler(0);
         return null; // Only reachable in testing.
       } else {
         if (results.rest.isEmpty && !results['build-mode']) {
-          _showUsage(parser);
+          _showUsage(parser, analytics, fromHelp: true);
           exitHandler(15);
           return null; // Only reachable in testing.
         }
       }
       return new CommandLineOptions._fromArgs(results);
     } on FormatException catch (e) {
       errorSink.writeln(e.message);
-      _showUsage(parser);
+      _showUsage(parser, null);
       exitHandler(15);
       return null; // Only reachable in testing.
     }
   }
 
-  static _showUsage(ArgParser parser) {
+  static _showUsage(ArgParser parser, telemetry.Analytics analytics,
+      {bool fromHelp: false}) {
+    void printAnalyticsInfo() {
+      if (fromHelp) {
+        errorSink.writeln('');
+        errorSink.writeln(telemetry.analyticsNotice);
+      }
+
+      if (analytics != null) {
+        errorSink.writeln('');
+        errorSink.writeln(telemetry.createAnalyticsStatusMessage(
+            analytics.enabled,
+            command: 'analytics'));
+      }
+    }
+
     errorSink.writeln(
         'Usage: $_binaryName [options...] <directory or list of files>');
+
+    // If it's our first run, we display the analytics info more prominently.
+    if (analytics != null && analytics.firstRun) {
+      printAnalyticsInfo();
+    }
+
     errorSink.writeln('');
     errorSink.writeln(parser.usage);
+
+    if (analytics != null && !analytics.firstRun) {
+      printAnalyticsInfo();
+    }
+
     errorSink.writeln('');
     errorSink.writeln('''
 Run "dartanalyzer -h -v" for verbose help output, including less commonly used options.
-For more information, see http://www.dartlang.org/tools/analyzer.
-''');
+For more information, see https://www.dartlang.org/tools/analyzer.\n''');
   }
 }