feat: 417700911290c4167a2272b9c3d40edf81fb11ce

Author: serverpod_cloud

ground_control_client/lib/src/protocol/client.dart

@@ -650,6 +650,17 @@ class EndpointPlans extends _i1.EndpointRef {
         {},
       );
 
+  /// Checks if a plan is available for procurement.
+  ///
+  /// - Throws [NotFoundException] if the product is not found.
+  /// - Throws [ProcurementDeniedException] if the product is not available.
+  _i2.Future<void> checkPlanAvailability({required String planName}) =>
+      caller.callServerEndpoint<void>(
+        'plans',
+        'checkPlanAvailability',
+        {'planName': planName},
+      );
+
   /// Fetches the names of the available subscription plans.
   _i2.Future<List<String>> listPlanNames() =>
       caller.callServerEndpoint<List<String>>(

ground_control_client/lib/src/protocol/protocol.dart

@@ -59,7 +59,7 @@ import 'features/secret_manager/models/secret_type.dart' as _i42;
 import 'shared/exceptions/models/duplicate_entry_exception.dart' as _i43;
 import 'shared/exceptions/models/invalid_value_exception.dart' as _i44;
 import 'shared/exceptions/models/not_found_exception.dart' as _i45;
-import 'shared/exceptions/models/resource_denied_exception.dart' as _i46;
+import 'shared/exceptions/models/procurement_denied_exception.dart' as _i46;
 import 'shared/exceptions/models/unauthenticated_exception.dart' as _i47;
 import 'shared/exceptions/models/unauthorized_exception.dart' as _i48;
 import 'shared/models/serverpod_region.dart' as _i49;
@@ -136,7 +136,7 @@ export 'features/secret_manager/models/secret_type.dart';
 export 'shared/exceptions/models/duplicate_entry_exception.dart';
 export 'shared/exceptions/models/invalid_value_exception.dart';
 export 'shared/exceptions/models/not_found_exception.dart';
-export 'shared/exceptions/models/resource_denied_exception.dart';
+export 'shared/exceptions/models/procurement_denied_exception.dart';
 export 'shared/exceptions/models/unauthenticated_exception.dart';
 export 'shared/exceptions/models/unauthorized_exception.dart';
 export 'shared/models/serverpod_region.dart';
@@ -288,8 +288,8 @@ class Protocol extends _i1.SerializationManager {
     if (t == _i45.NotFoundException) {
       return _i45.NotFoundException.fromJson(data) as T;
     }
-    if (t == _i46.ResourceDeniedException) {
-      return _i46.ResourceDeniedException.fromJson(data) as T;
+    if (t == _i46.ProcurementDeniedException) {
+      return _i46.ProcurementDeniedException.fromJson(data) as T;
     }
     if (t == _i47.UnauthenticatedException) {
       return _i47.UnauthenticatedException.fromJson(data) as T;
@@ -453,9 +453,10 @@ class Protocol extends _i1.SerializationManager {
     if (t == _i1.getType<_i45.NotFoundException?>()) {
       return (data != null ? _i45.NotFoundException.fromJson(data) : null) as T;
     }
-    if (t == _i1.getType<_i46.ResourceDeniedException?>()) {
-      return (data != null ? _i46.ResourceDeniedException.fromJson(data) : null)
-          as T;
+    if (t == _i1.getType<_i46.ProcurementDeniedException?>()) {
+      return (data != null
+          ? _i46.ProcurementDeniedException.fromJson(data)
+          : null) as T;
     }
     if (t == _i1.getType<_i47.UnauthenticatedException?>()) {
       return (data != null
@@ -709,8 +710,8 @@ class Protocol extends _i1.SerializationManager {
         return 'InvalidValueException';
       case _i45.NotFoundException():
         return 'NotFoundException';
-      case _i46.ResourceDeniedException():
-        return 'ResourceDeniedException';
+      case _i46.ProcurementDeniedException():
+        return 'ProcurementDeniedException';
       case _i47.UnauthenticatedException():
         return 'UnauthenticatedException';
       case _i48.UnauthorizedException():
@@ -882,8 +883,8 @@ class Protocol extends _i1.SerializationManager {
     if (dataClassName == 'NotFoundException') {
       return deserialize<_i45.NotFoundException>(data['data']);
     }
-    if (dataClassName == 'ResourceDeniedException') {
-      return deserialize<_i46.ResourceDeniedException>(data['data']);
+    if (dataClassName == 'ProcurementDeniedException') {
+      return deserialize<_i46.ProcurementDeniedException>(data['data']);
     }
     if (dataClassName == 'UnauthenticatedException') {
       return deserialize<_i47.UnauthenticatedException>(data['data']);

…ns/models/resource_denied_exception.dart …models/procurement_denied_exception.dartground_control_client/lib/src/protocol/shared/exceptions/models/resource_denied_exception.dart renamed to ground_control_client/lib/src/protocol/shared/exceptions/models/procurement_denied_exception.dart ground_control_client/lib/src/protocol/shared/exceptions/models/resource_denied_exception.dart renamed to ground_control_client/lib/src/protocol/shared/exceptions/models/procurement_denied_exception.dart

@@ -12,29 +12,29 @@
 // ignore_for_file: no_leading_underscores_for_library_prefixes
 import 'package:serverpod_client/serverpod_client.dart' as _i1;
 
-/// Exception thrown when a resource is denied to the user / organization
-/// due to insufficient quota, allowance, or other subscription limit.
+/// Exception thrown when a procurement is denied to the user / organization
+/// due to insufficient allowance or other subscription limits.
 ///
-/// This is distinct from access authorization.
-abstract class ResourceDeniedException
+/// This is distinct from access authorization, and from quota limits.
+abstract class ProcurementDeniedException
     implements _i1.SerializableException, _i1.SerializableModel {
-  ResourceDeniedException._({required this.message});
+  ProcurementDeniedException._({required this.message});
 
-  factory ResourceDeniedException({required String message}) =
-      _ResourceDeniedExceptionImpl;
+  factory ProcurementDeniedException({required String message}) =
+      _ProcurementDeniedExceptionImpl;
 
-  factory ResourceDeniedException.fromJson(
+  factory ProcurementDeniedException.fromJson(
       Map<String, dynamic> jsonSerialization) {
-    return ResourceDeniedException(
+    return ProcurementDeniedException(
         message: jsonSerialization['message'] as String);
   }
 
   String message;
 
-  /// Returns a shallow copy of this [ResourceDeniedException]
+  /// Returns a shallow copy of this [ProcurementDeniedException]
   /// with some or all fields replaced by the given arguments.
   @_i1.useResult
-  ResourceDeniedException copyWith({String? message});
+  ProcurementDeniedException copyWith({String? message});
   @override
   Map<String, dynamic> toJson() {
     return {'message': message};
@@ -46,15 +46,15 @@ abstract class ResourceDeniedException
   }
 }
 
-class _ResourceDeniedExceptionImpl extends ResourceDeniedException {
-  _ResourceDeniedExceptionImpl({required String message})
+class _ProcurementDeniedExceptionImpl extends ProcurementDeniedException {
+  _ProcurementDeniedExceptionImpl({required String message})
       : super._(message: message);
 
-  /// Returns a shallow copy of this [ResourceDeniedException]
+  /// Returns a shallow copy of this [ProcurementDeniedException]
   /// with some or all fields replaced by the given arguments.
   @_i1.useResult
   @override
-  ResourceDeniedException copyWith({String? message}) {
-    return ResourceDeniedException(message: message ?? this.message);
+  ProcurementDeniedException copyWith({String? message}) {
+    return ProcurementDeniedException(message: message ?? this.message);
   }
 }

serverpod_cloud_cli/lib/commands/launch/launch.dart

@@ -27,6 +27,11 @@ abstract class Launch {
     required final bool? enableDb,
     required final bool? performDeploy,
   }) async {
+    await ProjectCommands.checkPlanAvailability(
+      cloudApiClient,
+      logger: logger,
+    );
+
     logger.init('Launching new Serverpod Cloud project.\n');
 
     final projectSetup = ProjectLaunch(

serverpod_cloud_cli/lib/commands/project/project.dart

@@ -13,6 +13,26 @@ import 'package:serverpod_cloud_cli/util/scloud_config/scloud_config_file.dart';
 import 'package:serverpod_cloud_cli/util/scloudignore.dart';
 
 abstract class ProjectCommands {
+  static const defaultPlanName = 'early-access';
+
+  /// Subcommand to check if the user is subscribed to a plan,
+  /// and if not whether a plan can be procured.
+  /// If [planName] is not provided, the default plan will be assumed.
+  /// Throws an exception if there is no subscription and the plan cannot be
+  /// procured.
+  static Future<void> checkPlanAvailability(
+    final Client cloudApiClient, {
+    required final CommandLogger logger,
+    final String? planName,
+  }) async {
+    final planNames = await cloudApiClient.plans.listProcuredPlanNames();
+    if (planNames.isEmpty) {
+      await cloudApiClient.plans.checkPlanAvailability(
+        planName: planName ?? defaultPlanName,
+      );
+    }
+  }
+
   /// Subcommand to create a new tenant project.
   static Future<void> createProject(
     final Client cloudApiClient, {
@@ -26,16 +46,7 @@ abstract class ProjectCommands {
     // This behavior will be changed in the future.
     final planNames = await cloudApiClient.plans.listProcuredPlanNames();
     if (planNames.isEmpty) {
-      const defaultPlanName = 'early-access';
-      try {
-        await cloudApiClient.plans.procurePlan(planName: defaultPlanName);
-      } on ResourceDeniedException catch (e) {
-        final setupUrl = _getConsoleSetupAccountUrl();
-        throw FailureException(
-            error:
-                "Couldn't procure the plan '$defaultPlanName':\n${e.message}",
-            hint: 'Visit $setupUrl to set up your account.');
-      }
+      await cloudApiClient.plans.procurePlan(planName: defaultPlanName);
       logger.init('Creating Serverpod Cloud project "$projectId".');
       logger.info('On plan: $defaultPlanName');
     } else {
@@ -383,14 +394,4 @@ abstract class ProjectCommands {
     gitIgnoreFile.writeAsStringSync('$content$scloudIgnoreTemplate');
     return true;
   }
-
-  static String _getConsoleSetupAccountUrl() {
-    const prodConsoleHost = 'https://console.serverpod.cloud';
-    const setupLandingPath = '/projects/create';
-
-    final hostFromEnv =
-        Platform.environment['SERVERPOD_CLOUD_CONSOLE_SERVER_URL'];
-    final consoleHost = hostFromEnv ?? prodConsoleHost;
-    return '$consoleHost$setupLandingPath';
-  }
 }

serverpod_cloud_cli/lib/shared/helpers/common_exceptions_handler.dart

@@ -1,6 +1,7 @@
 import 'package:serverpod_cloud_cli/command_logger/command_logger.dart';
 import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 import 'package:ground_control_client/ground_control_client.dart';
+import 'package:serverpod_cloud_cli/shared/helpers/console_urls.dart';
 
 /// If the exception is a common client exception, process it by displaying
 /// relevant messages to the user and throwing an [ErrorExitException].
@@ -42,17 +43,24 @@ void processCommonClientExceptions(
         stackTrace,
       );
 
-    case ResourceDeniedException():
-      logger.error(
-        'The resource was not allowed.',
-        hint: e.message,
-      );
-
-      throw ErrorExitException(
-        'The action was not allowed.',
-        e,
-        stackTrace,
-      );
+    case ProcurementDeniedException():
+      final baseUrl = getConsoleBaseUrl();
+      if (e.message.contains('no valid payment method')) {
+        final setupUrl = '$baseUrl/projects/create';
+        logger.error(
+          "You need a payment method!",
+          hint: 'To set up your account, visit: $setupUrl\n',
+          newParagraph: true,
+        );
+      } else {
+        final projectsUrl = '$baseUrl/projects';
+        logger.error(
+          e.message,
+          hint: 'To see your account, visit: $projectsUrl\n',
+          newParagraph: true,
+        );
+      }
+      throw ErrorExitException('The procurement was not allowed.');
 
     case NotFoundException():
       logger.error(

serverpod_cloud_cli/lib/shared/helpers/console_urls.dart

@@ -0,0 +1,9 @@
+import 'dart:io' show Platform;
+
+String getConsoleBaseUrl() {
+  const prodConsoleHost = 'https://console.serverpod.cloud';
+
+  final hostFromEnv =
+      Platform.environment['SERVERPOD_CLOUD_CONSOLE_SERVER_URL'];
+  return hostFromEnv ?? prodConsoleHost;
+}

serverpod_cloud_cli/test/common_exceptions_handler_test.dart

@@ -62,13 +62,13 @@ void main() {
   });
 
   test(
-      'Given a ResourceDeniedException '
+      'Given a ProcurementDeniedException '
       'when calling processCommonClientExceptions '
       'then should throw ExitErrorException and log error message', () {
     expect(
       () => processCommonClientExceptions(
           logger,
-          ResourceDeniedException(
+          ProcurementDeniedException(
             message:
                 'The maximum number of projects that can be created has been reached (5).',
           ),
@@ -79,9 +79,11 @@ void main() {
     expect(
       logger.errorCalls.last,
       equalsErrorCall(
-        message: 'The resource was not allowed.',
-        hint:
+        message:
             'The maximum number of projects that can be created has been reached (5).',
+        hint:
+            'To see your account, visit: https://console.serverpod.cloud/projects\n',
+        newParagraph: true,
       ),
     );
   });

serverpod_cloud_cli/test_integration/commands/launch_command_test.dart

@@ -162,6 +162,10 @@ void main() {
 
       when(() => client.plans.procurePlan(planName: any(named: 'planName')))
           .thenAnswer((final invocation) async => Future.value());
+
+      when(() => client.plans
+              .checkPlanAvailability(planName: any(named: 'planName')))
+          .thenAnswer((final invocation) async => Future.value());
     });
 
     tearDownAll(() async {