feat(dart_frog_dev): report external path dependencies (#339)

Author: felangel

bricks/dart_frog_dev_server/hooks/pre_gen.dart

@@ -4,6 +4,7 @@ import 'dart:io' as io;
 import 'package:dart_frog_gen/dart_frog_gen.dart';
 import 'package:mason/mason.dart';
 import 'package:path/path.dart' as path;
+import 'package:pubspec_parse/pubspec_parse.dart';
 
 typedef RouteConfigurationBuilder = RouteConfiguration Function(
   io.Directory directory,
@@ -27,6 +28,7 @@ Future<void> preGen(
 
   reportRouteConflicts(context, configuration);
   reportRogueRoutes(context, configuration);
+  await reportExternalPathDependencies(context, io.Directory.current);
 
   context.vars = {
     'port': context.vars['port'] ?? '8080',
@@ -45,6 +47,39 @@ Future<void> preGen(
   };
 }
 
+Future<void> reportExternalPathDependencies(
+  HookContext context,
+  io.Directory directory,
+) async {
+  final pubspec = Pubspec.parse(
+    await io.File(path.join(directory.path, 'pubspec.yaml')).readAsString(),
+  );
+
+  final dependencies = pubspec.dependencies;
+  final devDependencies = pubspec.devDependencies;
+  final pathDependencies = [...dependencies.entries, ...devDependencies.entries]
+      .where((entry) => entry.value is PathDependency)
+      .map((entry) {
+    final value = entry.value as PathDependency;
+    return [entry.key, value.path];
+  }).toList();
+  final externalDependencies = pathDependencies.where(
+    (dep) => !path.isWithin(directory.path, dep.last),
+  );
+
+  if (externalDependencies.isNotEmpty) {
+    context.logger
+      ..info('')
+      ..err('All path dependencies must be within the project.')
+      ..err('External path dependencies detected:');
+    for (final dependency in externalDependencies) {
+      final dependencyName = dependency.first;
+      final dependencyPath = path.normalize(dependency.last);
+      context.logger.err('  \u{2022} $dependencyName from $dependencyPath');
+    }
+  }
+}
+
 void reportRouteConflicts(
   HookContext context,
   RouteConfiguration configuration,

bricks/dart_frog_dev_server/hooks/pubspec.yaml

@@ -7,8 +7,10 @@ environment:
 dependencies:
   dart_frog_gen: ^0.1.0
   mason: ^0.1.0-dev.31
+  pubspec_parse: ^1.2.0
 
 dev_dependencies:
   mocktail: ^0.3.0
+  path: ^1.8.2
   test: ^1.19.2
   very_good_analysis: ^3.0.1

bricks/dart_frog_dev_server/hooks/test/pre_gen_test.dart

@@ -3,6 +3,7 @@ import 'dart:io';
 import 'package:dart_frog_gen/dart_frog_gen.dart';
 import 'package:mason/mason.dart';
 import 'package:mocktail/mocktail.dart';
+import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
 import '../pre_gen.dart';
@@ -339,6 +340,111 @@ void main() {
     });
   });
 
+  group('reportExternalPathDependencies', () {
+    late HookContext context;
+    late Logger logger;
+
+    setUp(() {
+      context = _MockHookContext();
+      logger = _MockLogger();
+
+      when(() => context.logger).thenReturn(logger);
+    });
+
+    test('reports nothing when there are no external path dependencies',
+        () async {
+      final directory = Directory.systemTemp.createTempSync();
+      File(path.join(directory.path, 'pubspec.yaml')).writeAsStringSync(
+        '''
+name: example
+version: 0.1.0
+environment:
+  sdk: ^2.17.0
+dependencies:
+  mason: any
+dev_dependencies:
+  test: any
+''',
+      );
+      await expectLater(
+        reportExternalPathDependencies(context, directory),
+        completes,
+      );
+      verifyNever(() => logger.err(any()));
+      directory.delete(recursive: true).ignore();
+    });
+
+    test('reports when there is a single external path dependency', () async {
+      final directory = Directory.systemTemp.createTempSync();
+      File(path.join(directory.path, 'pubspec.yaml')).writeAsStringSync(
+        '''
+name: example
+version: 0.1.0
+environment:
+  sdk: ^2.17.0
+dependencies:
+  mason: any
+  foo:
+    path: ../../foo
+dev_dependencies:
+  test: any
+''',
+      );
+      await expectLater(
+        reportExternalPathDependencies(context, directory),
+        completes,
+      );
+      verify(
+        () => logger.err('All path dependencies must be within the project.'),
+      ).called(1);
+      verify(
+        () => logger.err('External path dependencies detected:'),
+      ).called(1);
+      verify(
+        () => logger.err('  \u{2022} foo from ../../foo'),
+      ).called(1);
+      directory.delete(recursive: true).ignore();
+    });
+
+    test('reports when there are multiple external path dependencies',
+        () async {
+      final directory = Directory.systemTemp.createTempSync();
+      File(path.join(directory.path, 'pubspec.yaml')).writeAsStringSync(
+        '''
+name: example
+version: 0.1.0
+environment:
+  sdk: ^2.17.0
+dependencies:
+  mason: any
+  foo:
+    path: ../../foo
+dev_dependencies:
+  test: any
+  bar:
+    path: ../../bar
+''',
+      );
+      await expectLater(
+        reportExternalPathDependencies(context, directory),
+        completes,
+      );
+      verify(
+        () => logger.err('All path dependencies must be within the project.'),
+      ).called(1);
+      verify(
+        () => logger.err('External path dependencies detected:'),
+      ).called(1);
+      verify(
+        () => logger.err('  \u{2022} foo from ../../foo'),
+      ).called(1);
+      verify(
+        () => logger.err('  \u{2022} bar from ../../bar'),
+      ).called(1);
+      directory.delete(recursive: true).ignore();
+    });
+  });
+
   group('ExitOverrides', () {
     group('runZoned', () {
       test('uses default exit when not specified', () {