Support 'action' field in Devtools event payload

Author: Anna Gringauze

dwds/CHANGELOG.md

@@ -1,8 +1,33 @@
+## 11.3.1-dev
+
+- Add metrics measuring DevTools Initial Page Load time.
+- Add `ext.dwds.sendEvent` service extension to dwds so other tools
+  can send events to the debugger.
+  Event format:
+  ```
+  {
+    'type': '<event type>',
+    'payload': {
+      'screen: '<screen name>',
+      'action: '<action name>',
+    }
+  }
+  ```
+  Currently supported event values:
+  ```
+  {
+    'type: 'DevtoolsEvent',
+    'payload': {
+      'screen': 'debugger'
+      'action': 'screenReady'
+    }
+  }
+  ```
+
 ## 11.3.0
 
 - Update SDK constraint to `>=2.14.0 <3.0.0`
 - Depend on `vm_service` version `7.3.0`.
-- Add metrics measuring DevTools Initial Page Load time.
 
 ## 11.2.3
 

dwds/lib/src/dwds_vm_client.dart

@@ -156,19 +156,7 @@ class DwdsVmClient {
     await client.registerService('ext.dwds.screenshot', 'DWDS');
 
     client.registerServiceCallback('ext.dwds.sendEvent', (event) async {
-      var type = event['type'] as String;
-      var payload = event['payload'] as Map<String, dynamic>;
-      switch (type) {
-        case 'DevtoolsEvent':
-          {
-            var screen = payload == null ? null : payload['screen'];
-            if (screen == 'debugger' && dwdsStats.isFirstDebuggerReady()) {
-              emitEvent(DwdsEvent.debuggerReady(DateTime.now()
-                  .difference(dwdsStats.debuggerStart)
-                  .inMilliseconds));
-            }
-          }
-      }
+      _processSendEvent(event, chromeProxyService, dwdsStats);
       return {'result': Success().toJson()};
     });
     await client.registerService('ext.dwds.sendEvent', 'DWDS');
@@ -206,6 +194,28 @@ class DwdsVmClient {
   }
 }
 
+void _processSendEvent(Map<String, dynamic> event,
+    ChromeProxyService chromeProxyService, DwdsStats dwdsStats) {
+  var type = event['type'] as String;
+  var payload = event['payload'] as Map<String, dynamic>;
+  switch (type) {
+    case 'DevtoolsEvent':
+      {
+        var screen = payload == null ? null : payload['screen'];
+        var action = payload == null ? null : payload['action'];
+        if (screen == 'debugger' &&
+            action == 'screenReady' &&
+            dwdsStats.isFirstDebuggerReady()) {
+          emitEvent(DwdsEvent.debuggerReady(DateTime.now()
+              .difference(dwdsStats.debuggerStart)
+              .inMilliseconds));
+        } else {
+          _logger.warning('Ignoring unknown event: $event');
+        }
+      }
+  }
+}
+
 Future<void> _disableBreakpointsAndResume(
     VmService client, ChromeProxyService chromeProxyService) async {
   _logger.info('Attempting to disable breakpoints and resume the isolate');

dwds/pubspec.yaml

@@ -1,6 +1,6 @@
 name: dwds
 # Every time this changes you need to run `pub run build_runner build`.
-version: 11.3.0
+version: 11.3.1-dev
 homepage: https://github.com/dart-lang/webdev/tree/master/dwds
 description: >-
   A service that proxies between the Chrome debug protocol and the Dart VM

dwds/test/events_test.dart

@@ -98,7 +98,7 @@ void main() {
     var response = await context.debugConnection.vmService
         .callServiceExtension('ext.dwds.sendEvent', args: {
       'type': 'DevtoolsEvent',
-      'payload': {'screen': 'debugger'},
+      'payload': {'screen': 'debugger', 'action': 'screenReady'},
     });
     expect(response.type, 'Success');
     await events;