Skip to content

Conversation

@sfanahata
Copy link
Contributor

In local development, esbuild's write option was set to false, causing PNG images to be embedded as binary data in the JavaScript output instead of being written as external files. This resulted in 'Invalid or unexpected token' errors when rendering pages with images.

Now setting write=true for both development and CI environments, while keeping it false for production Lambda runtime where the filesystem is read-only.

Fixes issues multiple developers were experiencing in local dev.

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.): Local build is broken until this fix goes through
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

In local development, esbuild's write option was set to false,
causing PNG images to be embedded as binary data in the JavaScript
output instead of being written as external files. This resulted in
'Invalid or unexpected token' errors when rendering pages with images.

Now setting write=true for both development and CI environments,
while keeping it false for production Lambda runtime where the
filesystem is read-only.

Fixes issues multiple developers were experiencing in local dev.
@vercel
Copy link

vercel bot commented Nov 10, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Nov 10, 2025 10:59pm
sentry-docs Ready Ready Preview Comment Nov 10, 2025 10:59pm

Copy link
Member

@sergical sergical left a comment

Choose a reason for hiding this comment

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

great catch

@codecov
Copy link

codecov bot commented Nov 10, 2025

Bundle Report

Changes will increase total bundle size by 663 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.17MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.62MB 669 bytes (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/wGPJ0sAABKWJfMT9qdhxf/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/wGPJ0sAABKWJfMT9qdhxf/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/xUhqDyAlJ2W_nZlQznGzU/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/xUhqDyAlJ2W_nZlQznGzU/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.74MB -0.0%
../instrumentation.js -3 bytes 1.07MB -0.0%
9523.js -3 bytes 1.04MB -0.0%
../app/[[...path]]/page.js.nft.json 226 bytes 767.55kB 0.03%
../app/platform-redirect/page.js.nft.json 226 bytes 767.47kB 0.03%
../app/sitemap.xml/route.js.nft.json 226 bytes 764.7kB 0.03%

@sfanahata sfanahata merged commit b53f21d into master Nov 10, 2025
16 checks passed
@sfanahata sfanahata deleted the fix-mdx-image-embedding branch November 10, 2025 23:01
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.

3 participants