feat: allow prod server brick to use external dependencies (#910)

erickzanardo · web-flow · commit b00ec98da0c3 · 2023-08-15T18:41:05.000-03:00
diff --git a/bricks/dart_frog_prod_server/hooks/pre_gen.dart b/bricks/dart_frog_prod_server/hooks/pre_gen.dart
@@ -2,11 +2,14 @@ import 'dart:async';
 import 'dart:io' as io;
 
 import 'package:dart_frog_gen/dart_frog_gen.dart';
+import 'package:io/io.dart' as io_expanded;
 import 'package:mason/mason.dart'
     show HookContext, defaultForeground, lightCyan;
 import 'package:path/path.dart' as path;
 
 import 'src/create_bundle.dart';
+import 'src/create_external_packages_folder.dart';
+import 'src/dart_pub_get.dart';
 import 'src/exit_overrides.dart';
 import 'src/get_path_dependencies.dart';
 
@@ -21,11 +24,21 @@ Future<void> run(HookContext context) => preGen(context);
 Future<void> preGen(
   HookContext context, {
   io.Directory? directory,
+  ProcessRunner runProcess = io.Process.run,
   RouteConfigurationBuilder buildConfiguration = buildRouteConfiguration,
   void Function(int exitCode) exit = _defaultExit,
+  Future<void> Function(String from, String to) copyPath = io_expanded.copyPath,
 }) async {
   final projectDirectory = directory ?? io.Directory.current;
 
+  // We need to make sure that the pubspec.lock file is up to date
+  await dartPubGet(
+    context,
+    workingDirectory: projectDirectory.path,
+    runProcess: runProcess,
+    exit: exit,
+  );
+
   await createBundle(context, projectDirectory, exit);
 
   final RouteConfiguration configuration;
@@ -64,25 +77,30 @@ Future<void> preGen(
     },
   );
 
-  await reportExternalPathDependencies(
-    projectDirectory,
-    onViolationStart: () {
-      context.logger
-        ..err('All path dependencies must be within the project.')
-        ..err('External path dependencies detected:');
-    },
-    onExternalPathDependency: (dependencyName, dependencyPath) {
-      context.logger.err('  \u{2022} $dependencyName from $dependencyPath');
-    },
-    onViolationEnd: () {
-      exit(1);
-    },
-  );
-
   final customDockerFile = io.File(
     path.join(projectDirectory.path, 'Dockerfile'),
   );
 
+  // Get all the internal path packages
+  final internalPathDependencies = (await getPathDependencies(projectDirectory))
+      .where(
+        (dependencyPath) =>
+            path.isWithin(projectDirectory.path, dependencyPath),
+      )
+      .toList();
+
+  // Then create the external packages folder
+  // and add it to the list of path packages.
+  final externalDependencies = await createExternalPackagesFolder(
+    projectDirectory,
+    copyPath: copyPath,
+  );
+
+  final pathDependencies = [
+    ...internalPathDependencies,
+    ...externalDependencies,
+  ];
+
   final addDockerfile = !customDockerFile.existsSync();
 
   context.vars = {
@@ -99,7 +117,7 @@ Future<void> preGen(
     'serveStaticFiles': configuration.serveStaticFiles,
     'invokeCustomEntrypoint': configuration.invokeCustomEntrypoint,
     'invokeCustomInit': configuration.invokeCustomInit,
-    'pathDependencies': await getPathDependencies(projectDirectory),
+    'pathDependencies': pathDependencies,
     'dartVersion': context.vars['dartVersion'],
     'addDockerfile': addDockerfile,
   };
diff --git a/bricks/dart_frog_prod_server/hooks/pubspec.yaml b/bricks/dart_frog_prod_server/hooks/pubspec.yaml
@@ -9,6 +9,7 @@ dependencies:
   io: ^1.0.3
   mason: ^0.1.0-dev.39
   path: ^1.8.1
+  pubspec_lock: ^3.0.2
   pubspec_parse: ^1.2.0
 
 dev_dependencies:
diff --git a/bricks/dart_frog_prod_server/hooks/src/create_external_packages_folder.dart b/bricks/dart_frog_prod_server/hooks/src/create_external_packages_folder.dart
@@ -0,0 +1,100 @@
+import 'dart:io';
+
+import 'package:io/io.dart' as io;
+import 'package:path/path.dart' as path;
+import 'package:pubspec_lock/pubspec_lock.dart';
+
+Future<List<String>> createExternalPackagesFolder(
+  Directory directory, {
+  path.Context? pathContext,
+  Future<void> Function(String from, String to) copyPath = io.copyPath,
+}) async {
+  final pathResolver = pathContext ?? path.context;
+  final pubspecLock = await _getPubspecLock(directory.path, pathResolver);
+
+  final externalPathDependencies = pubspecLock.packages
+      .map(
+        (p) => p.iswitch(
+          sdk: (_) => null,
+          hosted: (_) => null,
+          git: (_) => null,
+          path: (d) => d.path,
+        ),
+      )
+      .whereType<String>()
+      .where((dependencyPath) {
+    return !pathResolver.isWithin('', dependencyPath);
+  }).toList();
+
+  if (externalPathDependencies.isEmpty) {
+    return [];
+  }
+  final mappedDependencies = externalPathDependencies
+      .map(
+    (dependencyPath) => (
+      pathResolver.basename(dependencyPath),
+      dependencyPath,
+    ),
+  )
+      .fold(<String, String>{}, (map, dependency) {
+    map[dependency.$1] = dependency.$2;
+    return map;
+  });
+
+  final buildDirectory = Directory(
+    pathResolver.join(
+      directory.path,
+      'build',
+    ),
+  )..createSync();
+
+  final packagesDirectory = Directory(
+    pathResolver.join(
+      buildDirectory.path,
+      '.dart_frog_path_dependencies',
+    ),
+  )..createSync();
+
+  for (final entry in mappedDependencies.entries) {
+    final from = pathResolver.join(directory.path, entry.value);
+    final to = pathResolver.join(packagesDirectory.path, entry.key);
+
+    await copyPath(from, to);
+  }
+
+  final mappedPaths = mappedDependencies.map(
+    (key, value) => MapEntry(
+      key,
+      pathResolver.relative(
+        path.join(packagesDirectory.path, key),
+        from: buildDirectory.path,
+      ),
+    ),
+  );
+
+  await File(
+    pathResolver.join(
+      buildDirectory.path,
+      'pubspec_overrides.yaml',
+    ),
+  ).writeAsString('''
+dependency_overrides:
+${mappedPaths.entries.map((entry) => '  ${entry.key}:\n    path: ${entry.value}').join('\n')}
+''');
+
+  return externalPathDependencies;
+}
+
+Future<PubspecLock> _getPubspecLock(
+  String workingDirectory,
+  path.Context pathResolver,
+) async {
+  final pubspecLockFile = File(
+    workingDirectory.isEmpty
+        ? 'pubspec.lock'
+        : pathResolver.join(workingDirectory, 'pubspec.lock'),
+  );
+
+  final content = await pubspecLockFile.readAsString();
+  return content.loadPubspecLockFromYaml();
+}
diff --git a/bricks/dart_frog_prod_server/hooks/test/pre_gen_test.dart b/bricks/dart_frog_prod_server/hooks/test/pre_gen_test.dart
@@ -9,6 +9,7 @@ import 'package:test/test.dart';
 
 import '../pre_gen.dart';
 import '../src/exit_overrides.dart';
+import 'pubspeck_locks.dart';
 
 class _FakeHookContext extends Fake implements HookContext {
   _FakeHookContext({Logger? logger}) : _logger = logger ?? _MockLogger();
@@ -36,6 +37,14 @@ void main() {
     late HookContext context;
     late Logger logger;
 
+    Future<ProcessResult> successRunProcess(
+      executable,
+      args, {
+      String? workingDirectory,
+      bool? runInShell,
+    }) =>
+        Future.value(ProcessResult(0, 0, '', ''));
+
     setUp(() {
       logger = _MockLogger();
       context = _FakeHookContext(logger: logger)
@@ -61,6 +70,7 @@ void main() {
         context,
         buildConfiguration: (_) => throw exception,
         exit: exitCalls.add,
+        runProcess: successRunProcess,
       );
       expect(exitCalls, equals([1]));
       verify(() => logger.err(exception.toString())).called(1);
@@ -106,6 +116,7 @@ void main() {
         context,
         buildConfiguration: (_) => configuration,
         exit: exitCalls.add,
+        runProcess: successRunProcess,
       );
 
       verify(
@@ -139,6 +150,7 @@ void main() {
         context,
         buildConfiguration: (_) => configuration,
         exit: exitCalls.add,
+        runProcess: successRunProcess,
       );
 
       verify(
@@ -149,18 +161,20 @@ void main() {
       expect(exitCalls, equals([1]));
     });
 
-    test('exit(1) for external dependencies', () async {
-      const configuration = RouteConfiguration(
-        middleware: [],
-        directories: [],
-        routes: [],
-        rogueRoutes: [],
-        endpoints: {},
-      );
+    test(
+      'works with external dependencies',
+      () async {
+        const configuration = RouteConfiguration(
+          middleware: [],
+          directories: [],
+          routes: [],
+          rogueRoutes: [],
+          endpoints: {},
+        );
 
-      final directory = Directory.systemTemp.createTempSync();
-      File(path.join(directory.path, 'pubspec.yaml')).writeAsStringSync(
-        '''
+        final directory = Directory.systemTemp.createTempSync();
+        File(path.join(directory.path, 'pubspec.yaml')).writeAsStringSync(
+          '''
 name: example
 version: 0.1.0
 environment:
@@ -172,28 +186,24 @@ dependencies:
 dev_dependencies:
   test: any
 ''',
-      );
-
-      final exitCalls = <int>[];
-      await preGen(
-        context,
-        buildConfiguration: (_) => configuration,
-        exit: exitCalls.add,
-        directory: directory,
-      );
+        );
+        File(path.join(directory.path, 'pubspec.lock')).writeAsStringSync(
+          fooPath,
+        );
+        final exitCalls = <int>[];
+        await preGen(
+          context,
+          buildConfiguration: (_) => configuration,
+          exit: exitCalls.add,
+          directory: directory,
+          runProcess: successRunProcess,
+          copyPath: (_, __) async {},
+        );
 
-      expect(exitCalls, equals([1]));
-      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();
-    });
+        expect(exitCalls, isEmpty);
+        directory.delete(recursive: true).ignore();
+      },
+    );
 
     test('retains invokeCustomEntrypoint (true)', () async {
       const configuration = RouteConfiguration(
@@ -209,6 +219,7 @@ dev_dependencies:
         context,
         buildConfiguration: (_) => configuration,
         exit: exitCalls.add,
+        runProcess: successRunProcess,
       );
       expect(exitCalls, isEmpty);
       verifyNever(() => logger.err(any()));
@@ -251,6 +262,10 @@ dependencies:
   test: any
 ''',
       );
+
+      File(path.join(directory.path, 'pubspec.lock')).writeAsStringSync(
+        noPathDependencies,
+      );
       File(path.join(directory.path, 'Dockerfile')).writeAsStringSync(
         '',
       );
@@ -261,6 +276,7 @@ dependencies:
         buildConfiguration: (_) => configuration,
         exit: exitCalls.add,
         directory: directory,
+        runProcess: successRunProcess,
       );
 
       expect(
@@ -295,6 +311,7 @@ dependencies:
         context,
         buildConfiguration: (_) => configuration,
         exit: exitCalls.add,
+        runProcess: successRunProcess,
       );
       expect(exitCalls, isEmpty);
       verifyNever(() => logger.err(any()));
@@ -397,6 +414,7 @@ dependencies:
           context,
           buildConfiguration: (_) => configuration,
           exit: exitCalls.add,
+          runProcess: successRunProcess,
         );
         expect(exitCalls, isEmpty);
         verifyNever(() => logger.err(any()));
diff --git a/bricks/dart_frog_prod_server/hooks/test/pubspeck_locks.dart b/bricks/dart_frog_prod_server/hooks/test/pubspeck_locks.dart
diff --git a/bricks/dart_frog_prod_server/hooks/test/src/create_external_packages_folder_test.dart b/bricks/dart_frog_prod_server/hooks/test/src/create_external_packages_folder_test.dart
