Hide using debug symbols under a flag, update versions and changelog

Author: Anna Gringauze

dwds/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 12.0.0-dev
+
+- Add code for loading symbols generated by DDC, if
+  `enableDebugSymbols` is set to `true` in `dwds.start`.
+  To be used by variable inspection, not implemented yet.
+
+**Breaking changes:**
+  - Add `enableDebugSymbols` parameter `Dwds.start`, false by default.
+  - Add `symbolsContents` method to `AssetReader`.
+  
 ## 11.1.0
 
 - Add global functions to the injected client for `dart.developer.postEvent`

dwds/lib/dwds.dart

@@ -101,6 +101,7 @@ class Dwds {
     // TODO(annagrin): make expressionCompiler argument required
     // [issue 881](https://github.com/dart-lang/webdev/issues/881)
     ExpressionCompiler expressionCompiler,
+    bool enableDebugSymbols,
     bool enableDebugExtension,
     String hostname,
     bool useSseForDebugProxy,
@@ -120,6 +121,7 @@ class Dwds {
     enableDevtoolsLaunch ??= true;
     spawnDds ??= true;
     globalLoadStrategy = loadStrategy;
+    enableDebugSymbols ??= false;
 
     DevTools devTools;
     String extensionUri;
@@ -172,6 +174,7 @@ class Dwds {
       useSseForInjectedClient,
       serveDevTools,
       expressionCompiler,
+      enableDebugSymbols,
       injected,
       spawnDds,
     );

dwds/lib/src/handlers/dev_handler.dart

@@ -64,6 +64,7 @@ class DevHandler {
   final bool _serveDevTools;
   final bool _spawnDds;
   final ExpressionCompiler _expressionCompiler;
+  final bool _enableDebugSymbols;
   final DwdsInjector _injected;
 
   /// Null until [close] is called.
@@ -86,6 +87,7 @@ class DevHandler {
       this._useSseForInjectedClient,
       this._serveDevTools,
       this._expressionCompiler,
+      this._enableDebugSymbols,
       this._injected,
       this._spawnDds) {
     _subs.add(buildResults.listen(_emitBuildResults));
@@ -204,6 +206,7 @@ class DevHandler {
       // This will provide a websocket based service.
       useSse: false,
       expressionCompiler: _expressionCompiler,
+      enableDebugSymbols: _enableDebugSymbols,
       spawnDds: _spawnDds,
     );
   }
@@ -485,6 +488,7 @@ class DevHandler {
           },
           useSse: _useSseForDebugProxy,
           expressionCompiler: _expressionCompiler,
+          enableDebugSymbols: _enableDebugSymbols,
           spawnDds: _spawnDds,
         );
         var appServices =

dwds/lib/src/services/chrome_proxy_service.dart

@@ -95,6 +95,8 @@ class ChromeProxyService implements VmServiceInterface {
   final ExpressionCompiler _compiler;
   ExpressionEvaluator _expressionEvaluator;
 
+  final bool _enableDebugSymbols;
+
   bool terminatingIsolates = false;
 
   ChromeProxyService._(
@@ -107,6 +109,7 @@ class ChromeProxyService implements VmServiceInterface {
     this._skipLists,
     this.executionContext,
     this._compiler,
+    this._enableDebugSymbols,
   ) {
     var debugger = Debugger.create(
       remoteDebugger,
@@ -120,6 +123,10 @@ class ChromeProxyService implements VmServiceInterface {
         ? null
         : ExpressionEvaluator(debugger, _locations, _modules, _compiler);
     _debuggerCompleter.complete(debugger);
+
+    if (_enableDebugSymbols) {
+      throw UnimplementedError('Debug symbols are not uset yet.');
+    }
   }
 
   static Future<ChromeProxyService> create(
@@ -129,7 +136,8 @@ class ChromeProxyService implements VmServiceInterface {
       LoadStrategy loadStrategy,
       AppConnection appConnection,
       ExecutionContext executionContext,
-      ExpressionCompiler expressionCompiler) async {
+      ExpressionCompiler expressionCompiler,
+      bool enableDebugSymbols) async {
     final vm = VM(
       name: 'ChromeDebugProxy',
       operatingSystem: Platform.operatingSystem,
@@ -158,6 +166,7 @@ class ChromeProxyService implements VmServiceInterface {
       skipLists,
       executionContext,
       expressionCompiler,
+      enableDebugSymbols,
     );
     unawaited(service.createIsolate(appConnection));
     return service;

dwds/lib/src/services/debug_service.dart

@@ -214,7 +214,8 @@ class DebugService {
       void Function(Map<String, dynamic>) onResponse,
       bool spawnDds = true,
       bool useSse,
-      ExpressionCompiler expressionCompiler}) async {
+      ExpressionCompiler expressionCompiler,
+      bool enableDebugSymbols}) async {
     useSse ??= false;
     var chromeProxyService = await ChromeProxyService.create(
         remoteDebugger,
@@ -223,7 +224,8 @@ class DebugService {
         loadStrategy,
         appConnection,
         executionContext,
-        expressionCompiler);
+        expressionCompiler,
+        enableDebugSymbols);
     var authToken = _makeAuthToken();
     var serviceExtensionRegistry = ServiceExtensionRegistry();
     Handler handler;

dwds/pubspec.yaml

@@ -1,6 +1,6 @@
 name: dwds
 # Every time this changes you need to run `pub run build_runner build`.
-version: 11.1.0
+version: 12.0.0-dev
 homepage: https://github.com/dart-lang/webdev/tree/master/dwds
 description: >-
   A service that proxies between the Chrome debug protocol and the Dart VM

dwds/test/fixtures/context.dart

@@ -118,6 +118,7 @@ class TestContext {
       bool restoreBreakpoints,
       CompilationMode compilationMode,
       bool enableExpressionEvaluation,
+      bool enableDebugSymbols,
       bool verbose}) async {
     reloadConfiguration ??= ReloadConfiguration.none;
     serveDevTools ??= false;
@@ -127,6 +128,7 @@ class TestContext {
     waitToDebug ??= false;
     compilationMode ??= CompilationMode.buildDaemon;
     enableExpressionEvaluation ??= false;
+    enableDebugSymbols ??= false;
     spawnDds ??= true;
     verbose ??= false;
 
@@ -172,6 +174,10 @@ class TestContext {
                 '--define',
                 'build_web_compilers|ddc=generate-full-dill=true',
               ],
+              if (enableDebugSymbols) ...[
+                '--define',
+                'build_web_compilers|ddc=generate-symbols=true',
+              ],
               if (verbose) '--verbose',
             ];
             daemonClient = await connectClient(workingDirectory, options,
@@ -225,6 +231,7 @@ class TestContext {
                 [fileSystemRoot],
                 'org-dartlang-app',
                 _outputDir.path,
+                enableDebugSymbols,
                 verbose);
 
             var assetServerPort = await findUnusedPort();
@@ -289,6 +296,7 @@ class TestContext {
         urlEncoder,
         restoreBreakpoints,
         expressionCompiler,
+        enableDebugSymbols,
         spawnDds,
         ddcService,
       );

dwds/test/fixtures/server.dart

@@ -72,6 +72,7 @@ class TestServer {
     UrlEncoder urlEncoder,
     bool restoreBreakpoints,
     ExpressionCompiler expressionCompiler,
+    bool enableDebugSymbols,
     bool spawnDds,
     ExpressionCompilerService ddcService,
   ) async {
@@ -107,6 +108,7 @@ class TestServer {
         hostname: hostname,
         urlEncoder: urlEncoder,
         expressionCompiler: expressionCompiler,
+        enableDebugSymbols: enableDebugSymbols,
         devtoolsLauncher: serveDevTools
             ? (hostname) async {
                 var server = await devtools_lancher.serveDevTools(

frontend_server_common/lib/src/asset_server.dart

@@ -158,7 +158,7 @@ class TestAssetServer implements AssetReader {
     var codeBytes = codeFile.readAsBytesSync();
     var sourcemapBytes = sourcemapFile.readAsBytesSync();
     var metadataBytes = metadataFile.readAsBytesSync();
-    var symbolsBytes = symbolsFile.readAsBytesSync();
+    var symbolsBytes = symbolsFile?.readAsBytesSync();
     var manifest =
         castStringKeyedMap(json.decode(manifestFile.readAsStringSync()));
     for (var filePath in manifest.keys) {
@@ -171,11 +171,10 @@ class TestAssetServer implements AssetReader {
       var sourcemapOffsets =
           (offsets['sourcemap'] as List<dynamic>).cast<int>();
       var metadataOffsets = (offsets['metadata'] as List<dynamic>).cast<int>();
-      var symbolsOffsets = (offsets['symbols'] as List<dynamic>).cast<int>();
+
       if (codeOffsets.length != 2 ||
           sourcemapOffsets.length != 2 ||
-          metadataOffsets.length != 2 ||
-          symbolsOffsets.length != 2) {
+          metadataOffsets.length != 2) {
         _printTrace('Invalid manifest byte offsets: $offsets');
         continue;
       }
@@ -219,18 +218,25 @@ class TestAssetServer implements AssetReader {
       );
       _metadata['$filePath.metadata'] = metadataView;
 
-      var symbolsStart = symbolsOffsets[0];
-      var symbolsEnd = symbolsOffsets[1];
-      if (symbolsStart < 0 || symbolsEnd > symbolsBytes.lengthInBytes) {
-        _printTrace('Invalid byte index: [$symbolsStart, $symbolsEnd]');
-        continue;
+      if (symbolsBytes != null) {
+        var symbolsOffsets = (offsets['symbols'] as List<dynamic>).cast<int>();
+        if (symbolsOffsets.length != 2) {
+          _printTrace('Invalid manifest byte offsets: $offsets');
+          continue;
+        }
+        var symbolsStart = symbolsOffsets[0];
+        var symbolsEnd = symbolsOffsets[1];
+        if (symbolsStart < 0 || symbolsEnd > symbolsBytes.lengthInBytes) {
+          _printTrace('Invalid byte index: [$symbolsStart, $symbolsEnd]');
+          continue;
+        }
+        var symbolsView = Uint8List.view(
+          symbolsBytes.buffer,
+          symbolsStart,
+          symbolsEnd - symbolsStart,
+        );
+        _metadata['$filePath.symbols'] = symbolsView;
       }
-      var symbolsView = Uint8List.view(
-        symbolsBytes.buffer,
-        symbolsStart,
-        symbolsEnd - symbolsStart,
-      );
-      _metadata['$filePath.symbols'] = symbolsView;
 
       modules.add(filePath);
     }

frontend_server_common/lib/src/devfs.dart

@@ -31,6 +31,7 @@ class WebDevFS {
     this.packagesPath,
     this.root,
     this.urlTunneller,
+    this.enableDebugSymbols = false,
   });
 
   final FileSystem fileSystem;
@@ -41,6 +42,7 @@ class WebDevFS {
   final String packagesPath;
   final String root;
   final UrlEncoder urlTunneller;
+  final bool enableDebugSymbols;
   Directory _savedCurrentDirectory;
   List<Uri> sources;
 
@@ -126,8 +128,11 @@ class WebDevFS {
           parentDirectory.childFile('${compilerOutput.outputFilename}.map');
       metadataFile = parentDirectory
           .childFile('${compilerOutput.outputFilename}.metadata');
-      symbolsFile =
-          parentDirectory.childFile('${compilerOutput.outputFilename}.symbols');
+
+      symbolsFile = enableDebugSymbols
+          ? parentDirectory
+              .childFile('${compilerOutput.outputFilename}.symbols')
+          : null;
       modules = assetServer.write(
           codeFile, manifestFile, sourcemapFile, metadataFile, symbolsFile);
     } on FileSystemException catch (err) {

frontend_server_common/lib/src/resident_runner.dart

@@ -30,6 +30,7 @@ class ResidentWebRunner {
       this.fileSystemRoots,
       this.fileSystemScheme,
       this.outputPath,
+      this.enableDebugSymbols,
       bool verbose) {
     generator = ResidentCompiler(dartSdkPath,
         packagesPath: packagesPath,
@@ -47,6 +48,7 @@ class ResidentWebRunner {
   final String outputPath;
   final List<String> fileSystemRoots;
   final String fileSystemScheme;
+  final bool enableDebugSymbols;
 
   ResidentCompiler generator;
   ExpressionCompiler expressionCompiler;
@@ -68,6 +70,7 @@ class ResidentWebRunner {
       packagesPath: packagesPath,
       root: root,
       urlTunneller: urlTunneller,
+      enableDebugSymbols: enableDebugSymbols,
     );
     uri = await devFS.create();
 

webdev/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.8.0-dev
+
+- Read DDC debug symbols under a `--enable-debug-symbols` flag.
+  Disabled by default. The feature is under development.
+
 ## 2.7.4
 
 - Allow the latest build_runner, build_web_compilers, and build_daemon

webdev/README.md

@@ -115,6 +115,8 @@ Common:
                                            (defaults to on)
 -e, --[no-]enable-expression-evaluation    Enable expression evaluation features
                                            in the debugger.
+-s, --[no-]enable-debug-symbols            Enable expression evaluation features
+                                           in the debugger.
 -v, --verbose                              Enables verbose logging.
 
 Run "webdev help" to see global options.
@@ -157,6 +159,8 @@ Usage: webdev build [arguments]
                                            (defaults to on)
 -e, --[no-]enable-expression-evaluation    Enable expression evaluation features
                                            in the debugger.
+-s, --[no-]enable-debug-symbols            Enable expression evaluation features
+                                           in the debugger.
 -v, --verbose                              Enables verbose logging.
 
 Run "webdev help" to see global options.