fix(build): fix source maps

vsavkin · vsavkin · commit 87d56acdaa0a · 2015-11-24T19:33:27.000Z
Closes #5444
diff --git a/gulpfile.js b/gulpfile.js
@@ -524,7 +524,7 @@ function launchKarmaWithExternalBrowsers(reporters, browsers, done) {
 
 gulp.task('!test.unit.js/karma-server', function(done) {
   var watchStarted = false;
-  var server = new karma.Server({configFile: __dirname + '/karma-js.conf.js', reporters: 'dots'});
+  var server = new karma.Server({configFile: __dirname + '/karma-js.conf.js'});
   server.on('run_complete', function() {
     if (!watchStarted) {
       watchStarted = true;
@@ -548,10 +548,7 @@ gulp.task('test.unit.router', function(done) {
 });
 
 gulp.task('!test.unit.router/karma-server', function() {
-  new karma.Server({
-             configFile: __dirname + '/modules/angular1_router/karma-router.conf.js',
-             reporters: 'dots'
-           })
+  new karma.Server({configFile: __dirname + '/modules/angular1_router/karma-router.conf.js'})
       .start();
 });
 
diff --git a/karma-js.conf.js b/karma-js.conf.js
@@ -1,4 +1,5 @@
 var browserProvidersConf = require('./browser-providers.conf.js');
+var internalAngularReporter = require('./tools/karma/reporter.js');
 
 // Karma configuration
 // Generated on Thu Sep 25 2014 11:52:02 GMT-0700 (PDT)
@@ -35,6 +36,21 @@ module.exports = function(config) {
 
     customLaunchers: browserProvidersConf.customLaunchers,
 
+    plugins: [
+      'karma-jasmine',
+      'karma-browserstack-launcher',
+      'karma-sauce-launcher',
+      'karma-chrome-launcher',
+      'karma-sourcemap-loader',
+      'karma-dart',
+      internalAngularReporter
+    ],
+
+    preprocessors: {
+      '**/*.js': ['sourcemap']
+    },
+
+    reporters: ['internal-angular'],
     sauceLabs: {
       testName: 'Angular2',
       startConnect: false,
diff --git a/modules/playground/e2e_test/sourcemap/sourcemap_spec.ts b/modules/playground/e2e_test/sourcemap/sourcemap_spec.ts
@@ -29,7 +29,13 @@ describe('sourcemaps', function() {
       expect(errorColumn).not.toBeNull();
 
 
-      var sourceMapData = fs.readFileSync('dist/js/prod/es5/playground/src/sourcemap/index.js.map');
+      const content =
+          fs.readFileSync('dist/js/dev/es5/playground/src/sourcemap/index.js').toString("utf8");
+      const marker = "//# sourceMappingURL=data:application/json;base64,";
+      const index = content.indexOf(marker);
+      const sourceMapData =
+          new Buffer(content.substring(index + marker.length), 'base64').toString("utf8");
+
       var decoder = new sourceMap.SourceMapConsumer(JSON.parse(sourceMapData));
 
       var originalPosition = decoder.originalPositionFor({line: errorLine, column: errorColumn});
diff --git a/npm-shrinkwrap.clean.json b/npm-shrinkwrap.clean.json
@@ -12153,6 +12153,9 @@
         }
       }
     },
+    "karma-sourcemap-loader": {
+      "version": "0.3.6"
+    },
     "lodash": {
       "version": "2.4.2"
     },
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json
@@ -81,6 +81,7 @@
     "karma-dart": "^0.3.0",
     "karma-jasmine": "^0.3.6",
     "karma-sauce-launcher": "^0.2.14",
+    "karma-sourcemap-loader": "^0.3.6",
     "lodash": "^2.4.1",
     "madge": "0.5.0",
     "merge": "^1.2.0",
diff --git a/tools/broccoli/angular_builder.ts b/tools/broccoli/angular_builder.ts
@@ -70,6 +70,7 @@ export class AngularBuilder {
         {
           name: 'dev',
           typeAssertions: true,
+          sourceMaps: true,
           projects: opts.projects,
           noTypeChecks: opts.noTypeChecks,
           generateEs6: opts.generateEs6
@@ -84,6 +85,7 @@ export class AngularBuilder {
         {
           name: 'prod',
           typeAssertions: false,
+          sourceMaps: false,
           projects: opts.projects,
           noTypeChecks: opts.noTypeChecks,
           generateEs6: opts.generateEs6
diff --git a/tools/broccoli/broccoli-typescript.ts b/tools/broccoli/broccoli-typescript.ts
@@ -103,7 +103,7 @@ class DiffingTSCompiler implements DiffingBroccoliPlugin {
           output.outputFiles.forEach(o => {
             let destDirPath = path.dirname(o.name);
             fse.mkdirsSync(destDirPath);
-            fs.writeFileSync(o.name, o.text, FS_OPTS);
+            fs.writeFileSync(o.name, this.fixSourceMapSources(o.text), FS_OPTS);
           });
         }
       });
@@ -145,9 +145,9 @@ class DiffingTSCompiler implements DiffingBroccoliPlugin {
 
   private doFullBuild() {
     let program = this.tsService.getProgram();
-    let emitResult = program.emit(undefined, function(absoluteFilePath, fileContent) {
+    let emitResult = program.emit(undefined, (absoluteFilePath, fileContent) => {
       fse.mkdirsSync(path.dirname(absoluteFilePath));
-      fs.writeFileSync(absoluteFilePath, fileContent, FS_OPTS);
+      fs.writeFileSync(absoluteFilePath, this.fixSourceMapSources(fileContent), FS_OPTS);
     });
 
     if (emitResult.emitSkipped) {
@@ -176,6 +176,33 @@ class DiffingTSCompiler implements DiffingBroccoliPlugin {
     }
   }
 
+  /**
+   * There is a bug in TypeScript 1.6, where the sourceRoot and inlineSourceMap properties
+   * are exclusive. This means that the sources property always contains relative paths
+   * (e.g, ../../../../angular2/src/di/injector.ts).
+   *
+   * Here, we normalize the sources property and remove the ../../../
+   *
+   * This issue is fixed in https://github.com/Microsoft/TypeScript/pull/5620.
+   * Once we switch to TypeScript 1.8, we can remove this method.
+   */
+  private fixSourceMapSources(content: string): string {
+    try {
+      const marker = "//# sourceMappingURL=data:application/json;base64,";
+      const index = content.indexOf(marker);
+      if (index == -1) return content;
+
+      const base = content.substring(0, index + marker.length);
+      const sourceMapBit =
+          new Buffer(content.substring(index + marker.length), 'base64').toString("utf8");
+      const sourceMaps = JSON.parse(sourceMapBit);
+      const source = sourceMaps.sources[0];
+      sourceMaps.sources = [source.substring(source.lastIndexOf("../") + 3)];
+      return `${base}${new Buffer(JSON.stringify(sourceMaps)).toString('base64')}`;
+    } catch (e) {
+      return content;
+    }
+  }
 
   private removeOutputFor(tsFilePath: string) {
     let absoluteJsFilePath = path.join(this.cachePath, tsFilePath.replace(/\.ts$/, '.js'));
diff --git a/tools/broccoli/trees/browser_tree.ts b/tools/broccoli/trees/browser_tree.ts
@@ -74,6 +74,7 @@ module.exports = function makeBrowserTree(options, destinationPath) {
   const modules = options.projects;
   const noTypeChecks = options.noTypeChecks;
   const generateEs6 = options.generateEs6;
+  const sourceMaps = options.sourceMaps;
 
   if (modules.angular2) {
     var angular2Tree = new Funnel('modules/angular2', {
@@ -147,14 +148,13 @@ module.exports = function makeBrowserTree(options, destinationPath) {
     declaration: false,
     emitDecoratorMetadata: true,
     experimentalDecorators: true,
-    mapRoot: '',  // force sourcemaps to use relative path
     module: 'commonjs',
     moduleResolution: 'classic',
     noEmitOnError: !noTypeChecks,
     rootDir: './',
     rootFilePaths: ['angular2/manual_typings/globals.d.ts'],
-    sourceMap: true,
-    sourceRoot: '.',
+    inlineSourceMap: sourceMaps,
+    inlineSources: sourceMaps,
     target: 'es5'
   });
 
@@ -276,12 +276,11 @@ module.exports = function makeBrowserTree(options, destinationPath) {
       declaration: false,
       emitDecoratorMetadata: true,
       experimentalDecorators: true,
-      mapRoot: '',  // force sourcemaps to use relative path
       noEmitOnError: false,
       rootDir: './',
       rootFilePaths: ['angular2/manual_typings/globals-es6.d.ts'],
-      sourceMap: true,
-      sourceRoot: '.',
+      inlineSourceMap: sourceMaps,
+      inlineSources: sourceMaps,
       target: 'es6'
     });
 
diff --git a/tools/karma/reporter.js b/tools/karma/reporter.js
@@ -0,0 +1,59 @@
+var SourceMapConsumer = require('source-map').SourceMapConsumer;
+var DotsReporter = require('karma/lib/reporters/dots_color');
+
+var createErrorFormatter = function (basePath, emitter, SourceMapConsumer) {
+  var lastServedFiles = [];
+  emitter.on('file_list_modified', function (files) {
+    lastServedFiles = files.served
+  });
+  function findFile(path) {
+    return lastServedFiles.filter(_ => _.path === path)[0];
+  }
+
+  var URL_REGEXP = new RegExp('(?:https?:\\/\\/[^\\/]*)?\\/?' +
+    '(base|absolute)' + // prefix
+    '((?:[A-z]\\:)?[^\\?\\s\\:]*)' + // path
+    '(\\?\\w*)?' + // sha
+    '(\\:(\\d+))?' + // line
+    '(\\:(\\d+))?' + // column
+    '', 'g')
+
+  return function (msg, indentation) {
+    msg = (msg || '').replace(URL_REGEXP, function (_, prefix, path, __, ___, line, ____, column) {
+      if (prefix === 'base') {
+        path = basePath + path;
+      }
+      line = parseInt(line || '0', 10);
+      column = parseInt(column || '0', 10);
+
+      var file = findFile(path)
+      if (file && file.sourceMap) {
+        try {
+          var original = new SourceMapConsumer(file.sourceMap).originalPositionFor({
+            line: line,
+            column: column
+          });
+          return process.cwd() + "/modules/" + original.source + ":" + original.line + ":" + original.column;
+        } catch (e) {
+          log.warn('SourceMap position not found for trace: %s', msg);
+        }
+      }
+      return path + ':' + line + ':' + column;
+    });
+
+    // indent every line
+    if (indentation) {
+      msg = indentation + msg.replace(/\n/g, '\n' + indentation)
+    }
+    return msg + '\n';
+  }
+}
+
+
+var InternalAngularReporter = function (config, emitter) {
+  var formatter = createErrorFormatter(config.basePath, emitter, SourceMapConsumer);
+  DotsReporter.call(this, formatter, false)
+}
+InternalAngularReporter.$inject = ['config', 'emitter']
+
+module.exports = {'reporter:internal-angular': ['type', InternalAngularReporter]};

Original file line number	Diff line number	Diff line change
`@@ -12153,6 +12153,9 @@`
`12153`	`12153`	`}`
`12154`	`12154`	`}`
`12155`	`12155`	`},`
	`12156`	`+ "karma-sourcemap-loader": {`
	`12157`	`+ "version": "0.3.6"`
	`12158`	`+ },`
`12156`	`12159`	`"lodash": {`
`12157`	`12160`	`"version": "2.4.2"`
`12158`	`12161`	`},`