Browser Plugin: Allocate Instance IDs in BrowserPluginEmbedder instead of BrowserPluginManager

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/memory/singleton.h"
 #include "base/path_service.h"
@@ skipping 106 matching lines @@
 }
 
 // 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 |pending_damage_buffer_| 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.
+  // Verify that the information in CreateGuest is correct.
   int instance_id = 0;
   {
     const IPC::Message* msg =
         browser_plugin_manager()->sink().GetUniqueMessageMatching(
-            BrowserPluginHostMsg_ResizeGuest::ID);
+            BrowserPluginHostMsg_CreateGuest::ID);
     ASSERT_TRUE(msg);
-    BrowserPluginHostMsg_ResizeGuest_Params params;
-    BrowserPluginHostMsg_ResizeGuest::Read(msg, &instance_id, &params);
-    EXPECT_EQ(640, params.view_size.width());
-    EXPECT_EQ(480, params.view_size.height());
+    int instance_id = 0;
+    BrowserPluginHostMsg_CreateGuest_Params params;
+    BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
+    EXPECT_EQ(640, params.resize_guest_params.view_size.width());
+    EXPECT_EQ(480, params.resize_guest_params.view_size.height());
   }
 
   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->pending_damage_buffer_.get());
 
   // Send the BrowserPlugin an UpdateRect equal to its container size with
@@ skipping 10 matching lines @@
   EXPECT_FALSE(browser_plugin->pending_damage_buffer_.get());
 }
 
 // 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.
   {
     // Ensure we get a CreateGuest on the initial navigation.
-    const IPC::Message* create_msg =
-    browser_plugin_manager()->sink().GetUniqueMessageMatching(
-        BrowserPluginHostMsg_CreateGuest::ID);
-    ASSERT_TRUE(create_msg);
-
     const IPC::Message* msg =
-    browser_plugin_manager()->sink().GetUniqueMessageMatching(
-        BrowserPluginHostMsg_NavigateGuest::ID);
+        browser_plugin_manager()->sink().GetUniqueMessageMatching(
+            BrowserPluginHostMsg_CreateGuest::ID);
     ASSERT_TRUE(msg);
 
     int instance_id = 0;
-    std::string src;
-    BrowserPluginHostMsg_NavigateGuest::Read(msg, &instance_id, &src);
-    EXPECT_EQ("foo", src);
+    BrowserPluginHostMsg_CreateGuest_Params params;
+    BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
+    EXPECT_EQ("foo", params.src);
   }
 
   browser_plugin_manager()->sink().ClearMessages();
   // Navigate to bar and observe the associated
   // BrowserPluginHostMsg_NavigateGuest message.
   // Verify that the src attribute is updated as well.
   ExecuteJavaScript("document.getElementById('browserplugin').src = 'bar'");
   {
     // Verify that we do not get a CreateGuest on subsequent navigations.
     const IPC::Message* create_msg =
-    browser_plugin_manager()->sink().GetUniqueMessageMatching(
-        BrowserPluginHostMsg_CreateGuest::ID);
+        browser_plugin_manager()->sink().GetUniqueMessageMatching(
+            BrowserPluginHostMsg_CreateGuest::ID);
     ASSERT_FALSE(create_msg);
 
     const IPC::Message* msg =
-      browser_plugin_manager()->sink().GetUniqueMessageMatching(
-          BrowserPluginHostMsg_NavigateGuest::ID);
+        browser_plugin_manager()->sink().GetUniqueMessageMatching(
+            BrowserPluginHostMsg_NavigateGuest::ID);
     ASSERT_TRUE(msg);
 
     int instance_id = 0;
     std::string src;
     BrowserPluginHostMsg_NavigateGuest::Read(msg, &instance_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());
   int instance_id = 0;
   {
-    // Ensure we get a NavigateGuest on the initial navigation and grab the
+    // Ensure we get a CreateGuest on the initial navigation and grab the
     // BrowserPlugin's instance_id from there.
-    std::string src;
-    const IPC::Message* nav_msg =
-    browser_plugin_manager()->sink().GetUniqueMessageMatching(
-        BrowserPluginHostMsg_NavigateGuest::ID);
-    ASSERT_TRUE(nav_msg);
-    BrowserPluginHostMsg_NavigateGuest::Read(nav_msg, &instance_id, &src);
+    const IPC::Message* msg =
+        browser_plugin_manager()->sink().GetUniqueMessageMatching(
+            BrowserPluginHostMsg_CreateGuest::ID);
+    ASSERT_TRUE(msg);
+    BrowserPluginHostMsg_CreateGuest_Params params;
+    BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
   }
   MockBrowserPlugin* browser_plugin =
       static_cast<MockBrowserPlugin*>(
           browser_plugin_manager()->GetBrowserPlugin(instance_id));
   ASSERT_TRUE(browser_plugin);
   EXPECT_TRUE(browser_plugin->pending_damage_buffer_.get());
   // Send an UpdateRect to the BrowserPlugin to make it use the pending damage
   // buffer.
   {
     // We send a stale UpdateRect to the BrowserPlugin.
@@ skipping 67 matching lines @@
     browser_plugin->OnMessageReceived(msg);
     // The BrowserPlugin has finally received an UpdateRect that satisifes
     // its current size, and so it is happy.
     EXPECT_FALSE(browser_plugin->pending_damage_buffer_.get());
   }
 }
 
 TEST_F(BrowserPluginTest, GuestCrash) {
   LoadHTML(GetHTMLForBrowserPluginObject().c_str());
 
-  // Grab the BrowserPlugin's instance ID from its resize message.
+  // Grab the BrowserPlugin's instance ID from its CreateGuest message.
   int instance_id = 0;
   {
     const IPC::Message* msg =
         browser_plugin_manager()->sink().GetFirstMessageMatching(
-            BrowserPluginHostMsg_ResizeGuest::ID);
+            BrowserPluginHostMsg_CreateGuest::ID);
     ASSERT_TRUE(msg);
-    BrowserPluginHostMsg_ResizeGuest_Params params;
-    BrowserPluginHostMsg_ResizeGuest::Read(msg, &instance_id, &params);
+    BrowserPluginHostMsg_CreateGuest_Params params;
+    BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
   }
   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);
@@ skipping 42 matching lines @@
   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));
 }
 
+// This test verifies that PluginDestroyed messages do not get sent from a
+// BrowserPlugin that has never navigated.
+TEST_F(BrowserPluginTest, RemovePluginBeforeNavigation) {
+  std::string html = StringPrintf(kHTMLForSourcelessPluginObject,
+                                  content::kBrowserPluginMimeType);
+  LoadHTML(html.c_str());
+  EXPECT_FALSE(browser_plugin_manager()->sink().GetUniqueMessageMatching(
+      BrowserPluginHostMsg_PluginDestroyed::ID));
+  ExecuteJavaScript("x = document.getElementById('browserplugin'); "
+                    "x.parentNode.removeChild(x);");
+  ProcessPendingMessages();
+  EXPECT_FALSE(browser_plugin_manager()->sink().GetUniqueMessageMatching(
+      BrowserPluginHostMsg_PluginDestroyed::ID));
+}
+
 TEST_F(BrowserPluginTest, CustomEvents) {
   const char* kAddEventListener =
     "var url;"
     "function nav(e) {"
     "  url = JSON.parse(e.detail).url;"
     "}"
     "document.getElementById('browserplugin')."
     "    addEventListener('-internal-loadcommit', nav);";
   const char* kRemoveEventListener =
     "document.getElementById('browserplugin')."
     "    removeEventListener('-internal-loadcommit', nav);";
   const char* kGetProcessID =
       "document.getElementById('browserplugin').getProcessId()";
   const char* kGetSrc =
       "document.getElementById('browserplugin').src";
   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);
+          BrowserPluginHostMsg_CreateGuest::ID);
   ASSERT_TRUE(msg);
   int instance_id = 0;
-  BrowserPluginHostMsg_ResizeGuest_Params params;
-  BrowserPluginHostMsg_ResizeGuest::Read(msg, &instance_id, &params);
+  BrowserPluginHostMsg_CreateGuest_Params params;
+  BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
 
   MockBrowserPlugin* browser_plugin =
       static_cast<MockBrowserPlugin*>(
           browser_plugin_manager()->GetBrowserPlugin(instance_id));
   ASSERT_TRUE(browser_plugin);
 
   {
     BrowserPluginMsg_LoadCommit_Params navigate_params;
     navigate_params.is_top_level = true;
     navigate_params.url = GURL(kGoogleURL);
@@ skipping 104 matching lines @@
         "document.getElementById('browserplugin').src"));
   }
 
   // Verify that the BrowserPlugin accepts changes to its src attribue after
   // setting the partition to a valid value.
   ExecuteJavaScript(
       "document.getElementById('browserplugin').partition = 'persist:foo'");
   ExecuteJavaScript("document.getElementById('browserplugin').src = 'bar'");
   EXPECT_EQ("bar", ExecuteScriptAndReturnString(
       "document.getElementById('browserplugin').src"));
+  ProcessPendingMessages();
   // Verify that the BrowserPlugin does not 'deadlock': it can recover from
   // the partition ID error state.
   {
     ExecuteJavaScript(
         "try {"
         "  document.getElementById('browserplugin').partition = 'persist:1337';"
         "  document.title = 'success';"
         "} catch (e) { document.title = e.message; }");
     std::string title = ExecuteScriptAndReturnString("document.title");
     EXPECT_STREQ(
@@ skipping 16 matching lines @@
       "document.getElementById('browserplugin').partition = 'storage'");
   std::string partition_value = ExecuteScriptAndReturnString(
       "document.getElementById('browserplugin').partition");
   EXPECT_STREQ("storage", partition_value.c_str());
 
   std::string src_value = ExecuteScriptAndReturnString(
       "document.getElementById('browserplugin').src");
   EXPECT_STREQ("", src_value.c_str());
 
   ExecuteJavaScript("document.getElementById('browserplugin').src = 'bar'");
+  ProcessPendingMessages();
   {
     const IPC::Message* create_msg =
     browser_plugin_manager()->sink().GetUniqueMessageMatching(
         BrowserPluginHostMsg_CreateGuest::ID);
     ASSERT_TRUE(create_msg);
 
     int create_instance_id = 0;
     BrowserPluginHostMsg_CreateGuest_Params params;
     BrowserPluginHostMsg_CreateGuest::Read(
         create_msg,
         &create_instance_id,
         &params);
     EXPECT_STREQ("storage", params.storage_partition_id.c_str());
     EXPECT_FALSE(params.persist_storage);
-
-    const IPC::Message* msg =
-        browser_plugin_manager()->sink().GetUniqueMessageMatching(
-            BrowserPluginHostMsg_NavigateGuest::ID);
-    ASSERT_TRUE(msg);
-
-    int instance_id = 0;
-    std::string src;
-    BrowserPluginHostMsg_NavigateGuest::Read(msg, &instance_id, &src);
-    EXPECT_STREQ("bar", src.c_str());
-    EXPECT_EQ(create_instance_id, instance_id);
+    EXPECT_STREQ("bar", params.src.c_str());
   }
 
   // Setting the partition should throw an exception and the value should not
   // change.
   ExecuteJavaScript(
       "try {"
       "  document.getElementById('browserplugin').partition = 'someid';"
       "  document.title = 'success';"
       "} catch (e) { document.title = e.message; }");
 
@@ skipping 19 matching lines @@
     "}"
     "document.getElementById('browserplugin')."
     "    addEventListener('-internal-loadcommit', nav);";
   const char* kGoogleURL = "http://www.google.com/";
   const char* kGoogleNewsURL = "http://news.google.com/";
   const char* kGetProcessID =
       "document.getElementById('browserplugin').getProcessId()";
 
   LoadHTML(GetHTMLForBrowserPluginObject().c_str());
   ExecuteJavaScript(kAddEventListener);
-  // Grab the BrowserPlugin's instance ID from its resize message.
+  // Grab the BrowserPlugin's instance ID from its CreateGuest message.
   const IPC::Message* msg =
       browser_plugin_manager()->sink().GetFirstMessageMatching(
-          BrowserPluginHostMsg_ResizeGuest::ID);
+          BrowserPluginHostMsg_CreateGuest::ID);
   ASSERT_TRUE(msg);
   int instance_id = 0;
-  BrowserPluginHostMsg_ResizeGuest_Params params;
-  BrowserPluginHostMsg_ResizeGuest::Read(msg, &instance_id, &params);
+  BrowserPluginHostMsg_CreateGuest_Params params;
+  BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
 
   MockBrowserPlugin* browser_plugin =
       static_cast<MockBrowserPlugin*>(
           browser_plugin_manager()->GetBrowserPlugin(instance_id));
   ASSERT_TRUE(browser_plugin);
 
   {
     BrowserPluginMsg_LoadCommit_Params navigate_params;
     navigate_params.url = GURL(kGoogleURL);
     navigate_params.process_id = 1337;
@@ skipping 29 matching lines @@
     "document.getElementById('browserplugin')."
     "    addEventListener('-internal-loadcommit', nava);"
     "document.getElementById('browserplugin')."
     "    addEventListener('-internal-loadcommit', navb);";
   const char* kGoogleURL = "http://www.google.com/";
   const char* kGetProcessID =
       "document.getElementById('browserplugin').getProcessId()";
 
   LoadHTML(GetHTMLForBrowserPluginObject().c_str());
   ExecuteJavaScript(kAddEventListener);
-  // Grab the BrowserPlugin's instance ID from its resize message.
+  // Grab the BrowserPlugin's instance ID from its CreateGuest message.
   const IPC::Message* msg =
       browser_plugin_manager()->sink().GetFirstMessageMatching(
-          BrowserPluginHostMsg_ResizeGuest::ID);
+          BrowserPluginHostMsg_CreateGuest::ID);
   ASSERT_TRUE(msg);
   int instance_id = 0;
-  BrowserPluginHostMsg_ResizeGuest_Params params;
-  BrowserPluginHostMsg_ResizeGuest::Read(msg, &instance_id, &params);
+  BrowserPluginHostMsg_CreateGuest_Params params;
+  BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
 
   MockBrowserPlugin* browser_plugin =
       static_cast<MockBrowserPlugin*>(
           browser_plugin_manager()->GetBrowserPlugin(instance_id));
   ASSERT_TRUE(browser_plugin);
 
   {
     BrowserPluginMsg_LoadCommit_Params navigate_params;
     navigate_params.url = GURL(kGoogleURL);
     navigate_params.process_id = 1337;
     BrowserPluginMsg_LoadCommit msg(0, instance_id, navigate_params);
     browser_plugin->OnMessageReceived(msg);
     EXPECT_EQ(2, ExecuteScriptAndReturnInt("count"));
     EXPECT_EQ(1337, ExecuteScriptAndReturnInt(kGetProcessID));
   }
 }
 
 TEST_F(BrowserPluginTest, RemoveBrowserPluginOnExit) {
   LoadHTML(GetHTMLForBrowserPluginObject().c_str());
 
-  // Grab the BrowserPlugin's instance ID from its resize message.
+  // Grab the BrowserPlugin's instance ID from its CreateGuest message.
   int instance_id = 0;
   {
     const IPC::Message* msg =
         browser_plugin_manager()->sink().GetFirstMessageMatching(
-            BrowserPluginHostMsg_ResizeGuest::ID);
+            BrowserPluginHostMsg_CreateGuest::ID);
     ASSERT_TRUE(msg);
-    BrowserPluginHostMsg_ResizeGuest_Params params;
-    BrowserPluginHostMsg_ResizeGuest::Read(msg, &instance_id, &params);
+    BrowserPluginHostMsg_CreateGuest_Params params;
+    BrowserPluginHostMsg_CreateGuest::Read(msg, &instance_id, &params);
   }
 
   MockBrowserPlugin* browser_plugin =
       static_cast<MockBrowserPlugin*>(
           browser_plugin_manager()->GetBrowserPlugin(instance_id));
   ASSERT_TRUE(browser_plugin);
 
   const char* kAddEventListener =
     "function exitListener(e) {"
     "  if (JSON.parse(e.detail).reason == 'killed') {"
@@ skipping 98 matching lines @@
                                               &resize_params);
     EXPECT_FALSE(auto_size_params.enable);
     EXPECT_EQ(42, auto_size_params.min_size.width());
     EXPECT_EQ(43, auto_size_params.min_size.height());
     EXPECT_EQ(1337, auto_size_params.max_size.width());
     EXPECT_EQ(1338, auto_size_params.max_size.height());
   }
 }
 
 }  // namespace content