Fix tests, implement getExtensionRpcs for WebSocketAppInspector

Author: bkonyi

dwds/lib/src/debugging/chrome_inspector.dart

@@ -24,6 +24,7 @@ import 'package:dwds/src/utilities/objects.dart';
 import 'package:dwds/src/utilities/server.dart';
 import 'package:dwds/src/utilities/shared.dart';
 import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
 import 'package:vm_service/vm_service.dart';
 import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart';
 
@@ -38,7 +39,10 @@ class ChromeAppInspector extends AppInspector {
   final RemoteDebugger remoteDebugger;
   final ExecutionContext _executionContext;
 
-  late ChromeLibraryHelper _libraryHelper;
+  @override
+  @protected
+  late final libraryHelper = ChromeLibraryHelper(this);
+
   late ChromeAppClassHelper _classHelper;
   late ChromeAppInstanceHelper _instanceHelper;
 
@@ -51,15 +55,10 @@ class ChromeAppInspector extends AppInspector {
   /// Regex used to extract the message from an exception description.
   static final exceptionMessageRegex = RegExp(r'^.*$', multiLine: true);
 
-  /// Flutter widget inspector library.
-  @override
-  Future<LibraryRef?> get flutterWidgetInspectorLibrary => _libraryHelper
-      .libraryRefFor('package:flutter/src/widgets/widget_inspector.dart');
-
   /// Regex used to extract a stack trace line from the exception description.
   static final stackTraceLineRegex = RegExp(r'^\s*at\s.*$', multiLine: true);
 
-  ChromeAppInspector(
+  ChromeAppInspector._(
     super.appConnection,
     super.isolate,
     this.remoteDebugger,
@@ -119,7 +118,7 @@ class ChromeAppInspector extends AppInspector {
       isSystemIsolate: false,
       isolateFlags: [],
     )..extensionRPCs = [];
-    final inspector = ChromeAppInspector(
+    final inspector = ChromeAppInspector._(
       appConnection,
       isolate,
       remoteDebugger,
@@ -343,7 +342,7 @@ class ChromeAppInspector extends AppInspector {
   Future<Library?> getLibrary(String objectId) async {
     final libraryRef = await libraryRefFor(objectId);
     if (libraryRef == null) return null;
-    return _libraryHelper.libraryFor(libraryRef);
+    return libraryHelper.libraryFor(libraryRef);
   }
 
   Future<Obj> getObject(String objectId, {int? offset, int? count}) async {
@@ -437,11 +436,6 @@ class ChromeAppInspector extends AppInspector {
   Future<SourceReport> getSourceReport(
     List<String> reports, {
     String? scriptId,
-    int? tokenPos,
-    int? endTokenPos,
-    bool? forceCompile,
-    bool? reportLines,
-    List<String>? libraryFilters,
   }) {
     if (reports.contains(SourceReportKind.kCoverage)) {
       throwInvalidParam(

dwds/lib/src/debugging/inspector.dart

@@ -49,7 +49,8 @@ abstract class AppInspector {
 
   final AppConnection appConnection;
 
-  late LibraryHelper _libraryHelper;
+  @protected
+  LibraryHelper get libraryHelper;
 
   /// The root URI from which the application is served.
   final String root;
@@ -61,7 +62,7 @@ abstract class AppInspector {
   static final exceptionMessageRegex = RegExp(r'^.*$', multiLine: true);
 
   /// Flutter widget inspector library.
-  Future<LibraryRef?> get flutterWidgetInspectorLibrary => _libraryHelper
+  Future<LibraryRef?> get flutterWidgetInspectorLibrary => libraryHelper
       .libraryRefFor('package:flutter/src/widgets/widget_inspector.dart');
 
   /// Regex used to extract a stack trace line from the exception description.
@@ -73,23 +74,22 @@ abstract class AppInspector {
   /// Reset all caches and recompute any mappings.
   ///
   /// Should be called across hot reloads with a valid [ModifiedModuleReport].
+  @protected
   @mustCallSuper
   Future<void> initialize({ModifiedModuleReport? modifiedModuleReport}) async {
     _scriptCacheMemoizer = AsyncMemoizer<List<ScriptRef>>();
 
-    if (modifiedModuleReport != null) {
-      // Invalidate `_libraryHelper` as we use it populate any script caches.
-      _libraryHelper.initialize(modifiedModuleReport: modifiedModuleReport);
-    } else {
-      _libraryHelper = LibraryHelper(this)..initialize();
+    // Invalidate `_libraryHelper` as we use it populate any script caches.
+    libraryHelper.initialize(modifiedModuleReport: modifiedModuleReport);
+    if (modifiedModuleReport == null) {
       _scriptRefsById.clear();
       _serverPathToScriptRef.clear();
       _scriptIdToLibraryId.clear();
       _libraryIdToScriptRefs.clear();
     }
 
-    final libraries = await _libraryHelper.libraryRefs;
-    isolate.rootLib = await _libraryHelper.rootLib;
+    final libraries = await libraryHelper.libraryRefs;
+    isolate.rootLib = await libraryHelper.rootLib;
     isolate.libraries?.clear();
     isolate.libraries?.addAll(libraries);
 
@@ -111,7 +111,7 @@ abstract class AppInspector {
   );
 
   Future<LibraryRef?> libraryRefFor(String objectId) =>
-      _libraryHelper.libraryRefFor(objectId);
+      libraryHelper.libraryRefFor(objectId);
 
   /// Returns the [ScriptRef] for the provided Dart server path [uri].
   Future<ScriptRef?> scriptRefFor(String uri) async {
@@ -152,7 +152,7 @@ abstract class AppInspector {
         // Invalidate any script caches that were computed for the now invalid
         // libraries. They will get repopulated below.
         for (final libraryUri in modifiedModuleReport.modifiedLibraries) {
-          final libraryRef = await _libraryHelper.libraryRefFor(libraryUri);
+          final libraryRef = await libraryHelper.libraryRefFor(libraryUri);
           final libraryId = libraryRef?.id;
           // If this was not a pre-existing library, nothing to invalidate.
           if (libraryId == null) continue;
@@ -185,7 +185,7 @@ abstract class AppInspector {
           ScriptRef(uri: uri, id: createId()),
           for (final part in parts ?? []) ScriptRef(uri: part, id: createId()),
         ];
-        final libraryRef = await _libraryHelper.libraryRefFor(uri);
+        final libraryRef = await libraryHelper.libraryRefFor(uri);
         final libraryId = libraryRef?.id;
         if (libraryId != null) {
           final libraryIdToScriptRefs = _libraryIdToScriptRefs.putIfAbsent(

dwds/lib/src/debugging/libraries.dart

@@ -10,6 +10,7 @@ import 'package:dwds/src/debugging/metadata/class.dart';
 import 'package:dwds/src/debugging/metadata/provider.dart';
 import 'package:dwds/src/services/chrome_debug_exception.dart';
 import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
 import 'package:vm_service/vm_service.dart';
 import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart';
 
@@ -33,6 +34,7 @@ class LibraryHelper<T extends AppInspector> {
   ///
   /// If [modifiedModuleReport] is not null, invalidates only modified libraries
   /// from the cache and recomputes values for any eager caches.
+  @mustCallSuper
   void initialize({ModifiedModuleReport? modifiedModuleReport}) {
     _rootLib = null;
     if (modifiedModuleReport != null) {

dwds/lib/src/debugging/web_socket_inspector.dart

@@ -4,16 +4,25 @@
 
 import 'package:dwds/src/connections/app_connection.dart';
 import 'package:dwds/src/debugging/inspector.dart';
+import 'package:dwds/src/debugging/libraries.dart';
+import 'package:dwds/src/services/web_socket_proxy_service.dart';
+import 'package:meta/meta.dart';
 import 'package:vm_service/vm_service.dart';
 
 /// Provides information about the currently loaded program.
 class WebSocketAppInspector extends AppInspector {
   /// Counter for generating unique isolate IDs across page refreshes
   static int _globalIsolateIdCounter = 0;
 
-  WebSocketAppInspector(super.appConnection, super.isolate, super.root);
+  WebSocketAppInspector._(
+    super.appConnection,
+    super.isolate,
+    super.root,
+    this._service,
+  );
 
   static Future<WebSocketAppInspector> create(
+    WebSocketProxyService service,
     AppConnection appConnection,
     String root,
   ) async {
@@ -27,31 +36,43 @@ class WebSocketAppInspector extends AppInspector {
       startTime: time,
       runnable: true,
       pauseOnExit: false,
-      pauseEvent: Event(
-        kind: EventKind.kPauseStart,
-        timestamp: time,
-        isolate: IsolateRef(
-          id: id,
-          name: name,
-          number: id,
-          isSystemIsolate: false,
-        ),
-      ),
       livePorts: 0,
       libraries: [],
       breakpoints: [],
       isSystemIsolate: false,
       isolateFlags: [],
-    )..extensionRPCs = [];
-    final inspector = WebSocketAppInspector(appConnection, isolate, root);
+    );
+    final inspector = WebSocketAppInspector._(
+      appConnection,
+      isolate,
+      root,
+      service,
+    );
 
     await inspector.initialize();
     return inspector;
   }
 
   @override
-  Future<Set<String>> getExtensionRpcs() {
-    // TODO: implement getExtensionRpcs
-    throw UnimplementedError();
+  @protected
+  late final libraryHelper = LibraryHelper(this);
+
+  final WebSocketProxyService _service;
+
+  /// Invokes the `getExtensionRpcs` service extension, which returns the list
+  /// of registered extensions.
+  ///
+  /// Combines this with the RPCs registered in the [isolate]. Use this over
+  /// [Isolate.extensionRPCs] as this computes a live set.
+  ///
+  /// Updates [Isolate.extensionRPCs] to this set.
+  @override
+  Future<Set<String>> getExtensionRpcs() async {
+    final response = await _service.callServiceExtension('getExtensionRpcs');
+    final extensionRpcs = (response.json!['rpcs'] as List)
+        .cast<String>()
+        .toSet();
+    isolate.extensionRPCs = List.of(extensionRpcs);
+    return extensionRpcs;
   }
 }

dwds/lib/src/services/chrome_proxy_service.dart

@@ -855,50 +855,28 @@ class ChromeProxyService extends ProxyService<ChromeAppInspector> {
     String isolateId,
     List<String> reports, {
     String? scriptId,
+    // Note: Ignore the following optional parameters. They are here to match
+    // the VM service interface.
     int? tokenPos,
     int? endTokenPos,
     bool? forceCompile,
     bool? reportLines,
     List<String>? libraryFilters,
-    // Note: Ignore the optional librariesAlreadyCompiled parameter. It is here
-    // to match the VM service interface.
     List<String>? librariesAlreadyCompiled,
   }) => wrapInErrorHandlerAsync(
     'getSourceReport',
-    () => _getSourceReport(
-      isolateId,
-      reports,
-      scriptId: scriptId,
-      tokenPos: tokenPos,
-      endTokenPos: endTokenPos,
-      forceCompile: forceCompile,
-      reportLines: reportLines,
-      libraryFilters: libraryFilters,
-    ),
+    () => _getSourceReport(isolateId, reports, scriptId: scriptId),
   );
 
   Future<SourceReport> _getSourceReport(
     String isolateId,
     List<String> reports, {
     String? scriptId,
-    int? tokenPos,
-    int? endTokenPos,
-    bool? forceCompile,
-    bool? reportLines,
-    List<String>? libraryFilters,
   }) {
     return captureElapsedTime(() async {
       await isInitialized;
       _checkIsolate('getSourceReport', isolateId);
-      return await inspector.getSourceReport(
-        reports,
-        scriptId: scriptId,
-        tokenPos: tokenPos,
-        endTokenPos: endTokenPos,
-        forceCompile: forceCompile,
-        reportLines: reportLines,
-        libraryFilters: libraryFilters,
-      );
+      return await inspector.getSourceReport(reports, scriptId: scriptId);
     }, (result) => DwdsEvent.getSourceReport());
   }
 

dwds/lib/src/services/web_socket_proxy_service.dart

@@ -201,7 +201,7 @@ class WebSocketProxyService extends ProxyService<WebSocketAppInspector> {
       return;
     }
 
-    inspector = await WebSocketAppInspector.create(appConnection, root);
+    inspector = await WebSocketAppInspector.create(this, appConnection, root);
 
     final isolateRef = inspector.isolateRef;
     vm.isolates?.add(isolateRef);