Defer execution of main until resume for hot restart with DDC library bundle format (#2623)

pause_isolates_on_start tells DWDS and the client that during a
hot restart or a hot reload, the VM service will pause and is
actively waiting for the client to remove existing breakpoints,
reregister them, and then resume. It lets the client know by
sending a kPausePostRequest event.

In order to do this in DWDS, we need to defer the execution of
main until that resume. So, like we do with the require
restarter, we wait for a completer to finish before we call
main after a hot restart. This completer is only provided when
the flag is enabled.

Fixes existing code that marks the completer as completed before
running main. The previous code canceled the subscription in an
unawaited Future. This may result in us recalling main because
the event stream could still have a listener. An example is if
we hit a breakpoint immediately after main and call resume.

Also fixes an issue where metadata information isn't recomputed
on a hot restart. This is needed when new files are added.

Fixes some hot restart tests that should wait for main to execute.

Adds tests for:

- Modifying a line with a breakpoint and restarting.
- Adding a line before a breakpoint and restarting.
- Removing a line before a breakpoint and restarting.
- Adding a file and putting a breakpoint in it before restarting.

Author: srujzs

dwds/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Added WebSocket-based hot reload support: `reloadSources` in `ChromeProxyService` and `DevHandler` now handle hot reload requests and responses over WebSockets.
 - Refactored the injected client to use a reusable function for handling hot reload requests and responses over WebSockets.
+- Added support for breakpoint registering on a hot restart with the DDC library bundle format using PausePostRequests.
 
 ## 24.3.10
 

dwds/lib/src/dwds_vm_client.dart

@@ -9,7 +9,6 @@ import 'package:dwds/src/events.dart';
 import 'package:dwds/src/services/chrome_debug_exception.dart';
 import 'package:dwds/src/services/chrome_proxy_service.dart';
 import 'package:dwds/src/services/debug_service.dart';
-import 'package:dwds/src/utilities/shared.dart';
 import 'package:dwds/src/utilities/synchronized.dart';
 import 'package:logging/logging.dart';
 import 'package:uuid/uuid.dart';
@@ -443,24 +442,14 @@ Future<Map<String, dynamic>> _hotRestart(
 }
 
 void _waitForResumeEventToRunMain(ChromeProxyService chromeProxyService) {
-  final issuedReadyToRunMainCompleter = Completer<void>();
-
-  final resumeEventsSubscription = chromeProxyService
-      .resumeAfterRestartEventsStream
+  StreamSubscription<String>? resumeEventsSubscription;
+  resumeEventsSubscription = chromeProxyService.resumeAfterRestartEventsStream
       .listen((_) async {
+        await resumeEventsSubscription!.cancel();
         await chromeProxyService.inspector.jsEvaluate(
           '\$dartReadyToRunMain();',
         );
-        if (!issuedReadyToRunMainCompleter.isCompleted) {
-          issuedReadyToRunMainCompleter.complete();
-        }
       });
-
-  safeUnawaited(
-    issuedReadyToRunMainCompleter.future.then((_) {
-      resumeEventsSubscription.cancel();
-    }),
-  );
 }
 
 Future<Map<String, dynamic>> _fullReload(

dwds/lib/src/handlers/dev_handler.dart

@@ -538,18 +538,11 @@ class DevHandler {
     Stream<String> resumeEventsStream,
     Completer<void> readyToRunMainCompleter,
   ) {
-    final resumeEventsSubscription = resumeEventsStream.listen((_) {
+    StreamSubscription<String>? resumeEventsSubscription;
+    resumeEventsSubscription = resumeEventsStream.listen((_) async {
+      await resumeEventsSubscription!.cancel();
       readyToRunMainCompleter.complete();
-      if (!readyToRunMainCompleter.isCompleted) {
-        readyToRunMainCompleter.complete();
-      }
     });
-
-    safeUnawaited(
-      readyToRunMainCompleter.future.then((_) {
-        resumeEventsSubscription.cancel();
-      }),
-    );
   }
 
   void _handleIsolateExit(AppConnection appConnection) {