Record Data Savings for Client-Side LoFi

components/data_reduction_proxy/core/browser/data_reduction_proxy_network_delegate_unittest.cc

 // 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 "components/data_reduction_proxy/core/browser/data_reduction_proxy_network_delegate.h"
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <map>
@@ skipping 116 matching lines @@
 #elif defined(OS_QNX)
 const Client kClient = Client::CHROME_QNX;
 #else
 const Client kClient = Client::UNKNOWN;
 #endif
 
 class TestLoFiDecider : public LoFiDecider {
  public:
   TestLoFiDecider()
       : should_be_client_lofi_(false),
+        should_be_client_lofi_auto_reload_(false),
         should_request_lofi_resource_(false),
         ignore_is_using_data_reduction_proxy_check_(false) {}
   ~TestLoFiDecider() override {}
 
   bool IsUsingLoFi(const net::URLRequest& request) const override {
     return should_request_lofi_resource_;
   }
 
   void SetIsUsingLoFi(bool should_request_lofi_resource) {
     should_request_lofi_resource_ = should_request_lofi_resource;
   }
 
   void SetIsUsingClientLoFi(bool should_be_client_lofi) {
     should_be_client_lofi_ = should_be_client_lofi;
   }
 
+  void SetIsClientLoFiAutoReload(bool should_be_client_lofi_auto_reload) {
+    should_be_client_lofi_auto_reload_ = should_be_client_lofi_auto_reload;
+  }
+
   void MaybeSetAcceptTransformHeader(
       const net::URLRequest& request,
       bool is_previews_disabled,
       net::HttpRequestHeaders* headers) const override {
     if (should_request_lofi_resource_) {
       headers->SetHeader(chrome_proxy_accept_transform_header(),
                          empty_image_directive());
     }
   }
 
@@ skipping 28 matching lines @@
       net::HttpRequestHeaders* headers) const override {}
 
   bool ShouldRecordLoFiUMA(const net::URLRequest& request) const override {
     return should_request_lofi_resource_;
   }
 
   bool IsClientLoFiImageRequest(const net::URLRequest& request) const override {
     return should_be_client_lofi_;
   }
 
+  bool IsClientLoFiAutoReloadRequest(
+      const net::URLRequest& request) const override {
+    return should_be_client_lofi_auto_reload_;
+  }
+
   void ignore_is_using_data_reduction_proxy_check() {
     ignore_is_using_data_reduction_proxy_check_ = true;
   }
 
  private:
   bool should_be_client_lofi_;
+  bool should_be_client_lofi_auto_reload_;
   bool should_request_lofi_resource_;
   bool ignore_is_using_data_reduction_proxy_check_;
 };
 
 class TestLoFiUIService : public LoFiUIService {
  public:
   TestLoFiUIService() : on_lofi_response_(false) {}
   ~TestLoFiUIService() override {}
 
   bool DidNotifyLoFiResponse() const { return on_lofi_response_; }
 
   void OnLoFiReponseReceived(const net::URLRequest& request) override {
     on_lofi_response_ = true;
   }
 
   void ClearResponse() { on_lofi_response_ = false; }
 
  private:
   bool on_lofi_response_;
 };
 
 enum ProxyTestConfig { USE_SECURE_PROXY, USE_INSECURE_PROXY, BYPASS_PROXY };
 
 class DataReductionProxyNetworkDelegateTest : public testing::Test {
  public:
   DataReductionProxyNetworkDelegateTest()
       : context_(true),
         context_storage_(&context_),
+        lofi_decider_(nullptr),
+        lofi_ui_service_(nullptr),
         ssl_socket_data_provider_(net::ASYNC, net::OK) {
     ssl_socket_data_provider_.next_proto = net::kProtoHTTP11;
     ssl_socket_data_provider_.cert = net::ImportCertFromFile(
         net::GetTestCertsDirectory(), "unittest.selfsigned.der");
   }
 
   void Init(ProxyTestConfig proxy_config, bool enable_brotli_globally) {
     net::ProxyServer proxy_server;
     switch (proxy_config) {
       case BYPASS_PROXY:
@@ skipping 1401 matching lines @@
 
   // When the ECT is set to the same value, fetching the same resource should
   // result in a cache hit.
   FetchURLRequestAndVerifyECTHeader(effective_connection_types[0], true, true);
 
   // When the ECT is set to a different value, the response should still be
   // served from the cache.
   FetchURLRequestAndVerifyECTHeader(effective_connection_types[1], true, true);
 }
 
+class DataReductionProxyNetworkDelegateClientLoFiTest : public testing::Test {
+ public:
+  DataReductionProxyNetworkDelegateClientLoFiTest() : baseline_savings_(0) {}
+  ~DataReductionProxyNetworkDelegateClientLoFiTest() override;
+
+  void Reset() {
+    drp_test_context_.reset();
+    mock_socket_factory_.reset();
+    context_storage_.reset();
+
+    context_.reset(new net::TestURLRequestContext(true));
+    context_storage_.reset(new net::URLRequestContextStorage(context_.get()));
+    mock_socket_factory_.reset(new net::MockClientSocketFactory());
+    context_->set_client_socket_factory(mock_socket_factory_.get());
+
+    drp_test_context_ =
+        DataReductionProxyTestContext::Builder()
+            .WithURLRequestContext(context_.get())
+            .WithMockClientSocketFactory(mock_socket_factory_.get())
+            .Build();
+
+    drp_test_context_->AttachToURLRequestContext(context_storage_.get());
+    context_->Init();
+    base::RunLoop().RunUntilIdle();
+
+    baseline_savings_ =
+        drp_test_context()->settings()->GetTotalHttpContentLengthSaved();
+  }
+
+  void SetUpLoFiDecider(bool is_client_lofi_image,
+                        bool is_client_lofi_auto_reload) const {
+    std::unique_ptr<TestLoFiDecider> lofi_decider(new TestLoFiDecider());
+    lofi_decider->SetIsUsingClientLoFi(is_client_lofi_image);
+    lofi_decider->SetIsClientLoFiAutoReload(is_client_lofi_auto_reload);
+    drp_test_context_->io_data()->set_lofi_decider(
+        std::unique_ptr<LoFiDecider>(std::move(lofi_decider)));
+  }
+
+  int64_t GetSavings() const {
+    return drp_test_context()->settings()->GetTotalHttpContentLengthSaved() -
+           baseline_savings_;
+  }
+
+  net::TestURLRequestContext* context() const { return context_.get(); }
+  net::MockClientSocketFactory* mock_socket_factory() const {
+    return mock_socket_factory_.get();
+  }
+  DataReductionProxyTestContext* drp_test_context() const {
+    return drp_test_context_.get();
+  }
+
+ private:
+  base::MessageLoopForIO loop;
+  std::unique_ptr<net::TestURLRequestContext> context_;
+  std::unique_ptr<net::URLRequestContextStorage> context_storage_;
+  std::unique_ptr<net::MockClientSocketFactory> mock_socket_factory_;
+  std::unique_ptr<DataReductionProxyTestContext> drp_test_context_;
+  int64_t baseline_savings_;
+};
+
+DataReductionProxyNetworkDelegateClientLoFiTest::
+    ~DataReductionProxyNetworkDelegateClientLoFiTest() {}
+
+TEST_F(DataReductionProxyNetworkDelegateClientLoFiTest, DataSavingsNonDRP) {
+  const char kSimple200ResponseHeaders[] =
+      "HTTP/1.1 200 OK\r\n"
+      "Content-Length: 140\r\n\r\n";
+
+  const struct {
+    const char* headers;
+    size_t response_length;
+    bool is_client_lofi_image;
+    bool is_client_lofi_auto_reload;
+    int64_t expected_savings;
+  } tests[] = {
+      {kSimple200ResponseHeaders, 140, false, false, 0},

[RyanSturm, 2017/05/10 18:14:09]

nit: Can you comment on some of these test cases (like saying the content is
under 2048 for the first set and maybe some detail on the rest?

[sclittle, 2017/05/10 19:56:37]

Done.

+      {kSimple200ResponseHeaders, 140, true, false, 0},
+      {kSimple200ResponseHeaders, 140, false, true,
+       -(static_cast<int64_t>(sizeof(kSimple200ResponseHeaders) - 1) + 140)},
+      {kSimple200ResponseHeaders, 140, true, true,
+       -(static_cast<int64_t>(sizeof(kSimple200ResponseHeaders) - 1) + 140)},
+
+      {"HTTP/1.1 206 Partial Content\r\n"
+       "Content-Range: bytes 0-2047/10000\r\n"
+       "Content-Length: 2048\r\n\r\n",
+       2048, false, false, 0},
+      {"HTTP/1.1 206 Partial Content\r\n"
+       "Content-Range: bytes 0-2047/10000\r\n"
+       "Content-Length: 2048\r\n\r\n",
+       2048, true, false, 10000 - 2048},
+
+      {"HTTP/1.1 206 Partial Content\r\n"
+       "Content-Range: bytes 0-999/1000\r\n"
+       "Content-Length: 1000\r\n\r\n",
+       1000, true, false, 0},
+      {"HTTP/1.1 206 Partial Content\r\n"
+       "Content-Range: bytes 0-2047/*\r\n"
+       "Content-Length: 2048\r\n\r\n",
+       2048, true, false, 0},
+      {"HTTP/1.1 206 Partial Content\r\n"
+       "Content-Range: invalid_content_range\r\n"
+       "Content-Length: 2048\r\n\r\n",
+       2048, true, false, 0},
+  };
+
+  for (const auto& test : tests) {
+    Reset();
+    SetUpLoFiDecider(test.is_client_lofi_image,
+                     test.is_client_lofi_auto_reload);
+
+    std::string response_body(test.response_length, 'a');
+    net::MockRead reads[] = {net::MockRead(test.headers),
+                             net::MockRead(response_body.c_str()),
+                             net::MockRead(net::ASYNC, net::OK)};
+    net::StaticSocketDataProvider socket(reads, arraysize(reads), nullptr, 0);
+    mock_socket_factory()->AddSocketDataProvider(&socket);
+
+    net::TestDelegate test_delegate;
+    std::unique_ptr<net::URLRequest> request = context()->CreateRequest(
+        GURL("http://example.com"), net::RequestPriority::IDLE, &test_delegate);
+
+    request->Start();
+    base::RunLoop().RunUntilIdle();
+
+    EXPECT_EQ(test.expected_savings, GetSavings()) << (&test - tests);
+  }
+}
+
+TEST_F(DataReductionProxyNetworkDelegateClientLoFiTest, DataSavingsThroughDRP) {
+  Reset();
+  drp_test_context()->EnableDataReductionProxyWithSecureProxyCheckSuccess();
+  SetUpLoFiDecider(true, false);
+
+  const char kHeaders[] =
+      "HTTP/1.1 206 Partial Content\r\n"
+      "Content-Range: bytes 0-2047/10000\r\n"
+      "Content-Length: 2048\r\n"
+      "Via: 1.1 Chrome-Compression-Proxy\r\n"
+      "X-Original-Content-Length: 3000\r\n\r\n";
+
+  std::string response_body(2048, 'a');
+  net::MockRead reads[] = {net::MockRead(kHeaders),
+                           net::MockRead(response_body.c_str()),
+                           net::MockRead(net::ASYNC, net::OK)};
+  net::StaticSocketDataProvider socket(reads, arraysize(reads), nullptr, 0);
+  mock_socket_factory()->AddSocketDataProvider(&socket);
+
+  net::TestDelegate test_delegate;
+  std::unique_ptr<net::URLRequest> request = context()->CreateRequest(
+      GURL("http://example.com"), net::RequestPriority::IDLE, &test_delegate);
+
+  request->Start();
+  base::RunLoop().RunUntilIdle();
+
+  // Since the Data Reduction Proxy is enabled, the length of the raw headers
+  // should be used in the estimated original size. The X-OCL should be ignored.
+  EXPECT_EQ(static_cast<int64_t>(net::HttpUtil::AssembleRawHeaders(
+                                     kHeaders, sizeof(kHeaders) - 1)
+                                     .size() +
+                                 10000 - request->GetTotalReceivedBytes()),
+            GetSavings());
+}
+
 }  // namespace
 
 }  // namespace data_reduction_proxy