Analytics

lib/pub.dart

@@ -9,10 +9,15 @@ import 'src/command_runner.dart';
 import 'src/pub_embeddable_command.dart';
 export 'src/executable.dart'
     show getExecutableForCommand, CommandResolutionFailedException;
+export 'src/pub_embeddable_command.dart' show PubAnalytics;
 
 /// Returns a [Command] for pub functionality that can be used by an embedding
 /// CommandRunner.
-Command<int> pubCommand() => PubEmbeddableCommand();
+///
+/// If [analytics] is given, pub will use that analytics instance to send
+/// statistics about resolutions.
+Command<int> pubCommand({PubAnalytics analytics}) =>
+    PubEmbeddableCommand(analytics);
 
 /// Support for the `pub` toplevel command.
 @Deprecated('Use [pubCommand] instead.')

lib/src/command.dart

@@ -117,6 +117,8 @@ abstract class PubCommand extends Command<int> {
     return _pubEmbeddableCommand ?? (runner as PubCommandRunner);
   }
 
+  PubAnalytics get analytics => _pubEmbeddableCommand?.analytics;
+
   @override
   String get invocation {
     var command = this;

lib/src/command/add.dart

@@ -150,11 +150,10 @@ class AddCommand extends PubCommand {
       // TODO(jonasfj): Stop abusing Entrypoint.global for dry-run output
       await Entrypoint.global(newRoot, entrypoint.lockFile, cache,
               solveResult: solveResult)
-          .acquireDependencies(
-        SolveType.GET,
-        dryRun: true,
-        precompile: argResults['precompile'],
-      );
+          .acquireDependencies(SolveType.GET,
+              dryRun: true,
+              precompile: argResults['precompile'],
+              analytics: analytics);
     } else {
       /// Update the `pubspec.yaml` before calling [acquireDependencies] to
       /// ensure that the modification timestamp on `pubspec.lock` and
@@ -165,14 +164,18 @@ class AddCommand extends PubCommand {
       /// Create a new [Entrypoint] since we have to reprocess the updated
       /// pubspec file.
       final updatedEntrypoint = Entrypoint(directory, cache);
-      await updatedEntrypoint.acquireDependencies(SolveType.GET,
-          precompile: argResults['precompile']);
+      await updatedEntrypoint.acquireDependencies(
+        SolveType.GET,
+        precompile: argResults['precompile'],
+        analytics: analytics,
+      );
 
       if (argResults['example'] && entrypoint.example != null) {
         await entrypoint.example.acquireDependencies(
           SolveType.GET,
           precompile: argResults['precompile'],
           onlyReportSuccessOrFailure: true,
+          analytics: analytics,
         );
       }
     }

lib/src/command/downgrade.dart

@@ -53,16 +53,21 @@ class DowngradeCommand extends PubCommand {
           'The --packages-dir flag is no longer used and does nothing.'));
     }
     var dryRun = argResults['dry-run'];
+
     await entrypoint.acquireDependencies(
       SolveType.DOWNGRADE,
       unlock: argResults.rest,
       dryRun: dryRun,
+      analytics: analytics,
     );
     if (argResults['example'] && entrypoint.example != null) {
-      await entrypoint.example.acquireDependencies(SolveType.GET,
-          unlock: argResults.rest,
-          dryRun: dryRun,
-          onlyReportSuccessOrFailure: true);
+      await entrypoint.example.acquireDependencies(
+        SolveType.GET,
+        unlock: argResults.rest,
+        dryRun: dryRun,
+        onlyReportSuccessOrFailure: true,
+        analytics: analytics,
+      );
     }
 
     if (isOffline) {

lib/src/command/get.dart

@@ -51,14 +51,21 @@ class GetCommand extends PubCommand {
       log.warning(log.yellow(
           'The --packages-dir flag is no longer used and does nothing.'));
     }
-    await entrypoint.acquireDependencies(SolveType.GET,
-        dryRun: argResults['dry-run'], precompile: argResults['precompile']);
+    await entrypoint.acquireDependencies(
+      SolveType.GET,
+      dryRun: argResults['dry-run'],
+      precompile: argResults['precompile'],
+      analytics: analytics,
+    );
 
     if (argResults['example'] && entrypoint.example != null) {
-      await entrypoint.example.acquireDependencies(SolveType.GET,
-          dryRun: argResults['dry-run'],
-          precompile: argResults['precompile'],
-          onlyReportSuccessOrFailure: true);
+      await entrypoint.example.acquireDependencies(
+        SolveType.GET,
+        dryRun: argResults['dry-run'],
+        precompile: argResults['precompile'],
+        onlyReportSuccessOrFailure: true,
+        analytics: analytics,
+      );
     }
   }
 }

lib/src/command/global_activate.dart

@@ -139,8 +139,12 @@ class GlobalActivateCommand extends PubCommand {
 
         var path = readArg('No package to activate given.');
         validateNoExtraArgs();
-        return globals.activatePath(path, executables,
-            overwriteBinStubs: overwrite);
+        return globals.activatePath(
+          path,
+          executables,
+          overwriteBinStubs: overwrite,
+          analytics: analytics,
+        );
     }
 
     throw StateError('unreachable');

lib/src/command/remove.dart

@@ -68,25 +68,30 @@ class RemoveCommand extends PubCommand {
       final newRoot = Package.inMemory(newPubspec);
 
       await Entrypoint.global(newRoot, entrypoint.lockFile, cache)
-          .acquireDependencies(
-        SolveType.GET,
-        precompile: argResults['precompile'],
-        dryRun: true,
-      );
+          .acquireDependencies(SolveType.GET,
+              precompile: argResults['precompile'],
+              dryRun: true,
+              analytics: null);
     } else {
       /// Update the pubspec.
       _writeRemovalToPubspec(packages);
 
       /// Create a new [Entrypoint] since we have to reprocess the updated
       /// pubspec file.
       final updatedEntrypoint = Entrypoint(directory, cache);
-      await updatedEntrypoint.acquireDependencies(SolveType.GET,
-          precompile: argResults['precompile']);
+      await updatedEntrypoint.acquireDependencies(
+        SolveType.GET,
+        precompile: argResults['precompile'],
+        analytics: analytics,
+      );
 
       if (argResults['example'] && entrypoint.example != null) {
-        await entrypoint.example.acquireDependencies(SolveType.GET,
-            precompile: argResults['precompile'],
-            onlyReportSuccessOrFailure: true);
+        await entrypoint.example.acquireDependencies(
+          SolveType.GET,
+          precompile: argResults['precompile'],
+          onlyReportSuccessOrFailure: true,
+          analytics: analytics,
+        );
       }
     }
   }

lib/src/command/upgrade.dart

@@ -122,11 +122,14 @@ class UpgradeCommand extends PubCommand {
   }
 
   Future<void> _runUpgrade(Entrypoint e, {bool onlySummary = false}) async {
-    await e.acquireDependencies(SolveType.UPGRADE,
-        unlock: argResults.rest,
-        dryRun: _dryRun,
-        precompile: _precompile,
-        onlyReportSuccessOrFailure: onlySummary);
+    await e.acquireDependencies(
+      SolveType.UPGRADE,
+      unlock: argResults.rest,
+      dryRun: _dryRun,
+      precompile: _precompile,
+      onlyReportSuccessOrFailure: onlySummary,
+      analytics: analytics,
+    );
 
     _showOfflineWarning();
   }
@@ -233,6 +236,7 @@ be direct 'dependencies' or 'dev_dependencies', following packages are not:
         SolveType.UPGRADE,
         dryRun: true,
         precompile: _precompile,
+        analytics: null, // No analytics for dry-run
       );
     } else {
       await _updatePubspec(changes);
@@ -243,6 +247,7 @@ be direct 'dependencies' or 'dev_dependencies', following packages are not:
       await Entrypoint(directory, cache).acquireDependencies(
         SolveType.UPGRADE,
         precompile: _precompile,
+        analytics: analytics,
       );
     }
 
@@ -326,6 +331,7 @@ be direct 'dependencies' or 'dev_dependencies', following packages are not:
         SolveType.UPGRADE,
         dryRun: true,
         precompile: _precompile,
+        analytics: null,
       );
     } else {
       await _updatePubspec(changes);
@@ -336,6 +342,7 @@ be direct 'dependencies' or 'dev_dependencies', following packages are not:
       await Entrypoint(directory, cache).acquireDependencies(
         SolveType.UPGRADE,
         precompile: _precompile,
+        analytics: analytics,
       );
     }
 

lib/src/entrypoint.dart

@@ -28,6 +28,7 @@ import 'package_config.dart' show PackageConfig;
 import 'package_graph.dart';
 import 'package_name.dart';
 import 'packages_file.dart' as packages_file;
+import 'pub_embeddable_command.dart';
 import 'pubspec.dart';
 import 'sdk.dart';
 import 'solver.dart';
@@ -247,6 +248,7 @@ class Entrypoint {
     Iterable<String> unlock,
     bool dryRun = false,
     bool precompile = false,
+    @required PubAnalytics analytics,
     bool onlyReportSuccessOrFailure = false,
   }) async {
     final suffix = root.dir == null || root.dir == '.' ? '' : ' in ${root.dir}';
@@ -307,6 +309,10 @@ class Entrypoint {
     }
 
     if (!dryRun) {
+      if (analytics != null) {
+        result.sendAnalytics(analytics);
+      }
+
       /// Build a package graph from the version solver results so we don't
       /// have to reload and reparse all the pubspecs.
       _packageGraph = PackageGraph.fromSolveResult(this, result);

lib/src/executable.dart

@@ -19,6 +19,7 @@ import 'io.dart';
 import 'isolate.dart' as isolate;
 import 'log.dart' as log;
 import 'log.dart';
+import 'pub_embeddable_command.dart';
 import 'solver/type.dart';
 import 'system_cache.dart';
 import 'utils.dart';
@@ -236,7 +237,9 @@ Future<int> _runDartProgram(
 ///  [CommandResolutionFailedException].
 ///
 /// * Otherwise if the current package resolution is outdated do an implicit
-/// `pub get`, if that fails, throw a [CommandResolutionFailedException].
+///   `pub get`, if that fails, throw a [CommandResolutionFailedException].
+///
+///   This pub get will send analytics events to [analytics] if provided.
 ///
 /// * Otherwise let  `<current>` be the name of the package at [root], and
 ///   interpret [descriptor] as `[<package>][:<command>]`.
@@ -269,6 +272,7 @@ Future<String> getExecutableForCommand(
   bool allowSnapshot = true,
   String root,
   String pubCacheDir,
+  PubAnalytics analytics,
 }) async {
   root ??= p.current;
   var asPath = descriptor;
@@ -294,7 +298,11 @@ Future<String> getExecutableForCommand(
       entrypoint.assertUpToDate();
     } on DataException {
       await warningsOnlyUnlessTerminal(
-          () => entrypoint.acquireDependencies(SolveType.GET));
+        () => entrypoint.acquireDependencies(
+          SolveType.GET,
+          analytics: analytics,
+        ),
+      );
     }
 
     String command;

lib/src/global_packages.dart

@@ -21,6 +21,7 @@ import 'lock_file.dart';
 import 'log.dart' as log;
 import 'package.dart';
 import 'package_name.dart';
+import 'pub_embeddable_command.dart';
 import 'pubspec.dart';
 import 'sdk.dart';
 import 'solver.dart';
@@ -144,11 +145,11 @@ class GlobalPackages {
   /// existing binstubs in other packages will be overwritten by this one's.
   /// Otherwise, the previous ones will be preserved.
   Future<void> activatePath(String path, List<String> executables,
-      {bool overwriteBinStubs}) async {
+      {bool overwriteBinStubs, @required PubAnalytics analytics}) async {
     var entrypoint = Entrypoint(path, cache);
 
     // Get the package's dependencies.
-    await entrypoint.acquireDependencies(SolveType.GET);
+    await entrypoint.acquireDependencies(SolveType.GET, analytics: analytics);
     var name = entrypoint.root.name;
 
     try {

lib/src/pub_embeddable_command.dart

@@ -3,7 +3,10 @@
 // BSD-style license that can be found in the LICENSE file.
 
 // @dart=2.10
+import 'package:meta/meta.dart';
+import 'package:usage/usage.dart';
 
+import 'command.dart' show PubCommand, PubTopLevel;
 import 'command.dart';
 import 'command/add.dart';
 import 'command/build.dart';
@@ -24,6 +27,16 @@ import 'command/uploader.dart';
 import 'log.dart' as log;
 import 'log.dart';
 
+/// The information needed for the embedded pub command to send analytics.
+@sealed
+class PubAnalytics {
+  /// Name of the custom dimension of the dependency kind.
+  final String dependencyKindCustomDimensionName;
+  final Analytics analytics;
+  PubAnalytics(this.analytics,
+      {@required this.dependencyKindCustomDimensionName});
+}
+
 /// Exposes the `pub` commands as a command to be embedded in another command
 /// runner such as `dart pub`.
 class PubEmbeddableCommand extends PubCommand implements PubTopLevel {
@@ -34,10 +47,13 @@ class PubEmbeddableCommand extends PubCommand implements PubTopLevel {
   @override
   String get docUrl => 'https://dart.dev/tools/pub/cmd/pub-global';
 
+  @override
+  final PubAnalytics analytics;
+
   @override
   String get directory => argResults['directory'];
 
-  PubEmbeddableCommand() : super() {
+  PubEmbeddableCommand(this.analytics) : super() {
     argParser.addFlag('trace',
         help: 'Print debugging information when an error occurs.');
     argParser.addFlag('verbose',