feat(dart_frog_dev_server): report route conflicts (#200)

Author: felangel

.github/workflows/dart_frog_dev_server.yaml

@@ -0,0 +1,21 @@
+name: dart_frog_dev_server
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/dart_frog_dev_server.yaml"
+      - "bricks/dart_frog_dev_server/hooks/**"
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/dart_frog_dev_server.yaml"
+      - "bricks/dart_frog_dev_server/hooks/**"
+
+jobs:
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
+    with:
+      working_directory: bricks/dart_frog_dev_server/hooks
+      analyze_directories: .
+      report_on: pre_gen.dart

bricks/dart_frog_dev_server/hooks/.gitignore

@@ -1,3 +1,4 @@
 .dart_tool
 .packages
 pubspec.lock
+coverage

bricks/dart_frog_dev_server/hooks/analysis_options.yaml

@@ -0,0 +1 @@
+include: package:very_good_analysis/analysis_options.3.0.1.yaml

bricks/dart_frog_dev_server/hooks/pre_gen.dart

@@ -1,17 +1,32 @@
-import 'dart:io';
+import 'dart:async';
+import 'dart:io' as io;
 
-import 'package:mason/mason.dart';
 import 'package:dart_frog_gen/dart_frog_gen.dart';
+import 'package:mason/mason.dart';
+import 'package:path/path.dart' as path;
+
+typedef RouteConfigurationBuilder = RouteConfiguration Function(
+  io.Directory directory,
+);
 
-Future<void> run(HookContext context) async {
+Future<void> run(HookContext context) async => preGen(context);
+
+Future<void> preGen(
+  HookContext context, {
+  RouteConfigurationBuilder buildConfiguration = buildRouteConfiguration,
+  void Function(int exitCode)? exit,
+}) async {
   final RouteConfiguration configuration;
   try {
-    configuration = buildRouteConfiguration(Directory.current);
+    configuration = buildConfiguration(io.Directory.current);
   } catch (error) {
     context.logger.err('$error');
-    exit(1);
+    final _exit = exit ?? ExitOverrides.current?.exit ?? io.exit;
+    return _exit(1);
   }
 
+  reportRouteConflicts(context, configuration);
+
   context.vars = {
     'port': context.vars['port'] ?? '8080',
     'directories': configuration.directories
@@ -27,3 +42,55 @@ Future<void> run(HookContext context) async {
     'serveStaticFiles': configuration.serveStaticFiles,
   };
 }
+
+void reportRouteConflicts(
+  HookContext context,
+  RouteConfiguration configuration,
+) {
+  final conflictingEndpoints =
+      configuration.endpoints.entries.where((entry) => entry.value.length > 1);
+  if (conflictingEndpoints.isNotEmpty) {
+    context.logger.info('');
+    for (final conflict in conflictingEndpoints) {
+      final originalFilePath = path.normalize(
+        path.join('routes', conflict.value.first.path),
+      );
+      final conflictingFilePath = path.normalize(
+        path.join('routes', conflict.value.last.path),
+      );
+      context.logger.err(
+        '''Route conflict detected. ${lightCyan.wrap(originalFilePath)} and ${lightCyan.wrap(conflictingFilePath)} both resolve to ${lightCyan.wrap(conflict.key)}.''',
+      );
+    }
+    context.logger.info('');
+  }
+}
+
+const _asyncRunZoned = runZoned;
+
+abstract class ExitOverrides {
+  static final _token = Object();
+
+  static ExitOverrides? get current {
+    return Zone.current[_token] as ExitOverrides?;
+  }
+
+  static R runZoned<R>(R Function() body, {void Function(int)? exit}) {
+    final overrides = _ExitOverridesScope(exit);
+    return _asyncRunZoned(body, zoneValues: {_token: overrides});
+  }
+
+  void Function(int exitCode) get exit => io.exit;
+}
+
+class _ExitOverridesScope extends ExitOverrides {
+  _ExitOverridesScope(this._exit);
+
+  final ExitOverrides? _previous = ExitOverrides.current;
+  final void Function(int exitCode)? _exit;
+
+  @override
+  void Function(int exitCode) get exit {
+    return _exit ?? _previous?.exit ?? super.exit;
+  }
+}

bricks/dart_frog_dev_server/hooks/pubspec.yaml

@@ -5,5 +5,10 @@ environment:
   sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
-  dart_frog_gen: ^0.0.2-dev.4
+  dart_frog_gen: ^0.0.2-dev.5
   mason: ^0.1.0-dev.30
+
+dev_dependencies:
+  mocktail: ^0.3.0
+  test: ^1.19.2
+  very_good_analysis: ^3.0.1