feat(dart_frog_cli): support custom ports via --port (#82)

Author: felangel

bricks/dart_frog_dev_server/__brick__/server.dart

@@ -12,7 +12,7 @@ void main() => hotReload(createServer);
 
 Future<HttpServer> createServer() async {
   final ip = InternetAddress.anyIPv4;
-  final port = int.parse(Platform.environment['PORT'] ?? '8080');
+  final port = int.parse(Platform.environment['PORT'] ?? '{{port}}');
   final handler = buildRootHandler();
   return serve(handler, ip, port);
 }

bricks/dart_frog_dev_server/hooks/pre_gen.dart

@@ -13,6 +13,7 @@ Future<void> run(HookContext context) async {
   }
 
   context.vars = {
+    'port': context.vars['port'] ?? '8080',
     'directories': configuration.directories
         .map((c) => c.toJson())
         .toList()

bricks/dart_frog_prod_server/__brick__/build/Dockerfile

@@ -24,5 +24,4 @@ COPY --from=build /runtime/ /
 COPY --from=build /app/bin/server /app/bin/
 
 # Start server.
-EXPOSE 8080
 CMD ["/app/bin/server"]

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

@@ -25,6 +25,7 @@ class BuildCommand extends DartFrogCommand {
     var vars = <String, dynamic>{};
 
     await generator.hooks.preGen(
+      vars: vars,
       workingDirectory: cwd.path,
       onVarsChanged: (v) => vars = v,
     );

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

@@ -1,5 +1,6 @@
 import 'dart:convert';
 import 'dart:io' as io;
+import 'dart:io';
 
 import 'package:dart_frog_cli/src/command.dart';
 import 'package:dart_frog_cli/src/commands/commands.dart';
@@ -49,7 +50,14 @@ class DevCommand extends DartFrogCommand {
         _isWindows = isWindows ?? io.Platform.isWindows,
         _runProcess = runProcess ?? io.Process.run,
         _sigint = sigint ?? io.ProcessSignal.sigint,
-        _startProcess = startProcess ?? io.Process.start;
+        _startProcess = startProcess ?? io.Process.start {
+    argParser.addOption(
+      'port',
+      abbr: 'p',
+      defaultsTo: '8080',
+      help: 'Which port number the server should start on.',
+    );
+  }
 
   final DirectoryWatcherBuilder _directoryWatcher;
   final GeneratorBuilder _generator;
@@ -67,11 +75,13 @@ class DevCommand extends DartFrogCommand {
 
   @override
   Future<int> run() async {
+    final port = Platform.environment['PORT'] ?? results['port'] as String;
     final generator = await _generator(dartFrogDevServerBundle);
 
     Future<void> codegen() async {
-      var vars = <String, dynamic>{};
+      var vars = <String, dynamic>{'port': port};
       await generator.hooks.preGen(
+        vars: vars,
         workingDirectory: cwd.path,
         onVarsChanged: (v) => vars = v,
       );
@@ -112,7 +122,7 @@ class DevCommand extends DartFrogCommand {
     final progress = logger.progress('Serving');
     await codegen();
     await serve();
-    progress.complete('Running on http://localhost:8080');
+    progress.complete('Running on http://localhost:$port');
 
     final watcher = _directoryWatcher(path.join(cwd.path, 'routes'));
     final subscription = watcher.events.listen((event) async {

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

@@ -1,12 +1,15 @@
 import 'dart:async';
 import 'dart:io';
 
+import 'package:args/args.dart';
 import 'package:dart_frog_cli/src/commands/commands.dart';
 import 'package:mason/mason.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:test/test.dart';
 import 'package:watcher/watcher.dart';
 
+class _MockArgResults extends Mock implements ArgResults {}
+
 class _MockDirectoryWatcher extends Mock implements DirectoryWatcher {}
 
 class _MockLogger extends Mock implements Logger {}
@@ -32,6 +35,7 @@ void main() {
       registerFallbackValue(_FakeDirectoryGeneratorTarget());
     });
 
+    late ArgResults argResults;
     late DirectoryWatcher directoryWatcher;
     late MasonGenerator generator;
     late bool isWindows;
@@ -43,6 +47,8 @@ void main() {
     late DevCommand command;
 
     setUp(() {
+      argResults = _MockArgResults();
+      when<dynamic>(() => argResults['port']).thenReturn('8080');
       directoryWatcher = _MockDirectoryWatcher();
       generator = _MockMasonGenerator();
       isWindows = false;
@@ -68,7 +74,7 @@ void main() {
           return process;
         },
         sigint: sigint,
-      );
+      )..testArgResults = argResults;
     });
 
     test('runs a dev server successfully.', () async {
@@ -102,6 +108,54 @@ void main() {
       );
       final exitCode = await command.run();
       expect(exitCode, equals(ExitCode.success.code));
+      verify(
+        () => generatorHooks.preGen(
+          vars: <String, dynamic>{'port': '8080'},
+          workingDirectory: any(named: 'workingDirectory'),
+          onVarsChanged: any(named: 'onVarsChanged'),
+        ),
+      ).called(1);
+    });
+
+    test('port can be specified using --port', () async {
+      when<dynamic>(() => argResults['port']).thenReturn('4242');
+      final generatorHooks = _MockGeneratorHooks();
+      when(
+        () => generatorHooks.preGen(
+          vars: any(named: 'vars'),
+          workingDirectory: any(named: 'workingDirectory'),
+          onVarsChanged: any(named: 'onVarsChanged'),
+        ),
+      ).thenAnswer((invocation) async {
+        (invocation.namedArguments[const Symbol('onVarsChanged')] as Function(
+          Map<String, dynamic> vars,
+        ))
+            .call(<String, dynamic>{});
+      });
+      when(
+        () => generator.generate(
+          any(),
+          vars: any(named: 'vars'),
+          fileConflictResolution: FileConflictResolution.overwrite,
+        ),
+      ).thenAnswer((_) async => []);
+      when(() => generator.hooks).thenReturn(generatorHooks);
+      when(() => process.stdout).thenAnswer((_) => const Stream.empty());
+      when(() => process.stderr).thenAnswer((_) => const Stream.empty());
+      when(
+        () => directoryWatcher.events,
+      ).thenAnswer(
+        (_) => Stream.value(WatchEvent(ChangeType.MODIFY, 'README.md')),
+      );
+      final exitCode = await command.run();
+      expect(exitCode, equals(ExitCode.success.code));
+      verify(
+        () => generatorHooks.preGen(
+          vars: <String, dynamic>{'port': '4242'},
+          workingDirectory: any(named: 'workingDirectory'),
+          onVarsChanged: any(named: 'onVarsChanged'),
+        ),
+      ).called(1);
     });
 
     test('kills all child processes when sigint received on windows', () async {
@@ -155,7 +209,7 @@ void main() {
           return process;
         },
         sigint: sigint,
-      );
+      )..testArgResults = argResults;
       command.run().ignore();
       await untilCalled(() => process.pid);
       expect(exitCode, equals(ExitCode.success.code));