ref(apple): add notes on SwiftUI limitations#18352
Open
philprime wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+29
to
+31
| View hierarchy support for SwiftUI is highly limited, due to the SwiftUI rendering engine not backing every view with a UIKit view anymore. | ||
|
|
||
| For example, `Text` views may be rendered directly into a graphics render surface rather than creating a corresponding `UILabel`. This is an operating system limitation, not a limitation of the Sentry SDK. As a result, the captured view hierarchy may not fully represent the SwiftUI view tree. |
Contributor
There was a problem hiding this comment.
Bug: The documentation change to "highly limited" support for SwiftUI view hierarchies is misleading if the feature is completely unsupported, setting incorrect user expectations.
Severity: LOW
Suggested Fix
Revert the documentation to state that view hierarchies are "not supported for SwiftUI" to accurately reflect the feature's capability. If there is some partial support, the documentation should be more specific about what is and isn't captured, rather than using ambiguous terms like "highly limited".
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/platforms/apple/common/enriching-events/viewhierarchy/index.mdx#L29-L31
Potential issue: The documentation in `index.mdx` is being updated from stating that
view hierarchies are "not supported for SwiftUI" to being "highly limited". This new
wording, particularly the phrase "the captured view hierarchy may not fully represent
the SwiftUI view tree," implies that some view hierarchy data is captured for SwiftUI
applications. However, evidence suggests the feature is completely unsupported for
SwiftUI. This discrepancy can mislead users into expecting partial functionality from
the `attachViewHierarchy` option, leading to confusion when no view hierarchy data is
actually captured.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Clarifies that the SwiftUI-related limitations are not caused by the SDK, but by the operating system not offering data to us.
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: