Add screen field to DebuggerReady event (#1552)

* Add screen field to DebuggerReady event

* Updated changelog

* Report DebuggerReady event for embedded DevTools

Author: Anna Gringauze

dwds/CHANGELOG.md

@@ -14,6 +14,8 @@
 - Update `vm_service` version to `^8.2.0`.
 - Migrate .packages to package_config.json.
 - Update error message on expression evaluation using unloaded libraries.
+- Add `screen` field to the `DebuggerReady` event.
+- Report `DebuggerReady` events for DevTools embedded into Chrome Devtools.
 
 **Breaking changes:**
 - `Dwds.start` and `ExpressionCompilerService` now take

dwds/lib/src/dwds_vm_client.dart

@@ -151,21 +151,22 @@ void _processSendEvent(Map<String, dynamic> event,
     case 'DevtoolsEvent':
       {
         _logger.finest('Received DevTools event: $event');
-        var action = payload == null ? null : payload['action'];
+        var action = payload == null ? null : payload['action'] as String;
+        var screen = payload == null ? null : payload['screen'] as String;
         if (action == 'pageReady') {
           if (dwdsStats.isFirstDebuggerReady) {
             if (dwdsStats.devToolsStart != null) {
               var time = DateTime.now()
                   .difference(dwdsStats.devToolsStart)
                   .inMilliseconds;
-              emitEvent(DwdsEvent.devToolsLoad(time));
+              emitEvent(DwdsEvent.devToolsLoad(time, screen));
               _logger.fine('DevTools load time: $time ms');
             }
             if (dwdsStats.debuggerStart != null) {
               var time = DateTime.now()
                   .difference(dwdsStats.debuggerStart)
                   .inMilliseconds;
-              emitEvent(DwdsEvent.debuggerReady(time));
+              emitEvent(DwdsEvent.debuggerReady(time, screen));
               _logger.fine('Debugger ready time: $time ms');
             }
           } else {

dwds/lib/src/events.dart

@@ -94,14 +94,16 @@ class DwdsEvent {
 
   DwdsEvent.fullReload() : this(DwdsEventKind.fullReload, {});
 
-  DwdsEvent.debuggerReady(int elapsedMilliseconds)
+  DwdsEvent.debuggerReady(int elapsedMilliseconds, String screen)
       : this(DwdsEventKind.debuggerReady, {
           'elapsedMilliseconds': elapsedMilliseconds,
+          'screen': screen,
         });
 
-  DwdsEvent.devToolsLoad(int elapsedMilliseconds)
+  DwdsEvent.devToolsLoad(int elapsedMilliseconds, String screen)
       : this(DwdsEventKind.devToolsLoad, {
           'elapsedMilliseconds': elapsedMilliseconds,
+          'screen': screen,
         });
 
   DwdsEvent.httpRequestException(String server, String exception)

dwds/lib/src/handlers/dev_handler.dart

@@ -530,6 +530,9 @@ class DevHandler {
       final appServices = _servicesByAppId[appId];
       final encodedUri = await appServices.debugService.encodedUri;
 
+      appServices.dwdsStats.updateLoadTime(
+          debuggerStart: debuggerStart, devToolsStart: DateTime.now());
+
       // If we only want the URI, this means we are embedding Dart DevTools in
       // Chrome DevTools. Therefore return early.
       if (devToolsRequest.uriOnly != null && devToolsRequest.uriOnly) {
@@ -544,8 +547,6 @@ class DevHandler {
         encodedUri,
         ideQueryParam: 'DebugExtension',
       );
-      appServices.dwdsStats.updateLoadTime(
-          debuggerStart: debuggerStart, devToolsStart: DateTime.now());
       await _launchDevTools(extensionDebugger, devToolsUri);
     });
   }

dwds/test/events_test.dart

@@ -136,9 +136,11 @@ void main() {
         [
           matchesEvent(DwdsEventKind.debuggerReady, {
             'elapsedMilliseconds': isNotNull,
+            'screen': equals('debugger'),
           }),
           matchesEvent(DwdsEventKind.devToolsLoad, {
             'elapsedMilliseconds': isNotNull,
+            'screen': equals('debugger'),
           }),
         ],
         () => keyboard.sendChord([Keyboard.alt, 'd']),