Add UKM initial_url and session_id fields.

components/ukm/ukm_service_unittest.cc

 // Copyright 2017 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/ukm/ukm_service.h"
 
+#include <map>
 #include <string>
 #include <utility>
 
 #include "base/hash.h"
 #include "base/metrics/metrics_hashes.h"
+#include "base/test/scoped_feature_list.h"
 #include "base/test/test_simple_task_runner.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "components/metrics/proto/ukm/report.pb.h"
 #include "components/metrics/proto/ukm/source.pb.h"
 #include "components/metrics/test_metrics_provider.h"
 #include "components/metrics/test_metrics_service_client.h"
 #include "components/prefs/testing_pref_service.h"
 #include "components/ukm/persisted_logs_metrics_impl.h"
 #include "components/ukm/ukm_entry_builder.h"
 #include "components/ukm/ukm_pref_names.h"
 #include "components/ukm/ukm_source.h"
+#include "components/variations/variations_associated_data.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/zlib/google/compression_utils.h"
 
 namespace ukm {
 
 namespace {
 
+class ScopedUkmFeatureParams {

[Bryan McQuade, 2017/03/02 18:21:08]

just to give credit, this class is based on a similar class in
components/subresource_filter/core/browser/subresource_filter_features_test_support.h

[rkaplow, 2017/03/02 18:46:54]

This isn't really UKM specific either. If this has been useful, maybe we should
move this into variations? Can you add a TODO on this and assign to me?

[Bryan McQuade, 2017/03/02 22:18:32]

Sure, I added a TODO for you.

+ public:
+  explicit ScopedUkmFeatureParams(
+      const std::map<std::string, std::string>& variation_params) {
+    static const char kTestFieldTrialName[] = "TestTrial";
+    static const char kTestExperimentGroupName[] = "TestGroup";
+
+    variations::testing::ClearAllVariationParams();
+
+    EXPECT_TRUE(variations::AssociateVariationParams(
+        kTestFieldTrialName, kTestExperimentGroupName, variation_params));
+
+    base::FieldTrial* field_trial = base::FieldTrialList::CreateFieldTrial(
+        kTestFieldTrialName, kTestExperimentGroupName);
+
+    std::unique_ptr<base::FeatureList> feature_list(new base::FeatureList);
+    feature_list->RegisterFieldTrialOverride(
+        kUkmFeature.name, base::FeatureList::OVERRIDE_ENABLE_FEATURE,
+        field_trial);
+
+    // Since we are adding a scoped feature list after browser start, copy over
+    // the existing feature list to prevent inconsistency.
+    base::FeatureList* existing_feature_list = base::FeatureList::GetInstance();
+    if (existing_feature_list) {
+      std::string enabled_features;
+      std::string disabled_features;
+      base::FeatureList::GetInstance()->GetFeatureOverrides(&enabled_features,
+                                                            &disabled_features);
+      feature_list->InitializeFromCommandLine(enabled_features,
+                                              disabled_features);
+    }
+
+    scoped_feature_list_.InitWithFeatureList(std::move(feature_list));
+  }
+
+  ~ScopedUkmFeatureParams() { variations::testing::ClearAllVariationParams(); }
+
+ private:
+  base::test::ScopedFeatureList scoped_feature_list_;
+};
+
 class UkmServiceTest : public testing::Test {
  public:
   UkmServiceTest()
       : task_runner_(new base::TestSimpleTaskRunner),
         task_runner_handle_(task_runner_) {
     UkmService::RegisterPrefs(prefs_.registry());
+    ClearPrefs();
+  }
+
+  void ClearPrefs() {
     prefs_.ClearPref(prefs::kUkmClientId);
+    prefs_.ClearPref(prefs::kUkmSessionId);
     prefs_.ClearPref(prefs::kUkmPersistedLogs);
   }
 
   int GetPersistedLogCount() {
     const base::ListValue* list_value =
         prefs_.GetList(prefs::kUkmPersistedLogs);
     return list_value->GetSize();
   }
 
   Report GetPersistedReport() {
@@ skipping 72 matching lines @@
 
 TEST_F(UkmServiceTest, SourceSerialization) {
   UkmService service(&prefs_, &client_);
   EXPECT_EQ(GetPersistedLogCount(), 0);
   service.Initialize();
   task_runner_->RunUntilIdle();
   service.EnableRecording();
   service.EnableReporting();
 
   int32_t id = UkmService::GetNewSourceID();
+  service.UpdateSourceURL(id, GURL("https://google.com/initial"));
+  service.UpdateSourceURL(id, GURL("https://google.com/intermediate"));
   service.UpdateSourceURL(id, GURL("https://google.com/foobar"));
 
   service.Flush();
   EXPECT_EQ(GetPersistedLogCount(), 1);
 
   Report proto_report = GetPersistedReport();
   EXPECT_EQ(1, proto_report.sources_size());
+  EXPECT_FALSE(proto_report.has_session_id());
   const Source& proto_source = proto_report.sources(0);
 
   EXPECT_EQ(id, proto_source.id());
   EXPECT_EQ(GURL("https://google.com/foobar").spec(), proto_source.url());
+  EXPECT_FALSE(proto_source.has_initial_url());
 }
 
 TEST_F(UkmServiceTest, EntryBuilderAndSerialization) {
   UkmService service(&prefs_, &client_);
   EXPECT_EQ(0, GetPersistedLogCount());
   service.Initialize();
   task_runner_->RunUntilIdle();
   service.EnableRecording();
   service.EnableReporting();
 
@@ skipping 163 matching lines @@
 
 TEST_F(UkmServiceTest, GetNewSourceID) {
   int32_t id1 = UkmService::GetNewSourceID();
   int32_t id2 = UkmService::GetNewSourceID();
   int32_t id3 = UkmService::GetNewSourceID();
   EXPECT_NE(id1, id2);
   EXPECT_NE(id1, id3);
   EXPECT_NE(id2, id3);
 }
 
+TEST_F(UkmServiceTest, RecordInitialUrl) {
+  for (bool should_record_initial_url : {true, false}) {
+    base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
+    ScopedUkmFeatureParams params(
+        {{"RecordInitialUrl", should_record_initial_url ? "true" : "false"}});
+
+    ClearPrefs();
+    UkmService service(&prefs_, &client_);
+    EXPECT_EQ(GetPersistedLogCount(), 0);
+    service.Initialize();
+    task_runner_->RunUntilIdle();
+    service.EnableRecording();
+    service.EnableReporting();
+
+    int32_t id = UkmService::GetNewSourceID();
+    service.UpdateSourceURL(id, GURL("https://google.com/initial"));
+    service.UpdateSourceURL(id, GURL("https://google.com/intermediate"));
+    service.UpdateSourceURL(id, GURL("https://google.com/foobar"));
+
+    service.Flush();
+    EXPECT_EQ(GetPersistedLogCount(), 1);
+
+    Report proto_report = GetPersistedReport();
+    EXPECT_EQ(1, proto_report.sources_size());
+    const Source& proto_source = proto_report.sources(0);
+
+    EXPECT_EQ(id, proto_source.id());
+    EXPECT_EQ(GURL("https://google.com/foobar").spec(), proto_source.url());
+    EXPECT_EQ(should_record_initial_url, proto_source.has_initial_url());
+    if (should_record_initial_url) {
+      EXPECT_EQ(GURL("https://google.com/initial").spec(),
+                proto_source.initial_url());
+    }
+  }
+}
+
+TEST_F(UkmServiceTest, RecordSessionId) {
+  for (bool should_record_session_id : {true, false}) {
+    base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
+    ScopedUkmFeatureParams params(
+        {{"RecordSessionId", should_record_session_id ? "true" : "false"}});
+
+    ClearPrefs();
+    UkmService service(&prefs_, &client_);
+    EXPECT_EQ(GetPersistedLogCount(), 0);
+    service.Initialize();
+    task_runner_->RunUntilIdle();
+    service.EnableRecording();
+    service.EnableReporting();
+
+    int32_t id = UkmService::GetNewSourceID();
+    service.UpdateSourceURL(id, GURL("https://google.com/foobar"));
+
+    service.Flush();
+    EXPECT_EQ(GetPersistedLogCount(), 1);
+
+    Report proto_report = GetPersistedReport();
+    EXPECT_EQ(should_record_session_id, proto_report.has_session_id());
+  }
+}
+
 }  // namespace ukm