Skip to content

fix(core): Resolve Metro from project root for source map generation - #6625

Open
antonis wants to merge 5 commits into
mainfrom
fix/metro-resolve-project-root
Open

fix(core): Resolve Metro from project root for source map generation#6625
antonis wants to merge 5 commits into
mainfrom
fix/metro-resolve-project-root

Conversation

@antonis

@antonis antonis commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

📢 Type of change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring

📜 Description

The default Metro serializer resolved Metro's internal modules (baseJSBundle, bundleToString, sourceMapString) from the SDK's own location (__dirname). In a workspace/monorepo where a different Metro version is nested under @sentry/react-native than the one the app uses, that meant source maps were generated with a mismatched Metro version.

The serializer now resolves Metro internals preferring the app's options.projectRoot, falling back to the SDK-resolvable Metro. Resolution is deferred to the first serialization (when projectRoot is available) and memoized. In a normal single-Metro install both paths resolve to the same Metro, so behavior is unchanged.

💡 Motivation and Context

Surfaced while bumping the React Native sample to 0.87 (Metro 0.87) while packages/core pins Metro 0.84.4 as a devDependency: the nested SDK Metro shadowed the app's Metro 0.87 and broke production source-map generation. The fix also benefits real users who have multiple Metro versions resolvable in a monorepo.

Split out of #6617 so the sample bump carries no core changes.

💚 How did you test it?

  • Existing Metro serializer unit tests pass.
  • Local Android release build of the RN 0.87 sample produced a valid production bundle with a Debug ID via this serializer.

📝 Checklist

  • I added tests to verify changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • All tests passing.
  • Public API changes reviewed by another Mobile SDK team member or implemented according to the develop docs spec.
  • No breaking changes.

🔮 Next steps

  • Add a dedicated unit test that asserts Metro internals are resolved from options.projectRoot when a different Metro is nested under the SDK.

🤖 Generated with Claude Code

The vendored default serializer required Metro internals resolvable from
the SDK's own location. In this monorepo the core package has its own
Metro dev dependency (0.84.4) that shadows the app's Metro, so bundling
the RN 0.87 sample generated source maps with the mismatched older Metro
and threw `Unexpected module with full source map found` on the
metro-runtime require.js polyfill.

Resolve Metro internals from `options.projectRoot` (the app being
bundled) with a fallback to the previous SDK-local resolution. In a
normal install both resolve the same Metro instance, so behavior is
unchanged; in the monorepo the sample now bundles with its own 0.87
Metro. Resolution is deferred to the first serialization so
`options.projectRoot` is available, and memoized thereafter.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@antonis
antonis force-pushed the fix/metro-resolve-project-root branch from d8893b4 to addbd1d Compare August 27, 2026 11:21
@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Semver Impact of This PR

None (no version bump detected)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


  • fix(core): Resolve Metro from project root for source map generation by antonis in #6625
  • feat(tracing): Copy app start vitals onto standalone children by buenaflor in #6631
  • chore(deps): update Cocoa SDK to v9.26.1 by github-actions in #6623
  • fix(ios): Force-load the Sentry static archive to keep ObjC category methods by antonis in #6615
  • feat(core): Forward feature flag evaluations to the native SDKs by antonis in #6613
  • chore(deps): update Android SDK to v8.54.0 by github-actions in #6624
  • chore(deps): update Sentry Android Gradle Plugin to v6.20.0 by github-actions in #6627

🤖 This preview updates automatically when you update the PR.

@antonis antonis added the ready-to-merge Triggers the full CI test suite label Aug 27, 2026
Comment thread packages/core/src/js/tools/vendor/metro/utils.ts
@sentry

sentry Bot commented Aug 27, 2026

Copy link
Copy Markdown

📲 Install Builds

Android

🔗 App Name App ID Version Configuration
Sentry RN io.sentry.reactnative.sample 8.24.0 (104) Release

⚙️ sentry-react-native Build Distribution Settings

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

iOS (legacy) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 3856.69 ms 1221.58 ms -2635.11 ms
Size 5.08 MiB 6.80 MiB 1.72 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
ecf47a2+dirty 3835.20 ms 1222.43 ms -2612.77 ms
3817909+dirty 1183.90 ms 1187.50 ms 3.60 ms
5ee78d6+dirty 3847.52 ms 1224.27 ms -2623.25 ms
890d145+dirty 1223.59 ms 1231.37 ms 7.78 ms
e763471+dirty 3841.16 ms 1218.06 ms -2623.09 ms
3d31fcf+dirty 3838.09 ms 1223.46 ms -2614.63 ms
9210ae6+dirty 3815.93 ms 1214.14 ms -2601.79 ms
26843eb+dirty 3861.60 ms 1238.77 ms -2622.82 ms
7a89652+dirty 3861.46 ms 1229.61 ms -2631.85 ms
9ad4522+dirty 3850.40 ms 1222.40 ms -2628.00 ms

App size

Revision Plain With Sentry Diff
ecf47a2+dirty 4.98 MiB 6.46 MiB 1.49 MiB
3817909+dirty 3.38 MiB 4.73 MiB 1.35 MiB
5ee78d6+dirty 5.15 MiB 6.69 MiB 1.53 MiB
890d145+dirty 3.38 MiB 4.77 MiB 1.38 MiB
e763471+dirty 4.98 MiB 6.51 MiB 1.53 MiB
3d31fcf+dirty 4.98 MiB 6.56 MiB 1.58 MiB
9210ae6+dirty 5.15 MiB 6.68 MiB 1.53 MiB
26843eb+dirty 4.98 MiB 6.53 MiB 1.55 MiB
7a89652+dirty 5.15 MiB 6.70 MiB 1.55 MiB
9ad4522+dirty 4.98 MiB 6.56 MiB 1.58 MiB

Previous results on branch: fix/metro-resolve-project-root

Startup times

Revision Plain With Sentry Diff
ade1508+dirty 3839.98 ms 1220.75 ms -2619.23 ms

App size

Revision Plain With Sentry Diff
ade1508+dirty 5.08 MiB 6.72 MiB 1.64 MiB

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Android (legacy) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 421.02 ms 430.26 ms 9.24 ms
Size 49.74 MiB 55.66 MiB 5.91 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
8e18f68+dirty 426.20 ms 456.44 ms 30.24 ms
038a6d7+dirty 524.82 ms 531.92 ms 7.10 ms
a858ac3+dirty 426.50 ms 484.82 ms 58.32 ms
822d35b+dirty 429.31 ms 498.04 ms 68.73 ms
5ca03f9+dirty 423.30 ms 467.00 ms 43.70 ms
083e3ef+dirty 446.67 ms 491.68 ms 45.01 ms
4953e94+dirty 442.02 ms 456.52 ms 14.50 ms
244f6e8+dirty 424.36 ms 488.29 ms 63.92 ms
2e64504+dirty 450.52 ms 482.70 ms 32.18 ms
a9df5ce+dirty 418.40 ms 452.38 ms 33.98 ms

App size

Revision Plain With Sentry Diff
8e18f68+dirty 49.74 MiB 55.45 MiB 5.71 MiB
038a6d7+dirty 48.30 MiB 53.60 MiB 5.30 MiB
a858ac3+dirty 49.74 MiB 55.08 MiB 5.34 MiB
822d35b+dirty 49.74 MiB 54.84 MiB 5.10 MiB
5ca03f9+dirty 49.74 MiB 55.26 MiB 5.52 MiB
083e3ef+dirty 49.74 MiB 55.36 MiB 5.61 MiB
4953e94+dirty 43.75 MiB 48.08 MiB 4.33 MiB
244f6e8+dirty 49.74 MiB 55.38 MiB 5.63 MiB
2e64504+dirty 49.74 MiB 55.45 MiB 5.71 MiB
a9df5ce+dirty 49.74 MiB 55.36 MiB 5.62 MiB

Previous results on branch: fix/metro-resolve-project-root

Startup times

Revision Plain With Sentry Diff
ade1508+dirty 485.55 ms 545.23 ms 59.68 ms

App size

Revision Plain With Sentry Diff
ade1508+dirty 49.74 MiB 55.45 MiB 5.71 MiB

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

iOS (new) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 3841.65 ms 1224.58 ms -2617.07 ms
Size 5.08 MiB 6.80 MiB 1.72 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
3ce5254+dirty 1217.70 ms 1224.69 ms 6.99 ms
0b1b5e3+dirty 3820.72 ms 1207.94 ms -2612.78 ms
44abcc2+dirty 3841.42 ms 1214.77 ms -2626.65 ms
1d3572b+dirty 3830.71 ms 1222.23 ms -2608.49 ms
6177334+dirty 3851.52 ms 1226.23 ms -2625.29 ms
5ee78d6+dirty 3815.71 ms 1217.04 ms -2598.67 ms
083e3ef+dirty 3871.96 ms 1234.95 ms -2637.01 ms
ce7b368+dirty 3851.41 ms 1222.37 ms -2629.04 ms
7887847+dirty 3844.89 ms 1221.67 ms -2623.22 ms
1122a96+dirty 3839.17 ms 1219.23 ms -2619.93 ms

App size

Revision Plain With Sentry Diff
3ce5254+dirty 3.38 MiB 4.76 MiB 1.38 MiB
0b1b5e3+dirty 5.15 MiB 6.70 MiB 1.54 MiB
44abcc2+dirty 4.98 MiB 6.55 MiB 1.57 MiB
1d3572b+dirty 4.98 MiB 6.56 MiB 1.58 MiB
6177334+dirty 5.15 MiB 6.68 MiB 1.53 MiB
5ee78d6+dirty 5.15 MiB 6.69 MiB 1.53 MiB
083e3ef+dirty 4.98 MiB 6.55 MiB 1.57 MiB
ce7b368+dirty 4.98 MiB 6.51 MiB 1.53 MiB
7887847+dirty 4.98 MiB 6.46 MiB 1.48 MiB
1122a96+dirty 5.15 MiB 6.68 MiB 1.53 MiB

Previous results on branch: fix/metro-resolve-project-root

Startup times

Revision Plain With Sentry Diff
ade1508+dirty 3846.26 ms 1221.43 ms -2624.83 ms

App size

Revision Plain With Sentry Diff
ade1508+dirty 5.08 MiB 6.72 MiB 1.64 MiB

… over a nested SDK copy

requireMetroModule now tries each candidate path shape against the app
(projectRoot) before the SDK's own location, so the app's Metro wins even
when the two copies expose internals via different subpaths (app on
metro/src/*, SDK on metro/private/*). Adds projectRoot-preference and
ordering-regression tests using on-disk fake-Metro fixtures.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Android (new) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 428.06 ms 458.04 ms 29.98 ms
Size 49.74 MiB 55.66 MiB 5.91 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
8e18f68+dirty 443.14 ms 446.98 ms 3.84 ms
ca9d079+dirty 460.67 ms 512.54 ms 51.87 ms
c151573+dirty 485.39 ms 495.18 ms 9.79 ms
5a21b51+dirty 505.16 ms 539.20 ms 34.04 ms
ecf47a2+dirty 457.21 ms 498.10 ms 40.89 ms
1d3572b+dirty 444.48 ms 478.42 ms 33.94 ms
3ce5254+dirty 373.90 ms 427.84 ms 53.94 ms
9b5615c+dirty 428.67 ms 490.15 ms 61.48 ms
2e64504+dirty 488.33 ms 541.31 ms 52.98 ms
ad66da3+dirty 411.49 ms 449.38 ms 37.89 ms

App size

Revision Plain With Sentry Diff
8e18f68+dirty 49.74 MiB 55.45 MiB 5.71 MiB
ca9d079+dirty 48.30 MiB 53.58 MiB 5.28 MiB
c151573+dirty 48.30 MiB 53.54 MiB 5.24 MiB
5a21b51+dirty 48.30 MiB 53.49 MiB 5.19 MiB
ecf47a2+dirty 49.74 MiB 54.82 MiB 5.07 MiB
1d3572b+dirty 49.74 MiB 55.38 MiB 5.63 MiB
3ce5254+dirty 43.94 MiB 48.98 MiB 5.04 MiB
9b5615c+dirty 49.74 MiB 55.09 MiB 5.34 MiB
2e64504+dirty 49.74 MiB 55.45 MiB 5.71 MiB
ad66da3+dirty 48.30 MiB 53.49 MiB 5.19 MiB

Previous results on branch: fix/metro-resolve-project-root

Startup times

Revision Plain With Sentry Diff
ade1508+dirty 491.94 ms 520.06 ms 28.12 ms

App size

Revision Plain With Sentry Diff
ade1508+dirty 49.74 MiB 55.45 MiB 5.71 MiB

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

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit 0645154. Configure here.

@antonis
antonis marked this pull request as ready for review August 27, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge Triggers the full CI test suite

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant