[element model] migrate use_key_in_widget_constructors

Bug: https://github.com/dart-lang/linter/issues/5099
Change-Id: I2355eda7d2516137f4bb31b12dc5403e3c003295
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/390502
Auto-Submit: Phil Quitslund <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Phil Quitslund <[email protected]>

Author: pq

pkg/linter/lib/src/rules/use_key_in_widget_constructors.dart

@@ -4,7 +4,7 @@
 
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/dart/element/type.dart';
 
 import '../analyzer.dart';
@@ -39,11 +39,11 @@ class _Visitor extends SimpleAstVisitor<void> {
 
   @override
   void visitClassDeclaration(ClassDeclaration node) {
-    var classElement = node.declaredElement;
+    var classElement = node.declaredFragment?.element;
     if (classElement != null &&
         classElement.isPublic &&
-        hasWidgetAsAscendant(classElement) &&
-        classElement.allConstructors.where((e) => !e.isSynthetic).isEmpty) {
+        classElement.extendsWidget &&
+        classElement.constructors2.where((e) => !e.isSynthetic).isEmpty) {
       rule.reportLintForToken(node.name);
     }
     super.visitClassDeclaration(node);
@@ -53,26 +53,26 @@ class _Visitor extends SimpleAstVisitor<void> {
   void visitConstructorDeclaration(ConstructorDeclaration node) {
     if (node.isAugmentation) return;
 
-    var constructorElement = node.declaredElement;
+    var constructorElement = node.declaredFragment?.element;
     if (constructorElement == null) {
       return;
     }
-    var classElement = constructorElement.enclosingElement3;
+    var classElement = constructorElement.enclosingElement2;
     if (constructorElement.isPublic &&
         !constructorElement.isFactory &&
         classElement.isPublic &&
-        classElement is ClassElement &&
-        hasWidgetAsAscendant(classElement) &&
-        !isExactWidget(classElement) &&
+        classElement is ClassElement2 &&
+        !classElement.isExactlyWidget &&
+        classElement.extendsWidget &&
         !_hasKeySuperParameterInitializerArg(node) &&
         !node.initializers.any((initializer) {
           if (initializer is SuperConstructorInvocation) {
-            var staticElement = initializer.staticElement;
+            var staticElement = initializer.element;
             return staticElement != null &&
                 (!_defineKeyParameter(staticElement) ||
                     _defineKeyArgument(initializer.argumentList));
           } else if (initializer is RedirectingConstructorInvocation) {
-            var staticElement = initializer.staticElement;
+            var staticElement = initializer.element;
             return staticElement != null &&
                 (!_defineKeyParameter(staticElement) ||
                     _defineKeyArgument(initializer.argumentList));
@@ -86,15 +86,16 @@ class _Visitor extends SimpleAstVisitor<void> {
   }
 
   bool _defineKeyArgument(ArgumentList argumentList) => argumentList.arguments
-      .any((a) => a.staticParameterElement?.name == 'key');
+      .any((a) => a.correspondingParameter?.name3 == 'key');
 
-  bool _defineKeyParameter(ConstructorElement element) =>
-      element.parameters.any((e) => e.name == 'key' && _isKeyType(e.type));
+  bool _defineKeyParameter(ConstructorElement2 element) =>
+      element.formalParameters
+          .any((e) => e.name3 == 'key' && _isKeyType(e.type));
 
   bool _hasKeySuperParameterInitializerArg(ConstructorDeclaration node) {
-    for (var parameter in node.parameters.parameters) {
-      var element = parameter.declaredElement;
-      if (element is SuperFormalParameterElement && element.name == 'key') {
+    for (var parameter in node.parameters.parameterFragments) {
+      var element = parameter?.element;
+      if (element is SuperFormalParameterElement2 && element.name3 == 'key') {
         return true;
       }
     }

pkg/linter/lib/src/util/flutter_utils.dart

@@ -10,6 +10,13 @@ import 'package:analyzer/dart/element/type.dart';
 import '../extensions.dart';
 import '../util/dart_type_utilities.dart';
 
+const _nameBuildContext = 'BuildContext';
+const _nameContainer = 'Container';
+const _nameSizedBox = 'SizedBox';
+const _nameState = 'State';
+const _nameStatefulWidget = 'StatefulWidget';
+const _nameWidget = 'Widget';
+
 var _collectionInterfaces = <InterfaceTypeDefinition>[
   InterfaceTypeDefinition('List', 'dart.core'),
   InterfaceTypeDefinition('Map', 'dart.core'),
@@ -20,6 +27,10 @@ var _collectionInterfaces = <InterfaceTypeDefinition>[
 
 _Flutter _flutterInstance = _Flutter('flutter', 'package:flutter');
 
+final Uri _uriFramework = Uri.parse(
+  'package:flutter/src/widgets/framework.dart',
+);
+
 _Flutter get _flutter => _flutterInstance;
 
 bool hasWidgetAsAscendant(ClassElement element) =>
@@ -64,13 +75,6 @@ bool isWidgetType(DartType? type) => _flutter.isWidgetType(type);
 ///
 /// See pkg/analysis_server/lib/src/utilities/flutter.dart.
 class _Flutter {
-  static const _nameBuildContext = 'BuildContext';
-  static const _nameContainer = 'Container';
-  static const _nameSizedBox = 'SizedBox';
-  static const _nameState = 'State';
-  static const _nameStatefulWidget = 'StatefulWidget';
-  static const _nameWidget = 'Widget';
-
   final String packageName;
   final String widgetsUri;
 
@@ -122,6 +126,9 @@ class _Flutter {
   bool isExactWidget(ClassElement element) =>
       isExactly(element, _nameWidget, _uriFramework);
 
+  bool isExactWidget2(ClassElement2 element) =>
+      isExactly2(element, _nameWidget, _uriFramework);
+
   bool isExactWidgetTypeContainer(DartType? type) =>
       type is InterfaceType &&
       isExactly(type.element, _nameContainer, _uriContainer);
@@ -165,3 +172,39 @@ class _Flutter {
   bool isWidgetType(DartType? type) =>
       type is InterfaceType && isWidget(type.element3);
 }
+
+// TODO(pq): based on similar extension in server. (Move and reuse.)
+extension InterfaceElementExtension2 on InterfaceElement2? {
+  bool get extendsWidget => _hasWidgetAsAscendant(this, {});
+
+  bool get isExactlyWidget => _isExactly(_nameWidget, _uriFramework);
+
+  /// Whether this is the Flutter class `Widget`, or a subtype.
+  bool get isWidget {
+    var self = this;
+    if (self is! ClassElement2) return false;
+
+    if (isExactlyWidget) return true;
+
+    return self.allSupertypes
+        .any((type) => type.element3._isExactly(_nameWidget, _uriFramework));
+  }
+
+  /// Whether this is the exact [type] defined in the file with the given [uri].
+  bool _isExactly(String type, Uri uri) {
+    var self = this;
+    return self is ClassElement2 &&
+        self.name3 == type &&
+        self.firstFragment.libraryFragment.source.uri == uri;
+  }
+
+  static bool _hasWidgetAsAscendant(
+      InterfaceElement2? element, Set<InterfaceElement2> alreadySeen) {
+    if (element == null) return false;
+    if (element.isExactlyWidget) return true;
+
+    if (!alreadySeen.add(element)) return false;
+
+    return _hasWidgetAsAscendant(element.supertype?.element3, alreadySeen);
+  }
+}

pkg/linter/test/rules/use_key_in_widget_constructors_test.dart

@@ -127,6 +127,24 @@ class MyWidget extends StatelessWidget {
 ''');
   }
 
+  test_implementsWidget() async {
+    await assertNoDiagnostics(r'''
+import 'package:flutter/widgets.dart';
+
+abstract class AbstractWidget implements Widget {}
+''');
+  }
+
+  test_key_keyPassedToSuper() async {
+    await assertNoDiagnostics(r'''
+import 'package:flutter/widgets.dart';
+
+abstract class MyWidget extends StatelessWidget {
+  MyWidget({Key? key}) : super(key: key ?? Key(''));
+}
+''');
+  }
+
   test_keyUse_inAugmentedConstructor() async {
     newFile('$testPackageLibPath/a.dart', r'''
 part of 'test.dart';