Add package root support to analysis server.

pkg/analysis_server/lib/src/context_manager.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library context.directory.manager;
 
 import 'dart:async';
 import 'dart:collection';
 
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/source/package_map_provider.dart';
+import 'package:analyzer/source/package_map_resolver.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/source.dart';
+import 'package:analyzer/src/generated/source_io.dart';
+import 'package:analyzer/src/generated/java_io.dart';
 import 'package:path/path.dart' as pathos;
 import 'package:watcher/watcher.dart';
 
 
 /**
  * File name of pubspec files.
  */
 const String PUBSPEC_NAME = 'pubspec.yaml';
 
 
@@ skipping 32 matching lines @@
 
   /**
    * The list of included paths (folders and files) most recently passed to
    * [setRoots].
    */
   List<String> includedPaths = <String>[];
 
   /**
    * The map of package roots most recently passed to [setRoots].
    */
   Map<String, String> packageRoots = <String, String>{};

[scheglov, 2014/10/24 18:45:18]

Are we going to use it?
Should we just use it instead of normalizedPackageRoots?

[Paul Berry, 2014/10/24 20:26:49]

We do use it, in refresh().
I'm not sure.  I'm planning to follow up with some additional cleanups; I'll
keep it in mind.

 
   /**
+   * Same as [packageRoots], except that source folders have been normalized
+   * and non-folders have been removed.
+   */
+  Map<String, String> normalizedPackageRoots = <String, String>{};
+
+  /**
    * Provider which is used to determine the mapping from package name to
    * package folder.
    */
-  final PackageMapProvider packageMapProvider;
+  final PackageMapProvider _packageMapProvider;
 
-  ContextManager(this.resourceProvider, this.packageMapProvider) {
+  ContextManager(this.resourceProvider, this._packageMapProvider) {
     pathContext = resourceProvider.pathContext;
   }
 
   /**
    * Called when a new context needs to be created.
    */
-  void addContext(Folder folder, Map<String, List<Folder>> packageMap);
+  void addContext(Folder folder, UriResolver packageUriResolver);
 
   /**
    * Called when the set of files associated with a context have changed (or
    * some of those files have been modified).  [changeSet] is the set of
    * changes that need to be applied to the context.
    */
   void applyChangesToContext(Folder contextFolder, ChangeSet changeSet);
 
   /**
    * Returns `true` if the given absolute [path] is in one of the current
@@ skipping 31 matching lines @@
     // Rebuild contexts based on the data last sent to setRoots().
     setRoots(includedPaths, excludedPaths, packageRoots);
   }
 
   /**
    * Change the set of paths which should be used as starting points to
    * determine the context directories.
    */
   void setRoots(List<String> includedPaths, List<String> excludedPaths,
       Map<String, String> packageRoots) {
-    // TODO(paulberry): process package roots.
     this.packageRoots = packageRoots;
+
+    // Normalize all package root sources by mapping them to folders on the
+    // filesystem.  Ignore any package root sources that aren't folders.
+    normalizedPackageRoots = <String, String>{};
+    packageRoots.forEach((String sourcePath, String targetPath) {
+      Resource resource = resourceProvider.getResource(sourcePath);
+      if (resource is Folder) {
+        normalizedPackageRoots[resource.path] = targetPath;
+      }
+    });
+
     List<Folder> contextFolders = _contexts.keys.toList();
     // included
     Set<Folder> includedFolders = new HashSet<Folder>();
     for (int i = 0; i < includedPaths.length; i++) {
       String path = includedPaths[i];
       Resource resource = resourceProvider.getResource(path);
       if (resource is Folder) {
         includedFolders.add(resource);
       } else {
         // TODO(scheglov) implemented separate files analysis
         throw new UnimplementedError(
             '$path is not a folder. '
                 'Only support for folder analysis is implemented currently.');
       }
     }
     this.includedPaths = includedPaths;
     // excluded
     List<String> oldExcludedPaths = this.excludedPaths;
     this.excludedPaths = excludedPaths;
     // destroy old contexts
     for (Folder contextFolder in contextFolders) {
       bool isIncluded = includedFolders.any((folder) {
         return folder.isOrContains(contextFolder.path);
       });
       if (!isIncluded) {
         _destroyContext(contextFolder);
       }
     }
+    // Update package roots for existing contexts
+    _contexts.forEach((Folder folder, _ContextInfo info) {
+      String newPackageRoot = normalizedPackageRoots[folder.path];
+      if (info.packageRoot != newPackageRoot) {
+        info.packageRoot = newPackageRoot;
+        _recomputePackageUriResolver(info);
+      }
+    });
     // create new contexts
     for (Folder includedFolder in includedFolders) {
       bool wasIncluded = contextFolders.any((folder) {
         return folder.isOrContains(includedFolder.path);
       });
       if (!wasIncluded) {
         _createContexts(includedFolder, false);
       }
     }
     // remove newly excluded sources
@@ skipping 18 matching lines @@
     _contexts.forEach((folder, info) {
       ChangeSet changeSet = new ChangeSet();
       _addPreviouslyExcludedSources(info, changeSet, folder, oldExcludedPaths);
       applyChangesToContext(folder, changeSet);
     });
   }
 
   /**
    * Called when the package map for a context has changed.
    */
-  void updateContextPackageMap(Folder contextFolder, Map<String,
-      List<Folder>> packageMap);
+  void updateContextPackageUriResolver(Folder contextFolder,
+                                       UriResolver packageUriResolver);
 
   /**
    * Resursively adds all Dart and HTML files to the [changeSet].
    */
   void _addPreviouslyExcludedSources(_ContextInfo info, ChangeSet changeSet,
       Folder folder, List<String> oldExcludedPaths) {
     if (info.excludesResource(folder)) {
       return;
     }
     List<Resource> children = folder.getChildren();
@@ skipping 46 matching lines @@
       } else if (child is Folder) {
         if (child.shortName == PACKAGES_NAME) {
           continue;
         }
         _addSourceFiles(changeSet, child, info);
       }
     }
   }
 
   /**
+   * Compute the appropriate package URI resolver for [folder], and store
+   * dependency information in [info].
+   */
+  UriResolver _computePackageUriResolver(Folder folder, _ContextInfo info) {
+    UriResolver packageUriResolver;
+    if (info.packageRoot != null) {
+      info.packageMapDependencies = new Set<String>();
+      packageUriResolver = new PackageUriResolver(
+          [new JavaFile(info.packageRoot)]);
+    } else {
+      PackageMapInfo packageMapInfo =
+          _packageMapProvider.computePackageMap(folder);
+      info.packageMapDependencies = packageMapInfo.dependencies;
+      packageUriResolver = new PackageMapUriResolver(
+          resourceProvider, packageMapInfo.packageMap);
+      // TODO(paulberry): if any of the dependencies is outside of [folder],
+      // we'll need to watch their parent folders as well.
+    }
+    return packageUriResolver;
+  }
+
+  /**
    * Create a new empty context associated with [folder].
    */
   _ContextInfo _createContext(Folder folder, List<_ContextInfo> children) {
-    _ContextInfo info = new _ContextInfo(folder, children);
+    _ContextInfo info = new _ContextInfo(folder, children,
+        normalizedPackageRoots[folder.path]);
     _contexts[folder] = info;
     info.changeSubscription = folder.changes.listen((WatchEvent event) {
       _handleWatchEvent(folder, info, event);
     });
-    PackageMapInfo packageMapInfo =
-        packageMapProvider.computePackageMap(folder);
-    info.packageMapDependencies = packageMapInfo.dependencies;
-    // TODO(paulberry): if any of the dependencies is outside of [folder],
-    // we'll need to watch their parent folders as well.
-    addContext(folder, packageMapInfo.packageMap);
+    UriResolver packageUriResolver = _computePackageUriResolver(folder, info);
+    addContext(folder, packageUriResolver);
     return info;
   }
 
   /**
    * Create a new context associated with [folder] and fills its with sources.
    */
   _ContextInfo _createContextWithSources(Folder folder,
       List<_ContextInfo> children) {
     _ContextInfo info = _createContext(folder, children);
     ChangeSet changeSet = new ChangeSet();
@@ skipping 139 matching lines @@
         Source source = info.sources[path];
         if (source != null) {
           ChangeSet changeSet = new ChangeSet();
           changeSet.changedSource(source);
           applyChangesToContext(folder, changeSet);
         }
         break;
     }
 
     if (info.packageMapDependencies.contains(path)) {
-      // TODO(paulberry): when computePackageMap is changed into an
-      // asynchronous API call, we'll want to suspend analysis for this context
-      // while we're rerunning "pub list", since any analysis we complete while
-      // "pub list" is in progress is just going to get thrown away anyhow.
-      PackageMapInfo packageMapInfo =
-          packageMapProvider.computePackageMap(folder);
-      info.packageMapDependencies = packageMapInfo.dependencies;
-      updateContextPackageMap(folder, packageMapInfo.packageMap);
+      _recomputePackageUriResolver(info);
     }
   }
 
   /**
    * Returns `true` if the given [path] is excluded by [excludedPaths].
    */
   bool _isExcluded(String path) {
     return _isExcludedBy(excludedPaths, path);
   }
 
@@ skipping 38 matching lines @@
       parentInfo.children.remove(info);
       ChangeSet changeSet = new ChangeSet();
       info.sources.forEach((path, source) {
         parentInfo.sources[path] = source;
         changeSet.addedSource(source);
       });
       applyChangesToContext(parentInfo.folder, changeSet);
     }
   }
 
+  /**
+   * Recompute the package URI resolver for the context described by [info],
+   * and update the client appropriately.
+   */
+  void _recomputePackageUriResolver(_ContextInfo info) {
+    // TODO(paulberry): when computePackageMap is changed into an
+    // asynchronous API call, we'll want to suspend analysis for this context
+    // while we're rerunning "pub list", since any analysis we complete while
+    // "pub list" is in progress is just going to get thrown away anyhow.
+    UriResolver packageUriResolver =
+        _computePackageUriResolver(info.folder, info);
+    updateContextPackageUriResolver(info.folder, packageUriResolver);
+  }
+
   static bool _shouldFileBeAnalyzed(File file) {
     if (!(AnalysisEngine.isDartFileName(file.path) ||
         AnalysisEngine.isHtmlFileName(file.path))) {
       return false;
     }
     // Emacs creates dummy links to track the fact that a file is open for
     // editing and has unsaved changes (e.g. having unsaved changes to
     // 'foo.dart' causes a link '.#foo.dart' to be created, which points to the
     // non-existent file 'username@hostname.pid'.  To avoid these dummy links
     // causing the analyzer to thrash, just ignore links to non-existent files.
     return file.exists;
   }
 }
 
 /**
  * Information tracked by the [ContextManager] for each context.
  */
 class _ContextInfo {
   /**
    * The [Folder] for which this information object is created.
    */
   final Folder folder;
 
   /**
    * The enclosed pubspec-based contexts.
    */
   final List<_ContextInfo> children;
 
   /**
+   * The package root for this context, or null if there is no package root.
+   */
+  String packageRoot;
+
+  /**
    * The [_ContextInfo] that encloses this one.
    */
   _ContextInfo parent;
 
   /**
    * The `pubspec.yaml` file path for this context.
    */
   String pubspecPath;
 
   /**
    * Stream subscription we are using to watch the context's directory for
    * changes.
    */
   StreamSubscription<WatchEvent> changeSubscription;
 
   /**
    * Map from full path to the [Source] object, for each source that has been
    * added to the context.
    */
   Map<String, Source> sources = new HashMap<String, Source>();
 
   /**
    * Dependencies of the context's package map.
    * If any of these files changes, the package map needs to be recomputed.
    */
   Set<String> packageMapDependencies;
 
-  _ContextInfo(this.folder, this.children) {
+  _ContextInfo(this.folder, this.children, this.packageRoot) {
     pubspecPath = folder.getChild(PUBSPEC_NAME).path;
     for (_ContextInfo child in children) {
       child.parent = this;
     }
   }
 
   /**
    * Returns `true` if this context is root folder based.
    */
   bool get isRoot => parent == null;
@@ skipping 14 matching lines @@
     return excludes(resource.path);
   }
 
   /**
    * Returns `true` if [path] is the pubspec file of this context.
    */
   bool isPubspec(String path) {
     return path == pubspecPath;
   }
 }