Skip to content

fix(consumer): Don't compare node contents during tree update #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mwcampbell merged 2 commits into from
Oct 9, 2022
Merged

fix(consumer): Don't compare node contents during tree update #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eab70b
fix(consumer): Don't compare node contents during tree update
mwcampbell Oct 9, 2022
c28c2b2
Add a node on performance to the TreeUpdate documentation
mwcampbell Oct 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions common/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1198,6 +1198,12 @@ impl Tree {
/// The sender and receiver must be in sync; the update is only meant
/// to bring the tree from a specific previous state into its next state.
/// Trying to apply it to the wrong tree should immediately panic.
///
/// Note that for performance, an update should only include nodes that are
/// new or changed. AccessKit platform adapters will avoid raising extraneous
/// events for nodes that have not changed since the previous update,
/// but there is still a cost in processing these nodes and replacing
/// the previous instances.
#[derive(Clone, Debug, Default, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
Expand Down
48 changes: 3 additions & 45 deletions consumer/src/tree.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,9 @@ impl State {
orphans.insert(*child_id);
}
}
if *node_state.data != *node_data {
node_state.data = node_data;
if let Some(changes) = &mut changes {
changes.updated_node_ids.insert(node_id);
}
node_state.data = node_data;
if let Some(changes) = &mut changes {
changes.updated_node_ids.insert(node_id);
}
} else if let Some(parent_and_index) = pending_children.remove(&node_id) {
add_node(
Expand Down Expand Up @@ -676,44 +674,4 @@ mod tests {
tree.read().node_by_id(NODE_ID_2).unwrap().name()
);
}

// Verify that if an update consists entirely of node data and tree data
// that's the same as before, no changes are reported. This would be useful
// for a provider that constructs a fresh tree every time, such as
// an immediate-mode GUI.
#[test]
fn no_change_update() {
let update = TreeUpdate {
nodes: vec![
(
NODE_ID_1,
Arc::new(Node {
role: Role::Window,
children: vec![NODE_ID_2, NODE_ID_3],
..Default::default()
}),
),
(
NODE_ID_2,
Arc::new(Node {
role: Role::Button,
..Default::default()
}),
),
(
NODE_ID_3,
Arc::new(Node {
role: Role::Button,
..Default::default()
}),
),
],
tree: Some(Tree::new(NODE_ID_1)),
focus: Some(NODE_ID_2),
};
let tree = super::Tree::new(update.clone(), Box::new(NullActionHandler {}));
tree.update_and_process_changes(update, |_| {
panic!("expected no changes");
});
}
}