analysis_server: Introduce analysis_server_shared package

With a simple move of two classes, Fix and FixContent.

The class moves are not exactly no-ops. I moved each class into its
own library and made the following changes:

* Start doc comments with third person verbs [1].
* Make `Fix` class **final**.
* Make `FixContext` class **interface**.

[1]: https://dart.dev/effective-dart/documentation#prefer-starting-function-or-method-comments-with-third-person-verbs

Work towards #53402

Cq-Include-Trybots: dart-internal/g3.dart-internal.try:g3-cbuild-try
Change-Id: Ic046b236d634543832825db8746e0abdca5191fe
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/355889
Reviewed-by: Alexander Thomas <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>

Author: srawlins

pkg/analysis_server/lib/plugin/edit/fix/fix_dart.dart

@@ -2,11 +2,11 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/instrumentation/service.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
+import 'package:server_plugin/edit/fix/fix_content.dart';
 
 /// An object used to provide context information for Dart fix contributors.
 ///

pkg/analysis_server/lib/src/cider/fixes.dart

@@ -2,7 +2,6 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/services/correction/change_workspace.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server/src/services/correction/fix_internal.dart';
@@ -16,6 +15,7 @@ import 'package:analyzer/src/dart/analysis/performance_logger.dart';
 import 'package:analyzer/src/dart/micro/resolve_file.dart';
 import 'package:analyzer/src/services/top_level_declarations.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 
 class CiderErrorFixes {
   final AnalysisError error;

pkg/analysis_server/lib/src/g3/fixes.dart

@@ -2,7 +2,6 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/protocol_server.dart' show SourceEdit;
 import 'package:analysis_server/src/services/correction/change_workspace.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
@@ -16,6 +15,7 @@ import 'package:analyzer/instrumentation/service.dart';
 import 'package:analyzer/src/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/src/dart/error/lint_codes.dart';
 import 'package:collection/collection.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 
 /// The root of a set of classes that support testing for lint fixes.
 ///

pkg/analysis_server/lib/src/handler/legacy/edit_get_fixes.dart

@@ -4,7 +4,6 @@
 
 import 'dart:async';
 
-import 'package:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/handler/legacy/legacy_handler.dart';
 import 'package:analysis_server/src/legacy_analysis_server.dart';
 import 'package:analysis_server/src/plugin/result_converter.dart';
@@ -30,6 +29,7 @@ import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/util/file_paths.dart';
 import 'package:analyzer/src/workspace/pub.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:yaml/yaml.dart';
 
 /// The handler for the `edit.getFixes` request.

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

@@ -3,7 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:_fe_analyzer_shared/src/scanner/errors.dart';
-import 'package:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/plugin/edit/fix/fix_dart.dart';
 import 'package:analysis_server/protocol/protocol_generated.dart'
     hide AnalysisOptions;
@@ -49,6 +48,7 @@ import 'package:analyzer_plugin/protocol/protocol_common.dart'
 import 'package:analyzer_plugin/src/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/conflicting_edit_exception.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:yaml/yaml.dart';
 
 import 'fix/pubspec/fix_generator.dart';

pkg/analysis_server/lib/src/services/correction/fix/analysis_options/fix_generator.dart

@@ -4,7 +4,6 @@
 
 import 'dart:math' as math;
 
-import 'package:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analysis_server/src/utilities/yaml_node_locator.dart';
@@ -20,6 +19,7 @@ import 'package:analyzer_plugin/utilities/change_builder/change_builder_yaml.dar
 import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:collection/collection.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:yaml/yaml.dart';
 import 'package:yaml_edit/yaml_edit.dart';
 
@@ -182,7 +182,7 @@ class AnalysisOptionsFixGenerator {
     }
     change.id = kind.id;
     change.message = formatList(kind.message, args);
-    fixes.add(Fix(kind, change));
+    fixes.add(Fix(kind: kind, change: change));
   }
 
   Future<ChangeBuilder?> _createScalarDeletionBuilder(

pkg/analysis_server/lib/src/services/correction/fix/pubspec/fix_generator.dart

@@ -3,7 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:_fe_analyzer_shared/src/scanner/characters.dart';
-import 'package:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/services/correction/fix/pubspec/fix_kind.dart';
 import 'package:analysis_server/src/utilities/yaml_node_locator.dart';
 import 'package:analyzer/dart/analysis/session.dart';
@@ -18,6 +17,7 @@ import 'package:analyzer/src/util/yaml.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:yaml/yaml.dart';
 
 /// The generator used to generate fixes in pubspec.yaml files.
@@ -147,7 +147,7 @@ class PubspecFixGenerator {
     }
     change.id = kind.id;
     change.message = formatList(kind.message, null);
-    fixes.add(Fix(kind, change));
+    fixes.add(Fix(kind: kind, change: change));
   }
 
   Future<void> _addMissingDependency(ErrorCode errorCode) async {

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

@@ -2,7 +2,6 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/plugin/edit/fix/fix_dart.dart';
 import 'package:analysis_server/src/services/correction/dart/abstract_producer.dart';
 import 'package:analysis_server/src/services/correction/dart/add_async.dart';
@@ -239,6 +238,7 @@ import 'package:analyzer_plugin/src/utilities/change_builder/change_builder_core
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/conflicting_edit_exception.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 
 final _builtInLintMultiProducers = {
   LintNames.deprecated_member_use_from_same_package: [
@@ -1667,7 +1667,7 @@ class FixInFileProcessor {
             var fixKind = fixState.fixKind;
             sourceChange.id = fixKind.id;
             sourceChange.message = fixKind.message;
-            fixes.add(Fix(fixKind, sourceChange));
+            fixes.add(Fix(kind: fixKind, change: sourceChange));
           }
         }
       }

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

@@ -2,7 +2,6 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/plugin/edit/fix/fix_dart.dart';
 import 'package:analysis_server/src/services/correction/base_processor.dart';
 import 'package:analysis_server/src/services/correction/bulk_fix_processor.dart';
@@ -15,6 +14,7 @@ import 'package:analyzer/src/generated/java_core.dart';
 import 'package:analyzer/src/util/file_paths.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 import 'package:analyzer_plugin/utilities/change_builder/conflicting_edit_exception.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 
 /// A function that can be executed to create a multi-correction producer.
 typedef MultiProducerGenerator = MultiCorrectionProducer Function();
@@ -97,7 +97,7 @@ class FixProcessor extends BaseProcessor {
 
     change.id = kind.id;
     change.message = formatList(kind.message, producer.fixArguments);
-    fixes.add(Fix(kind, change));
+    fixes.add(Fix(kind: kind, change: change));
   }
 
   Future<void> _addFromProducers() async {

pkg/analysis_server/pubspec.yaml

@@ -21,6 +21,7 @@ dependencies:
   memory_usage: any
   meta: any
   path: any
+  server_plugin: any
   stream_channel: any
   telemetry: any
   test: any

pkg/analysis_server/test/src/cider/fixes_test.dart

@@ -2,12 +2,12 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/cider/fixes.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart' show SourceEdit;
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 

pkg/analysis_server/test/src/services/correction/fix/analysis_options/test_support.dart

@@ -2,7 +2,6 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/services/correction/fix/analysis_options/fix_generator.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/generated/source.dart';
@@ -11,6 +10,7 @@ import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart'
     hide AnalysisError;
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:test/test.dart';
 import 'package:yaml/yaml.dart';
 

pkg/analysis_server/test/src/services/correction/fix/fix_processor.dart

@@ -2,7 +2,6 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/services/correction/bulk_fix_processor.dart';
 import 'package:analysis_server/src/services/correction/change_workspace.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
@@ -16,6 +15,7 @@ import 'package:analyzer_plugin/protocol/protocol_common.dart'
 import 'package:analyzer_plugin/utilities/change_builder/change_workspace.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
 import 'package:meta/meta.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:test/test.dart';
 
 import '../../../../abstract_context.dart';

pkg/analysis_server/test/src/services/correction/fix/pubspec/test_support.dart

@@ -2,14 +2,14 @@
 // 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:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/protocol_server.dart' show SourceEdit;
 import 'package:analysis_server/src/services/correction/fix/pubspec/fix_generator.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/src/pubspec/pubspec_validator.dart'
     as pubspec_validator;
 import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:server_plugin/edit/fix/fix.dart';
 import 'package:test/test.dart';
 import 'package:yaml/yaml.dart';
 

pkg/server_plugin/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+## Contributing
+
+Contributions welcome! Please follow the guide in [Contributing][contributing].
+
+## Building
+
+If you want to build Dart yourself, here is a guide to [getting the source,
+preparing your machine to build the SDK, and building][building].
+
+There are more documents on our [wiki][]. Once set up to build the SDK, run:
+
+```none
+./tools/build.py -mrelease create_sdk
+```
+
+## Coding style
+
+The analyzer packages are coded with a styled specified in our [coding style
+document][coding style].
+
+[building]: https://github.com/dart-lang/sdk/wiki/Building
+[coding style]: https://github.com/dart-lang/sdk/blob/main/pkg/analyzer/doc/implementation/coding_style.md
+[contributing]: https://github.com/dart-lang/sdk/wiki/Contributing
+[wiki]: https://github.com/dart-lang/sdk/wiki

pkg/server_plugin/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2012, the Dart project authors.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name of Google LLC nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pkg/server_plugin/OWNERS

@@ -0,0 +1 @@
+file:/tools/OWNERS_ANALYZER

pkg/server_plugin/README.md

@@ -0,0 +1,58 @@
+# server\_plugin package
+
+This package is being developed for the second incarnation of Dart Analyzer
+plugins. It is in an intermediate state, and a few things must be kept in mind
+during this phase of development:
+
+1. **This package is not to be published on pub.** Yet. We may decide to go
+   forward with this package as a full replacement of the `analyzer_plugin`
+   package, in which case we _would_ ultimately publish it. But we may choose a
+   different plan.  Until we finalize, this package is not to be published.
+2. **In order to support the above point, no pub-publishable code can depend on
+   this package.** At no point can we introduce a dependency from a package
+   like `analyzer` or `analyzer_plugin` to this package. If we did so, then at
+   the next time we published _that_ package to pub, we would need to publish
+   _this_ package to pub. No. In short, I think what this means is that only
+   the `analsis_server` package can depend on this package (until we decide the
+   final path to publishing the next Dart Analyzer plugins story.
+
+## Migration of code between packages
+
+As part of the design of the new Dart Analyzer plugins, much code will shift
+around, in a few directions.
+
+* **`analysis_server` package to `server_plugin` package:** The API of the new
+  Dart Analyzer plugins focuses around two primary concepts: lint rules and
+  quick fixes. Quick assists may be chosen as a third important concept.  Lint
+  rule code has typically lived in the `analyzer` package, and does not need to
+  move. (It's presense in the `analyzer` package could be deprecated in favor
+  of this package, but it is not important for the implementation.)
+
+  Quick fixes, however, have only existed in concept, and interface, and API,
+  in the `analysis_server` package. That code needs to move to this package in
+  order to be used in a Dart Analyzer plugin.
+
+  **A move from the `analysis_server` package to this package is not a breaking
+  change.**
+
+* **`analyzer_plugin` package to `server_plugin` package:** Care is being taken
+  to decide where Dart Analyzer plugin code will live and how it will be
+  published. It is not decided yet what the ultimate package API will be. Some
+  code from **analyzer_plugin** may move to this package.
+
+  **A move from the `analyzer_plugin` package is a breaking change. Extreme
+  care must be taken.**
+
+* **`analyzer_plugin` package to `analysis_server` package:** There will be
+  many components of the analysis server that currently live in
+  `analyzer_plugin`, because they were necessary for the first version of Dart
+  Analyzer plugins), but are not part of the new Dart Analyzer plugins. These
+  components can be moved safely back into the `analysis_server` package.
+
+  In terms of priority, it is not crucial for such code to be moved out of the
+  `analyzer_plugin` package. It can live there indefinitely, and the
+  `analysis_server` package can continue to depend on code from the
+  `analyzer_plugin` package, as shipped in the SDK.
+
+  **A move from the `analyzer_plugin` package is a breaking change. Extreme
+  care must be taken.**

pkg/server_plugin/analysis_options.yaml

@@ -0,0 +1,28 @@
+include: package:lints/recommended.yaml
+
+analyzer:
+  language:
+    strict-casts: true
+    strict-inference: true
+    strict-raw-types: true
+  errors:
+    # This package imports much of the implementation libraries of the
+    # 'analyzer' (and sometimes the '_fe_analyzer_shared' package), because it
+    # is tightly integrated. This will not likely change any time soon.
+    implementation_imports: ignore
+
+linter:
+  rules:
+    - always_use_package_imports
+    - avoid_dynamic_calls
+    - avoid_redundant_argument_values
+    - avoid_unused_constructor_parameters
+    - flutter_style_todos
+    - library_annotations
+    - prefer_single_quotes
+    - unawaited_futures
+    - unnecessary_breaks
+    - unnecessary_library_directive
+    - unnecessary_parenthesis
+    - unreachable_from_main
+