Bring up of the enhanced bookmarks cluster service.

components/enhanced_bookmarks/bookmark_server_cluster_service.h

+// 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.
+#ifndef COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_CLUSTER_SERVICE_H_
+#define COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_CLUSTER_SERVICE_H_
+
+#include <string>
+#include <vector>
+
+#include "base/compiler_specific.h"
+#include "components/enhanced_bookmarks/bookmark_server_service.h"
+#include "components/keyed_service/content/browser_context_keyed_service_factory.h"
+#include "components/signin/core/browser/signin_manager_base.h"
+#include "net/url_request/url_fetcher.h"
+
+class PrefService;
+class BookmarkServerClusterClient;
+
+namespace enhanced_bookmarks {
+
+// Manages requests to the bookmark server to retrieve the current clustering
+// state.

[battre, 2014/09/26 14:33:05]

Add a description of what a cluster and cluster name is?

[noyau (Ping after 24h), 2014/10/01 16:04:43]

Done.

+class BookmarkServerClusterService : public KeyedService,
+                                     public BookmarkServerService,
+                                     public SigninManagerBase::Observer {
+ public:
+  typedef std::map<std::string, std::vector<std::string> > ClusterMap;

[battre, 2014/09/26 14:33:05]

describe key and value?

[noyau (Ping after 24h), 2014/10/01 16:04:44]

Done.

+  BookmarkServerClusterService(
+      const std::string& application_language_code,

[battre, 2014/09/26 14:33:05]

describe parameter? (see above)

[noyau (Ping after 24h), 2014/10/01 16:04:43]

Done.

+      scoped_refptr<net::URLRequestContextGetter> request_context_getter,
+      ProfileOAuth2TokenService* token_service,
+      SigninManagerBase* signin_manager,
+      BookmarkModel* bookmark_model,
+      PrefService* pref_service);
+  virtual ~BookmarkServerClusterService();
+
+  // Retrieves all the bookmarks associated with a cluster.

[battre, 2014/09/26 14:33:05]

Comment on ownership of BookmarkNodes?

[noyau (Ping after 24h), 2014/10/01 16:04:43]

Done.

+  const std::vector<const BookmarkNode*> BookmarksForClusterNamed(
+      const std::string& cluster_name) const;
+
+  // Returns the clusters in which the passed bookmark is in, if any.
+  const std::vector<std::string> ClustersForBookmark(
+      const BookmarkNode* bookmark) const;
+
+  // Dynamically generates a vector of all clusters.
+  const std::vector<std::string> GetClusters() const;
+
+  // Registers server cluster service prefs.
+  static void RegisterPrefs(user_prefs::PrefRegistrySyncable* registry);
+
+ protected:

[battre, 2014/09/26 14:33:05]

// BookmarkServerService methods.

[noyau (Ping after 24h), 2014/10/01 16:04:43]

Done.

+  virtual net::URLFetcher* CreateFetcher() OVERRIDE;
+
+  virtual bool ProcessResponse(const std::string& response,
+                               bool* should_notify) OVERRIDE;
+
+  virtual void CleanAfterFailure() OVERRIDE;
+
+  // BookmarkModelObserver methods.

[battre, 2014/09/26 14:33:05]

I can't find this inheritance.

[noyau (Ping after 24h), 2014/10/01 16:04:44]

Yes, the code changed, and this inheritance disappeared in the superclass.

+  virtual void BookmarkModelLoaded(BookmarkModel* model,
+                                   bool ids_reassigned) OVERRIDE;
+  virtual void BookmarkNodeAdded(BookmarkModel* model,
+                                 const BookmarkNode* parent,
+                                 int index) OVERRIDE;
+  virtual void BookmarkMetaInfoChanged(BookmarkModel* model,
+                                       const BookmarkNode* node) OVERRIDE;
+  virtual void BookmarkAllUserNodesRemoved(
+      BookmarkModel* model,
+      const std::set<GURL>& removed_urls) OVERRIDE;
+
+ private:
+  FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, Cluster);
+  FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, Serialization);
+  FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, SaveToPrefs);
+  FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest, BadAuth);
+  FRIEND_TEST_ALL_PREFIXES(BookmarkServerServiceTest,
+                           ClearClusterMapOnRemoveAllBookmarks);
+
+  // Overriden from SigninManagerBase::Observer.
+  virtual void GoogleSignedOut(const std::string& account_id,
+                               const std::string& username) OVERRIDE;
+
+  // Updates |cluster_data_| and saves the result to profile prefs.
+  // All changes to |cluster_data_| should go through this method to ensure
+  // profile prefs is always up to date.

[battre, 2014/09/26 14:33:05]

What's the cluster_map parameter?

[noyau (Ping after 24h), 2014/10/01 16:04:44]

Done.

+  // TODO(noyau): This is probably a misuse of profile prefs. While the expected
+  // amount of data is small (<1kb), it can theoretically reach megabytes in
+  // size.
+  void UpdateModel(ClusterMap* cluster_map);
+  // Updates |cluster_data_| from profile prefs.
+  void LoadModel();
+
+  // The result is swapped into |out_result|.
+  static void Serialize(const ClusterMap& cluster_map,
+                        std::string* out_result,
+                        const std::string& auth_id);

[battre, 2014/09/26 14:33:05]

make the output parameter the last one? (same for Deserialize)

what's auth_id?

[noyau (Ping after 24h), 2014/10/01 16:04:43]

Done.

+  // Returns true on success.
+  // The result is swapped into |out_map|.
+  // |auth_id| must match the serialized auth_id for this method to succeed.
+  static bool Deserialize(const std::string& input,
+                          ClusterMap* out_map,
+                          const std::string& auth_id);
+
+  // The ISO 639-1 code of the language used by the application.
+  const std::string application_language_code_;
+  // The preferences services associated with the relevant profile.
+  PrefService* pref_service_;
+  // The cluster data, a map from cluster name to a vector of starsid.
+  ClusterMap cluster_data_;
+
+  DISALLOW_COPY_AND_ASSIGN(BookmarkServerClusterService);
+};
+}  // namespace enhanced_bookmarks
+
+#endif  // COMPONENTS_ENHANCED_BOOKMARKS_BOOKMARK_SERVER_CLUSTER_SERVICE_H_