feat(scloud): 683ab67eebdabda71d3ae6add51c7553181e8fcc

Author: serverpod_cloud

serverpod_cloud_cli/bin/serverpod_cloud_cli.dart

@@ -48,7 +48,8 @@ Future<void> _main(final List<String> args, final CommandLogger logger) async {
   final runner = CloudCliCommandRunner.create(
     logger: logger,
     version: cliVersion,
-    onAnalyticsEvent: _reportAnalyticsEvent,
+    onAnalyticsEvent: (final event, final properties) =>
+        _reportAnalyticsEvent(event, properties, logger),
   );
   try {
     await runner.run(args);
@@ -80,9 +81,14 @@ ${error.runtimeType} $error''';
 void _reportAnalyticsEvent(
   final String event,
   final Map<String, dynamic> properties,
+  final CommandLogger logger,
 ) {
-  _postHogAnalytics.track(event: event, properties: properties);
-  _analytics.track(event: event, properties: properties);
+  try {
+    _postHogAnalytics.track(event: event, properties: properties);
+    _analytics.track(event: event, properties: properties);
+  } catch (e, stackTrace) {
+    logger.debug('Analytics event failed: $e\n$stackTrace');
+  }
 }
 
 const _postHogApiKey = 'phc_xGBPHgcrTrDuWGtyNX3UJODXgnR684rzRPZjWRlqVxf';

serverpod_cloud_cli/lib/command_runner/cloud_cli_command.dart

@@ -70,6 +70,7 @@ See the full documentation at: https://docs.serverpod.cloud/references/cli/comma
       await AuthLoginCommands.login(
         logger: logger,
         globalConfig: globalConfiguration,
+        cloudApiClient: client,
         persistent: true,
         openBrowser: globalConfiguration.browser,
       );

serverpod_cloud_cli/lib/command_runner/cloud_cli_command_runner.dart

@@ -210,6 +210,21 @@ class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
     }
   }
 
+  @override
+  void sendAnalyticsEvent(
+    final String event, [
+    final Map<String, dynamic> properties = const {},
+  ]) {
+    final enrichedProperties = Map<String, dynamic>.from(properties);
+    final cloudUser = ResourceManager.tryFetchServerpodCloudUserDataSync(
+      localStoragePath: globalConfiguration.scloudDir.path,
+    );
+    if (cloudUser != null) {
+      enrichedProperties['cloud_user_id'] = cloudUser.id;
+    }
+    super.sendAnalyticsEvent(event, enrichedProperties);
+  }
+
   @override
   Future<bool> determineAnalyticsSettings() async {
     if (onAnalyticsEvent == null) {
@@ -238,7 +253,7 @@ class CloudCliCommandRunner extends BetterCommandRunner<GlobalOption, void> {
     }
 
     final confirm = await logger.confirm(
-      'Do you agree to sending anonymous command usage analytics to Serverpod?',
+      'Do you agree to sending command usage analytics to Serverpod?',
       defaultValue: true,
     );
     await settings.setEnableAnalytics(confirm);

serverpod_cloud_cli/lib/command_runner/commands/auth_command.dart

@@ -113,6 +113,7 @@ class CloudLoginCommand extends CloudCliCommand<LoginCommandOption> {
     await AuthLoginCommands.login(
       logger: logger,
       globalConfig: globalConfiguration,
+      cloudApiClient: runner.serviceProvider.cloudApiClient,
       timeLimit: timeLimit,
       persistent: persistent,
       openBrowser: openBrowser,

serverpod_cloud_cli/lib/commands/auth/auth_login.dart

@@ -1,8 +1,10 @@
 import 'dart:async';
 
+import 'package:ground_control_client/ground_control_client.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/models/serverpod_cloud_auth_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_user_data.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/browser_launcher.dart';
@@ -12,6 +14,7 @@ abstract class AuthLoginCommands {
   static Future<void> login({
     required final CommandLogger logger,
     required final GlobalConfiguration globalConfig,
+    required final Client cloudApiClient,
     final Duration timeLimit = const Duration(seconds: 300),
     required final bool persistent,
     required final bool openBrowser,
@@ -67,8 +70,30 @@ abstract class AuthLoginCommands {
         authData: ServerpodCloudAuthData(token),
         localStoragePath: localStoragePath.path,
       );
+      await fetchAndStoreServerpodCloudUserData(
+        cloudApiClient: cloudApiClient,
+        localStoragePath: localStoragePath.path,
+        logger: logger,
+      );
     }
 
     logger.success('Successfully logged in to Serverpod cloud.');
   }
+
+  static Future<void> fetchAndStoreServerpodCloudUserData({
+    required final Client cloudApiClient,
+    required final String localStoragePath,
+    required final CommandLogger logger,
+  }) async {
+    try {
+      final user = await cloudApiClient.users.readUser();
+      final cloudUserId = user.id.toString();
+      await ResourceManager.storeServerpodCloudUserData(
+        cloudUserData: ServerpodCloudUserData(cloudUserId),
+        localStoragePath: localStoragePath,
+      );
+    } on Exception catch (e) {
+      logger.debug('Failed to fetch user data: $e');
+    }
+  }
 }

serverpod_cloud_cli/lib/persistent_storage/local_data_storage_exception.dart

@@ -0,0 +1,11 @@
+/// Exception thrown when a local data storage operation fails.
+class LocalDataStorageException implements Exception {
+  final String message;
+  final Object? error;
+
+  LocalDataStorageException(this.message, [this.error]);
+
+  @override
+  String toString() =>
+      'LocalDataStorageException: $message${error != null ? '\nError: $error' : ''}';
+}

serverpod_cloud_cli/lib/persistent_storage/models/scloud_settings_data.dart

@@ -7,10 +7,12 @@ class ServerpodCloudSettingsData {
   ServerpodCloudSettingsData._(this.enableAnalytics);
 
   factory ServerpodCloudSettingsData.fromJson(final Map<String, dynamic> json) {
-    return ServerpodCloudSettingsData._(json['enable_analytics'] as bool?);
+    return ServerpodCloudSettingsData._(
+      json['command_usage_analytics'] as bool?,
+    );
   }
 
-  Map<String, dynamic> toJson() => {'enable_analytics': enableAnalytics};
+  Map<String, dynamic> toJson() => {'command_usage_analytics': enableAnalytics};
 
   @override
   String toString() => 'ScloudSettings(enableAnalytics: $enableAnalytics)';

serverpod_cloud_cli/lib/persistent_storage/models/serverpod_cloud_user_data.dart

@@ -0,0 +1,11 @@
+class ServerpodCloudUserData {
+  late final String id;
+
+  ServerpodCloudUserData(this.id);
+
+  factory ServerpodCloudUserData.fromJson(final Map<String, dynamic> json) {
+    return ServerpodCloudUserData(json['id'] as String);
+  }
+
+  Map<String, dynamic> toJson() => {'id': id};
+}

serverpod_cloud_cli/lib/persistent_storage/resource_manager.dart

@@ -1,12 +1,15 @@
+import 'dart:convert';
 import 'dart:io';
 
 import 'package:cli_tools/cli_tools.dart';
 import 'package:path/path.dart' as p;
 import 'package:serverpod_cloud_cli/command_logger/command_logger.dart';
 import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_auth_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_user_data.dart';
 import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 import 'package:uuid/uuid.dart';
 
+import 'local_data_storage_exception.dart';
 import 'models/scloud_settings_data.dart';
 
 abstract class ResourceManager {
@@ -43,6 +46,9 @@ abstract class ResourceManager {
     return userId;
   }
 
+  /// Removes Serverpod Cloud authentication and user data from local storage.
+  ///
+  /// Throws [LocalDataStorageException] if the file cannot be deleted.
   static Future<void> removeServerpodCloudAuthData({
     required final String localStoragePath,
   }) async {
@@ -51,13 +57,73 @@ abstract class ResourceManager {
         fileName: ResourceManagerConstants.serverpodCloudAuthFilePath,
         localStoragePath: localStoragePath,
       );
+      await LocalStorageManager.removeFile(
+        fileName: ResourceManagerConstants.serverpodCloudUserFilePath,
+        localStoragePath: localStoragePath,
+      );
     } on DeleteException catch (e) {
-      throw Exception(
+      throw LocalDataStorageException(
         'Failed to remove serverpod cloud data. error: ${e.error}',
+        e,
+      );
+    }
+  }
+
+  /// Stores Serverpod Cloud user data to local storage.
+  ///
+  /// Throws [LocalDataStorageException] if the file cannot be created, serialized, or written.
+  static Future<void> storeServerpodCloudUserData({
+    required final ServerpodCloudUserData cloudUserData,
+    required final String localStoragePath,
+  }) async {
+    try {
+      await LocalStorageManager.storeJsonFile(
+        fileName: ResourceManagerConstants.serverpodCloudUserFilePath,
+        json: cloudUserData.toJson(),
+        localStoragePath: localStoragePath,
+      );
+    } on CreateException catch (e) {
+      throw LocalDataStorageException(
+        'Failed to store serverpod cloud user data. error: ${e.error}',
+        e,
+      );
+    } on SerializationException catch (e) {
+      throw LocalDataStorageException(
+        'Failed to store serverpod cloud user data. error: ${e.error}',
+        e,
       );
+    } on WriteException catch (e) {
+      throw LocalDataStorageException(
+        'Failed to store serverpod cloud user data. error: ${e.error}',
+        e,
+      );
+    }
+  }
+
+  static ServerpodCloudUserData? tryFetchServerpodCloudUserDataSync({
+    required final String localStoragePath,
+  }) {
+    try {
+      final file = File(
+        p.join(
+          localStoragePath,
+          ResourceManagerConstants.serverpodCloudUserFilePath,
+        ),
+      );
+      if (!file.existsSync()) {
+        return null;
+      }
+      final json = file.readAsStringSync();
+      final decoded = jsonDecode(json) as Map<String, dynamic>;
+      return ServerpodCloudUserData.fromJson(decoded);
+    } catch (_) {
+      return null;
     }
   }
 
+  /// Stores Serverpod Cloud authentication data to local storage.
+  ///
+  /// Throws [LocalDataStorageException] if the file cannot be created, serialized, or written.
   static Future<void> storeServerpodCloudAuthData({
     required final ServerpodCloudAuthData authData,
     required final String localStoragePath,
@@ -69,16 +135,19 @@ abstract class ResourceManager {
         localStoragePath: localStoragePath,
       );
     } on CreateException catch (e) {
-      throw Exception(
+      throw LocalDataStorageException(
         'Failed to store serverpod cloud data. error: ${e.error}',
+        e,
       );
     } on SerializationException catch (e) {
-      throw Exception(
+      throw LocalDataStorageException(
         'Failed to store serverpod cloud data. error: ${e.error}',
+        e,
       );
     } on WriteException catch (e) {
-      throw Exception(
+      throw LocalDataStorageException(
         'Failed to store serverpod cloud data. error: ${e.error}',
+        e,
       );
     }
   }
@@ -199,6 +268,9 @@ abstract class ResourceManager {
     return null;
   }
 
+  /// Stores Serverpod Cloud settings data to local storage.
+  ///
+  /// Throws [FailureException] if the file cannot be written.
   static Future<void> storeSettings({
     required final ServerpodCloudSettingsData settings,
     required final String localStoragePath,
@@ -214,6 +286,9 @@ abstract class ResourceManager {
     }
   }
 
+  /// Loads Serverpod Cloud settings data from local storage.
+  ///
+  /// Throws [FailureException] if the file cannot be read or deserialized.
   static Future<ServerpodCloudSettingsData?> tryLoadSettings({
     required final String localStoragePath,
   }) async {
@@ -231,6 +306,7 @@ abstract class ResourceManager {
 
 abstract class ResourceManagerConstants {
   static const serverpodCloudAuthFilePath = 'serverpod_cloud_auth.json';
+  static const serverpodCloudUserFilePath = 'serverpod_cloud_user.json';
   static const latestVersionFilePath = 'latest_cli_version.json';
   static const settingsFilePath = 'settings.json';
 }

serverpod_cloud_cli/test_integration/analytics_test.dart

@@ -1,6 +1,8 @@
 import 'package:path/path.dart' as p;
 import 'package:serverpod_cloud_cli/command_runner/cloud_cli_command_runner.dart';
 import 'package:serverpod_cloud_cli/command_runner/helpers/cloud_cli_service_provider.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_user_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/resource_manager.dart';
 import 'package:ground_control_client/ground_control_client_test_tools.dart';
 import 'package:test/test.dart';
 import 'package:test_descriptor/test_descriptor.dart' as d;
@@ -12,12 +14,14 @@ void main() {
   final logger = TestCommandLogger(printToStdout: false);
 
   final List<String> analyticsEvents = [];
+  final List<Map<String, dynamic>> analyticsProperties = [];
 
   final client = ClientMock();
 
   setUp(() async {
     logger.clear();
     analyticsEvents.clear();
+    analyticsProperties.clear();
   });
 
   group('Given default non-prod-env suppression (enabled)', () {
@@ -35,6 +39,7 @@ void main() {
         ),
         onAnalyticsEvent: (final event, final properties) {
           analyticsEvents.add(event);
+          analyticsProperties.add(Map<String, dynamic>.from(properties));
         },
       );
     });
@@ -99,6 +104,7 @@ void main() {
         ),
         onAnalyticsEvent: (final event, final properties) {
           analyticsEvents.add(event);
+          analyticsProperties.add(Map<String, dynamic>.from(properties));
         },
         enableAnalyticsForAllEnvs: true,
       );
@@ -115,7 +121,7 @@ void main() {
           logger.confirmCalls.single,
           equalsConfirmCall(
             message:
-                'Do you agree to sending anonymous command usage analytics to Serverpod?',
+                'Do you agree to sending command usage analytics to Serverpod?',
             defaultValue: true,
           ),
         );
@@ -274,5 +280,29 @@ void main() {
         });
       });
     });
+
+    group('and cloud user data stored', () {
+      const cloudUserId = 'test-cloud-user-uuid';
+
+      setUp(() async {
+        await ResourceManager.storeServerpodCloudUserData(
+          cloudUserData: ServerpodCloudUserData(cloudUserId),
+          localStoragePath: settingsDir,
+        );
+      });
+
+      test('when invoking command with analytics'
+          ' then analytics properties include cloud_user_id', () async {
+        logger.answerNextConfirmWith(true);
+        await cli.run(['--config-dir', settingsDir, 'version']);
+
+        expect(analyticsEvents, equals(['version']));
+        expect(analyticsProperties, hasLength(1));
+        expect(
+          analyticsProperties.single['cloud_user_id'],
+          equals(cloudUserId),
+        );
+      });
+    });
   });
 }