Add a new workspaceName parameter to DWDS on start up (#2237)

Author: elliette

dwds/CHANGELOG.md

@@ -1,10 +1,11 @@
 ## 22.0.0-wip
 
+- Update the interface for ChromeProxyService.getSourceReport to match the VM service. - [#2235](https://github.com/dart-lang/webdev/pull/2235)
+
 **Breaking changes**
 
 - Refactor the parameters to `Dwds.start`. - [#2231](https://github.com/dart-lang/webdev/pull/2231).
-
-- Update the interface for ChromeProxyService.getSourceReport to match the VM service. - [#2235](https://github.com/dart-lang/webdev/pull/2235)
+- Add a new parameter `workspaceName` to the `ToolConfiguration` passed to `Dwds.start`. - [#2237](https://github.com/dart-lang/webdev/pull/2237)
 
 ## 21.0.0
 

dwds/lib/src/config/tool_configuration.dart

@@ -36,11 +36,13 @@ ToolConfiguration get globalToolConfiguration => _globalToolConfiguration;
 class AppMetadata {
   final String hostname;
   final bool isInternalBuild;
+  final String? workspaceName;
   Future<bool> Function() isFlutterApp;
 
   AppMetadata({
     this.hostname = 'localhost',
     this.isInternalBuild = false,
+    this.workspaceName,
     Future<bool> Function()? isFlutterApp,
   }) : isFlutterApp = isFlutterApp ?? (() => Future.value(true));
 }

dwds/lib/src/handlers/injector.dart

@@ -200,5 +200,9 @@ Future<String> _injectedClientSnippet(
   if (extensionUri != null) {
     injectedBody += 'window.\$dartExtensionUri = "$extensionUri";\n';
   }
+  final workspaceName = globalToolConfiguration.appMetadata.workspaceName;
+  if (workspaceName != null) {
+    injectedBody += 'window.\$dartWorkspaceName = "$workspaceName";\n';
+  }
   return injectedBody;
 }

dwds/lib/src/injected/client.js

@@ -154,6 +154,7 @@ class TestContext {
     bool isInternalBuild = false,
     List<String> experiments = const <String>[],
     bool canaryFeatures = false,
+    String? workspaceName,
   }) async {
     final sdkLayout = sdkConfigurationProvider.sdkLayout;
     final toolConfiguration = createToolConfiguration(
@@ -171,6 +172,7 @@ class TestContext {
         hostname: hostname,
         isInternalBuild: isInternalBuild,
         isFlutterApp: () => Future.value(isFlutterApp),
+        workspaceName: workspaceName,
       ),
     );
     setGlobalsForTesting(toolConfiguration: toolConfiguration);
@@ -427,6 +429,7 @@ class TestContext {
         ddcService,
         isFlutterApp,
         isInternalBuild,
+        workspaceName,
         sdkLayout,
       );
 

dwds/test/fixtures/context.dart

@@ -82,6 +82,7 @@ class TestServer {
     ExpressionCompilerService? ddcService,
     bool isFlutterApp,
     bool isInternalBuild,
+    String? workspaceName,
     TestSdkLayout sdkLayout,
   ) async {
     var pipeline = const Pipeline();
@@ -132,6 +133,7 @@ class TestServer {
       hostname: hostname,
       isInternalBuild: isInternalBuild,
       isFlutterApp: () => Future.value(isFlutterApp),
+      workspaceName: workspaceName,
     );
 
     final toolConfiguration = ToolConfiguration(

dwds/test/fixtures/server.dart

@@ -59,6 +59,7 @@ void testAll({
             extensionPath: extensionPath,
             serveDevTools: true,
             useSse: useSse,
+            workspaceName: 'test-workspace',
           );
 
           if (isMV3) {
@@ -111,6 +112,7 @@ void testAll({
           expect(debugInfo.appUrl, isNotNull);
           expect(debugInfo.isInternalBuild, isNotNull);
           expect(debugInfo.isFlutterApp, isNotNull);
+          expect(debugInfo.workspaceName, isNotNull);
           await appTab.close();
         });
 

dwds/test/puppeteer/extension_common.dart

@@ -42,6 +42,7 @@ Future<Browser> setUpExtensionTest(
   bool isInternalBuild = false,
   bool isFlutterApp = false,
   bool openChromeDevTools = false,
+  String? workspaceName,
 }) async {
   // TODO(elliette): Only start a TestServer, that way we can get rid of the
   // launchChrome parameter: https://github.com/dart-lang/webdev/issues/1779
@@ -52,6 +53,7 @@ Future<Browser> setUpExtensionTest(
     enableDebugExtension: true,
     isInternalBuild: isInternalBuild,
     isFlutterApp: isFlutterApp,
+    workspaceName: workspaceName,
   );
   return await puppeteer.launch(
     devTools: openChromeDevTools,

dwds/test/puppeteer/test_utils.dart

@@ -271,7 +271,8 @@ void _launchCommunicationWithDebugExtension() {
           ..authUrl = _authUrl
           ..extensionUrl = _extensionUrl
           ..isInternalBuild = _isInternalBuild
-          ..isFlutterApp = _isFlutterApp,
+          ..isFlutterApp = _isFlutterApp
+          ..workspaceName = dartWorkspaceName,
       ),
     ),
   );
@@ -358,6 +359,9 @@ external bool get isInternalBuild;
 @JS(r'$isFlutterApp')
 external bool get isFlutterApp;
 
+@JS(r'$dartWorkspaceName')
+external String? get dartWorkspaceName;
+
 bool get _isChromium => window.navigator.vendor.contains('Google');
 
 JsObject get _windowContext => JsObject.fromBrowserObject(window);