Allow webdriver users to choose between sending the key events when...

chrome/browser/automation/testing_automation_provider.cc

 // Copyright (c) 2011 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 <string>
 #include <vector>
 
@@ skipping 4637 matching lines @@
   if (modifiers & automation::kControlKeyMask)
     event.modifiers |= WebKit::WebInputEvent::ControlKey;
   if (modifiers & automation::kAltKeyMask)
     event.modifiers |= WebKit::WebInputEvent::AltKey;
   if (modifiers & automation::kMetaKeyMask)
     event.modifiers |= WebKit::WebInputEvent::MetaKey;
 
   event.isSystemKey = is_system_key;
   event.timeStampSeconds = base::Time::Now().ToDoubleT();
   event.skip_in_browser = true;
-  new InputEventAckNotificationObserver(this, reply_message, event.type);
-  browser->GetSelectedTabContents()->render_view_host()->
-    ForwardKeyboardEvent(event);
+  bool use_native_events = false;
+  // If useNativeEvents is true, this funciton will call

[Paweł Hajdan Jr., 2011/03/05 11:55:51]

I'd strongly prefer to standardize on one way we implement this, and not leave
it as an option for the client.

By the way, why are the native events needed at all? I have read the bug, and
why not just send the Chinese/Japanese/Korean chars directly to WebKit? My
understanding is that ChromeDriver was not intended to test IME software...

And of course the native events are really going to be more flaky.

[timothe faudot, 2011/03/07 02:45:26]

I added some justifications in the associated bug
http://code.google.com/p/chromium/issues/detail?id=74899

+  // ui_controls::endKeyPress to the native window handle of the browser,

[Jason Leyba, 2011/03/04 19:25:12]

ui_controls::SendKeyPress

[timothe faudot, 2011/03/07 02:45:26]

Done.

+  // allowing events to be catched higher up; if false it will send an
+  // event directly to webkit.
+  if (args->GetBoolean("useNativeEvents", &use_native_events) &&
+      use_native_events) {
+    // The ui_controls::SendKeyPress function will generate up and down events
+    // from one keycode for us so we only need to send one event to it.
+    // Filtering is done via the RawKeyDown type because it is the one sent by
+    // the current webdriver implementation of WebElement.SendKeys(...).
+    if (event.type == WebKit::WebInputEvent::RawKeyDown) {
+      BrowserWindow* browser_window = browser->window();
+      if (!browser_window) {
+        AutomationJSONReply reply(this, reply_message);
+        reply.SendError("Could not get the browser window");
+        return;
+      }
+      gfx::NativeWindow window = browser_window->GetNativeHandle();
+      if (!window) {
+        AutomationJSONReply reply(this, reply_message);
+        reply.SendError("Could not get the browser window handle");
+        return;
+      }
+      bool control = !!(event.modifiers & WebKit::WebInputEvent::ControlKey);
+      bool shift = !!(event.modifiers & WebKit::WebInputEvent::ShiftKey);
+      bool alt = !!(event.modifiers & WebKit::WebInputEvent::AltKey);
+      bool meta = !!(event.modifiers & WebKit::WebInputEvent::MetaKey);
+      if (!ui_controls::SendKeyPress(
+              window, static_cast<ui::KeyboardCode>(event.nativeKeyCode),
+              control, shift, alt, meta)) {
+        AutomationJSONReply reply(this, reply_message);
+        reply.SendError("Could not send the native key event");
+        return;
+      } else {
+        AutomationJSONReply reply(this, reply_message);
+        reply.SendSuccess(NULL);
+      }
+    } else {
+      // Skip this event by acknowledging it without doing nothing.
+      AutomationJSONReply reply(this, reply_message);
+      reply.SendSuccess(NULL);
+      return;
+    }
+  } else {
+    new InputEventAckNotificationObserver(this, reply_message, event.type);
+    browser->GetSelectedTabContents()->render_view_host()->
+      ForwardKeyboardEvent(event);
+    return;
+  }
 }
 
 // Sample JSON input: { "command": "GetNTPThumbnailMode" }
 // For output, refer to GetNTPThumbnailMode() in
 // chrome/test/pyautolib/pyauto.py.
 void TestingAutomationProvider::GetNTPThumbnailMode(
     Browser* browser,
     DictionaryValue* args,
     IPC::Message* reply_message) {
   const int shown_sections = ShownSectionsHandler::GetShownSections(
@@ skipping 94 matching lines @@
   }
 
   PrefService* prefs = browser->profile()->GetPrefs();
   Section section;
   if (section_name.compare("apps") == 0) {
     section = MENU_APPS;
   } else if (section_name.compare("most_visited") == 0) {
     section = MENU_THUMB;
   } else if (section_name.compare("recently_closed") == 0) {
     section = MENU_RECENT;
-  }
-  else {
+  } else {
     reply.SendError(StringPrintf("Unexpected section name: '%s'",
                                  section_name.c_str()));
     return;
   }
 
   int shown_sections = ShownSectionsHandler::GetShownSections(prefs);
   if (turn_on) {
     // Change the bit for the relevant section in the bitmask to 1.
     shown_sections |= section;
   } else {
@@ skipping 236 matching lines @@
     // If you change this, update Observer for NotificationType::SESSION_END
     // below.
     MessageLoop::current()->PostTask(FROM_HERE,
         NewRunnableMethod(this, &TestingAutomationProvider::OnRemoveProvider));
   }
 }
 
 void TestingAutomationProvider::OnRemoveProvider() {
   AutomationProviderList::GetInstance()->RemoveProvider(this);
 }