Implementation of AutomationEventQueue and associated framework to support generic non-blocking aut…

chrome/browser/automation/testing_automation_provider.cc

 // Copyright (c) 2012 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/automation/testing_automation_provider.h"
 
 #include <map>
 #include <set>
 #include <string>
 #include <vector>
@@ skipping 2298 matching lines @@
   handler_map["NavigateToURL"] =
       &TestingAutomationProvider::NavigateToURL;
   handler_map["GetLocalStatePrefsInfo"] =
       &TestingAutomationProvider::GetLocalStatePrefsInfo;
   handler_map["SetLocalStatePrefs"] =
       &TestingAutomationProvider::SetLocalStatePrefs;
   handler_map["GetPrefsInfo"] = &TestingAutomationProvider::GetPrefsInfo;
   handler_map["SetPrefs"] = &TestingAutomationProvider::SetPrefs;
   handler_map["ExecuteJavascript"] =
       &TestingAutomationProvider::ExecuteJavascriptJSON;
+  handler_map["AddDomRaisedEventObserver"] =
+      &TestingAutomationProvider::AddDomRaisedEventObserver;
+  handler_map["RemoveEventObserver"] =
+      &TestingAutomationProvider::RemoveEventObserver;
+  handler_map["GetQueuedEvent"] =
+      &TestingAutomationProvider::GetQueuedEvent;
+  handler_map["ClearQueuedEvents"] =
+      &TestingAutomationProvider::ClearQueuedEvents;
+  handler_map["ClearEventObservers"] =
+      &TestingAutomationProvider::ClearEventObservers;
   handler_map["ExecuteJavascriptInRenderView"] =
       &TestingAutomationProvider::ExecuteJavascriptInRenderView;
   handler_map["GoForward"] =
       &TestingAutomationProvider::GoForward;
   handler_map["GoBack"] =
       &TestingAutomationProvider::GoBack;
   handler_map["Reload"] =
       &TestingAutomationProvider::ReloadJSON;
   handler_map["CaptureEntirePage"] =
       &TestingAutomationProvider::CaptureEntirePageJSON;
@@ skipping 4107 matching lines @@
     AutomationJSONReply(this, reply_message).SendError(
             "A RenderViewHost object was not found with the given view ID.");
     return;
   }
 
   new DomOperationMessageSender(this, reply_message, true);
   ExecuteJavascriptInRenderViewFrame(frame_xpath, javascript, reply_message,
                                      rvh);
 }
 
+void TestingAutomationProvider::AddDomRaisedEventObserver(
+    DictionaryValue* args,
+    IPC::Message* reply_message) {
+  if (SendErrorIfModalDialogActive(this, reply_message))
+    return;
+

[Nirnimesh, 2012/02/28 09:13:09]

Create an instance of AutomationJSONReply

[craigdh, 2012/02/28 22:42:56]

Done.

+  std::string event_name;
+  if (!args->GetString("event_name", &event_name)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'event_name' missing or invalid");

[Nirnimesh, 2012/02/28 09:13:09]

then use it here

[craigdh, 2012/02/28 22:42:56]

Done.

+    return;
+  }
+
+  DomRaisedEventObserver* jsobserver =
+      new DomRaisedEventObserver(automation_event_queue_, event_name);

[Nirnimesh, 2012/02/28 09:13:09]

Since automation_event_queue_ owns the new observer, to make the ownership
clearer, this should probably be like:

automation_event_queue->AddEventObserver(new DomRaisedEventObserver(...))

Then it'd match line 6485 as well

[craigdh, 2012/02/28 22:42:56]

Done.

+  scoped_ptr<DictionaryValue> return_value(new DictionaryValue);
+  return_value->SetInteger("observer_id", jsobserver->GetId());
+  AutomationJSONReply(this, reply_message).SendSuccess(return_value.get());

[Nirnimesh, 2012/02/28 09:13:09]

and here

[craigdh, 2012/02/28 22:42:56]

Done.

+}
+
+void TestingAutomationProvider::RemoveEventObserver(
+    DictionaryValue* args,
+    IPC::Message* reply_message) {
+  int observer_id;

[Nirnimesh, 2012/02/28 09:13:09]

create AutomationJSONReply once, the use it in line 6482 & 6486

[craigdh, 2012/02/28 22:42:56]

Done.

+  if (!args->GetInteger("observer_id", &observer_id)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'observer_id' missing or invalid");
+    return;
+  }
+  automation_event_queue_.RemoveObserver(observer_id);
+  AutomationJSONReply(this, reply_message).SendSuccess(NULL);
+}
+
+void TestingAutomationProvider::ClearQueuedEvents(
+    DictionaryValue* args,
+    IPC::Message* reply_message) {
+  automation_event_queue_.Clear();

[Nirnimesh, 2012/02/28 09:13:09]

Does this really free up the observers?

[craigdh, 2012/02/28 22:42:56]

I've now merged ClearEventObservers() into Clear() to simplify the API.

+  AutomationJSONReply(this, reply_message).SendSuccess(NULL);
+}
+
+void TestingAutomationProvider::ClearEventObservers(

[Nirnimesh, 2012/02/28 09:13:09]

As a user, I don't understand how this differs from the previous method

[craigdh, 2012/02/28 22:42:56]

See previous.

+    DictionaryValue* args,
+    IPC::Message* reply_message) {
+  automation_event_queue_.ClearObservers();
+  AutomationJSONReply(this, reply_message).SendSuccess(NULL);
+}
+
+void TestingAutomationProvider::GetQueuedEvent(

[Nirnimesh, 2012/02/28 09:13:09]

rename to: GetNextEvent?

[craigdh, 2012/02/28 22:42:56]

Done.

+    DictionaryValue* args,
+    IPC::Message* reply_message) {
+  int observer_id;
+  bool blocking;

[Nirnimesh, 2012/02/28 09:13:09]

define AutomationJSONReply here and use it below

[craigdh, 2012/02/28 22:42:56]

Done.

+  if (!args->GetInteger("observer_id", &observer_id)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'observer_id' missing or invalid");
+    return;
+  }
+  if (!args->GetBoolean("blocking", &blocking)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'blocking' missing or invalid");
+    return;
+  }
+
+  automation_event_queue_.GetEvent(this, reply_message, observer_id, blocking);

[Nirnimesh, 2012/02/28 09:13:09]

does this respond back to the client?
Why not fetch the data and return it from here?

[craigdh, 2012/02/28 22:42:56]

Because if there is no matching event in the queue then this function will
return without sending an automation reply and the AutomationEventQueue will
take ownership of the AutomationJSONReply and respond once a matching event is
added. It's similar to the observers in automation_provider_observers.h/cc.

+}
+
 void TestingAutomationProvider::GoForward(
     DictionaryValue* args,
     IPC::Message* reply_message) {
   if (SendErrorIfModalDialogActive(this, reply_message))
     return;
 
   WebContents* web_contents;
   std::string error;
   if (!GetTabFromJSONArgs(args, &web_contents, &error)) {
     AutomationJSONReply(this, reply_message).SendError(error);
@@ skipping 517 matching lines @@
 
   Send(reply_message_);
   redirect_query_ = 0;
   reply_message_ = NULL;
 }
 
 void TestingAutomationProvider::OnRemoveProvider() {
   if (g_browser_process)
     g_browser_process->GetAutomationProviderList()->RemoveProvider(this);
 }