Rollbar Sourcemap Webpack Plugin

Common errors

• TypeError: RollbarSourceMapPlugin is not a constructor

  cause Attempting to use named import syntax `import { RollbarSourceMapPlugin }` when the plugin is exported as a default.
  fix Change the import statement to `import RollbarSourceMapPlugin from 'rollbar-sourcemap-webpack-plugin';` for ESM, or `const RollbarSourceMapPlugin = require('rollbar-sourcemap-webpack-plugin');` for CommonJS.

• Error: Missing required option: accessToken (or version/publicPath)

  cause One of the mandatory configuration options (`accessToken`, `version`, or `publicPath`) was not provided to the plugin.
  fix Review the plugin configuration in your `webpack.config.js` and ensure all required options (`accessToken`, `version`, `publicPath`) are present and correctly valued.

• Rollbar API Error: 400 Bad Request (or similar upload failure message)

  cause Often caused by an incorrect `accessToken`, an invalid `version` string, or a `publicPath` that doesn't correctly map to the deployed assets on your CDN.
  fix Double-check your Rollbar `post_server_item` access token. Ensure your `version` string is unique and valid. Verify that the `publicPath` configuration matches the exact base URL where your production JavaScript bundles are hosted.

Warnings

• breaking Version 3.0.0 introduced a breaking change requiring Webpack 4 or higher. Projects using Webpack 3 or older must remain on `rollbar-sourcemap-webpack-plugin` v2.x.
  Fix: Upgrade Webpack to version 4 or newer, or downgrade `rollbar-sourcemap-webpack-plugin` to a 2.x version compatible with your Webpack setup.
• gotcha The `accessToken`, `version`, and `publicPath` options are all required for the plugin to function correctly. Omitting any of these will lead to upload failures.
  Fix: Ensure `accessToken` (your Rollbar post_server_item token), `version` (a unique string for your code version, e.g., git SHA), and `publicPath` (the base URL for your deployed bundles) are all provided in the plugin configuration.
• gotcha Using `devtool: 'hidden-source-map'` is recommended for production builds when using this plugin, as it generates sourcemaps without adding comments to the bundled files, which could expose source map URLs publicly. Other `devtool` options might embed source map references or generate inline sourcemaps which are not suitable for external upload.
  Fix: Set `devtool: 'hidden-source-map'` in your Webpack configuration for production builds.

Install

• npm install rollbar-sourcemap-webpack-plugin npm
• yarn add rollbar-sourcemap-webpack-plugin yarn
• pnpm add rollbar-sourcemap-webpack-plugin pnpm

Imports

• RollbarSourceMapPlugin
  wrong:

  import { RollbarSourceMapPlugin } from 'rollbar-sourcemap-webpack-plugin';

  correct:

  import RollbarSourceMapPlugin from 'rollbar-sourcemap-webpack-plugin';

  The plugin is exported as a default export.
• RollbarSourceMapPlugin

  const RollbarSourceMapPlugin = require('rollbar-sourcemap-webpack-plugin');

  CommonJS `require` for older Node.js or `webpack.config.js` setups.

Quickstart

This quickstart demonstrates how to configure the plugin in a webpack.config.js to upload sourcemaps for a production build.

const RollbarSourceMapPlugin = require('rollbar-sourcemap-webpack-plugin');
const path = require('path');

const PUBLIC_PATH = 'https://my.cdn.net/assets';

module.exports = {
  mode: 'production',
  devtool: 'hidden-source-map',
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    publicPath: PUBLIC_PATH,
    filename: 'index-[contenthash].js'
  },
  plugins: [
    new RollbarSourceMapPlugin({
      accessToken: process.env.ROLLBAR_ACCESS_TOKEN ?? 'aaaabbbbccccddddeeeeffff00001111', // Use environment variable in production
      version: process.env.GIT_SHA ?? 'default-version-123',
      publicPath: PUBLIC_PATH,
      includeChunks: ['main'] // Specify chunk name if desired
    })
  ]
};