Send debug info from injected client to the debug extension (#1772)

Author: elliette

dwds/CHANGELOG.md

@@ -1,12 +1,20 @@
+## 16.0.2-dev
+
+- Include debug information in the event sent from the injected client to the
+  Dart Debug Extension notifying that the Dart app is ready.
+- Include an optional param to `Dwds.start` to indicate whether it is running
+  internally or externally.
+
 ## 16.0.1
 
 - Allow the following API to return `null` and add error handling:
   - `LoadStrategy.serverPathForModule`
   - `LoadStrategy.sourceMapPathForModule`
 - Expression evaluation performance improvement:
-  - Batch `ChromeProxyService.evaluate()` requests that are close in time
-    and are executed in the same library and scope.
-- Update `package:file` version to `6.13` or greater to handle https://github.com/dart-lang/sdk/issues/49647.
+  - Batch `ChromeProxyService.evaluate()` requests that are close in time and
+    are executed in the same library and scope.
+- Update `package:file` version to `6.13` or greater to handle
+  https://github.com/dart-lang/sdk/issues/49647.
 
 ## 16.0.0
 

dwds/debug_extension_mv3/pubspec.yaml

@@ -15,3 +15,9 @@ dev_dependencies:
   build: ^2.0.0
   build_web_compilers: ^3.0.0
   build_runner: ^2.0.6
+  dwds: ^16.0.0
+
+dependency_overrides:
+  dwds:
+    path: ..
+

dwds/debug_extension_mv3/web/background.dart

@@ -5,10 +5,14 @@
 @JS()
 library background;
 
+import 'dart:html';
+
+import 'package:dwds/data/debug_info.dart';
 import 'package:js/js.dart';
 
 import 'chrome_api.dart';
 import 'messaging.dart';
+import 'web_api.dart';
 
 void main() {
   _registerListeners();
@@ -22,13 +26,27 @@ void _handleRuntimeMessages(
     dynamic jsRequest, MessageSender sender, Function sendResponse) async {
   if (jsRequest is! String) return;
 
-  interceptMessage(
+  interceptMessage<DebugInfo>(
       message: jsRequest,
+      expectedType: MessageType.debugInfo,
       expectedSender: Script.detector,
       expectedRecipient: Script.background,
-      expectedType: MessageType.dartAppReady,
-      messageHandler: (_) {
+      messageHandler: (DebugInfo debugInfo) async {
+        final currentTab = await _getTab();
+        final currentUrl = currentTab?.url ?? '';
+        final appUrl = debugInfo.appUrl ?? '';
+        if (currentUrl.isEmpty || appUrl.isEmpty || currentUrl != appUrl) {
+          console.warn(
+              'Dart app detected at $appUrl but current tab is $currentUrl.');
+          return;
+        }
         // Update the icon to show that a Dart app has been detected:
         chrome.action.setIcon(IconInfo(path: 'dart.png'), /*callback*/ null);
       });
 }
+
+Future<Tab?> _getTab() async {
+  final query = QueryInfo(active: true, currentWindow: true);
+  final tabs = List<Tab>.from(await promiseToFuture(chrome.tabs.query(query)));
+  return tabs.isNotEmpty ? tabs.first : null;
+}

dwds/debug_extension_mv3/web/chrome_api.dart

@@ -12,6 +12,7 @@ external Chrome get chrome;
 class Chrome {
   external Action get action;
   external Runtime get runtime;
+  external Tabs get tabs;
 }
 
 /// chrome.action APIs
@@ -66,6 +67,24 @@ class MessageSender {
   external factory MessageSender({String? id, String? url, Tab? tab});
 }
 
+/// chrome.tabs APIs
+/// https://developer.chrome.com/docs/extensions/reference/tabs
+
+@JS()
+@anonymous
+class Tabs {
+  external Object query(QueryInfo queryInfo);
+}
+
+@JS()
+@anonymous
+class QueryInfo {
+  external bool get active;
+  external bool get currentWindow;
+  external String get url;
+  external factory QueryInfo({bool? active, bool? currentWindow, String? url});
+}
+
 @JS()
 @anonymous
 class Tab {

dwds/debug_extension_mv3/web/detector.dart

@@ -6,10 +6,12 @@
 library detector;
 
 import 'dart:html';
+import 'dart:js_util';
 import 'package:js/js.dart';
 
 import 'chrome_api.dart';
 import 'messaging.dart';
+import 'web_api.dart';
 
 void main() {
   _registerListeners();
@@ -20,9 +22,14 @@ void _registerListeners() {
 }
 
 void _onDartAppReadyEvent(Event event) {
+  final debugInfo = getProperty(event, 'detail') as String?;
+  if (debugInfo == null) {
+    console.warn('Can\'t debug Dart app without debug info.');
+    return;
+  }
   _sendMessageToBackgroundScript(
-    type: MessageType.dartAppReady,
-    body: 'Dart app ready!',
+    type: MessageType.debugInfo,
+    body: debugInfo,
   );
 }
 

dwds/debug_extension_mv3/web/messaging.dart

@@ -7,6 +7,7 @@ library messaging;
 
 import 'dart:convert';
 
+import 'package:dwds/data/serializers.dart';
 import 'package:js/js.dart';
 
 import 'web_api.dart';
@@ -21,7 +22,7 @@ enum Script {
 }
 
 enum MessageType {
-  dartAppReady;
+  debugInfo;
 
   factory MessageType.fromString(String value) {
     return MessageType.values.byName(value);
@@ -57,34 +58,34 @@ class Message {
 
   String toJSON() {
     return jsonEncode({
-      'type': type.name,
       'to': to.name,
       'from': from.name,
-      'encodedBody': body,
+      'type': type.name,
+      'body': body,
       if (error != null) 'error': error,
     });
   }
 }
 
-void interceptMessage({
+void interceptMessage<T>({
   required String? message,
   required MessageType expectedType,
   required Script expectedSender,
   required Script expectedRecipient,
-  required void Function(String message) messageHandler,
+  required void Function(T message) messageHandler,
 }) {
+  if (message == null) return;
   try {
-    if (message == null) return;
     final decodedMessage = Message.fromJSON(message);
     if (decodedMessage.type != expectedType ||
         decodedMessage.to != expectedRecipient ||
         decodedMessage.from != expectedSender) {
       return;
     }
-    messageHandler(decodedMessage.body);
+    messageHandler(
+        serializers.deserialize(jsonDecode(decodedMessage.body)) as T);
   } catch (error) {
     console.warn(
-        'Error intercepting $expectedType message from $expectedSender to $expectedRecipient: $error');
-    return;
+        'Error intercepting $expectedType from $expectedSender to $expectedRecipient: $error');
   }
 }

dwds/lib/dart_web_debug_service.dart

@@ -86,6 +86,7 @@ class Dwds {
     bool launchDevToolsInNewWindow = true,
     SdkConfigurationProvider? sdkConfigurationProvider,
     bool emitDebugEvents = true,
+    bool isInternalBuild = false,
   }) async {
     globalLoadStrategy = loadStrategy;
     sdkConfigurationProvider ??= DefaultSdkConfigurationProvider();

dwds/lib/data/README.md

@@ -0,0 +1,16 @@
+# How to generate data files:
+
+## Creating a new data file:
+
+1. Create a new file for your data type in the `/data` directory with the
+   `.dart` extension
+1. Create an abstract class for your data type (see existing files for examples)
+1. Add the new data type to `/data/serializers.dart` 4 Run:
+   `dart run build_runner build` from DWDS root (this will generate the
+   `.g.dart` file)
+
+## To update an existing data file:
+
+1. Make your changes
+1. Run: `dart run build_runner clean` from DWDS root
+1. Run: `dart run build_runner build` from DWDS root

dwds/lib/data/debug_info.dart

@@ -0,0 +1,25 @@
+// Copyright (c) 2022, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:built_value/built_value.dart';
+import 'package:built_value/serializer.dart';
+
+part 'debug_info.g.dart';
+
+abstract class DebugInfo implements Built<DebugInfo, DebugInfoBuilder> {
+  static Serializer<DebugInfo> get serializer => _$debugInfoSerializer;
+
+  factory DebugInfo([Function(DebugInfoBuilder) updates]) = _$DebugInfo;
+
+  DebugInfo._();
+
+  String? get appEntrypointPath;
+  String? get appId;
+  String? get appInstanceId;
+  String? get appOrigin;
+  String? get appUrl;
+  String? get dwdsVersion;
+  String? get extensionUrl;
+  bool? get isInternalBuild;
+}