Potential partial fix for broken socket exceptions (#1417)

* Handle http request serving errors

* Update changelogs, versions, build

* Addressed CR comments

* Addressed CR comments

Author: Anna Gringauze

dwds/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 11.4.0
 
 - Fix duplicated scripts returned by `VmService.getScripts` API.
+- Handle and log http request serving errors.
 - Encode extension url asynchronously.
 - Use default constant port for debug service.
   - If we fail binding to the port, fall back to previous strategy

dwds/lib/src/injected/client.js

@@ -4,20 +4,25 @@
 
 // @dart = 2.9
 
+import 'dart:async';
 import 'dart:io';
 
 import 'package:async/async.dart';
+
 import 'package:http_multi_server/http_multi_server.dart';
+import 'package:logging/logging.dart';
 import 'package:shelf/shelf.dart';
-import 'package:shelf/shelf_io.dart';
 
 import '../../data/extension_request.dart';
 import '../handlers/socket_connections.dart';
+import '../utilities/shared.dart';
 import 'extension_debugger.dart';
 
 const authenticationResponse = 'Dart Debug Authentication Success!\n\n'
     'You can close this tab and launch the Dart Debug Extension again.';
 
+Logger _logger = Logger('ExtensiobBackend');
+
 /// A backend for the Dart Debug Extension.
 ///
 /// Sets up an SSE handler to communicate with the extension background.
@@ -50,7 +55,9 @@ class ExtensionBackend {
       return Response.notFound('');
     }).add(_socketHandler.handler);
     var server = await HttpMultiServer.bind(hostname, 0);
-    serveRequests(server, cascade.handler);
+    serveHttpRequests(server, cascade.handler, (e, s) {
+      _logger.warning('Error serving requests', e, s);
+    });
     return ExtensionBackend._(
         _socketHandler, server.address.host, server.port, server);
   }

dwds/lib/src/servers/extension_backend.dart

@@ -11,10 +11,10 @@ import 'dart:math';
 import 'dart:typed_data';
 
 import 'package:dds/dds.dart';
+import 'package:logging/logging.dart';
 import 'package:pedantic/pedantic.dart';
 import 'package:shelf/shelf.dart' as shelf;
 import 'package:shelf/shelf.dart' hide Response;
-import 'package:shelf/shelf_io.dart';
 import 'package:shelf_web_socket/shelf_web_socket.dart';
 import 'package:sse/server/sse_handler.dart';
 import 'package:vm_service/vm_service.dart';
@@ -29,6 +29,8 @@ import 'chrome_proxy_service.dart';
 bool _acceptNewConnections = true;
 int _clientsConnected = 0;
 
+Logger _logger = Logger('DebugService');
+
 void Function(WebSocketChannel, String) _createNewConnectionHandler(
   ChromeProxyService chromeProxyService,
   ServiceExtensionRegistry serviceExtensionRegistry, {
@@ -253,7 +255,9 @@ class DebugService {
       };
     }
     var server = await startHttpServer(hostname, port: 44456);
-    serveRequests(server, handler);
+    serveHttpRequests(server, handler, (e, s) {
+      _logger.warning('Error serving requests', e, s);
+    });
     return DebugService._(
       chromeProxyService,
       server.address.host,

dwds/lib/src/services/debug_service.dart

@@ -4,11 +4,16 @@
 
 // @dart = 2.9
 
+import 'dart:async';
 import 'dart:io';
 
 import 'package:http_multi_server/http_multi_server.dart';
+import 'package:shelf/shelf.dart';
+import 'package:shelf/shelf_io.dart';
+import 'package:stack_trace/stack_trace.dart';
 import 'package:vm_service/vm_service.dart';
-import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart';
+import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart'
+    as wip;
 
 import '../../dwds.dart' show ChromeDebugException;
 
@@ -72,9 +77,20 @@ Future<HttpServer> startHttpServer(String hostname, {int port}) async {
   return httpServer;
 }
 
-/// Throws an [ExceptionDetails] object if `exceptionDetails` is present on the
+/// Handles [requests] using [handler].
+///
+/// Captures all sync and async stack error traces and passes
+/// them to the [onError] handler.
+void serveHttpRequests(Stream<HttpRequest> requests, Handler handler,
+    void Function(Object, StackTrace) onError) {
+  return Chain.capture(() {
+    serveRequests(requests, handler);
+  }, onError: onError);
+}
+
+/// Throws an [wip.ExceptionDetails] object if `exceptionDetails` is present on the
 /// result.
-void handleErrorIfPresent(WipResponse response,
+void handleErrorIfPresent(wip.WipResponse response,
     {String evalContents, Object additionalDetails}) {
   if (response == null) return;
   if (response.result.containsKey('exceptionDetails')) {

dwds/lib/src/utilities/shared.dart

@@ -30,6 +30,7 @@ dependencies:
   shelf_static: ^1.0.0
   shelf_web_socket: ^1.0.0
   source_maps: ^0.10.0
+  stack_trace: ^1.10.0
   sse: ^4.1.0
   # We pin the version because we implement the interface.
   vm_service: 7.3.0

dwds/pubspec.yaml

@@ -10,13 +10,15 @@ import 'dart:io';
 
 import 'package:dwds/dwds.dart';
 import 'package:dwds/src/utilities/shared.dart';
+import 'package:logging/logging.dart';
 import 'package:path/path.dart' as p;
 import 'package:shelf/shelf.dart';
-import 'package:shelf/shelf_io.dart' as shelf_io;
 import 'package:test/test.dart';
 
 import 'fixtures/logging.dart';
 
+Logger _logger = Logger('ExpressionCompilerServiceTest');
+
 @TestOn('vm')
 void main() async {
   group('expression compiler service with fake asset server', () {
@@ -65,8 +67,11 @@ void main() async {
       await service.initialize(moduleFormat: 'amd');
 
       // setup asset server
-      shelf_io.serveRequests(
-          server, Cascade().add(service.handler).add(assetHandler).handler);
+      serveHttpRequests(
+          server, Cascade().add(service.handler).add(assetHandler).handler,
+          (e, s) {
+        _logger.warning('Error serving requests', e, s);
+      });
 
       // generate full dill
       File.fromUri(source)

dwds/test/expression_compiler_service_test.dart

@@ -10,10 +10,10 @@ import 'package:build_daemon/data/build_status.dart' as daemon;
 import 'package:devtools_server/devtools_server.dart' as devtools_lancher;
 import 'package:dwds/data/build_result.dart';
 import 'package:dwds/dwds.dart';
+import 'package:dwds/src/utilities/shared.dart';
 import 'package:http_multi_server/http_multi_server.dart';
 import 'package:logging/logging.dart';
 import 'package:shelf/shelf.dart';
-import 'package:shelf/shelf_io.dart' as shelf_io;
 import 'package:webkit_inspection_protocol/webkit_inspection_protocol.dart';
 
 Logger _logger = Logger('TestServer');
@@ -127,12 +127,14 @@ class TestServer {
       cascade = cascade.add(ddcService.handler);
     }
 
-    shelf_io.serveRequests(
+    serveHttpRequests(
         server,
         pipeline
             .addMiddleware(_logRequests)
             .addMiddleware(dwds.middleware)
-            .addHandler(cascade.handler));
+            .addHandler(cascade.handler), (e, s) {
+      _logger.warning('Error handling requests', e, s);
+    });
 
     return TestServer._(
       target,

dwds/test/fixtures/server.dart

@@ -1,3 +1,7 @@
+## 2.7.7-dev
+
+- Handle and log http request serving errors.
+
 ## 2.7.6
 
 - Update SDK constraint to `>=2.14.0 <3.0.0`

webdev/CHANGELOG.md

@@ -14,14 +14,17 @@ import 'package:dwds/dwds.dart';
 import 'package:http/http.dart' as http;
 import 'package:http/io_client.dart';
 import 'package:http_multi_server/http_multi_server.dart';
+import 'package:logging/logging.dart';
 import 'package:shelf/shelf.dart';
-import 'package:shelf/shelf_io.dart' as shelf_io;
 import 'package:shelf_proxy/shelf_proxy.dart';
 
 import '../command/configuration.dart';
+import '../util.dart';
 import 'chrome.dart';
 import 'handlers/favicon_handler.dart';
 
+Logger _logger = Logger('WebDevServer');
+
 class ServerOptions {
   final Configuration configuration;
   final int port;
@@ -179,7 +182,10 @@ class WebDevServer {
       server = await HttpMultiServer.bind(hostname, options.port);
     }
 
-    shelf_io.serveRequests(server, pipeline.addHandler(cascade.handler));
+    serveHttpRequests(server, pipeline.addHandler(cascade.handler), (e, s) {
+      _logger.warning('Error serving requests', e, s);
+    });
+
     return WebDevServer._(
       options.target,
       server,

webdev/lib/src/serve/webdev_server.dart

@@ -4,12 +4,27 @@
 
 // @dart = 2.9
 
+import 'dart:async';
 import 'dart:io';
 
 import 'package:path/path.dart' as p;
+import 'package:shelf/shelf.dart';
+import 'package:shelf/shelf_io.dart';
+import 'package:stack_trace/stack_trace.dart';
 
 const appName = 'webdev';
 
+/// Handles [requests] using [handler].
+///
+/// Captures all sync and async stack error traces and passes
+/// them to the [onError] handler.
+void serveHttpRequests(Stream<HttpRequest> requests, Handler handler,
+    void Function(Object, StackTrace) onError) {
+  return Chain.capture(() {
+    serveRequests(requests, handler);
+  }, onError: onError);
+}
+
 /// The path to the root directory of the SDK.
 final String _sdkDir = (() {
   // The Dart executable is in "/path/to/sdk/bin/dart", so two levels up is

webdev/lib/src/util.dart

@@ -1,6 +1,6 @@
 name: webdev
 # Every time this changes you need to run `pub run build_runner build`.
-version: 2.7.6
+version: 2.7.7-dev
 # We should not depend on a dev SDK before publishing.
 # publish_to: none
 homepage: https://github.com/dart-lang/webdev
@@ -32,6 +32,7 @@ dependencies:
   shelf: ^1.0.0
   shelf_proxy: ^1.0.0
   shelf_static: ^1.0.0
+  stack_trace: ^1.10.0
   sse: ^4.1.0
   vm_service: '>=3.0.0 <8.0.0'
   webkit_inspection_protocol: '>=0.4.0 <2.0.0'