fix(dart_frog_cli): workspace package version resolution

Author: felangel

bricks/dart_frog_prod_server/hooks/lib/dart_frog_prod_server_hooks.dart

@@ -5,7 +5,9 @@ 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_package_config.dart';
 export 'src/get_pubspec_lock.dart';
+export 'src/get_workspace_root.dart';
 export 'src/uses_workspace_resolution.dart';
 
 /// A void callback function (e.g. `void Function()`).

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

@@ -2,26 +2,17 @@ import 'dart:io';
 import 'package:dart_frog_prod_server_hooks/dart_frog_prod_server_hooks.dart';
 import 'package:mason/mason.dart';
 import 'package:path/path.dart' as path;
-import 'package:yaml/yaml.dart';
 
 /// Copies the pubspec.lock from the workspace root into the project directory
 /// in order to ensure the production build uses the exact same versions of all
 /// dependencies.
 VoidCallback copyWorkspacePubspecLock(
   HookContext context, {
   required String projectDirectory,
+  required String workspaceRoot,
   required void Function(int exitCode) exit,
 }) {
-  final workspaceRoot = _getWorkspaceRoot(projectDirectory);
-  if (workspaceRoot == null) {
-    context.logger.err(
-      'Unable to determine workspace root for $projectDirectory',
-    );
-    exit(1);
-    return () {};
-  }
-
-  final pubspecLockFile = File(path.join(workspaceRoot.path, 'pubspec.lock'));
+  final pubspecLockFile = File(path.join(workspaceRoot, 'pubspec.lock'));
   if (!pubspecLockFile.existsSync()) return () {};
 
   try {
@@ -35,45 +26,3 @@ VoidCallback copyWorkspacePubspecLock(
     return () {};
   }
 }
-
-/// Returns the root directory of the nearest Dart workspace.
-Directory? _getWorkspaceRoot(String workingDirectory) {
-  final file = _findNearestAncestor(
-    where: (path) => _getWorkspaceRootPubspecYaml(cwd: Directory(path)),
-    cwd: Directory(workingDirectory),
-  );
-  if (file == null || !file.existsSync()) return null;
-  return Directory(path.dirname(file.path));
-}
-
-/// The workspace root `pubspec.yaml` file for this project.
-File? _getWorkspaceRootPubspecYaml({required Directory cwd}) {
-  try {
-    final pubspecYamlFile = File(path.join(cwd.path, 'pubspec.yaml'));
-    if (!pubspecYamlFile.existsSync()) return null;
-    final pubspec = loadYaml(pubspecYamlFile.readAsStringSync());
-    if (pubspec is! YamlMap) return null;
-    final workspace = pubspec['workspace'] as List?;
-    if (workspace?.isEmpty ?? true) return null;
-    return pubspecYamlFile;
-  } on Exception {
-    return null;
-  }
-}
-
-/// Finds nearest ancestor file
-/// relative to the [cwd] that satisfies [where].
-File? _findNearestAncestor({
-  required File? Function(String path) where,
-  required Directory cwd,
-}) {
-  Directory? prev;
-  var dir = cwd;
-  while (prev?.path != dir.path) {
-    final file = where(dir.path);
-    if (file?.existsSync() ?? false) return file;
-    prev = dir;
-    dir = dir.parent;
-  }
-  return null;
-}

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

@@ -1,24 +1,60 @@
 import 'dart:io';
 import 'package:dart_frog_prod_server_hooks/dart_frog_prod_server_hooks.dart';
 import 'package:mason/mason.dart';
+import 'package:package_config/package_config_types.dart';
 import 'package:path/path.dart' as path;
+import 'package:pubspec_parse/pubspec_parse.dart';
 import 'package:yaml/yaml.dart';
 import 'package:yaml_edit/yaml_edit.dart';
 
 /// 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 PackageConfig packageConfig,
   required String projectDirectory,
+  required String workspaceRoot,
   required void Function(int exitCode) exit,
 }) {
+  final VoidCallback restoreWorkspaceResolution;
   try {
-    return overrideResolutionInPubspecOverrides(projectDirectory);
+    restoreWorkspaceResolution = overrideResolutionInPubspecOverrides(
+      projectDirectory,
+    );
   } on Exception catch (e) {
     context.logger.err('$e');
     exit(1);
     return () {}; // no-op
   }
+
+  // Get all package dependencies.
+  final pubspecFile = File(path.join(projectDirectory, 'pubspec.yaml'));
+  final pubspec = Pubspec.parse(pubspecFile.readAsStringSync());
+  final allDependencies = [
+    ...pubspec.dependencies.keys,
+    ...pubspec.devDependencies.keys,
+  ];
+
+  // Find path dependencies based on the package_config.json.
+  final pathDependencies = packageConfig.packages.where(
+    (package) => package.relativeRoot && allDependencies.contains(package.name),
+  );
+
+  // Add dependency_overrides to the pubspec_overrides.yaml.
+  final pubspecOverridesFile = File(
+    path.join(projectDirectory, 'pubspec_overrides.yaml'),
+  );
+  final contents = pubspecOverridesFile.readAsStringSync();
+  final editor = YamlEditor(contents)..update(['dependency_overrides'], {});
+  for (final package in pathDependencies) {
+    editor.update(
+      ['dependency_overrides', package.name],
+      {'path': path.relative(package.root.path, from: projectDirectory)},
+    );
+  }
+  pubspecOverridesFile.writeAsStringSync(editor.toString());
+
+  return restoreWorkspaceResolution;
 }
 
 VoidCallback overrideResolutionInPubspecOverrides(String projectDirectory) {

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

@@ -0,0 +1,22 @@
+import 'dart:io';
+
+import 'package:package_config/package_config_types.dart';
+import 'package:path/path.dart' as path;
+
+PackageConfig? getPackageConfig(
+  String workspaceRoot, {
+  path.Context? pathContext,
+}) {
+  final pathResolver = pathContext ?? path.context;
+  final packageConfigFile = File(
+    pathResolver.join(workspaceRoot, '.dart_tool/package_config.json'),
+  );
+  if (!packageConfigFile.existsSync()) return null;
+
+  try {
+    final content = packageConfigFile.readAsStringSync();
+    return PackageConfig.parseString(content, packageConfigFile.uri);
+  } on Exception {
+    return null;
+  }
+}

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

@@ -0,0 +1,46 @@
+import 'dart:io';
+
+import 'package:path/path.dart' as path;
+import 'package:yaml/yaml.dart';
+
+/// Returns the root directory of the nearest Dart workspace.
+Directory? getWorkspaceRoot(String workingDirectory) {
+  final file = _findNearestAncestor(
+    where: (path) => _getWorkspaceRootPubspecYaml(cwd: Directory(path)),
+    cwd: Directory(workingDirectory),
+  );
+  if (file == null || !file.existsSync()) return null;
+  return Directory(path.dirname(file.path));
+}
+
+/// The workspace root `pubspec.yaml` file for this project.
+File? _getWorkspaceRootPubspecYaml({required Directory cwd}) {
+  try {
+    final pubspecYamlFile = File(path.join(cwd.path, 'pubspec.yaml'));
+    if (!pubspecYamlFile.existsSync()) return null;
+    final pubspec = loadYaml(pubspecYamlFile.readAsStringSync());
+    if (pubspec is! YamlMap) return null;
+    final workspace = pubspec['workspace'] as List?;
+    if (workspace?.isEmpty ?? true) return null;
+    return pubspecYamlFile;
+  } on Exception {
+    return null;
+  }
+}
+
+/// Finds nearest ancestor file
+/// relative to the [cwd] that satisfies [where].
+File? _findNearestAncestor({
+  required File? Function(String path) where,
+  required Directory cwd,
+}) {
+  Directory? prev;
+  var dir = cwd;
+  while (prev?.path != dir.path) {
+    final file = where(dir.path);
+    if (file?.existsSync() ?? false) return file;
+    prev = dir;
+    dir = dir.parent;
+  }
+  return null;
+}

bricks/dart_frog_prod_server/hooks/pre_gen.dart

@@ -33,23 +33,50 @@ Future<void> preGen(
   VoidCallback? revertPubspecLock;
 
   if (usesWorkspaces) {
+    final workspaceRoot = getWorkspaceRoot(projectDirectory.path);
+    if (workspaceRoot == null) {
+      context.logger.err(
+        'Unable to determine workspace root for $projectDirectory',
+      );
+      return exit(1);
+    }
+
+    // We need to make sure the package_config.json is up to date.
+    await dartPubGet(
+      context,
+      workingDirectory: projectDirectory.path,
+      runProcess: runProcess,
+      exit: exit,
+    );
+
+    final packageConfig = getPackageConfig(workspaceRoot.path);
+    if (packageConfig == null) {
+      context.logger.err(
+        'Unable to find package_config.json for ${workspaceRoot.path}',
+      );
+      return exit(1);
+    }
+
     // Disable workspace resolution until we can generate per-package lockfiles.
     // https://github.com/dart-lang/pub/issues/4594
     restoreWorkspaceResolution = disableWorkspaceResolution(
       context,
+      packageConfig: packageConfig,
       projectDirectory: projectDirectory.path,
+      workspaceRoot: workspaceRoot.path,
       exit: exit,
     );
     // Copy the pubspec.lock from the workspace root to ensure the same versions
     // of dependencies are used in the production build.
     revertPubspecLock = copyWorkspacePubspecLock(
       context,
       projectDirectory: projectDirectory.path,
+      workspaceRoot: workspaceRoot.path,
       exit: exit,
     );
   }
 
-  // We need to make sure that the pubspec.lock file is up to date
+  // We need to make sure that the pubspec.lock file is up to date.
   await dartPubGet(
     context,
     workingDirectory: projectDirectory.path,

bricks/dart_frog_prod_server/hooks/pubspec.yaml

@@ -9,7 +9,9 @@ dependencies:
   equatable: ^2.0.5
   io: ^1.0.3
   mason: ^0.1.0
+  package_config: ^2.2.0
   path: ^1.8.1
+  pubspec_parse: ^1.5.0
   yaml: ^3.1.2
   yaml_edit: ^2.2.2