feat: add prod server builder (#1161)

Author: renancaraujo

packages/dart_frog_cli/lib/src/commands/build/build.dart

@@ -1,11 +1,9 @@
-import 'dart:io';
-
 import 'package:dart_frog_cli/src/command.dart';
 import 'package:dart_frog_cli/src/commands/build/templates/dart_frog_prod_server_bundle.dart';
 import 'package:dart_frog_cli/src/commands/commands.dart';
-import 'package:dart_frog_cli/src/runtime_compatibility.dart'
-    as runtime_compatibility;
+import 'package:dart_frog_cli/src/prod_server_builder/prod_server_builder.dart';
 import 'package:mason/mason.dart';
+import 'package:meta/meta.dart';
 
 /// {@template build_command}
 /// `dart_frog build` command which creates a production build`.
@@ -14,11 +12,12 @@ class BuildCommand extends DartFrogCommand {
   /// {@macro build_command}
   BuildCommand({
     super.logger,
-    void Function(Directory)? ensureRuntimeCompatibility,
-    GeneratorBuilder? generator,
-  })  : _ensureRuntimeCompatibility = ensureRuntimeCompatibility ??
-            runtime_compatibility.ensureRuntimeCompatibility,
-        _generator = generator ?? MasonGenerator.fromBundle {
+    @visibleForTesting GeneratorBuilder? generator,
+    @visibleForTesting
+    ProdServerBuilderConstructor? prodServerBuilderConstructor,
+  })  : _generator = generator ?? MasonGenerator.fromBundle,
+        _prodServerBuilderConstructor =
+            prodServerBuilderConstructor ?? ProdServerBuilder.new {
     argParser.addOption(
       'dart-version',
       defaultsTo: 'stable',
@@ -27,8 +26,8 @@ class BuildCommand extends DartFrogCommand {
     );
   }
 
-  final void Function(Directory) _ensureRuntimeCompatibility;
   final GeneratorBuilder _generator;
+  final ProdServerBuilderConstructor _prodServerBuilderConstructor;
 
   @override
   final String description = 'Create a production build.';
@@ -38,31 +37,21 @@ class BuildCommand extends DartFrogCommand {
 
   @override
   Future<int> run() async {
-    _ensureRuntimeCompatibility(cwd);
-
+    final dartVersion = results['dart-version'] as String;
     final generator = await _generator(dartFrogProdServerBundle);
-    var vars = <String, dynamic>{
-      'dartVersion': results['dart-version'],
-    };
 
-    logger.detail('[codegen] running pre-gen...');
-    await generator.hooks.preGen(
-      vars: vars,
-      workingDirectory: cwd.path,
-      onVarsChanged: (v) => vars = v,
+    final builder = _prodServerBuilderConstructor(
+      logger: logger,
+      dartVersion: dartVersion,
+      workingDirectory: cwd,
+      prodServerBundleGenerator: generator,
     );
 
-    logger.detail('[codegen] running generate...');
-    final _ = await generator.generate(
-      DirectoryGeneratorTarget(cwd),
-      vars: vars,
-      fileConflictResolution: FileConflictResolution.overwrite,
-    );
-
-    logger.detail('[codegen] running post-gen...');
-    await generator.hooks.postGen(workingDirectory: cwd.path);
-
-    logger.detail('[codegen] complete.');
-    return ExitCode.success.code;
+    try {
+      return (await builder.build()).code;
+    } catch (e) {
+      logger.err(e.toString());
+      return ExitCode.software.code;
+    }
   }
 }

packages/dart_frog_cli/lib/src/commands/create/create.dart

@@ -48,7 +48,7 @@ class CreateCommand extends DartFrogCommand {
     };
 
     logger.detail('[codegen] running generate...');
-    final _ = await generator.generate(
+    await generator.generate(
       DirectoryGeneratorTarget(outputDirectory),
       vars: vars,
     );

packages/dart_frog_cli/lib/src/commands/dev/dev.dart

@@ -15,10 +15,10 @@ class DevCommand extends DartFrogCommand {
   DevCommand({
     super.logger,
     GeneratorBuilder? generator,
-    DevServerRunnerBuilder? devServerRunnerBuilder,
+    DevServerRunnerConstructor? devServerRunnerConstructor,
   })  : _generator = generator ?? MasonGenerator.fromBundle,
-        _devServerRunnerBuilder =
-            devServerRunnerBuilder ?? DevServerRunner.new {
+        _devServerRunnerConstructor =
+            devServerRunnerConstructor ?? DevServerRunner.new {
     argParser
       ..addOption(
         'port',
@@ -43,7 +43,8 @@ class DevCommand extends DartFrogCommand {
   static const _defaultDartVmServicePort = '8181';
 
   final GeneratorBuilder _generator;
-  final DevServerRunnerBuilder _devServerRunnerBuilder;
+  final DevServerRunnerConstructor _devServerRunnerConstructor;
+
   @override
   final String description = 'Run a local development server.';
 
@@ -119,7 +120,7 @@ class DevCommand extends DartFrogCommand {
       }
     }
 
-    _devServerRunner = _devServerRunnerBuilder(
+    _devServerRunner = _devServerRunnerConstructor(
       devServerBundleGenerator: generator,
       logger: logger,
       workingDirectory: cwd,

packages/dart_frog_cli/lib/src/daemon/domain/dev_server_domain.dart

@@ -17,10 +17,10 @@ class DevServerDomain extends DomainBase {
     super.daemon, {
     @visibleForTesting super.getId,
     @visibleForTesting GeneratorBuilder? generator,
-    @visibleForTesting DevServerRunnerBuilder? devServerRunnerBuilder,
+    @visibleForTesting DevServerRunnerConstructor? devServerRunnerConstructor,
   })  : _generator = generator ?? MasonGenerator.fromBundle,
-        _devServerRunnerBuilder =
-            devServerRunnerBuilder ?? DevServerRunner.new {
+        _devServerRunnerConstructor =
+            devServerRunnerConstructor ?? DevServerRunner.new {
     addHandler('start', _start);
     addHandler('reload', _reload);
     addHandler('stop', _stop);
@@ -32,7 +32,7 @@ class DevServerDomain extends DomainBase {
   final _devServerRunners = <String, DevServerRunner>{};
 
   final GeneratorBuilder _generator;
-  final DevServerRunnerBuilder _devServerRunnerBuilder;
+  final DevServerRunnerConstructor _devServerRunnerConstructor;
 
   /// Starts a [DevServerRunner] for the given [request].
   Future<DaemonResponse> _start(DaemonRequest request) async {
@@ -80,7 +80,7 @@ class DevServerDomain extends DomainBase {
       idGenerator: getId,
     );
 
-    final devServerRunner = _devServerRunnerBuilder(
+    final devServerRunner = _devServerRunnerConstructor(
       logger: logger,
       port: '$port',
       address: ip,

packages/dart_frog_cli/lib/src/dev_server_runner/dev_server_runner.dart

@@ -39,7 +39,7 @@ final _dartVmServiceAlreadyInUseErrorRegex = RegExp(
 );
 
 /// Typedef for [DevServerRunner.new].
-typedef DevServerRunnerBuilder = DevServerRunner Function({
+typedef DevServerRunnerConstructor = DevServerRunner Function({
   required Logger logger,
   required String port,
   required io.InternetAddress? address,
@@ -169,7 +169,7 @@ class DevServerRunner {
     );
 
     logger.detail('[codegen] running generate...');
-    final _ = await devServerBundleGenerator.generate(
+    await devServerBundleGenerator.generate(
       _target,
       vars: vars,
       fileConflictResolution: FileConflictResolution.overwrite,

packages/dart_frog_cli/lib/src/prod_server_builder/prod_server_builder.dart

@@ -0,0 +1,81 @@
+import 'dart:io' as io;
+
+import 'package:dart_frog_cli/src/runtime_compatibility.dart';
+import 'package:mason/mason.dart';
+import 'package:meta/meta.dart';
+
+/// Typedef for [ProdServerBuilder.new].
+typedef ProdServerBuilderConstructor = ProdServerBuilder Function({
+  required Logger logger,
+  required String dartVersion,
+  required io.Directory workingDirectory,
+  required MasonGenerator prodServerBundleGenerator,
+});
+
+/// {@template prod_server_builder}
+/// A class that builds the production server runtime code.
+///
+/// This class is responsible for:
+///  - Ensuring that the current version of `package:dart_frog` is compatible
+///    with the generated code.
+///  - Generating the production server runtime code.
+///
+/// {@endtemplate}
+class ProdServerBuilder {
+  /// {@macro prod_server_builder}
+  ProdServerBuilder({
+    required this.logger,
+    required this.dartVersion,
+    required this.workingDirectory,
+    required this.prodServerBundleGenerator,
+    @visibleForTesting
+    RuntimeCompatibilityCallback? runtimeCompatibilityCallback,
+  }) : _ensureRuntimeCompatibility =
+            runtimeCompatibilityCallback ?? ensureRuntimeCompatibility;
+
+  /// The Dart SDK version used to build the Dockerfile.
+  final String dartVersion;
+
+  /// [Logger] instance used to wrap stdout.
+  final Logger logger;
+
+  /// The working directory of the dart_frog project.
+  final io.Directory workingDirectory;
+
+  /// The [MasonGenerator] used to generate the prod server runtime code.
+  final MasonGenerator prodServerBundleGenerator;
+
+  final RuntimeCompatibilityCallback _ensureRuntimeCompatibility;
+
+  /// Builds the production server runtime code.
+  Future<ExitCode> build() async {
+    _ensureRuntimeCompatibility(workingDirectory);
+
+    var vars = <String, dynamic>{
+      'dartVersion': dartVersion,
+    };
+
+    logger.detail('[codegen] running pre-gen...');
+    await prodServerBundleGenerator.hooks.preGen(
+      vars: vars,
+      workingDirectory: workingDirectory.path,
+      onVarsChanged: (v) => vars = v,
+    );
+
+    logger.detail('[codegen] running generate...');
+    await prodServerBundleGenerator.generate(
+      DirectoryGeneratorTarget(workingDirectory),
+      vars: vars,
+      fileConflictResolution: FileConflictResolution.overwrite,
+    );
+
+    logger.detail('[codegen] running post-gen...');
+    await prodServerBundleGenerator.hooks.postGen(
+      workingDirectory: workingDirectory.path,
+    );
+
+    logger.detail('[codegen] complete.');
+
+    return ExitCode.success;
+  }
+}