summaryrefslogtreecommitdiff
path: root/chromium/third_party/blink/renderer/platform/ukm_time_aggregator_test.cc
blob: d2c8e2a5d8cf892b0e6bffabfa263995f98883da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
// Copyright 2018 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 "third_party/blink/renderer/platform/ukm_time_aggregator.h"

#include "components/ukm/test_ukm_recorder.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace blink {
namespace {

// These tests must use metrics defined in ukm.xml
const char* kEvent = "Blink.UpdateTime";
const char* kMetric1 = "Compositing";
const char* kMetric1Average = "Compositing.Average";
const char* kMetric1WorstCase = "Compositing.WorstCase";
const char* kMetric2 = "Paint";
const char* kMetric2Average = "Paint.Average";
const char* kMetric2WorstCase = "Paint.WorstCase";

struct Timer {
  static double GetTime() { return fake_time; }
  static double fake_time;
};

double Timer::fake_time = 0;

TEST(UkmTimeAggregatorTest, EmptyEventsNotRecorded) {
  Timer::fake_time = 0;
  auto original_time_function = SetTimeFunctionsForTesting(&Timer::GetTime);

  ukm::TestUkmRecorder recorder;
  int64_t source_id = ukm::UkmRecorder::GetNewSourceID();
  std::unique_ptr<UkmTimeAggregator> aggregator(
      new UkmTimeAggregator(kEvent, source_id, &recorder, {kMetric1, kMetric2},
                            TimeDelta::FromSeconds(1)));
  Timer::fake_time += 10.;
  aggregator.reset();

  EXPECT_EQ(recorder.sources_count(), 0u);
  EXPECT_EQ(recorder.entries_count(), 0u);
  SetTimeFunctionsForTesting(original_time_function);
}

TEST(UkmTimeAggregatorTest, EventsRecordedPerSecond) {
  Timer::fake_time = 0;
  auto original_time_function = SetTimeFunctionsForTesting(&Timer::GetTime);

  ukm::TestUkmRecorder recorder;
  int64_t source_id = ukm::UkmRecorder::GetNewSourceID();
  std::unique_ptr<UkmTimeAggregator> aggregator(
      new UkmTimeAggregator(kEvent, source_id, &recorder, {kMetric1, kMetric2},
                            TimeDelta::FromSeconds(1)));
  // Have 100 events 99ms each; if the records are recorded once per second, we
  // should expect 9 records to be recorded while the timer ticks. 0-1, 1-2,
  // ..., 8-9 seconds.
  for (int i = 0; i < 100; ++i) {
    auto timer = aggregator->GetScopedTimer(i % 2);
    Timer::fake_time += 0.099;
  }

  EXPECT_EQ(recorder.entries_count(), 9u);

  // Once we reset, we record any remaining samples into one more entry, for a
  // total of 10.
  aggregator.reset();

  EXPECT_EQ(recorder.entries_count(), 10u);
  auto entries = recorder.GetEntriesByName(kEvent);
  EXPECT_EQ(entries.size(), 10u);

  for (auto* entry : entries) {
    EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric1Average));
    const int64_t* metric1_average =
        ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric1Average);
    EXPECT_NEAR(*metric1_average / 1e6, 0.099, 0.0001);

    EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric1WorstCase));
    const int64_t* metric1_worst =
        ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric1WorstCase);
    EXPECT_NEAR(*metric1_worst / 1e6, 0.099, 0.0001);

    EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric2Average));
    const int64_t* metric2_average =
        ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric2Average);
    EXPECT_NEAR(*metric2_average / 1e6, 0.099, 0.0001);

    EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric2WorstCase));
    const int64_t* metric2_worst =
        ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric2WorstCase);
    EXPECT_NEAR(*metric2_worst / 1e6, 0.099, 0.0001);
  }

  SetTimeFunctionsForTesting(original_time_function);
}

TEST(UkmTimeAggregatorTest, EventsAveragedCorrectly) {
  Timer::fake_time = 0;
  auto original_time_function = SetTimeFunctionsForTesting(&Timer::GetTime);

  ukm::TestUkmRecorder recorder;
  int64_t source_id = ukm::UkmRecorder::GetNewSourceID();
  std::unique_ptr<UkmTimeAggregator> aggregator(
      new UkmTimeAggregator(kEvent, source_id, &recorder, {kMetric1, kMetric2},
                            TimeDelta::FromSeconds(10000)));
  // 1, 2, and 3 seconds.
  for (int i = 1; i <= 3; ++i) {
    auto timer = aggregator->GetScopedTimer(0);
    Timer::fake_time += i;
  }

  // 3, 3, 3, and then 1 outside of the loop.
  for (int i = 0; i < 3; ++i) {
    auto timer = aggregator->GetScopedTimer(1);
    Timer::fake_time += 3.;
  }
  {
    auto timer = aggregator->GetScopedTimer(1);
    Timer::fake_time += 1.;
  }

  aggregator.reset();
  auto entries = recorder.GetEntriesByName(kEvent);
  EXPECT_EQ(entries.size(), 1u);
  auto* entry = entries[0];

  EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric1Average));
  const int64_t* metric1_average =
      ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric1Average);
  // metric1 (1, 2, 3) average is 2
  EXPECT_NEAR(*metric1_average / 1e6, 2.0, 0.0001);

  EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric1WorstCase));
  const int64_t* metric1_worst =
      ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric1WorstCase);
  // metric1 (1, 2, 3) worst case is 3
  EXPECT_NEAR(*metric1_worst / 1e6, 3.0, 0.0001);

  EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric2Average));
  const int64_t* metric2_average =
      ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric2Average);
  // metric1 (3, 3, 3, 1) average is 2.5
  EXPECT_NEAR(*metric2_average / 1e6, 2.5, 0.0001);

  EXPECT_TRUE(ukm::TestUkmRecorder::EntryHasMetric(entry, kMetric2WorstCase));
  const int64_t* metric2_worst =
      ukm::TestUkmRecorder::GetEntryMetric(entry, kMetric2WorstCase);
  // metric1 (3, 3, 3, 1) worst case is 3
  EXPECT_NEAR(*metric2_worst / 1e6, 3.0, 0.0001);

  SetTimeFunctionsForTesting(original_time_function);
}

}  // namespace
}  // namespace blink