Move URLLoaderClientImpl to a separate file

content/child/url_loader_client_impl_unittest.cc

+// Copyright 2016 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/child/url_loader_client_impl.h"
+
+#include "base/memory/ptr_util.h"
+#include "base/message_loop/message_loop.h"
+#include "base/run_loop.h"
+#include "content/child/resource_dispatcher.h"
+#include "content/child/test_request_peer.h"
+#include "content/common/url_loader_factory.mojom.h"
+#include "ipc/ipc_sender.h"
+#include "mojo/public/cpp/bindings/associated_interface_ptr_info.h"
+#include "mojo/public/cpp/bindings/binding.h"
+#include "net/url_request/redirect_info.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace content {
+
+class URLLoaderClientImplTest : public ::testing::Test,
+                                IPC::Sender,
+                                mojom::URLLoaderFactory {
+ protected:
+  URLLoaderClientImplTest()
+      : dispatcher_(new ResourceDispatcher(this, message_loop_.task_runner())),
+        mojo_binding_(this) {
+    url_loader_factory_proxy_ = mojo_binding_.CreateInterfacePtrAndBind();
+
+    request_id_ = dispatcher_->StartAsync(
+        base::MakeUnique<ResourceRequest>(), 0, nullptr, url::Origin(),
+        base::MakeUnique<TestRequestPeer>(dispatcher_.get(),
+                                          &request_peer_context_),
+        blink::WebURLRequest::LoadingIPCType::Mojo,
+        url_loader_factory_proxy_.get(),
+        url_loader_factory_proxy_.associated_group());
+    request_peer_context_.request_id = request_id_;
+
+    base::RunLoop().RunUntilIdle();
+    EXPECT_TRUE(url_loader_client_);
+  }
+
+  void TearDown() override {
+    url_loader_client_ = nullptr;
+    url_loader_factory_proxy_ = nullptr;
+  }
+
+  bool Send(IPC::Message* message) override {
+    ADD_FAILURE() << "IPC::Sneder::Send should not be called.";

[kinuko, 2016/12/22 07:54:48]

Sneder -> Sender

[yhirano, 2016/12/22 08:03:32]

Done.

+    return false;
+  }
+
+  void CreateLoaderAndStart(
+      mojom::URLLoaderAssociatedRequest request,
+      int32_t routing_id,
+      int32_t request_id,
+      const ResourceRequest& url_request,
+      mojom::URLLoaderClientAssociatedPtrInfo client_ptr_info) override {
+    url_loader_client_.Bind(std::move(client_ptr_info));
+  }
+
+  void SyncLoad(int32_t routing_id,
+                int32_t request_id,
+                const ResourceRequest& request,
+                const SyncLoadCallback& callback) override {
+    NOTREACHED();
+  }
+
+  static MojoCreateDataPipeOptions dataPipeOptions() {

[kinuko, 2016/12/22 07:54:48]

DataPipeOptions()

[yhirano, 2016/12/22 08:03:32]

Done.

+    MojoCreateDataPipeOptions options;
+    options.struct_size = sizeof(MojoCreateDataPipeOptions);
+    options.flags = MOJO_CREATE_DATA_PIPE_OPTIONS_FLAG_NONE;
+    options.element_num_bytes = 1;
+    options.capacity_num_bytes = 4096;
+    return options;
+  }
+
+  base::MessageLoop message_loop_;
+  std::unique_ptr<ResourceDispatcher> dispatcher_;
+  TestRequestPeer::Context request_peer_context_;
+  int request_id_ = 0;
+  mojom::URLLoaderClientAssociatedPtr url_loader_client_;
+  mojom::URLLoaderFactoryPtr url_loader_factory_proxy_;
+  mojo::Binding<mojom::URLLoaderFactory> mojo_binding_;
+};
+
+TEST_F(URLLoaderClientImplTest, OnReceiveResponse) {
+  ResourceResponseHead response_head;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+}
+
+TEST_F(URLLoaderClientImplTest, ResponseBody) {
+  ResourceResponseHead response_head;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+
+  mojo::DataPipe data_pipe(dataPipeOptions());
+  url_loader_client_->OnStartLoadingResponseBody(
+      std::move(data_pipe.consumer_handle));
+  uint32_t size = 5;
+  MojoResult result =
+      mojo::WriteDataRaw(data_pipe.producer_handle.get(), "hello", &size,
+                         MOJO_WRITE_DATA_FLAG_NONE);
+  ASSERT_EQ(MOJO_RESULT_OK, result);
+  EXPECT_EQ(5u, size);
+
+  base::RunLoop().RunUntilIdle();
+  EXPECT_EQ("hello", request_peer_context_.data);
+}
+
+// OnStartLoadingResponseBody can be called before OnReceiveResponse. Because
+// of the lack of the ordering guarantee between the message channel and the
+// data pipe, bytes can arrive before OnReceiveResponse. URLLoaderClientImpl
+// should restore the order.
+TEST_F(URLLoaderClientImplTest, ResponseBodyShouldComeAfterResponse) {
+  ResourceResponseHead response_head;
+
+  mojo::DataPipe data_pipe(dataPipeOptions());
+  url_loader_client_->OnStartLoadingResponseBody(
+      std::move(data_pipe.consumer_handle));
+  uint32_t size = 5;
+  MojoResult result =
+      mojo::WriteDataRaw(data_pipe.producer_handle.get(), "hello", &size,
+                         MOJO_WRITE_DATA_FLAG_NONE);
+  ASSERT_EQ(MOJO_RESULT_OK, result);
+  EXPECT_EQ(5u, size);
+
+  base::RunLoop().RunUntilIdle();
+  EXPECT_EQ("", request_peer_context_.data);
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_EQ("", request_peer_context_.data);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_EQ("hello", request_peer_context_.data);
+}
+
+TEST_F(URLLoaderClientImplTest, OnReceiveRedirect) {
+  ResourceResponseHead response_head;
+  net::RedirectInfo redirect_info;
+
+  url_loader_client_->OnReceiveRedirect(redirect_info, response_head);
+
+  EXPECT_EQ(0, request_peer_context_.seen_redirects);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_EQ(1, request_peer_context_.seen_redirects);
+}
+
+TEST_F(URLLoaderClientImplTest, OnDataDownloaded) {
+  ResourceResponseHead response_head;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  url_loader_client_->OnDataDownloaded(8, 13);
+  url_loader_client_->OnDataDownloaded(2, 1);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_EQ(0, request_peer_context_.total_downloaded_data_length);
+  EXPECT_EQ(0, request_peer_context_.total_encoded_data_length);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_EQ(10, request_peer_context_.total_downloaded_data_length);
+  EXPECT_EQ(14, request_peer_context_.total_encoded_data_length);
+}
+
+TEST_F(URLLoaderClientImplTest, OnTransferSizeUpdated) {
+  ResourceResponseHead response_head;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  url_loader_client_->OnTransferSizeUpdated(4);
+  url_loader_client_->OnTransferSizeUpdated(4);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_EQ(0, request_peer_context_.total_encoded_data_length);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_EQ(8, request_peer_context_.total_encoded_data_length);
+}
+
+TEST_F(URLLoaderClientImplTest, OnCompleteWithoutResponseBody) {
+  ResourceResponseHead response_head;
+  ResourceRequestCompletionStatus completion_status;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  url_loader_client_->OnComplete(completion_status);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_FALSE(request_peer_context_.complete);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_TRUE(request_peer_context_.complete);
+}
+
+TEST_F(URLLoaderClientImplTest, OnCompleteWithResponseBody) {
+  ResourceResponseHead response_head;
+  ResourceRequestCompletionStatus completion_status;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  mojo::DataPipe data_pipe(dataPipeOptions());
+  url_loader_client_->OnStartLoadingResponseBody(
+      std::move(data_pipe.consumer_handle));
+  uint32_t size = 5;
+  MojoResult result =
+      mojo::WriteDataRaw(data_pipe.producer_handle.get(), "hello", &size,
+                         MOJO_WRITE_DATA_FLAG_NONE);
+  ASSERT_EQ(MOJO_RESULT_OK, result);
+  EXPECT_EQ(5u, size);
+  data_pipe.producer_handle.reset();
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_EQ("", request_peer_context_.data);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_EQ("hello", request_peer_context_.data);
+
+  url_loader_client_->OnComplete(completion_status);
+
+  EXPECT_FALSE(request_peer_context_.complete);
+  base::RunLoop().RunUntilIdle();
+
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_EQ("hello", request_peer_context_.data);
+  EXPECT_TRUE(request_peer_context_.complete);
+}
+
+// Due to the lack of ordering guarantee, it is possible that the response body
+// bytes arrives after the completion message. URLLoaderClientImpl should
+// restore the order.
+TEST_F(URLLoaderClientImplTest, OnCompleteShouldBeTheLastMessage) {
+  ResourceResponseHead response_head;
+  ResourceRequestCompletionStatus completion_status;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  mojo::DataPipe data_pipe(dataPipeOptions());
+  url_loader_client_->OnStartLoadingResponseBody(
+      std::move(data_pipe.consumer_handle));
+  url_loader_client_->OnComplete(completion_status);
+
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_FALSE(request_peer_context_.complete);
+
+  uint32_t size = 5;
+  MojoResult result =
+      mojo::WriteDataRaw(data_pipe.producer_handle.get(), "hello", &size,
+                         MOJO_WRITE_DATA_FLAG_NONE);
+  ASSERT_EQ(MOJO_RESULT_OK, result);
+  EXPECT_EQ(5u, size);
+
+  base::RunLoop().RunUntilIdle();
+  EXPECT_EQ("hello", request_peer_context_.data);
+  EXPECT_FALSE(request_peer_context_.complete);
+
+  data_pipe.producer_handle.reset();
+  base::RunLoop().RunUntilIdle();
+  EXPECT_EQ("hello", request_peer_context_.data);
+  EXPECT_TRUE(request_peer_context_.complete);
+}
+
+// Cancelling a request in a client method should be handled correctly.
+TEST_F(URLLoaderClientImplTest, Cancel1) {
+  request_peer_context_.cancel_on_receive_response = true;
+
+  ResourceResponseHead response_head;
+  ResourceRequestCompletionStatus completion_status;
+
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  mojo::DataPipe data_pipe(dataPipeOptions());
+  url_loader_client_->OnStartLoadingResponseBody(
+      std::move(data_pipe.consumer_handle));
+  url_loader_client_->OnComplete(completion_status);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_FALSE(request_peer_context_.complete);
+  EXPECT_FALSE(request_peer_context_.cancelled);
+
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_FALSE(request_peer_context_.complete);
+  EXPECT_TRUE(request_peer_context_.cancelled);
+}
+
+// Cancelling a request in a client method should be handled correctly.
+TEST_F(URLLoaderClientImplTest, Cancel2) {

[kinuko, 2016/12/22 07:54:48]

Could Cancel1, Cancel2, Cancel3 be given slightly more descriptive names?

[yhirano, 2016/12/22 08:03:32]

Done.

+  request_peer_context_.cancel_on_receive_response = true;
+
+  ResourceResponseHead response_head;
+  ResourceRequestCompletionStatus completion_status;
+
+  mojo::DataPipe data_pipe(dataPipeOptions());
+  uint32_t size = 5;
+  MojoResult result =
+      mojo::WriteDataRaw(data_pipe.producer_handle.get(), "hello", &size,
+                         MOJO_WRITE_DATA_FLAG_NONE);
+  ASSERT_EQ(MOJO_RESULT_OK, result);
+  EXPECT_EQ(5u, size);
+
+  url_loader_client_->OnStartLoadingResponseBody(
+      std::move(data_pipe.consumer_handle));
+  base::RunLoop().RunUntilIdle();
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  url_loader_client_->OnComplete(completion_status);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_FALSE(request_peer_context_.complete);
+  EXPECT_FALSE(request_peer_context_.cancelled);
+
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_FALSE(request_peer_context_.complete);
+  EXPECT_TRUE(request_peer_context_.cancelled);
+}
+
+// Cancelling a request in a client method should be handled correctly.
+TEST_F(URLLoaderClientImplTest, Cancel3) {
+  request_peer_context_.cancel_on_receive_data = true;
+
+  ResourceResponseHead response_head;
+  ResourceRequestCompletionStatus completion_status;
+
+  mojo::DataPipe data_pipe(dataPipeOptions());
+  uint32_t size = 5;
+  MojoResult result =
+      mojo::WriteDataRaw(data_pipe.producer_handle.get(), "hello", &size,
+                         MOJO_WRITE_DATA_FLAG_NONE);
+  ASSERT_EQ(MOJO_RESULT_OK, result);
+  EXPECT_EQ(5u, size);
+
+  url_loader_client_->OnStartLoadingResponseBody(
+      std::move(data_pipe.consumer_handle));
+  base::RunLoop().RunUntilIdle();
+  url_loader_client_->OnReceiveResponse(response_head, nullptr);
+  url_loader_client_->OnComplete(completion_status);
+
+  EXPECT_FALSE(request_peer_context_.received_response);
+  EXPECT_EQ("", request_peer_context_.data);
+  EXPECT_FALSE(request_peer_context_.complete);
+  EXPECT_FALSE(request_peer_context_.cancelled);
+
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(request_peer_context_.received_response);
+  EXPECT_EQ("hello", request_peer_context_.data);
+  EXPECT_FALSE(request_peer_context_.complete);
+  EXPECT_TRUE(request_peer_context_.cancelled);
+}
+
+}  // namespace content