feat: apply pathMapping when loading sourcemaps (#1241)

Fixes #1240

Author: timvahlbrock

src/adapter/sources.ts

@@ -852,6 +852,7 @@ export class SourceContainer {
     contentHash?: string,
   ): Promise<Source> {
     const absolutePath = await this.sourcePathResolver.urlToAbsolutePath({ url });
+
     this.logger.verbose(LogTag.RuntimeSourceCreate, 'Creating source from url', {
       inputUrl: url,
       absolutePath,

src/common/sourceMaps/sourceMapFactory.ts

@@ -10,6 +10,7 @@ import { IRootDapApi } from '../../dap/connection';
 import { sourceMapParseFailed } from '../../dap/errors';
 import { MapUsingProjection } from '../datastructure/mapUsingProjection';
 import { IDisposable } from '../disposable';
+import { ILogger, LogTag } from '../logging';
 import { ISourcePathResolver } from '../sourcePathResolver';
 import { fileUrlToAbsolutePath } from '../urlUtils';
 import { ISourceMapMetadata, SourceMap } from './sourceMap';
@@ -49,13 +50,16 @@ export class SourceMapFactory implements ISourceMapFactory {
     @inject(ISourcePathResolver) private readonly pathResolve: ISourcePathResolver,
     @inject(IResourceProvider) private readonly resourceProvider: IResourceProvider,
     @inject(IRootDapApi) protected readonly dap: Dap.Api,
+    @inject(ILogger) private readonly logger: ILogger,
   ) {}
 
   /**
    * @inheritdoc
    */
   public async load(metadata: ISourceMapMetadata): Promise<SourceMap> {
-    const basic = await this.parseSourceMap(metadata.sourceMapUrl);
+    const basic =
+      (await this.parsePathMappedSourceMap(metadata.sourceMapUrl)) ||
+      (await this.parseSourceMap(metadata.sourceMapUrl));
 
     // The source-map library is destructive with its sources parsing. If the
     // source root is '/', it'll "helpfully" resolve a source like `../foo.ts`
@@ -80,6 +84,17 @@ export class SourceMapFactory implements ISourceMapFactory {
     );
   }
 
+  public async parsePathMappedSourceMap(url: string) {
+    const localSourceMapUrl = await this.pathResolve.urlToAbsolutePath({ url });
+    if (!localSourceMapUrl) return;
+
+    try {
+      return this.parseSourceMap(localSourceMapUrl);
+    } catch (error) {
+      this.logger.info(LogTag.SourceMapParsing, 'Parsing path mapped source map failed.', error);
+    }
+  }
+
   /**
    * @inheritdoc
    */

src/test/breakpoints/breakpoints-configure-source-map-thats-path-mapped.txt

@@ -0,0 +1,8 @@
+{
+    allThreadsStopped : false
+    description : Paused on breakpoint
+    reason : breakpoint
+    threadId : <number>
+}
+foo @ ${workspaceFolder}/web/tmp/app.ts:2:3
+<anonymous> @ ${workspaceFolder}/web/tmp/app.ts:5:1

src/test/breakpoints/breakpointsTest.ts

@@ -132,6 +132,42 @@ describe('breakpoints', () => {
       await waitForPause(p);
       p.assertLog();
     });
+
+    itIntegrates("source map that's path mapped", async ({ r }) => {
+      const cwd = r.workspacePath('web/tmp');
+
+      after(() =>
+        del([`${forceForwardSlashes(cwd)}/**`], {
+          force: true /* delete outside cwd */,
+        }),
+      );
+
+      createFileTree(cwd, {
+        'app.ts': await readfile(r.workspacePath('web/pathMapped/app.ts')),
+        'app.js': (await readfile(r.workspacePath('web/pathMapped/app.js'))).replace(
+          'app.js.map',
+          'mappedPath/app.js.map',
+        ),
+        'index.html': await readfile(r.workspacePath('web/pathMapped/index.html')),
+        mappedDir: {
+          'app.js.map': await readfile(r.workspacePath('web/pathMapped/app.js.map')),
+        },
+      });
+
+      const p = await r.launchUrl('tmp/index.html', {
+        pathMapping: {
+          '/mappedPath/': '${workspaceFolder}/web/tmp/mappedDir/',
+        },
+      });
+      const source: Dap.Source = {
+        path: p.workspacePath('web/tmp/app.ts'),
+      };
+
+      await p.dap.setBreakpoints({ source, breakpoints: [{ line: 2 }] });
+      p.load();
+      await waitForPause(p);
+      p.assertLog();
+    });
   });
 
   describe('launched', () => {

testWorkspace/web/pathMapped/app.js

@@ -0,0 +1,5 @@
+function foo() {
+  void(0); // break here
+}
+
+foo();

testWorkspace/web/pathMapped/app.js.map

@@ -0,0 +1 @@
+<script src="app.js"></script>