Move towards event-driven JS on about:sync

chrome/browser/ui/webui/sync_internals_message_handler.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/ui/webui/sync_internals_message_handler.h"
 
 #include <vector>
 
 #include "base/logging.h"
 #include "chrome/browser/profiles/profile.h"
@@ skipping 16 matching lines @@
     : weak_ptr_factory_(this) {}
 
 SyncInternalsMessageHandler::~SyncInternalsMessageHandler() {
   if (js_controller_)
     js_controller_->RemoveJsEventHandler(this);
 }
 
 void SyncInternalsMessageHandler::RegisterMessages() {
   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
 
+  // Register for ProfileSyncService events.
+  ProfileSyncService* service = GetProfileSyncService();
+  if (service)
+    service->AddObserver(this);
+
   // Init our link to the JsController.
-  ProfileSyncService* service = GetProfileSyncService();
   if (service)
     js_controller_ = service->GetJsController();
   if (js_controller_)
     js_controller_->AddJsEventHandler(this);
 
   web_ui()->RegisterMessageCallback(
-      "getAboutInfo",
-      base::Bind(&SyncInternalsMessageHandler::OnGetAboutInfo,
+      "requestUpdatedAboutInfo",
+      base::Bind(&SyncInternalsMessageHandler::OnRequestUpdatedAboutInfo,
                  base::Unretained(this)));
 
   web_ui()->RegisterMessageCallback(
-      "getListOfTypes",
-      base::Bind(&SyncInternalsMessageHandler::OnGetListOfTypes,
+      "requestListOfTypes",
+      base::Bind(&SyncInternalsMessageHandler::OnRequestListOfTypes,
                  base::Unretained(this)));
 
   RegisterJsControllerCallback("getNotificationState");
   RegisterJsControllerCallback("getNotificationInfo");
   RegisterJsControllerCallback("getAllNodes");
   RegisterJsControllerCallback("getClientServerTraffic");
 }
 
-void SyncInternalsMessageHandler::OnGetAboutInfo(const base::ListValue* args) {
-  // TODO(rlarocque): We should DCHECK(!args) here.  See crbug.com/334431.
-  scoped_ptr<base::DictionaryValue> value =
-      sync_ui_util::ConstructAboutInformation(GetProfileSyncService());
-  web_ui()->CallJavascriptFunction(
-      "chrome.sync.getAboutInfo.handleReply",
-      *value);
+void SyncInternalsMessageHandler::OnRequestUpdatedAboutInfo(
+    const base::ListValue* args) {
+  DCHECK(args->empty());

[Dan Beam, 2014/02/13 22:32:45]

nit: doesn't seem necessary ^

[rlarocque, 2014/02/13 23:34:30]

Function calls without argument checking scare me.  If someone is misusing this
API, I'd like them to know about it.

+  SendAboutInfo();
 }
 
-void SyncInternalsMessageHandler::OnGetListOfTypes(
+void SyncInternalsMessageHandler::OnRequestListOfTypes(
     const base::ListValue* args) {
-  // TODO(rlarocque): We should DCHECK(!args) here.  See crbug.com/334431.
-  base::ListValue type_list;
+  DCHECK(args->empty());

[Dan Beam, 2014/02/13 22:32:45]

^ same

+  base::DictionaryValue event_details;
+  scoped_ptr<base::ListValue> type_list(new base::ListValue());
   ModelTypeSet protocol_types = syncer::ProtocolTypes();
   for (ModelTypeSet::Iterator it = protocol_types.First();
        it.Good(); it.Inc()) {
-    type_list.Append(new base::StringValue(ModelTypeToString(it.Get())));
+    type_list->Append(new base::StringValue(ModelTypeToString(it.Get())));
   }
+  event_details.Set("types", type_list.release());
   web_ui()->CallJavascriptFunction(
-      "chrome.sync.getListOfTypes.handleReply",
-      type_list);
+      "chrome.sync.dispatchEvent",
+      base::StringValue("onReceivedListOfTypes"),
+      event_details);
 }
 
 void SyncInternalsMessageHandler::HandleJsReply(
     const std::string& name, const JsArgList& args) {
   DVLOG(1) << "Handling reply for " << name << " message"
            << " with args " << args.ToString();
   const std::string& reply_handler = "chrome.sync." + name + ".handleReply";
   std::vector<const base::Value*> arg_list(args.Get().begin(),
                                            args.Get().end());
   web_ui()->CallJavascriptFunction(reply_handler, arg_list);
 }
 
+void SyncInternalsMessageHandler::OnStateChanged() {
+  SendAboutInfo();
+}
+
 void SyncInternalsMessageHandler::HandleJsEvent(
     const std::string& name,
     const JsEventDetails& details) {
   DVLOG(1) << "Handling event: " << name
            << " with details " << details.ToString();
   web_ui()->CallJavascriptFunction("chrome.sync.dispatchEvent",
                                    base::StringValue(name),
                                    details.Get());
 }
 
 void SyncInternalsMessageHandler::RegisterJsControllerCallback(
     const std::string& name) {
   web_ui()->RegisterMessageCallback(
       name,
       base::Bind(&SyncInternalsMessageHandler::ForwardToJsController,
                  base::Unretained(this),
                  name));
 }
 
+void SyncInternalsMessageHandler::SendAboutInfo() {
+  scoped_ptr<base::DictionaryValue> value =
+      sync_ui_util::ConstructAboutInformation(GetProfileSyncService());
+  web_ui()->CallJavascriptFunction(
+      "chrome.sync.dispatchEvent",
+      base::StringValue("onAboutInfoUpdated"),
+      *value);
+}
+
 void SyncInternalsMessageHandler::ForwardToJsController(
     const std::string& name,
     const base::ListValue* args) {
   if (js_controller_) {
     scoped_ptr<base::ListValue> args_copy(args->DeepCopy());
     JsArgList js_arg_list(args_copy.get());
     js_controller_->ProcessJsMessage(
         name, js_arg_list,
         MakeWeakHandle(weak_ptr_factory_.GetWeakPtr()));
   } else {
     DLOG(WARNING) << "No sync service; dropping message " << name;
   }
 }
 
 // Gets the ProfileSyncService of the underlying original profile.
 // May return NULL (e.g., if sync is disabled on the command line).
 ProfileSyncService* SyncInternalsMessageHandler::GetProfileSyncService() {
   Profile* profile = Profile::FromWebUI(web_ui());
   ProfileSyncServiceFactory* factory = ProfileSyncServiceFactory::GetInstance();
   return factory->GetForProfile(profile->GetOriginalProfile());
 }