Make printing work better with OOPIF.

components/printing/test/print_web_view_helper_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 "components/printing/renderer/print_web_view_helper.h"
 
 #include <stddef.h>
 
 #include <memory>
 #include <tuple>
 #include <utility>
 
 #include "base/command_line.h"
 #include "base/macros.h"
 #include "base/run_loop.h"
 #include "build/build_config.h"
 #include "components/printing/common/print_messages.h"
 #include "components/printing/test/mock_printer.h"
 #include "components/printing/test/print_mock_render_thread.h"
 #include "components/printing/test/print_test_content_renderer_client.h"
+#include "content/public/renderer/render_frame.h"
 #include "content/public/renderer/render_view.h"
 #include "content/public/test/render_view_test.h"
 #include "ipc/ipc_listener.h"
 #include "printing/print_job_constants.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/WebKit/public/platform/WebString.h"
 #include "third_party/WebKit/public/web/WebLocalFrame.h"
 #include "third_party/WebKit/public/web/WebRange.h"
 #include "third_party/WebKit/public/web/WebView.h"
 
@@ skipping 185 matching lines @@
     ASSERT_EQ(printed, did_print_msg);
     if (printed) {
       PrintHostMsg_DidPrintPage::Param post_did_print_page_param;
       PrintHostMsg_DidPrintPage::Read(print_msg, &post_did_print_page_param);
       EXPECT_EQ(0, std::get<0>(post_did_print_page_param).page_number);
     }
   }
 
 #if defined(ENABLE_BASIC_PRINTING)
   void OnPrintPages() {
-    PrintWebViewHelper::Get(view_)->OnPrintPages();
+    GetPrintWebViewHelper()->OnPrintPages();
     ProcessPendingMessages();
   }
 #endif  // defined(ENABLE_BASIC_PRINTING)
 
 #if defined(ENABLE_PRINT_PREVIEW)
   void VerifyPreviewRequest(bool requested) {
     const IPC::Message* print_msg =
         render_thread_->sink().GetUniqueMessageMatching(
             PrintHostMsg_SetupScriptedPrintPreview::ID);
     bool did_print_msg = !!print_msg;
     ASSERT_EQ(requested, did_print_msg);
   }
 
   void OnPrintPreview(const base::DictionaryValue& dict) {
-    PrintWebViewHelper* print_web_view_helper = PrintWebViewHelper::Get(view_);
+    PrintWebViewHelper* print_web_view_helper = GetPrintWebViewHelper();
     print_web_view_helper->OnInitiatePrintPreview(false);
     base::RunLoop run_loop;
     DidPreviewPageListener filter(&run_loop);
     render_thread_->sink().AddFilter(&filter);
     print_web_view_helper->OnPrintPreview(dict);
     run_loop.Run();
     render_thread_->sink().RemoveFilter(&filter);
   }
 #endif  // defined(ENABLE_PRINT_PREVIEW)
 
 #if defined(ENABLE_BASIC_PRINTING)
   void OnPrintForPrintPreview(const base::DictionaryValue& dict) {
-    PrintWebViewHelper::Get(view_)->OnPrintForPrintPreview(dict);
+    GetPrintWebViewHelper()->OnPrintForPrintPreview(dict);
     ProcessPendingMessages();
   }
 #endif  // defined(ENABLE_BASIC_PRINTING)
 
+  PrintWebViewHelper* GetPrintWebViewHelper() {
+    return PrintWebViewHelper::Get(
+        content::RenderFrame::FromWebFrame(GetMainFrame()));

[nasko, 2016/11/02 04:50:37]

This means that the test will not exercise out-of-process iframes printing,
right?

[Lei Zhang, 2016/11/08 11:13:22]

Correct. We'll need to write more tests at some point.

[nasko, 2016/11/08 22:18:35]

Is this something I can help with? I don't know much about printing or how to
wait for printing related events, but if you point me at which test case is
closest to the scenario we are solving, I can try to write one that mimics it
for OOPIFs.

[Lei Zhang, 2016/11/11 21:06:48]

PrintWithIframe below might be the closest, but it looks old and crufty.

I'll take a shot at writing some more test cases here. If I write a test case,
will the linux_site_isolation bot automatically run the same test with
--site-per-process ?

[Łukasz Anforowicz, 2016/11/11 21:29:02]

Correct - linux_site_isolation trybot will run a bunch of tests with
--site-per-process.  This includes content_browsertests, browser_tests,
components_browsertests, layout tests and a few others - for details which test
suites are covered you can look at testing/buildbot/chromium.fyi.json and search
for "Site Isolation Linux" (note that this config file configures [with a single
entry] both the FYI bot *and* the linux_site_isolation trybot).  

Additionally content_browsertests and browser_tests are also run with and
without --site-per-process by CQ (i.e. see site_per_process_content_browsertests
step being executed by linux_chromium_rel_ng bot and configured by an entry in
testing/buildbot/chromium.linux.json).

+  }
+
   // Naked pointer as ownership is with content::RenderViewTest::render_thread_.
   PrintMockRenderThread* print_render_thread_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(PrintWebViewHelperTestBase);
 };
 
 // RenderViewTest-based tests crash on Android
 // http://crbug.com/187500
 #if defined(OS_ANDROID)
@@ skipping 25 matching lines @@
   PrintWithJavaScript();
   PrintWithJavaScript();
   VerifyPagesPrinted(false);
 
   // Pretend user will print. (but printing is blocked.)
   print_render_thread_->set_print_dialog_user_response(true);
   PrintWithJavaScript();
   VerifyPagesPrinted(false);
 
   // Unblock script initiated printing and verify printing works.
-  PrintWebViewHelper::Get(view_)->scripting_throttler_.Reset();
+  GetPrintWebViewHelper()->scripting_throttler_.Reset();
   print_render_thread_->printer()->ResetPrinter();
   PrintWithJavaScript();
   VerifyPageCount(1);
   VerifyPagesPrinted(true);
 }
 
 // Tests that the renderer always allows window.print() calls if they are user
 // initiated.
 TEST_F(MAYBE_PrintWebViewHelperTest, AllowUserOriginatedPrinting) {
   // Pretend user will cancel printing.
@@ skipping 66 matching lines @@
       "  document.write(frames['sub1'].name);"
       "  frames['sub1'].document.write("
       "      '<p>Cras tempus ante eu felis semper luctus!</p>');"
       "  frames['sub1'].document.close();"
       "</script></body></html>";
 
   LoadHTML(html);
 
   // Find the frame and set it as the focused one.  This should mean that that
   // the printout should only contain the contents of that frame.
-  WebFrame* sub1_frame =
-      view_->GetWebView()->findFrameByName(WebString::fromUTF8("sub1"));
+  auto* web_view = view_->GetWebView();
+  WebFrame* sub1_frame = web_view->findFrameByName(WebString::fromUTF8("sub1"));
   ASSERT_TRUE(sub1_frame);
-  view_->GetWebView()->setFocusedFrame(sub1_frame);
-  ASSERT_NE(view_->GetWebView()->focusedFrame(),
-            view_->GetWebView()->mainFrame());
+  web_view->setFocusedFrame(sub1_frame);
+  ASSERT_NE(web_view->focusedFrame(), web_view->mainFrame());
 
   // Initiate printing.
   OnPrintPages();
   VerifyPagesPrinted(true);
 
   // Verify output through MockPrinter.
   const MockPrinter* printer(print_render_thread_->printer());
   ASSERT_EQ(1, printer->GetPrintedPages());
   const Image& image1(printer->GetPrintedPage(0)->image());
 
@@ skipping 208 matching lines @@
       EXPECT_EQ(page_has_print_css, std::get<2>(param));
     }
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(MAYBE_PrintWebViewHelperPreviewTest);
 };
 
 TEST_F(MAYBE_PrintWebViewHelperPreviewTest, BlockScriptInitiatedPrinting) {
   LoadHTML(kHelloWorldHTML);
-  PrintWebViewHelper* print_web_view_helper = PrintWebViewHelper::Get(view_);
-  print_web_view_helper->SetScriptedPrintBlocked(true);
+  PrintWebViewHelper* print_web_view_helper = GetPrintWebViewHelper();
+  print_web_view_helper->SetPrintingEnabled(false);
   PrintWithJavaScript();
   VerifyPreviewRequest(false);
 
-  print_web_view_helper->SetScriptedPrintBlocked(false);
+  print_web_view_helper->SetPrintingEnabled(true);
   PrintWithJavaScript();
   VerifyPreviewRequest(true);
 }
 
 TEST_F(MAYBE_PrintWebViewHelperPreviewTest, PrintWithJavaScript) {
   LoadHTML(kPrintOnUserAction);
   gfx::Size new_size(200, 100);
   Resize(new_size, false);
 
   gfx::Rect bounds = GetElementBounds("print");
@@ skipping 412 matching lines @@
 
   VerifyPrintFailed(true);
   VerifyPagesPrinted(false);
 }
 #endif  // defined(ENABLE_BASIC_PRINTING)
 #endif  // defined(ENABLE_PRINT_PREVIEW)
 
 #endif  // !defined(OS_CHROMEOS)
 
 }  // namespace printing