feat: add placeholderValue to page source tree #1016
Conversation
| @@ -216,13 +217,18 @@ + (NSDictionary *)dictionaryForElement:(id<FBXCElementSnapshot>)snapshot | |||
| }, | |||
| FBExclusionAttributeFocused: ^{ | |||
| return [@([wrappedSnapshot isWDFocused]) stringValue]; | |||
| }, | |||
| FBExclusionAttributePlaceholderValue: ^{ | |||
| return FBValueOrNull(wrappedSnapshot.wdPlaceholderValue); | |||
There was a problem hiding this comment.
I'm not sure if it makes sense to have nulls everywhere as this attribute only makes sense for a limited range of elements
There was a problem hiding this comment.
I'm not sure if it makes sense to have nulls everywhere as this attribute only makes sense for a limited range of elements
Thanks for the feedback — you're absolutely right that placeholderValue only applies to a limited set of elements.
I've updated the implementation to include it only for relevant types (TextField, SecureTextField, SearchField) and excluded it entirely from the output for all others.
This ensures the /source response stays clean and focused, without unnecessary null values. Let me know if you'd prefer a different approach!
| @@ -201,7 +202,8 @@ + (NSDictionary *)dictionaryForElement:(id<FBXCElementSnapshot>)snapshot | |||
| info[@"label"] = FBValueOrNull(wrappedSnapshot.wdLabel); | |||
| info[@"rect"] = wrappedSnapshot.wdRect; | |||
|
|
|||
| NSDictionary<NSString *, NSString * (^)(void)> *attributeBlocks = @{ | |||
| // Define the base attribute blocks that apply to all elements. | |||
| NSDictionary<NSString *, NSString * (^)(void)> *baseAttributeBlocks = @{ | |||
There was a problem hiding this comment.
I think it makes sense to extract this logic into a separate method for better readability.
Also this dictionary should be defined as mutable to reduce the amount of boilerplate code
|
|
||
| // Add placeholderValue only for elements where it is meaningful (e.g., text input fields). | ||
| switch (snapshot.elementType) { | ||
| case XCUIElementTypeTextField: |
There was a problem hiding this comment.
consider reusing this helper for detecting whether a particular element is a text field:
There was a problem hiding this comment.
@mykola-mokhnach I initially tried to use fb_supportsInnerText as suggested, but it's only available on XCUIElement, while here we work exclusively with FBXCElementSnapshotWrapper.
Rather than casting or duplicating the logic inline, I added a minimal helper fb_supportsPlaceholder to the existing FBXCElementSnapshotWrapper+Helpers category.
This keeps everything localized, avoids unnecessary switching, and makes it easier to extend later.
There was a problem hiding this comment.
Would exposing fb_supportsInnerText from XCUIElement+FBWebDriverAttributes.h help to refer to it?
There was a problem hiding this comment.
I've extracted this helper in the other PR. Please rebase with master to be able to use it
Moved the logic for constructing attribute blocks into a separate method for clarity and future extensibility. Also replaced direct type checks with a reusable fb_supportsPlaceholder helper on FBXCElementSnapshotWrapper.
| @@ -248,6 +237,41 @@ + (NSDictionary *)dictionaryForElement:(id<FBXCElementSnapshot>)snapshot | |||
| return info; | |||
| } | |||
|
|
|||
| // Private helper that builds all attribute blocks for a given snapshot. | |||
| // Includes both base attributes and any element-specific ones (e.g. placeholder for text inputs, etc.). | |||
| + (NSMutableDictionary<NSString *, NSString *(^)(void)> *)attributeBlockMapForSnapshot:(id<FBXCElementSnapshot>)snapshot | |||
There was a problem hiding this comment.
The returned dictionary must be immutable
There was a problem hiding this comment.
method names must always start with fb_ in extension classes
| @@ -248,6 +237,41 @@ + (NSDictionary *)dictionaryForElement:(id<FBXCElementSnapshot>)snapshot | |||
| return info; | |||
| } | |||
|
|
|||
| // Private helper that builds all attribute blocks for a given snapshot. | |||
There was a problem hiding this comment.
consider moving the helper closer to the tail of the class definition if it is private
Summary
This PR adds support for the placeholderValue attribute to be included in the response from the
/source(getPageSource) endpoint.Motivation
Previously,
placeholderValuewas only available when requesting attributes for a specific element. However, this attribute is also valuable when analyzing the full accessibility tree returned by/source, particularly for identifying input fields and verifying placeholder text during automated accessibility testing.By including
placeholderValuein the full snapshot, we enable better support for end-to-end validations and tools that rely on the complete accessibility hierarchy.