Skip to content

Conversation

@philprime
Copy link
Member

@philprime philprime commented Aug 25, 2025

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 AVPlayerLayer and AVCaptureVideoPreviewLayer (used for camera previews and video content), cannot be captured by Session Replay. This limitation applies even when using the unmaskedViewClasses configuration.

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.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • 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


Slack Thread

Open in Cursor Open in Web

Co-authored-by: phil.niedertscheider <phil.niedertscheider@sentry.io>
@cursor
Copy link

cursor bot commented Aug 25, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@vercel
Copy link

vercel bot commented Aug 25, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Aug 26, 2025 2:10pm
sentry-docs Ready Ready Preview Comment Aug 26, 2025 2:10pm

@codeowner-assignment codeowner-assignment bot requested a review from a team August 25, 2025 14:07
@philprime philprime marked this pull request as ready for review August 25, 2025 14:08
@philprime philprime requested a review from jas-kas August 25, 2025 14:08
@codecov
Copy link

codecov bot commented Aug 25, 2025

Bundle Report

Changes will decrease total bundle size by 1.15MB (-5.06%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.9MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 11.33MB -1.15MB (-9.21%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/Ne_NimT9ogyGsT_L2V5hc/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/Ne_NimT9ogyGsT_L2V5hc/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/duPpACoAnq_u-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/duPpACoAnq_u-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -33.51kB 1.74MB -1.89%
../instrumentation.js -33.8kB 1.07MB -3.07%
9523.js -33.51kB 1.04MB -3.11%
../app/[[...path]]/page.js.nft.json -349.32kB 415.75kB -45.66%
../app/platform-redirect/page.js.nft.json -349.32kB 415.66kB -45.66%
../app/sitemap.xml/route.js.nft.json -349.32kB 413.13kB -45.82%
7153.js (New) 29.25kB 29.25kB 100.0% 🚀
../app/api/ip-ranges/route.js -300 bytes 5.79kB -4.92%
../app/robots.txt/route.js -300 bytes 5.02kB -5.64%
2311.js (Deleted) -29.86kB 0 bytes -100.0% 🗑️

App Routes Affected:

App Route Size Change Total Size Change (%)
/ -600 bytes 2.62MB -0.02%

@philprime philprime self-assigned this Aug 25, 2025
@philprime philprime changed the title Update session replay docs with AVFoundation limitation feat(apple): Update session replay docs with AVFoundation limitation Aug 25, 2025
@jas-kas
Copy link
Member

jas-kas commented Aug 25, 2025

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/

@philprime
Copy link
Member Author

I agree the JS troubleshooting page makes more sense with a larger list of issues.
We can adopt this for the Apple page too. Do you think we should move the Known Limitations to a different page instead? In that case I would not use the collapsable troubleshooting list yet, because it would only be a single point for each.

@jas-kas
Copy link
Member

jas-kas commented Aug 25, 2025

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
Copy link
Contributor

Copilot AI left a 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 unmaskedViewClasses configuration 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.

@philprime
Copy link
Member Author

@jas-kas I updated it so that it fits the new collapsable list.

@jas-kas
Copy link
Member

jas-kas commented Aug 26, 2025

@philprime looks like latest deploy failed so I can't see the latest Vercel preview with your changes :/

@jas-kas
Copy link
Member

jas-kas commented Aug 26, 2025

ok, the deploy is back. visual changes look good!

@philprime philprime merged commit f964dda into master Aug 26, 2025
13 of 14 checks passed
@philprime philprime deleted the cursor/update-session-replay-docs-with-avfoundation-limitation-785f branch August 26, 2025 14:32
@github-actions github-actions bot locked and limited conversation to collaborators Sep 11, 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.

4 participants