refactor(cli): Abstract some components (#365)

dnys1 · web-flow · commit e2337c3a8f35 · 2025-04-27T19:35:31.000-07:00
- Lift up stop signal so that all commands have access to functionality
- Move cloud-related logic to a unified `CloudRepository`
diff --git a/apps/cli/fixtures/fixtures_test.dart b/apps/cli/fixtures/fixtures_test.dart
@@ -14,6 +14,7 @@ import 'package:celest/src/runtime/serve.dart';
 import 'package:celest_ast/celest_ast.dart' as ast;
 import 'package:celest_cli/src/analyzer/analysis_result.dart';
 import 'package:celest_cli/src/analyzer/celest_analyzer.dart';
+import 'package:celest_cli/src/cli/stop_signal.dart';
 import 'package:celest_cli/src/codegen/client_code_generator.dart';
 import 'package:celest_cli/src/codegen/cloud_code_generator.dart';
 import 'package:celest_cli/src/compiler/api/local_api_runner.dart';
@@ -407,7 +408,7 @@ class TestRunner {
       expect(errors, isEmpty);
       expect(project, isNotNull);
 
-      final frontend = CelestFrontend();
+      final frontend = CelestFrontend(stopSignal: StopSignal());
       final buildDir = fileSystem.directory(projectPaths.buildDir);
       if (buildDir.existsSync()) {
         buildDir.deleteSync(recursive: true);
diff --git a/apps/cli/fixtures/standalone/api/pubspec.yaml b/apps/cli/fixtures/standalone/api/pubspec.yaml
@@ -25,6 +25,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 
diff --git a/apps/cli/fixtures/standalone/auth/pubspec.yaml b/apps/cli/fixtures/standalone/auth/pubspec.yaml
@@ -26,6 +26,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 
diff --git a/apps/cli/fixtures/standalone/data/pubspec.yaml b/apps/cli/fixtures/standalone/data/pubspec.yaml
@@ -23,6 +23,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 
diff --git a/apps/cli/fixtures/standalone/env_vars/pubspec.yaml b/apps/cli/fixtures/standalone/env_vars/pubspec.yaml
@@ -20,6 +20,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 dev_dependencies:
diff --git a/apps/cli/fixtures/standalone/exceptions/pubspec.yaml b/apps/cli/fixtures/standalone/exceptions/pubspec.yaml
@@ -22,6 +22,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 
diff --git a/apps/cli/fixtures/standalone/flutter/pubspec.yaml b/apps/cli/fixtures/standalone/flutter/pubspec.yaml
@@ -22,6 +22,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 celest:
diff --git a/apps/cli/fixtures/standalone/http/pubspec.yaml b/apps/cli/fixtures/standalone/http/pubspec.yaml
@@ -22,6 +22,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 
diff --git a/apps/cli/fixtures/standalone/marcelo/pubspec.yaml b/apps/cli/fixtures/standalone/marcelo/pubspec.yaml
@@ -22,6 +22,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 dev_dependencies:
diff --git a/apps/cli/fixtures/standalone/streaming/pubspec.yaml b/apps/cli/fixtures/standalone/streaming/pubspec.yaml
@@ -22,6 +22,8 @@ dependency_overrides:
     path: ../../../../../packages/celest_cloud
   celest_cloud_auth:
     path: ../../../../../services/celest_cloud_auth
+  celest_cloud_core:
+    path: ../../../../../services/celest_cloud_core
   celest_core:
     path: ../../../../../packages/celest_core
 
diff --git a/apps/cli/lib/src/cli/stop_signal.dart b/apps/cli/lib/src/cli/stop_signal.dart
@@ -0,0 +1,28 @@
+import 'dart:async';
+import 'dart:io';
+
+import 'package:celest_cli/src/exceptions.dart';
+
+/// {@template celest.cli.stop_signal}
+/// Signals that a `SIGINT` or `SIGTERM` event has fired and the CLI needs to
+/// shutdown.
+/// {@endtemplate}
+extension type StopSignal._(Completer<ProcessSignal> _it) {
+  factory StopSignal() => StopSignal._(Completer<ProcessSignal>.sync());
+
+  Future<ProcessSignal> get future => _it.future;
+
+  void complete(ProcessSignal signal) => _it.complete(signal);
+
+  /// Whether a SIGINT or SIGTERM signal has been received and the frontend
+  /// is no longer operational.
+  bool get isStopped => _it.isCompleted;
+
+  /// Checks if the signal has been received and throws a [CancellationException]
+  /// if it has.
+  void check() {
+    if (isStopped) {
+      throw const CancellationException('Celest was interrupted');
+    }
+  }
+}
diff --git a/apps/cli/lib/src/commands/celest_command.dart b/apps/cli/lib/src/commands/celest_command.dart
@@ -3,7 +3,9 @@ import 'dart:convert';
 import 'dart:io';
 
 import 'package:args/command_runner.dart';
+import 'package:async/async.dart';
 import 'package:celest_cli/src/cli/cli_runtime.dart';
+import 'package:celest_cli/src/cli/stop_signal.dart';
 import 'package:celest_cli/src/commands/auth/auth_command.dart';
 import 'package:celest_cli/src/context.dart';
 import 'package:celest_cli/src/models.dart';
@@ -19,6 +21,22 @@ import 'package:pub_semver/pub_semver.dart';
 
 /// Base class for all commands in this package providing common functionality.
 abstract base class CelestCommand extends Command<int> {
+  CelestCommand() {
+    // Initialize immediately instead of lazily since _stopSub is never accessed
+    // directly until `close`.
+    _stopSub = StreamGroup.merge([
+      ProcessSignal.sigint.watch(),
+      // SIGTERM is not supported on Windows. Attempting to register a SIGTERM
+      // handler raises an exception.
+      if (!Platform.isWindows) ProcessSignal.sigterm.watch(),
+    ]).listen((signal) {
+      logger.fine('Got exit signal: $signal');
+      if (!stopSignal.isStopped) {
+        stopSignal.complete(signal);
+      }
+    });
+  }
+
   late final Logger logger = Logger(name);
 
   /// The version of the CLI.
@@ -115,6 +133,13 @@ abstract base class CelestCommand extends Command<int> {
     )!;
   }
 
+  /// {@macro celest.cli.stop_signal}
+  final stopSignal = StopSignal();
+
+  /// Subscription to [ProcessSignal.sigint] and [ProcessSignal.sigterm] which
+  /// forwards to [stopSignal] when triggered.
+  late final StreamSubscription<ProcessSignal> _stopSub;
+
   @override
   @mustCallSuper
   Future<int> run() async {
@@ -147,6 +172,7 @@ abstract base class CelestCommand extends Command<int> {
   @mustCallSuper
   Future<void> close() async {
     await Future.wait([
+      _stopSub.cancel(),
       for (final deferred in _deferred) Future.value(deferred()),
     ]);
   }
diff --git a/apps/cli/lib/src/commands/project/build_command.dart b/apps/cli/lib/src/commands/project/build_command.dart
@@ -26,7 +26,7 @@ final class BuildCommand extends CelestCommand
 
     final needsMigration = await configure();
 
-    return CelestFrontend().build(
+    return CelestFrontend(stopSignal: stopSignal).build(
       migrateProject: needsMigration,
       currentProgress: cliLogger.progress('Building project'),
       environmentId: 'production', // TODO(dnys1): Allow setting environment
diff --git a/apps/cli/lib/src/commands/project/deploy_command.dart b/apps/cli/lib/src/commands/project/deploy_command.dart
@@ -29,6 +29,7 @@ final class DeployCommand extends CelestCommand
       return code;
     }
 
-    return CelestFrontend().deploy(migrateProject: needsMigration);
+    return CelestFrontend(stopSignal: stopSignal)
+        .deploy(migrateProject: needsMigration);
   }
 }
diff --git a/apps/cli/lib/src/commands/project/init_command.dart b/apps/cli/lib/src/commands/project/init_command.dart
@@ -1,20 +1,16 @@
 import 'dart:io';
 
-import 'package:celest_cli/src/cli/cli_runtime.dart';
+import 'package:celest_cli/src/commands/auth/authenticate.dart';
 import 'package:celest_cli/src/commands/celest_command.dart';
 import 'package:celest_cli/src/context.dart';
+import 'package:celest_cli/src/init/project_creator.dart';
 import 'package:celest_cli/src/init/project_init.dart';
+import 'package:celest_cli/src/repositories/cloud_repository.dart';
 import 'package:mason_logger/mason_logger.dart';
 
-final class InitCommand extends CelestCommand with Configure, ProjectCreator {
+final class InitCommand extends CelestCommand
+    with Configure, ProjectCreator, Authenticate, CloudRepository {
   InitCommand() {
-    argParser.addFlag(
-      'precache',
-      help: 'Precache assets and warm up analyzer in the background.',
-      negatable: true,
-      hide: true,
-      defaultsTo: true,
-    );
     argParser.addOption(
       'template',
       abbr: 't',
@@ -26,6 +22,10 @@ final class InitCommand extends CelestCommand with Configure, ProjectCreator {
       },
       defaultsTo: 'hello',
     );
+    argParser.addOption(
+      'name',
+      help: 'The project name.',
+    );
   }
 
   @override
@@ -43,57 +43,15 @@ final class InitCommand extends CelestCommand with Configure, ProjectCreator {
   @override
   late final String template = argResults!.option('template')!;
 
-  /// Precache assets in the background.
-  Future<void> _precacheInBackground() async {
-    final command = switch (CliRuntime.current) {
-      CliRuntime.pubGlobal => <String>[
-          platform.resolvedExecutable,
-          'pub',
-          'global',
-          'run',
-          'celest_cli:celest',
-          'precache',
-          projectPaths.projectRoot,
-          if (verbose) '--verbose',
-        ],
-      CliRuntime.local => <String>[
-          platform.resolvedExecutable,
-          platform.script.toFilePath(),
-          'precache',
-          projectPaths.projectRoot,
-          if (verbose) '--verbose',
-        ],
-      CliRuntime.aot => <String>[
-          platform.resolvedExecutable,
-          'precache',
-          projectPaths.projectRoot,
-          if (verbose) '--verbose',
-        ],
-    };
-    try {
-      logger.fine('Precaching assets in background...');
-      await processManager.start(
-        command,
-        mode: ProcessStartMode.detached,
-        workingDirectory: projectPaths.projectRoot,
-      );
-    } on Object catch (e, st) {
-      logger.fine('Failed to precache assets', e, st);
-      performance.captureError(e, stackTrace: st, extra: {'command': command});
-    }
-  }
-
-  bool get precache => argResults!.flag('precache');
+  @override
+  String? get projectName => argResults!.option('name');
 
   @override
   Future<int> run() async {
     await super.run();
 
     await checkForLatestVersion();
     await configure();
-    if (precache) {
-      await _precacheInBackground();
-    }
 
     final projectRoot = projectPaths.projectRoot;
 
diff --git a/apps/cli/lib/src/commands/project/start_command.dart b/apps/cli/lib/src/commands/project/start_command.dart
@@ -2,6 +2,7 @@ import 'package:celest_cli/src/commands/celest_command.dart';
 import 'package:celest_cli/src/context.dart';
 import 'package:celest_cli/src/frontend/celest_frontend.dart';
 import 'package:celest_cli/src/frontend/child_process.dart';
+import 'package:celest_cli/src/init/project_creator.dart';
 import 'package:celest_cli/src/init/project_init.dart';
 import 'package:celest_cli/src/init/project_migrate.dart';
 import 'package:mason_logger/mason_logger.dart';
@@ -53,7 +54,7 @@ final class StartCommand extends CelestCommand
     }
 
     // Start the Celest Frontend Loop
-    return CelestFrontend().run(
+    return CelestFrontend(stopSignal: stopSignal).run(
       migrateProject: needsMigration,
       currentProgress: currentProgress,
       childProcess: childProcess,
diff --git a/apps/cli/lib/src/frontend/celest_frontend.dart b/apps/cli/lib/src/frontend/celest_frontend.dart
diff --git a/apps/cli/lib/src/init/project_creator.dart b/apps/cli/lib/src/init/project_creator.dart
diff --git a/apps/cli/lib/src/init/project_init.dart b/apps/cli/lib/src/init/project_init.dart
diff --git a/apps/cli/lib/src/repositories/cloud_repository.dart b/apps/cli/lib/src/repositories/cloud_repository.dart
