Analyzer warnings: add support for @Deprecation.extend and .implement

Work towards #60504

For each annotation, we implement several features in the analyzer:

* The annotation causes certain usage to generate a warning (+ tests).
* Possible fixes for this new warning are offered (+ tests).
* Placing the annotation on an invalid element generates a different
  warning (+ tests).
* Possible fixes for the invalid annotation are offered (+ tests).

Change-Id: I55f8663a4c0589bc8409dda879f28b072eca6197
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/442705
Reviewed-by: Konstantin Shcheglov <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: srawlins

pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml

@@ -3462,10 +3462,14 @@ WarningCode.DEPRECATED_EXPORT_USE:
   status: hasFix
   notes: |-
     A data driven fix using `replacedBy`.
+WarningCode.DEPRECATED_EXTEND:
+  status: hasFix
 WarningCode.DEPRECATED_EXTENDS_FUNCTION:
   status: needsFix
   notes: |-
-    The fix is to remove `Function` from where it's referenced.
+    The fix is to remove the class from the implements list.
+WarningCode.DEPRECATED_IMPLEMENT:
+  status: hasFix
 WarningCode.DEPRECATED_IMPLEMENTS_FUNCTION:
   status: hasFix
 WarningCode.DEPRECATED_MIXIN_FUNCTION:
@@ -3551,6 +3555,12 @@ WarningCode.INVALID_ANNOTATION_TARGET:
   status: hasFix
 WarningCode.INVALID_AWAIT_NOT_REQUIRED_ANNOTATION:
   status: needsFix
+WarningCode.INVALID_DEPRECATED_EXTEND_ANNOTATION:
+  status: needsFix
+  notes: The fix is to remove the annotation.
+WarningCode.INVALID_DEPRECATED_IMPLEMENT_ANNOTATION:
+  status: needsFix
+  notes: The fix is to remove the annotation.
 WarningCode.INVALID_EXPORT_OF_INTERNAL_ELEMENT:
   status: needsFix
   notes: |-

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

@@ -1197,6 +1197,8 @@ final _builtInNonLintGenerators = <DiagnosticCode, List<ProducerGenerator>>{
     //  a place where it can be reached (when possible).
     RemoveDeadCode.new,
   ],
+  WarningCode.DEPRECATED_EXTEND: [RemoveExtendsClause.new],
+  WarningCode.DEPRECATED_IMPLEMENT: [RemoveNameFromDeclarationClause.new],
   WarningCode.DEPRECATED_IMPLEMENTS_FUNCTION: [
     RemoveNameFromDeclarationClause.new,
   ],

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

@@ -43,6 +43,34 @@ class RemoveExtendsClauseTest extends FixProcessorTest {
   @override
   FixKind get kind => DartFixKind.REMOVE_EXTENDS_CLAUSE;
 
+  Future<void> test_deprecatedExtends() async {
+    newFile('$testPackageLibPath/a.dart', '''
+@Deprecated.extend()
+class A {}
+''');
+    await resolveTestCode('''
+import 'a.dart';
+class B extends A {}
+''');
+    await assertHasFix('''
+import 'a.dart';
+class B {}
+''');
+  }
+
+  Future<void> test_deprecatedExtends_classTypeAlias() async {
+    newFile('$testPackageLibPath/a.dart', '''
+@Deprecated.extend()
+class A {}
+''');
+    await resolveTestCode('''
+import 'a.dart';
+mixin M {}
+class B = A with M;
+''');
+    await assertNoFix();
+  }
+
   Future<void> test_mixinClass_extends_class() async {
     await resolveTestCode('''
 class A {}

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

@@ -15,6 +15,7 @@ void main() {
     defineReflectiveTests(ExtendsDisallowedClassTest);
     defineReflectiveTests(ExtendsNonClassTest);
     defineReflectiveTests(ExtendsTypeAliasExpandsToTypeParameterTest);
+    defineReflectiveTests(ImplementsDeprecatedImplementTest);
     defineReflectiveTests(ImplementsDisallowedClassTest);
     defineReflectiveTests(ImplementsRepeatedTest);
     defineReflectiveTests(ImplementsSuperClassTest);
@@ -92,6 +93,27 @@ class C {}
   }
 }
 
+@reflectiveTest
+class ImplementsDeprecatedImplementTest extends FixProcessorTest {
+  @override
+  FixKind get kind => DartFixKind.REMOVE_NAME_FROM_DECLARATION_CLAUSE;
+
+  Future<void> test_deprecatedExtends() async {
+    newFile('$testPackageLibPath/a.dart', '''
+@Deprecated.implement()
+class A {}
+''');
+    await resolveTestCode('''
+import 'a.dart';
+class B implements A {}
+''');
+    await assertHasFix('''
+import 'a.dart';
+class B {}
+''');
+  }
+}
+
 @reflectiveTest
 class ImplementsDisallowedClassTest extends FixProcessorTest {
   @override

pkg/analyzer/lib/src/dart/element/extensions.dart

@@ -74,6 +74,22 @@ extension Element2Extension on Element {
     return false;
   }
 
+  /// Whether the use of this element is deprecated.
+  bool get isUseDeprecated {
+    var element = this;
+
+    var metadata =
+        (element is PropertyAccessorElement && element.isSynthetic)
+            ? element.variable.metadata
+            : element.metadata;
+
+    var annotations = metadata.annotations.where((e) => e.isDeprecated);
+    return annotations.any((annotation) {
+      var value = annotation.computeConstantValue();
+      return value?.getField('_isUse')?.toBoolValue() ?? true;
+    });
+  }
+
   /// Whether this element is a wildcard variable.
   bool get isWildcardVariable {
     return name == '_' &&

pkg/analyzer/lib/src/diagnostic/diagnostic_code_values.g.dart

@@ -988,7 +988,9 @@ const List<DiagnosticCode> diagnosticCodeValues = [
   WarningCode.DEAD_CODE_LATE_WILDCARD_VARIABLE_INITIALIZER,
   WarningCode.DEAD_CODE_ON_CATCH_SUBTYPE,
   WarningCode.DEPRECATED_EXPORT_USE,
+  WarningCode.DEPRECATED_EXTEND,
   WarningCode.DEPRECATED_EXTENDS_FUNCTION,
+  WarningCode.DEPRECATED_IMPLEMENT,
   WarningCode.DEPRECATED_IMPLEMENTS_FUNCTION,
   WarningCode.DEPRECATED_MIXIN_FUNCTION,
   WarningCode.DEPRECATED_NEW_IN_COMMENT_REFERENCE,
@@ -1022,6 +1024,8 @@ const List<DiagnosticCode> diagnosticCodeValues = [
   WarningCode.INFERENCE_FAILURE_ON_UNTYPED_PARAMETER,
   WarningCode.INVALID_ANNOTATION_TARGET,
   WarningCode.INVALID_AWAIT_NOT_REQUIRED_ANNOTATION,
+  WarningCode.INVALID_DEPRECATED_EXTEND_ANNOTATION,
+  WarningCode.INVALID_DEPRECATED_IMPLEMENT_ANNOTATION,
   WarningCode.INVALID_EXPORT_OF_INTERNAL_ELEMENT,
   WarningCode.INVALID_EXPORT_OF_INTERNAL_ELEMENT_INDIRECTLY,
   WarningCode.INVALID_FACTORY_METHOD_DECL,

pkg/analyzer/lib/src/error/annotation_verifier.dart

@@ -45,6 +45,8 @@ class AnnotationVerifier {
     var parent = node.parent;
     if (element.isAwaitNotRequired) {
       _checkAwaitNotRequired(node);
+    } else if (element.isDeprecated) {
+      _checkDeprecated(node);
     } else if (element.isFactory) {
       _checkFactory(node);
     } else if (element.isInternal) {
@@ -113,6 +115,88 @@ class AnnotationVerifier {
     }
   }
 
+  void _checkDeprecated(Annotation node) {
+    var element = node.elementAnnotation;
+    var value = element?.computeConstantValue();
+    if (value == null) return;
+
+    // The vast majority of deprecated annotations use the default constructor.
+    // Check this case first.
+    if (value.getField('_isUse')?.toBoolValue() ?? true) return;
+
+    var isExtend = value.getField('_isExtend')?.toBoolValue() ?? false;
+    if (isExtend) {
+      _checkDeprecatedExtend(node, node.parent);
+      return;
+    }
+
+    var isImplement = value.getField('_isImplement')?.toBoolValue() ?? false;
+    if (isImplement) {
+      _checkDeprecatedImplement(node, node.parent);
+      return;
+    }
+  }
+
+  void _checkDeprecatedExtend(Annotation node, AstNode parent) {
+    if (parent
+        case ClassDeclaration(:var declaredFragment) ||
+            ClassTypeAlias(:var declaredFragment)) {
+      var classElement = declaredFragment?.element;
+      if (classElement == null) return;
+      var hasGenerativeConstructor = classElement.constructors.any(
+        (c) => c.isPublic && c.isGenerative,
+      );
+      if (classElement.isExtendableOutside && hasGenerativeConstructor) return;
+    }
+
+    if (parent is GenericTypeAlias) {
+      var classElement = parent.type.type?.element;
+      if (classElement is ClassElement) {
+        var hasGenerativeConstructor = classElement.constructors.any(
+          (c) => c.isPublic && c.isGenerative,
+        );
+        if (classElement.isExtendableOutside && hasGenerativeConstructor) {
+          return;
+        }
+      }
+    }
+
+    _diagnosticReporter.atNode(
+      node.name,
+      WarningCode.INVALID_DEPRECATED_EXTEND_ANNOTATION,
+    );
+  }
+
+  void _checkDeprecatedImplement(Annotation node, AstNode parent) {
+    if (parent
+        case ClassDeclaration(:var declaredFragment) ||
+            ClassTypeAlias(:var declaredFragment)) {
+      var classElement = declaredFragment?.element;
+      if (classElement == null) return;
+      if (classElement.isImplementableOutside) return;
+    }
+
+    if (parent is MixinDeclaration) {
+      var mixinElement = parent.declaredFragment?.element;
+      if (mixinElement == null) return;
+      if (mixinElement.isImplementableOutside) return;
+    }
+
+    if (parent is GenericTypeAlias) {
+      var element = parent.type.type?.element;
+      if (element is ClassElement && element.isImplementableOutside) {
+        return;
+      } else if (element is MixinElement && element.isImplementableOutside) {
+        return;
+      }
+    }
+
+    _diagnosticReporter.atNode(
+      node.name,
+      WarningCode.INVALID_DEPRECATED_IMPLEMENT_ANNOTATION,
+    );
+  }
+
   /// Reports a warning at [node] if its parent is not a valid target for a
   /// `@factory` annotation.
   void _checkFactory(Annotation node) {