fix: group node internals and WASM to clean up loaded sources view (#2073)

![](https://memes.peet.io/img/24-09-3dcf61d0-09e8-46e9-9ea7-d42b6b72396b.png)

Author: connor4312

package-lock.json

@@ -115,7 +115,7 @@
     "@typescript-eslint/eslint-plugin": "^6.20.0",
     "@typescript-eslint/parser": "^6.20.0",
     "@vscode/dwarf-debugging": "^0.0.2",
-    "@vscode/test-electron": "^2.3.9",
+    "@vscode/test-electron": "^2.4.1",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "chai-string": "^1.5.0",

package.json

@@ -46,6 +46,8 @@ export interface IWasmWorkerFactory extends IDisposable {
   prompt(): void;
 }
 
+export const ensureWATExtension = (path: string) => path.replace(/\.wasm$/i, '') + '.wat';
+
 @injectable()
 export class WasmWorkerFactory implements IWasmWorkerFactory {
   private cdpCounter = 0;
@@ -362,7 +364,8 @@ class DecompiledWasmSymbols implements IWasmSymbols {
     protected readonly cdp: Cdp.Api,
     files: string[],
   ) {
-    files.push(this.decompiledUrl = event.url.replace('.wasm', '.wat'));
+    this.decompiledUrl = ensureWATExtension(event.url);
+    files.push(this.decompiledUrl);
     this.files = files;
   }
 

src/adapter/dwarf/wasmSymbolProvider.ts

@@ -9,7 +9,7 @@ import { ICdpApi } from '../../cdp/connection';
 import { MapUsingProjection } from '../../common/datastructure/mapUsingProjection';
 import { EventEmitter } from '../../common/events';
 import { ILogger, LogTag } from '../../common/logging';
-import { node15InternalsPrefix } from '../../common/node15Internal';
+import { node15InternalsPrefix, nodeInternalsToken } from '../../common/node15Internal';
 import { memoizeLast, trailingEdgeThrottle, truthy } from '../../common/objUtils';
 import * as pathUtils from '../../common/pathUtils';
 import { getDeferred, IDeferred } from '../../common/promiseUtil';
@@ -50,7 +50,7 @@ function preprocessAuthoredGlobs(
   userSkipPatterns: ReadonlyArray<string>,
 ): string[] {
   const authoredGlobs = userSkipPatterns
-    .filter(pattern => !pattern.includes('<node_internals>'))
+    .filter(pattern => !pattern.includes(nodeInternalsToken))
     .map(pattern =>
       urlUtils.isAbsolute(pattern)
         ? urlUtils.absolutePathToFileUrlWithDetection(spr.rebaseLocalToRemote(pattern))

src/adapter/scriptSkipper/implementation.ts

@@ -7,6 +7,7 @@ import { relative } from 'path';
 import { URL } from 'url';
 import Cdp from '../cdp/api';
 import { checkContentHash } from '../common/hash/checkContentHash';
+import { node15InternalsPrefix, nodeInternalsToken } from '../common/node15Internal';
 import { once } from '../common/objUtils';
 import { forceForwardSlashes, isSubdirectoryOf } from '../common/pathUtils';
 import { delay, getDeferred, IDeferred } from '../common/promiseUtil';
@@ -327,7 +328,11 @@ export class Source {
       return 'repl';
     }
 
-    if (this.absolutePath.startsWith('<node_internals>')) {
+    if (this.url.startsWith(node15InternalsPrefix)) {
+      return nodeInternalsToken + '/' + this.url.slice(node15InternalsPrefix.length);
+    }
+
+    if (this.absolutePath.startsWith(nodeInternalsToken)) {
       return this.absolutePath;
     }
 

src/adapter/source.ts

@@ -23,7 +23,7 @@ import { sourceMapParseFailed } from '../dap/errors';
 import { IInitializeParams } from '../ioc-extras';
 import { IStatistics } from '../telemetry/classification';
 import { extractErrorDetails } from '../telemetry/dapTelemetryReporter';
-import { IWasmSymbolProvider, IWasmSymbols } from './dwarf/wasmSymbolProvider';
+import { ensureWATExtension, IWasmSymbolProvider, IWasmSymbols } from './dwarf/wasmSymbolProvider';
 import { IResourceProvider } from './resourceProvider';
 import { ScriptSkipper } from './scriptSkipper/implementation';
 import { IScriptSkipper } from './scriptSkipper/scriptSkipper';
@@ -706,23 +706,25 @@ export class SourceContainer {
 
     const todo: Promise<unknown>[] = [];
     for (const url of symbols.files) {
-      const absolutePath = await this.sourcePathResolver.urlToAbsolutePath({ url });
-      const resolvedUrl = absolutePath ? utils.absolutePathToFileUrl(absolutePath) : url;
+      let absolutePath: string | undefined;
+      let resolvedUrl: string;
+      let contentGetter: ContentGetter;
+      if (url === symbols.decompiledUrl) {
+        absolutePath = ensureWATExtension(compiled.absolutePath);
+        resolvedUrl = ensureWATExtension(compiled.url);
+        contentGetter = () => symbols.getDisassembly();
+      } else {
+        absolutePath = await this.sourcePathResolver.urlToAbsolutePath({ url });
+        resolvedUrl = absolutePath ? utils.absolutePathToFileUrl(absolutePath) : url;
+        contentGetter = () => this.resourceProvider.fetch(resolvedUrl).then(r => r.body);
+      }
 
       this.logger.verbose(LogTag.RuntimeSourceCreate, 'Creating wasm source from source map', {
         inputUrl: url,
         absolutePath,
         resolvedUrl,
       });
 
-      const fileUrl = absolutePath && utils.absolutePathToFileUrl(absolutePath);
-      const contentGetter = url === symbols.decompiledUrl
-        ? () => symbols.getDisassembly()
-        : () =>
-          fileUrl
-            ? this.resourceProvider.fetch(fileUrl).then(r => r.body)
-            : Promise.resolve(`Could not read ${url}`);
-
       const source = new SourceFromMap(this, resolvedUrl, absolutePath, contentGetter);
       source.compiledToSourceUrl.set(compiled, url);
       compiled.sourceMap.sourceByUrl.set(url, source);

src/adapter/sourceContainer.ts

@@ -17,6 +17,7 @@ import {
   preferredDebugTypes,
 } from '../common/contributionUtils';
 import { knownToolToken } from '../common/knownTools';
+import { nodeInternalsToken } from '../common/node15Internal';
 import { mapValues, sortKeys, walkObject } from '../common/objUtils';
 import {
   AnyLaunchConfiguration,
@@ -196,7 +197,7 @@ const baseConfigurationAttributes: ConfigurationAttributes<IBaseConfiguration> =
   skipFiles: {
     type: 'array',
     description: refString('browser.skipFiles.description'),
-    default: ['<node_internals>/**'],
+    default: ['${/**'],
   },
   smartStep: {
     type: 'boolean',
@@ -403,7 +404,7 @@ const nodeAttachConfig: IDebugger<INodeAttachConfiguration> = {
         request: 'attach',
         name: '${1:Attach}',
         port: 9229,
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -417,7 +418,7 @@ const nodeAttachConfig: IDebugger<INodeAttachConfiguration> = {
         port: 9229,
         localRoot: '^"\\${workspaceFolder}"',
         remoteRoot: '${3:Absolute path to the remote directory containing the program}',
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -428,7 +429,7 @@ const nodeAttachConfig: IDebugger<INodeAttachConfiguration> = {
         request: 'attach',
         name: '${1:Attach by Process ID}',
         processId: '^"\\${command:PickProcess}"',
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
   ],
@@ -510,7 +511,7 @@ const nodeLaunchConfig: IDebugger<INodeLaunchConfiguration> = {
         request: 'launch',
         name: '${2:Launch Program}',
         program: '^"\\${workspaceFolder}/${1:app.js}"',
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -522,7 +523,7 @@ const nodeLaunchConfig: IDebugger<INodeLaunchConfiguration> = {
         name: '${1:Launch via NPM}',
         runtimeExecutable: 'npm',
         runtimeArgs: ['run-script', 'debug'],
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -537,7 +538,7 @@ const nodeLaunchConfig: IDebugger<INodeLaunchConfiguration> = {
         restart: true,
         console: 'integratedTerminal',
         internalConsoleOptions: 'neverOpen',
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -557,7 +558,7 @@ const nodeLaunchConfig: IDebugger<INodeLaunchConfiguration> = {
           '^"\\${workspaceFolder}/${1:test}"',
         ],
         internalConsoleOptions: 'openOnSessionStart',
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -571,7 +572,7 @@ const nodeLaunchConfig: IDebugger<INodeLaunchConfiguration> = {
         args: ['${1:generator}'],
         console: 'integratedTerminal',
         internalConsoleOptions: 'neverOpen',
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -583,7 +584,7 @@ const nodeLaunchConfig: IDebugger<INodeLaunchConfiguration> = {
         name: 'Gulp ${1:task}',
         program: '^"\\${workspaceFolder}/node_modules/gulp/bin/gulp.js"',
         args: ['${1:task}'],
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
     {
@@ -595,7 +596,7 @@ const nodeLaunchConfig: IDebugger<INodeLaunchConfiguration> = {
         name: 'Electron Main',
         runtimeExecutable: '^"electron"',
         program: '^"\\${workspaceFolder}/main.js"',
-        skipFiles: ['<node_internals>/**'],
+        skipFiles: [`${nodeInternalsToken}/**`],
       },
     },
   ],

src/build/generate-contributions.ts

@@ -6,3 +6,8 @@
  * URL prefix that Node 15 and onwards uses for its internals.
  */
 export const node15InternalsPrefix = 'node:';
+
+/**
+ * Token the debugger uses to represent node internals.
+ */
+export const nodeInternalsToken = '<node_internals>';

src/common/node15Internal.ts

@@ -5,6 +5,7 @@
 import { homedir } from 'os';
 import { SourceMapTimeouts } from './adapter/sourceContainer';
 import { DebugType } from './common/contributionUtils';
+import { nodeInternalsToken } from './common/node15Internal';
 import { assertNever, filterValues } from './common/objUtils';
 import Dap from './dap/api';
 import { AnyRestartOptions } from './targets/node/restartPolicy';
@@ -859,7 +860,7 @@ const nodeBaseDefaults: INodeBaseConfiguration = {
   resolveSourceMapLocations: ['**', '!**/node_modules/**'],
   autoAttachChildProcesses: true,
   runtimeSourcemapPausePatterns: [],
-  skipFiles: ['<node_internals>/**'],
+  skipFiles: [`${nodeInternalsToken}/**`],
 };
 
 export const terminalBaseDefaults: ITerminalLaunchConfiguration = {

src/configuration.ts

@@ -6,6 +6,7 @@ import * as path from 'path';
 import { URL } from 'url';
 import { IFsUtils } from '../../common/fsUtils';
 import { ILogger } from '../../common/logging';
+import { nodeInternalsToken } from '../../common/node15Internal';
 import { fixDriveLetterAndSlashes, properResolve } from '../../common/pathUtils';
 import { SourceMap } from '../../common/sourceMaps/sourceMap';
 import {
@@ -102,7 +103,7 @@ export class NodeSourcePathResolver extends SourcePathResolverBase<IOptions> {
     // require('cluster') will import a file simply named "cluster". For these
     // paths, prefix them as internal.
     else if (!path.isAbsolute(url)) {
-      return `<node_internals>/${url}`;
+      return `${nodeInternalsToken}/${url}`;
     } // Otherwise, use default overrides.
     else {
       url = this.sourceMapOverrides.apply(url);

src/targets/node/nodeSourcePathResolver.ts

@@ -13,6 +13,7 @@ import { DebugType } from '../../common/contributionUtils';
 import { EnvironmentVars } from '../../common/environmentVars';
 import { findOpenPort } from '../../common/findOpenPort';
 import { existsInjected, IFsUtils, LocalFsUtils } from '../../common/fsUtils';
+import { nodeInternalsToken } from '../../common/node15Internal';
 import { forceForwardSlashes, isSubpathOrEqualTo } from '../../common/pathUtils';
 import { some } from '../../common/promiseUtil';
 import { getNormalizedBinaryName, nearestDirectoryWhere } from '../../common/urlUtils';
@@ -326,7 +327,7 @@ export async function createLaunchConfigFromContext(
     type: DebugType.Node,
     request: 'launch',
     name: l10n.t('Launch Program'),
-    skipFiles: ['<node_internals>/**'],
+    skipFiles: [`${nodeInternalsToken}/**`],
   };
 
   if (existingConfig && existingConfig.noDebug) {