[messages] Add uniqueNameCheck constructor parameter.

Adds the constructor parameter `uniqueNameCheck` to `DiagnosticCode`
and derived classes. If a non-null value is supplied for this
parameter, an assertion checks that it's equal to
`uniqueName`. (Passing a `null` value disables the assertion; this is
necessary to preserve analyzer API compatibility).

The reason for this change is that the value supplied for `uniqueName`
when calling constructors in the `DiagnosticCode` class hierarchy is
not necessarily the same as the value that is eventually stored in the
`uniqueName` field; it goes through a sequence of manipulations while
being passed up the superclass chain that make its actual behavior
difficult to follow. The `uniqueNameCheck` field allows me to test the
theory that the actual values that wind up in `uniqueName` are simply
the analyzer codes, with the exception that `LinterLintCode.` is
replaced with `LintCode.`.

In a follow-up CL, I plan to eliminate nearly all the manipulations of
`uniqueName` that occur while being passed up the superclass chain,
which will simplify the code generation logic for computing
`uniqueName` values. Adding `uniqueNameCheck` now allows me to test
out the new, simpler logic, and verify that it will produce the same
result as today's more complex logic.

The `uniqueNameCheck` parameter is marked as `@deprecated` to prevent
clients from trying to use it; this ensures that when I remove it in a
follow-up CL, it won't be necessary to bump the analyzer major
version.

Change-Id: I6a6a696440bce62a31b988d12064244e54e37b6b
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/458820
Reviewed-by: Samuel Rawlins <[email protected]>
Commit-Queue: Paul Berry <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: stereotype441

pkg/_fe_analyzer_shared/lib/src/base/errors.dart

@@ -243,6 +243,11 @@ abstract class DiagnosticCode {
    * associated with the error will be created from the given [problemMessage]
    * template. The correction associated with the error will be created from the
    * given [correctionMessage] template.
+   * 
+   * If a non-null value is supplied for [uniqueNameCheck], it should be the
+   * same as [uniqueName]. This parameter is marked `@deprecated` because it
+   * should not be used by client; it exists as a temporary measure to aid in
+   * migration and will soon be removed.
    */
   const DiagnosticCode({
     String? correctionMessage,
@@ -251,7 +256,12 @@ abstract class DiagnosticCode {
     required this.name,
     required String problemMessage,
     required this.uniqueName,
-  }) : _correctionMessage = correctionMessage,
+    @deprecated String? uniqueNameCheck,
+  }) : assert(
+         uniqueName == uniqueNameCheck || uniqueNameCheck == null,
+         '$uniqueName != $uniqueNameCheck',
+       ),
+       _correctionMessage = correctionMessage,
        _problemMessage = problemMessage;
 
   /**
@@ -329,6 +339,7 @@ class DiagnosticCodeImpl extends DiagnosticCode {
     required super.problemMessage,
     required this.type,
     required super.uniqueName,
+    required super.uniqueNameCheck,
   });
 
   @override
@@ -348,6 +359,7 @@ abstract class DiagnosticCodeWithExpectedTypes extends DiagnosticCodeImpl {
     required super.problemMessage,
     required super.type,
     required super.uniqueName,
+    required super.uniqueNameCheck,
     this.expectedTypes,
   });
 }

pkg/analysis_server/lib/src/services/correction/fix/data_driven/transform_set_error_code.g.dart

@@ -29,6 +29,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   conflictingKey = TransformSetErrorTemplate(
     name: 'conflicting_key',
     problemMessage: "The key '{0}' can't be used when '{1}' is also used.",
+    uniqueNameCheck: 'TransformSetErrorCode.conflicting_key',
     withArguments: _withArgumentsConflictingKey,
     expectedTypes: [ExpectedType.object, ExpectedType.object],
   );
@@ -38,6 +39,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
       TransformSetErrorWithoutArguments(
         name: 'expected_primary',
         problemMessage: "Expected either an identifier or a string literal.",
+        uniqueNameCheck: 'TransformSetErrorCode.expected_primary',
         expectedTypes: [],
       );
 
@@ -51,6 +53,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
     name: 'incompatible_element_kind',
     problemMessage:
         "An element of kind '{0}' can't be replaced by an element of kind '{1}'.",
+    uniqueNameCheck: 'TransformSetErrorCode.incompatible_element_kind',
     withArguments: _withArgumentsIncompatibleElementKind,
     expectedTypes: [ExpectedType.object, ExpectedType.object],
   );
@@ -65,6 +68,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
     name: 'invalid_change_for_kind',
     problemMessage:
         "A change of type '{0}' can't be used for an element of kind '{1}'.",
+    uniqueNameCheck: 'TransformSetErrorCode.invalid_change_for_kind',
     withArguments: _withArgumentsInvalidChangeForKind,
     expectedTypes: [ExpectedType.object, ExpectedType.object],
   );
@@ -77,6 +81,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   invalidCharacter = TransformSetErrorTemplate(
     name: 'invalid_character',
     problemMessage: "Invalid character '{0}'.",
+    uniqueNameCheck: 'TransformSetErrorCode.invalid_character',
     withArguments: _withArgumentsInvalidCharacter,
     expectedTypes: [ExpectedType.object],
   );
@@ -89,6 +94,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   invalidKey = TransformSetErrorTemplate(
     name: 'invalid_key',
     problemMessage: "Keys must be of type 'String' but found the type '{0}'.",
+    uniqueNameCheck: 'TransformSetErrorCode.invalid_key',
     withArguments: _withArgumentsInvalidKey,
     expectedTypes: [ExpectedType.object],
   );
@@ -101,6 +107,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   invalidParameterStyle = TransformSetErrorTemplate(
     name: 'invalid_parameter_style',
     problemMessage: "The parameter style must be one of the following: {0}.",
+    uniqueNameCheck: 'TransformSetErrorCode.invalid_parameter_style',
     withArguments: _withArgumentsInvalidParameterStyle,
     expectedTypes: [ExpectedType.object],
   );
@@ -111,6 +118,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
     name: 'invalid_required_if',
     problemMessage:
         "The key 'requiredIf' can only be used with optional named parameters.",
+    uniqueNameCheck: 'TransformSetErrorCode.invalid_required_if',
     expectedTypes: [],
   );
 
@@ -129,6 +137,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
     name: 'invalid_value',
     problemMessage:
         "The value of '{0}' should be of type '{1}' but is of type '{2}'.",
+    uniqueNameCheck: 'TransformSetErrorCode.invalid_value',
     withArguments: _withArgumentsInvalidValue,
     expectedTypes: [
       ExpectedType.object,
@@ -146,6 +155,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   invalidValueOneOf = TransformSetErrorTemplate(
     name: 'invalid_value_one_of',
     problemMessage: "The value of '{0}' must be one of the following: '{1}'.",
+    uniqueNameCheck: 'TransformSetErrorCode.invalid_value_one_of',
     withArguments: _withArgumentsInvalidValueOneOf,
     expectedTypes: [ExpectedType.object, ExpectedType.object],
   );
@@ -158,6 +168,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   missingKey = TransformSetErrorTemplate(
     name: 'missing_key',
     problemMessage: "Missing the required key '{0}'.",
+    uniqueNameCheck: 'TransformSetErrorCode.missing_key',
     withArguments: _withArgumentsMissingKey,
     expectedTypes: [ExpectedType.object],
   );
@@ -170,6 +181,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   missingOneOfMultipleKeys = TransformSetErrorTemplate(
     name: 'missing_one_of_multiple_keys',
     problemMessage: "Exactly one of the following keys must be provided: {0}.",
+    uniqueNameCheck: 'TransformSetErrorCode.missing_one_of_multiple_keys',
     withArguments: _withArgumentsMissingOneOfMultipleKeys,
     expectedTypes: [ExpectedType.object],
   );
@@ -179,6 +191,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
       TransformSetErrorWithoutArguments(
         name: 'missing_template_end',
         problemMessage: "Missing the end brace for the template.",
+        uniqueNameCheck: 'TransformSetErrorCode.missing_template_end',
         expectedTypes: [],
       );
 
@@ -190,6 +203,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   missingToken = TransformSetErrorTemplate(
     name: 'missing_token',
     problemMessage: "Expected to find {0}.",
+    uniqueNameCheck: 'TransformSetErrorCode.missing_token',
     withArguments: _withArgumentsMissingToken,
     expectedTypes: [ExpectedType.object],
   );
@@ -199,6 +213,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
       TransformSetErrorWithoutArguments(
         name: 'missing_uri',
         problemMessage: "At least one URI must be provided.",
+        uniqueNameCheck: 'TransformSetErrorCode.missing_uri',
         expectedTypes: [],
       );
 
@@ -210,6 +225,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   undefinedVariable = TransformSetErrorTemplate(
     name: 'undefined_variable',
     problemMessage: "The variable '{0}' isn't defined.",
+    uniqueNameCheck: 'TransformSetErrorCode.undefined_variable',
     withArguments: _withArgumentsUndefinedVariable,
     expectedTypes: [ExpectedType.object],
   );
@@ -222,6 +238,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   unexpectedTransformSetToken = TransformSetErrorTemplate(
     name: 'unexpected_transform_set_token',
     problemMessage: "Didn't expect to find {0}.",
+    uniqueNameCheck: 'TransformSetErrorCode.unexpected_transform_set_token',
     withArguments: _withArgumentsUnexpectedTransformSetToken,
     expectedTypes: [ExpectedType.object],
   );
@@ -234,6 +251,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   unknownAccessor = TransformSetErrorTemplate(
     name: 'unknown_accessor',
     problemMessage: "The accessor '{0}' is invalid.",
+    uniqueNameCheck: 'TransformSetErrorCode.unknown_accessor',
     withArguments: _withArgumentsUnknownAccessor,
     expectedTypes: [ExpectedType.object],
   );
@@ -246,6 +264,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   unsupportedKey = TransformSetErrorTemplate(
     name: 'unsupported_key',
     problemMessage: "The key '{0}' isn't supported.",
+    uniqueNameCheck: 'TransformSetErrorCode.unsupported_key',
     withArguments: _withArgumentsUnsupportedKey,
     expectedTypes: [ExpectedType.object],
   );
@@ -257,6 +276,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
         problemMessage:
             "The key 'static' is only supported for elements in a class, enum, "
             "extension, or mixin.",
+        uniqueNameCheck: 'TransformSetErrorCode.unsupported_static',
         expectedTypes: [],
       );
 
@@ -265,6 +285,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
       TransformSetErrorWithoutArguments(
         name: 'unsupported_version',
         problemMessage: "Only version '1' is supported at this time.",
+        uniqueNameCheck: 'TransformSetErrorCode.unsupported_version',
         expectedTypes: [],
       );
 
@@ -277,6 +298,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   wrongToken = TransformSetErrorTemplate(
     name: 'wrong_token',
     problemMessage: "Expected to find {0}, but found {1}.",
+    uniqueNameCheck: 'TransformSetErrorCode.wrong_token',
     withArguments: _withArgumentsWrongToken,
     expectedTypes: [ExpectedType.object, ExpectedType.object],
   );
@@ -289,6 +311,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
   yamlSyntaxError = TransformSetErrorTemplate(
     name: 'yaml_syntax_error',
     problemMessage: "Parse error: {0}",
+    uniqueNameCheck: 'TransformSetErrorCode.yaml_syntax_error',
     withArguments: _withArgumentsYamlSyntaxError,
     expectedTypes: [ExpectedType.object],
   );
@@ -301,6 +324,7 @@ class TransformSetErrorCode extends DiagnosticCodeWithExpectedTypes {
     super.hasPublishedDocs = false,
     super.isUnresolvedIdentifier = false,
     String? uniqueName,
+    required String super.uniqueNameCheck,
     required super.expectedTypes,
   }) : super(
          type: DiagnosticType.COMPILE_TIME_ERROR,
@@ -452,6 +476,7 @@ final class TransformSetErrorTemplate<T extends Function>
     super.hasPublishedDocs = false,
     super.isUnresolvedIdentifier = false,
     super.uniqueName,
+    required super.uniqueNameCheck,
     required super.expectedTypes,
     required this.withArguments,
   });
@@ -467,6 +492,7 @@ final class TransformSetErrorWithoutArguments extends TransformSetErrorCode
     super.hasPublishedDocs = false,
     super.isUnresolvedIdentifier = false,
     super.uniqueName,
+    required super.uniqueNameCheck,
     required super.expectedTypes,
   });
 }

pkg/analysis_server/test/protocol_server_test.dart

@@ -175,6 +175,8 @@ class AnalysisErrorTest {
         'my_lint',
         'my message',
         correctionMessage: 'correction',
+        // ignore: deprecated_member_use
+        uniqueNameCheck: 'LintCode.my_lint',
       ),
       offset: 10,
       length: 20,

pkg/analysis_server/test/shared/shared_code_actions_fixes_tests.dart

@@ -876,6 +876,8 @@ class _DeprecatedCamelCaseTypes extends AnalysisRule {
     correctionMessage:
         'Try changing the name to follow the UpperCamelCase style.',
     hasPublishedDocs: true,
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.camel_case_types',
   );
 
   _DeprecatedCamelCaseTypes()

pkg/analysis_server/test/src/services/completion/yaml/analysis_options_generator_test.dart

@@ -325,6 +325,8 @@ class InternalRule extends AnalysisRule {
     'internal_rule',
     'Internal rule.',
     correctionMessage: 'Try internal rule.',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.internal_rule',
   );
 
   InternalRule()
@@ -339,7 +341,12 @@ class InternalRule extends AnalysisRule {
 }
 
 class _RemovedLint extends AnalysisRule {
-  static const LintCode _code = LintCode('removed_lint', 'Removed rule.');
+  static const LintCode _code = LintCode(
+    'removed_lint',
+    'Removed rule.',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.removed_lint',
+  );
 
   _RemovedLint()
     : super(name: 'removed_lint', state: RuleState.removed(), description: '');

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

@@ -22,6 +22,8 @@ class DeprecatedRule extends AnalysisRule {
     'deprecated_rule',
     'Deprecated rule.',
     correctionMessage: 'Try deprecated rule.',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.deprecated_rule',
   );
 
   DeprecatedRule()
@@ -40,6 +42,8 @@ class RemovedRule extends AnalysisRule {
     'removed_rule',
     'Removed rule.',
     correctionMessage: 'Try removed rule.',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.removed_rule',
   );
 
   RemovedRule()

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

@@ -48,7 +48,12 @@ class FixProcessorMapTest {
       required CorrectionProducerContext context,
     }) => MockCorrectionProducer();
 
-    var lintCode = LintCode('test_rule', 'Test rule.');
+    var lintCode = LintCode(
+      'test_rule',
+      'Test rule.',
+      // ignore: deprecated_member_use
+      uniqueNameCheck: 'LintCode.test_rule',
+    );
     expect(registeredFixGenerators.lintProducers[lintCode], null);
     registeredFixGenerators.registerFixForLint(lintCode, generator);
     expect(

pkg/analysis_server_plugin/test/src/lint_rules.dart

@@ -13,6 +13,8 @@ class NeedsPackageRule extends AnalysisRule {
   static const LintCode code = LintCode(
     'needs_package',
     'Needs Package at {0}',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.needs_package',
   );
 
   NeedsPackageRule()
@@ -34,7 +36,12 @@ class NeedsPackageRule extends AnalysisRule {
 }
 
 class NoBoolsRule extends AnalysisRule {
-  static const LintCode code = LintCode('no_bools', 'No bools message');
+  static const LintCode code = LintCode(
+    'no_bools',
+    'No bools message',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.no_bools',
+  );
 
   NoBoolsRule() : super(name: 'no_bools', description: 'No bools desc');
 
@@ -56,6 +63,8 @@ class NoDoublesCustomSeverityRule extends AnalysisRule {
     'no_doubles_custom_severity',
     'No doubles message',
     severity: DiagnosticSeverity.WARNING,
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.no_doubles_custom_severity',
   );
 
   NoDoublesCustomSeverityRule()
@@ -78,7 +87,12 @@ class NoDoublesCustomSeverityRule extends AnalysisRule {
 }
 
 class NoDoublesRule extends AnalysisRule {
-  static const LintCode code = LintCode('no_doubles', 'No doubles message');
+  static const LintCode code = LintCode(
+    'no_doubles',
+    'No doubles message',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.no_doubles',
+  );
 
   NoDoublesRule()
     : super(name: 'no_doubles', description: 'No doubles message');
@@ -100,6 +114,8 @@ class NoReferencesToStringsRule extends AnalysisRule {
   static const LintCode code = LintCode(
     'no_references_to_strings',
     'No references to Strings',
+    // ignore: deprecated_member_use
+    uniqueNameCheck: 'LintCode.no_references_to_strings',
   );
 
   NoReferencesToStringsRule()