Use fuzzy search when using sourcemaps (#306)

DominicKramer · web-flow · commit db2156454905 · 2017-07-10T16:05:07.000-07:00
Now the input file in a directory tree associated with the output file described by sourcemap can be identified, even if the input file's path does not match exactly with what is expected from the sourcemap. Fixes: #226 PR-URL: #306
diff --git a/src/agent/sourcemapper.ts b/src/agent/sourcemapper.ts
@@ -19,6 +19,7 @@ import * as fs from 'fs';
 import * as _ from 'lodash';
 import * as path from 'path';
 import * as sourceMap from 'source-map';
+import {findScriptsFuzzy} from './v8debugapi';
 
 /** @define {string} */ const MAP_EXT = '.map';
 
@@ -127,6 +128,31 @@ export class SourceMapper {
     this.infoMap_ = new Map();
   }
 
+  /**
+   * Used to get the information about the transpiled file from a given input
+   * source file provided there isn't any ambiguity with associating the input
+   * path to exactly one output transpiled file.
+   *
+   * @param inputPath The (possibly relative) path to the original source file.
+   * @return The `MapInfoInput` object that describes the transpiled file
+   *  associated with the specified input path.  `null` is returned if either
+   *  zero files are associated with the input path or if more than one file
+   *  could possibly be associated with the given input path.
+   */
+  private getMappingInfo(inputPath: string): MapInfoInput|null {
+    if (this.infoMap_.has(path.normalize(inputPath))) {
+      return this.infoMap_.get(inputPath) as MapInfoInput;
+    }
+
+    const matches =
+        findScriptsFuzzy(inputPath, Array.from(this.infoMap_.keys()));
+    if (matches.length === 1) {
+      return this.infoMap_.get(matches[0]) as MapInfoInput;
+    }
+
+    return null;
+  }
+
   /**
    * Used to determine if the source file specified by the given path has
    * a .map file and an output file associated with it.
@@ -141,7 +167,7 @@ export class SourceMapper {
    *  relative to the process's current working directory.
    */
   hasMappingInfo(inputPath: string): boolean {
-    return this.infoMap_.has(path.normalize(inputPath));
+    return this.getMappingInfo(inputPath) !== null;
   }
 
   /**
@@ -166,12 +192,11 @@ export class SourceMapper {
   mappingInfo(inputPath: string, lineNumber: number, colNumber: number):
       MapInfoOutput|null {
     inputPath = path.normalize(inputPath);
-    if (!this.hasMappingInfo(inputPath)) {
+    const entry = this.getMappingInfo(inputPath);
+    if (entry === null) {
       return null;
     }
 
-    // TODO: `entry` could be `undefined` here.  Address this case.
-    const entry = this.infoMap_.get(inputPath) as any as MapInfoInput;
     const sourcePos = {
       source: path.relative(path.dirname(entry.mapFile), inputPath),
       line: lineNumber + 1,  // the SourceMapConsumer expects the line number
diff --git a/src/agent/v8debugapi.ts b/src/agent/v8debugapi.ts
@@ -743,7 +743,6 @@ export function findScripts(
  *     available.
  * @return {array<string>} list of files that match.
  */
-// Exposed for unit testing.
 export function findScriptsFuzzy(
     scriptPath: string, fileList: string[]): string[] {
   let matches = fileList;
diff --git a/test/test-sourcemapper.js b/test/test-sourcemapper.js
@@ -21,24 +21,30 @@ var path = require('path');
 
 var SourceMapper = require('../build/src/agent/sourcemapper.js');
 
+var BASE_PATH = path.join(__dirname, 'fixtures', 'sourcemapper');
+
 /**
- * @param {string} tool The name of the tool that was used to generate the 
+ * @param {string} tool The name of the tool that was used to generate the
  *  given sourcemap data
- * @param {string} mapFilePath The path to the sourcemap file of a
+ * @param {string} relativeMapFilePath The path to the sourcemap file of a
  *  transpilation to test
- * @param {string} inputFilePath The path to the input file that was
+ * @param {string} relativeInputFilePath The path to the input file that was
  *  transpiled to generate the specified sourcemap file
- * @param {string} outputFilePath The path to the output file that was 
- *  generated during the transpilation process that constructed the 
+ * @param {string} relativeOutputFilePath The path to the output file that was
+ *  generated during the transpilation process that constructed the
  *  specified sourcemap file
  * @param {Array.<Array.<number, number>>} inToOutLineNums An array of arrays
  *  where each element in the array is a pair of numbers.  The first number
  *  in the pair is the line number from the input file and the second number
  *  in the pair is the expected line number in the corresponding output file
- * 
+ *
  *  Note: The line numbers are zero-based
  */
-function testTool(tool, mapFilePath, inputFilePath, outputFilePath, inToOutLineNums) {
+function testTool(tool, relativeMapFilePath, relativeInputFilePath, relativeOutputFilePath, inToOutLineNums) {
+  var mapFilePath = path.join(BASE_PATH, relativeMapFilePath);
+  var inputFilePath = path.join(BASE_PATH, relativeInputFilePath);
+  var outputFilePath = path.join(BASE_PATH, relativeOutputFilePath);
+
   describe('sourcemapper for tool ' + tool, function() {
     var sourcemapper;
 
@@ -62,11 +68,21 @@ function testTool(tool, mapFilePath, inputFilePath, outputFilePath, inToOutLineN
         done();
     });
 
-    it('for tool ' + tool + 
+    it('for tool ' + tool +
+      ' it states that it has mapping info for files with a path' +
+      ' similar to a path it knows about',
+      function(done) {
+        assert.equal(sourcemapper.hasMappingInfo(relativeInputFilePath), true);
+        var movedPath = path.join('/some/other/base/dir/', relativeInputFilePath);
+        assert.equal(sourcemapper.hasMappingInfo(movedPath), true);
+        done();
+    });
+
+    it('for tool ' + tool +
       ' it states that it does not have mapping info for a file it ' +
       'doesn\'t recognize',
       function(done) {
-        assert.equal(sourcemapper.hasMappingInfo('INVALID_' + inputFilePath), false);
+        assert.equal(sourcemapper.hasMappingInfo(inputFilePath + '_INVALID'), false);
         done();
     });
 
@@ -90,11 +106,10 @@ function testTool(tool, mapFilePath, inputFilePath, outputFilePath, inToOutLineN
   });
 }
 
-var basePath = path.join(__dirname, 'fixtures', 'sourcemapper');
-testTool('Babel', 
-  path.join(basePath, 'babel', 'out.js.map'),
-  path.join(basePath, 'babel', 'in.js'),
-  path.join(basePath, 'babel', 'out.js'), [
+testTool('Babel',
+  path.join('babel', 'out.js.map'),
+  path.join('babel', 'in.js'),
+  path.join('babel', 'out.js'), [
   [1, 14],
   [2, 15],
   [3, 16],
@@ -148,9 +163,9 @@ testTool('Babel',
 ]);
 
 testTool('Typescript',
-  path.join(basePath, 'typescript', 'out.js.map'),
-  path.join(basePath, 'typescript', 'in.ts'),
-  path.join(basePath, 'typescript', 'out.js'), [
+  path.join('typescript', 'out.js.map'),
+  path.join('typescript', 'in.ts'),
+  path.join('typescript', 'out.js'), [
   [1, 5],
   [2, 6],
   [3, 9],
@@ -167,9 +182,9 @@ testTool('Typescript',
 ]);
 
 testTool('Coffeescript',
-  path.join(basePath, 'coffeescript', 'in.js.map'),
-  path.join(basePath, 'coffeescript', 'in.coffee'),
-  path.join(basePath, 'coffeescript', 'in.js'),[
+  path.join('coffeescript', 'in.js.map'),
+  path.join('coffeescript', 'in.coffee'),
+  path.join('coffeescript', 'in.js'),[
   [1, 1],
   [2, 7],
   [3, 8],
