feat(android): Improve SentryNavEffect by consolidating back stack entry mapping (JAVA-274) by 0xadam-brown · Pull Request #6197 · getsentry/sentry-java

0xadam-brown · 2026-09-30T20:01:01Z

📜 Description

PR improves the yet-to-be-released SentryNavEffect by replacing separate name and argument extractors with a single BackStackEntryMapper.

I've also updated terminology throughout to use "back stack entry" rather than "back stack route". That should avoid some developer confusion, given Google's use of "route" to mean (essentially) a navigation destination. By contrast, we need a term that refers solely to an element in the host app's back stack.

(In general, Nav3 is careful to distinguish between nav destinations and back stack entries, as a destination may be composed from multiple entries.)

💡 Motivation and Context

Lets us spare users from having to create three giant when statements mapping all the nav entries in their entire app (two for us and one for Nav3's entryProvider). Now users only have to create two.

A future PR will allow them to create just the one Google requires via a forthcoming Sentry entryProvider wrapper. That work will make use of the BackStackEntryMapper introduced here.

addresses: JAVA-274

💚 How did you test it?

Unit tests

📝 Checklist

I added GH Issue ID & Linear ID
I added tests to verify the 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.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.
Public API changes reviewed by another Mobile SDK team member or implemented according to the develop docs spec.

🔮 Next steps

Create PRs for the Nav3 sample app.
Remove the @ApiStatus.Internal annotations from SentryNavEffect, SentryNavOptions, RouteNameExtractor, and RouteArgumentsExtractor once we're ready to release publicly + add an appropriate CHANGELOG entry + publish the module via craft (link).
sentry-docs
Introduce a new rememberSentryEntryProvider() method that lets us extract Sentry back stack entry info from the mapping users already have to do on behalf of NavDisplay. (We don't have to hold up release of Nav3 support for this.)

#skip-changelog

github-actions · 2026-09-30T20:01:44Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against d877a7b

sentry · 2026-09-30T20:02:24Z

📲 Install Builds

Android

🔗 App Name	App ID	Version	Configuration
SDK Size	io.sentry.tests.size	8.59.0 (1)	release

⚙️ sentry-android Build Distribution Settings

…ute mapping (JAVA-274) Commit improves the yet-to-be-released SentryNavEffect by replacing separate route name and argument extractors with a single BackStackEntryMapper. Doing so lets us spare users from having to create three giant `when` statements mapping all nav entries in their entire app (two for us and one for Nav3's entryProvider). After this commit, users only have to create two. (Future work will allow them to create just one via a forthcoming Sentry entryProvider wrapper.) Commit also uses the term "back stack entry" rather than "back stack route" throughout to avoid developer confusion, given Google's use of "route" to mean (essentially) a navigation destination. By contrast, we need a term that refers solely to an element in the host app's back stack. (In general, Nav3 is careful to distinguish between nav destinations and back stack entries, as a destination may be composed from multiple entries in a back stack.)

0xadam-brown force-pushed the ref/sentry-nav-effect-consolidate-extractors branch from 0a1a393 to 3a694a1 Compare September 30, 2026 20:04