feat: add infobox for elements at snapshotMaxDepth #1596
Conversation
github-actions
bot
added
enhancement
| @@ -133,6 +133,7 @@ | |||
| "contextDropdownInfo": "Multiple contexts detected; certain elements might only be accessible after switching to a different context. Note that webview inspection in Appium Inspector is less accurate than the DevTools of Chrome or Safari. For more information, see:", | |||
| "idAutocompletionCanBeDisabled": "The requested id selector does not have a package name prefix. This Appium session has package name autocompletion enabled, which may be the reason why no elements were found. To disable this behavior, relaunch this session with the capability 'appium:disableIdLocatorAutocompletion' set to 'true'.", | |||
| "missingAutomationNameForStrategies": "Additional locator strategies may be available. To view them, add the capability 'appium:automationName' when launching the session. Note that this capability is mandatory in Appium 2.", | |||
| "snapshotMaxDepthReached": "This element is located at the maximum source depth {{selectedElementDepth}}, therefore its child elements (if any) are not shown. To reveal them, change the 'snapshotMaxDepth' setting to a value higher than {{selectedElementDepth}}. Check your driver documentation for the maximum supported value.", | |||
There was a problem hiding this comment.
should we explicitly mention the maximum supported value is 62?
There was a problem hiding this comment.
perhaps greater than?
There was a problem hiding this comment.
The maximum value of 62 refers only to the XCUITest driver, but for UiAutomator2 it seems to be 500.
There was a problem hiding this comment.
I assume it would still be hard for users to find this value in docs themselves
There was a problem hiding this comment.
for UIA2 the value does not really have an upper limit. I don't know exactly at which value the tree reader starts to freak out
There was a problem hiding this comment.
I agree that the value may not be easy to find in the XCUITest docs (I'm not sure if it even is there), but I would still say it's better to not refer to any specific drivers in this message for future extensibility.
This PR adds a new infobox when selecting an element located at
snapshotMaxDepth. It helps users understand that some elements may be hidden, explains the reason why they are hidden, and provides a way to expose them.The hope is that this infobox will also provide additional help for users testing React Native apps on iOS, since such apps are known to have issues with high element depth.