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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/performance_manager/public/user_tuning/tab_revisit_tracker.h"
#include <memory>
#include "base/test/metrics/histogram_tester.h"
#include "base/time/time.h"
#include "components/performance_manager/public/decorators/page_live_state_decorator.h"
#include "components/performance_manager/public/graph/graph.h"
#include "components/performance_manager/public/graph/page_node.h"
#include "components/performance_manager/test_support/graph_test_harness.h"
#include "components/performance_manager/test_support/mock_graphs.h"
#include "components/ukm/test_ukm_recorder.h"
#include "services/metrics/public/cpp/ukm_builders.h"
namespace performance_manager {
// Hard-coding these constants instead of using `static_cast` on the
// `TabRevisitTracker::State` enum to guard against changes to the enum that
// would make it out of sync with the enums.xml entry.
constexpr int64_t kActiveState = 0;
constexpr int64_t kBackgroundState = 1;
constexpr int64_t kClosedState = 2;
constexpr ukm::SourceId kValidSourceId = 1;
class TabRevisitTrackerTest : public GraphTestHarness {
protected:
void SetUp() override {
GraphTestHarness::SetUp();
graph()->PassToGraph(std::make_unique<TabPageDecorator>());
auto tracker = std::make_unique<TabRevisitTracker>();
tab_revisit_tracker_ = tracker.get();
graph()->PassToGraph(std::move(tracker));
test_ukm_recorder_ = std::make_unique<ukm::TestAutoSetUkmRecorder>();
}
void SetIsActiveTab(const PageNode* page_node, bool is_active) {
PageLiveStateDecorator::Data* data =
PageLiveStateDecorator::Data::GetOrCreateForPageNode(page_node);
data->SetIsActiveTabForTesting(is_active);
}
void SwitchTab(const PageNode* from, const PageNode* to) {
SetIsActiveTab(from, false);
SetIsActiveTab(to, true);
}
void SimulateDiscard(PageNodeImpl* page_node) {
tab_revisit_tracker_->OnTabAboutToBeDiscarded(
page_node, TabPageDecorator::FromPageNode(page_node));
page_node->SetUkmSourceId(ukm::kInvalidSourceId);
}
void ValidateEntry(size_t entries_count,
size_t entry_id,
int64_t previous_state,
int64_t new_state,
int64_t num_total_revisits,
base::TimeDelta time_in_previous_state,
base::TimeDelta total_time_active) {
auto entries = test_ukm_recorder_->GetEntriesByName(
ukm::builders::TabRevisitTracker_TabStateChange::kEntryName);
EXPECT_EQ(entries.size(), entries_count);
EXPECT_GT(entries.size(), entry_id);
test_ukm_recorder_->ExpectEntryMetric(entries[entry_id], "NewState",
new_state);
test_ukm_recorder_->ExpectEntryMetric(entries[entry_id], "PreviousState",
previous_state);
test_ukm_recorder_->ExpectEntryMetric(entries[entry_id], "NumTotalRevisits",
num_total_revisits);
test_ukm_recorder_->ExpectEntryMetric(
entries[entry_id], "TimeInPreviousState",
TabRevisitTracker::ExponentiallyBucketedSeconds(
time_in_previous_state));
test_ukm_recorder_->ExpectEntryMetric(
entries[entry_id], "TotalTimeActive",
TabRevisitTracker::ExponentiallyBucketedSeconds(total_time_active));
}
std::unique_ptr<ukm::TestUkmRecorder> test_ukm_recorder_;
raw_ptr<TabRevisitTracker> tab_revisit_tracker_;
};
TEST_F(TabRevisitTrackerTest, StartsBackgroundedThenRevisited) {
base::HistogramTester tester;
MockSinglePageInSingleProcessGraph mock_graph(graph());
mock_graph.page->SetUkmSourceId(kValidSourceId);
// Creating the graph doesn't record anything since the page nodes are created
// as kUnknown and don't change their "active tab" status.
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 0);
SetIsActiveTab(mock_graph.page.get(), false);
mock_graph.page->SetType(PageType::kTab);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 0);
AdvanceClock(base::Minutes(30));
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 0);
SetIsActiveTab(mock_graph.page.get(), true);
// The tab became active after 30 minutes in the background, this should be
// recorded in the revisit histogram.
tester.ExpectUniqueSample(TabRevisitTracker::kTimeToRevisitHistogramName,
base::Minutes(30).InSeconds(), 1);
ValidateEntry(/*entries_count=*/1, /*entry_id=*/0,
/*previous_state=*/kBackgroundState,
/*new_state=*/kActiveState,
/*num_total_revisits=*/1,
/*time_in_previous_state=*/base::Minutes(30),
/*total_time_active=*/base::TimeDelta());
SetIsActiveTab(mock_graph.page.get(), false);
tester.ExpectUniqueSample(TabRevisitTracker::kTimeToRevisitHistogramName,
base::Minutes(30).InSeconds(), 1);
ValidateEntry(/*entries_count=*/2, /*entry_id=*/1,
/*previous_state=*/kActiveState,
/*new_state=*/kBackgroundState,
/*num_total_revisits=*/1,
/*time_in_previous_state=*/base::TimeDelta(),
/*total_time_active=*/base::TimeDelta());
AdvanceClock(base::Minutes(10));
// The tab became active again after 10 minutes in the background, the revisit
// histogram should contain 2 samples: one for each revisit.
SetIsActiveTab(mock_graph.page.get(), true);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 2);
tester.ExpectBucketCount(TabRevisitTracker::kTimeToRevisitHistogramName,
base::Minutes(10).InSeconds(), 1);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToCloseHistogramName, 0);
ValidateEntry(/*entries_count=*/3, /*entry_id=*/2,
/*previous_state=*/kBackgroundState,
/*new_state=*/kActiveState,
/*num_total_revisits=*/2,
/*time_in_previous_state=*/base::Minutes(10),
/*total_time_active=*/base::TimeDelta());
}
TEST_F(TabRevisitTrackerTest, CloseInBackgroundRecordsToCloseHistogram) {
base::HistogramTester tester;
MockSinglePageInSingleProcessGraph mock_graph(graph());
mock_graph.page->SetUkmSourceId(kValidSourceId);
SetIsActiveTab(mock_graph.page.get(), false);
mock_graph.page->SetType(PageType::kTab);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 0);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToCloseHistogramName, 0);
AdvanceClock(base::Hours(1));
// Closing the tab while it's inactive should record to the close histogram
// but not the revisit one.
mock_graph.frame.reset();
mock_graph.page.reset();
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 0);
tester.ExpectUniqueSample(TabRevisitTracker::kTimeToCloseHistogramName,
base::Hours(1).InSeconds(), 1);
ValidateEntry(/*entries_count=*/1, /*entry_id=*/0,
/*previous_state=*/kBackgroundState,
/*new_state=*/kClosedState,
/*num_total_revisits=*/0,
/*time_in_previous_state=*/base::Hours(1),
/*total_time_active=*/base::TimeDelta());
}
TEST_F(TabRevisitTrackerTest, CloseWhileActiveDoesntRecordClose) {
base::HistogramTester tester;
MockSinglePageInSingleProcessGraph mock_graph(graph());
mock_graph.page->SetUkmSourceId(kValidSourceId);
SetIsActiveTab(mock_graph.page.get(), true);
mock_graph.page->SetType(PageType::kTab);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 0);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToCloseHistogramName, 0);
AdvanceClock(base::Hours(1));
// Closing the tab while it's active doesn't record either histogram, since
// they are only concerned about background tabs closing or becoming active.
mock_graph.frame.reset();
mock_graph.page.reset();
tester.ExpectTotalCount(TabRevisitTracker::kTimeToRevisitHistogramName, 0);
tester.ExpectTotalCount(TabRevisitTracker::kTimeToCloseHistogramName, 0);
ValidateEntry(/*entries_count=*/1, /*entry_id=*/0,
/*previous_state=*/kActiveState,
/*new_state=*/kClosedState,
/*num_total_revisits=*/0,
/*time_in_previous_state=*/base::Hours(1),
/*total_time_active=*/base::Hours(1));
}
TEST_F(TabRevisitTrackerTest, TestSwitchToDiscardedTab) {
// This graph has 4 pages: `page` and `other_pages[0..2]`, hereafter referred
// to as `OP_N`
MockManyPagesInSingleProcessGraph mock_graph(graph(), 3);
mock_graph.page->SetUkmSourceId(kValidSourceId);
mock_graph.page->SetType(PageType::kTab);
for (auto& p : mock_graph.other_pages) {
p->SetType(PageType::kTab);
}
SetIsActiveTab(mock_graph.page.get(), true);
// Simulate that other_pages[0] is being discarded, then switched to. The
// order in which things happen in that situation are:
//
// 1. OnAboutToBeDiscarded is invoked with the current tab's TabHandle and its
// PageNode before the discard.
// 2. The tab is discarded, its PageNode is deleted and replaced by a fresh
// one.
// 3. The tab is switched to, it becomes the active tab. TabRevisitTracker
// attempts to record the TabStateChange UKM but the tab's UKM source ID is
// invalid
// 4. The tab navigates to its URL, its UKM source ID is set.
EXPECT_EQ(mock_graph.other_pages[0]->GetUkmSourceID(), ukm::kInvalidSourceId);
// Set the page's source ID as if it had navigated before
mock_graph.other_pages[0]->SetUkmSourceId(kValidSourceId);
EXPECT_EQ(mock_graph.other_pages[0]->GetUkmSourceID(), kValidSourceId);
SimulateDiscard(mock_graph.other_pages[0].get());
SwitchTab(mock_graph.page.get(), mock_graph.other_pages[0].get());
auto entries = test_ukm_recorder_->GetEntriesByName(
ukm::builders::TabRevisitTracker_TabStateChange::kEntryName);
// There should be 3 entries: the first tab being made active, followed by one
// entry for the active tab going inactive. The inactive tab being made active
// will only be recorded when its UKM source ID becomes available.
EXPECT_EQ(entries.size(), 2UL);
// Simulate that the source ID is set post-navigation. This should trigger
// recording the inactive -> active UKM.
mock_graph.other_pages[0]->SetUkmSourceId(kValidSourceId);
entries = test_ukm_recorder_->GetEntriesByName(
ukm::builders::TabRevisitTracker_TabStateChange::kEntryName);
EXPECT_EQ(entries.size(), 3UL);
}
} // namespace performance_manager
|
