[analyze] When opening several folders with "resolution: workspace" try to merge them by workspace root

Use-case: I have 20+ folders from the sdk that I have open
(front_end, _fe_analyzer_shared, vm, analyzer, analysis_server etc) and
before this CL that meant I had 20+ contexts, despite them having
`resolution: workspace` and being specified in the roots pubspec.yaml
under `workspace`. Opening, for instance, `pkg` directly would
successfully give me only 1 context, but also include lots of stuff I
don't want to clutter neither my screen nor my mind.

This CL merges such folders as possible meaning I with this CL only have
1 context.

* If not using the workspace resolution this should change nothing.
* If opening only the root of a workspace this should change nothing.
* If opening a sub folder that itself isn't a package (say `pkg` in the
  sdk) this should change nothing.

Change-Id: Ia38fa6636b02fa95ed274ebf72d424cae7d4da66
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/434802
Reviewed-by: Konstantin Shcheglov <[email protected]>
Commit-Queue: Jens Johansen <[email protected]>

Author: jensjoha

pkg/analyzer/lib/src/dart/analysis/context_locator.dart

@@ -12,6 +12,7 @@ import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
 import 'package:analyzer/src/context/packages.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options.dart';
 import 'package:analyzer/src/dart/analysis/context_root.dart';
+import 'package:analyzer/src/lint/pub.dart';
 import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/util/yaml.dart';
@@ -111,8 +112,69 @@ class ContextLocatorImpl {
       }
     }
 
+    var workspaceResolutionRootMap = <String, List<Folder>>{};
+    var nonWorkspaceResolutionFolders = <Folder>[];
+    _sortIncludedFoldersIntoWorkspaceResolutions(
+      includedFolders,
+      defaultOptionsFile,
+      defaultPackagesFile,
+      nonWorkspaceResolutionFolders,
+      workspaceResolutionRootMap,
+    );
+
     var roots = <ContextRootImpl>[];
-    for (Folder folder in includedFolders) {
+    for (var workspaceResolution in workspaceResolutionRootMap.entries) {
+      var workspaceRootFolder = resourceProvider.getFolder(
+        workspaceResolution.key,
+      );
+      var location = _contextRootLocation(
+        workspaceRootFolder,
+        defaultOptionsFile: defaultOptionsFile,
+        defaultPackagesFile: defaultPackagesFile,
+        defaultRootFolder: () => workspaceRootFolder,
+      );
+
+      ContextRootImpl root = _createContextRoot(
+        roots,
+        rootFolder: workspaceRootFolder,
+        workspace: location.workspace,
+        optionsFile: location.optionsFile,
+        packagesFile: location.packagesFile,
+      );
+
+      var rootEnabledLegacyPlugins = _getEnabledLegacyPlugins(
+        location.workspace,
+        location.optionsFile,
+      );
+
+      Set<String> visited = {};
+      bool usedRoot = false;
+
+      for (var folder in workspaceResolution.value) {
+        if (!root.isAnalyzed(folder.path)) {
+          root.included.add(folder);
+        }
+
+        usedRoot |= _createContextRoots(
+          roots,
+          visited,
+          folder,
+          excludedFolders,
+          root,
+          rootEnabledLegacyPlugins,
+          root.excludedGlobs,
+          defaultOptionsFile,
+          defaultPackagesFile,
+        );
+      }
+      if (!usedRoot) {
+        // If all included folders under this workspace resolution ended up
+        // creating new contexts remove the (not used) root.
+        roots.remove(root);
+      }
+    }
+
+    for (Folder folder in nonWorkspaceResolutionFolders) {
       var location = _contextRootLocation(
         folder,
         defaultOptionsFile: defaultOptionsFile,
@@ -315,7 +377,10 @@ class ContextLocatorImpl {
   /// For each directory within the given [folder] that is neither in the list
   /// of [excludedFolders] nor excluded by the [excludedGlobs], recursively
   /// search for nested context roots.
-  void _createContextRoots(
+  ///
+  /// Returns true if the folder was contained in the root and did not create a
+  /// new root, false if it did create a new root.
+  bool _createContextRoots(
     List<ContextRoot> roots,
     Set<String> visited,
     Folder folder,
@@ -353,6 +418,8 @@ class ContextLocatorImpl {
           localEnabledPlugins,
         );
 
+    bool usedThisRoot = true;
+
     // Create a context root for the given [folder] if a packages or build file
     // is locally specified, or the set of enabled legacy plugins changed.
     if (pluginsDiffer || localPackagesFile != null || buildGnFile != null) {
@@ -391,6 +458,7 @@ class ContextLocatorImpl {
       containingRootEnabledLegacyPlugins = localEnabledPlugins;
       excludedGlobs = _getExcludedGlobs(root.optionsFile, workspace);
       root.excludedGlobs = excludedGlobs;
+      usedThisRoot = false;
     }
 
     if (localOptionsFile != null) {
@@ -414,6 +482,8 @@ class ContextLocatorImpl {
       optionsFile,
       packagesFile,
     );
+
+    return usedThisRoot;
   }
 
   /// For each directory within the given [folder] that is neither in the list
@@ -647,6 +717,47 @@ class ContextLocatorImpl {
     return null;
   }
 
+  /// Load the `workspace` paths from the pubspec file in the given [root].
+  ///
+  /// From https://dart.dev/tools/pub/workspaces a root folder pubspec file will
+  /// look like this:
+  ///
+  /// ```
+  /// name: _
+  /// publish_to: none
+  /// environment:
+  ///   sdk: ^3.6.0
+  /// workspace:
+  ///   - packages/helper
+  ///   - packages/client_package
+  ///   - packages/server_package
+  /// ```
+  ///
+  /// This loads the paths from the `workspace` entry and return them as
+  /// Folders if they exist as folders in the filesystem.
+  Set<Folder> _loadWorkspaceDetailsFromPubspec(String root) {
+    var result = <Folder>{};
+    var rootFolder = resourceProvider.getFolder(root);
+    var rootPubspecFile = rootFolder.getChildAssumingFile(
+      file_paths.pubspecYaml,
+    );
+    if (rootPubspecFile.exists) {
+      var rootPubspec = Pubspec.parse(rootPubspecFile.readAsStringSync());
+      var workspace = rootPubspec.workspace;
+      if (workspace != null) {
+        for (var entry in workspace) {
+          if (entry.text case var relativePath?) {
+            var child = rootFolder.getChild(relativePath);
+            if (child.exists && child is Folder) {
+              result.add(child);
+            }
+          }
+        }
+      }
+    }
+    return result;
+  }
+
   /// Add to the given lists of [folders] and [files] all of the resources in
   /// the given list of [paths] that exist and are not contained within one of
   /// the folders.
@@ -667,6 +778,65 @@ class ContextLocatorImpl {
     }
   }
 
+  /// Sorts [includedFolders] into either pub workspace resolution or not.
+  ///
+  /// For each [Folder] in [includedFolders] sort into either
+  /// [nonWorkspaceResolutionFolders] or [workspaceResolutionRootMap] depending
+  /// on `pubspec.yaml` specifications.
+  ///
+  /// Folders with `pubspec.yaml` files with a `resolution: workspace` setting
+  /// that matches a root-folders `pubspec.yaml` files `workspace` list is
+  /// sorted into the [workspaceResolutionRootMap] map. Other folders end up in
+  /// [nonWorkspaceResolutionFolders].
+  void _sortIncludedFoldersIntoWorkspaceResolutions(
+    List<Folder> includedFolders,
+    File? defaultOptionsFile,
+    File? defaultPackagesFile,
+    List<Folder> nonWorkspaceResolutionFolders,
+    Map<String, List<Folder>> workspaceResolutionRootMap,
+  ) {
+    var rootWorkspaceSpecification = <String, Set<Folder>>{};
+    for (Folder folder in includedFolders) {
+      var location = _contextRootLocation(
+        folder,
+        defaultOptionsFile: defaultOptionsFile,
+        defaultPackagesFile: defaultPackagesFile,
+        defaultRootFolder: () => folder,
+      );
+
+      var addedToWorkspace = false;
+
+      if (folder.path == location.workspace.root) {
+        // If opening the root don't try to do anything special.
+        var known = rootWorkspaceSpecification[location.workspace.root] ??= {};
+        known.clear();
+        nonWorkspaceResolutionFolders.addAll(
+          workspaceResolutionRootMap[location.workspace.root] ?? [],
+        );
+      } else {
+        var pubspecFile = folder.getChildAssumingFile(file_paths.pubspecYaml);
+        if (pubspecFile.exists) {
+          var pubspec = Pubspec.parse(pubspecFile.readAsStringSync());
+          var resolution = pubspec.resolution;
+          if (resolution != null && resolution.value.text == 'workspace') {
+            var known =
+                rootWorkspaceSpecification[location.workspace.root] ??=
+                    _loadWorkspaceDetailsFromPubspec(location.workspace.root);
+            if (known.contains(folder)) {
+              (workspaceResolutionRootMap[location.workspace.root] ??= []).add(
+                folder,
+              );
+              addedToWorkspace = true;
+            }
+          }
+        }
+      }
+      if (!addedToWorkspace) {
+        nonWorkspaceResolutionFolders.add(folder);
+      }
+    }
+  }
+
   /// Return a list of paths that contains all of the unique elements from the
   /// given list of [paths], sorted such that shorter paths are first.
   List<String> _uniqueSortedPaths(List<String> paths) {

pkg/analyzer/lib/src/lint/pub.dart

@@ -188,8 +188,12 @@ abstract class Pubspec {
 
   PubspecEntry? get repository;
 
+  PubspecEntry? get resolution;
+
   PubspecEntry? get version;
 
+  PubspecNodeList? get workspace;
+
   void accept(PubspecVisitor visitor);
 }
 
@@ -226,6 +230,9 @@ class _Pubspec implements Pubspec {
   @override
   final PubspecNodeList? authors;
 
+  @override
+  final PubspecNodeList? workspace;
+
   @override
   final PubspecEntry? description;
 
@@ -247,6 +254,9 @@ class _Pubspec implements Pubspec {
   @override
   final PubspecEntry? repository;
 
+  @override
+  final PubspecEntry? resolution;
+
   @override
   final PubspecEntry? version;
 
@@ -266,13 +276,15 @@ class _Pubspec implements Pubspec {
 
     PubspecEntry? author;
     PubspecNodeList? authors;
+    PubspecNodeList? workspace;
     PubspecEntry? description;
     PubspecEntry? documentation;
     PubspecEnvironment? environment;
     PubspecEntry? homepage;
     PubspecEntry? issueTracker;
     PubspecEntry? name;
     PubspecEntry? repository;
+    PubspecEntry? resolution;
     PubspecEntry? version;
     PubspecDependencyList? dependencies;
     PubspecDependencyList? devDependencies;
@@ -310,6 +322,10 @@ class _Pubspec implements Pubspec {
           environment = _processEnvironment(key, v, resourceProvider);
         case 'version':
           version = _processScalar(key, v, resourceProvider);
+        case 'resolution':
+          resolution = _processScalar(key, v, resourceProvider);
+        case 'workspace':
+          workspace = _processScalarList(key, v, resourceProvider);
       }
     });
 
@@ -327,12 +343,15 @@ class _Pubspec implements Pubspec {
       dependencies: dependencies,
       devDependencies: devDependencies,
       dependencyOverrides: dependencyOverrides,
+      resolution: resolution,
+      workspace: workspace,
     );
   }
 
   _Pubspec._({
     this.author,
     this.authors,
+    this.workspace,
     this.description,
     this.documentation,
     this.environment,
@@ -344,6 +363,7 @@ class _Pubspec implements Pubspec {
     this.dependencies,
     this.devDependencies,
     this.dependencyOverrides,
+    this.resolution,
   });
 
   @override