Skip to content

feat(android-nav3): [Android Nav3 5] Make SentryNavEffect accessible to sample apps - #6137

Open
0xadam-brown wants to merge 1 commit into
feat/sentry-nav3-effect-4-effectfrom
feat/sentry-nav3-effect-5-effect
Open

0xadam-brown wants to merge 1 commit into
feat/sentry-nav3-effect-4-effectfrom
feat/sentry-nav3-effect-5-effect

Conversation

@0xadam-brown

@0xadam-brown 0xadam-brown commented Sep 21, 2026

Copy link
Copy Markdown
Member

PR Stack (Android Nav3)


📜 Description

Make SentryNavEffect public so the Nav3 sample app can consume the API shape we intend to expose.

Still marked as @ApiStatus.Internal until we actually release + include a CHANGELOG.

💡 Motivation and Context

The sample app should validate the actual API host apps will use. Keeping SentryNavEffect
internal blocks that validation, so this PR exposes the effect as the next step in the Nav3 stack.

addresses: JAVA-274

💚 How did you test it?

  • Existing unit tests
  • API dump updated via CI / local verification as needed

📝 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.
  • Public API changes reviewed by another Mobile SDK team member or implemented according to the develop docs spec.

🔮 Next steps

  • Expose the remaining Nav3 public APIs needed by the sample app
  • Add module README and docs

#skip-changelog

⚠️ Merge this PR using a merge commit (not squash). This PR should merge into the effect branch first, then flow back down the chain.

Make SentryNavEffect and related APIs public so they can be called from the Nav3 sample app. For now, keep them marked as @ApiStatus.Internal until we publicly released + include a CHANGELOG entry.
@github-actions

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

Generated by 🚫 dangerJS against 323c163

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

Reviewed by Cursor Bugbot for commit 323c163. Configure here.

@Composable
@Suppress("FunctionNaming")
internal fun <T : Any> SentryNavEffect(
public fun <T : Any> SentryNavEffect(

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Contradictory public API status annotations

Low Severity

SentryNavEffect and its parameter types are annotated with both @ApiStatus.Experimental and @ApiStatus.Internal. Those markers conflict: Internal means the API is not for host apps, while Experimental means it is public but unstable. The PR presents this as the integration surface host apps will use.

Additional Locations (2)
Fix in Cursor Fix in Web

Triggered by project rule: PR Review Guidelines for Cursor Bugbot

Reviewed by Cursor Bugbot for commit 323c163. Configure here.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Not sure what our convention here is, and happy to conform as needed.

This PR is meant to make SentryNavEffect public exclusively for our sample apps; official publication will come later, accompanied by a CHANGELOG entry, etc., at which point these APIs will still be experimental.

@sentry

sentry Bot commented Sep 21, 2026

Copy link
Copy Markdown

📲 Install Builds

Android

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

⚙️ sentry-android Build Distribution Settings

@0xadam-brown 0xadam-brown changed the title feat(android-nav3): [Android Nav3 5] Make SentryNavEffect public feat(android-nav3): [Android Nav3 5] Make SentryNavEffect accessible to sample apps Sep 21, 2026

This branch has not been deployed

No deployments
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