refactor(shorebird_cli): consolidate command precondition checks in S…

…horebirdValidationMixin (#575)
shorebirdtech · Jun 1, 2023 · 3c07866 · 3c07866
1 parent 5b28adf
commit 3c07866
Show file tree

Hide file tree

Showing 24 changed files with 229 additions and 234 deletions.
diff --git a/packages/shorebird_cli/lib/src/auth_logger_mixin.dart b/packages/shorebird_cli/lib/src/auth_logger_mixin.dart
diff --git a/packages/shorebird_cli/lib/src/commands/account/subscribe_account_command.dart b/packages/shorebird_cli/lib/src/commands/account/subscribe_account_command.dart
@@ -1,16 +1,16 @@
 import 'dart:async';
 
 import 'package:mason_logger/mason_logger.dart';
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
+import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 import 'package:shorebird_code_push_client/shorebird_code_push_client.dart';
 
 /// {@template subscribe_account_command}
 /// `shorebird account subscribe`
 /// {@endtemplate}
 class SubscribeAccountCommand extends ShorebirdCommand
-    with AuthLoggerMixin, ShorebirdConfigMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin {
   /// {@macro subscribe_account_command}
   SubscribeAccountCommand({
     required super.logger,
@@ -35,9 +35,12 @@ Visit ${styleUnderlined.wrap(lightCyan.wrap('https://shorebird.dev'))} for more
 
   @override
   Future<int> run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.software.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final client = buildCodePushClient(

diff --git a/packages/shorebird_cli/lib/src/commands/apps/create_apps_command.dart b/packages/shorebird_cli/lib/src/commands/apps/create_apps_command.dart
@@ -1,10 +1,10 @@
 import 'dart:async';
 
 import 'package:mason_logger/mason_logger.dart';
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
 import 'package:shorebird_cli/src/shorebird_create_app_mixin.dart';
+import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 import 'package:shorebird_code_push_client/shorebird_code_push_client.dart';
 
 /// {@template create_app_command}
@@ -13,7 +13,10 @@ import 'package:shorebird_code_push_client/shorebird_code_push_client.dart';
 /// Create a new app on Shorebird.
 /// {@endtemplate}
 class CreateAppCommand extends ShorebirdCommand
-    with AuthLoggerMixin, ShorebirdConfigMixin, ShorebirdCreateAppMixin {
+    with
+        ShorebirdConfigMixin,
+        ShorebirdValidationMixin,
+        ShorebirdCreateAppMixin {
   /// {@macro create_app_command}
   CreateAppCommand({
     required super.logger,
@@ -36,9 +39,12 @@ Defaults to the name in "pubspec.yaml".''',
 
   @override
   Future<int>? run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final appName = results['app-name'] as String?;

diff --git a/packages/shorebird_cli/lib/src/commands/apps/delete_apps_command.dart b/packages/shorebird_cli/lib/src/commands/apps/delete_apps_command.dart
@@ -1,17 +1,17 @@
 import 'dart:async';
 
 import 'package:mason_logger/mason_logger.dart';
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
+import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 
 /// {@template delete_app_command}
 ///
 /// `shorebird apps delete`
 /// Delete an existing app on Shorebird.
 /// {@endtemplate}
 class DeleteAppCommand extends ShorebirdCommand
-    with AuthLoggerMixin, ShorebirdConfigMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin {
   /// {@macro delete_app_command}
   DeleteAppCommand({
     required super.logger,
@@ -34,9 +34,12 @@ Defaults to the app_id in "shorebird.yaml".''',
 
   @override
   Future<int>? run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final appIdArg = results['app-id'] as String?;

diff --git a/packages/shorebird_cli/lib/src/commands/apps/list_apps_command.dart b/packages/shorebird_cli/lib/src/commands/apps/list_apps_command.dart
@@ -2,9 +2,9 @@ import 'dart:async';
 
 import 'package:barbecue/barbecue.dart';
 import 'package:mason_logger/mason_logger.dart';
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
+import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 import 'package:shorebird_code_push_client/shorebird_code_push_client.dart';
 
 /// {@template list_apps_command}
@@ -13,7 +13,7 @@ import 'package:shorebird_code_push_client/shorebird_code_push_client.dart';
 /// List all apps using Shorebird.
 /// {@endtemplate}
 class ListAppsCommand extends ShorebirdCommand
-    with AuthLoggerMixin, ShorebirdConfigMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin {
   /// {@macro list_apps_command}
   ListAppsCommand({
     required super.logger,
@@ -32,9 +32,12 @@ class ListAppsCommand extends ShorebirdCommand
 
   @override
   Future<int>? run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final client = buildCodePushClient(

diff --git a/packages/shorebird_cli/lib/src/commands/build/build_aar_command.dart b/packages/shorebird_cli/lib/src/commands/build/build_aar_command.dart
@@ -3,7 +3,6 @@ import 'dart:io';
 
 import 'package:mason_logger/mason_logger.dart';
 import 'package:path/path.dart' as p;
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_build_mixin.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
@@ -15,14 +14,11 @@ import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 /// Build an Android aar file from your app.
 /// {@endtemplate}
 class BuildAarCommand extends ShorebirdCommand
-    with
-        AuthLoggerMixin,
-        ShorebirdValidationMixin,
-        ShorebirdConfigMixin,
-        ShorebirdBuildMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin, ShorebirdBuildMixin {
   BuildAarCommand({
     required super.logger,
     super.auth,
+    super.validators,
   }) {
     // We would have a "target" option here, similar to what [BuildApkCommand]
     // and [BuildAabCommand] have, but target cannot currently be configured in
@@ -49,17 +45,16 @@ class BuildAarCommand extends ShorebirdCommand
 
   @override
   Future<int> run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
-    }
-
-    final pubspec = getPubspecYaml();
-    if (pubspec == null) {
-      logger.err('No pubspec.yaml file found.');
-      return ExitCode.config.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+        checkShorebirdInitialized: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
+    final pubspec = getPubspecYaml()!;
     final module = pubspec.flutter?['module'] as Map?;
     final androidPackageName = module?['androidPackage'] as String?;
     if (androidPackageName == null) {

diff --git a/packages/shorebird_cli/lib/src/commands/build/build_apk_command.dart b/packages/shorebird_cli/lib/src/commands/build/build_apk_command.dart
@@ -2,7 +2,6 @@ import 'dart:io';
 
 import 'package:mason_logger/mason_logger.dart';
 import 'package:path/path.dart' as p;
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_build_mixin.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
@@ -14,11 +13,7 @@ import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 /// Build an Android APK file from your app.
 /// {@endtemplate}
 class BuildApkCommand extends ShorebirdCommand
-    with
-        AuthLoggerMixin,
-        ShorebirdValidationMixin,
-        ShorebirdConfigMixin,
-        ShorebirdBuildMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin, ShorebirdBuildMixin {
   /// {@macro build_apk_command}
   BuildApkCommand({
     required super.logger,
@@ -45,15 +40,13 @@ class BuildApkCommand extends ShorebirdCommand
 
   @override
   Future<int> run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
-    }
-
-    final validationIssues = await runValidators();
-    if (validationIssuesContainsError(validationIssues)) {
-      logValidationFailure(issues: validationIssues);
-      return ExitCode.config.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+        checkValidators: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final flavor = results['flavor'] as String?;

diff --git a/packages/shorebird_cli/lib/src/commands/build/build_app_bundle_command.dart b/packages/shorebird_cli/lib/src/commands/build/build_app_bundle_command.dart
@@ -2,7 +2,6 @@ import 'dart:io';
 
 import 'package:mason_logger/mason_logger.dart';
 import 'package:path/path.dart' as p;
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_build_mixin.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
@@ -14,11 +13,7 @@ import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 /// Build an Android App Bundle file from your app.
 /// {@endtemplate}
 class BuildAppBundleCommand extends ShorebirdCommand
-    with
-        AuthLoggerMixin,
-        ShorebirdValidationMixin,
-        ShorebirdConfigMixin,
-        ShorebirdBuildMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin, ShorebirdBuildMixin {
   /// {@macro build_app_bundle_command}
   BuildAppBundleCommand({
     required super.logger,
@@ -45,15 +40,13 @@ class BuildAppBundleCommand extends ShorebirdCommand
 
   @override
   Future<int> run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
-    }
-
-    final validationIssues = await runValidators();
-    if (validationIssuesContainsError(validationIssues)) {
-      logValidationFailure(issues: validationIssues);
-      return ExitCode.config.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+        checkValidators: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final flavor = results['flavor'] as String?;

diff --git a/packages/shorebird_cli/lib/src/commands/build/build_ipa_command.dart b/packages/shorebird_cli/lib/src/commands/build/build_ipa_command.dart
@@ -2,7 +2,6 @@ import 'dart:io';
 
 import 'package:mason_logger/mason_logger.dart';
 import 'package:path/path.dart' as p;
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_build_mixin.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
@@ -14,11 +13,7 @@ import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 /// App Store submission.
 /// {@endtemplate}
 class BuildIpaCommand extends ShorebirdCommand
-    with
-        AuthLoggerMixin,
-        ShorebirdValidationMixin,
-        ShorebirdConfigMixin,
-        ShorebirdBuildMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin, ShorebirdBuildMixin {
   /// {@macro build_ipa_command}
   BuildIpaCommand({required super.logger, super.auth, super.validators}) {
     argParser
@@ -47,15 +42,13 @@ class BuildIpaCommand extends ShorebirdCommand
 
   @override
   Future<int> run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
-    }
-
-    final validationIssues = await runValidators();
-    if (validationIssuesContainsError(validationIssues)) {
-      logValidationFailure(issues: validationIssues);
-      return ExitCode.config.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+        checkValidators: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final flavor = results['flavor'] as String?;

diff --git a/packages/shorebird_cli/lib/src/commands/collaborators/add_collaborators_command.dart b/packages/shorebird_cli/lib/src/commands/collaborators/add_collaborators_command.dart
@@ -1,16 +1,16 @@
 import 'dart:async';
 
 import 'package:mason_logger/mason_logger.dart';
-import 'package:shorebird_cli/src/auth_logger_mixin.dart';
 import 'package:shorebird_cli/src/command.dart';
 import 'package:shorebird_cli/src/shorebird_config_mixin.dart';
+import 'package:shorebird_cli/src/shorebird_validation_mixin.dart';
 
 /// {@template add_collaborators_command}
 /// `shorebird collaborators add`
 /// Add a new collaborator to a Shorebird app.
 /// {@endtemplate}
 class AddCollaboratorsCommand extends ShorebirdCommand
-    with AuthLoggerMixin, ShorebirdConfigMixin {
+    with ShorebirdConfigMixin, ShorebirdValidationMixin {
   /// {@macro add_collaborators_command}
   AddCollaboratorsCommand({
     required super.logger,
@@ -39,9 +39,12 @@ class AddCollaboratorsCommand extends ShorebirdCommand
 
   @override
   Future<int>? run() async {
-    if (!auth.isAuthenticated) {
-      printNeedsAuthInstructions();
-      return ExitCode.noUser.code;
+    try {
+      await validatePreconditions(
+        checkUserIsAuthenticated: true,
+      );
+    } on PreconditionFailedException catch (e) {
+      return e.exitCode.code;
     }
 
     final client = buildCodePushClient(