feat(scloud): 6a9207869896eb2c3a88c9f6512b4afab7ac4a6d

Author: serverpod_cloud

serverpod_cloud_cli/lib/command_runner/cloud_cli_command.dart

@@ -6,6 +6,7 @@ import 'package:config/config.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/commands/auth/auth_login.dart';
+import 'package:serverpod_cloud_cli/commands/billing/billing_commands.dart';
 import 'package:serverpod_cloud_cli/shared/exceptions/cloud_cli_usage_exception.dart';
 import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 import 'package:serverpod_cloud_cli/shared/helpers/common_exceptions_handler.dart'
@@ -22,6 +23,10 @@ abstract class CloudCliCommand<O extends OptionDefinition>
   /// The default is true, subclasses can override to false.
   final bool requireLogin = true;
 
+  /// Whether to warn the user if their account is not in good standing.
+  /// The default is true, subclasses can override to false.
+  final bool warnIfBillingOverdue = true;
+
   CloudCliCommand({required this.logger, super.options = const []})
     : super(wrapTextColumn: logger.wrapTextColumn);
 
@@ -70,6 +75,15 @@ See the full documentation at: https://docs.serverpod.cloud/references/cli/comma
       );
     }
 
+    if (isAuthenticated &&
+        warnIfBillingOverdue &&
+        globalConfiguration.warnBillingOverdue) {
+      await BillingCommands.warnIfOverdue(
+        logger: logger,
+        billing: runner.serviceProvider.cloudApiClient.billing,
+      );
+    }
+
     await _runCommand();
   }
 

serverpod_cloud_cli/lib/command_runner/cloud_cli_command_runner.dart

@@ -483,6 +483,15 @@ enum GlobalOption<V> implements OptionDefinition<V> {
       hide: true,
     ),
   ),
+  warnBillingOverdue(
+    FlagOption(
+      argName: 'warn-billing-overdue',
+      helpText: 'Enable / disable warning if the account has overdue payments.',
+      defaultsTo: true,
+      negatable: true,
+      hide: true,
+    ),
+  ),
   consoleServer(
     StringOption(
       argName: 'console-url',
@@ -546,5 +555,7 @@ class GlobalConfiguration extends Configuration<GlobalOption> {
 
   bool get skipConfirmation => value(GlobalOption.skipConfirmation);
 
+  bool get warnBillingOverdue => value(GlobalOption.warnBillingOverdue);
+
   String? get authToken => optionalValue(GlobalOption.authToken);
 }

serverpod_cloud_cli/lib/command_runner/commands/auth_command.dart

@@ -3,8 +3,8 @@ import 'package:ground_control_client/ground_control_client.dart' show Client;
 import 'package:serverpod_cloud_cli/command_runner/cloud_cli_command.dart';
 import 'package:serverpod_cloud_cli/command_runner/helpers/command_options.dart';
 import 'package:serverpod_cloud_cli/commands/auth/auth_login.dart';
-import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 import 'package:serverpod_cloud_cli/persistent_storage/resource_manager.dart';
+import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 
 import '../../commands/auth/auth.dart';
 import 'categories.dart';
@@ -75,6 +75,9 @@ class CloudLoginCommand extends CloudCliCommand<LoginCommandOption> {
   @override
   bool get requireLogin => false;
 
+  @override
+  bool get warnIfBillingOverdue => false;
+
   @override
   final name = 'login';
 

serverpod_cloud_cli/lib/command_runner/commands/version_command.dart

@@ -7,6 +7,9 @@ class VersionCommand extends CloudCliCommand {
   @override
   bool get requireLogin => false;
 
+  @override
+  bool get warnIfBillingOverdue => false;
+
   @override
   final name = 'version';
 

serverpod_cloud_cli/lib/commands/billing/billing_commands.dart

@@ -0,0 +1,45 @@
+import 'package:ground_control_client/ground_control_client.dart';
+import 'package:serverpod_cloud_cli/command_logger/command_logger.dart';
+
+abstract class BillingCommands {
+  /// Checks if the owner is in good standing and warns if not.
+  static Future<void> warnIfOverdue({
+    required final CommandLogger logger,
+    required final EndpointBilling billing,
+  }) async {
+    final bool isInGoodStanding;
+    try {
+      isInGoodStanding = await billing.ownerIsInGoodStanding();
+    } catch (e) {
+      logger.debug('Failed to call [ownerIsInGoodStanding]: $e');
+      return;
+    }
+
+    if (isInGoodStanding) return;
+
+    Uri? billingPortalUrl;
+    try {
+      final Owner owner = await billing.readOwner();
+      billingPortalUrl = owner.billingPortalUrl;
+    } catch (e) {
+      logger.debug('Failed to call [readOwner]: $e');
+    }
+
+    _printOverdueWarning(logger: logger, billingPortalUrl: billingPortalUrl);
+  }
+
+  static void _printOverdueWarning({
+    required final CommandLogger logger,
+    final Uri? billingPortalUrl,
+  }) {
+    var message =
+        'Payment Overdue\n'
+        'Update your payment method to avoid service interruption.';
+
+    if (billingPortalUrl != null) {
+      message = '$message\n\nManage billing: $billingPortalUrl';
+    }
+
+    logger.box(message, level: LogLevel.warning);
+  }
+}

serverpod_cloud_cli/test_integration/commands/custom_domain_command/custom_domain_command_test.dart

@@ -2,13 +2,13 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 
+import 'package:ground_control_client/ground_control_client.dart';
 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/commands/custom_domain_command.dart';
-import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.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';
+import 'package:serverpod_cloud_cli/shared/exceptions/exit_exceptions.dart';
 import 'package:test/test.dart';
 
 import '../../../test_utils/command_logger_matchers.dart';
@@ -80,6 +80,7 @@ void main() {
           projectId,
           '--api-url',
           localServerAddress.toString(),
+          '--no-warn-billing-overdue',
           '--config-dir',
           testCacheFolderPath,
         ]);
@@ -116,6 +117,7 @@ void main() {
           projectId,
           '--api-url',
           localServerAddress.toString(),
+          '--no-warn-billing-overdue',
           '--config-dir',
           testCacheFolderPath,
         ]);
@@ -154,6 +156,7 @@ void main() {
           projectId,
           '--api-url',
           localServerAddress.toString(),
+          '--no-warn-billing-overdue',
           '--config-dir',
           testCacheFolderPath,
         ]);
@@ -191,6 +194,7 @@ void main() {
           projectId,
           '--api-url',
           localServerAddress.toString(),
+          '--no-warn-billing-overdue',
           '--config-dir',
           testCacheFolderPath,
         ]);