Merge branch 'main' of github.com:dart-lang/webdev into 25.1.1_release

Author: bkonyi

dwds/CHANGELOG.md

@@ -1,6 +1,8 @@
-## 25.1.1
+## 26.0.0
 
-- Bump SDK constraint to ^3.10.0.
+- Bump SDK constraint to ^3.10.0
+- Added 'scriptUri' parameter to compileExpressionToJs
+- Fix an issue in `reloadSources` where a `PauseInterrupted` event was sent. - [#61560](https://github.com/dart-lang/sdk/issues/61560)
 - Expose `dtdUri` via `DebugConnection`.
 
 ## 25.1.0

dwds/lib/src/debugging/debugger.dart

@@ -96,15 +96,28 @@ class Debugger extends Domain {
   bool _isStepping = false;
   DartLocation? _previousSteppingLocation;
 
+  // If not null and not completed, the pause handler completes this instead of
+  // sending a `PauseInterrupted` event to the event stream.
+  //
+  // In some cases e.g. a hot reload, DWDS pauses the execution itself in order
+  // to handle debugging logic like breakpoints. In such cases, sending the
+  // event to the event stream may trigger the client to believe that the user
+  // sent the event. To avoid that and still signal that a pause is completed,
+  // this completer is used. See https://github.com/dart-lang/sdk/issues/61560
+  // for more details.
+  Completer<void>? _internalPauseCompleter;
+
   void updateInspector(AppInspectorInterface appInspector) {
     inspector = appInspector;
     _breakpoints.inspector = appInspector;
   }
 
-  Future<Success> pause() async {
+  Future<Success> pause({bool internalPause = false}) async {
     _isStepping = false;
+    if (internalPause) _internalPauseCompleter = Completer<void>();
     final result = await _remoteDebugger.pause();
     handleErrorIfPresent(result);
+    await _internalPauseCompleter?.future;
     return Success();
   }
 
@@ -632,7 +645,14 @@ class Debugger extends Domain {
     // DevTools is showing an overlay. Both cannot be shown at the same time.
     // _showPausedOverlay();
     isolate.pauseEvent = event;
-    _streamNotify('Debug', event);
+    final internalPauseCompleter = _internalPauseCompleter;
+    if (event.kind == EventKind.kPauseInterrupted &&
+        internalPauseCompleter != null &&
+        !internalPauseCompleter.isCompleted) {
+      internalPauseCompleter.complete();
+    } else {
+      _streamNotify('Debug', event);
+    }
   }
 
   /// Handles resume events coming from the Chrome connection.

dwds/lib/src/debugging/modules.dart

@@ -22,6 +22,14 @@ class Modules {
 
   // The Dart server path to library import uri
   final _sourceToLibrary = <String, Uri>{};
+
+  // The Dart server path to library/part import uri
+  final _sourceToLibraryOrPart = <String, Uri>{};
+
+  // Library import uri to list of script (parts) dart server path for the
+  // library.
+  final _scriptsForLibrary = <Uri, List<String>>{};
+
   var _moduleMemoizer = AsyncMemoizer<void>();
 
   final Map<String, String> _libraryToModule = {};
@@ -45,7 +53,18 @@ class Modules {
       assert(_entrypoint == entrypoint);
       for (final library in modifiedModuleReport.modifiedLibraries) {
         final libraryServerPath = _getLibraryServerPath(library);
-        _sourceToLibrary.remove(libraryServerPath);
+        final libraryUri = _sourceToLibrary.remove(libraryServerPath);
+        _sourceToLibraryOrPart.remove(libraryServerPath);
+        if (libraryUri != null) {
+          final scriptServerPaths = _scriptsForLibrary[libraryUri];
+          if (scriptServerPaths != null) {
+            for (final scriptServerPath in scriptServerPaths) {
+              _sourceToLibraryOrPart.remove(scriptServerPath);
+              _sourceToLibrary.remove(scriptServerPath);
+            }
+            _scriptsForLibrary.remove(libraryUri);
+          }
+        }
         _sourceToModule.remove(libraryServerPath);
         _libraryToModule.remove(library);
       }
@@ -57,6 +76,8 @@ class Modules {
     }
     _entrypoint = entrypoint;
     _sourceToLibrary.clear();
+    _sourceToLibraryOrPart.clear();
+    _scriptsForLibrary.clear();
     _sourceToModule.clear();
     _libraryToModule.clear();
     _moduleToSources.clear();
@@ -81,6 +102,13 @@ class Modules {
     return _sourceToLibrary[serverPath];
   }
 
+  /// Returns the importUri of the library or part for the provided Dart server
+  /// path.
+  Future<Uri?> libraryOrPartForSource(String serverPath) async {
+    await _moduleMemoizer.runOnce(_initializeMapping);
+    return _sourceToLibraryOrPart[serverPath];
+  }
+
   Future<String?> moduleForLibrary(String libraryUri) async {
     await _moduleMemoizer.runOnce(_initializeMapping);
     return _libraryToModule[libraryUri];
@@ -105,7 +133,8 @@ class Modules {
       ? library
       : DartUri(library, _root).serverPath;
 
-  /// Initializes [_sourceToModule], [_moduleToSources], and [_sourceToLibrary].
+  /// Initializes [_sourceToModule], [_moduleToSources], [_sourceToLibrary] and
+  /// [_sourceToLibraryOrPart].
   ///
   /// If [modifiedModuleReport] is not null, only updates the maps for the
   /// modified libraries in the report.
@@ -125,6 +154,7 @@ class Modules {
         // it, so it's okay to only process the modified libraries.
         continue;
       }
+      final libraryUri = Uri.parse(library);
       final scripts = libraryToScripts[library]!;
       final libraryServerPath = _getLibraryServerPath(library);
 
@@ -133,15 +163,17 @@ class Modules {
 
         _sourceToModule[libraryServerPath] = module;
         _moduleToSources.putIfAbsent(module, () => {}).add(libraryServerPath);
-        _sourceToLibrary[libraryServerPath] = Uri.parse(library);
+        _sourceToLibrary[libraryServerPath] = libraryUri;
+        _sourceToLibraryOrPart[libraryServerPath] = libraryUri;
         _libraryToModule[library] = module;
 
         for (final script in scripts) {
           final scriptServerPath = _getLibraryServerPath(script);
-
           _sourceToModule[scriptServerPath] = module;
           _moduleToSources[module]!.add(scriptServerPath);
-          _sourceToLibrary[scriptServerPath] = Uri.parse(library);
+          _sourceToLibrary[scriptServerPath] = libraryUri;
+          _sourceToLibraryOrPart[scriptServerPath] = Uri.parse(script);
+          (_scriptsForLibrary[libraryUri] ??= []).add(scriptServerPath);
         }
       } else {
         _logger.warning('No module found for library $library');

dwds/lib/src/injected/client.js

@@ -1029,14 +1029,24 @@ class ChromeProxyService extends ProxyService {
     }).stream;
   }
 
+  /// If [internalPause] is true, indicates that this was a pause triggered
+  /// within DWDS, and therefore a `PauseInterrupted` event is never sent to the
+  /// VM service event stream. Instead, we just wait for the pause to be
+  /// completed.
   @override
-  Future<Success> pause(String isolateId) =>
-      wrapInErrorHandlerAsync('pause', () => _pause(isolateId));
+  Future<Success> pause(String isolateId, {bool internalPause = false}) =>
+      wrapInErrorHandlerAsync(
+        'pause',
+        () => _pause(isolateId, internalPause: internalPause),
+      );
 
-  Future<Success> _pause(String isolateId) async {
+  Future<Success> _pause(
+    String isolateId, {
+    required bool internalPause,
+  }) async {
     await isInitialized;
     _checkIsolate('pause', isolateId);
-    return (await debuggerFuture).pause();
+    return (await debuggerFuture).pause(internalPause: internalPause);
   }
 
   // Note: Ignore the optional local parameter, when it is set to `true` the
@@ -1180,9 +1190,7 @@ class ChromeProxyService extends ProxyService {
     };
 
     // Pause and wait for the pause to occur before managing breakpoints.
-    final pausedEvent = _firstStreamEvent('Debug', EventKind.kPauseInterrupted);
-    await pause(isolateId);
-    await pausedEvent;
+    await pause(isolateId, internalPause: true);
 
     await _reinitializeForHotReload(reloadedModulesToLibraries);
 
@@ -1513,11 +1521,6 @@ class ChromeProxyService extends ProxyService {
     });
   }
 
-  Future<void> _firstStreamEvent(String streamId, String eventKind) {
-    final controller = streamControllers[streamId]!;
-    return controller.stream.firstWhere((event) => event.kind == eventKind);
-  }
-
   Future<void> _handleDeveloperLog(
     IsolateRef isolateRef,
     ConsoleAPIEvent event,

dwds/lib/src/services/chrome_proxy_service.dart

@@ -63,6 +63,7 @@ abstract class ExpressionCompiler {
   Future<ExpressionCompilationResult> compileExpressionToJs(
     String isolateId,
     String libraryUri,
+    String scriptUri,
     int line,
     int column,
     Map<String, String> jsModules,

dwds/lib/src/services/expression_compiler.dart

@@ -144,6 +144,7 @@ class _Compiler {
 
   Future<ExpressionCompilationResult> compileExpressionToJs(
     String libraryUri,
+    String scriptUri,
     int line,
     int column,
     Map<String, String> jsModules,
@@ -171,6 +172,7 @@ class _Compiler {
       'jsModules': jsModules,
       'jsScope': jsFrameValues,
       'libraryUri': libraryUri,
+      'scriptUri': scriptUri,
       'moduleName': moduleName,
     });
 
@@ -241,6 +243,7 @@ class ExpressionCompilerService implements ExpressionCompiler {
   Future<ExpressionCompilationResult> compileExpressionToJs(
     String isolateId,
     String libraryUri,
+    String scriptUri,
     int line,
     int column,
     Map<String, String> jsModules,
@@ -249,6 +252,7 @@ class ExpressionCompilerService implements ExpressionCompiler {
     String expression,
   ) async => (await _compiler.future).compileExpressionToJs(
     libraryUri,
+    scriptUri,
     line,
     column,
     jsModules,

dwds/lib/src/services/expression_compiler_service.dart

@@ -125,6 +125,9 @@ class ExpressionEvaluator {
     final compilationResult = await _compiler.compileExpressionToJs(
       isolateId,
       libraryUri.toString(),
+      // Evaluating at "the library level" (and passing line 0 column 0) we'll
+      // also just pass the library uri as the script uri.
+      libraryUri.toString(),
       0,
       0,
       {},
@@ -280,6 +283,7 @@ class ExpressionEvaluator {
     final dartLocation = locationMap.dartLocation;
     final dartSourcePath = dartLocation.uri.serverPath;
     final libraryUri = await _modules.libraryForSource(dartSourcePath);
+    final scriptUri = await _modules.libraryOrPartForSource(dartSourcePath);
     if (libraryUri == null) {
       return createError(
         EvaluationErrorKind.internal,
@@ -298,6 +302,7 @@ class ExpressionEvaluator {
     _logger.finest(
       'Evaluating "$expression" at $module, '
       '$libraryUri:${dartLocation.line}:${dartLocation.column} '
+      'or rather $scriptUri:${dartLocation.line}:${dartLocation.column} '
       'with scope: $scope',
     );
 
@@ -317,6 +322,7 @@ class ExpressionEvaluator {
     final compilationResult = await _compiler.compileExpressionToJs(
       isolateId,
       libraryUri.toString(),
+      scriptUri.toString(),
       dartLocation.line,
       dartLocation.column,
       {},

dwds/lib/src/services/expression_evaluator.dart

@@ -1,6 +1,6 @@
 name: dwds
 # Every time this changes you need to run `dart run build_runner build`.
-version: 25.1.1
+version: 26.0.0
 
 description: >-
   A service that proxies between the Chrome debug protocol and the Dart VM