feat(scloud): 89a724c481c0911609d3c165651ce8921c52c779

Author: serverpod_cloud

serverpod_cloud_cli/lib/command_runner/commands/launch_command.dart

@@ -19,6 +19,7 @@ enum LaunchOption<V> implements OptionDefinition<V> {
       group: _projectGroup,
     ),
   ),
+  plan(PlanOption()),
   enableDb(
     FlagOption(
       argName: 'enable-db',
@@ -69,6 +70,7 @@ class CloudLaunchCommand extends CloudCliCommand<LaunchOption> {
       LaunchOption.projectId,
     );
     final newProjectId = commandConfig.optionalValue(LaunchOption.newProjectId);
+    final plan = commandConfig.optionalValue(LaunchOption.plan);
     final enableDb = commandConfig.optionalValue(LaunchOption.enableDb);
     final deploy = commandConfig.optionalValue(LaunchOption.deploy);
     final dartVersionOverride = commandConfig.optionalValue(
@@ -83,6 +85,7 @@ class CloudLaunchCommand extends CloudCliCommand<LaunchOption> {
       foundProjectDir: foundProjectDir,
       newProjectId: newProjectId,
       existingProjectId: existingProjectId,
+      plan: plan,
       enableDb: enableDb,
       performDeploy: deploy,
       dartVersionOverride: dartVersionOverride,

serverpod_cloud_cli/lib/command_runner/commands/project_command.dart

@@ -33,16 +33,7 @@ class CloudProjectCommand extends CloudCliCommand {
 
 enum ProjectCreateOption<V> implements OptionDefinition<V> {
   projectId(ProjectIdOption.argsOnly(asFirstArg: true)),
-  profile(
-    EnumOption<ProjectProfile>(
-      argName: 'profile',
-      helpText: 'Project profile (starter or growth).',
-      enumParser: EnumParser(ProjectProfile.values),
-      defaultsTo: ProjectProfile.defaultProfile,
-      mandatory: false,
-      hide: true,
-    ),
-  ),
+  plan(PlanOption()),
   enableDb(
     FlagOption(
       argName: 'enable-db',
@@ -71,7 +62,7 @@ class CloudProjectCreateCommand extends CloudCliCommand<ProjectCreateOption> {
   @override
   Future<void> runWithConfig(final Configuration commandConfig) async {
     final projectId = commandConfig.value(ProjectCreateOption.projectId);
-    final projectProfile = commandConfig.value(ProjectCreateOption.profile);
+    final plan = commandConfig.optionalValue(ProjectCreateOption.plan);
     final enableDb = commandConfig.value(ProjectCreateOption.enableDb);
     final projectDir =
         runner.selectProjectDirectory() ?? Directory.current.path;
@@ -85,7 +76,7 @@ class CloudProjectCreateCommand extends CloudCliCommand<ProjectCreateOption> {
       runner.serviceProvider.cloudApiClient,
       logger: logger,
       projectId: projectId,
-      projectProfile: projectProfile,
+      plan: plan,
       enableDb: enableDb,
       projectDir: projectDir,
       configFilePath: configFilePath,

serverpod_cloud_cli/lib/command_runner/helpers/command_options.dart

@@ -1,4 +1,6 @@
 import 'package:config/config.dart';
+import 'package:serverpod_cloud_cli/commands/project/project.dart'
+    show PlanProfile;
 import 'package:serverpod_cloud_cli/util/scloud_config/scloud_config.dart';
 
 import 'email_validator.dart';
@@ -58,6 +60,17 @@ class ProjectIdOption extends StringOption {
       );
 }
 
+class PlanOption extends EnumOption<PlanProfile> {
+  const PlanOption({final PlanProfile? defaultValue})
+    : super(
+        argName: 'plan',
+        helpText: 'Selects the plan to use.',
+        enumParser: const EnumParser(PlanProfile.values),
+        defaultsTo: defaultValue,
+        hide: true,
+      );
+}
+
 class NameOption extends StringOption {
   const NameOption({required String super.helpText, required int super.argPos})
     : super(argName: 'name', mandatory: true);

serverpod_cloud_cli/lib/commands/launch/launch.dart

@@ -31,12 +31,11 @@ abstract class Launch {
     required final String? foundProjectDir,
     required final String? newProjectId,
     required final String? existingProjectId,
+    required final PlanProfile? plan,
     required final bool? enableDb,
     required final bool? performDeploy,
     final String? dartVersionOverride,
   }) async {
-    await ProjectCommands.checkPlanAvailability(cloudApiClient, logger: logger);
-
     if (newProjectId != null && existingProjectId != null) {
       throw ArgumentError(
         'Cannot specify both newProjectId and existingProjectId.',
@@ -48,6 +47,7 @@ abstract class Launch {
     final projectSetup = ProjectLaunch(
       projectDir: specifiedProjectDir,
       projectId: newProjectId ?? existingProjectId,
+      plan: plan,
       enableDb: enableDb,
       preexistingProject: existingProjectId != null,
       performDeploy: performDeploy,
@@ -58,6 +58,8 @@ abstract class Launch {
     await selectProjectId(cloudApiClient, logger, projectSetup);
 
     if (projectSetup.preexistingProject != true) {
+      await selectPlan(cloudApiClient, logger, projectSetup);
+
       await selectEnableDb(logger, projectSetup);
     }
 
@@ -328,6 +330,63 @@ The default API domain will be: <project-id>.api.serverpod.space
     return null;
   }
 
+  static Future<void> selectPlan(
+    final Client cloudApiClient,
+    final CommandLogger logger,
+    final ProjectLaunch projectSetup,
+  ) async {
+    final validPlanNames = PlanProfile.values
+        .map((final p) => p.name)
+        .join(', ');
+
+    var planProfile = projectSetup.plan;
+
+    do {
+      if (planProfile != null) {
+        if (await _isAvailablePlan(cloudApiClient, logger, planProfile)) {
+          projectSetup.plan = planProfile;
+          return;
+        }
+      }
+
+      final projectPlanName = await logger.input('Enter the plan');
+
+      if (projectPlanName.isEmpty) {
+        logger.error('Plan is required. Must be one of: $validPlanNames');
+        continue;
+      }
+
+      planProfile = PlanProfile.values
+          .where((final p) => p.name == projectPlanName)
+          .firstOrNull;
+      if (planProfile == null) {
+        logger.error('Invalid plan. Must be one of: $validPlanNames');
+        continue;
+      }
+    } while (true);
+  }
+
+  static Future<bool> _isAvailablePlan(
+    final Client cloudApiClient,
+    final CommandLogger logger,
+    final PlanProfile planProfile,
+  ) async {
+    try {
+      await ProjectCommands.checkPlanAvailability(
+        cloudApiClient,
+        logger: logger,
+        plan: planProfile,
+      );
+      return true;
+    } on NotFoundException catch (e) {
+      logger.error('No plan found for ${planProfile.name}: ${e.message}');
+      return false;
+    } on ProcurementDeniedException catch (e) {
+      logger.error(e.message);
+      return false;
+    }
+  }
+
   static Future<void> selectEnableDb(
     final CommandLogger logger,
     final ProjectLaunch projectSetup,
@@ -458,6 +517,7 @@ The default API domain will be: <project-id>.api.serverpod.space
     final projectDir = projectSetup.projectDir;
     final configFilePath = projectSetup.configFilePath;
     final performDeploy = projectSetup.performDeploy;
+    final planProfile = projectSetup.plan;
 
     if (projectId == null) {
       throw StateError('ProjectId must be set.');
@@ -476,12 +536,16 @@ The default API domain will be: <project-id>.api.serverpod.space
     }
 
     if (projectSetup.preexistingProject != true) {
+      if (planProfile == null) {
+        throw StateError('PlanProfile must be set.');
+      }
+
       final enableDb = projectSetup.enableDb!;
       await ProjectCommands.createProject(
         cloudApiClient,
         logger: logger,
         projectId: projectId,
-        projectProfile: ProjectProfile.defaultProfile,
+        plan: planProfile,
         enableDb: enableDb,
         projectDir: projectDir,
         configFilePath: configFilePath,
@@ -600,6 +664,7 @@ class ProjectLaunch {
   String? _projectDir;
   String? configFilePath;
   String? projectId;
+  PlanProfile? plan;
   bool? enableDb;
   bool? preexistingProject;
   bool? performDeploy;
@@ -608,6 +673,7 @@ class ProjectLaunch {
   ProjectLaunch({
     final String? projectDir,
     this.projectId,
+    this.plan,
     this.enableDb,
     this.preexistingProject,
     this.performDeploy,
@@ -637,6 +703,7 @@ class ProjectLaunch {
         ['Project directory', projectDir],
         if (preexistingProject != true) ...[
           ['New project id', projectId],
+          ['Project plan', plan?.name ?? ''],
           ['Enable DB', enableDb == true ? 'yes' : 'no'],
         ] else
           ['Existing project id', projectId],

serverpod_cloud_cli/lib/commands/project/project.dart

@@ -11,49 +11,57 @@ import 'package:serverpod_cloud_cli/util/dart_version_util.dart';
 import 'package:serverpod_cloud_cli/util/pubspec_validator.dart'
     show resolveProjectDartSdkVersion;
 
-enum ProjectProfile {
+enum PlanProfile {
   starter('starter', 'starter', 'starter-project'),
-  growth('growth', 'growth', 'growth-project'),
-  defaultProfile(null, null, null);
+  growth('growth', 'growth', 'growth-project');
 
-  const ProjectProfile(
-    this.name,
-    this.planProductName,
-    this.projectProductName,
-  );
+  const PlanProfile(this.name, this.planProductName, this.projectProductName);
 
-  final String? name;
-  final String? planProductName;
-  final String? projectProductName;
+  final String name;
+  final String planProductName;
+  final String projectProductName;
 }
 
 abstract class ProjectCommands {
-  static const defaultPlanName = 'early-access';
+  static const defaultPlan = 'starter';
 
-  /// Subcommand to check if the user is subscribed to a plan,
-  /// and if not whether a plan can be procured.
-  /// If [planProductName] is not provided, the default plan will be assumed.
-  /// Throws an exception if there is no subscription and the plan cannot be
-  /// procured.
+  static const _legacyPlanNames = [
+    'early-access',
+    'closed-beta',
+    'internal-test-runs',
+    'internal-payment-testing',
+  ];
+
+  /// Subcommand to check if the user is subscribed to a given plan,
+  /// and if not whether the plan can be procured.
+  ///
+  /// Throws [ProcurementDeniedException] if there is no subscription and the
+  /// plan cannot be procured.
   static Future<void> checkPlanAvailability(
     final Client cloudApiClient, {
     required final CommandLogger logger,
-    final String? planProductName,
+    required final PlanProfile? plan,
   }) async {
     final planNames = await cloudApiClient.plans.listProcuredPlanNames();
-    if (planNames.isEmpty) {
-      await cloudApiClient.plans.checkPlanAvailability(
-        planProductName: planProductName ?? defaultPlanName,
-      );
+
+    if (plan == null &&
+        planNames.any((final name) => _legacyPlanNames.contains(name))) {
+      return;
     }
+
+    final planProductName = plan?.name ?? defaultPlan;
+
+    await cloudApiClient.plans.checkPlanAvailability(
+      planProductName: planProductName,
+    );
   }
 
   /// Subcommand to create a new tenant project.
   static Future<void> createProject(
     final Client cloudApiClient, {
     required final CommandLogger logger,
     required final String projectId,
-    required final ProjectProfile projectProfile,
+    required final PlanProfile? plan,
     required final bool enableDb,
     required final String projectDir,
     required final String configFilePath,
@@ -63,33 +71,32 @@ abstract class ProjectCommands {
       await UserConfirmations.confirmNewProjectCostAcceptance(logger);
     }
 
-    final String subscriptionId;
-    if (projectProfile.planProductName == null) {
-      // Check that the user is on a plan and automatically procure one if not.
-      // This behavior will be changed in the future.
+    String? subscriptionId;
+    if (plan == null) {
+      // If no plan is specified and user has a legacy plan, use that.
       final subscriptions = await cloudApiClient.plans.listSubscriptions();
-      if (subscriptions.isEmpty) {
-        subscriptionId = await cloudApiClient.plans.procurePlan(
-          planProductName: defaultPlanName,
-        );
-        logger.init('Creating Serverpod Cloud project "$projectId".');
-        logger.info('On plan: $defaultPlanName');
-      } else {
-        final subscription = subscriptions
-            .where((final s) => s.planName == defaultPlanName)
+      if (subscriptions.isNotEmpty) {
+        final legacySubscription = subscriptions
+            .where(
+              (final s) =>
+                  _legacyPlanNames.contains(s.planProductId.split(':').first),
+            )
             .firstOrNull;
-        if (subscription == null) {
-          throw FailureException(error: 'User does not have the default plan.');
+        if (legacySubscription != null) {
+          logger.init('Creating Serverpod Cloud project "$projectId".');
+          logger.info('On plan: ${legacySubscription.planDisplayName}');
+          subscriptionId = legacySubscription.subscriptionId;
         }
-        logger.init('Creating Serverpod Cloud project "$projectId".');
-        logger.debug('On plan: ${subscription.planName}');
-        subscriptionId = subscription.subscriptionId;
       }
-    } else {
+    }
+
+    if (subscriptionId == null) {
+      final planProductName = plan?.name ?? defaultPlan;
       subscriptionId = await cloudApiClient.plans.procurePlan(
-        planProductName: projectProfile.planProductName,
+        planProductName: planProductName,
       );
       logger.init('Creating Serverpod Cloud project "$projectId".');
+      logger.info('On plan: $planProductName');
     }
 
     try {
@@ -99,7 +106,7 @@ abstract class ProjectCommands {
         () async {
           await cloudApiClient.projects.createProject(
             cloudProjectId: projectId,
-            projectProductName: projectProfile.projectProductName,
+            projectProductName: plan?.projectProductName,
             underSubscriptionId: subscriptionId,
           );
           return true;