feat: adds configurable dev environments for source map upload plugins

Author: subzero10

packages/esbuild-plugin/README.md

@@ -68,6 +68,9 @@ These plugin parameters correspond to the Honeybadger [Source Map Upload API](ht
     <dd>The name of the user that triggered this deploy, for example, "Jane"</dd>
   </dl>
   </dd>
+
+  <dt><code>developmentEnvironments</code> (optional &mdash; default: ["dev", "development", "test"])</dt>
+  <dd>Used to decide whether source maps should be uploaded or not.</dd>
 </dl>
 
 ### esbuild.config.js

packages/esbuild-plugin/src/index.ts

@@ -24,7 +24,7 @@ class HoneybadgerSourceMapPlugin {
     return {
       name: PLUGIN_NAME,
       setup(build: PluginBuild) {
-        if (self.isNonProdEnv()) {
+        if (self.isDevEnv(self.options.developmentEnvironments)) {
           return
         }
 
@@ -95,8 +95,12 @@ class HoneybadgerSourceMapPlugin {
     return assets
   }
 
-  private isNonProdEnv(): boolean {
-    return !!process.env.NODE_ENV && process.env.NODE_ENV !== 'production'
+  private isDevEnv(devEnvironments: string[]): boolean {
+    if (!process.env.NODE_ENV || process.env.NODE_ENV === '') {
+      return false
+    }
+
+    return devEnvironments.includes(process.env.NODE_ENV)
   }
 
   private handleError(error: Error): Message {

packages/plugin-core/src/options.ts

@@ -11,6 +11,7 @@ export const DEFAULT_DEPLOY = false
 export const DEFAULT_DEPLOY_ENDPOINT = 'https://api.honeybadger.io/v1/deploys'
 export const DEFAULT_IGNORE_PATHS = []
 export const DEFAULT_IGNORE_ERRORS = false
+export const DEFAULT_DEVELOPMENT_ENVIRONMENTS = ['dev', 'development', 'test'];
 
 const required = [
   'apiKey',
@@ -27,6 +28,7 @@ const defaultOptions = {
   ignorePaths: DEFAULT_IGNORE_PATHS,
   ignoreErrors: DEFAULT_IGNORE_ERRORS,
   workerCount: DEFAULT_WORKER_COUNT,
+  developmentEnvironments: DEFAULT_DEVELOPMENT_ENVIRONMENTS
 }
 
 export function cleanOptions(
@@ -44,6 +46,11 @@ export function cleanOptions(
     throw new Error('ignorePaths must be an array')
   }
 
+  // Validate developmentEnvironments
+  if (options.developmentEnvironments && !Array.isArray(options.developmentEnvironments)) {
+    throw new Error('developmentEnvironments must be an array')
+  }
+
   // Don't allow excessive retries
   if (options.retries && options.retries > MAX_RETRIES) {
     if (!options.silent) {

packages/plugin-core/src/types.ts

@@ -11,6 +11,7 @@ export type HbPluginOptions = {
   ignorePaths: Array<string>;
   ignoreErrors: boolean;
   workerCount: number;
+  developmentEnvironments: Array<string>;
 }
 
 // Options passed in by a user

packages/rollup-plugin/README.md

@@ -70,6 +70,9 @@ These plugin parameters correspond to the Honeybadger [Source Map Upload API](ht
     <dd>The name of the user that triggered this deploy, for example, "Jane"</dd>
   </dl>
   </dd>
+
+  <dt><code>developmentEnvironments</code> (optional &mdash; default: ["dev", "development", "test"])</dt>
+  <dd>Used to decide whether source maps should be uploaded or not.</dd>
 </dl>
 
 ### rollup.config.js

packages/rollup-plugin/src/index.ts

@@ -1,4 +1,4 @@
-import { extractSourcemapDataFromBundle, isNonProdEnv } from './rollupUtils'
+import { extractSourcemapDataFromBundle, isDevEnv } from './rollupUtils'
 import { sendDeployNotification, uploadSourcemaps, cleanOptions, Types } from '@honeybadger-io/plugin-core'
 import type { OutputBundle, Plugin, NormalizedOutputOptions } from 'rollup'
 
@@ -13,7 +13,7 @@ export default function honeybadgerRollupPlugin(
       outputOptions: NormalizedOutputOptions,
       bundle: OutputBundle
     ) => {
-      if (isNonProdEnv()) {
+      if (isDevEnv(hbOptions.developmentEnvironments)) {
         if (!hbOptions.silent) {
           console.info('Honeybadger will not upload sourcemaps in non-production environment.')
         }

packages/rollup-plugin/src/rollupUtils.ts

@@ -55,6 +55,10 @@ function formatSourcemapData(
  * In Rollup without Vite, it may or may not be available,
  * so if it's missing we'll assume prod
  */
-export function isNonProdEnv(): boolean {
-  return !!process.env.NODE_ENV && process.env.NODE_ENV !== 'production'
+export function isDevEnv(devEnvironments: string[]): boolean {
+  if (!process.env.NODE_ENV || process.env.NODE_ENV === '') {
+    return false
+  }
+
+  return devEnvironments.includes(process.env.NODE_ENV)
 }

packages/rollup-plugin/test/rollupUtils.test.ts

@@ -1,5 +1,5 @@
 import { expect } from 'chai'
-import { extractSourcemapDataFromBundle, isNonProdEnv } from '../src/rollupUtils';
+import { extractSourcemapDataFromBundle, isDevEnv } from '../src/rollupUtils';
 import bundle from './fixtures/bundle'
 import path from 'node:path'
 import { NormalizedOutputOptions } from 'rollup';
@@ -91,29 +91,40 @@ describe('extractSourcemapDataFromBundle', () => {
   })
 })
 
-describe('isNonProdEnv', () => {
+describe('isDevEnv', () => {
+  const developmentEnvironments = ['development', 'test', 'staging']
   let restore
 
   beforeEach(() => {
     restore = process.env.NODE_ENV
   })
 
   afterEach(() => {
+    // @ts-expect-error
     process.env.NODE_ENV = restore
   })
 
   it('returns true if NODE_ENV is non-prod', () => {
+    // @ts-expect-error
     process.env.NODE_ENV = 'development'
-    expect(isNonProdEnv()).to.equal(true)
+    expect(isDevEnv(developmentEnvironments)).to.equal(true)
+  })
+
+  it('returns false if NODE_ENV is non-prod but not in developmentEnvironments array', () => {
+    // @ts-expect-error
+    process.env.NODE_ENV = 'staging'
+    expect(isDevEnv(developmentEnvironments)).to.equal(false)
   })
 
   it('returns false if NODE_ENV is missing', () => {
+    // @ts-expect-error
     delete process.env.NODE_ENV
-    expect(isNonProdEnv()).to.equal(false)
+    expect(isDevEnv(developmentEnvironments)).to.equal(false)
   })
 
   it('returns false if NODE_ENV is prod', () => {
+    // @ts-expect-error
     process.env.NODE_ENV = 'production'
-    expect(isNonProdEnv()).to.equal(false)
+    expect(isDevEnv(developmentEnvironments)).to.equal(false)
   })
 })

packages/rollup-plugin/tsconfig.json

@@ -2,9 +2,14 @@
   "extends": "../../tsconfig.base.json",
   "include": [
     "src/**/*.ts"
-  ], 
+  ],
   "compilerOptions": {
-    "rootDir": "./", 
+    "rootDir": "./",
     "allowSyntheticDefaultImports": true
   },
-}
+  "references": [
+    {
+      "path": "../plugin-core"
+    }
+  ]
+}

packages/webpack/README.md

@@ -77,6 +77,9 @@ These plugin parameters correspond to the Honeybadger [Source Map Upload API](ht
     <dd>The name of the user that triggered this deploy, for example, "Jane"</dd>
   </dl>
   </dd>
+
+  <dt><code>developmentEnvironments</code> (optional &mdash; default: ["dev", "development", "test"])</dt>
+  <dd>Source maps upload will be skipped when the environment matches any of the values in this array or the webpack dev server is running.</dd>
 </dl>
 
 ### Vanilla webpack.config.js

packages/webpack/src/HoneybadgerSourceMapPlugin.js

@@ -19,7 +19,7 @@ class HoneybadgerSourceMapPlugin {
   }
 
   async afterEmit (compilation) {
-    if (this.isDevServerRunning()) {
+    if (this.isDevEnv(this.options.developmentEnvironments)) {
       if (!this.options.silent) {
         console.info('\nHoneybadgerSourceMapPlugin will not upload source maps because webpack-dev-server is running.')
       }
@@ -41,8 +41,12 @@ class HoneybadgerSourceMapPlugin {
     }
   }
 
-  isDevServerRunning () {
-    return process.env.WEBPACK_DEV_SERVER === 'true'
+  isDevEnv (devEnvironments) {
+    if (process.env.WEBPACK_DEV_SERVER === 'true') {
+      return true
+    }
+
+    return !!(devEnvironments && devEnvironments.includes(process.env.NODE_ENV));
   }
 
   apply (compiler) {