Fix BookmarkPermanentNode leak in ChromeBookmarkClient

chrome/browser/bookmarks/chrome_bookmark_client.cc

 // Copyright 2014 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 "chrome/browser/bookmarks/chrome_bookmark_client.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/debug/leak_annotations.h"

[gab, 2014/07/07 18:13:38]

Also, rm this include

[Sigurður Ásgeirsson, 2014/07/07 18:40:19]

Done.

 #include "base/logging.h"
 #include "base/values.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/favicon/favicon_changed_details.h"
 #include "chrome/browser/favicon/favicon_service.h"
 #include "chrome/browser/favicon/favicon_service_factory.h"
 #include "chrome/browser/history/history_service.h"
 #include "chrome/browser/history/history_service_factory.h"
 #include "chrome/browser/policy/profile_policy_connector.h"
 #include "chrome/browser/policy/profile_policy_connector_factory.h"
@@ skipping 138 matching lines @@
 #endif
 }
 
 void ChromeBookmarkClient::RecordAction(const base::UserMetricsAction& action) {
   content::RecordAction(action);
 }
 
 bookmarks::LoadExtraCallback ChromeBookmarkClient::GetLoadExtraNodesCallback() {
   // Create the managed_node now; it will be populated in the LoadExtraNodes
   // callback.
-  managed_node_ = new BookmarkPermanentNode(0);
-  // The ownership of this object is in limbo until the LoadExtraNodes task
-  // runs, but in a ProfileBrowserTest this never happens.
-  // crbug.com/391508
-  ANNOTATE_LEAKING_OBJECT_PTR(managed_node_);
+  // The ownership of maanaged_node_ is in limbo until LoadExtraNodes runs,

[gab, 2014/07/07 18:12:47]

s/maanaged/managed

[Sigurður Ásgeirsson, 2014/07/07 18:40:19]

Done.

+  // so we leave it in the care of the closure meanwhile.
+  scoped_ptr<BookmarkPermanentNode> managed(new BookmarkPermanentNode(0));
+  managed_node_ = managed.get();

[gab, 2014/07/07 18:12:47]

So is the only purpose of storing this as a member for pointer comparison later?
If so, would it make sense to use a void* (or perhaps a new type typedef'ed to
void* for clarity)?

I don't like that there is a fully typed pointer in this class which no one
should ever deref...

[Sigurður Ásgeirsson, 2014/07/07 18:40:19]

The member is used by ChromeBookmarkClient::BookmarkModelLoaded, but I don't
understand the contract, so can't say which thread that'll run on. I can't
naively change this even to a const pointer...

 
   return base::Bind(
       &ChromeBookmarkClient::LoadExtraNodes,
       StartupTaskRunnerServiceFactory::GetForProfile(profile_)
           ->GetBookmarkTaskRunner(),
-      managed_node_,
+      base::Passed(&managed),
       base::Passed(managed_bookmarks_tracker_->GetInitialManagedBookmarks()));
 }
 
 bool ChromeBookmarkClient::CanSetPermanentNodeTitle(
     const BookmarkNode* permanent_node) {
   // The |managed_node_| can have its title updated if the user signs in or
   // out.
   return !IsDescendantOfManagedNode(permanent_node) ||
          permanent_node == managed_node_;
 }
@@ skipping 45 matching lines @@
                                                bool ids_reassigned) {
   // Start tracking the managed bookmarks. This will detect any changes that
   // may have occurred while the initial managed bookmarks were being loaded
   // on the background.
   managed_bookmarks_tracker_->Init(managed_node_);
 }
 
 // static
 bookmarks::BookmarkPermanentNodeList ChromeBookmarkClient::LoadExtraNodes(
     const scoped_refptr<base::DeferredSequencedTaskRunner>& profile_io_runner,
-    BookmarkPermanentNode* managed_node,
+    scoped_ptr<BookmarkPermanentNode> managed_node,
     scoped_ptr<base::ListValue> initial_managed_bookmarks,
     int64* next_node_id) {
   DCHECK(profile_io_runner->RunsTasksOnCurrentThread());
   // Load the initial contents of the |managed_node| now, and assign it an
   // unused ID.
   int64 managed_id = *next_node_id;
   managed_node->set_id(managed_id);
   *next_node_id = policy::ManagedBookmarksTracker::LoadInitial(
-      managed_node, initial_managed_bookmarks.get(), managed_id + 1);
+      managed_node.get(), initial_managed_bookmarks.get(), managed_id + 1);
   managed_node->set_visible(!managed_node->empty());
   managed_node->SetTitle(
       l10n_util::GetStringUTF16(IDS_BOOKMARK_BAR_MANAGED_FOLDER_DEFAULT_NAME));
 
   bookmarks::BookmarkPermanentNodeList extra_nodes;
-  extra_nodes.push_back(managed_node);
+  // Ownership of the managed node passed to the caller.
+  extra_nodes.push_back(managed_node.release());
+
   return extra_nodes.Pass();
 }
 
 std::string ChromeBookmarkClient::GetManagedBookmarksDomain() {
   policy::ProfilePolicyConnector* connector =
       policy::ProfilePolicyConnectorFactory::GetForProfile(profile_);
   if (connector->IsPolicyFromCloudPolicy(policy::key::kManagedBookmarks))
     return connector->GetManagementDomain();
   return std::string();
 }