Skip to content

Add config.js_exclude_paths to skip rollbar.js injection on some paths - #1208

Open
bugthing wants to merge 2 commits into
rollbar:masterfrom
bugthing:js-exclude-paths
Open

Add config.js_exclude_paths to skip rollbar.js injection on some paths#1208
bugthing wants to merge 2 commits into
rollbar:masterfrom
bugthing:js-exclude-paths

Conversation

@bugthing

@bugthing bugthing commented Aug 25, 2026

Copy link
Copy Markdown

Rollbar::Middleware::Js currently injects the rollbar.js snippet into every 200 HTML response app-wide, with no way to opt individual paths out.

The poblem is for routes that serve their own restrictive Content-Security-Policy, for example rswag-ui's Swagger UI page sets a hardcoded, narrow CSP (script-src 'self' 'unsafe-inline') that doesn't allow cdn.rollbar.com. The injected snippet's breaks their CSP

Change

Adds config.js_exclude_paths, an array of String (matched as a PATH_INFO prefix) or Regexp entries. When a request's path matches any entry, Rollbar::Middleware::Js skips injecting the config/snippet <script> tags for that response, using the same short-circuit as the existing enabled?/attachment?/streaming? checks in add_js?.

Rollbar.configure do |config|
  config.js_enabled = true
  config.js_exclude_paths = ['/api-docs', %r{\A/health}]
end

Defaults to [], so this is fully backward compatible — no behavior change unless the option is explicitly set.

Rollbar::Middleware::Js currently injects the rollbar.js snippet into
every 200 HTML response app-wide with no way to opt individual paths
out. This is a problem for routes that serve their own restrictive
Content-Security-Policy (e.g. rswag-ui's Swagger UI page), where the
injected script tags can't load cdn.rollbar.com and just fail silently.

js_exclude_paths accepts an array of String (matched as a PATH_INFO
prefix) or Regexp entries. Defaults to [] for full backward
compatibility.
@bugthing
bugthing marked this pull request as ready for review August 25, 2026 16:43

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8fbb3c1948

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread lib/rollbar/middleware/js.rb Outdated
Regexp#match? was added in Ruby 2.4 and isn't available on Ruby
2.0-2.3, which the gemspec still declares support for. Using it
raised NoMethodError on older rubies, which the outer rescue
silently swallowed, disabling JS injection entirely.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant