fix: Make serverpod generate compatible with workspaces. (serverpod#3403)

Author: SandPod

templates/pubspecs/tools/serverpod_cli/pubspec.yaml

@@ -19,7 +19,7 @@ dependencies:
   recase: ^4.1.0
   built_collection: ^5.1.1
   package_config: ^2.1.0
-  pubspec_parse: ^1.2.2
+  pubspec_parse: ^1.4.0
   source_span: ^1.10.0
   super_string: ^1.0.3
   watcher: ^1.0.2
@@ -43,6 +43,7 @@ dev_dependencies:
   serverpod_lints: SERVERPOD_VERSION
   term_glyph: ^1.2.2
   test: ^1.24.2
+  test_descriptor: ^2.0.2
 
 dependency_overrides:
   serverpod_shared:

tools/serverpod_cli/lib/src/config/config.dart

@@ -337,6 +337,7 @@ class GeneratorConfig implements ModelLoadConfig {
 
     var modules = loadModuleConfigs(
       packageConfig: packageConfig,
+      projectPubspec: pubspec,
       nickNameOverrides: manualModules,
     );
 

tools/serverpod_cli/lib/src/util/locate_modules.dart

@@ -1,50 +1,117 @@
+import 'dart:collection';
 import 'dart:io';
 
 import 'package:package_config/package_config.dart';
 import 'package:path/path.dart' as path;
+import 'package:pubspec_parse/pubspec_parse.dart';
 import 'package:serverpod_cli/src/config/config.dart';
+import 'package:serverpod_cli/src/util/pubspec_helpers.dart';
 import 'package:serverpod_shared/serverpod_shared.dart';
 import 'package:yaml/yaml.dart';
 
 const _serverSuffix = '_server';
 
+bool _isServerpodModule(String packageName) {
+  return packageName.endsWith(_serverSuffix) || packageName == 'serverpod';
+}
+
 List<ModuleConfig> loadModuleConfigs({
+  required Pubspec projectPubspec,
   required PackageConfig packageConfig,
   Map<String, String?> nickNameOverrides = const {},
 }) {
-  var modules = <ModuleConfig>[];
+  var projectModuleDependencies = _listModuleDependencies(
+    projectPubspec: projectPubspec,
+    packageConfig: packageConfig,
+  );
 
-  for (var packageInfo in packageConfig.packages) {
-    try {
-      var packageName = packageInfo.name;
+  var moduleConfigs = _loadModuleConfigs(
+    modules: projectModuleDependencies,
+    nickNameOverrides: nickNameOverrides,
+  );
+
+  return moduleConfigs;
+}
 
-      if (!packageName.endsWith(_serverSuffix) && packageName != 'serverpod') {
+Set<Package> _listModuleDependencies({
+  required Pubspec projectPubspec,
+  required PackageConfig packageConfig,
+}) {
+  var projectModuleDependencies = <Package>{};
+  var visitedModules = <String>{};
+  var foundModules = Queue<String>();
+
+  void queueModulesInPubspec(Pubspec projectPubspec) {
+    for (var dependencyName in projectPubspec.dependencies.keys) {
+      if (!_isServerpodModule(dependencyName)) {
         continue;
       }
 
-      var packageSrcRoot = packageInfo.packageUriRoot;
-      var moduleProjectRoot = List<String>.from(packageSrcRoot.pathSegments)
-        ..removeLast()
-        ..removeLast();
-      var generatorConfigSegments = path
-          .joinAll([...moduleProjectRoot, 'config', 'generator.yaml']).split(
-              path.separator);
+      foundModules.add(dependencyName);
+    }
+  }
+
+  queueModulesInPubspec(projectPubspec);
+
+  while (foundModules.isNotEmpty) {
+    var moduleName = foundModules.removeFirst();
+    if (visitedModules.contains(moduleName)) {
+      continue;
+    }
+
+    visitedModules.add(moduleName);
+
+    var packageInfo = packageConfig.packages
+        .where((pkg) => pkg.name == moduleName)
+        .firstOrNull;
+
+    if (packageInfo == null) {
+      throw ServerpodModulesNotFoundException(
+        'Failed to locate module dependency path in package config for '
+        'dependency: $moduleName',
+      );
+    }
+
+    projectModuleDependencies.add(packageInfo);
 
-      var generatorConfigUri = packageSrcRoot.replace(
-        pathSegments: generatorConfigSegments,
+    Pubspec modulePubspec;
+    try {
+      var modulePubspecFile = File.fromUri(
+        packageInfo.root.resolve('pubspec.yaml'),
       );
+      modulePubspec = parsePubspec(modulePubspecFile);
+    } catch (_) {
+      continue;
+    }
+
+    queueModulesInPubspec(modulePubspec);
+  }
+
+  return projectModuleDependencies;
+}
+
+List<ModuleConfig> _loadModuleConfigs({
+  required Set<Package> modules,
+  Map<String, String?> nickNameOverrides = const {},
+}) {
+  var moduleConfigs = <ModuleConfig>[];
+
+  for (var packageInfo in modules) {
+    try {
+      var packageName = packageInfo.name;
+
+      var packageSrcRoot = packageInfo.root;
+
+      var generatorConfigUri =
+          packageSrcRoot.resolve(path.joinAll(['config', 'generator.yaml']));
 
       var generatorConfigFile = File.fromUri(generatorConfigUri);
       if (!generatorConfigFile.existsSync()) {
         continue;
       }
 
-      var moduleProjectUri = packageSrcRoot.replace(
-        pathSegments: moduleProjectRoot,
-      );
-
       var migrationVersions = findAllMigrationVersionsSync(
-        directory: Directory.fromUri(moduleProjectUri),
+        directory: Directory.fromUri(packageSrcRoot),
       );
 
       var moduleInfo = loadConfigFile(generatorConfigFile);
@@ -53,21 +120,21 @@ List<ModuleConfig> loadModuleConfigs({
       var manualNickname = nickNameOverrides[moduleName];
       var nickname = manualNickname ?? moduleInfo['nickname'] ?? moduleName;
 
-      modules.add(
+      moduleConfigs.add(
         ModuleConfig(
           type: GeneratorConfig.getPackageType(moduleInfo),
           name: moduleName,
           nickname: nickname,
           migrationVersions: migrationVersions,
-          serverPackageDirectoryPathParts: moduleProjectRoot,
+          serverPackageDirectoryPathParts: packageSrcRoot.pathSegments,
         ),
       );
     } catch (e) {
       continue;
     }
   }
 
-  return modules;
+  return moduleConfigs;
 }
 
 Map<dynamic, dynamic> loadConfigFile(File file) {

tools/serverpod_cli/pubspec.yaml

@@ -20,7 +20,7 @@ dependencies:
   recase: ^4.1.0
   built_collection: ^5.1.1
   package_config: ^2.1.0
-  pubspec_parse: ^1.2.2
+  pubspec_parse: ^1.4.0
   source_span: ^1.10.0
   super_string: ^1.0.3
   watcher: ^1.0.2
@@ -44,6 +44,7 @@ dev_dependencies:
   serverpod_lints: 2.5.0
   term_glyph: ^1.2.2
   test: ^1.24.2
+  test_descriptor: ^2.0.2
 
 dependency_overrides:
   serverpod_shared: