[analysis_server] Add isDeprecated flag to editable arguments

See flutter/devtools#8930

Change-Id: Ia23ff0659973971393e31bc6f00bd9104bd2c67c
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/411686
Reviewed-by: Elliott Brooks <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: DanTup

pkg/analysis_server/lib/src/lsp/handlers/custom/editable_arguments/handler_editable_arguments.dart

@@ -239,6 +239,7 @@ class EditableArgumentsHandler
       isRequired: parameter.isRequired,
       isNullable:
           parameter.type.nullabilitySuffix == NullabilitySuffix.question,
+      isDeprecated: parameter.metadata2.hasDeprecated,
       isEditable: notEditableReason == null,
       notEditableReason: notEditableReason,
     );

pkg/analysis_server/test/shared/shared_editable_arguments_tests.dart

@@ -78,6 +78,7 @@ $content
     Object? defaultValue = anything,
     Object? isRequired = anything,
     Object? isNullable = anything,
+    Object? isDeprecated = anything,
     Object? isEditable = anything,
     Object? notEditableReason = anything,
     Object? options = anything,
@@ -92,6 +93,7 @@ $content
         .having((arg) => arg.defaultValue, 'defaultValue', defaultValue)
         .having((arg) => arg.isRequired, 'isRequired', isRequired)
         .having((arg) => arg.isNullable, 'isNullable', isNullable)
+        .having((arg) => arg.isDeprecated, 'isDeprecated', isDeprecated)
         .having((arg) => arg.isEditable, 'isEditable', isEditable)
         .having(
           (arg) => arg.notEditableReason,
@@ -349,6 +351,31 @@ class MyWidget extends StatelessWidget {
     );
   }
 
+  Future<void> test_isDeprecated() async {
+    var result = await getEditableArgumentsFor('''
+class MyWidget extends StatelessWidget {
+  /// Creates a MyWidget.
+  const MyWidget(
+    @deprecated
+    int aDeprecated,
+    int aNotDeprecated,
+  );
+
+  @override
+  Widget build(BuildContext context) => MyW^idget(1, 2);
+}
+''');
+    expect(
+      result,
+      hasArgs(
+        unorderedEquals([
+          isArg('aDeprecated', isDeprecated: true),
+          isArg('aNotDeprecated', isDeprecated: false),
+        ]),
+      ),
+    );
+  }
+
   Future<void> test_isEditable_false_positional_optional() async {
     var result = await getEditableArgumentsFor(r'''
 class MyWidget extends StatelessWidget {

pkg/analysis_server/tool/lsp_spec/generate_all.dart

@@ -496,6 +496,11 @@ List<LspEntity> getCustomClasses() {
             'Whether this argument can be `null`.\n\nIt is possible for an '
             'argument to be required, but still allow an explicit `null`.',
       ),
+      field(
+        'isDeprecated',
+        type: 'boolean',
+        comment: 'Whether the parameter is deprecated.',
+      ),
       field(
         'isEditable',
         type: 'boolean',

third_party/pkg/language_server_protocol/lib/protocol_custom_generated.dart

@@ -1457,6 +1457,9 @@ class EditableArgument implements ToJsonable {
   /// parameter default or null.
   final bool hasArgument;
 
+  /// Whether the parameter is deprecated.
+  final bool isDeprecated;
+
   /// Whether this argument can be add/edited.
   ///
   /// If not, notEditableReason will contain an explanation for why.
@@ -1503,6 +1506,7 @@ class EditableArgument implements ToJsonable {
     this.displayValue,
     this.documentation,
     required this.hasArgument,
+    required this.isDeprecated,
     required this.isEditable,
     required this.isNullable,
     required this.isRequired,
@@ -1518,6 +1522,7 @@ class EditableArgument implements ToJsonable {
         displayValue,
         documentation,
         hasArgument,
+        isDeprecated,
         isEditable,
         isNullable,
         isRequired,
@@ -1536,6 +1541,7 @@ class EditableArgument implements ToJsonable {
         displayValue == other.displayValue &&
         documentation == other.documentation &&
         hasArgument == other.hasArgument &&
+        isDeprecated == other.isDeprecated &&
         isEditable == other.isEditable &&
         isNullable == other.isNullable &&
         isRequired == other.isRequired &&
@@ -1559,6 +1565,7 @@ class EditableArgument implements ToJsonable {
       result['documentation'] = documentation;
     }
     result['hasArgument'] = hasArgument;
+    result['isDeprecated'] = isDeprecated;
     result['isEditable'] = isEditable;
     result['isNullable'] = isNullable;
     result['isRequired'] = isRequired;
@@ -1593,6 +1600,10 @@ class EditableArgument implements ToJsonable {
           allowsUndefined: false, allowsNull: false)) {
         return false;
       }
+      if (!_canParseBool(obj, reporter, 'isDeprecated',
+          allowsUndefined: false, allowsNull: false)) {
+        return false;
+      }
       if (!_canParseBool(obj, reporter, 'isEditable',
           allowsUndefined: false, allowsNull: false)) {
         return false;
@@ -1634,6 +1645,8 @@ class EditableArgument implements ToJsonable {
     final documentation = documentationJson as String?;
     final hasArgumentJson = json['hasArgument'];
     final hasArgument = hasArgumentJson as bool;
+    final isDeprecatedJson = json['isDeprecated'];
+    final isDeprecated = isDeprecatedJson as bool;
     final isEditableJson = json['isEditable'];
     final isEditable = isEditableJson as bool;
     final isNullableJson = json['isNullable'];
@@ -1656,6 +1669,7 @@ class EditableArgument implements ToJsonable {
       displayValue: displayValue,
       documentation: documentation,
       hasArgument: hasArgument,
+      isDeprecated: isDeprecated,
       isEditable: isEditable,
       isNullable: isNullable,
       isRequired: isRequired,