Adding opt out and previews type information to DRP pingback

chrome/browser/page_load_metrics/observers/data_reduction_proxy_metrics_observer_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 "chrome/browser/page_load_metrics/observers/data_reduction_proxy_metrics_observer.h"
 
 #include <stdint.h>
 
 #include <functional>
 #include <memory>
@@ skipping 34 matching lines @@
   return data;
 }
 
 // Pingback client responsible for recording the timing information it receives
 // from a SendPingback call.
 class TestPingbackClient
     : public data_reduction_proxy::DataReductionProxyPingbackClient {
  public:
   TestPingbackClient()
       : data_reduction_proxy::DataReductionProxyPingbackClient(nullptr),
+        tab_identifier_key_(nullptr),
         send_pingback_called_(false) {}
   ~TestPingbackClient() override {}
 
   void SendPingback(
       const data_reduction_proxy::DataReductionProxyData& data,
-      const data_reduction_proxy::DataReductionProxyPageLoadTiming& timing)
-      override {
+      const data_reduction_proxy::DataReductionProxyPageLoadTiming& timing,
+      const void* tab_identifier_key) override {
     timing_.reset(
         new data_reduction_proxy::DataReductionProxyPageLoadTiming(timing));
     send_pingback_called_ = true;
+    data_ = data.DeepCopy();
+    tab_identifier_key_ = tab_identifier_key;

[bengr, 2017/04/20 17:36:18]

Which cases will have no tab identifier key? Document somewhere, and is that ok?

[RyanSturm, 2017/04/20 20:25:44]

Acknowledged.

   }
 
   data_reduction_proxy::DataReductionProxyPageLoadTiming* timing() const {
     return timing_.get();
   }
 
+  const data_reduction_proxy::DataReductionProxyData& data() const {
+    return *data_;
+  }
+
+  const void* tab_identifier_key() const { return tab_identifier_key_; }
+
   bool send_pingback_called() const { return send_pingback_called_; }
 
   void Reset() {
     send_pingback_called_ = false;
     timing_.reset();
   }
 
  private:
   std::unique_ptr<data_reduction_proxy::DataReductionProxyPageLoadTiming>
       timing_;
+  std::unique_ptr<data_reduction_proxy::DataReductionProxyData> data_;
+  const void* tab_identifier_key_;
   bool send_pingback_called_;
 
   DISALLOW_COPY_AND_ASSIGN(TestPingbackClient);
 };
 
 }  // namespace
 
 // DataReductionProxyMetricsObserver responsible for modifying data about the
 // navigation in OnCommit. It is also responsible for using a passed in
 // DataReductionProxyPingbackClient instead of the default.
@@ skipping 80 matching lines @@
     if (expected && actual) {
       EXPECT_EQ(expected.value(), actual.value());
     } else {
       EXPECT_TRUE(!expected);
       EXPECT_TRUE(!actual);
     }
   }
 
   void ValidateTimes() {
     EXPECT_TRUE(pingback_client_->send_pingback_called());
+    EXPECT_EQ(static_cast<void*>(web_contents()),
+              pingback_client_->tab_identifier_key());
     EXPECT_EQ(timing_.navigation_start,
               pingback_client_->timing()->navigation_start);
     ExpectEqualOrUnset(timing_.first_contentful_paint,
               pingback_client_->timing()->first_contentful_paint);
     ExpectEqualOrUnset(
         timing_.first_meaningful_paint,
         pingback_client_->timing()->experimental_first_meaningful_paint);
     ExpectEqualOrUnset(timing_.response_start,
               pingback_client_->timing()->response_start);
     ExpectEqualOrUnset(timing_.load_event_start,
               pingback_client_->timing()->load_event_start);
     ExpectEqualOrUnset(timing_.first_image_paint,
               pingback_client_->timing()->first_image_paint);
   }
 
+  void ValidateLoFiInPingback(bool lofi_expected) {
+    EXPECT_TRUE(pingback_client_->send_pingback_called());
+    EXPECT_EQ(lofi_expected, pingback_client_->data().lofi_received());
+  }
+
   void ValidateHistograms() {
     ValidateHistogramsForSuffix(
         internal::kHistogramDOMContentLoadedEventFiredSuffix,
         timing_.dom_content_loaded_event_start);
     ValidateHistogramsForSuffix(internal::kHistogramFirstLayoutSuffix,
                                 timing_.first_layout);
     ValidateHistogramsForSuffix(internal::kHistogramLoadEventFiredSuffix,
                                 timing_.load_event_start);
     ValidateHistogramsForSuffix(internal::kHistogramFirstContentfulPaintSuffix,
                                 timing_.first_contentful_paint);
@@ skipping 182 matching lines @@
   timing_.first_meaningful_paint = base::nullopt;
   RunTestAndNavigateToUntrackedUrl(true, false);
   ValidateTimes();
 
   ResetTest();
   // Verify that when data reduction proxy was used but load event start is
   // unset, SendPingback is not called.
   timing_.load_event_start = base::nullopt;
   RunTestAndNavigateToUntrackedUrl(true, false);
   ValidateTimes();
+  ValidateLoFiInPingback(false);
+
+  ResetTest();
+
+  // Verify LoFi is tracked when a LoFi response is received.
+  page_load_metrics::ExtraRequestInfo resource = {
+      true /*was_cached*/, 1024 * 40 /* raw_body_bytes */,
+      false /* data_reduction_proxy_used*/, true /*  was_lofi_response */,
+      0 /* original_network_content_length */};
+
+  RunTest(true, false);
+  SimulateLoadedResource(resource);
+  NavigateToUntrackedUrl();
+  ValidateTimes();
+  ValidateLoFiInPingback(true);
 
   ResetTest();
   // Verify that when data reduction proxy was not used, SendPingback is not
   // called.
   RunTestAndNavigateToUntrackedUrl(false, false);
   EXPECT_FALSE(pingback_client_->send_pingback_called());
 
   ResetTest();
   // Verify that when the holdback experiment is enabled, no pingback is sent.
   base::FieldTrialList field_trial_list(nullptr);
   ASSERT_TRUE(base::FieldTrialList::CreateFieldTrial(
       "DataCompressionProxyHoldback", "Enabled"));
   RunTestAndNavigateToUntrackedUrl(true, false);
   EXPECT_FALSE(pingback_client_->send_pingback_called());
 }
 
 TEST_F(DataReductionProxyMetricsObserverTest, ByteInformationCompression) {
   ResetTest();
 
   RunTest(true, false);
 
   // Prepare 4 resources of varying size and configurations.
   page_load_metrics::ExtraRequestInfo resources[] = {
       // Cached request.
       {true /*was_cached*/, 1024 * 40 /* raw_body_bytes */,
-       false /* data_reduction_proxy_used*/,
+       false /* data_reduction_proxy_used*/, false /*  was_lofi_response */,

[bengr, 2017/04/20 17:36:18]

you have two spaces after /*

[RyanSturm, 2017/04/20 20:25:44]

Acknowledged.

        0 /* original_network_content_length */},
       // Uncached non-proxied request.
       {false /*was_cached*/, 1024 * 40 /* raw_body_bytes */,
-       false /* data_reduction_proxy_used*/,
+       false /* data_reduction_proxy_used*/, false /*  was_lofi_response */,
        1024 * 40 /* original_network_content_length */},
       // Uncached proxied request with .1 compression ratio.
       {false /*was_cached*/, 1024 * 40 /* raw_body_bytes */,
-       true /* data_reduction_proxy_used*/,
+       true /* data_reduction_proxy_used*/, false /*  was_lofi_response */,
        1024 * 40 * 10 /* original_network_content_length */},
       // Uncached proxied request with .5 compression ratio.
       {false /*was_cached*/, 1024 * 40 /* raw_body_bytes */,
-       true /* data_reduction_proxy_used*/,
+       true /* data_reduction_proxy_used*/, false /*  was_lofi_response */,
        1024 * 40 * 5 /* original_network_content_length */},
   };
 
   int network_resources = 0;
   int drp_resources = 0;
   int64_t network_bytes = 0;
   int64_t drp_bytes = 0;
   int64_t ocl_bytes = 0;
   for (auto request : resources) {
     SimulateLoadedResource(request);
@@ skipping 16 matching lines @@
 
 TEST_F(DataReductionProxyMetricsObserverTest, ByteInformationInflation) {
   ResetTest();
 
   RunTest(true, false);
 
   // Prepare 4 resources of varying size and configurations.
   page_load_metrics::ExtraRequestInfo resources[] = {
       // Cached request.
       {true /*was_cached*/, 1024 * 40 /* raw_body_bytes */,
-       false /* data_reduction_proxy_used*/,
+       false /* data_reduction_proxy_used*/, false /*  was_lofi_response */,
        0 /* original_network_content_length */},
       // Uncached non-proxied request.
       {false /*was_cached*/, 1024 * 40 /* raw_body_bytes */,
-       false /* data_reduction_proxy_used*/,
+       false /* data_reduction_proxy_used*/, false /*  was_lofi_response */,
        1024 * 40 /* original_network_content_length */},
       // Uncached proxied request with .1 compression ratio.
       {false /*was_cached*/, 1024 * 40 * 10 /* raw_body_bytes */,
-       true /* data_reduction_proxy_used*/,
+       true /* data_reduction_proxy_used*/, false /*  was_lofi_response */,
        1024 * 40 /* original_network_content_length */},
       // Uncached proxied request with .5 compression ratio.
       {false /*was_cached*/, 1024 * 40 * 5 /* raw_body_bytes */,
-       true /* data_reduction_proxy_used*/,
+       true /* data_reduction_proxy_used*/, false /*  was_lofi_response */,
        1024 * 40 /* original_network_content_length */},
   };
 
   int network_resources = 0;
   int drp_resources = 0;
   int64_t network_bytes = 0;
   int64_t drp_bytes = 0;
   int64_t ocl_bytes = 0;
   for (auto request : resources) {
     SimulateLoadedResource(request);
     if (!request.was_cached) {
       network_bytes += request.raw_body_bytes;
       ocl_bytes += request.original_network_content_length;
       ++network_resources;
     }
     if (request.data_reduction_proxy_used) {
       drp_bytes += request.raw_body_bytes;
       ++drp_resources;
     }
   }
 
   NavigateToUntrackedUrl();
 
   ValidateDataHistograms(network_resources, drp_resources, network_bytes,
                          drp_bytes, ocl_bytes);
 }
 
 }  //  namespace data_reduction_proxy