Fix a bug with build metadata option (#101)

* fix: 🐛 don't try to access metadata build option when not provided

* fix linting issue

* test: ✅ make test more robust by not requiring a specific order

* test: ✅ add new test for un-set metadata

* test: ✅ make source map uploader assertions less tight

Author: gingerbenw

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [Unreleased]
+
+- Fixed an issue when build metadata option is not provided (#101)
+
 ## [2.2.2] - 2025-07-03
 
 - Ensure that we correctly pass the metadata the BugSnag CLI create build command (#100)

build-reporter-plugin.js

@@ -62,9 +62,11 @@ class BugsnagBuildReporterPlugin {
     const optionalOpts = {
       autoAssignRelease: opts.build.autoAssignRelease,
       builderName: opts.build.builderName,
-      metadata: Object.entries(opts.build.metadata)
-        .map(([key, value]) => `${key}=${value}`)
-        .join(','),
+      metadata: opts.build.metadata
+        ? Object.entries(opts.build.metadata)
+            .map(([key, value]) => `${key}=${value}`)
+            .join(',')
+        : undefined,
       provider: opts.build.sourceControl.provider,
       repository: opts.build.sourceControl.repository,
       revision: opts.build.sourceControl.revision,

package.json

@@ -17,11 +17,11 @@
   "author": "Bugsnag Inc.",
   "license": "MIT",
   "devDependencies": {
+    "@randomgoods/tap-spec": "^5.0.4",
     "concat-stream": "^1.6.2",
-    "once": "^1.4.0",
     "formidable": "^3.5.1",
+    "once": "^1.4.0",
     "standard": "^16.0.1",
-    "@randomgoods/tap-spec": "^5.0.4",
     "tape": "^5.0.1"
   },
   "dependencies": {

test/build-reporter-plugin.test.mjs

@@ -41,10 +41,19 @@ test('it sends upon successful build', t => {
     })
   })
   server.listen()
+
+  // Add timeout to prevent hanging
+  const timeout = setTimeout(() => {
+    server.close()
+    t.fail('Test timed out - webpack process may be hanging')
+    t.end()
+  }, 30000) // 30 second timeout
+
   exec(join(__dirname, '..', 'node_modules', '.bin', 'webpack'), {
     env: generateEnv(server),
     cwd: join(__dirname, 'fixtures', 'a')
   }, (err, stdout, stderr) => {
+    clearTimeout(timeout)
     server.close()
     if (err) { console.info(err, '\n\n\n', stdout, '\n\n\n', stderr) }
     if (err) return t.fail(err.message)
@@ -62,12 +71,62 @@ test('it doesn’t send upon unsuccessful build', t => {
     })
   })
   server.listen()
+
+  // Add timeout to prevent hanging
+  const timeout = setTimeout(() => {
+    server.close()
+    t.fail('Test timed out - webpack process may be hanging')
+    t.end()
+  }, 30000) // 30 second timeout
+
   exec(join(__dirname, '..', 'node_modules', '.bin', 'webpack'), {
     env: generateEnv(server),
     cwd: join(__dirname, 'fixtures', 'b')
   }, (err, stdout, stderr) => {
+    clearTimeout(timeout)
+    server.close()
+    t.ok(err, 'webpack should fail due to syntax error')
+    t.end()
+  })
+})
+
+test('it sends upon successful build without metadata', t => {
+  t.plan(3)
+  const server = createServer((req, res) => {
+    let body = ''
+    req.on('data', (d) => { body += d })
+    req.on('end', () => {
+      res.end('ok')
+      let j
+      try {
+        j = JSON.parse(body)
+      } catch (e) {
+        server.close()
+        t.fail('failed to parse body as json')
+      }
+      t.ok(j, 'json body was received')
+      t.equal(j.appVersion, '1.2.3', 'body should contain app version')
+      t.equal(j.apiKey, 'YOUR_API_KEY', 'body should contain api key')
+      // Note: no metadata check since none was provided
+    })
+  })
+  server.listen()
+
+  // Add timeout to prevent hanging
+  const timeout = setTimeout(() => {
+    server.close()
+    t.fail('Test timed out - webpack process may be hanging')
+    t.end()
+  }, 30000) // 30 second timeout
+
+  exec(join(__dirname, '..', 'node_modules', '.bin', 'webpack'), {
+    env: generateEnv(server),
+    cwd: join(__dirname, 'fixtures', 'i')
+  }, (err, stdout, stderr) => {
+    clearTimeout(timeout)
     server.close()
-    t.ok(err)
+    if (err) { console.info(err, '\n\n\n', stdout, '\n\n\n', stderr) }
+    if (err) return t.fail(err.message)
     t.end()
   })
 })

test/fixtures/i/.gitignore

@@ -0,0 +1 @@
+bundle.js

test/fixtures/i/app.js

@@ -0,0 +1 @@
+console.log('hello world without metadata')

test/fixtures/i/webpack.config.js

@@ -0,0 +1,17 @@
+const BugsnagBuildReporterPlugin = require('../../../').BugsnagBuildReporterPlugin
+
+module.exports = {
+  entry: './app.js',
+  output: {
+    path: __dirname,
+    filename: './bundle.js'
+  },
+  plugins: [
+    new BugsnagBuildReporterPlugin({
+      apiKey: 'YOUR_API_KEY',
+      appVersion: '1.2.3',
+      endpoint: `http://localhost:${process.env.PORT}`
+      // Note: no metadata provided
+    })
+  ]
+}

test/source-map-uploader-plugin.test.mjs

@@ -197,8 +197,8 @@ if (process.env.WEBPACK_VERSION !== '3') {
 
       const done = () => {
         t.equal(requests[0].minifiedUrl, '*/dist/main.js')
-        t.match(requests[0].parts[1].filename, /main\.js$/)
-        t.match(requests[0].parts[0].filename, /main\.js\.map$/)
+        t.match(requests[0].parts.find(p => p.filename.includes('.js') && !p.filename.includes('.map'))?.filename, /main\.js$/)
+        t.match(requests[0].parts.find(p => p.filename.includes('.js.map'))?.filename, /main\.js\.map$/)
         end()
       }
 
@@ -246,11 +246,11 @@ if (process.env.WEBPACK_VERSION !== '3') {
     const done = () => {
       requests.sort((a, b) => a.minifiedUrl < b.minifiedUrl ? -1 : 1)
       t.equal(requests[0].minifiedUrl, '*/dist/main.css')
-      t.match(requests[0].parts[0].filename, /main\.css/)
-      t.match(requests[0].parts[0].filename, /main\.css\.map/)
+      t.match(requests[0].parts.find(p => p.filename.includes('.css'))?.filename, /main\.css/)
+      t.match(requests[0].parts.find(p => p.filename.includes('.map'))?.filename, /main\.css\.map/)
       t.equal(requests[1].minifiedUrl, '*/dist/main.js')
-      t.match(requests[1].parts[0].filename, /main\.js/)
-      t.match(requests[1].parts[0].filename, /main\.js\.map/)
+      t.match(requests[1].parts.find(p => p.filename.includes('.js') && !p.filename.includes('.map'))?.filename, /main\.js/)
+      t.match(requests[1].parts.find(p => p.filename.includes('.js.map'))?.filename, /main\.js\.map/)
       end()
     }