feat(dart_frog_cli): support for Dart workspaces (#1825)

Author: felangel

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

@@ -19,6 +19,7 @@ COPY ./pubspec_overrides.yaml ./pubspec_overrides.yaml
 {{/hasExternalDependencies}}
 # Resolve app dependencies.
 COPY pubspec.* ./
+COPY pubspec_overrides.yaml* ./
 RUN dart pub get
 
 # Copy app source code and AOT compile it.

bricks/dart_frog_prod_server/hooks/lib/dart_frog_prod_server_hooks.dart

@@ -1,6 +1,8 @@
 export 'src/create_bundle.dart';
 export 'src/create_external_packages_folder.dart';
 export 'src/dart_pub_get.dart';
+export 'src/disable_workspace_resolution.dart';
 export 'src/exit_overrides.dart';
 export 'src/get_internal_path_dependencies.dart';
 export 'src/get_pubspec_lock.dart';
+export 'src/uses_workspace_resolution.dart';

bricks/dart_frog_prod_server/hooks/lib/src/create_external_packages_folder.dart

@@ -22,9 +22,7 @@ Future<List<String>> createExternalPackagesFolder({
       .map(
         (dependency) {
           final pathDescription = dependency.pathDescription;
-          if (pathDescription == null) {
-            return null;
-          }
+          if (pathDescription == null) return null;
 
           final isExternal = !pathResolver.isWithin('', pathDescription.path);
           if (!isExternal) return null;
@@ -38,9 +36,7 @@ Future<List<String>> createExternalPackagesFolder({
       .whereType<_ExternalPathDependency>()
       .toList();
 
-  if (externalPathDependencies.isEmpty) {
-    return [];
-  }
+  if (externalPathDependencies.isEmpty) return [];
 
   final packagesDirectory = Directory(
     pathResolver.join(
@@ -51,34 +47,38 @@ Future<List<String>> createExternalPackagesFolder({
 
   final copiedExternalPathDependencies = await Future.wait(
     externalPathDependencies.map(
-      (externalPathDependency) => externalPathDependency.copyTo(
-        copyPath: copyPath,
-        targetDirectory: Directory(
-          pathResolver.join(
-            packagesDirectory.path,
-            externalPathDependency.name,
+      (externalPathDependency) async {
+        final copy = await externalPathDependency.copyTo(
+          copyPath: copyPath,
+          targetDirectory: Directory(
+            pathResolver.join(
+              packagesDirectory.path,
+              externalPathDependency.name,
+            ),
           ),
-        ),
-      ),
+        );
+        overrideResolutionInPubspecOverrides(copy.path);
+        return copy;
+      },
     ),
   );
 
-  await File(
-    pathResolver.join(
-      buildDirectory.path,
-      'pubspec_overrides.yaml',
-    ),
-  ).writeAsString('''
+  File(
+    pathResolver.join(buildDirectory.path, 'pubspec_overrides.yaml'),
+  ).writeAsStringSync(
+    '''
+resolution: null
 dependency_overrides:
 ${copiedExternalPathDependencies.map(
-    (dependency) {
-      final name = dependency.name;
-      final path =
-          pathResolver.relative(dependency.path, from: buildDirectory.path);
-      return '  $name:\n    path: $path';
-    },
-  ).join('\n')}
-''');
+      (dependency) {
+        final name = dependency.name;
+        final path =
+            pathResolver.relative(dependency.path, from: buildDirectory.path);
+        return '  $name:\n    path: $path';
+      },
+    ).join('\n')}
+''',
+  );
 
   return copiedExternalPathDependencies
       .map((dependency) => dependency.path)

bricks/dart_frog_prod_server/hooks/lib/src/disable_workspace_resolution.dart

@@ -0,0 +1,50 @@
+import 'dart:io';
+import 'package:mason/mason.dart';
+import 'package:path/path.dart' as path;
+import 'package:yaml/yaml.dart';
+import 'package:yaml_edit/yaml_edit.dart';
+
+/// A void callback function (e.g. `void Function()`).
+typedef VoidCallback = void Function();
+
+/// Opts out of dart workspaces until we can generate per package lockfiles.
+/// https://github.com/dart-lang/pub/issues/4594
+VoidCallback disableWorkspaceResolution(
+  HookContext context, {
+  required String projectDirectory,
+  required void Function(int exitCode) exit,
+}) {
+  try {
+    return overrideResolutionInPubspecOverrides(projectDirectory);
+  } on Exception catch (e) {
+    context.logger.err('$e');
+    exit(1);
+    return () {}; // no-op
+  }
+}
+
+VoidCallback overrideResolutionInPubspecOverrides(String projectDirectory) {
+  final pubspecOverridesFile = File(
+    path.join(projectDirectory, 'pubspec_overrides.yaml'),
+  );
+
+  if (!pubspecOverridesFile.existsSync()) {
+    pubspecOverridesFile.writeAsStringSync('resolution: null');
+    return pubspecOverridesFile.deleteSync;
+  }
+
+  final contents = pubspecOverridesFile.readAsStringSync();
+  final pubspecOverrides = loadYaml(contents) as YamlMap?;
+
+  if (pubspecOverrides == null) {
+    pubspecOverridesFile.writeAsStringSync('resolution: null');
+    return () => pubspecOverridesFile.writeAsStringSync(contents);
+  }
+
+  if (pubspecOverrides['resolution'] == 'null') return () {}; // no-op
+
+  final editor = YamlEditor(contents)..update(['resolution'], null);
+  pubspecOverridesFile.writeAsStringSync(editor.toString());
+
+  return () => pubspecOverridesFile.writeAsStringSync(contents);
+}

bricks/dart_frog_prod_server/hooks/lib/src/uses_workspace_resolution.dart

@@ -0,0 +1,30 @@
+import 'dart:io';
+import 'package:mason/mason.dart';
+import 'package:path/path.dart' as path;
+import 'package:yaml/yaml.dart';
+
+/// Determines whether the project in the provided [workingDirectory]
+/// is configured to use `resolution: workspace`.
+bool usesWorkspaceResolution(
+  HookContext context, {
+  required String workingDirectory,
+  required void Function(int exitCode) exit,
+}) {
+  final pubspecFile = File(path.join(workingDirectory, 'pubspec.yaml'));
+  if (!pubspecFile.existsSync()) return false;
+
+  final YamlMap pubspec;
+  try {
+    final yaml = loadYaml(pubspecFile.readAsStringSync());
+    if (yaml is! YamlMap) {
+      throw Exception('Unable to parse ${pubspecFile.path}');
+    }
+    pubspec = yaml;
+  } on Exception catch (e) {
+    context.logger.err('$e');
+    exit(1);
+    return false;
+  }
+
+  return pubspec['resolution'] == 'workspace';
+}

bricks/dart_frog_prod_server/hooks/pre_gen.dart

@@ -23,6 +23,23 @@ Future<void> preGen(
   Future<void> Function(String from, String to) copyPath = io_expanded.copyPath,
 }) async {
   final projectDirectory = directory ?? io.Directory.current;
+  final usesWorkspaces = usesWorkspaceResolution(
+    context,
+    workingDirectory: projectDirectory.path,
+    exit: exit,
+  );
+
+  VoidCallback? restoreWorkspaceResolution;
+
+  if (usesWorkspaces) {
+    // Disable workspace resolution until we can generate per-package lockfiles.
+    // https://github.com/dart-lang/pub/issues/4594
+    restoreWorkspaceResolution = disableWorkspaceResolution(
+      context,
+      projectDirectory: projectDirectory.path,
+      exit: exit,
+    );
+  }
 
   // We need to make sure that the pubspec.lock file is up to date
   await dartPubGet(
@@ -43,6 +60,8 @@ Future<void> preGen(
     exit: exit,
   );
 
+  restoreWorkspaceResolution?.call();
+
   final RouteConfiguration configuration;
   try {
     configuration = buildConfiguration(projectDirectory);
@@ -62,9 +81,7 @@ Future<void> preGen(
         '''Route conflict detected. ${lightCyan.wrap(originalFilePath)} and ${lightCyan.wrap(conflictingFilePath)} both resolve to ${lightCyan.wrap(conflictingEndpoint)}.''',
       );
     },
-    onViolationEnd: () {
-      exit(1);
-    },
+    onViolationEnd: () => exit(1),
   );
 
   reportRogueRoutes(
@@ -74,9 +91,7 @@ Future<void> preGen(
         '''Rogue route detected.${defaultForeground.wrap(' ')}Rename ${lightCyan.wrap(filePath)} to ${lightCyan.wrap(idealPath)}.''',
       );
     },
-    onViolationEnd: () {
-      exit(1);
-    },
+    onViolationEnd: () => exit(1),
   );
 
   final customDockerFile = io.File(

bricks/dart_frog_prod_server/hooks/pubspec.yaml

@@ -11,6 +11,7 @@ dependencies:
   mason: ^0.1.0
   path: ^1.8.1
   yaml: ^3.1.2
+  yaml_edit: ^2.2.2
 
 dev_dependencies:
   mocktail: ^1.0.0

bricks/dart_frog_prod_server/hooks/test/post_gen_test.dart

@@ -54,7 +54,6 @@ void main() {
       expect(
         ExitOverrides.runZoned(
           () => post_gen.run(_FakeHookContext(logger: logger)),
-          exit: (_) {},
         ),
         completes,
       );

bricks/dart_frog_prod_server/hooks/test/pre_gen_test.dart

@@ -10,6 +10,7 @@ import 'package:test/test.dart';
 
 import '../pre_gen.dart' as pre_gen;
 import 'pubspec_locks.dart';
+import 'pubspecs.dart';
 
 class _FakeHookContext extends Fake implements HookContext {
   _FakeHookContext({Logger? logger}) : _logger = logger ?? _MockLogger();
@@ -161,49 +162,84 @@ void main() {
       expect(exitCalls, equals([1]));
     });
 
-    test(
-      'works with external dependencies',
-      () async {
-        const configuration = RouteConfiguration(
-          middleware: [],
-          directories: [],
-          routes: [],
-          rogueRoutes: [],
-          endpoints: {},
-        );
+    test('works with workspaces', () async {
+      const configuration = RouteConfiguration(
+        middleware: [],
+        directories: [],
+        routes: [],
+        rogueRoutes: [],
+        endpoints: {},
+      );
 
-        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
-''',
-        );
-        File(path.join(directory.path, 'pubspec.lock')).writeAsStringSync(
-          fooPath,
-        );
-        final exitCalls = <int>[];
-        await pre_gen.preGen(
-          context,
-          buildConfiguration: (_) => configuration,
-          exit: exitCalls.add,
-          directory: directory,
-          runProcess: successRunProcess,
-          copyPath: (_, __) async {},
-        );
+      final directory = Directory.systemTemp.createTempSync();
+      File(
+        path.join(directory.path, 'pubspec.yaml'),
+      ).writeAsStringSync(workspaceRoot);
+      final server = Directory(
+        path.join(directory.path, 'server'),
+      )..createSync();
+      File(
+        path.join(server.path, 'pubspec.yaml'),
+      ).writeAsStringSync(workspaceChild);
+      File(
+        path.join(server.path, 'pubspec.lock'),
+      ).writeAsStringSync('''
+# Generated by pub
+# See https://dart.dev/tools/pub/glossary#lockfile
+packages:
+  _fe_analyzer_shared:
+    dependency: transitive
+    description:
+      name: _fe_analyzer_shared
+      sha256: da0d9209ca76bde579f2da330aeb9df62b6319c834fa7baae052021b0462401f
+      url: "https://pub.dev"
+    source: hosted
+    version: "85.0.0"
+''');
+      final exitCalls = <int>[];
+      await pre_gen.preGen(
+        context,
+        buildConfiguration: (_) => configuration,
+        exit: exitCalls.add,
+        directory: server,
+        runProcess: successRunProcess,
+        copyPath: (_, __) async {},
+      );
 
-        expect(exitCalls, isEmpty);
-        directory.delete(recursive: true).ignore();
-      },
-    );
+      expect(exitCalls, isEmpty);
+      directory.delete(recursive: true).ignore();
+    });
+
+    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.lock'),
+      ).writeAsStringSync(fooPath);
+      final exitCalls = <int>[];
+      await pre_gen.preGen(
+        context,
+        buildConfiguration: (_) => configuration,
+        exit: exitCalls.add,
+        directory: directory,
+        runProcess: successRunProcess,
+        copyPath: (from, to) async {
+          File(
+            path.join(to, 'pubspec_overrides.yaml'),
+          ).createSync(recursive: true);
+        },
+      );
+
+      expect(exitCalls, isEmpty);
+      directory.delete(recursive: true).ignore();
+    });
 
     test('retains invokeCustomEntrypoint (true)', () async {
       const configuration = RouteConfiguration(