Reland "options map support scaffolding in driver" (with a re-introduced optional analysisOptions param)

This is a reland of commit 717ce7a with a slight modification to `AnalysisDriver` to allow Google3 clients to pass an analysisOptions object in.

The logic to accommodate this is only temporary and will go away as soon as I can update clients to use an options map instead.




Original change's description:
> options map support scaffolding in driver
>
> Konstantin and I chatted a bit about this so at least some of it shouldn't be too surprising to him but please do feel free to grab me to chat.
>
> That said a few pointers would be handy. Notably, this change:
>
> * introduces a new `SharedOptionsOptionsMap` for use in SDK drivers (and preserve current semantics)
>   * this is currently public but will be private once driver is more evolved to accommodate multiple options files
> * removes the shared `_analysisOptions` from the analysis driver with a baby step to using the one shared in SharedOptionsOptionsMap
> * removes context_builder and collection v2 experiments (and tests)
>   * I'll harvest some more functionality from these in future changes but for now they're distracting and hard to maintain
>
> This work is all to setup moving analysis options awareness into file state objects which will allow us to remove `sdkVersionConstraint` info from options (finally) and a host of other good stuff (see #54124).
>
>
>
> Change-Id: Ic4278184016d1018b4b5b1c6ac5ba9e2546927a5
> Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/344860
> Reviewed-by: Brian Wilkerson <[email protected]>
> Reviewed-by: Konstantin Shcheglov <[email protected]>
> Commit-Queue: Phil Quitslund <[email protected]>

Change-Id: Iac9c4eb1aa448f2ca44e32dfb6cdf7cf765b6027
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/344944
Reviewed-by: Konstantin Shcheglov <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Phil Quitslund <[email protected]>

Author: pq

pkg/analyzer/lib/dart/sdk/build_sdk_summary.dart

@@ -6,6 +6,7 @@ import 'dart:typed_data';
 
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/context/packages.dart';
+import 'package:analyzer/src/dart/analysis/analysis_options_map.dart';
 import 'package:analyzer/src/dart/analysis/byte_store.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
 import 'package:analyzer/src/dart/analysis/performance_logger.dart';
@@ -49,6 +50,7 @@ Future<Uint8List> buildSdkSummary({
 
   final logger = PerformanceLog(StringBuffer());
   final scheduler = AnalysisDriverScheduler(logger);
+  final optionsMap = AnalysisOptionsMap.forSharedOptions(AnalysisOptionsImpl());
   final analysisDriver = AnalysisDriver(
     scheduler: scheduler,
     logger: logger,
@@ -57,7 +59,7 @@ Future<Uint8List> buildSdkSummary({
     sourceFactory: SourceFactory([
       DartUriResolver(sdk),
     ]),
-    analysisOptions: AnalysisOptionsImpl(),
+    analysisOptionsMap: optionsMap,
     packages: Packages({}),
   );
   scheduler.start();

pkg/analyzer/lib/src/clients/build_resolvers/build_resolvers.dart

@@ -8,6 +8,7 @@ import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/dart/analysis/session.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/context/packages.dart';
+import 'package:analyzer/src/dart/analysis/analysis_options_map.dart';
 import 'package:analyzer/src/dart/analysis/byte_store.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
 import 'package:analyzer/src/dart/analysis/performance_logger.dart';
@@ -53,13 +54,15 @@ AnalysisDriverForPackageBuild createAnalysisDriver({
 
   var logger = PerformanceLog(null);
   var scheduler = AnalysisDriverScheduler(logger);
+  var sharedOptions = analysisOptions as AnalysisOptionsImpl;
+  var optionsMap = AnalysisOptionsMap.forSharedOptions(sharedOptions);
   var driver = AnalysisDriver(
     scheduler: scheduler,
     logger: logger,
     resourceProvider: resourceProvider,
     byteStore: byteStore ?? MemoryByteStore(),
     sourceFactory: sourceFactory,
-    analysisOptions: analysisOptions as AnalysisOptionsImpl,
+    analysisOptionsMap: optionsMap,
     externalSummaries: dataStore,
     packages: packages,
   );

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

@@ -2,29 +2,61 @@
 // 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.
 
-import 'package:analyzer/dart/analysis/analysis_options.dart';
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/src/clients/build_resolvers/build_resolvers.dart';
 
-/// Instances of the class [AnalysisOptionsMap] map [File]s under analysis to their
-/// corresponding [AnalysisOptions].
+/// Instances of the class [AnalysisOptionsMap] map [File]s under analysis to
+/// their corresponding [AnalysisOptions].
 class AnalysisOptionsMap {
-  // TODO(pq): final backing representation TBD.
-  final List<({Folder folder, AnalysisOptions options})> _entries = [];
+  final List<OptionsMapEntry> entries = [];
+
+  /// Create an empty [AnalysisOptionsMap] instance.
+  AnalysisOptionsMap();
 
   /// Map this [folder] to the given [options].
   void add(Folder folder, AnalysisOptions options) {
-    _entries.add((folder: folder, options: options));
+    entries.add(OptionsMapEntry(folder, options));
     // Sort entries by (reverse) containment (for now).
-    _entries.sort((e1, e2) => e1.folder.contains(e2.folder.path) ? 1 : -1);
+    entries.sort((e1, e2) => e1.folder.contains(e2.folder.path) ? 1 : -1);
   }
 
   /// Get the [AnalysisOptions] instance for the given [file] (or `null` if none
   /// has been set).
   AnalysisOptions? getOptions(File file) {
-    for (var entry in _entries) {
+    for (var entry in entries) {
       if (entry.folder.contains(file.path)) return entry.options;
     }
 
     return null;
   }
+
+  /// Create an [AnalysisOptionsMap] that holds one set of [sharedOptions] for all
+  /// associated files.
+  // TODO(pq): replace w/ a factory constructor when SharedOptionsOptionsMap is made private
+  static SharedOptionsOptionsMap forSharedOptions(
+          AnalysisOptionsImpl sharedOptions) =>
+      SharedOptionsOptionsMap(sharedOptions);
+}
+
+/// Instances of [OptionsMapEntry] associate [Folder]s with their
+/// corresponding [AnalysisOptions].
+class OptionsMapEntry {
+  /// The folder containing an options file.
+  final Folder folder;
+
+  /// The corresponding options object.
+  final AnalysisOptions options;
+
+  /// Create a new entry for the give [folder] and corresponding [options];
+  OptionsMapEntry(this.folder, this.options);
+}
+
+// TODO(pq): make private when no longer referenced.
+class SharedOptionsOptionsMap extends AnalysisOptionsMap {
+  /// The [entries] list is empty but that's OK. We'll always just return
+  /// the shared options.
+  final AnalysisOptionsImpl sharedOptions;
+  SharedOptionsOptionsMap(this.sharedOptions);
+  @override
+  AnalysisOptions getOptions(File file) => sharedOptions;
 }

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

@@ -11,8 +11,10 @@ import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
 import 'package:analyzer/src/analysis_options/apply_options.dart';
 import 'package:analyzer/src/context/builder.dart' show EmbedderYamlLocator;
 import 'package:analyzer/src/context/packages.dart';
+import 'package:analyzer/src/dart/analysis/analysis_options_map.dart';
 import 'package:analyzer/src/dart/analysis/byte_store.dart'
     show ByteStore, MemoryByteStore;
+import 'package:analyzer/src/dart/analysis/context_root.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart'
     show
         AnalysisDriver,
@@ -128,17 +130,18 @@ class ContextBuilderImpl implements ContextBuilder {
         sdk: sdk,
       );
     }
+    // TODO(pq): replace w/ a map created directly via `_createOptionsMap`
+    var analysisOptionsMap = AnalysisOptionsMap.forSharedOptions(options);
 
     final analysisContext =
         DriverBasedAnalysisContext(resourceProvider, contextRoot);
-
     var driver = AnalysisDriver(
       scheduler: scheduler,
       logger: performanceLog,
       resourceProvider: resourceProvider,
       byteStore: byteStore,
       sourceFactory: sourceFactory,
-      analysisOptions: options,
+      analysisOptionsMap: analysisOptionsMap,
       packages: _createPackageMap(
         contextRoot: contextRoot,
       ),
@@ -165,6 +168,66 @@ class ContextBuilderImpl implements ContextBuilder {
     return analysisContext;
   }
 
+  /// Create an [AnalysisOptionsMap] for the given [contextRoot].
+  // ignore: unused_element
+  AnalysisOptionsMap _createOptionsMap(
+      ContextRoot contextRoot,
+      SourceFactory sourceFactory,
+      @Deprecated("Use 'updateAnalysisOptions2' instead")
+      void Function(AnalysisOptionsImpl p1)? updateAnalysisOptions,
+      void Function(
+              {required AnalysisOptionsImpl analysisOptions,
+              required ContextRoot contextRoot,
+              required DartSdk sdk})?
+          updateAnalysisOptions2,
+      DartSdk sdk) {
+    var map = AnalysisOptionsMap();
+    var provider = AnalysisOptionsProvider(sourceFactory);
+    var pubspecFile = _findPubspecFile(contextRoot);
+
+    void updateOptions(AnalysisOptionsImpl options) {
+      if (pubspecFile != null) {
+        var extractor = SdkConstraintExtractor(pubspecFile);
+        var sdkVersionConstraint = extractor.constraint();
+        if (sdkVersionConstraint != null) {
+          // TODO(pq): remove
+          // ignore: deprecated_member_use_from_same_package
+          options.sdkVersionConstraint = sdkVersionConstraint;
+        }
+      }
+      if (updateAnalysisOptions != null) {
+        updateAnalysisOptions(options);
+      } else if (updateAnalysisOptions2 != null) {
+        updateAnalysisOptions2(
+          analysisOptions: options,
+          contextRoot: contextRoot,
+          sdk: sdk,
+        );
+      }
+    }
+
+    var optionsMappings =
+        (contextRoot as ContextRootImpl).optionsFileMap.entries;
+
+    // If there are no options files, we still want to propagate sdk constraints
+    // and options updates to the context root.
+    if (optionsMappings.isEmpty) {
+      var options = AnalysisOptionsImpl();
+      updateOptions(options);
+      map.add(contextRoot.root, options);
+    } else {
+      for (var entry in optionsMappings) {
+        var options = AnalysisOptionsImpl();
+        var optionsYaml = provider.getOptionsFromFile(entry.value);
+        options.applyOptions(optionsYaml);
+        updateOptions(options);
+        map.add(entry.key, options);
+      }
+    }
+
+    return map;
+  }
+
   /// Return [Packages] to analyze the [contextRoot].
   ///
   // TODO(scheglov): Get [Packages] from [Workspace]?