Browser Plugin: New Implementation (Renderer Side)

content/renderer/browser_plugin/browser_plugin_browsertest.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 "content/renderer/browser_plugin/browser_plugin_browsertest.h"
+
+#include "base/file_path.h"
+#include "base/file_util.h"
+#include "base/path_service.h"
+#include "content/common/browser_plugin_messages.h"
+#include "content/public/common/content_constants.h"
+#include "content/renderer/browser_plugin/browser_plugin.h"
+#include "content/renderer/browser_plugin/mock_browser_plugin.h"
+#include "content/renderer/browser_plugin/mock_browser_plugin_manager.h"
+#include "content/renderer/render_thread_impl.h"
+#include "content/renderer/renderer_webkitplatformsupport_impl.h"
+#include "content/shell/shell_main_delegate.h"
+#include "skia/ext/platform_canvas.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebCursorInfo.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebInputEvent.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebScriptSource.h"
+
+namespace {
+const char kHTMLForBrowserPluginObject[] =
+  "<object id='browserplugin' width='640px' height='480px'"
+  "  src='foo' type='%s'>";
+
+std::string GetHTMLForBrowserPluginObject() {
+  return StringPrintf(kHTMLForBrowserPluginObject,
+                      content::kBrowserPluginNewMimeType);
+}
+
+}
+
+namespace content {
+
+BrowserPluginTest::BrowserPluginTest() {}
+
+BrowserPluginTest::~BrowserPluginTest() {}
+
+void BrowserPluginTest::SetUp() {
+  GetContentClient()->set_renderer_for_testing(&content_renderer_client_);
+  content::RenderViewTest::SetUp();
+  browser_plugin_manager_.reset(new MockBrowserPluginManager());
+  content::ShellMainDelegate::InitializeResourceBundle();
+}
+
+void BrowserPluginTest::TearDown() {
+  browser_plugin_manager_->Cleanup();
+  content::RenderViewTest::TearDown();
+}
+
+std::string BrowserPluginTest::ExecuteScriptAndReturnString(
+    const std::string& script) {
+  v8::Handle<v8::Value>  value = GetMainFrame()->executeScriptAndReturnValue(
+      WebKit::WebScriptSource(WebKit::WebString::fromUTF8(script.c_str())));
+  if (value.IsEmpty() || !value->IsString())
+    return std::string();
+
+  v8::Local<v8::String> v8_str = value->ToString();
+  int length = v8_str->Utf8Length() + 1;
+  scoped_array<char> str(new char[length]);
+  v8_str->WriteUtf8(str.get(), length);
+  return str.get();
+}
+
+// This test verifies that an initial resize occurs when we instantiate the
+// browser plugin. This test also verifies that the browser plugin is waiting
+// for a BrowserPluginMsg_UpdateRect in response. We issue an UpdateRect, and
+// we observe an UpdateRect_ACK, with the resize_pending_ reset, indiciating
+// that the BrowserPlugin is not waiting for any more UpdateRects to
+// satisfy its resize request.
+TEST_F(BrowserPluginTest, InitialResize) {
+  LoadHTML(GetHTMLForBrowserPluginObject().c_str());
+  // Verify that the information based on ResizeGuest is correct, and
+  // use its TransportDIB::Id to paint.
+  const IPC::Message* msg =
+      browser_plugin_manager()->sink().GetUniqueMessageMatching(
+          BrowserPluginHostMsg_ResizeGuest::ID);
+  ASSERT_TRUE(msg);
+  PickleIterator iter = IPC::SyncMessage::GetDataIterator(msg);
+  BrowserPluginHostMsg_ResizeGuest::SendParam  resize_params;
+  ASSERT_TRUE(IPC::ReadParam(msg, &iter, &resize_params));
+  int instance_id = resize_params.a;
+  BrowserPluginHostMsg_ResizeGuest_Params params(resize_params.b);
+  EXPECT_EQ(640, params.width);
+  EXPECT_EQ(480, params.height);
+  // Verify that the browser plugin wasn't already waiting on a resize when this
+  // resize happened.
+  EXPECT_EQ(false, params.resize_pending);
+
+  MockBrowserPlugin* browser_plugin =
+      static_cast<MockBrowserPlugin*>(
+          browser_plugin_manager()->GetBrowserPlugin(instance_id));
+  ASSERT_TRUE(browser_plugin);
+  // Now the browser plugin is expecting a UpdateRect resize.
+  EXPECT_TRUE(browser_plugin->resize_pending_);
+
+  // Send the BrowserPlugin an UpdateRect equal to its container size.
+  // That should clear the resize_pending_ flag.
+  BrowserPluginMsg_UpdateRect_Params update_rect_params;
+  update_rect_params.view_size = gfx::Size(640, 480);
+  update_rect_params.scale_factor = 1.0f;
+  update_rect_params.is_resize_ack = true;
+  browser_plugin->UpdateRect(0, update_rect_params);
+  EXPECT_FALSE(browser_plugin->resize_pending_);
+}
+
+// Verify that the src attribute on the browser plugin works as expected.
+TEST_F(BrowserPluginTest, SrcAttribute) {
+  LoadHTML(GetHTMLForBrowserPluginObject().c_str());
+  // Verify that we're reporting the correct URL to navigate to based on the
+  // src attribute.
+  {
+    const IPC::Message* msg =
+    browser_plugin_manager()->sink().GetUniqueMessageMatching(
+        BrowserPluginHostMsg_NavigateOrCreateGuest::ID);
+    ASSERT_TRUE(msg);
+
+    int instance_id;
+    long long frame_id;
+    std::string src;
+    BrowserPluginHostMsg_NavigateOrCreateGuest::Read(
+        msg,
+        &instance_id,
+        &frame_id,
+        &src);
+    EXPECT_EQ("foo", src);
+  }
+
+  browser_plugin_manager()->sink().ClearMessages();
+  // Navigate to bar and observe the associated
+  // BrowserPluginHostMsg_NavigateOrCreateGuest message.
+  // Verify that the src attribute is updated as well.
+  ExecuteJavaScript("document.getElementById('browserplugin').src = 'bar'");
+  {
+    const IPC::Message* msg =
+      browser_plugin_manager()->sink().GetUniqueMessageMatching(
+          BrowserPluginHostMsg_NavigateOrCreateGuest::ID);
+    ASSERT_TRUE(msg);
+
+    int instance_id;
+    long long frame_id;
+    std::string src;
+    BrowserPluginHostMsg_NavigateOrCreateGuest::Read(
+        msg,
+        &instance_id,
+        &frame_id,
+        &src);
+    EXPECT_EQ("bar", src);
+    std::string src_value =
+        ExecuteScriptAndReturnString(
+            "document.getElementById('browserplugin').src");
+    EXPECT_EQ("bar", src_value);
+  }
+}
+
+TEST_F(BrowserPluginTest, ResizeFlowControl) {
+  LoadHTML(GetHTMLForBrowserPluginObject().c_str());
+  browser_plugin_manager()->sink().ClearMessages();
+
+  // Resize the browser plugin three times.
+  ExecuteJavaScript("document.getElementById('browserplugin').width = '641px'");
+  ProcessPendingMessages();
+  ExecuteJavaScript("document.getElementById('browserplugin').width = '642px'");
+  ProcessPendingMessages();
+  ExecuteJavaScript("document.getElementById('browserplugin').width = '643px'");
+  ProcessPendingMessages();
+
+  // Expect to see three messsages in the sink.
+  EXPECT_EQ(3u, browser_plugin_manager()->sink().message_count());
+  const IPC::Message* msg =
+      browser_plugin_manager()->sink().GetFirstMessageMatching(
+          BrowserPluginHostMsg_ResizeGuest::ID);
+  ASSERT_TRUE(msg);
+  PickleIterator iter = IPC::SyncMessage::GetDataIterator(msg);
+  BrowserPluginHostMsg_ResizeGuest::SendParam  resize_params;
+  ASSERT_TRUE(IPC::ReadParam(msg, &iter, &resize_params));
+  int instance_id = resize_params.a;
+  BrowserPluginHostMsg_ResizeGuest_Params params(resize_params.b);
+  EXPECT_EQ(641, params.width);
+  EXPECT_EQ(480, params.height);
+  // This indicates that the BrowserPlugin has sent out a previous resize
+  // request but has not yet received an UpdateRect for that request.
+  // We send this resize regardless to update the damage buffer in the
+  // browser process, so it's ready when the guest sends the appropriate
+  // UpdateRect.
+  EXPECT_TRUE(params.resize_pending);
+
+  MockBrowserPlugin* browser_plugin =
+      static_cast<MockBrowserPlugin*>(
+          browser_plugin_manager()->GetBrowserPlugin(instance_id));
+  ASSERT_TRUE(browser_plugin);
+  {
+    // We send a stale UpdateRect to the BrowserPlugin.
+    BrowserPluginMsg_UpdateRect_Params update_rect_params;
+    update_rect_params.view_size = gfx::Size(640, 480);
+    update_rect_params.scale_factor = 1.0f;
+    update_rect_params.is_resize_ack = true;
+    browser_plugin->UpdateRect(0, update_rect_params);
+    // This tells us that the BrowserPlugin is still expecting another
+    // UpdateRect with the most recent size.
+    EXPECT_TRUE(browser_plugin->resize_pending_);
+  }
+  {
+    BrowserPluginMsg_UpdateRect_Params update_rect_params;
+    update_rect_params.view_size = gfx::Size(643, 480);
+    update_rect_params.scale_factor = 1.0f;
+    update_rect_params.is_resize_ack = true;
+    browser_plugin->UpdateRect(0, update_rect_params);
+    // The BrowserPlugin has finally received an UpdateRect that satisifes
+    // its current size, and so it is happy.
+    EXPECT_FALSE(browser_plugin->resize_pending_);
+  }
+}
+
+TEST_F(BrowserPluginTest, GuestCrash) {
+  LoadHTML(GetHTMLForBrowserPluginObject().c_str());
+
+  // Grab the BrowserPlugin's instance ID from its resize message.
+  const IPC::Message* msg =
+      browser_plugin_manager()->sink().GetFirstMessageMatching(
+          BrowserPluginHostMsg_ResizeGuest::ID);
+  ASSERT_TRUE(msg);
+  PickleIterator iter = IPC::SyncMessage::GetDataIterator(msg);
+  BrowserPluginHostMsg_ResizeGuest::SendParam  resize_params;
+  ASSERT_TRUE(IPC::ReadParam(msg, &iter, &resize_params));
+  int instance_id = resize_params.a;
+
+  MockBrowserPlugin* browser_plugin =
+      static_cast<MockBrowserPlugin*>(
+          browser_plugin_manager()->GetBrowserPlugin(instance_id));
+  ASSERT_TRUE(browser_plugin);
+
+  WebKit::WebCursorInfo cursor_info;
+  // Send an event and verify that the event is deported.
+  browser_plugin->handleInputEvent(WebKit::WebMouseEvent(),
+                                   cursor_info);
+  EXPECT_TRUE(browser_plugin_manager()->sink().GetUniqueMessageMatching(
+      BrowserPluginHostMsg_HandleInputEvent::ID));
+  browser_plugin_manager()->sink().ClearMessages();
+
+  // Pretend that the guest has crashed
+  browser_plugin->GuestCrashed();
+  // Send an event and verify that events are no longer deported.
+  browser_plugin->handleInputEvent(WebKit::WebMouseEvent(),
+                                   cursor_info);
+  EXPECT_FALSE(browser_plugin_manager()->sink().GetUniqueMessageMatching(
+      BrowserPluginHostMsg_HandleInputEvent::ID));
+
+  // Navigate and verify that the guest_crashed_ flag has been reset.
+  browser_plugin->SetSrcAttribute("bar");
+  EXPECT_FALSE(browser_plugin->guest_crashed_);
+}
+
+TEST_F(BrowserPluginTest, RemovePlugin) {
+  LoadHTML(GetHTMLForBrowserPluginObject().c_str());
+  EXPECT_FALSE(browser_plugin_manager()->sink().GetUniqueMessageMatching(
+      BrowserPluginHostMsg_PluginDestroyed::ID));
+  ExecuteJavaScript("x = document.getElementById('browserplugin'); "
+                    "x.parentNode.removeChild(x);");
+  ProcessPendingMessages();
+  EXPECT_TRUE(browser_plugin_manager()->sink().GetUniqueMessageMatching(
+      BrowserPluginHostMsg_PluginDestroyed::ID));
+}
+
+TEST_F(BrowserPluginTest, CustomEvents) {
+  const char* kAddEventListener =
+    "var url;"
+    "function nav(u) {"
+    "  url = u;"
+    "}"
+    "document.getElementById('browserplugin')."
+    "    addEventListener('navigation', nav);";
+  const char* kRemoveEventListener =
+    "document.getElementById('browserplugin')."
+    "    removeEventListener('navigation', nav);";
+  const char* kGoogleURL = "http://www.google.com/";
+  const char* kGoogleNewsURL = "http://news.google.com/";
+
+  LoadHTML(GetHTMLForBrowserPluginObject().c_str());
+  ExecuteJavaScript(kAddEventListener);
+  // Grab the BrowserPlugin's instance ID from its resize message.
+  const IPC::Message* msg =
+      browser_plugin_manager()->sink().GetFirstMessageMatching(
+          BrowserPluginHostMsg_ResizeGuest::ID);
+  ASSERT_TRUE(msg);
+  PickleIterator iter = IPC::SyncMessage::GetDataIterator(msg);
+  BrowserPluginHostMsg_ResizeGuest::SendParam  resize_params;
+  ASSERT_TRUE(IPC::ReadParam(msg, &iter, &resize_params));
+  int instance_id = resize_params.a;
+
+  MockBrowserPlugin* browser_plugin =
+      static_cast<MockBrowserPlugin*>(
+          browser_plugin_manager()->GetBrowserPlugin(instance_id));
+  ASSERT_TRUE(browser_plugin);
+
+  browser_plugin->DidNavigate(GURL(kGoogleURL));
+  EXPECT_EQ(kGoogleURL, ExecuteScriptAndReturnString("url"));
+
+  ExecuteJavaScript(kRemoveEventListener);
+  browser_plugin->DidNavigate(GURL(kGoogleNewsURL));
+  // The URL variable should not change because we've removed the event
+  // listener.
+  EXPECT_EQ(kGoogleURL, ExecuteScriptAndReturnString("url"));
+}
+
+}  // namespace content