feat(dart_frog_prod_server): report rogue routes (#253)

Author: felangel

bricks/dart_frog_prod_server/hooks/pre_gen.dart

@@ -33,6 +33,7 @@ Future<void> preGen(
   }
 
   reportRouteConflicts(context, configuration, _exit);
+  reportRogueRoutes(context, configuration, _exit);
 
   context.vars = {
     'directories': configuration.directories
@@ -120,6 +121,28 @@ void reportRouteConflicts(
   }
 }
 
+void reportRogueRoutes(
+  HookContext context,
+  RouteConfiguration configuration,
+  void Function(int exitCode) exit,
+) {
+  if (configuration.rogueRoutes.isNotEmpty) {
+    for (final route in configuration.rogueRoutes) {
+      final filePath = path.normalize(path.join('routes', route.path));
+      final fileDirectory = path.dirname(filePath);
+      final idealPath = path.join(
+        fileDirectory,
+        path.basenameWithoutExtension(filePath),
+        'index.dart',
+      );
+      context.logger.err(
+        '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap(filePath)} to ${lightCyan.wrap(idealPath)}.''',
+      );
+    }
+    exit(1);
+  }
+}
+
 const _asyncRunZoned = runZoned;
 
 abstract class ExitOverrides {

bricks/dart_frog_prod_server/hooks/pubspec.yaml

@@ -5,7 +5,7 @@ environment:
   sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
-  dart_frog_gen: ^0.0.2-dev.6
+  dart_frog_gen: ^0.0.2-dev.7
   io: ^1.0.3
   mason: ^0.1.0-dev.31
   path: ^1.8.1

bricks/dart_frog_prod_server/hooks/test/pre_gen_test.dart

@@ -1,7 +1,8 @@
 import 'dart:io';
 
 import 'package:dart_frog_gen/dart_frog_gen.dart';
-import 'package:mason/mason.dart' show HookContext, Logger, Progress, lightCyan;
+import 'package:mason/mason.dart'
+    show HookContext, Logger, Progress, defaultForeground, lightCyan;
 import 'package:mocktail/mocktail.dart';
 import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
@@ -95,6 +96,7 @@ void main() {
           RouteFile(name: 'index', path: 'index.dart', route: '/'),
           RouteFile(name: 'hello', path: 'hello.dart', route: '/hello'),
         ],
+        rogueRoutes: [],
         endpoints: {
           '/': [
             RouteFile(name: 'index', path: 'index.dart', route: '/'),
@@ -302,6 +304,66 @@ dev_dependencies:
         expect(exitCalls, equals([1]));
       });
     });
+
+    group('reportRogueRoutes', () {
+      late HookContext context;
+      late Logger logger;
+      late RouteConfiguration configuration;
+
+      setUp(() {
+        context = _MockHookContext();
+        logger = _MockLogger();
+        configuration = _MockRouteConfiguration();
+
+        when(() => context.logger).thenReturn(logger);
+      });
+
+      test('reports nothing when there are no rogue routes', () {
+        final exitCalls = <int>[];
+        when(() => configuration.rogueRoutes).thenReturn([]);
+        reportRogueRoutes(context, configuration, exitCalls.add);
+        verifyNever(() => logger.err(any()));
+        expect(exitCalls, isEmpty);
+      });
+
+      test('reports single rogue route', () {
+        final exitCalls = <int>[];
+        when(() => configuration.rogueRoutes).thenReturn(
+          const [
+            RouteFile(name: 'hello', path: 'hello.dart', route: '/hello'),
+          ],
+        );
+        reportRogueRoutes(context, configuration, exitCalls.add);
+        verify(
+          () => logger.err(
+            '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap('routes/hello.dart')} to ${lightCyan.wrap('routes/hello/index.dart')}.''',
+          ),
+        );
+        expect(exitCalls, equals([1]));
+      });
+
+      test('reports multiple rogue routes', () {
+        final exitCalls = <int>[];
+        when(() => configuration.rogueRoutes).thenReturn(
+          const [
+            RouteFile(name: 'hello', path: 'hello.dart', route: '/hello'),
+            RouteFile(name: 'hi', path: 'hi.dart', route: '/hi'),
+          ],
+        );
+        reportRogueRoutes(context, configuration, exitCalls.add);
+        verify(
+          () => logger.err(
+            '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap('routes/hello.dart')} to ${lightCyan.wrap('routes/hello/index.dart')}.''',
+          ),
+        );
+        verify(
+          () => logger.err(
+            '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap('routes/hi.dart')} to ${lightCyan.wrap('routes/hi/index.dart')}.''',
+          ),
+        );
+        expect(exitCalls, equals([1]));
+      });
+    });
   });
 
   group('ExitOverrides', () {