Add dwdsLaunch and dwdsAttach events (#2418)

dart-lang · Apr 24, 2024 · 50bf268 · 50bf268
1 parent 804eb5c
commit 50bf268
Show file tree

Hide file tree

Showing 9 changed files with 96 additions and 8 deletions.
diff --git a/dwds/debug_extension_mv3/pubspec.yaml b/dwds/debug_extension_mv3/pubspec.yaml
@@ -1,6 +1,6 @@
 name: mv3_extension
 publish_to: none
-version: 2.1.3
+version: 2.1.4
 homepage: https://github.com/dart-lang/webdev
 description: >-
   A Chrome extension for Dart debugging.

diff --git a/dwds/debug_extension_mv3/web/debug_session.dart b/dwds/debug_extension_mv3/web/debug_session.dart
@@ -77,7 +77,20 @@ enum Trigger {
   angularDartDevTools,
   cider,
   extensionPanel,
-  extensionIcon,
+  extensionIcon;
+
+  String get clientName {
+    switch (this) {
+      case Trigger.angularDartDevTools:
+        return 'acx-devtools';
+      case Trigger.cider:
+        return 'cider';
+      case Trigger.extensionPanel:
+        return 'embedded-devtools';
+      case Trigger.extensionIcon:
+        return 'devtools';
+    }
+  }
 }
 
 enum DebuggerLocation {
@@ -390,7 +403,8 @@ Future<bool> _connectToDwds({
         ..instanceId = debugInfo.appInstanceId
         ..contextId = dartAppContextId
         ..tabUrl = tabUrl
-        ..uriOnly = true,
+        ..uriOnly = true
+        ..client = trigger?.clientName ?? 'unknown',
     ),
   );
   return true;

diff --git a/dwds/debug_extension_mv3/web/manifest_mv3.json b/dwds/debug_extension_mv3/web/manifest_mv3.json
@@ -1,6 +1,6 @@
 {
   "name": "Dart Debug Extension",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "manifest_version": 3,
   "devtools_page": "static_assets/devtools.html",
   "action": {

diff --git a/dwds/lib/dart_web_debug_service.dart b/dwds/lib/dart_web_debug_service.dart
@@ -131,6 +131,8 @@ class Dwds {
       debugSettings.launchDevToolsInNewWindow,
     );
 
+    _maybeEmitDwdsLaunchEvent(toolConfiguration);
+
     return Dwds._(
       injected.middleware,
       devTools,
@@ -140,6 +142,18 @@ class Dwds {
     );
   }
 
+  static void _maybeEmitDwdsLaunchEvent(ToolConfiguration toolConfiguration) {
+    if (toolConfiguration.appMetadata.codeRunner != null) {
+      emitEvent(
+        DwdsEvent.dwdsLaunch(
+          codeRunner: toolConfiguration.appMetadata.codeRunner!,
+          isFlutterApp:
+              toolConfiguration.loadStrategy.buildSettings.isFlutterApp,
+        ),
+      );
+    }
+  }
+
   bool shouldPauseIsolatesOnStart(String appId) =>
       _devHandler.shouldPauseIsolatesOnStart(appId);
 }
diff --git a/dwds/lib/data/devtools_request.dart b/dwds/lib/data/devtools_request.dart
@@ -46,6 +46,12 @@ abstract class DevToolsRequest
   /// Only available on requests coming from the Dart Debug Extension. Is `null`
   /// for local debug service.
   bool? get uriOnly;
+
+  /// Identifies the client that DWDS is attaching to.
+  ///
+  /// This could be Cider, DevTools (as a standalone app), or DevTools (embedded
+  /// in Chrome DevTools).
+  String? get client;
 }
 
 /// A response to a [DevToolsRequest].

diff --git a/dwds/lib/data/devtools_request.g.dart b/dwds/lib/data/devtools_request.g.dart
diff --git a/dwds/lib/src/config/tool_configuration.dart b/dwds/lib/src/config/tool_configuration.dart
@@ -37,11 +37,13 @@ class AppMetadata {
   final String hostname;
   final bool isInternalBuild;
   final String? workspaceName;
+  final String? codeRunner;
 
   const AppMetadata({
     this.hostname = 'localhost',
     this.isInternalBuild = false,
     this.workspaceName,
+    this.codeRunner,
   });
 }
 

diff --git a/dwds/lib/src/events.dart b/dwds/lib/src/events.dart
@@ -40,6 +40,8 @@ class DwdsEventKind {
   static const String devtoolsLaunch = 'DEVTOOLS_LAUNCH';
   static const String devToolsLoad = 'DEVTOOLS_LOAD';
   static const String debuggerReady = 'DEBUGGER_READY';
+  static const String dwdsAttach = 'DWDS_ATTACH';
+  static const String dwdsLaunch = 'DWDS_LAUNCH';
   static const String evaluate = 'EVALUATE';
   static const String evaluateInFrame = 'EVALUATE_IN_FRAME';
   static const String fullReload = 'FULL_RELOAD';
@@ -60,6 +62,18 @@ class DwdsEvent {
 
   DwdsEvent(this.type, this.payload);
 
+  DwdsEvent.dwdsLaunch({required String codeRunner, bool? isFlutterApp})
+      : this(DwdsEventKind.dwdsLaunch, {
+          'codeRunner': codeRunner,
+          'isFlutterApp': isFlutterApp ?? false,
+        });
+
+  DwdsEvent.dwdsAttach({required String client, bool? isFlutterApp})
+      : this(DwdsEventKind.dwdsAttach, {
+          'client': client,
+          'isFlutterApp': isFlutterApp ?? false,
+        });
+
   DwdsEvent.compilerUpdateDependencies(String entrypoint)
       : this(DwdsEventKind.compilerUpdateDependencies, {
           'entrypoint': entrypoint,

diff --git a/dwds/lib/src/handlers/dev_handler.dart b/dwds/lib/src/handlers/dev_handler.dart
@@ -617,6 +617,9 @@ class DevHandler {
       extensionDebugConnections.add(DebugConnection(appServices));
       _servicesByAppId[appId] = appServices;
     }
+
+    _maybeEmitDwdsAttachEvent(devToolsRequest);
+
     // If we don't have a DevTools instance, then are connecting to an IDE.
     // Therefore return early instead of opening DevTools:
     if (_devTools == null) return;
@@ -680,6 +683,18 @@ class DevHandler {
       },
     ).toString();
   }
+
+  static void _maybeEmitDwdsAttachEvent(DevToolsRequest request) {
+    if (request.client != null) {
+      emitEvent(
+        DwdsEvent.dwdsAttach(
+          client: request.client!,
+          isFlutterApp:
+              globalToolConfiguration.loadStrategy.buildSettings.isFlutterApp,
+        ),
+      );
+    }
+  }
 }
 
 class AppConnectionException implements Exception {