Move MimeTypeResourceHandler before ThrottlingResourceHandler

content/browser/loader/mime_sniffing_resource_handler_unittest.cc

Index: content/browser/loader/mime_sniffing_resource_handler_unittest.cc
diff --git a/content/browser/loader/mime_sniffing_resource_handler_unittest.cc b/content/browser/loader/mime_sniffing_resource_handler_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..2c9320e887cb44ec79b46d02fdcbbd5390d5a092
--- /dev/null
+++ b/content/browser/loader/mime_sniffing_resource_handler_unittest.cc
@@ -0,0 +1,489 @@
+// Copyright 2014 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/browser/loader/mime_sniffing_resource_handler.h"
+
+#include <stdint.h>
+
+#include <memory>
+
+#include "base/files/file_path.h"
+#include "base/location.h"
+#include "base/logging.h"
+#include "base/macros.h"
+#include "base/single_thread_task_runner.h"
+#include "base/threading/thread_task_runner_handle.h"
+#include "content/public/browser/resource_controller.h"
+#include "content/public/browser/resource_request_info.h"
+#include "content/public/common/resource_response.h"
+#include "content/public/common/webplugininfo.h"
+#include "content/public/test/test_browser_thread_bundle.h"
+#include "content/public/test/test_utils.h"
+#include "net/url_request/url_request_context.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "url/gurl.h"
+
+namespace content {
+
+namespace {
+
+class TestResourceHandler : public ResourceHandler {
+ public:
+  TestResourceHandler(bool response_started,
+                      bool defer_response_started,
+                      bool will_read,
+                      bool read_completed,
+                      bool defer_read_completed)
+      : ResourceHandler(nullptr),
+        buffer_(new net::IOBuffer(2048)),
+        response_started_(response_started),
+        defer_response_started_(defer_response_started),
+        will_read_(will_read),
+        read_completed_(read_completed),
+        defer_read_completed_(defer_read_completed) {}
+
+  void SetController(ResourceController* controller) override {}
+
+  bool OnRequestRedirected(const net::RedirectInfo& redirect_info,
+                           ResourceResponse* response,
+                           bool* defer) override {
+    NOTREACHED();
+    return false;
+  }
+
+  bool OnResponseStarted(ResourceResponse* response, bool* defer) override {
+    if (defer_response_started_)
+      *defer = true;
+    return response_started_;
+  }
+
+  bool OnWillStart(const GURL& url, bool* defer) override { return false; }
+
+  bool OnBeforeNetworkStart(const GURL& url, bool* defer) override {
+    NOTREACHED();
+    return false;
+  }
+
+  bool OnWillRead(scoped_refptr<net::IOBuffer>* buf,
+                  int* buf_size,
+                  int min_size) override {
+    *buf = buffer_;
+    *buf_size = 2048;
+    return will_read_;
+  }
+
+  bool OnReadCompleted(int bytes_read, bool* defer) override {
+    DCHECK_LT(bytes_read, 2048);
+    if (defer_read_completed_)
+      *defer = true;
+    return read_completed_;
+  }
+
+  void OnResponseCompleted(const net::URLRequestStatus& status,
+                           const std::string& security_info,
+                           bool* defer) override {}
+
+  void OnDataDownloaded(int bytes_downloaded) override { NOTREACHED(); }
+
+  scoped_refptr<net::IOBuffer> buffer() { return buffer_; }
+
+ private:
+  scoped_refptr<net::IOBuffer> buffer_;
+  bool response_started_;
+  bool defer_response_started_;
+  bool will_read_;
+  bool read_completed_;
+  bool defer_read_completed_;
+  DISALLOW_COPY_AND_ASSIGN(TestResourceHandler);
+};
+
+}  // namespace
+
+class TestResourceController : public ResourceController {
+ public:
+  TestResourceController() : cancel_called_(0), resume_called_(0) {}
+  void Cancel() override { cancel_called_++; }
+
+  void CancelAndIgnore() override { NOTREACHED(); }
+
+  void CancelWithError(int error_code) override { NOTREACHED(); }
+
+  void Resume() override { resume_called_++; }
+
+  int cancel_called() const { return cancel_called_; }
+  int resume_called() const { return resume_called_; }
+
+ private:
+  int cancel_called_;
+  int resume_called_;
+};
+
+class MimeSniffingResourceHandlerTest : public testing::Test {
+ public:
+  MimeSniffingResourceHandlerTest() {}
+
+  std::string TestAcceptHeaderSetting(ResourceType request_resource_type);
+  std::string TestAcceptHeaderSettingWithURLRequest(
+      ResourceType request_resource_type,
+      net::URLRequest* request);
+
+  // Tests the operation of the MimeSniffingHandler when it needs to buffer
+  // data.
+  void TestHandlerSniffing(bool response_started,
+                           bool defer_response_started,
+                           bool will_read,
+                           bool read_completed,
+                           bool defer_read_completed);
+
+  // Tests the operation of the MimeSniffingHandler when it doesn't buffer
+  // data.
+  void TestHandlerNoSniffing(bool response_started,
+                             bool defer_response_started,
+                             bool will_read,
+                             bool read_completed,
+                             bool defer_read_completed);
+
+ private:
+  TestBrowserThreadBundle thread_bundle_;
+};
+
+std::string MimeSniffingResourceHandlerTest::TestAcceptHeaderSetting(
+    ResourceType request_resource_type) {
+  net::URLRequestContext context;
+  std::unique_ptr<net::URLRequest> request(context.CreateRequest(
+      GURL("http://www.google.com"), net::DEFAULT_PRIORITY, nullptr));
+  return TestAcceptHeaderSettingWithURLRequest(request_resource_type,
+                                               request.get());
+}
+
+std::string
+MimeSniffingResourceHandlerTest::TestAcceptHeaderSettingWithURLRequest(
+    ResourceType request_resource_type,
+    net::URLRequest* request) {
+  bool is_main_frame = request_resource_type == RESOURCE_TYPE_MAIN_FRAME;
+  ResourceRequestInfo::AllocateForTesting(request, request_resource_type,
+                                          nullptr,        // context
+                                          0,              // render_process_id
+                                          0,              // render_view_id
+                                          0,              // render_frame_id
+                                          is_main_frame,  // is_main_frame
+                                          false,   // parent_is_main_frame
+                                          false,   // allow_download
+                                          true,    // is_async
+                                          false);  // is_using_lofi
+
+  std::unique_ptr<ResourceHandler> mime_sniffing_handler(
+      new MimeSniffingResourceHandler(
+          std::unique_ptr<ResourceHandler>(
+              new TestResourceHandler(false, false, false, false, false)),
+          request));
+
+  bool defer = false;
+  mime_sniffing_handler->OnWillStart(request->url(), &defer);
+  content::RunAllPendingInMessageLoop();
+
+  std::string accept_header;
+  request->extra_request_headers().GetHeader("Accept", &accept_header);
+  return accept_header;
+}
+
+void MimeSniffingResourceHandlerTest::TestHandlerSniffing(
+    bool response_started,
+    bool defer_response_started,
+    bool will_read,
+    bool read_completed,
+    bool defer_read_completed) {
+  net::URLRequestContext context;
+  std::unique_ptr<net::URLRequest> request(context.CreateRequest(
+      GURL("http://www.google.com"), net::DEFAULT_PRIORITY, nullptr));
+  ResourceRequestInfo::AllocateForTesting(request.get(),
+                                          RESOURCE_TYPE_MAIN_FRAME,
+                                          nullptr,  // context
+                                          0,        // render_process_id
+                                          0,        // render_view_id
+                                          0,        // render_frame_id
+                                          true,     // is_main_frame
+                                          false,    // parent_is_main_frame
+                                          false,    // allow_download
+                                          true,     // is_async
+                                          false);   // is_using_lofi
+
+  std::unique_ptr<ResourceHandler> handler(new MimeSniffingResourceHandler(
+      std::unique_ptr<ResourceHandler>(new TestResourceHandler(
+          response_started, defer_response_started, will_read, read_completed,
+          defer_read_completed)),
+      request.get()));
+  MimeSniffingResourceHandler* mime_sniffing_handler =
+      static_cast<MimeSniffingResourceHandler*>(handler.get());
+
+  TestResourceController resource_controller;
+  mime_sniffing_handler->SetController(&resource_controller);
+
+  // The response should be sniffed.
+  scoped_refptr<ResourceResponse> response(new ResourceResponse);
+  response->head.mime_type.assign("text/plain");
+
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_STARTING,
+           mime_sniffing_handler->state_);
+
+  // Simulate the response starting. We should start buffering, so the return
+  // value should always be true.
+  bool defer = false;
+  CHECK_EQ(true,
+           mime_sniffing_handler->OnResponseStarted(response.get(), &defer));
+  CHECK_EQ(0, resource_controller.cancel_called());
+  CHECK_EQ(0, resource_controller.resume_called());
+  CHECK_EQ(false, defer);
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_BUFFERING,
+           mime_sniffing_handler->state_);
+
+  // Read some data to sniff the mime type. This will ask the next
+  // ResourceHandler for a buffer.
+  scoped_refptr<net::IOBuffer> read_buffer;
+  int buf_size = 0;
+  CHECK_EQ(will_read,
+           mime_sniffing_handler->OnWillRead(&read_buffer, &buf_size, -1));
+  CHECK_EQ(0, resource_controller.cancel_called());
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_BUFFERING,
+           mime_sniffing_handler->state_);
+
+  if (!will_read)
+    return;
+
+  // Simulate an HTML page. The mime sniffer will identify the MimeType and
+  // proceed with replay.
+  char data[] = "!DOCTYPE html\n<head>\n<title>Foo</title>\n</head>";
+  memcpy(read_buffer->data(), data, sizeof(data));
+
+  defer = false;
+  bool return_value =
+      mime_sniffing_handler->OnReadCompleted(sizeof(data), &defer);
+
+  // If the next handler cancels the response start, we hsould be notified
+  // immediately.
+  if (!response_started) {
+    CHECK_EQ(response_started, return_value);
+    CHECK_EQ(0, resource_controller.cancel_called());
+    return;
+  }
+
+  // The replay can be deferred both at response started and read replay
+  // stages.
+  CHECK_EQ(defer, defer_response_started || defer_read_completed);
+  if (defer_response_started) {
+    CHECK_EQ(true, defer);
+    CHECK_EQ(true, return_value);
+    CHECK_EQ(MimeSniffingResourceHandler::STATE_REPLAYING_RESPONSE_RECEIVED,
+             mime_sniffing_handler->state_);
+    mime_sniffing_handler->Resume();
+  }
+
+  // The body that was sniffed should be transmitted to the next handler. This
+  // may cancel the request.
+  if (!read_completed) {
+    if (defer_response_started) {
+      CHECK_EQ(1, resource_controller.cancel_called());
+    } else {
+      CHECK_EQ(0, resource_controller.cancel_called());
+      CHECK_EQ(false, return_value);
+    }
+    return;
+  }
+
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_STREAMING,
+           mime_sniffing_handler->state_);
+
+  // The request may be deferred by the next handler once the read is done.
+  if (defer_read_completed) {
+    CHECK_EQ(true, defer);
+    mime_sniffing_handler->Resume();
+  }
+
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_STREAMING,
+           mime_sniffing_handler->state_);
+  CHECK_EQ(0, resource_controller.cancel_called());
+
+  // Even if the next handler defers the request twice, the
+  // MimeSniffingResourceHandler should only call Resume on its controller
+  // once.
+  if (defer_response_started || defer_read_completed)
+    CHECK_EQ(1, resource_controller.resume_called());
+  else
+    CHECK_EQ(0, resource_controller.resume_called());
+}
+
+void MimeSniffingResourceHandlerTest::TestHandlerNoSniffing(
+    bool response_started,
+    bool defer_response_started,
+    bool will_read,
+    bool read_completed,
+    bool defer_read_completed) {
+  net::URLRequestContext context;
+  std::unique_ptr<net::URLRequest> request(context.CreateRequest(
+      GURL("http://www.google.com"), net::DEFAULT_PRIORITY, nullptr));
+  ResourceRequestInfo::AllocateForTesting(request.get(),
+                                          RESOURCE_TYPE_MAIN_FRAME,
+                                          nullptr,  // context
+                                          0,        // render_process_id
+                                          0,        // render_view_id
+                                          0,        // render_frame_id
+                                          true,     // is_main_frame
+                                          false,    // parent_is_main_frame
+                                          false,    // allow_download
+                                          true,     // is_async
+                                          false);   // is_using_lofi
+
+  std::unique_ptr<ResourceHandler> handler(new MimeSniffingResourceHandler(
+      std::unique_ptr<ResourceHandler>(new TestResourceHandler(
+          response_started, defer_response_started, will_read, read_completed,
+          defer_read_completed)),
+      request.get()));
+  MimeSniffingResourceHandler* mime_sniffing_handler =
+      static_cast<MimeSniffingResourceHandler*>(handler.get());
+
+  TestResourceController resource_controller;
+  mime_sniffing_handler->SetController(&resource_controller);
+  int expected_resume_calls = 0;
+
+  // The response should not be sniffed.
+  scoped_refptr<ResourceResponse> response(new ResourceResponse);
+  response->head.mime_type.assign("text/html");
+
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_STARTING,
+           mime_sniffing_handler->state_);
+
+  // Simulate the response starting. There should be no need for buffering, so
+  // the return value should be that of the next handler.
+  bool defer = false;
+  CHECK_EQ(response_started,
+           mime_sniffing_handler->OnResponseStarted(response.get(), &defer));
+  CHECK_EQ(0, resource_controller.cancel_called());
+
+  if (!response_started)
+    return;
+
+  CHECK_EQ(defer_response_started, defer);
+  if (defer) {
+    CHECK_EQ(MimeSniffingResourceHandler::STATE_REPLAYING_RESPONSE_RECEIVED,
+             mime_sniffing_handler->state_);
+    expected_resume_calls++;
+    mime_sniffing_handler->Resume();
+  }
+
+  CHECK_EQ(expected_resume_calls, resource_controller.resume_called());
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_STREAMING,
+           mime_sniffing_handler->state_);
+
+  // The MimeSniffingResourceHandler should be acting as a pass-through
+  // ResourceHandler.
+  scoped_refptr<net::IOBuffer> read_buffer;
+  int buf_size = 0;
+  CHECK_EQ(will_read,
+           mime_sniffing_handler->OnWillRead(&read_buffer, &buf_size, -1));
+  CHECK_EQ(0, resource_controller.cancel_called());
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_STREAMING,
+           mime_sniffing_handler->state_);
+
+  if (!will_read)
+    return;
+
+  defer = false;
+  CHECK_EQ(read_completed,
+           mime_sniffing_handler->OnReadCompleted(2000, &defer));
+  CHECK_EQ(0, resource_controller.cancel_called());
+  CHECK_EQ(MimeSniffingResourceHandler::STATE_STREAMING,
+           mime_sniffing_handler->state_);
+
+  if (!read_completed)
+    return;
+
+  CHECK_EQ(defer_read_completed, defer);
+  if (defer) {
+    expected_resume_calls++;
+    mime_sniffing_handler->Resume();
+  }
+  CHECK_EQ(expected_resume_calls, resource_controller.resume_called());
+}
+
+// Test that the proper Accept: header is set based on the ResourceType
+TEST_F(MimeSniffingResourceHandlerTest, AcceptHeaders) {
+  EXPECT_EQ(
+      "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,"
+      "*/*;q=0.8",
+      TestAcceptHeaderSetting(RESOURCE_TYPE_MAIN_FRAME));
+  EXPECT_EQ(
+      "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,"
+      "*/*;q=0.8",
+      TestAcceptHeaderSetting(RESOURCE_TYPE_SUB_FRAME));
+  EXPECT_EQ("text/css,*/*;q=0.1",
+            TestAcceptHeaderSetting(RESOURCE_TYPE_STYLESHEET));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_SCRIPT));
+  EXPECT_EQ("image/webp,image/*,*/*;q=0.8",
+            TestAcceptHeaderSetting(RESOURCE_TYPE_IMAGE));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_FONT_RESOURCE));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_SUB_RESOURCE));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_OBJECT));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_MEDIA));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_WORKER));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_SHARED_WORKER));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_PREFETCH));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_FAVICON));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_XHR));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_PING));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_SERVICE_WORKER));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_CSP_REPORT));
+  EXPECT_EQ("*/*", TestAcceptHeaderSetting(RESOURCE_TYPE_PLUGIN_RESOURCE));
+
+  // Ensure that if an Accept header is already set, it is not overwritten.
+  net::URLRequestContext context;
+  std::unique_ptr<net::URLRequest> request(context.CreateRequest(
+      GURL("http://www.google.com"), net::DEFAULT_PRIORITY, nullptr));
+  request->SetExtraRequestHeaderByName("Accept", "*", true);
+  EXPECT_EQ("*", TestAcceptHeaderSettingWithURLRequest(RESOURCE_TYPE_XHR,
+                                                       request.get()));
+}
+
+// Test that the MimeSniffingHandler operates properly when it doesn't sniff
+// resources.
+TEST_F(MimeSniffingResourceHandlerTest, NoSniffing) {
+  // Test simple case.
+  TestHandlerNoSniffing(true, false, true, true, false);
+
+  // Test deferral in OnResponseStarted and/or in OnReadCompleted.
+  TestHandlerNoSniffing(true, true, true, true, false);
+  TestHandlerNoSniffing(true, false, true, true, true);
+  TestHandlerNoSniffing(true, true, true, true, true);
+
+  // Test cancel in OnResponseStarted, OnWillRead, OnReadCompleted.
+  TestHandlerNoSniffing(false, false, false, false, false);
+  TestHandlerNoSniffing(true, false, false, false, false);
+  TestHandlerNoSniffing(true, false, true, false, false);
+
+  // Test cancel after OnResponseStarted deferral.
+  TestHandlerNoSniffing(true, true, false, false, false);
+  TestHandlerNoSniffing(true, true, true, false, false);
+}
+
+// Test that the MimeSniffingHandler operates properly when it sniffs
+// resources.
+TEST_F(MimeSniffingResourceHandlerTest, Sniffing) {
+  // Test simple case.
+  TestHandlerSniffing(true, false, true, true, false);
+
+  // Test deferral in OnResponseStarted and/or in OnReadCompleted.
+  TestHandlerSniffing(true, true, true, true, false);
+  TestHandlerSniffing(true, false, true, true, true);
+  TestHandlerSniffing(true, true, true, true, true);
+
+  // Test cancel in OnResponseStarted, OnWillRead, OnReadCompleted.
+  TestHandlerSniffing(false, false, false, false, false);
+  TestHandlerSniffing(true, false, false, false, false);
+  TestHandlerSniffing(true, false, true, false, false);
+
+  // Test cancel after OnResponseStarted deferral.
+  TestHandlerSniffing(true, true, false, false, false);
+  TestHandlerSniffing(true, true, true, false, false);
+}
+
+}  // namespace content