dartdev: flip AOT flag for analysis-server-based commands

Work towards #50498

Work towards #53576

Change-Id: Idc34d6e1f0b0107391d26d0b531329fbc9645a00
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/435445
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Siva Annamalai <[email protected]>

Author: srawlins

CHANGELOG.md

@@ -16,10 +16,31 @@ constraint][language version] lower bound to 3.9 or greater (`sdk: '^3.9.0'`).
 
 #### Analyzer
 
+- The [dart command-line tool][] commands that use the analysis server now run
+  the AOT-compiled analysis server snapshot. These include `dart analyze`,
+  `dart fix`, and `dart language-server`.
+
+  There is no functional difference when using the AOT-compiled analysis server
+  snapshot. But various tests indicate that there is a significant speedup in
+  the time to analyze a project.
+
+  In case of an incompatibility with the AOT-compiled snapshot, a
+  `--no-use-aot-snapshot` flag may be passed to these commands. (Please file an
+  issue with the appropriate project if you find that you need to use this
+  flag! It will be removed in the future.) This flag directs the tool to revert
+  to the old behavior, using the JIT-compiled analysis server snapshot. To
+  direct the Dart Code plugin for VS Code to pass this flag, use the
+  [`dart.analyzerAdditionalArgs`][vs-code-args] setting. To direct the Dart
+  IntelliJ plugin to pass this flag, use the `dart.server.additional.arguments`
+  registry property, similar to [these steps][intellij-args].
+
 - Add the [`switch_on_type`][] lint rule.
 - Add the [`unnecessary_unawaited`][] lint rule.
 - Add an assist to convert a field formal parameter to a normal parameter.
 
+[dart command-line tool]: https://dart.dev/tools/dart-tool
+[vs-code-args]: https://dartcode.org/docs/settings/#dartanalyzeradditionalargs
+[intellij-args]: https://github.com/dart-lang/sdk/blob/main/pkg/analysis_server/doc/tutorial/instrumentation.md#intellij-idea-and-android-studio
 [`switch_on_type`]: http://dart.dev/lints/switch_on_type
 [`unnecessary_unawaited`]: http://dart.dev/lints/unnecessary_unawaited
 

pkg/dartdev/lib/src/commands/analyze.dart

@@ -93,6 +93,7 @@ class AnalyzeCommand extends DartdevCommand {
       ..addFlag(
         useAotSnapshotFlag,
         help: 'Use the AOT analysis server snapshot',
+        defaultsTo: true,
         hide: true,
       )
       ..addExperimentalFlags();
@@ -124,7 +125,7 @@ class AnalyzeCommand extends DartdevCommand {
       }
     }
 
-    /// Errors in analysis_options and pubspec.yaml will be reported first
+    /// Errors in analysis_options.yaml and pubspec.yaml will be reported first
     /// and a note that they might be the cause of other errors.
     final List<AnalysisError> priorityErrors = <AnalysisError>[];
     final List<AnalysisError> errors = <AnalysisError>[];

pkg/dartdev/lib/src/commands/fix.dart

@@ -64,6 +64,7 @@ To use the tool, run either ['dart fix --dry-run'] for a preview of the proposed
       ..addFlag(
         useAotSnapshotFlag,
         help: 'Use the AOT analysis server snapshot',
+        defaultsTo: true,
         hide: true,
       )
       ..addExperimentalFlags(verbose: verbose);

pkg/dartdev/lib/src/commands/language_server.dart

@@ -36,7 +36,9 @@ For more information about the server's capabilities and configuration, see:
       includeHelpFlag: false,
       defaultToLsp: true,
     )..addFlag(useAotSnapshotFlag,
-        help: 'Use the AOT analysis server snapshot', hide: true);
+        help: 'Use the AOT analysis server snapshot',
+        defaultsTo: true,
+        hide: true);
   }
 
   @override
@@ -61,6 +63,8 @@ For more information about the server's capabilities and configuration, see:
           useExecProcess: true,
         );
       } else {
+        args = [...args];
+        args.remove('--no-$useAotSnapshotFlag');
         VmInteropHandler.run(
           sdk.analysisServerSnapshot,
           args,

pkg/dartdev/test/commands/analyze_test.dart

@@ -826,6 +826,30 @@ warning - analysis_options.yaml:1:10 - The include file 'package:lints/recommend
       });
     });
   });
+
+  group('AOT snapshot', () {
+    test('--use-aot-snapshot', () async {
+      p = project(mainSrc: 'int get foo => 1;\n');
+
+      var result =
+          await p.runAnalyze(['--use-aot-snapshot'], workingDir: p.dirPath);
+
+      expect(result.exitCode, 0);
+      expect(result.stderr, isEmpty);
+      expect(result.stdout, contains('No issues found!'));
+    });
+
+    test('--no-use-aot-snapshot', () async {
+      p = project(mainSrc: 'int get foo => 1;\n');
+
+      var result =
+          await p.runAnalyze(['--no-use-aot-snapshot'], workingDir: p.dirPath);
+
+      expect(result.exitCode, 0);
+      expect(result.stderr, isEmpty);
+      expect(result.stdout, contains('No issues found!'));
+    });
+  });
 }
 
 class TestLogger implements Logger {

pkg/dartdev/test/commands/fix_test.dart

@@ -627,6 +627,41 @@ linter:
             '2 fixes made in 1 file.',
           ]));
     });
+
+    group('AOT mode', () {
+      test('--use-aot-snapshot', () async {
+        p = project(
+          mainSrc: 'String a() => "";',
+          analysisOptions: '''
+linter:
+  rules:
+    - prefer_single_quotes
+''',
+        );
+        var result = await p!.runFix(['--use-aot-snapshot', '--dry-run', '.'],
+            workingDir: p!.dirPath);
+        expect(result.exitCode, 0);
+        expect(result.stderr, isEmpty);
+        expect(result.stdout, contains('1 proposed fix in 1 file.'));
+      });
+
+      test('--no-use-aot-snapshot', () async {
+        p = project(
+          mainSrc: 'String a() => "";',
+          analysisOptions: '''
+linter:
+  rules:
+    - prefer_single_quotes
+''',
+        );
+        var result = await p!.runFix(
+            ['--no-use-aot-snapshot', '--dry-run', '.'],
+            workingDir: p!.dirPath);
+        expect(result.exitCode, 0);
+        expect(result.stderr, isEmpty);
+        expect(result.stdout, contains('1 proposed fix in 1 file.'));
+      });
+    });
   });
 
   group('regression', () {

pkg/dartdev/test/commands/language_server_test.dart

@@ -73,6 +73,14 @@ void defineLanguageServerTests() {
     return runWithLsp(['language-server', '--protocol=lsp']);
   });
 
+  test('--use-aot-snapshot', () async {
+    return runWithLsp(['language-server', '--use-aot-snapshot']);
+  });
+
+  test('--no-use-aot-snapshot', () async {
+    return runWithLsp(['language-server', '--no-use-aot-snapshot']);
+  });
+
   test('protocol analyzer', () async {
     project = utils.project();