analyzer: Move enableTiming out of AnalysisOptionsImpl to AnalysisDriver.

It has seemed disingenuous to me that `enableTiming` has been a
property of AnalysisOptionsImpl, when it cannot be specified in an
analysis options file. Additionally, it is used in exactly _one_
place: the linter package's `benchmark.dart` script.

Instead, it makes more sense to think of this "flag" as a process-wide
flag. It is not something that may be set one way for some files, and
another for another set of files. And it is not something that can be
set to one value early during an analysis process, and then change; it
never changes.

So instead this change makes it a _final_, _private_ field on
AnalysisDriver, and on LibraryAnalyzer. LibraryAnalyzer gets its value
from AnalysisDriver, and AnalysisDriver gets its value from the
AnalysisContextCollectionImpl constructor.

Change-Id: I347605775680a8ea1c1237f0ee20bd4bbe2c6216
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/393961
Reviewed-by: Phil Quitslund <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>

Author: srawlins

pkg/analysis_server/lib/src/services/correction/bulk_fix_processor.dart

@@ -550,7 +550,7 @@ class BulkFixProcessor {
     LintRuleUnitContext currentUnit,
     List<LintRuleUnitContext> allUnits,
   ) {
-    var nodeRegistry = NodeLintRegistry(false);
+    var nodeRegistry = NodeLintRegistry(enableTiming: false);
     var context = LinterContextWithParsedResults(allUnits, currentUnit);
     var lintRules =
         _syntacticLintCodes

pkg/analysis_server_plugin/lib/src/plugin_server.dart

@@ -26,7 +26,6 @@ import 'package:analyzer/src/dart/analysis/byte_store.dart';
 import 'package:analyzer/src/dart/analysis/file_content_cache.dart';
 import 'package:analyzer/src/dart/analysis/session.dart';
 import 'package:analyzer/src/dart/element/type_system.dart';
-import 'package:analyzer/src/lint/analysis_rule_timers.dart';
 import 'package:analyzer/src/lint/linter.dart';
 import 'package:analyzer/src/lint/linter_visitor.dart';
 import 'package:analyzer/src/lint/registry.dart';
@@ -240,8 +239,9 @@ class PluginServer {
         ),
     ];
 
-    var enableTiming = analysisOptions.enableTiming;
-    var nodeRegistry = NodeLintRegistry(enableTiming);
+    // TODO(srawlins): Enable timing similar to what the linter package's
+    // `benchhmark.dart` script does.
+    var nodeRegistry = NodeLintRegistry(enableTiming: false);
 
     var context = LinterContextWithResolvedResults(
       allUnits,
@@ -261,10 +261,9 @@ class PluginServer {
           Registry.ruleRegistry.enabled(configuration.diagnosticConfigs);
       for (var rule in rules) {
         rule.reporter = errorReporter;
-        var timer = enableTiming ? analysisRuleTimers.getTimer(rule) : null;
-        timer?.start();
+        // TODO(srawlins): Enable timing similar to what the linter package's
+        // `benchhmark.dart` script does.
         rule.registerNodeProcessors(nodeRegistry, context);
-        timer?.stop();
       }
     }
 

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

@@ -66,6 +66,7 @@ class AnalysisContextCollectionImpl implements AnalysisContextCollection {
       required DartSdk sdk,
     })? updateAnalysisOptions2,
     MacroSupportFactory? macroSupportFactory,
+    bool enableLintRuleTiming = false,
   }) : resourceProvider =
             resourceProvider ?? PhysicalResourceProvider.INSTANCE {
     sdkPath ??= getSdkPath();
@@ -124,6 +125,7 @@ class AnalysisContextCollectionImpl implements AnalysisContextCollection {
         infoDeclarationStore: infoDeclarationStore,
         macroSupport: macroSupport,
         ownedFiles: ownedFiles,
+        enableLintRuleTiming: enableLintRuleTiming,
       );
       contexts.add(context);
     }

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

@@ -328,9 +328,6 @@ class AnalysisOptionsImpl implements AnalysisOptions {
   @override
   List<PluginConfiguration> pluginConfigurations = [];
 
-  /// Whether timing data should be gathered during execution.
-  bool enableTiming = false;
-
   @override
   final List<ErrorProcessor> errorProcessors;
 

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

@@ -90,6 +90,7 @@ class ContextBuilderImpl {
     InfoDeclarationStore? infoDeclarationStore,
     MacroSupport? macroSupport,
     OwnedFiles? ownedFiles,
+    bool enableLintRuleTiming = false,
   }) {
     byteStore ??= MemoryByteStore();
     performanceLog ??= PerformanceLog(null);
@@ -162,6 +163,7 @@ class ContextBuilderImpl {
       declaredVariables: declaredVariables,
       testView: retainDataForTesting ? AnalysisDriverTestView() : null,
       ownedFiles: ownedFiles,
+      enableLintRuleTiming: enableLintRuleTiming,
     );
 
     // AnalysisDriver reports results into streams.

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

@@ -76,7 +76,7 @@ import 'package:meta/meta.dart';
 /// "analysis state" be either "working" or "idle".
 ///
 /// (These are theoretical constructs; they may not necessarily reflect data
-/// structures maintained explicitly by the driver).
+/// structures maintained explicitly by the driver.)
 ///
 /// Then we make the following guarantees:
 ///
@@ -267,6 +267,9 @@ class AnalysisDriver {
   /// A map that associates files to corresponding analysis options.
   late final AnalysisOptionsMap analysisOptionsMap;
 
+  /// Whether timing data should be gathered during lint rule execution.
+  final bool _enableLintRuleTiming;
+
   /// Create a new instance of [AnalysisDriver].
   ///
   /// The given [SourceFactory] is cloned to ensure that it does not contain a
@@ -293,6 +296,7 @@ class AnalysisDriver {
     DeclaredVariables? declaredVariables,
     bool retainDataForTesting = false,
     this.testView,
+    bool enableLintRuleTiming = false,
   })  : _scheduler = scheduler,
         _resourceProvider = resourceProvider,
         _byteStore = byteStore,
@@ -306,7 +310,8 @@ class AnalysisDriver {
         _sourceFactory = sourceFactory,
         _externalSummaries = externalSummaries,
         declaredVariables = declaredVariables ?? DeclaredVariables(),
-        testingData = retainDataForTesting ? TestingData() : null {
+        testingData = retainDataForTesting ? TestingData() : null,
+        _enableLintRuleTiming = enableLintRuleTiming {
     analysisContext?.driver = this;
     testView?.driver = this;
 
@@ -1400,6 +1405,7 @@ class AnalysisDriver {
           library,
           testingData: testingData,
           typeSystemOperations: typeSystemOperations,
+          enableLintRuleTiming: _enableLintRuleTiming,
         ).analyze();
 
         var isLibraryWithPriorityFile = _isLibraryWithPriorityFile(library);

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

@@ -84,12 +84,21 @@ class LibraryAnalyzer {
   final TestingData? _testingData;
   final TypeSystemOperations _typeSystemOperations;
 
-  LibraryAnalyzer(this._analysisOptions, this._declaredVariables,
-      this._libraryElement, this._inheritance, this._library,
-      {TestingData? testingData,
-      required TypeSystemOperations typeSystemOperations})
-      : _testingData = testingData,
-        _typeSystemOperations = typeSystemOperations {
+  /// Whether timing data should be gathered during lint rule execution.
+  final bool _enableLintRuleTiming;
+
+  LibraryAnalyzer(
+    this._analysisOptions,
+    this._declaredVariables,
+    this._libraryElement,
+    this._inheritance,
+    this._library, {
+    TestingData? testingData,
+    required TypeSystemOperations typeSystemOperations,
+    bool enableLintRuleTiming = false,
+  })  : _testingData = testingData,
+        _typeSystemOperations = typeSystemOperations,
+        _enableLintRuleTiming = enableLintRuleTiming {
     _libraryVerificationContext = LibraryVerificationContext(
       libraryKind: _library,
       constructorFieldsVerifier: ConstructorFieldsVerifier(
@@ -371,8 +380,7 @@ class LibraryAnalyzer {
     var allUnits = analysesToContextUnits.values.toList();
     definingContextUnit ??= allUnits.first;
 
-    var enableTiming = _analysisOptions.enableTiming;
-    var nodeRegistry = NodeLintRegistry(enableTiming);
+    var nodeRegistry = NodeLintRegistry(enableTiming: _enableLintRuleTiming);
     var context = LinterContextWithResolvedResults(
       allUnits,
       definingContextUnit,
@@ -383,7 +391,8 @@ class LibraryAnalyzer {
     );
 
     for (var linter in _analysisOptions.lintRules) {
-      var timer = enableTiming ? analysisRuleTimers.getTimer(linter) : null;
+      var timer =
+          _enableLintRuleTiming ? analysisRuleTimers.getTimer(linter) : null;
       timer?.start();
       linter.registerNodeProcessors(nodeRegistry, context);
       timer?.stop();

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

@@ -1096,7 +1096,7 @@ class AnalysisRuleVisitor implements AstVisitor<void> {
 
 /// The container to register visitors for separate AST node types.
 class NodeLintRegistry {
-  final bool enableTiming;
+  final bool _enableTiming;
   final List<_AfterLibrarySubscription> _afterLibrary = [];
   final List<_Subscription<AdjacentStrings>> _forAdjacentStrings = [];
   final List<_Subscription<Annotation>> _forAnnotation = [];
@@ -1307,7 +1307,7 @@ class NodeLintRegistry {
   final List<_Subscription<WithClause>> _forWithClause = [];
   final List<_Subscription<YieldStatement>> _forYieldStatement = [];
 
-  NodeLintRegistry(this.enableTiming);
+  NodeLintRegistry({required bool enableTiming}) : _enableTiming = enableTiming;
 
   void addAdjacentStrings(AnalysisRule rule, AstVisitor visitor) {
     _forAdjacentStrings.add(_Subscription(rule, visitor, _getTimer(rule)));
@@ -2019,7 +2019,7 @@ class NodeLintRegistry {
 
   /// Get the timer associated with the given [rule].
   Stopwatch? _getTimer(AnalysisRule rule) {
-    if (enableTiming) {
+    if (_enableTiming) {
       return analysisRuleTimers.getTimer(rule);
     } else {
       return null;

pkg/analyzer/test/src/dart/analysis/context_builder_test.dart

@@ -198,7 +198,6 @@ class ContextBuilderImplTest with ResourceProviderMixin {
     AnalysisOptionsImpl expected,
   ) {
     // TODO(brianwilkerson): Consider moving this to AnalysisOptionsImpl.==.
-    expect(actual.enableTiming, expected.enableTiming);
     expect(actual.lint, expected.lint);
     expect(actual.warning, expected.warning);
     expect(

pkg/linter/lib/src/test_utilities/lint_driver.dart

@@ -31,33 +31,31 @@ class LintDriver {
   Future<List<AnalysisErrorInfo>> analyze(Iterable<io.File> files) async {
     AnalysisEngine.instance.instrumentationService = _StdInstrumentation();
 
+    var filesPaths =
+        files.map((file) => _absoluteNormalizedPath(file.path)).toList();
+
     var contextCollection = AnalysisContextCollectionImpl(
       resourceProvider: _resourceProvider,
       sdkPath: options.dartSdkPath,
-      includedPaths:
-          files.map((file) => _absoluteNormalizedPath(file.path)).toList(),
+      includedPaths: filesPaths,
       updateAnalysisOptions2: ({
         required analysisOptions,
         required contextRoot,
         required sdk,
       }) {
         analysisOptions.lint = true;
         analysisOptions.warning = false;
-        analysisOptions.enableTiming = options.enableTiming;
         analysisOptions.lintRules =
             options.enabledRules.toList(growable: false);
       },
+      enableLintRuleTiming: options.enableTiming,
     );
 
-    for (io.File file in files) {
-      var path = _absoluteNormalizedPath(file.path);
-      _filesAnalyzed.add(path);
-    }
+    _filesAnalyzed.addAll(filesPaths);
 
     var result = <AnalysisErrorInfo>[];
     for (var path in _filesAnalyzed) {
-      var analysisContext = contextCollection.contextFor(path);
-      var analysisSession = analysisContext.currentSession;
+      var analysisSession = contextCollection.contextFor(path).currentSession;
       var errorsResult = await analysisSession.getErrors(path);
       if (errorsResult is ErrorsResult) {
         result.add(