Skip to content

fix(core): Escape JSON.stringify output that goes into generated code - #26314

Merged
isaacs merged 2 commits into
developfrom
feat/escape-json-stringify-for-js-injection
Nov 17, 2026
Merged

isaacs merged 2 commits into
developfrom
feat/escape-json-stringify-for-js-injection

Conversation

@isaacs

@isaacs isaacs commented Nov 12, 2026 •

Copy link
Copy Markdown
Member

JSON.stringify output is a valid JavaScript expression, but it does not escape < and >. When a value with </script> or <!-- goes into generated code and the bundle is inlined in HTML, it breaks out of the <script> element.

CodeQL flags this pattern (js/bad-code-sanitization). This helper avoids the issue.

Two packages had their own private escape helpers, and they did different things: bundler-plugins escaped <, and Remix escaped </ and <!--. The other SDKs did not escape at all. Now stringifyForCodeInjection in @sentry/core is the one helper. It is a drop-in replacement for JSON.stringify that also escapes <, >, U+2028 and U+2029. These characters only occur inside JSON strings, where their \u escapes have the same value. JSON.stringify already escapes the other characters in the CodeQL example.

Build-time code in astro, bundler-plugins, cloudflare, nextjs, nuxt, remix, server-utils, solidstart, svelte, sveltekit and tanstackstart-react now uses it for code, virtual modules, loaders and Vite define values. AGENTS.md points to it.

These uses of JSON.stringify stay as they are:

  • log and warning messages
  • boolean define and DefinePlugin values, and npm package names in __SENTRY_SERVER_MODULES__
  • the node local variables worker, which sends code to the V8 inspector, not to HTML
  • the Node ESM loader in server-runtime-injection, which is URL-encoded into a data: URL
  • base64-encoded source maps

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

size-limit report 📦

Compared: 77abacc (PR test merge using develop at 4202227)

Against: 4202227 (develop) · base run #66528

✅ Baseline matches: this diff contains only this PR's changes.

Path Size % Change Change
@sentry/browser 30.12 kB - -
@sentry/browser - with treeshaking flags 28.32 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 28.22 kB - -
@sentry/browser (incl. Tracing) 52.3 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 52.3 kB - -
@sentry/browser (incl. Tracing, Profiling) 55.27 kB - -
@sentry/browser (incl. Tracing, Replay) 92.83 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 81.62 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 97.22 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 110.61 kB - -
@sentry/browser (incl. Feedback) 47.74 kB - -
@sentry/browser (incl. sendFeedback) 30.7 kB - -
@sentry/browser (incl. FeedbackAsync) 35.71 kB - -
@sentry/browser (incl. Metrics) 31.44 kB - -
@sentry/browser (incl. Logs) 31.72 kB - -
@sentry/browser (incl. Metrics & Logs) 32.38 kB - -
@sentry/react 32.13 kB - -
@sentry/react (incl. Tracing) 54.97 kB - -
@sentry/vue 38.31 kB - -
@sentry/vue (incl. Tracing) 55.26 kB - -
@sentry/svelte 30.13 kB - -
@sentry/remix (Remix 3 client bundle) 58.08 kB - -
CDN Bundle 31.89 kB - -
CDN Bundle (incl. Tracing) 52.72 kB - -
CDN Bundle (incl. Logs, Metrics) 34.68 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 55.28 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 75.72 kB - -
CDN Bundle (incl. Tracing, Replay) 90.74 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 93.34 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 96.11 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 98.7 kB - -
CDN Bundle - uncompressed 93.05 kB - -
CDN Bundle (incl. Tracing) - uncompressed 155.52 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 101.39 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 163.15 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 231.51 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 275.67 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 283.3 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 287.47 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 295.09 kB - -
@sentry/nextjs (client) 58.59 kB - -
@sentry/sveltekit (client) 53.59 kB - -
@sentry/core/server 44.8 kB - -
@sentry/core/browser 14.4 kB - -
@sentry/node 151.67 kB -0.01% -6 B 🔽
@sentry/node/import (ESM hook with diagnostics-channel injection) 83.34 kB +0.01% +2 B 🔺
@sentry/node - without tracing 88.6 kB -0.01% -2 B 🔽
@sentry/node - without channel injection 140.63 kB -0.01% -1 B 🔽
@sentry/aws-serverless 98.97 kB -0.01% -8 B 🔽
@sentry/cloudflare (withSentry) - minified 206.94 kB - -
@sentry/cloudflare (withSentry) 480.32 kB - -
@sentry/nextjs/cloudflare (withSentry) - minified 232.31 kB - -

View base workflow run

@github-actions

Copy link
Copy Markdown
Contributor

One or more gzipped bundles increased by more than 500 bytes. If this increase is intentional, add the Accept Bundlesize Increase label to this PR to rerun and accept the check.

@isaacs
isaacs added this pull request to stack #26315 November 12, 2026 10:28
@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Optional E2E tests

Some optional checks were not successful. They do not block the merge. 1 not successful, 62 successful. See the run.

Check Status
❌ CI: Optional E2E Tests / E2E nextjs-16-cacheComponents (cloudflare) Test (optional) Failing after 10m Details
Successful checks
Check Status
✅ CI: Optional E2E Tests / E2E astro-7-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (cloudflare, latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E cloudflare-agent Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E cloudflare-mastra Test (optional) Successful in 45s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable Test (optional) Successful in 51s Details
✅ CI: Optional E2E Tests / E2E cloudflare-flue-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E debug-id-sourcemaps Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable (latest) Test (optional) Successful in 44s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (latest) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E cloudflare-workers-send-to-sentry Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think (ai v6) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E astro-7 Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (cloudflare) Test (optional) Successful in 44s Details
✅ CI: Optional E2E Tests / E2E node-flue Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-eve Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext, bun) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v2 Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E node-pi-durable Test (optional) Successful in 37s Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries Test (optional) Successful in 54s Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (latest) Test (optional) Successful in 50s Details
✅ CI: Optional E2E Tests / E2E deno (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5 Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E cloudflare-workers-without-tracing-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-14 (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-16-tunnel (cloudflare) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (bun) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (static / nuxt generate) Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (turbo) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-mastra Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-eve (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-eve (content off, latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v1 Test (optional) Successful in 30s Details
✅ CI: Optional E2E Tests / E2E nuxt-5 (development) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E react-router-7-framework-instrumentation Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-pi-durable (latest) Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (latest) Test (optional) Successful in 58s Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-tunnel Test (optional) Successful in 55s Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (client source maps kept) Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E node-mastra (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E react-send-to-sentry Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-cloudflare Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions Test (optional) Successful in 35s Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-eve (orchestrion) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E supabase-nextjs Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E solidstart-2-tunnel Test (optional) Successful in 54s Details
✅ CI: Optional E2E Tests / E2E node-flue (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps Test (optional) Successful in 42s Details
✅ CI: Optional E2E Tests / E2E vue-3 (no Options API) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-orpc Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-sourcemaps Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (deno) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5 (kv-cache) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E solidstart-2 Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-cloudflare Test (optional) Successful in 37s Details
✅ CI: Optional E2E Tests / E2E nestjs-12 (cloudflare) Test (optional) Successful in 31s Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions (latest) Test (optional) Successful in 1m Details

@isaacs
isaacs force-pushed the feat/escape-json-stringify-for-js-injection branch from 1d4e4d8 to 97cab5a Compare November 12, 2026 11:19
@isaacs
isaacs requested a review from a team November 12, 2026 11:19

@cursor cursor 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.

Stale Bugbot comment from a previous run.

@JPeer264 JPeer264 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice one

Comment thread AGENTS.md Resolved
@JPeer264
JPeer264 force-pushed the feat/escape-json-stringify-for-js-injection branch from 97cab5a to ecc2738 Compare November 12, 2026 13:28
Base automatically changed from jp/nextjs-deno-entry to develop November 13, 2026 06:40
@JPeer264
JPeer264 force-pushed the feat/escape-json-stringify-for-js-injection branch from ecc2738 to 4d40b75 Compare November 13, 2026 06:40
@isaacs
isaacs force-pushed the feat/escape-json-stringify-for-js-injection branch 3 times, most recently from e3cbb11 to cb6d5bd Compare November 17, 2026 15:16

@cursor cursor 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.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Want fixes drafted automatically? Bugbot Autofix can create code changes for findings. A team admin can enable Autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit cb6d5bd. Configure here.

return `const ${MERGED_OPTIONS_IDENTIFIER} = ${optionsFn};\n`;
}

const names = bindingNames.map(name => JSON.stringify(name)).join(', ');

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Missed stringify in generated code

Low Severity

This is flagged because the review guideline requires stringifyForCodeInjection whenever JSON.stringify output goes into generated code. These files already switched other injections over, but ctx.workerInfo, instrumentStoragePath, and driverName are still stringified with JSON.stringify and inlined into emitted modules.

Additional Locations (1)
Fix in Cursor Fix in Web

Triggered by project rule: PR Review Guidelines for Cursor Bot

Reviewed by Cursor Bugbot for commit cb6d5bd. Configure here.

isaacs and others added 2 commits November 17, 2026 07:23
`JSON.stringify` output is a valid JavaScript expression, but it does
not escape `<` and `>`. When a value with `</script>` or `<!--` goes
into generated code and the bundle is inlined in HTML, it breaks out of
the `<script>` element.

CodeQL flags this pattern (js/bad-code-sanitization). This helper avoids
the issue.

Two packages had their own private escape helpers, and they did
different things: `bundler-plugins` escaped `<`, and Remix escaped `</`
and `<!--`. The other SDKs did not escape at all. Now
`stringifyForCodeInjection` in `@sentry/core` is the one helper. It is
a drop-in replacement for `JSON.stringify` that also escapes `<`, `>`,
U+2028 and U+2029. These characters only occur inside JSON strings,
where their `\u` escapes have the same value. `JSON.stringify` already
escapes the other characters in the CodeQL example.

Build-time code in astro, bundler-plugins, cloudflare, nextjs, nuxt,
remix, server-utils, solidstart, svelte, sveltekit and
tanstackstart-react now uses it for code, virtual modules, loaders and
Vite `define` values. `AGENTS.md` points to it.

These uses of `JSON.stringify` stay as they are:

- log and warning messages
- boolean `define` and `DefinePlugin` values, and npm package names in
  `__SENTRY_SERVER_MODULES__`
- the `node` local variables worker, which sends code to the V8
  inspector, not to HTML
- the Node ESM loader in `server-runtime-injection`, which is
  URL-encoded into a `data:` URL
- base64-encoded source maps

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@isaacs
isaacs force-pushed the feat/escape-json-stringify-for-js-injection branch from a9d1a6b to 69b6f99 Compare November 17, 2026 15:23
@isaacs
isaacs enabled stacked auto-merge (squash) November 17, 2026 15:24
@isaacs
isaacs merged commit e0565f2 into develop Nov 17, 2026
474 of 475 checks passed
@isaacs
isaacs deleted the feat/escape-json-stringify-for-js-injection branch November 17, 2026 15:57
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.

2 participants