[dds/dap] Allow debug adapters to register multiple mappings for org-dartland-sdk URIs

Change-Id: Ibcb0f145d64c7cd7712c031737741b2dbc4aaab8
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/265500
Reviewed-by: Ben Konyi <bkonyi@google.com>
Commit-Queue: Ben Konyi <bkonyi@google.com>

pkg/dds/CHANGELOG.md

@@ -1,7 +1,8 @@
-# 2.5.0-dev
+# 2.5.0
 - [DAP] `variables` requests now treat lists from `dart:typed_data` (such as `Uint8List`) like standard `List` instances and return their elements instead of class fields.
 - [DAP] `variables` requests now return information about the number of items in lists to allow the client to page through them.
 - [DAP] `terminated` events are now always sent when detaching whether or not the debuggee terminates after unpause.
+- [DAP] Debug adapters can now add/overwrite `orgDartlangSdkMappings` to control mappings of `org-dartlang-sdk:///` paths.
 
 # 2.4.0
 - [DAP] Added support for sending progress notifications via `DartDebugAdapter.startProgressNotification`.

pkg/dds/lib/src/dap/adapters/dart.dart

@@ -325,7 +325,14 @@ abstract class DartDebugAdapter<TL extends LaunchRequestArguments,
   vm.VmServiceInterface? vmService;
 
   /// The root of the Dart SDK containing the VM running the debug adapter.
-  late final String sdkRoot;
+  late final String dartSdkRoot;
+
+  /// Mappings of file paths to 'org-dartlang-sdk:///' URIs used for translating
+  /// URIs/paths between the DAP client and the VM.
+  ///
+  /// Keys are the base file paths and the values are the base URIs. Neither
+  /// value should contain trailing slashes.
+  final Map<String, Uri> orgDartlangSdkMappings = {};
 
   /// The DDS instance that was started and that [vmService] is connected to.
   ///
@@ -450,7 +457,8 @@ abstract class DartDebugAdapter<TL extends LaunchRequestArguments,
     channel.closed.then((_) => shutdown());
 
     final vmPath = Platform.resolvedExecutable;
-    sdkRoot = path.dirname(path.dirname(vmPath));
+    dartSdkRoot = path.dirname(path.dirname(vmPath));
+    orgDartlangSdkMappings[dartSdkRoot] = Uri.parse('org-dartlang-sdk:///sdk');
 
     _isolateManager = IsolateManager(this);
     _converter = ProtocolConverter(this);
@@ -1316,16 +1324,6 @@ abstract class DartDebugAdapter<TL extends LaunchRequestArguments,
     );
   }
 
-  /// The default location for [dartlangSdkRootUri].
-  final _defaultDartlangSdkRootUri = Uri.parse('org-dartlang-sdk:///sdk');
-
-  /// The (org-dartlang-sdk) URI for the root of the Dart SDK.
-  ///
-  /// This can be overriden by debug adapters like Flutter where the Dart SDK
-  /// root is at another path (such as
-  /// `org-dartlang-sdk:///third_party/dart/sdk/`).
-  Uri get dartlangSdkRootUri => _defaultDartlangSdkRootUri;
-
   /// Converts a URI in the form org-dartlang-sdk:///sdk/lib/collection/hash_set.dart
   /// to a local file path based on the current SDK.
   String? convertOrgDartlangSdkToPath(Uri uri) {
@@ -1337,12 +1335,15 @@ abstract class DartDebugAdapter<TL extends LaunchRequestArguments,
     // We currently only handle the sdk folder, as we don't know which runtime
     // is being used (this code is shared) and do not want to map to the wrong
     // sources.
-    if (uri.pathSegments.isNotEmpty &&
-        uri.path.startsWith(dartlangSdkRootUri.path)) {
-      return path.joinAll([
-        sdkRoot,
-        ...uri.pathSegments.skip(dartlangSdkRootUri.pathSegments.length),
-      ]);
+    for (final mapping in orgDartlangSdkMappings.entries) {
+      final mapPath = mapping.key;
+      final mapUri = mapping.value;
+      if (uri.isScheme(mapUri.scheme) && uri.path.startsWith(mapUri.path)) {
+        return path.joinAll([
+          mapPath,
+          ...uri.pathSegments.skip(mapUri.pathSegments.length),
+        ]);
+      }
     }
 
     return null;
@@ -1351,16 +1352,17 @@ abstract class DartDebugAdapter<TL extends LaunchRequestArguments,
   /// Converts a file path inside the current SDK root into a URI in the form
   /// org-dartlang-sdk:///sdk/lib/collection/hash_set.dart.
   Uri? convertPathToOrgDartlangSdk(String input) {
-    if (path.isWithin(sdkRoot, input)) {
-      final relative = path.relative(input, from: sdkRoot);
-      return Uri(
-        scheme: dartlangSdkRootUri.scheme,
-        host: '',
-        pathSegments: [
-          ...dartlangSdkRootUri.pathSegments,
-          ...path.split(relative)
-        ],
-      );
+    for (final mapping in orgDartlangSdkMappings.entries) {
+      final mapPath = mapping.key;
+      final mapUri = mapping.value;
+      if (path.isWithin(mapPath, input)) {
+        final relative = path.relative(input, from: mapPath);
+        return Uri(
+          scheme: mapUri.scheme,
+          host: '',
+          pathSegments: [...mapUri.pathSegments, ...path.split(relative)],
+        );
+      }
     }
 
     return null;

pkg/dds/lib/src/dap/isolate_manager.dart

@@ -998,10 +998,8 @@ class ThreadInfo {
       return null;
     } else if (input.isScheme('file')) {
       return input.toFilePath();
-    } else if (input.isScheme(_manager._adapter.dartlangSdkRootUri.scheme)) {
-      return _manager._adapter.convertOrgDartlangSdkToPath(input);
     } else {
-      return null;
+      return _manager._adapter.convertOrgDartlangSdkToPath(input);
     }
   }
 

pkg/dds/pubspec.yaml

@@ -1,5 +1,5 @@
 name: dds
-version: 2.4.0
+version: 2.5.0
 description: >-
   A library used to spawn the Dart Developer Service, used to communicate with
   a Dart VM Service instance.

pkg/dds/test/dap/base_adapter_test.dart

@@ -2,8 +2,10 @@
 // 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 'dart:async';
 import 'dart:io';
 
+import 'package:dds/src/dap/protocol_stream.dart';
 import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
@@ -14,54 +16,104 @@ main() {
     final vmPath = Platform.resolvedExecutable;
     final sdkRoot = path.dirname(path.dirname(vmPath));
 
-    final sdkCorePath = path.join(sdkRoot, 'lib', 'core.dart');
-    final defaultCoreUri = Uri.parse('org-dartlang-sdk:///sdk/lib/core.dart');
-
-    group('default org-dartlang-sdk', () {
+    group('default Dart SDK', () {
+      final testPath = path.join(sdkRoot, 'lib', 'core.dart');
+      final testUri = Uri.parse('org-dartlang-sdk:///sdk/lib/core.dart');
       final adapter = MockDartCliDebugAdapter();
 
-      test('can SDK paths to org-dartlang-sdk:///', () async {
+      test('converts SDK paths to org-dartlang-sdk:///', () async {
         expect(
-          adapter.convertPathToOrgDartlangSdk(sdkCorePath),
-          defaultCoreUri,
+          adapter.convertPathToOrgDartlangSdk(testPath),
+          testUri,
         );
       });
 
       test('converts org-dartlang-sdk:/// to SDK paths', () async {
         expect(
-          adapter.convertOrgDartlangSdkToPath(defaultCoreUri),
-          sdkCorePath,
+          adapter.convertOrgDartlangSdkToPath(testUri),
+          testPath,
         );
       });
     });
 
-    group('custom org-dartlang-sdk', () {
-      final adapter = MockDartCliDebugAdapter()
-        ..dartlangSdkRootUriOverride =
-            Uri.parse('org-dartlang-sdk:///custom/sdk');
-      final customCoreUri =
-          Uri.parse('org-dartlang-sdk:///custom/sdk/lib/core.dart');
+    group('custom Dart SDK', () {
+      final testPath = path.join(sdkRoot, 'lib', 'core.dart');
+      final testUri =
+          Uri.parse('org-dartlang-sdk:///custom-dart/sdk/lib/core.dart');
+      final defaultSdkTestUri =
+          Uri.parse('org-dartlang-sdk:///sdk/lib/core.dart');
+      final adapter = MockCustomDartCliDebugAdapter(
+          {sdkRoot: Uri.parse('org-dartlang-sdk:///custom-dart/sdk')});
 
       test('converts SDK paths to custom org-dartlang-sdk:///', () async {
         expect(
-          adapter.convertPathToOrgDartlangSdk(sdkCorePath),
-          customCoreUri,
+          adapter.convertPathToOrgDartlangSdk(testPath),
+          testUri,
         );
       });
 
       test('converts custom org-dartlang-sdk:/// to SDK paths', () async {
         expect(
-          adapter.convertOrgDartlangSdkToPath(customCoreUri),
-          sdkCorePath,
+          adapter.convertOrgDartlangSdkToPath(testUri),
+          testPath,
         );
       });
 
-      test('does not convert default org-dartlang-sdk:///', () async {
+      test('does not convert default org-dartlang-sdk:/// to SDK paths',
+          () async {
         expect(
-          adapter.convertOrgDartlangSdkToPath(defaultCoreUri),
+          adapter.convertOrgDartlangSdkToPath(defaultSdkTestUri),
           isNull,
         );
       });
     });
+
+    group('additional SDKs', () {
+      final customSdkRootPath = path.join('my', 'flutter', 'sdk');
+      final customSdkRootUri = Uri.parse('org-dartlang-sdk:///flutter/sdk');
+      final testPath = path.join(customSdkRootPath, 'lib', 'ui.dart');
+      final testUri = Uri.parse('org-dartlang-sdk:///flutter/sdk/lib/ui.dart');
+      final adapter = MockCustomDartCliDebugAdapter({
+        customSdkRootPath: customSdkRootUri,
+      });
+
+      test('converts additional SDK paths to custom org-dartlang-sdk:///',
+          () async {
+        expect(
+          adapter.convertPathToOrgDartlangSdk(testPath),
+          testUri,
+        );
+      });
+
+      test('converts additional SDK org-dartlang-sdk:/// to paths', () async {
+        expect(
+          adapter.convertOrgDartlangSdkToPath(testUri),
+          testPath,
+        );
+      });
+    });
   });
 }
+
+class MockCustomDartCliDebugAdapter extends MockDartCliDebugAdapter {
+  factory MockCustomDartCliDebugAdapter(Map<String, Uri> customMappings) {
+    final stdinController = StreamController<List<int>>();
+    final stdoutController = StreamController<List<int>>();
+    final channel = ByteStreamServerChannel(
+        stdinController.stream, stdoutController.sink, null);
+
+    return MockCustomDartCliDebugAdapter._(
+        customMappings, stdinController.sink, stdoutController.stream, channel);
+  }
+
+  MockCustomDartCliDebugAdapter._(
+      Map<String, Uri> customMappings,
+      StreamSink<List<int>> stdin,
+      Stream<List<int>> stdout,
+      ByteStreamServerChannel channel)
+      : super.withStreams(stdin, stdout, channel) {
+    orgDartlangSdkMappings
+      ..clear()
+      ..addAll(customMappings);
+  }
+}

pkg/dds/test/dap/mocks.dart

@@ -26,20 +26,11 @@ class MockDartCliDebugAdapter extends DartCliDebugAdapter {
     final channel = ByteStreamServerChannel(
         stdinController.stream, stdoutController.sink, null);
 
-    return MockDartCliDebugAdapter._(
+    return MockDartCliDebugAdapter.withStreams(
         stdinController.sink, stdoutController.stream, channel);
   }
 
-  /// An override for [dartlangSdkRootUri].
-  ///
-  /// If not set, the default base value will be used.
-  Uri? dartlangSdkRootUriOverride;
-
-  @override
-  Uri get dartlangSdkRootUri =>
-      dartlangSdkRootUriOverride ?? super.dartlangSdkRootUri;
-
-  MockDartCliDebugAdapter._(
+  MockDartCliDebugAdapter.withStreams(
       this.stdin, this.stdout, ByteStreamServerChannel channel)
       : super(channel);