feat(scloud): 4561c92293dc121d182fcc56800fd77bdfc99a5d

Author: serverpod_cloud

serverpod_cloud_cli/bin/serverpod_cloud_cli.dart

@@ -1,10 +1,12 @@
 import 'dart:async';
 import 'dart:io';
 
+import 'package:cli_tools/analytics.dart';
 import 'package:cli_tools/better_command_runner.dart' show ExitException;
 import 'package:config/config.dart';
 import 'package:serverpod_cloud_cli/command_logger/command_logger.dart';
 import 'package:serverpod_cloud_cli/command_runner/cloud_cli_command_runner.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/resource_manager.dart';
 import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 import 'package:serverpod_cloud_cli/util/scloud_version.dart';
 
@@ -46,6 +48,7 @@ Future<void> _main(final List<String> args, final CommandLogger logger) async {
   final runner = CloudCliCommandRunner.create(
     logger: logger,
     version: cliVersion,
+    onAnalyticsEvent: _reportMixPanelEvent,
   );
   try {
     await runner.run(args);
@@ -73,3 +76,15 @@ https://github.com/serverpod/serverpod/issues
 ${zonedError ? 'Zoned error' : ''}
 ${error.runtimeType} $error''';
 }
+
+void _reportMixPanelEvent(final String event) {
+  _analytics.track(event: event);
+}
+
+const _mixPanelToken = 'd0aaf1b76185d37938f3767bdb685760';
+final Analytics _analytics = MixPanelAnalytics(
+  uniqueUserId: ResourceManager.uniqueUserId,
+  projectToken: _mixPanelToken,
+  version: cliVersion.canonicalizedVersion,
+  endpoint: 'https://api-eu.mixpanel.com/track',
+);

serverpod_cloud_cli/lib/command_runner/cloud_cli_command_runner.dart

@@ -24,20 +24,22 @@ import 'package:serverpod_cloud_cli/command_runner/helpers/cloud_cli_service_pro
 import 'package:serverpod_cloud_cli/command_runner/helpers/cli_version_checker.dart';
 import 'package:serverpod_cloud_cli/constants.dart';
 import 'package:serverpod_cloud_cli/persistent_storage/resource_manager.dart';
+import 'package:serverpod_cloud_cli/util/activation_checker.dart';
 import 'package:serverpod_cloud_cli/util/common.dart';
 import 'package:serverpod_cloud_cli/util/pubspec_validator.dart';
 import 'package:serverpod_cloud_cli/util/scloud_config/scloud_config.dart';
 import 'package:serverpod_cloud_cli/util/scloud_version.dart';
 
 import 'commands/admin/admin_command.dart';
+import 'commands/settings_command.dart';
 import 'completion/completion_script_carapace.dart';
 import 'completion/completion_script_completely.dart';
 
 /// Represents the Serverpod Cloud CLI main command, its global options, and subcommands.
 class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
   final Version version;
   final CommandLogger logger;
-  final CloudCliServiceProvider serviceProvider;
+  final CloudCliServiceProvider _serviceProvider;
 
   final VersionCommand _versionCommand;
 
@@ -64,12 +66,26 @@ class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
     logger.configuration = _globalConfiguration;
   }
 
+  /// Gets the initialized service provider for the Serverpod Cloud CLI.
+  /// Must not be called before the [run] method has been invoked.
+  CloudCliServiceProvider get serviceProvider {
+    if (!_serviceProvider.initialized) {
+      _serviceProvider.initialize(
+        globalConfiguration: globalConfiguration,
+        logger: logger,
+      );
+    }
+    return _serviceProvider;
+  }
+
   CloudCliCommandRunner._({
     required this.logger,
     required this.version,
-    required this.serviceProvider,
+    required final CloudCliServiceProvider serviceProvider,
+    super.onAnalyticsEvent,
     super.setLogLevel,
-  })  : _versionCommand = VersionCommand(logger: logger),
+  })  : _serviceProvider = serviceProvider,
+        _versionCommand = VersionCommand(logger: logger),
         super(
           'scloud',
           'Manage your Serverpod Cloud projects',
@@ -89,12 +105,14 @@ class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
     required final CommandLogger logger,
     final Version? version,
     final CloudCliServiceProvider? serviceProvider,
+    final OnAnalyticsEvent? onAnalyticsEvent,
     bool? adminUserMode,
   }) {
     final runner = CloudCliCommandRunner._(
       logger: logger,
       version: version ?? cliVersion,
       serviceProvider: serviceProvider ?? CloudCliServiceProvider(),
+      onAnalyticsEvent: onAnalyticsEvent,
       setLogLevel: ({
         final String? commandName,
         required final CommandRunnerLogLevel parsedLogLevel,
@@ -126,6 +144,7 @@ class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
       CloudDbCommand(logger: logger),
       CloudLaunchCommand(logger: logger),
       CloudUserCommand(logger: logger),
+      CliUserSettingsCommand(logger: logger),
       if (adminUserMode) CloudAdminCommand(logger: logger, hidden: false),
     ]);
 
@@ -134,11 +153,6 @@ class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
 
   @override
   Future<void> runCommand(final ArgResults topLevelResults) async {
-    serviceProvider.initialize(
-      globalConfiguration: globalConfiguration,
-      logger: logger,
-    );
-
     if (globalConfiguration.version) {
       await _versionCommand.run();
     }
@@ -179,6 +193,52 @@ class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
     }
   }
 
+  @override
+  Future<bool> determineAnalyticsSettings() async {
+    if (onAnalyticsEvent == null) {
+      return false;
+    }
+
+    final analyticsOptionValue = globalConfiguration.analytics;
+    if (analyticsOptionValue != null) {
+      // explicitly set via option for this run
+      return analyticsOptionValue;
+    }
+
+    if (!_isTenantUser()) {
+      return false;
+    }
+
+    final analyticsEnabled = await _getAnalyticsSetting();
+    return analyticsEnabled;
+  }
+
+  Future<bool> _getAnalyticsSetting() async {
+    final settings = serviceProvider.scloudSettings;
+    final analyticsEnabled = await settings.enableAnalytics;
+    if (analyticsEnabled != null) {
+      return analyticsEnabled;
+    }
+
+    final confirm = await logger.confirm(
+      'Do you agree to sending anonymous command usage analytics to Serverpod?',
+      defaultValue: true,
+    );
+    await settings.setEnableAnalytics(confirm);
+    return confirm;
+  }
+
+  /// Returns true if the user likely is a production tenant user.
+  bool _isTenantUser() {
+    if (!isActivatedFromPub()) {
+      return false;
+    }
+    if (globalConfiguration.apiServer != HostConstants.serverpodCloudApi) {
+      return false;
+    }
+    return true;
+  }
+
   @override
   String? get usageFooter =>
       '\nSee the full documentation at: https://docs.serverpod.cloud/';
@@ -300,7 +360,14 @@ Directory _getDefaultStorageDir() {
 enum GlobalOption<V> implements OptionDefinition<V> {
   quiet(BetterCommandRunnerFlags.quietOption),
   verbose(BetterCommandRunnerFlags.verboseOption),
-  analytics(BetterCommandRunnerFlags.analyticsOption),
+
+  analytics(FlagOption(
+    argName: BetterCommandRunnerFlags.analytics,
+    argAbbrev: BetterCommandRunnerFlags.analyticsAbbr,
+    envName: 'SERVERPOD_CLOUD_COMMAND_ANALYTICS',
+    negatable: true,
+    helpText: 'Toggles if analytics data is sent.',
+  )),
 
   version(
     FlagOption(
@@ -427,6 +494,8 @@ class GlobalConfiguration extends Configuration<GlobalOption> {
 
   bool get version => value(GlobalOption.version);
 
+  bool? get analytics => optionalValue(GlobalOption.analytics);
+
   Directory get scloudDir => value(GlobalOption.scloudDir);
 
   Directory? get projectDir => optionalValue(GlobalOption.projectDir);

serverpod_cloud_cli/lib/command_runner/commands/settings_command.dart

@@ -0,0 +1,51 @@
+import 'package:config/config.dart';
+import 'package:serverpod_cloud_cli/command_runner/cloud_cli_command.dart';
+
+enum CliUserSettingsOption<V> implements OptionDefinition<V> {
+  analytics(FlagOption(
+    argName: 'analytics',
+    negatable: true,
+    helpText: 'Toggles if analytics data is sent.',
+  ));
+
+  const CliUserSettingsOption(this.option);
+
+  @override
+  final ConfigOptionBase<V> option;
+}
+
+class CliUserSettingsCommand extends CloudCliCommand<CliUserSettingsOption> {
+  @override
+  final name = 'settings';
+
+  @override
+  final description = 'Manage local CLI user settings.';
+
+  CliUserSettingsCommand({required super.logger})
+      : super(options: CliUserSettingsOption.values);
+
+  @override
+  Future<void> runWithConfig(
+    final Configuration<CliUserSettingsOption> commandConfig,
+  ) async {
+    var settingSpecified = false;
+
+    if (commandConfig.optionalValue(CliUserSettingsOption.analytics)
+        case final bool analytics) {
+      final settings = runner.serviceProvider.scloudSettings;
+      await settings.setEnableAnalytics(analytics);
+      settingSpecified = true;
+      logger.info('Analytics set to "$analytics".');
+    }
+
+    if (!settingSpecified) {
+      // show current settings
+      final settings = runner.serviceProvider.scloudSettings;
+      final analytics = await settings.enableAnalytics;
+      logger.list(
+        title: 'Local settings',
+        ['Analytics = ${analytics ?? 'not set'}'],
+      );
+    }
+  }
+}

serverpod_cloud_cli/lib/command_runner/completion/completion_script_carapace.dart

@@ -1,16 +1,16 @@
 /// This file is auto-generated.
 library;
 
-import 'package:cli_tools/better_command_runner.dart' show CompletionTarget;
+import 'package:cli_tools/better_command_runner.dart' show CompletionTool;
 
 const String _completionScript = r'''
 # yaml-language-server: $schema=https://carapace.sh/schemas/command.json
 name: scloud
 persistentFlags:
   -q, --quiet: "Suppress all cli output. Is overridden by  -v, --verbose."
   -v, --verbose: "Prints additional information useful for development. Overrides --q, --quiet."
-  -a, --analytics: "Toggles if analytics data is sent. "
-  --no-analytics: "Toggles if analytics data is sent. "
+  -a, --analytics: "Toggles if analytics data is sent."
+  --no-analytics: "Toggles if analytics data is sent."
   --version: "Prints the version of the Serverpod Cloud CLI."
   --scloud-dir=: "Override the directory path where Serverpod Cloud cache/authentication files are stored."
   -d, --project-dir=: "The path to the Serverpod Cloud project server directory."
@@ -31,22 +31,22 @@ commands:
     commands:
       - name: generate
         flags:
-          -t, --target=!: "The target tool format"
+          -t, --tool=!: "The completion tool to target"
           -e, --exec-name=: "Override the name of the executable"
           -f, --file=: "Write the specification to a file instead of stdout"
         completion:
           flag:
-            target: ["completely", "carapace"]
+            tool: ["completely", "carapace"]
             file: ["$files"]
 
       - name: install
         flags:
-          -t, --target=!: "The target tool format"
+          -t, --tool=!: "The completion tool to target"
           -e, --exec-name=: "Override the name of the executable"
           -d, --write-dir=: "Override the directory to write the script to"
         completion:
           flag:
-            target: ["completely", "carapace"]
+            tool: ["completely", "carapace"]
             write-dir: ["$directories"]
 
   - name: version
@@ -262,11 +262,18 @@ commands:
         flags:
           -p, --project=!: "The ID of the project.\nCan be omitted for existing projects that are linked. See `scloud project link --help`."
 
+  - name: settings
+    flags:
+      --analytics: "Toggles if analytics data is sent."
+      --no-analytics: "Toggles if analytics data is sent."
+    exclusiveFlags:
+      - [analytics, no-analytics]
+
 
 ''';
 
 /// Embedded script for command line completion for `carapace`.
 const completionScriptCarapace = (
-  target: CompletionTarget.carapace,
+  tool: CompletionTool.carapace,
   script: _completionScript,
 );