feat: Refactor snapshotting mechanism #970

mykola-mokhnach · 2025-01-14T16:51:17Z

BREAKING CHANGE: snapshotTimeout and customSnapshotTimeout settings have been removed as a result of the custom snapshotting logic removal

Snapshotting is complicated. And requires lots of time.
This PR tries to optimize snapshots by performing the following optimizations:

Reduce the amount of snapshotting calls. We do not invoke element snapshots every time it is fetched from the cache, but instead only when it's necessary to either fetch element properties or verify if it is stalled.
Only fetch required element attributes where needed in snapshots without fetching the whole hierarchy or custom attributes. Basically we use the below 2 main snapshotting methods interchangeably:
- fb_takeSnapshot:NO -> the fastest one, - fetches only standard attributes without tree structure
- fb_takeSnapshot:YES -> the slower one, - fetches standard attributes plus the tree structure
Custom visibility and accessibility attributes are now fetched dynamically using a customized timeout value.

KazuCocoa

lgtm in my best knowledge...
I like this simplification. Hopefully, the fb_isVisible's removals will work well

WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.m

WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m

…o native_snap

WebDriverAgentLib/Utilities/FBXCAXClientProxy.m

WebDriverAgentLib/Categories/XCUIElement+FBIsVisible.m

KazuCocoa · 2025-01-16T07:55:20Z

Just to leave a finding:

I saw a missing value attribute case in the XML source for Settings app on a simulator. This was one line only, while other elements properly had value attributes. Should not be an issue with this PR change.

Current master

<XCUIElementTypeSearchField type="XCUIElementTypeSearchField" value="Search" name="Search" label="Search" enabled="true" visible="true" accessible="true" x="20" y="150" width="390" height="37" index="2">

With this PR

<XCUIElementTypeSearchField type="XCUIElementTypeSearchField" name="Search" label="Search" enabled="true" visible="true" accessible="true" x="20" y="150" width="390" height="37" index="2">

mykola-mokhnach · 2025-01-16T08:01:57Z

Just to leave a finding:

I saw a missing value attribute case in the XML source for Settings app on a simulator. This was one line only, while other elements properly had value attributes. Should not be an issue with this PR change.

Current master
<XCUIElementTypeSearchField type="XCUIElementTypeSearchField" value="Search" name="Search" label="Search" enabled="true" visible="true" accessible="true" x="20" y="150" width="390" height="37" index="2">
With this PR
<XCUIElementTypeSearchField type="XCUIElementTypeSearchField" name="Search" label="Search" enabled="true" visible="true" accessible="true" x="20" y="150" width="390" height="37" index="2">

I did not change any logic for the value fetching. Nevertheless added this field type to the list of placeholder owners to align these behaviours

KazuCocoa

yea, i know of. That was interesting.

lgtm

KazuCocoa · 2025-01-16T09:16:17Z

WebDriverAgentLib/Categories/XCUIElement+FBAccessibility.m

@@ -42,11 +42,11 @@ - (BOOL)fb_isAccessibilityElement
  if (nil != attributeValue) {
    NSMutableDictionary *updatedValue = [NSMutableDictionary dictionaryWithDictionary:self.additionalAttributes ?: @{}];
    [updatedValue setObject:attributeValue forKey:FB_XCAXAIsElementAttribute];
-    self.additionalAttributes = updatedValue.copy;
+    self.snapshot.additionalAttributes = updatedValue.copy;


then, others also need to be self.snapshot.additionalAttributes in here and visible?

not really due to

WebDriverAgent/WebDriverAgentLib/Routing/FBXCElementSnapshotWrapper.m

Line 103 in eca2ed1

- (id)forwardingTargetForSelector:(SEL)aSelector

magic

## [9.0.0](v8.12.2...v9.0.0) (2025-01-16) ### ⚠ BREAKING CHANGES * snapshotTimeout and customSnapshotTimeout settings have been removed as a result of the custom snapshotting logic removal ### Features * Refactor snapshotting mechanism ([#970](#970)) ([08f1306](08f1306))

github-actions · 2025-01-16T16:47:59Z

🎉 This PR is included in version 9.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

mykola-mokhnach added 2 commits January 14, 2025 14:36

feat: Exclude the tree hierarchy from snapshots that don't need it

b263b02

Optimize

5921b53

mykola-mokhnach requested a review from KazuCocoa January 14, 2025 16:51

mykola-mokhnach added 2 commits January 14, 2025 18:24

Bump fastlane

069c030

lock ruby to 3.3

66f471d

KazuCocoa approved these changes Jan 15, 2025

View reviewed changes

WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.m Show resolved Hide resolved

WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m Show resolved Hide resolved

Remove custom stuff for good

a36c190

mykola-mokhnach changed the title ~~feat: Refactor snapshotting mechnism~~ feat: Refactor snapshotting mechanism Jan 15, 2025

mykola-mokhnach added 2 commits January 15, 2025 21:38

Merge branch 'master' of https://github.com/appium/WebDriverAgent int…

61f8ed3

…o native_snap

remove settings

635f387

KazuCocoa reviewed Jan 16, 2025

View reviewed changes

WebDriverAgentLib/Utilities/FBXCAXClientProxy.m Outdated Show resolved Hide resolved

WebDriverAgentLib/Categories/XCUIElement+FBIsVisible.m Show resolved Hide resolved

Address comments

4265ccb

Tune value

96fc6b8

KazuCocoa approved these changes Jan 16, 2025

View reviewed changes

moar

e957b5f

KazuCocoa reviewed Jan 16, 2025

View reviewed changes

moar

045ddb1

mykola-mokhnach merged commit 08f1306 into master Jan 16, 2025
42 of 46 checks passed

mykola-mokhnach deleted the native_snap branch January 16, 2025 16:44

github-actions bot added the released label Jan 16, 2025

KazuCocoa mentioned this pull request Jan 17, 2025

feat: Bump WDA to v9 appium/appium-xcuitest-driver#2511

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Refactor snapshotting mechanism #970

feat: Refactor snapshotting mechanism #970

mykola-mokhnach commented Jan 14, 2025 •

edited

Loading

KazuCocoa left a comment

KazuCocoa commented Jan 16, 2025

mykola-mokhnach commented Jan 16, 2025 •

edited

Loading

KazuCocoa left a comment

KazuCocoa Jan 16, 2025 •

edited

Loading

mykola-mokhnach Jan 16, 2025

github-actions bot commented Jan 16, 2025

feat: Refactor snapshotting mechanism #970

feat: Refactor snapshotting mechanism #970

Conversation

mykola-mokhnach commented Jan 14, 2025 • edited Loading

KazuCocoa left a comment

Choose a reason for hiding this comment

KazuCocoa commented Jan 16, 2025

mykola-mokhnach commented Jan 16, 2025 • edited Loading

KazuCocoa left a comment

Choose a reason for hiding this comment

KazuCocoa Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

mykola-mokhnach Jan 16, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 16, 2025

mykola-mokhnach commented Jan 14, 2025 •

edited

Loading

mykola-mokhnach commented Jan 16, 2025 •

edited

Loading

KazuCocoa Jan 16, 2025 •

edited

Loading