fix(ui): add traversal depth and result count bounds for UI hierarchy and queries (#126) - #190
Merged
Merged
Conversation
Daliys
force-pushed
the
daliys/issue-126-ui-traversal-limits
branch
from
August 22, 2026 13:29
e28374b to
5d3e43a
Compare
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
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.
Summary
Addresses #126 by adding bounds and truncation indicators to UI Toolkit
VisualElementhierarchy traversal and queries.Problem
UI Toolkit traversal for hierarchy and element query tools (
ui_get_hierarchy,ui_query_elements,ui_capture_window_snapshot) recursively walked fullVisualElementtrees synchronously on the Unity main thread without depth or result count limits, causing visible editor stalls and oversized JSON payloads on complex windows.Changes
SerializeVisualElement: addedmaxDepth(default: 30) andmaxElements(default: 1000) caps. If limits are reached, recursion is halted, the truncated element node is marked withchildren_truncated: true, and the root object is marked withtruncated: true.UIGetHierarchy: accepts optionalmax_depthandmax_elements/max_resultsparameters.UIQueryElements&QueryVisualElementRecursive: accepts optionalmax_depth(default: 30) andmax_results(default: 100). Immediately aborts recursion whenmaxResultsormaxDepthis hit.UICaptureWindowSnapshot: forwardsmax_depthandmax_elementsto hierarchy serialization.routing.py,schemas.py): exposed and forwardedmax_depth,max_elements, andmax_resultsonunity_ui_automation(get_hierarchy,query,capture_window_snapshot).API_REFERENCE.MD,DOCUMENTATION.MD, andCHANGELOG.md.AgentToolingTests.csand Python tests intest_routing.pyandtest_schemas.py.Closes #126