Enable spare RenderProcessHost to be preinitialized.

content/browser/renderer_host/render_process_host_browsertest.cc

 // Copyright 2013 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 "base/bind.h"
 #include "base/command_line.h"
 #include "base/run_loop.h"
 #include "build/build_config.h"
 #include "content/browser/renderer_host/render_process_host_impl.h"
 #include "content/common/child_process_messages.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_process_host_observer.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/test/content_browser_test.h"
 #include "content/public/test/content_browser_test_utils.h"
 #include "content/public/test/test_service.mojom.h"
 #include "content/shell/browser/shell.h"
+#include "content/shell/browser/shell_browser_context.h"
+#include "content/shell/browser/shell_browser_main_parts.h"
+#include "content/shell/browser/shell_content_browser_client.h"
+#include "content/test/test_content_browser_client.h"
 #include "media/base/bind_to_current_loop.h"
 #include "media/base/media_switches.h"
 #include "media/base/test_data_util.h"
 #include "media/mojo/features.h"
 #include "net/test/embedded_test_server/embedded_test_server.h"
 
 #if defined(OS_WIN)
 #include "base/win/windows_version.h"
 #endif
 
@@ skipping 36 matching lines @@
   }
   void RenderProcessHostDestroyed(RenderProcessHost* host) override {
     ++host_destructions_;
   }
 
   int process_exits_;
   int host_destructions_;
   base::Closure process_exit_callback_;
 };
 
+// A mock ContentBrowserClient that only considers a spare renderer to be a
+// suitable host.
+class SpareRendererContentBrowserClient : public TestContentBrowserClient {
+ public:
+  bool IsSuitableHost(RenderProcessHost* process_host,
+                      const GURL& site_url) override {
+    if (RenderProcessHostImpl::GetSpareRenderProcessHostForTesting()) {
+      return process_host ==
+             RenderProcessHostImpl::GetSpareRenderProcessHostForTesting();
+    }
+    return true;
+  }
+};
+
+// A mock ContentBrowserClient that only considers a non-spare renderer to be a
+// suitable host, but otherwise tries to reuse processes.
+class NonSpareRendererContentBrowserClient : public TestContentBrowserClient {
+ public:
+  bool IsSuitableHost(RenderProcessHost* process_host,
+                      const GURL& site_url) override {
+    return RenderProcessHostImpl::GetSpareRenderProcessHostForTesting() !=
+           process_host;
+  }
+
+  bool ShouldTryToUseExistingProcessHost(BrowserContext* context,
+                                         const GURL& url) override {
+    return true;
+  }
+};
+
 // Sometimes the renderer process's ShutdownRequest (corresponding to the
 // ViewMsg_WasSwappedOut from a previous navigation) doesn't arrive until after
 // the browser process decides to re-use the renderer for a new purpose.  This
 // test makes sure the browser doesn't let the renderer die in that case.  See
 // http://crbug.com/87176.
 IN_PROC_BROWSER_TEST_F(RenderProcessHostTest,
                        ShutdownRequestFromActiveTabIgnored) {
   ASSERT_TRUE(embedded_test_server()->Start());
 
   GURL test_url = embedded_test_server()->GetURL("/simple_page.html");
@@ skipping 37 matching lines @@
   GURL::Replacements replace_host;
   replace_host.SetHostStr("localhost");
   GURL another_url = embedded_test_server()->GetURL("/simple_page.html");
   another_url = another_url.ReplaceComponents(replace_host);
   NavigateToURL(CreateBrowser(), another_url);
 
   // Expect that we got another process (the guest renderer was not reused).
   EXPECT_EQ(2, RenderProcessHostCount());
 }
 
+IN_PROC_BROWSER_TEST_F(RenderProcessHostTest, SpareRenderProcessHostTaken) {
+  ASSERT_TRUE(embedded_test_server()->Start());
+
+  RenderProcessHost::WarmupSpareRenderProcessHost(
+      ShellContentBrowserClient::Get()->browser_context());
+  RenderProcessHost* spare_renderer =
+      RenderProcessHostImpl::GetSpareRenderProcessHostForTesting();
+  EXPECT_NE(nullptr, spare_renderer);
+
+  GURL test_url = embedded_test_server()->GetURL("/simple_page.html");
+  Shell* window = CreateBrowser();
+  NavigateToURL(window, test_url);
+
+  EXPECT_EQ(spare_renderer,
+            window->web_contents()->GetMainFrame()->GetProcess());
+
+  // The spare render process host should no longer be available.
+  EXPECT_EQ(nullptr,
+            RenderProcessHostImpl::GetSpareRenderProcessHostForTesting());
+}
+
+IN_PROC_BROWSER_TEST_F(RenderProcessHostTest, SpareRenderProcessHostNotTaken) {
+  ASSERT_TRUE(embedded_test_server()->Start());
+
+  RenderProcessHost::WarmupSpareRenderProcessHost(
+      ShellContentBrowserClient::Get()->off_the_record_browser_context());
+  RenderProcessHost* spare_renderer =
+      RenderProcessHostImpl::GetSpareRenderProcessHostForTesting();
+  GURL test_url = embedded_test_server()->GetURL("/simple_page.html");
+  Shell* window = CreateBrowser();
+  NavigateToURL(window, test_url);
+
+  // There should have been another process created for the navigation.
+  EXPECT_NE(spare_renderer,
+            window->web_contents()->GetMainFrame()->GetProcess());
+
+  // The spare RenderProcessHost should have been cleaned up. Note this
+  // behavior is identical to what would have happened if the RenderProcessHost
+  // were taken.
+  EXPECT_EQ(nullptr,
+            RenderProcessHostImpl::GetSpareRenderProcessHostForTesting());
+}
+
+IN_PROC_BROWSER_TEST_F(RenderProcessHostTest, SpareRenderProcessHostKilled) {
+  RenderProcessHost::WarmupSpareRenderProcessHost(
+      ShellContentBrowserClient::Get()->browser_context());
+
+  RenderProcessHost* spare_renderer =
+      RenderProcessHostImpl::GetSpareRenderProcessHostForTesting();
+  mojom::TestServicePtr service;
+  ASSERT_NE(nullptr, spare_renderer);
+  BindInterface(spare_renderer, &service);
+
+  base::RunLoop run_loop;
+  set_process_exit_callback(run_loop.QuitClosure());
+  spare_renderer->AddObserver(this);  // For process_exit_callback.
+
+  // Should reply with a bad message and cause process death.
+  service->DoSomething(base::Bind(&base::DoNothing));
+  run_loop.Run();
+
+  // The spare RenderProcessHost should disappear when its process dies.
+  EXPECT_EQ(nullptr,
+            RenderProcessHostImpl::GetSpareRenderProcessHostForTesting());
+}
+
+// Test that the spare renderer works correctly when the limit on the maximum
+// number of processes is small.
+IN_PROC_BROWSER_TEST_F(RenderProcessHostTest,
+                       SpareRendererSurpressedMaxProcesses) {
+  ASSERT_TRUE(embedded_test_server()->Start());
+
+  SpareRendererContentBrowserClient browser_client;
+  ContentBrowserClient* old_client =
+      SetBrowserClientForTesting(&browser_client);
+
+  RenderProcessHost::SetMaxRendererProcessCount(1);
+
+  // A process is created with shell startup, so with a maximum of one renderer
+  // process the spare RPH should not be created.
+  RenderProcessHost::WarmupSpareRenderProcessHost(
+      ShellContentBrowserClient::Get()->browser_context());
+  EXPECT_EQ(nullptr,
+            RenderProcessHostImpl::GetSpareRenderProcessHostForTesting());
+
+  // A spare RPH should be created with a max of 2 renderer processes.
+  RenderProcessHost::SetMaxRendererProcessCount(2);
+  RenderProcessHost::WarmupSpareRenderProcessHost(
+      ShellContentBrowserClient::Get()->browser_context());
+  RenderProcessHost* spare_renderer =
+      RenderProcessHostImpl::GetSpareRenderProcessHostForTesting();
+  EXPECT_NE(nullptr, spare_renderer);
+
+  // Thanks to the injected SpareRendererContentBrowserClient and the limit on
+  // processes, the spare RPH will always be used via GetExistingProcessHost()
+  // rather than picked up via MaybeTakeSpareRenderProcessHost().
+  GURL test_url = embedded_test_server()->GetURL("/simple_page.html");
+  Shell* new_window = CreateBrowser();
+  NavigateToURL(new_window, test_url);
+  // The spare RPH should have been dropped during CreateBrowser() and given to
+  // the new window.
+  EXPECT_EQ(nullptr,
+            RenderProcessHostImpl::GetSpareRenderProcessHostForTesting());
+  EXPECT_EQ(spare_renderer,
+            new_window->web_contents()->GetMainFrame()->GetProcess());
+
+  // Revert to the default process limit and original ContentBrowserClient.
+  RenderProcessHost::SetMaxRendererProcessCount(0);
+  SetBrowserClientForTesting(old_client);
+}
+
+// Check that the spare renderer is dropped if an existing process is reused.
+IN_PROC_BROWSER_TEST_F(RenderProcessHostTest, SpareRendererOnProcessReuse) {
+  ASSERT_TRUE(embedded_test_server()->Start());
+
+  NonSpareRendererContentBrowserClient browser_client;
+  ContentBrowserClient* old_client =
+      SetBrowserClientForTesting(&browser_client);
+
+  RenderProcessHost::WarmupSpareRenderProcessHost(
+      ShellContentBrowserClient::Get()->browser_context());
+  RenderProcessHost* spare_renderer =
+      RenderProcessHostImpl::GetSpareRenderProcessHostForTesting();
+  EXPECT_NE(nullptr, spare_renderer);
+
+  // This should resuse the existing process and cause the spare renderer to be
+  // dropped.
+  Shell* new_browser = CreateBrowser();
+  EXPECT_EQ(shell()->web_contents()->GetMainFrame()->GetProcess(),
+            new_browser->web_contents()->GetMainFrame()->GetProcess());
+  EXPECT_NE(spare_renderer,
+            new_browser->web_contents()->GetMainFrame()->GetProcess());
+  EXPECT_EQ(nullptr,
+            RenderProcessHostImpl::GetSpareRenderProcessHostForTesting());
+
+  SetBrowserClientForTesting(old_client);
+}
+
 class ShellCloser : public RenderProcessHostObserver {
  public:
   ShellCloser(Shell* shell, std::string* logging_string)
       : shell_(shell), logging_string_(logging_string) {}
 
  protected:
   // RenderProcessHostObserver:
   void RenderProcessExited(RenderProcessHost* host,
                            base::TerminationStatus status,
                            int exit_code) override {
@@ skipping 179 matching lines @@
   // Verify shutdown went as expected.
   EXPECT_EQ(0, rph->get_audio_stream_count_for_testing());
   EXPECT_EQ(1, process_exits_);
   EXPECT_EQ(0, host_destructions_);
   if (!host_destructions_)
     rph->RemoveObserver(this);
 }
 
 }  // namespace
 }  // namespace content