feat: change production brick to support external dependencies in the Dockerfile (#926)

Author: erickzanardo

bricks/dart_frog_prod_server/__brick__/build/{{#addDockerfile}}Dockerfile{{/addDockerfile}}

@@ -3,13 +3,20 @@
 FROM dart:{{dartVersion}} AS build
 
 WORKDIR /app
+{{#hasExternalDependencies}}
 
+# Copy external dependencies
+COPY ./.dart_frog_path_dependencies  ./.dart_frog_path_dependencies
+COPY ./pubspec_overrides.yaml ./pubspec_overrides.yaml
+{{/hasExternalDependencies}}
 # Copy Dependencies
 {{#pathDependencies}}COPY {{{.}}} ./{{{.}}}
 {{/pathDependencies}}
+{{^hasExternalDependencies}}
 # Install Dependencies
 {{#pathDependencies}}RUN dart pub get -C {{{.}}}
 {{/pathDependencies}}
+{{/hasExternalDependencies}}
 # Resolve app dependencies.
 COPY pubspec.* ./
 RUN dart pub get

bricks/dart_frog_prod_server/hooks/pre_gen.dart

@@ -11,7 +11,7 @@ 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';
+import 'src/get_internal_path_dependencies.dart';
 
 typedef RouteConfigurationBuilder = RouteConfiguration Function(
   io.Directory directory,
@@ -81,26 +81,15 @@ Future<void> preGen(
     path.join(projectDirectory.path, 'Dockerfile'),
   );
 
-  // Get all the internal path packages
-  final internalPathDependencies = (await getPathDependencies(projectDirectory))
-      .where(
-        (dependencyPath) =>
-            path.isWithin(projectDirectory.path, dependencyPath),
-      )
-      .toList();
+  final internalPathDependencies = await getInternalPathDependencies(
+    projectDirectory,
+  );
 
-  // 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 = {
@@ -117,7 +106,9 @@ Future<void> preGen(
     'serveStaticFiles': configuration.serveStaticFiles,
     'invokeCustomEntrypoint': configuration.invokeCustomEntrypoint,
     'invokeCustomInit': configuration.invokeCustomInit,
-    'pathDependencies': pathDependencies,
+    'pathDependencies': internalPathDependencies,
+    'hasExternalDependencies': externalDependencies.isNotEmpty,
+    'externalPathDependencies': externalDependencies,
     'dartVersion': context.vars['dartVersion'],
     'addDockerfile': addDockerfile,
   };

bricks/dart_frog_prod_server/hooks/pubspec.yaml

@@ -10,7 +10,6 @@ dependencies:
   mason: ^0.1.0-dev.39
   path: ^1.8.1
   pubspec_lock: ^3.0.2
-  pubspec_parse: ^1.2.0
 
 dev_dependencies:
   mocktail: ^1.0.0

bricks/dart_frog_prod_server/hooks/src/create_external_packages_folder.dart

@@ -2,15 +2,19 @@ import 'dart:io';
 
 import 'package:io/io.dart' as io;
 import 'package:path/path.dart' as path;
-import 'package:pubspec_lock/pubspec_lock.dart';
+
+import 'get_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 pubspecLock = await getPubspecLock(
+    directory.path,
+    pathContext: pathResolver,
+  );
 
   final externalPathDependencies = pubspecLock.packages
       .map(
@@ -55,11 +59,15 @@ Future<List<String>> createExternalPackagesFolder(
     ),
   )..createSync();
 
+  final copiedPaths = <String>[];
   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);
+    copiedPaths.add(
+      path.relative(to, from: buildDirectory.path),
+    );
   }
 
   final mappedPaths = mappedDependencies.map(
@@ -82,19 +90,5 @@ 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();
+  return copiedPaths;
 }

bricks/dart_frog_prod_server/hooks/src/get_internal_path_dependencies.dart

@@ -0,0 +1,22 @@
+import 'dart:io' as io;
+
+import 'package:path/path.dart' as path;
+
+import 'get_pubspec_lock.dart';
+
+Future<List<String>> getInternalPathDependencies(io.Directory directory) async {
+  final pubspecLock = await getPubspecLock(directory.path);
+  return pubspecLock.packages
+      .map(
+        (p) => p.iswitch(
+          sdk: (_) => null,
+          hosted: (_) => null,
+          git: (_) => null,
+          path: (d) => d.path,
+        ),
+      )
+      .whereType<String>()
+      .where((dependencyPath) {
+    return path.isWithin('', dependencyPath);
+  }).toList();
+}

bricks/dart_frog_prod_server/hooks/src/get_path_dependencies.dart

@@ -0,0 +1,19 @@
+import 'dart:io';
+
+import 'package:path/path.dart' as path;
+import 'package:pubspec_lock/pubspec_lock.dart';
+
+Future<PubspecLock> getPubspecLock(
+  String workingDirectory, {
+  path.Context? pathContext,
+}) async {
+  final pathResolver = pathContext ?? path.context;
+  final pubspecLockFile = File(
+    workingDirectory.isEmpty
+        ? 'pubspec.lock'
+        : pathResolver.join(workingDirectory, 'pubspec.lock'),
+  );
+
+  final content = await pubspecLockFile.readAsString();
+  return content.loadPubspecLockFromYaml();
+}

bricks/dart_frog_prod_server/hooks/src/get_pubspec_lock.dart

@@ -106,8 +106,8 @@ void main() {
               route: '/',
               params: [],
               wildcard: false,
-            )
-          ]
+            ),
+          ],
         },
       );
 
@@ -234,6 +234,8 @@ dev_dependencies:
           'invokeCustomEntrypoint': true,
           'invokeCustomInit': false,
           'pathDependencies': <String>[],
+          'hasExternalDependencies': false,
+          'externalPathDependencies': <String>[],
           'dartVersion': 'stable',
           'addDockerfile': true,
         }),
@@ -289,6 +291,8 @@ dependencies:
           'serveStaticFiles': false,
           'invokeCustomEntrypoint': false,
           'invokeCustomInit': false,
+          'hasExternalDependencies': false,
+          'externalPathDependencies': <String>[],
           'pathDependencies': <String>[],
           'dartVersion': 'stable',
           'addDockerfile': false,
@@ -325,6 +329,8 @@ dependencies:
           'serveStaticFiles': false,
           'invokeCustomEntrypoint': false,
           'invokeCustomInit': true,
+          'hasExternalDependencies': false,
+          'externalPathDependencies': <String>[],
           'pathDependencies': <String>[],
           'dartVersion': 'stable',
           'addDockerfile': true,
@@ -344,7 +350,7 @@ dependencies:
             MiddlewareFile(
               name: 'hello_middleware',
               path: 'hello/middleware.dart',
-            )
+            ),
           ],
           directories: [
             RouteDirectory(
@@ -368,7 +374,7 @@ dependencies:
                 ),
               ],
               params: [],
-            )
+            ),
           ],
           routes: [
             RouteFile(
@@ -405,7 +411,7 @@ dependencies:
                 params: [],
                 wildcard: false,
               ),
-            ]
+            ],
           },
           serveStaticFiles: true,
         );
@@ -462,15 +468,20 @@ dependencies:
               }
             ],
             'middleware': [
-              {'name': 'hello_middleware', 'path': 'hello/middleware.dart'}
+              {
+                'name': 'hello_middleware',
+                'path': 'hello/middleware.dart',
+              },
             ],
             'globalMiddleware': {
               'name': 'middleware',
-              'path': 'middleware.dart'
+              'path': 'middleware.dart',
             },
             'serveStaticFiles': true,
             'invokeCustomEntrypoint': false,
             'invokeCustomInit': false,
+            'hasExternalDependencies': false,
+            'externalPathDependencies': <String>[],
             'pathDependencies': <String>[],
             'dartVersion': 'stable',
             'addDockerfile': true,

bricks/dart_frog_prod_server/hooks/test/pre_gen_test.dart

@@ -0,0 +1,67 @@
+import 'dart:io';
+
+import 'package:path/path.dart' as path;
+import 'package:test/test.dart';
+
+import '../../src/get_internal_path_dependencies.dart';
+
+void main() {
+  group('getPathDependencies', () {
+    test('returns nothing when there are no path dependencies', () {
+      final directory = Directory.systemTemp.createTempSync();
+      File(path.join(directory.path, 'pubspec.lock')).writeAsStringSync(
+        '''
+packages:
+  test:
+    dependency: transitive
+    description:
+      name: analyzer
+      sha256: f85566ec7b3d25cbea60f7dd4f157c5025f2f19233ca4feeed33b616c78a26a3
+      url: "https://pub.dev"
+    source: hosted
+    version: "6.1.0"
+  mason:
+    dependency: transitive
+    description:
+      name: analyzer
+      sha256: f85566ec7b3d25cbea60f7dd4f157c5025f2f19233ca4feeed33b616c78a26a3
+      url: "https://pub.dev"
+    source: hosted
+    version: "6.1.0"
+''',
+      );
+      expect(getInternalPathDependencies(directory), completion(isEmpty));
+      directory.delete(recursive: true).ignore();
+    });
+
+    test('returns correct path dependencies', () {
+      final directory = Directory.systemTemp.createTempSync();
+      File(path.join(directory.path, 'pubspec.lock')).writeAsStringSync(
+        '''
+packages:
+  dart_frog:
+    dependency: "direct main"
+    description:
+      path: "path/to/dart_frog"
+      relative: true
+    source: path
+    version: "0.0.0"
+  dart_frog_gen:
+    dependency: "direct main"
+    description:
+      path: "path/to/dart_frog_gen"
+      relative: true
+    source: path
+    version: "0.0.0"
+''',
+      );
+      expect(
+        getInternalPathDependencies(directory),
+        completion(
+          equals(['path/to/dart_frog', 'path/to/dart_frog_gen']),
+        ),
+      );
+      directory.delete(recursive: true).ignore();
+    });
+  });
+}