Move debug related webdev handlers to package:dwds (#477)

Author: grouma

dwds/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 0.4.0-dev
 
 - Move `data` abstractions from `package:webdev` into `package:dwds`.
+- Move debugging related handlers from `package:webdev` into `package:dwds`.
 
 ## 0.3.3
 

…c/serve/debugger/app_debug_services.dart dwds/lib/src/app_debug_services.dartwebdev/lib/src/serve/debugger/app_debug_services.dart renamed to dwds/lib/src/app_debug_services.dart webdev/lib/src/serve/debugger/app_debug_services.dart renamed to dwds/lib/src/app_debug_services.dart

@@ -3,18 +3,15 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async';
-import 'package:dwds/service.dart';
-// ignore: implementation_imports
-import 'package:dwds/src/chrome_proxy_service.dart' show ChromeProxyService;
 
-import '../../serve/chrome.dart';
-import '../debugger/webdev_vm_client.dart';
+import '../service.dart';
+import 'chrome_proxy_service.dart' show ChromeProxyService;
+import 'dwds_vm_client.dart';
 
 /// A container for all the services required for debugging an application.
 class AppDebugServices {
-  final Chrome chrome;
   final DebugService debugService;
-  final WebdevVmClient webdevClient;
+  final DwdsVmClient dwdsVmClient;
 
   ChromeProxyService get chromeProxyService =>
       debugService.chromeProxyService as ChromeProxyService;
@@ -24,8 +21,8 @@ class AppDebugServices {
   /// We only allow a given app to be debugged in a single tab at a time.
   String connectedInstanceId;
 
-  AppDebugServices(this.chrome, this.debugService, this.webdevClient);
+  AppDebugServices(this.debugService, this.dwdsVmClient);
 
   Future<void> close() =>
-      Future.wait([debugService.close(), webdevClient.close()]);
+      Future.wait([debugService.close(), dwdsVmClient.close()]);
 }

…dev/lib/src/serve/debugger/devtools.dart dwds/lib/src/devtools.dartwebdev/lib/src/serve/debugger/devtools.dart renamed to dwds/lib/src/devtools.dart webdev/lib/src/serve/debugger/devtools.dart renamed to dwds/lib/src/devtools.dart

@@ -6,27 +6,26 @@ import 'dart:async';
 import 'dart:convert';
 
 import 'package:dwds/service.dart';
-// ignore: implementation_imports
-import 'package:dwds/src/chrome_proxy_service.dart' show ChromeProxyService;
 import 'package:vm_service_lib/vm_service_lib.dart';
 
+import 'chrome_proxy_service.dart' show ChromeProxyService;
+
 // A client of the vm service that registers some custom extensions like
 // hotRestart.
-class WebdevVmClient {
+class DwdsVmClient {
   final VmService client;
   final StreamController<Map<String, Object>> _requestController;
   final StreamController<Map<String, Object>> _responseController;
 
-  WebdevVmClient(
-      this.client, this._requestController, this._responseController);
+  DwdsVmClient(this.client, this._requestController, this._responseController);
 
   Future<void> close() async {
     await _requestController.close();
     await _responseController.close();
     client.dispose();
   }
 
-  static Future<WebdevVmClient> create(DebugService debugService) async {
+  static Future<DwdsVmClient> create(DebugService debugService) async {
     // Set up hot restart as an extension.
     var requestController = StreamController<Map<String, Object>>();
     var responseController = StreamController<Map<String, Object>>();
@@ -76,7 +75,7 @@ class WebdevVmClient {
     });
     await client.registerService('ext.webdev.screenshot', 'WebDev');
 
-    return WebdevVmClient(client, requestController, responseController);
+    return DwdsVmClient(client, requestController, responseController);
   }
 }
 

…src/serve/debugger/webdev_vm_client.dart dwds/lib/src/dwds_vm_client.dartwebdev/lib/src/serve/debugger/webdev_vm_client.dart renamed to dwds/lib/src/dwds_vm_client.dart webdev/lib/src/serve/debugger/webdev_vm_client.dart renamed to dwds/lib/src/dwds_vm_client.dart

@@ -7,23 +7,21 @@ import 'dart:convert';
 
 import 'package:build_daemon/data/build_status.dart';
 import 'package:build_daemon/data/serializers.dart';
-import 'package:dwds/data/connect_request.dart';
-import 'package:dwds/data/devtools_request.dart';
-import 'package:dwds/data/isolate_events.dart';
-import 'package:dwds/data/run_request.dart';
-import 'package:dwds/data/serializers.dart' as dwds;
-import 'package:dwds/service.dart';
 import 'package:logging/logging.dart';
 import 'package:pedantic/pedantic.dart';
 import 'package:shelf/shelf.dart';
 import 'package:sse/server/sse_handler.dart';
 import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart';
 
-import '../../logging.dart';
-import '../chrome.dart';
-import '../debugger/app_debug_services.dart';
-import '../debugger/devtools.dart';
-import '../debugger/webdev_vm_client.dart';
+import '../../data/connect_request.dart';
+import '../../data/devtools_request.dart';
+import '../../data/isolate_events.dart';
+import '../../data/run_request.dart';
+import '../../data/serializers.dart' as dwds;
+import '../../service.dart';
+import '../app_debug_services.dart';
+import '../devtools.dart';
+import '../dwds_vm_client.dart';
 import '../handlers/asset_handler.dart';
 
 /// SSE handler to enable development features like hot reload and
@@ -39,11 +37,20 @@ class DevHandler {
   final _servicesByAppId = <String, Future<AppDebugServices>>{};
   final Stream<BuildResult> buildResults;
   final bool _verbose;
+  final void Function(Level, String) _logWriter;
+  final Future<ChromeConnection> Function() _chromeConnection;
 
   Stream<DevConnection> get connectedApps => _connectedApps.stream;
 
-  DevHandler(this.buildResults, this._devTools, this._assetHandler,
-      this._hostname, this._verbose) {
+  DevHandler(
+    this._chromeConnection,
+    this.buildResults,
+    this._devTools,
+    this._assetHandler,
+    this._hostname,
+    this._verbose,
+    this._logWriter,
+  ) {
     _sub = buildResults.listen(_emitBuildResults);
     _listen();
   }
@@ -82,7 +89,7 @@ class DevHandler {
       onResponse: _verbose
           ? (response) {
               if (response['error'] == null) return;
-              logWriter(Level.WARNING,
+              _logWriter(Level.WARNING,
                   'VmService proxy responded with an error:\n$response');
             }
           : null,
@@ -219,22 +226,21 @@ class DevHandler {
 
   Future<AppDebugServices> _createAppDebugServices(
       String appId, String instanceId) async {
-    var chrome = await Chrome.connectedInstance;
     var debugService =
-        await startDebugService(chrome.chromeConnection, instanceId);
-    logWriter(
+        await startDebugService(await _chromeConnection(), instanceId);
+    _logWriter(
         Level.INFO,
         'Debug service listening on '
         '${debugService.wsUri}\n');
 
-    var webdevClient = await WebdevVmClient.create(debugService);
-    var appServices = AppDebugServices(chrome, debugService, webdevClient);
+    var webdevClient = await DwdsVmClient.create(debugService);
+    var appServices = AppDebugServices(debugService, webdevClient);
 
     unawaited(
         appServices.chromeProxyService.tabConnection.onClose.first.then((_) {
       appServices.close();
       _servicesByAppId.remove(appId);
-      logWriter(
+      _logWriter(
           Level.INFO,
           'Stopped debug service on '
           'ws://${debugService.hostname}:${debugService.port}\n');

…ib/src/serve/handlers/asset_handler.dart dwds/lib/src/handlers/asset_handler.dartwebdev/lib/src/serve/handlers/asset_handler.dart renamed to dwds/lib/src/handlers/asset_handler.dart webdev/lib/src/serve/handlers/asset_handler.dart renamed to dwds/lib/src/handlers/asset_handler.dart

@@ -10,6 +10,7 @@ environment:
   sdk: ">=2.3.2-dev.0.1 <3.0.0"
 
 dependencies:
+  devtools: ^0.1.0
   http: ^0.12.0
   http_multi_server: ^2.0.0
   path: ^1.6.0
@@ -30,3 +31,7 @@ dev_dependencies:
   test: ^1.6.0
   webdriver: ^2.0.0
   webdev: ^2.0.0
+
+dependency_overrides:
+  webdev:
+    path: ../webdev

…/lib/src/serve/handlers/dev_handler.dart dwds/lib/src/handlers/dev_handler.dartwebdev/lib/src/serve/handlers/dev_handler.dart renamed to dwds/lib/src/handlers/dev_handler.dart webdev/lib/src/serve/handlers/dev_handler.dart renamed to dwds/lib/src/handlers/dev_handler.dart

@@ -8,10 +8,10 @@ import 'dart:io';
 
 import 'package:build_daemon/data/build_status.dart';
 import 'package:dwds/service.dart';
+import 'package:dwds/src/app_debug_services.dart'; // ignore: implementation_imports
 import 'package:pedantic/pedantic.dart';
 import 'package:vm_service_lib/vm_service_lib.dart';
 
-import '../serve/debugger/app_debug_services.dart';
 import '../serve/server_manager.dart';
 import 'daemon.dart';
 import 'domain.dart';
@@ -24,7 +24,7 @@ class AppDomain extends Domain {
 
   DebugService get _debugService => _appDebugServices?.debugService;
 
-  VmService get _vmService => _appDebugServices?.webdevClient?.client;
+  VmService get _vmService => _appDebugServices?.dwdsVmClient?.client;
   StreamSubscription<BuildResult> _resultSub;
   StreamSubscription<Event> _stdOutSub;
   bool _isShutdown = false;

dwds/pubspec.yaml

@@ -9,13 +9,13 @@ import 'package:build_daemon/client.dart';
 import 'package:build_daemon/data/build_status.dart';
 import 'package:build_daemon/data/build_target.dart';
 import 'package:build_daemon/data/server_log.dart';
+import 'package:dwds/src/devtools.dart'; // ignore: implementation_imports
 import 'package:logging/logging.dart' as logging;
 
 import '../command/configuration.dart';
 import '../daemon_client.dart';
 import '../logging.dart';
 import 'chrome.dart';
-import 'debugger/devtools.dart';
 import 'server_manager.dart';
 import 'webdev_server.dart';
 

webdev/lib/src/daemon/app_domain.dart

@@ -5,8 +5,8 @@
 import 'dart:async';
 
 import 'package:build_daemon/data/build_status.dart';
+import 'package:dwds/src/devtools.dart'; // ignore: implementation_imports
 
-import 'debugger/devtools.dart';
 import 'webdev_server.dart';
 
 /// Manages a set of [WebDevServer]s.