Merge pull request #41 from bugsnag/transform-relative-paths

feat: Transform relative "sources" paths in source map

lib/options.js

@@ -102,16 +102,23 @@ function transformSourcesMap (options) {
   return (
     readFileJSON(options.sourceMap)
       .then(sourceMap => (
-        mapSources(sourceMap, path => {
-          const relativePath = stripProjectRoot(options.projectRoot, path)
-          return doesFileExist(path).then(exists => {
+        mapSources(sourceMap, p => {
+          // resolve a relative path in the sources array if it begins with a ".." e.g. "../../src/index.js"
+          const resolvedPath = /^\.\./.test(p)
+            ? path.resolve(path.dirname(options.sourceMap), p)
+            : p
+
+          // then make it relative to the project root
+          const relativePath = stripProjectRoot(options.projectRoot, resolvedPath)
+
+          return doesFileExist(p).then(exists => {
             if (exists && options.uploadSources) {
-              if (path.indexOf('node_modules') !== -1) {
+              if (p.indexOf('node_modules') !== -1) {
                 if (options.uploadNodeModules) {
-                  options.sources[relativePath] = path
+                  options.sources[relativePath] = p
                 }
               } else {
-                options.sources[relativePath] = path
+                options.sources[relativePath] = p
               }
             }
             return relativePath

test/fixtures/multi-relative/src/app.js

@@ -0,0 +1,11 @@
+const logger = require('./services/logger')
+const Widget = require('./services/widget')
+const bugsnagClient = require('./services/bugsnag')
+
+logger.debug('app is booting')
+
+const widget = new Widget()
+logger.debug('Created a widget', widget.getCreated())
+widget.update()
+logger.debug('Updated a widget', widget.getUpdated())
+bugsnagClient.notify(new Error('errororor'))

test/fixtures/multi-relative/src/services/bugsnag.js

@@ -0,0 +1,6 @@
+const bugsnag = require('@bugsnag/js')
+const bugsnagClient = bugsnag({
+  apiKey: 'YOUR_API_KEY',
+  appVersion: require('../../package.json').version
+})
+module.exports = bugsnagClient

test/fixtures/multi-relative/src/services/logger.js

@@ -0,0 +1,15 @@
+exports.debug = function () {
+  console.debug(new Date(), arguments)
+}
+
+exports.info = function () {
+  console.info(new Date(), arguments)
+}
+
+exports.warn = function () {
+  console.warn(new Date(), arguments)
+}
+
+exports.error = function () {
+  console.error(new Date(), arguments)
+}

test/fixtures/multi-relative/src/services/widget.js

@@ -0,0 +1,24 @@
+class Widget {
+  constructor () {
+    this.created = new Date()
+    this.updated = new Date()
+  }
+
+  getCreated () {
+    return this.created
+  }
+
+  getUpdated () {
+    return this.updated
+  }
+
+  isWidget () {
+    return true
+  }
+
+  update () {
+    this.updated = new Date()
+  }
+}
+
+module.exports = Widget

test/index.test.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const path = require('path')
+const concat = require('concat-stream')
 
 afterEach(() => jest.resetModules())
 
@@ -74,3 +75,75 @@ test('multiple uploads', () => {
     ])
   })
 })
+
+test('multiple uploads (resolving relative source paths inside map)', () => {
+  let mockCalled = 0
+  let mockCalledWith = []
+  const mockConcat = concat
+  jest.mock('../lib/request', () => {
+    return (endpoint, makePayload, onSuccess, onError) => {
+      mockCalled++
+      const payload = makePayload()
+      payload.sourceMap.pipe(mockConcat(data => {
+        payload.sourceMapData = JSON.parse(data)
+        mockCalledWith.push(payload)
+        onSuccess()
+      }))
+    }
+  })
+
+  const upload = require('../').upload
+  return upload({
+    apiKey: 'API_KEY',
+    projectRoot: `${__dirname}/fixtures/multi-relative`,
+    directory: true
+  }).then(() => {
+    expect(mockCalled).toBe(4)
+
+    const uploads = mockCalledWith.reduce((accum, payload) => {
+      return accum.concat({
+        minifiedUrl: payload.minifiedUrl,
+        minifiedFile: payload.minifiedFile.path,
+        sourceMap: path.basename(payload.sourceMap.path),
+        sourceMapData: payload.sourceMapData
+      })
+    }, []).sort((a, b) => a.minifiedUrl > b.minifiedUrl)
+
+    const orderedSourceMapContent = uploads.map(u => {
+      const data = u.sourceMapData
+      // bad mutating this array in an iterator but needs must
+      delete u.sourceMapData
+      return data
+    })
+
+    expect(uploads).toEqual([
+      {
+        minifiedUrl: 'lib/app.js',
+        minifiedFile: `${__dirname}/fixtures/multi-relative/lib/app.js`,
+        sourceMap: 'app.js.map'
+      },
+      {
+        minifiedUrl: 'lib/services/bugsnag.js',
+        minifiedFile: `${__dirname}/fixtures/multi-relative/lib/services/bugsnag.js`,
+        sourceMap: 'bugsnag.js.map'
+      },
+      {
+        minifiedUrl: 'lib/services/logger.js',
+        minifiedFile: `${__dirname}/fixtures/multi-relative/lib/services/logger.js`,
+        sourceMap: 'logger.js.map'
+      },
+      {
+        minifiedUrl: 'lib/services/widget.js',
+        minifiedFile: `${__dirname}/fixtures/multi-relative/lib/services/widget.js`,
+        sourceMap: 'widget.js.map'
+      }
+    ])
+
+    expect(orderedSourceMapContent.map(map => map.sources[0])).toEqual([
+      'src/app.js',
+      'src/services/bugsnag.js',
+      'src/services/logger.js',
+      'src/services/widget.js'
+    ])
+  })
+})