[Property Editor] Better error handling (#9101)

Author: elliette

packages/devtools_app/lib/src/shared/analytics/constants/_property_editor_sidebar_constants.dart

@@ -9,6 +9,13 @@ class PropertyEditorSidebar {
   /// Analytics id to track events that come from the DTD editor sidebar.
   static String get id => 'propertyEditorSidebar';
 
+  /// Identifier for errors returned from the getEditableArguments API.
+  static String get getEditableArgumentsIdentifier =>
+      '${id}Error-getEditableArguments';
+
+  /// Identifier for errors returned from the editArgument API.
+  static String get editArgumentIdentifier => '${id}Error-editArgument';
+
   /// Analytics id for opening the documentation.
   static String get documentationLink => 'propertyEditorDocumentation';
 

packages/devtools_app/lib/src/shared/editor/api_classes.dart

@@ -140,6 +140,16 @@ abstract class Field {
   static const vmServiceUri = 'vmServiceUri';
 }
 
+/// Multi-purpose errors used by the Analysis Server.
+enum AnalysisServerError {
+  /// The document content was modified before the request was completed.
+  contentModifiedError(code: -32801);
+
+  const AnalysisServerError({required this.code});
+
+  final int code;
+}
+
 /// A base class for all known events that an editor can produce.
 ///
 /// The set of subclasses is not guaranteed to match actual events from any

packages/devtools_app/lib/src/shared/editor/editor_client.dart

@@ -8,13 +8,11 @@ import 'package:devtools_app_shared/utils.dart';
 import 'package:dtd/dtd.dart';
 import 'package:flutter/foundation.dart';
 import 'package:json_rpc_2/json_rpc_2.dart';
-import 'package:logging/logging.dart';
 
 import '../analytics/constants.dart';
+import '../framework/app_error_handling.dart';
 import 'api_classes.dart';
 
-final _log = Logger('editor_client');
-
 /// A client wrapper that connects to an editor over DTD.
 ///
 /// Changes made to the editor services/events should be considered carefully to
@@ -262,18 +260,47 @@ class EditorClient extends DisposableController
   }) async {
     final method = editableArgumentsMethodName.value;
     if (method == null) return null;
-    final response = await _callLspApi(
-      method,
-      params: {
-        'type': 'Object', // This is required by DTD.
-        'textDocument': textDocument.toJson(),
-        'position': position.toJson(),
-      },
-    );
-    final result = response.result[Field.result];
-    return result != null
-        ? EditableArgumentsResult.fromJson(result as Map<String, Object?>)
-        : null;
+
+    String? errorMessage;
+    StackTrace? stack;
+    EditableArgumentsResult? result;
+    try {
+      final response = await _callLspApi(
+        method,
+        params: {
+          'type': 'Object', // This is required by DTD.
+          'textDocument': textDocument.toJson(),
+          'position': position.toJson(),
+        },
+      );
+      final rawResult = response.result[Field.result];
+      result =
+          rawResult != null
+              ? EditableArgumentsResult.fromJson(
+                rawResult as Map<String, Object?>,
+              )
+              : null;
+    } on RpcException catch (e, st) {
+      // We expect content modified errors if a user edits their code before the
+      // request completes. Therefore it is safe to ignore.
+      if (e.code != AnalysisServerError.contentModifiedError.code) {
+        errorMessage = e.message;
+        stack = st;
+      }
+    } catch (e, st) {
+      errorMessage = 'Unknown error: $e';
+      stack = st;
+    } finally {
+      if (errorMessage != null) {
+        reportError(
+          errorMessage,
+          errorType: PropertyEditorSidebar.getEditableArgumentsIdentifier,
+          stack: stack,
+        );
+      }
+    }
+
+    return result;
   }
 
   /// Requests that the Analysis Server makes a code edit for an argument.
@@ -290,6 +317,9 @@ class EditorClient extends DisposableController
         errorMessage: 'API is unavailable.',
       );
     }
+
+    String? errorMessage;
+    StackTrace? stack;
     try {
       await _callLspApi(
         method,
@@ -301,22 +331,22 @@ class EditorClient extends DisposableController
         },
       );
       return EditArgumentResponse(success: true);
-    } on RpcException catch (e) {
-      final errorMessage = e.message;
-      _log.severe(errorMessage);
-      return EditArgumentResponse(
-        success: false,
-        errorCode: e.code,
-        errorMessage: errorMessage,
-      );
-    } catch (e) {
-      final errorMessage = 'Unknown error: $e';
-      _log.severe(errorMessage);
-      return EditArgumentResponse(
-        success: false,
-        errorMessage: 'Unknown error: $e',
-      );
+    } on RpcException catch (e, st) {
+      errorMessage = e.message;
+      stack = st;
+    } catch (e, st) {
+      errorMessage = 'Unknown error: $e';
+      stack = st;
+    } finally {
+      if (errorMessage != null) {
+        reportError(
+          errorMessage,
+          errorType: PropertyEditorSidebar.editArgumentIdentifier,
+          stack: stack,
+        );
+      }
     }
+    return EditArgumentResponse(success: false, errorMessage: errorMessage);
   }
 
   Future<DTDResponse> _call(