-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(apple): Update session replay docs with AVFoundation limitation #14700
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
feat(apple): Update session replay docs with AVFoundation limitation #14700
Conversation
Co-authored-by: phil.niedertscheider <phil.niedertscheider@sentry.io>
|
Cursor Agent can help with this pull request. Just |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Bundle ReportChanges will decrease total bundle size by 1.15MB (-5.06%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
App Routes Affected:
|
|
Content-wise the changes look good 👌 I find this Troubleshooting page hard to scan, especially with the "Known Limitations" heading mixed in there. Can we follow the pattern seen on the JavaScript Troubleshooting page for Replay? https://sentry-docs-git-cursor-update-session-replay-docs-with-a-c0ad0e.sentry.dev/platforms/javascript/session-replay/troubleshooting/ |
|
I agree the JS troubleshooting page makes more sense with a larger list of issues. |
|
I think known limitations can still fall within in the Troubleshooting context/page! For the JS troubleshooting docs, we use it in a way that lists known limitations as well |
…on-replay-docs-with-avfoundation-limitation-785f
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation for a known limitation where AVFoundation views and layers cannot be captured in iOS Session Replay, addressing user confusion about why video content and camera previews don't appear in replays.
- Adds a new "Known Limitations" section explaining AVFoundation capture limitations
- Clarifies that
unmaskedViewClassesconfiguration cannot override this limitation - Provides reference to GitHub issue for tracking progress on potential solutions
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
@jas-kas I updated it so that it fits the new collapsable list. |
|
@philprime looks like latest deploy failed so I can't see the latest Vercel preview with your changes :/ |
|
ok, the deploy is back. visual changes look good! |
DESCRIBE YOUR PR
This PR adds a "Known Limitations" section to the iOS Session Replay troubleshooting page. It clarifies that AVFoundation views and layers, such as
AVPlayerLayerandAVCaptureVideoPreviewLayer(used for camera previews and video content), cannot be captured by Session Replay. This limitation applies even when using theunmaskedViewClassesconfiguration.This update addresses user confusion (as seen in the provided Slack context) where users attempt to unmask AVFoundation-backed views and expect them to appear in replays.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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
Slack Thread