Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add WebView guide to mobile SDKs #12350

Merged
merged 7 commits into from
Jan 20, 2025
Merged

Conversation

krystofwoldrich
Copy link
Member

DESCRIBE YOUR PR

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

This PR adds a new page describing how mobile SDK (RN in this case) and browser SDK should be setup for use in web views.

I added only RN for now, but when aligned on the content of this page we can copy it for all the other mobile SDKs.

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.):
  • Other deadline: Not a specific date, but SE team is waiting for this page to be added.
  • 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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Jan 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 1:26pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jan 20, 2025 1:26pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jan 20, 2025 1:26pm

Copy link

codecov bot commented Jan 15, 2025

Bundle Report

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

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

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for adding this!

@krystofwoldrich krystofwoldrich changed the title Add React Native WebView guide Add WebView guide to mobile SDKs Jan 16, 2025
Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

Apple SDK LGTM.

Copy link
Contributor

@buenaflor buenaflor left a comment

Choose a reason for hiding this comment

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

Flutter looks good 👍

@stefanosiano
Copy link
Member

stefanosiano commented Jan 20, 2025

Android looks good
Just a couple of questions, though.

  1. Do we want to highlight the overhead of initializing the SDK in the webviews? I mean, if the user has multiple webviews in multiple parts of their app, they should know that initializing the SDK can have an overhead
  2. If i understood correctly, if the user closes the webview, then the js sdk is closed and needs to be reopen in the next webview, right? If so I'd be very explicit that the user has to init the js part on every webview they have

@krystofwoldrich
Copy link
Member Author

krystofwoldrich commented Jan 20, 2025

@stefanosiano

  1. I thought that's implicit as we point them to a guide of how to init JS. But we can call it out. Update: JS doesn't have explicit overhead doc page. So I would not add it.

  2. Good point, make sense to add.

@krystofwoldrich krystofwoldrich merged commit 707c24d into master Jan 20, 2025
11 checks passed
@krystofwoldrich krystofwoldrich deleted the kw-add-rn-web-view-guide branch January 20, 2025 14:40
@github-actions github-actions bot locked and limited conversation to collaborators Feb 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants