refactor(gc): 196831e53f5c2f88e6c26ba3695464067dd4ebaf

Author: serverpod_cloud

ground_control_client/lib/src/protocol/client.dart

@@ -74,25 +74,25 @@ class EndpointAdminProcurement extends _i1.EndpointRef {
   @override
   String get name => 'adminProcurement';
 
-  /// Procures a product for a user.
-  /// If [productVersion] is not provided, the latest version is used.
+  /// Procures a plan for a user.
+  /// If [planProductVersion] is not provided, the latest version is used.
   /// If [overrideChecks] is true, the product availability checks are overridden.
   ///
   /// Throws a [NotFoundException] if the user or product is not found.
   /// Throws a [InvalidValueException] if the user has no owner (not fully registered).
-  _i2.Future<void> procureProduct({
+  _i2.Future<void> procurePlan({
     required String userEmail,
-    required String productName,
-    int? productVersion,
+    required String planProductName,
+    int? planProductVersion,
     bool? overrideChecks,
   }) =>
       caller.callServerEndpoint<void>(
         'adminProcurement',
-        'procureProduct',
+        'procurePlan',
         {
           'userEmail': userEmail,
-          'productName': productName,
-          'productVersion': productVersion,
+          'planProductName': planProductName,
+          'planProductVersion': planProductVersion,
           'overrideChecks': overrideChecks,
         },
       );

serverpod_cloud_cli/lib/command_runner/commands/admin/admin_product_commands.dart

@@ -13,7 +13,7 @@ class AdminProductCommand extends CloudCliCommand {
 
   AdminProductCommand({required super.logger}) {
     addSubcommand(AdminListProcuredCommand(logger: logger));
-    addSubcommand(AdminProcureCommand(logger: logger));
+    addSubcommand(AdminProcurePlanCommand(logger: logger));
   }
 }
 
@@ -53,7 +53,7 @@ class AdminListProcuredCommand
   }
 }
 
-enum AdminProcureOption<V> implements OptionDefinition<V> {
+enum AdminProcurePlanOption<V> implements OptionDefinition<V> {
   user(
     UserEmailOption(argPos: 0, mandatory: true),
   ),
@@ -62,7 +62,7 @@ enum AdminProcureOption<V> implements OptionDefinition<V> {
       argName: 'name',
       argAbbrev: 'n',
       argPos: 1,
-      helpText: 'The name of the product to procure.'
+      helpText: 'The name of the plan to procure.'
           ' Can be passed as the second argument.',
       mandatory: true,
     ),
@@ -72,7 +72,7 @@ enum AdminProcureOption<V> implements OptionDefinition<V> {
       argName: 'version',
       argAbbrev: 'v',
       argPos: 2,
-      helpText: 'The product version (latest if unspecified).'
+      helpText: 'The plan version (latest if unspecified).'
           ' Can be passed as the third argument.',
       min: 0,
     ),
@@ -86,39 +86,40 @@ enum AdminProcureOption<V> implements OptionDefinition<V> {
     ),
   );
 
-  const AdminProcureOption(this.option);
+  const AdminProcurePlanOption(this.option);
 
   @override
   final ConfigOptionBase<V> option;
 }
 
-class AdminProcureCommand extends CloudCliCommand<AdminProcureOption> {
+class AdminProcurePlanCommand extends CloudCliCommand<AdminProcurePlanOption> {
   @override
-  final name = 'procure';
+  final name = 'procure-plan';
 
   @override
-  final description = 'Procure a product for an owner.\n'
-      'By specifying the override flag, the product is procured '
+  final description = 'Procure a plan for a user.\n'
+      'By specifying the override flag, the plan is procured '
       'even if locked or the owner lacks allowance.';
 
-  AdminProcureCommand({required super.logger})
-      : super(options: AdminProcureOption.values);
+  AdminProcurePlanCommand({required super.logger})
+      : super(options: AdminProcurePlanOption.values);
 
   @override
   Future<void> runWithConfig(
-    final Configuration<AdminProcureOption> commandConfig,
+    final Configuration<AdminProcurePlanOption> commandConfig,
   ) async {
-    final userEmail = commandConfig.value(AdminProcureOption.user);
-    final productName = commandConfig.value(AdminProcureOption.productName);
-    final ver = commandConfig.optionalValue(AdminProcureOption.productVersion);
-    final override = commandConfig.value(AdminProcureOption.overrideChecks);
+    final userEmail = commandConfig.value(AdminProcurePlanOption.user);
+    final productName = commandConfig.value(AdminProcurePlanOption.productName);
+    final ver =
+        commandConfig.optionalValue(AdminProcurePlanOption.productVersion);
+    final override = commandConfig.value(AdminProcurePlanOption.overrideChecks);
 
-    await ProductAdminCommands.procureProduct(
+    await ProductAdminCommands.procurePlan(
       runner.serviceProvider.cloudApiClient,
       logger: logger,
       userEmail: userEmail,
-      productName: productName,
-      productVersion: ver,
+      planName: productName,
+      planVersion: ver,
       overrideChecks: override,
     );
   }

serverpod_cloud_cli/lib/commands/admin/product_admin.dart

@@ -26,23 +26,23 @@ abstract class ProductAdminCommands {
     table.writeLines(logger.line);
   }
 
-  static Future<void> procureProduct(
+  static Future<void> procurePlan(
     final Client cloudApiClient, {
     required final CommandLogger logger,
     required final String userEmail,
-    required final String productName,
-    final int? productVersion,
+    required final String planName,
+    final int? planVersion,
     final bool? overrideChecks,
   }) async {
-    await cloudApiClient.adminProcurement.procureProduct(
+    await cloudApiClient.adminProcurement.procurePlan(
       userEmail: userEmail,
-      productName: productName,
-      productVersion: productVersion,
+      planProductName: planName,
+      planProductVersion: planVersion,
       overrideChecks: overrideChecks,
     );
 
     logger.success(
-      'The product has been procured for the user.',
+      'The plan $planName has been procured for the user.',
       newParagraph: true,
     );
   }

serverpod_cloud_cli/test_integration/commands/admin/admin_product_procure_cmd_test.dart

@@ -31,7 +31,7 @@ void main() {
   test(
       'Given admin product procure command when instantiated then requires login',
       () {
-    expect(AdminProcureCommand(logger: logger).requireLogin, isTrue);
+    expect(AdminProcurePlanCommand(logger: logger).requireLogin, isTrue);
   });
 
   group('Given authenticated', () {
@@ -42,10 +42,10 @@ void main() {
     group('when executing admin product procure', () {
       late Future commandResult;
       setUp(() async {
-        when(() => client.adminProcurement.procureProduct(
+        when(() => client.adminProcurement.procurePlan(
               userEmail: any(named: 'userEmail'),
-              productName: any(named: 'productName'),
-              productVersion: any(named: 'productVersion'),
+              planProductName: any(named: 'planProductName'),
+              planProductVersion: any(named: 'planProductVersion'),
               overrideChecks: any(named: 'overrideChecks'),
             )).thenAnswer(
           (final invocation) async => Future.value(),
@@ -54,7 +54,7 @@ void main() {
         commandResult = cli.run([
           'admin',
           'product',
-          'procure',
+          'procure-plan',
           'test@example.com',
           'test-plan',
         ]);
@@ -70,7 +70,7 @@ void main() {
         expect(
           logger.successCalls.first,
           equalsSuccessCall(
-            message: 'The product has been procured for the user.',
+            message: 'The plan test-plan has been procured for the user.',
             newParagraph: true,
           ),
         );