Make tree serialization more robust and add more unit tests.

ui/accessibility/ax_tree.cc

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/accessibility/ax_tree.h"
 
 #include <set>
 
+#include "base/logging.h"
+#include "base/strings/stringprintf.h"
 #include "ui/accessibility/ax_node.h"
 
 namespace ui {
 
 AXTree::AXTree()
     : root_(NULL) {
   AXNodeData root;
   root.id = 0;
   root.role = AX_ROLE_ROOT_WEB_AREA;
 
   AXTreeUpdate initial_state;
   initial_state.nodes.push_back(root);
-  Unserialize(initial_state);
+  CHECK(Unserialize(initial_state));

[aboxhall, 2013/12/02 17:18:08]

<< error() ? (and below)

[dmazzoni, 2013/12/03 08:35:04]

Good catch! I thought of that when I added error() but forgot to add it here.

 }
 
 AXTree::AXTree(const AXTreeUpdate& initial_state)
     : root_(NULL) {
-  Unserialize(initial_state);
+  CHECK(Unserialize(initial_state));
 }
 
 AXTree::~AXTree() {
   if (root_)
     DestroyNodeAndSubtree(root_);
 }
 
 AXNode* AXTree::GetRoot() const {
   return root_;
 }
 
 AXNode* AXTree::GetFromId(int32 id) const {
   base::hash_map<int32, AXNode*>::const_iterator iter = id_map_.find(id);
   return iter != id_map_.end() ? (iter->second) : NULL;
 }
 
 bool AXTree::Unserialize(const AXTreeUpdate& update) {
+  std::set<AXNode*> pending_nodes;
+
+  if (update.node_id_to_clear != 0) {
+    AXNode* node = GetFromId(update.node_id_to_clear);
+    if (!node) {
+      error_ = base::StringPrintf("Bad node_id_to_clear: %d",

[aboxhall, 2013/12/02 17:18:08]

Should this be behind an #ifdef DEBUG ?

[dmazzoni, 2013/12/03 08:35:04]

I think these are useful for release mode, and it's not that much code. I'm
hoping these logs will be useful if they ever happen "in the wild"

+                                  update.node_id_to_clear);
+      return false;
+    }
+    if (node == root_) {
+      DestroyNodeAndSubtree(root_);
+      root_ = NULL;
+    } else {
+      for (int i = 0; i < node->child_count(); ++i)
+        DestroyNodeAndSubtree(node->ChildAtIndex(i));
+      std::vector<AXNode*> children;
+      node->SwapChildren(children);
+      pending_nodes.insert(node);
+    }
+  }
+
   for (size_t i = 0; i < update.nodes.size(); ++i) {
-    if (!UpdateNode(update.nodes[i]))
+    if (!UpdateNode(update.nodes[i], &pending_nodes))
       return false;
   }
 
+  if (!pending_nodes.empty()) {
+    error_ = "Nodes left pending by the update:";
+    for (std::set<AXNode*>::iterator iter = pending_nodes.begin();
+         iter != pending_nodes.end(); ++iter) {
+      error_ += base::StringPrintf(" %d", (*iter)->id());
+    }
+    return false;
+  }
+
   return true;
 }
 
 AXNode* AXTree::CreateNode(AXNode* parent, int32 id, int32 index_in_parent) {
   return new AXNode(parent, id, index_in_parent);
 }
 
-bool AXTree::UpdateNode(const AXNodeData& src) {
+bool AXTree::UpdateNode(
+    const AXNodeData& src, std::set<AXNode*>* pending_nodes) {

[aboxhall, 2013/12/02 17:18:08]

This is called orphaned_nodes in the header.

[dmazzoni, 2013/12/03 08:35:04]

Done.

   // This method updates one node in the tree based on serialized data
   // received in an AXTreeUpdate. See AXTreeUpdate for pre and post
   // conditions.
 
   // Look up the node by id. If it's not found, then either the root
   // of the tree is being swapped, or we're out of sync with the source
   // and this is a serious error.
-  AXNode* node = static_cast<AXNode*>(GetFromId(src.id));
-  if (!node) {
-    if (src.role != AX_ROLE_ROOT_WEB_AREA)
+  AXNode* node = GetFromId(src.id);
+  if (node) {
+    pending_nodes->erase(node);
+  } else {
+    if (src.role != AX_ROLE_ROOT_WEB_AREA) {
+      error_ = base::StringPrintf(
+          "%d is not in the tree and not the new root", src.id);
       return false;
+    }
     node = CreateAndInitializeNode(NULL, src.id, 0);
   }
 
   // Set the node's data.
   node->SetData(src);
 
   // First, delete nodes that used to be children of this node but aren't
   // anymore.
   if (!DeleteOldChildren(node, src.child_ids))
     return false;
 
   // Now build a new children vector, reusing nodes when possible,
   // and swap it in.
   std::vector<AXNode*> new_children;
-  bool success = CreateNewChildVector(node, src.child_ids, &new_children);
+  bool success = CreateNewChildVector(
+      node, src.child_ids, &new_children, pending_nodes);
   node->SwapChildren(new_children);
 
   // Update the root of the tree if needed.
   if (src.role == AX_ROLE_ROOT_WEB_AREA &&
       (!root_ || root_->id() != src.id)) {
     if (root_)
       DestroyNodeAndSubtree(root_);
     root_ = node;
     OnRootChanged();
   }
 
   return success;
 }
 
 void AXTree::OnRootChanged() {
 }
 
 AXNode* AXTree::CreateAndInitializeNode(
     AXNode* parent, int32 id, int32 index_in_parent) {
   AXNode* node = CreateNode(parent, id, index_in_parent);
   id_map_[node->id()] = node;
   return node;
 }
 
 void AXTree::DestroyNodeAndSubtree(AXNode* node) {
   id_map_.erase(node->id());
-  for (int i = 0; i < node->child_count(); ++i) {
-    AXNode* child = static_cast<AXNode*>(node->ChildAtIndex(i));
-    child->Destroy();
-  }
+  for (int i = 0; i < node->child_count(); ++i)
+    DestroyNodeAndSubtree(node->ChildAtIndex(i));
   node->Destroy();
 }
 
 bool AXTree::DeleteOldChildren(AXNode* node,
-                                   const std::vector<int32> new_child_ids) {
+                               const std::vector<int32> new_child_ids) {
   // Create a set of child ids in |src| for fast lookup, and return false
   // if a duplicate is found;
   std::set<int32> new_child_id_set;
   for (size_t i = 0; i < new_child_ids.size(); ++i) {
-    if (new_child_id_set.find(new_child_ids[i]) != new_child_id_set.end())
+    if (new_child_id_set.find(new_child_ids[i]) != new_child_id_set.end()) {
+      error_ = base::StringPrintf("Node %d has duplicate child id %d",
+                                  node->id(), new_child_ids[i]);
       return false;
+    }
     new_child_id_set.insert(new_child_ids[i]);
   }
 
   // Delete the old children.
   const std::vector<AXNode*>& old_children = node->children();
   for (size_t i = 0; i < old_children.size(); ++i) {
     int old_id = old_children[i]->id();
     if (new_child_id_set.find(old_id) == new_child_id_set.end())
       DestroyNodeAndSubtree(old_children[i]);
   }
 
   return true;
 }
 
 bool AXTree::CreateNewChildVector(AXNode* node,
-                                      const std::vector<int32> new_child_ids,
-                                      std::vector<AXNode*>* new_children) {
+                                  const std::vector<int32> new_child_ids,
+                                  std::vector<AXNode*>* new_children,
+                                  std::set<AXNode*>* pending_nodes) {
   bool success = true;
   for (size_t i = 0; i < new_child_ids.size(); ++i) {
     int32 child_id = new_child_ids[i];
     int32 index_in_parent = static_cast<int32>(i);
-    AXNode* child = static_cast<AXNode*>(GetFromId(child_id));
+    AXNode* child = GetFromId(child_id);
     if (child) {
       if (child->parent() != node) {
         // This is a serious error - nodes should never be reparented.
         // If this case occurs, continue so this node isn't left in an
         // inconsistent state, but return failure at the end.
+        error_ = base::StringPrintf(
+            "Node %d reparented from %d to %d",
+            child->id(),
+            child->parent() ? child->parent()->id() : 0,
+            node->id());
         success = false;
         continue;
       }
       child->SetIndexInParent(index_in_parent);
     } else {
       child = CreateAndInitializeNode(node, child_id, index_in_parent);
+      pending_nodes->insert(child);
     }
     new_children->push_back(child);
   }
 
   return success;
 }
 
 }  // namespace ui