feat(scloud): 10cc2babefeb2b766af70f64256fde2ac2a5d666

Author: serverpod_cloud

serverpod_cloud_cli/lib/command_runner/cloud_cli_command_runner.dart

@@ -293,7 +293,7 @@ To update to the latest version, run "dart pub global activate serverpod_cloud_c
 }
 
 Directory _getDefaultStorageDir() {
-  return ResourceManager.localStorageDirectory;
+  return ResourceManager.localCloudStorageDirectory;
 }
 
 /// The global configuration options for the Serverpod Cloud CLI.

serverpod_cloud_cli/lib/command_runner/commands/auth_command.dart

@@ -3,7 +3,7 @@ import 'dart:async';
 import 'package:config/config.dart';
 import 'package:serverpod_cloud_cli/command_runner/cloud_cli_command.dart';
 import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
-import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_auth_data.dart';
 import 'package:serverpod_cloud_cli/persistent_storage/resource_manager.dart';
 import 'package:serverpod_cloud_cli/util/browser_launcher.dart';
 import 'package:serverpod_cloud_cli/util/listener_server.dart';
@@ -92,7 +92,8 @@ class CloudLoginCommand extends CloudCliCommand<LoginCommandOption> {
     final localStoragePath = globalConfiguration.scloudDir;
     final serverAddress = globalConfiguration.consoleServer;
 
-    final storedCloudData = await ResourceManager.tryFetchServerpodCloudData(
+    final storedCloudData =
+        await ResourceManager.tryFetchServerpodCloudAuthData(
       localStoragePath: localStoragePath.path,
       logger: logger,
     );
@@ -153,8 +154,8 @@ class CloudLoginCommand extends CloudCliCommand<LoginCommandOption> {
     }
 
     if (persistent) {
-      await ResourceManager.storeServerpodCloudData(
-        cloudData: ServerpodCloudData(token),
+      await ResourceManager.storeServerpodCloudAuthData(
+        authData: ServerpodCloudAuthData(token),
         localStoragePath: localStoragePath.path,
       );
     }
@@ -180,7 +181,7 @@ class CloudLogoutCommand extends CloudCliCommand {
   Future<void> runWithConfig(final Configuration commandConfig) async {
     final localStoragePath = globalConfiguration.scloudDir;
 
-    final cloudData = await ResourceManager.tryFetchServerpodCloudData(
+    final cloudData = await ResourceManager.tryFetchServerpodCloudAuthData(
       localStoragePath: localStoragePath.path,
       logger: logger,
     );
@@ -201,7 +202,7 @@ class CloudLogoutCommand extends CloudCliCommand {
     }
 
     try {
-      await ResourceManager.removeServerpodCloudData(
+      await ResourceManager.removeServerpodCloudAuthData(
         localStoragePath: localStoragePath.path,
       );
     } on Exception catch (e) {

serverpod_cloud_cli/lib/command_runner/helpers/cloud_cli_service_provider.dart

@@ -1,6 +1,6 @@
 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_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_auth_data.dart';
 import 'package:serverpod_cloud_cli/util/cli_authentication_key_manager.dart';
 import 'package:ground_control_client/ground_control_client.dart';
 
@@ -58,7 +58,7 @@ class CloudCliServiceProvider {
 
       final authTokenOverride = _globalConfiguration.authToken;
       final cloudDataOverride = authTokenOverride != null
-          ? ServerpodCloudData(authTokenOverride)
+          ? ServerpodCloudAuthData(authTokenOverride)
           : null;
 
       cloudApiClient = Client(

serverpod_cloud_cli/lib/persistent_storage/models/serverpod_cloud_auth_data.dart

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

serverpod_cloud_cli/lib/persistent_storage/models/serverpod_cloud_data.dart

@@ -3,18 +3,23 @@ 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_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_auth_data.dart';
 
 abstract class ResourceManager {
-  static Directory get localStorageDirectory => Directory(
-      p.join(LocalStorageManager.homeDirectory.path, '.serverpod_cloud'));
+  /// The directory where Serverpod tools store local data.
+  static Directory get _localStorageDirectory =>
+      Directory(p.join(LocalStorageManager.homeDirectory.path, '.serverpod'));
 
-  static Future<void> removeServerpodCloudData({
+  /// The directory where Serverpod Cloud CLI stores its local data.
+  static Directory get localCloudStorageDirectory =>
+      Directory(p.join(_localStorageDirectory.path, 'cloud'));
+
+  static Future<void> removeServerpodCloudAuthData({
     required final String localStoragePath,
   }) async {
     try {
       await LocalStorageManager.removeFile(
-        fileName: ResourceManagerConstants.serverpodCloudDataFilePath,
+        fileName: ResourceManagerConstants.serverpodCloudAuthFilePath,
         localStoragePath: localStoragePath,
       );
     } on DeleteException catch (e) {
@@ -24,14 +29,14 @@ abstract class ResourceManager {
     }
   }
 
-  static Future<void> storeServerpodCloudData({
-    required final ServerpodCloudData cloudData,
+  static Future<void> storeServerpodCloudAuthData({
+    required final ServerpodCloudAuthData authData,
     required final String localStoragePath,
   }) async {
     try {
       await LocalStorageManager.storeJsonFile(
-        fileName: ResourceManagerConstants.serverpodCloudDataFilePath,
-        json: cloudData.toJson(),
+        fileName: ResourceManagerConstants.serverpodCloudAuthFilePath,
+        json: authData.toJson(),
         localStoragePath: localStoragePath,
       );
     } on CreateException catch (e) {
@@ -49,34 +54,78 @@ abstract class ResourceManager {
     }
   }
 
-  static Future<ServerpodCloudData?> tryFetchServerpodCloudData({
+  static Future<ServerpodCloudAuthData?> tryFetchServerpodCloudAuthData({
     required final String localStoragePath,
     required final CommandLogger logger,
   }) async {
     try {
-      return await LocalStorageManager.tryFetchAndDeserializeJsonFile(
-        fileName: ResourceManagerConstants.serverpodCloudDataFilePath,
+      final authData = await LocalStorageManager.tryFetchAndDeserializeJsonFile(
+        fileName: ResourceManagerConstants.serverpodCloudAuthFilePath,
         localStoragePath: localStoragePath,
-        fromJson: ServerpodCloudData.fromJson,
+        fromJson: ServerpodCloudAuthData.fromJson,
       );
+      if (authData != null) {
+        return authData;
+      }
     } on ReadException catch (_) {
       logger.error(
-          'Could not read file at location ${ResourceManagerConstants.serverpodCloudDataFilePath}.',
+          'Could not read file ${ResourceManagerConstants.serverpodCloudAuthFilePath}.',
           hint:
               'Please check that the Serverpod Cloud CLI has the correct permissions to '
               'read the file. If the problem persists, try deleting the file.');
       return null;
     } on DeserializationException catch (_) {
       return null;
     }
+
+    // Transparently migrate old local auth data to new file path.
+    // TODO: Remove this code when users have had time to run scloud which
+    // automatically executes this.
+    return await _tryMigrateAuthData(localStoragePath: localStoragePath);
+  }
+
+  static Future<ServerpodCloudAuthData?> _tryMigrateAuthData({
+    required final String localStoragePath,
+  }) async {
+    const oldServerpodCloudStorageDir = '.serverpod_cloud';
+    const oldServerpodCloudDataFilePath = 'serverpod_cloud_data.yaml';
+
+    final oldAuthDirPath = p.join(
+      LocalStorageManager.homeDirectory.path,
+      oldServerpodCloudStorageDir,
+    );
+
+    // try to read the auth data from the old location
+    final authData = await LocalStorageManager.tryFetchAndDeserializeJsonFile(
+      localStoragePath: oldAuthDirPath,
+      fileName: oldServerpodCloudDataFilePath,
+      fromJson: ServerpodCloudAuthData.fromJson,
+    );
+    if (authData == null) {
+      return null;
+    }
+
+    // store the auth data to the new location
+    await storeServerpodCloudAuthData(
+      authData: authData,
+      localStoragePath: localStoragePath,
+    );
+
+    // remove the old file
+    await LocalStorageManager.removeFile(
+      localStoragePath: oldAuthDirPath,
+      fileName: oldServerpodCloudDataFilePath,
+    );
+
+    return authData;
   }
 
   static Future<void> storeLatestCliVersion({
     required final CommandLogger logger,
     required final PackageVersionData cliVersionData,
     String? localStoragePath,
   }) async {
-    localStoragePath ??= localStorageDirectory.path;
+    localStoragePath ??= localCloudStorageDirectory.path;
 
     try {
       await LocalStorageManager.storeJsonFile(
@@ -96,7 +145,7 @@ abstract class ResourceManager {
     String? localStoragePath,
     required final CommandLogger logger,
   }) async {
-    localStoragePath ??= localStorageDirectory.path;
+    localStoragePath ??= localCloudStorageDirectory.path;
 
     void deleteFile(final File file) {
       try {
@@ -126,6 +175,6 @@ abstract class ResourceManager {
 }
 
 abstract class ResourceManagerConstants {
-  static const serverpodCloudDataFilePath = 'serverpod_cloud_data.yaml';
+  static const serverpodCloudAuthFilePath = 'serverpod_cloud_auth.json';
   static const latestVersionFilePath = 'latest_cli_version.json';
 }

serverpod_cloud_cli/lib/persistent_storage/resource_manager.dart

@@ -1,5 +1,5 @@
 import 'package:serverpod_cloud_cli/command_logger/command_logger.dart';
-import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_auth_data.dart';
 import 'package:serverpod_cloud_cli/persistent_storage/resource_manager.dart';
 import 'package:ground_control_client/ground_control_client.dart';
 
@@ -10,12 +10,12 @@ extension IsAuthenticated on AuthenticationKeyManager {
 class CliAuthenticationKeyManager extends AuthenticationKeyManager {
   final CommandLogger _logger;
   final String _localStoragePath;
-  ServerpodCloudData? _cloudData;
+  ServerpodCloudAuthData? _cloudData;
 
   CliAuthenticationKeyManager({
     required final CommandLogger logger,
     required final String localStoragePath,
-    final ServerpodCloudData? cloudDataOverride,
+    final ServerpodCloudAuthData? cloudDataOverride,
   })  : _localStoragePath = localStoragePath,
         _logger = logger,
         _cloudData = cloudDataOverride;
@@ -27,7 +27,7 @@ class CliAuthenticationKeyManager extends AuthenticationKeyManager {
       return cloudData.token;
     }
 
-    _cloudData = await ResourceManager.tryFetchServerpodCloudData(
+    _cloudData = await ResourceManager.tryFetchServerpodCloudAuthData(
       localStoragePath: _localStoragePath,
       logger: _logger,
     );
@@ -38,16 +38,16 @@ class CliAuthenticationKeyManager extends AuthenticationKeyManager {
   @override
   Future<void> put(final String key) async {
     _cloudData = null;
-    return ResourceManager.storeServerpodCloudData(
-      cloudData: ServerpodCloudData(key),
+    return ResourceManager.storeServerpodCloudAuthData(
+      authData: ServerpodCloudAuthData(key),
       localStoragePath: _localStoragePath,
     );
   }
 
   @override
   Future<void> remove() async {
     _cloudData = null;
-    return ResourceManager.removeServerpodCloudData(
+    return ResourceManager.removeServerpodCloudAuthData(
       localStoragePath: _localStoragePath,
     );
   }

serverpod_cloud_cli/lib/util/cli_authentication_key_manager.dart

@@ -3,7 +3,7 @@ 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_data.dart';
+import 'package:serverpod_cloud_cli/persistent_storage/models/serverpod_cloud_auth_data.dart';
 import 'package:serverpod_cloud_cli/persistent_storage/resource_manager.dart';
 import 'package:serverpod_cloud_cli/util/cli_authentication_key_manager.dart';
 import 'package:test/test.dart';
@@ -26,9 +26,9 @@ void main() {
     late String testKey;
     setUp(() async {
       testKey = 'my-key-${const Uuid().v4()}';
-      final cloudData = ServerpodCloudData(testKey);
-      await ResourceManager.storeServerpodCloudData(
-        cloudData: cloudData,
+      final cloudData = ServerpodCloudAuthData(testKey);
+      await ResourceManager.storeServerpodCloudAuthData(
+        authData: cloudData,
         localStoragePath: testCacheFolderPath,
       );
     });
@@ -60,7 +60,7 @@ void main() {
       });
 
       test('then new key is stored on disk.', () async {
-        final cloudData = await ResourceManager.tryFetchServerpodCloudData(
+        final cloudData = await ResourceManager.tryFetchServerpodCloudAuthData(
           localStoragePath: testCacheFolderPath,
           logger: logger,
         );
@@ -85,7 +85,7 @@ void main() {
       });
 
       test('then key is removed from disk.', () async {
-        final cloudData = await ResourceManager.tryFetchServerpodCloudData(
+        final cloudData = await ResourceManager.tryFetchServerpodCloudAuthData(
           localStoragePath: testCacheFolderPath,
           logger: logger,
         );
@@ -119,7 +119,7 @@ void main() {
     });
 
     test('then the key is stored on disk.', () async {
-      final cloudData = await ResourceManager.tryFetchServerpodCloudData(
+      final cloudData = await ResourceManager.tryFetchServerpodCloudAuthData(
         localStoragePath: testCacheFolderPath,
         logger: logger,
       );
@@ -148,7 +148,7 @@ void main() {
     late CliAuthenticationKeyManager keyManager;
     setUp(() async {
       testKey = 'my-key-${const Uuid().v4()}';
-      final cloudData = ServerpodCloudData(testKey);
+      final cloudData = ServerpodCloudAuthData(testKey);
       keyManager = CliAuthenticationKeyManager(
         logger: logger,
         localStoragePath: testCacheFolderPath,
@@ -164,7 +164,7 @@ void main() {
     test('when getting the authentication key then no key is stored on disk.',
         () async {
       await keyManager.get();
-      final cloudData = await ResourceManager.tryFetchServerpodCloudData(
+      final cloudData = await ResourceManager.tryFetchServerpodCloudAuthData(
         localStoragePath: testCacheFolderPath,
         logger: logger,
       );
@@ -178,7 +178,7 @@ void main() {
       final newKey = 'new-key-${const Uuid().v4()}';
       await keyManager.put(newKey);
 
-      final cloudData = await ResourceManager.tryFetchServerpodCloudData(
+      final cloudData = await ResourceManager.tryFetchServerpodCloudAuthData(
         localStoragePath: testCacheFolderPath,
         logger: logger,
       );