Change Lo-Fi bool to bitmask to support multiple Previews types

content/browser/loader/resource_dispatcher_host_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/public/browser/resource_dispatcher_host.h"
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/memory/ref_counted.h"
 #include "base/run_loop.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
 #include "build/build_config.h"
 #include "content/browser/download/download_manager_impl.h"
 #include "content/browser/loader/resource_dispatcher_host_impl.h"
 #include "content/browser/web_contents/web_contents_impl.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/resource_dispatcher_host_delegate.h"
 #include "content/public/browser/resource_request_info.h"
 #include "content/public/browser/web_contents.h"
+#include "content/public/common/previews_state.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/test/browser_test_utils.h"
 #include "content/public/test/content_browser_test.h"
 #include "content/public/test/content_browser_test_utils.h"
 #include "content/public/test/test_navigation_observer.h"
 #include "content/public/test/test_utils.h"
 #include "content/shell/browser/shell.h"
 #include "content/shell/browser/shell_content_browser_client.h"
 #include "content/shell/browser/shell_network_delegate.h"
 #include "net/base/net_errors.h"
@@ skipping 547 matching lines @@
       shell(),
       embedded_test_server()->GetURL("/client_redirect.html"),
       2);
 
   EXPECT_TRUE(
       delegate.page_transition() & ui::PAGE_TRANSITION_CLIENT_REDIRECT);
 }
 
 namespace {
 
-// Checks whether the given urls are requested, and that IsUsingLofi() returns
-// the appropriate value when the Lo-Fi state is set.
-class LoFiModeResourceDispatcherHostDelegate
+// Checks whether the given urls are requested, and that GetPreviewsState()
+// returns the appropriate value when the Previews are set.
+class PreviewsStateResourceDispatcherHostDelegate
     : public ResourceDispatcherHostDelegate {
  public:
-  LoFiModeResourceDispatcherHostDelegate(const GURL& main_frame_url,
-                                         const GURL& subresource_url,
-                                         const GURL& iframe_url)
+  PreviewsStateResourceDispatcherHostDelegate(const GURL& main_frame_url,
+                                              const GURL& subresource_url,
+                                              const GURL& iframe_url)
       : main_frame_url_(main_frame_url),
         subresource_url_(subresource_url),
         iframe_url_(iframe_url),
         main_frame_url_seen_(false),
         subresource_url_seen_(false),
         iframe_url_seen_(false),
-        use_lofi_(false),
-        should_enable_lofi_mode_called_(false) {}
+        previews_state_(PREVIEWS_OFF),
+        should_get_previews_state_called_(false) {}
 
-  ~LoFiModeResourceDispatcherHostDelegate() override {}
+  ~PreviewsStateResourceDispatcherHostDelegate() override {}
 
   // ResourceDispatcherHostDelegate implementation:
   void RequestBeginning(net::URLRequest* request,
                         ResourceContext* resource_context,
                         AppCacheService* appcache_service,
                         ResourceType resource_type,
                         ScopedVector<ResourceThrottle>* throttles) override {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
     const ResourceRequestInfo* info = ResourceRequestInfo::ForRequest(request);
     if (request->url() != main_frame_url_ && request->url() != subresource_url_
         && request->url() != iframe_url_)
       return;
     if (request->url() == main_frame_url_) {
       EXPECT_FALSE(main_frame_url_seen_);
       main_frame_url_seen_ = true;
     } else if (request->url() == subresource_url_) {
       EXPECT_TRUE(main_frame_url_seen_);
       EXPECT_FALSE(subresource_url_seen_);
       subresource_url_seen_ = true;
     } else if (request->url() == iframe_url_) {
       EXPECT_TRUE(main_frame_url_seen_);
       EXPECT_FALSE(iframe_url_seen_);
       iframe_url_seen_ = true;
     }
-    EXPECT_EQ(use_lofi_, info->IsUsingLoFi());
+    EXPECT_EQ(previews_state_, info->GetPreviewsState());
   }
 
   void SetDelegate() {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
     ResourceDispatcherHost::Get()->SetDelegate(this);
   }
 
-  bool ShouldEnableLoFiMode(
+  PreviewsState GetPreviewsState(
       const net::URLRequest& request,
       content::ResourceContext* resource_context) override {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
-    EXPECT_FALSE(should_enable_lofi_mode_called_);
-    should_enable_lofi_mode_called_ = true;
+    EXPECT_FALSE(should_get_previews_state_called_);
+    should_get_previews_state_called_ = true;
     EXPECT_EQ(main_frame_url_, request.url());
-    return use_lofi_;
+    return previews_state_;
   }
 
-  void Reset(bool use_lofi) {
+  void Reset(PreviewsState previews_state) {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
     main_frame_url_seen_ = false;
     subresource_url_seen_ = false;
     iframe_url_seen_ = false;
-    use_lofi_ = use_lofi;
-    should_enable_lofi_mode_called_ = false;
+    previews_state_ = previews_state;
+    should_get_previews_state_called_ = false;
   }
 
-  void CheckResourcesRequested(bool should_enable_lofi_mode_called) {
+  void CheckResourcesRequested(bool should_get_previews_state_called) {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
-    EXPECT_EQ(should_enable_lofi_mode_called, should_enable_lofi_mode_called_);
+    EXPECT_EQ(should_get_previews_state_called,
+              should_get_previews_state_called_);
     EXPECT_TRUE(main_frame_url_seen_);
     EXPECT_TRUE(subresource_url_seen_);
     EXPECT_TRUE(iframe_url_seen_);
   }
 
  private:
   const GURL main_frame_url_;
   const GURL subresource_url_;
   const GURL iframe_url_;
 
   bool main_frame_url_seen_;
   bool subresource_url_seen_;
   bool iframe_url_seen_;
-  bool use_lofi_;
-  bool should_enable_lofi_mode_called_;
+  PreviewsState previews_state_;
+  bool should_get_previews_state_called_;
 
-  DISALLOW_COPY_AND_ASSIGN(LoFiModeResourceDispatcherHostDelegate);
+  DISALLOW_COPY_AND_ASSIGN(PreviewsStateResourceDispatcherHostDelegate);
 };
 
 }  // namespace
 
-class LoFiResourceDispatcherHostBrowserTest : public ContentBrowserTest {
+class PreviewsStateResourceDispatcherHostBrowserTest
+    : public ContentBrowserTest {
  public:
-  ~LoFiResourceDispatcherHostBrowserTest() override {}
+  ~PreviewsStateResourceDispatcherHostBrowserTest() override {}
 
  protected:
   void SetUpOnMainThread() override {
     ContentBrowserTest::SetUpOnMainThread();
 
     ASSERT_TRUE(embedded_test_server()->Start());
 
-    delegate_.reset(new LoFiModeResourceDispatcherHostDelegate(
+    delegate_.reset(new PreviewsStateResourceDispatcherHostDelegate(
         embedded_test_server()->GetURL("/page_with_iframe.html"),
         embedded_test_server()->GetURL("/image.jpg"),
         embedded_test_server()->GetURL("/title1.html")));
 
     content::BrowserThread::PostTask(
            content::BrowserThread::IO,
            FROM_HERE,
-           base::Bind(&LoFiModeResourceDispatcherHostDelegate::SetDelegate,
+           base::Bind(&PreviewsStateResourceDispatcherHostDelegate::SetDelegate,
                       base::Unretained(delegate_.get())));
   }
 
-  void Reset(bool use_lofi) {
+  void Reset(PreviewsState previews_state) {
     content::BrowserThread::PostTask(
         content::BrowserThread::IO, FROM_HERE,
-        base::Bind(&LoFiModeResourceDispatcherHostDelegate::Reset,
-                   base::Unretained(delegate_.get()), use_lofi));
+        base::Bind(&PreviewsStateResourceDispatcherHostDelegate::Reset,
+                   base::Unretained(delegate_.get()), previews_state));
   }
 
   void CheckResourcesRequested(
-      bool should_enable_lofi_mode_called) {
+      bool should_get_previews_state_called) {
     content::BrowserThread::PostTask(
         content::BrowserThread::IO, FROM_HERE,
-        base::Bind(
-            &LoFiModeResourceDispatcherHostDelegate::CheckResourcesRequested,
-            base::Unretained(delegate_.get()), should_enable_lofi_mode_called));
+        base::Bind(&PreviewsStateResourceDispatcherHostDelegate::
+                       CheckResourcesRequested,
+                   base::Unretained(delegate_.get()),
+                   should_get_previews_state_called));
   }
 
  private:
-  std::unique_ptr<LoFiModeResourceDispatcherHostDelegate> delegate_;
+  std::unique_ptr<PreviewsStateResourceDispatcherHostDelegate> delegate_;
 };
 
-// Test that navigating with ShouldEnableLoFiMode returning true fetches the
-// resources with LOFI_ON.
-IN_PROC_BROWSER_TEST_F(LoFiResourceDispatcherHostBrowserTest,
+// Test that navigating calls GetPreviewsState with SERVER_LOFI_ON.
+IN_PROC_BROWSER_TEST_F(PreviewsStateResourceDispatcherHostBrowserTest,
                        ShouldEnableLoFiModeOn) {
   // Navigate with ShouldEnableLoFiMode returning true.
-  Reset(true);
+  Reset(SERVER_LOFI_ON);
   NavigateToURLBlockUntilNavigationsComplete(
       shell(), embedded_test_server()->GetURL("/page_with_iframe.html"), 1);
   CheckResourcesRequested(true);
 }
 
-// Test that navigating with ShouldEnableLoFiMode returning false fetches the
-// resources with LOFI_OFF.
-IN_PROC_BROWSER_TEST_F(LoFiResourceDispatcherHostBrowserTest,
+// Test that navigating calls GetPreviewsState returning PREVIEWS_OFF.
+IN_PROC_BROWSER_TEST_F(PreviewsStateResourceDispatcherHostBrowserTest,
                        ShouldEnableLoFiModeOff) {
-  // Navigate with ShouldEnableLoFiMode returning false.
+  // Navigate with GetPreviewsState returning false.
   NavigateToURLBlockUntilNavigationsComplete(
       shell(), embedded_test_server()->GetURL("/page_with_iframe.html"), 1);
   CheckResourcesRequested(true);
 }
 
-// Test that reloading calls ShouldEnableLoFiMode again and changes the Lo-Fi
+// Test that reloading calls GetPreviewsState again and changes the Previews
 // state.
-IN_PROC_BROWSER_TEST_F(LoFiResourceDispatcherHostBrowserTest,
+IN_PROC_BROWSER_TEST_F(PreviewsStateResourceDispatcherHostBrowserTest,
                        ShouldEnableLoFiModeReload) {
-  // Navigate with ShouldEnableLoFiMode returning false.
+  // Navigate with GetPreviewsState returning PREVIEWS_OFF.
   NavigateToURLBlockUntilNavigationsComplete(
       shell(), embedded_test_server()->GetURL("/page_with_iframe.html"), 1);
   CheckResourcesRequested(true);
 
-  // Reload. ShouldEnableLoFiMode should be called.
-  Reset(true);
+  // Reload. GetPreviewsState should be called.
+  Reset(SERVER_LOFI_ON);
   ReloadBlockUntilNavigationsComplete(shell(), 1);
   CheckResourcesRequested(true);
 }
 
-// Test that navigating backwards calls ShouldEnableLoFiMode again and changes
-// the Lo-Fi state.
-IN_PROC_BROWSER_TEST_F(LoFiResourceDispatcherHostBrowserTest,
+// Test that navigating backwards calls GetPreviewsState again and changes
+// the Previews state.
+IN_PROC_BROWSER_TEST_F(PreviewsStateResourceDispatcherHostBrowserTest,
                        ShouldEnableLoFiModeNavigateBackThenForward) {
-  // Navigate with ShouldEnableLoFiMode returning false.
+  // Navigate with GetPreviewsState returning false.
   NavigateToURLBlockUntilNavigationsComplete(
       shell(), embedded_test_server()->GetURL("/page_with_iframe.html"), 1);
   CheckResourcesRequested(true);
 
   // Go to a different page.
   NavigateToURLBlockUntilNavigationsComplete(shell(), GURL("about:blank"), 1);
 
-  // Go back with ShouldEnableLoFiMode returning true.
-  Reset(true);
+  // Go back with GetPreviewsState returning SERVER_LOFI_ON.
+  Reset(SERVER_LOFI_ON);
   TestNavigationObserver tab_observer(shell()->web_contents(), 1);
   shell()->GoBackOrForward(-1);
   tab_observer.Wait();
   CheckResourcesRequested(true);
 }
 
-// Test that reloading with Lo-Fi disabled doesn't call ShouldEnableLoFiMode and
-// already has LOFI_OFF.
-IN_PROC_BROWSER_TEST_F(LoFiResourceDispatcherHostBrowserTest,
-                       ShouldEnableLoFiModeReloadDisableLoFi) {

[nasko, 2016/12/12 23:05:41]

What is the new behavior for when reloading? Can we have a test to ensure it
doesn't break?

[megjablon, 2016/12/13 03:03:14]

Added this back in. It was removed because my previous code moved checking the
lofi/previews state into Chrome, so on reload we would expect GetPreviewsState
to still be called.

-  // Navigate with ShouldEnableLoFiMode returning true.
-  Reset(true);
-  NavigateToURLBlockUntilNavigationsComplete(
-      shell(), embedded_test_server()->GetURL("/page_with_iframe.html"), 1);
-  CheckResourcesRequested(true);
-
-  // Reload with Lo-Fi disabled.
-  Reset(false);
-  TestNavigationObserver tab_observer(shell()->web_contents(), 1);
-  shell()->web_contents()->GetController().ReloadDisableLoFi(true);
-  tab_observer.Wait();
-  CheckResourcesRequested(false);
-}
-
 namespace {
 
 struct RequestDataForDelegate {
   const GURL url;
   const GURL first_party;
   const base::Optional<url::Origin> initiator;
 
   RequestDataForDelegate(const GURL& url,
                          const GURL& first_party,
                          const base::Optional<url::Origin>& initiator)
@@ skipping 264 matching lines @@
   EXPECT_EQ(top_origin, delegate_->data()[2]->initiator);
 
   // Cross-origin subresource requests have a unique first-party, and an
   // initiator that matches the document in which they're embedded.
   EXPECT_EQ(nested_js_url, delegate_->data()[3]->url);
   EXPECT_EQ(kURLWithUniqueOrigin, delegate_->data()[3]->first_party);
   EXPECT_EQ(nested_origin, delegate_->data()[3]->initiator);
 }
 
 }  // namespace content