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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "extensions/browser/message_tracker.h"
#include "base/strings/strcat.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "base/time/time.h"
#include "content/public/browser/browser_context.h"
#include "content/public/test/browser_task_environment.h"
#include "content/public/test/test_browser_context.h"
#include "extensions/browser/extensions_test.h"
#include "extensions/browser/test_extensions_browser_client.h"
#include "extensions/common/mojom/message_port.mojom-shared.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace extensions {
namespace {
class MessageTrackerTestObserver : public MessageTracker::TestObserver {
public:
explicit MessageTrackerTestObserver(const base::UnguessableToken message_id)
: observed_message_id_(message_id) {
MessageTracker::SetObserverForTest(this);
}
~MessageTrackerTestObserver() override {
MessageTracker::SetObserverForTest(nullptr);
}
void WaitForMessageHung() { on_message_hung_runloop.Run(); }
private:
void OnStageTimeoutRan(const base::UnguessableToken& message_id) override {
if (observed_message_id_ == message_id) {
on_message_hung_runloop.Quit();
}
}
private:
base::UnguessableToken observed_message_id_;
base::RunLoop on_message_hung_runloop;
};
} // namespace
class MessageTrackerUnitTest : public ExtensionsTest {
protected:
void SetUp() override {
ExtensionsTest::SetUp();
message_tracker_ = MessageTracker::Get(browser_context());
}
void TearDown() override {
message_tracker_ = nullptr;
ExtensionsTest::TearDown();
}
MessageTracker* message_tracker() { return message_tracker_; }
base::HistogramTester& histogram_tester() { return histogram_tester_; }
private:
raw_ptr<MessageTracker> message_tracker_;
base::HistogramTester histogram_tester_;
};
// Tests that the tracker correctly records and reports metrics when an
// extension message succeeds in its message stage.
TEST_F(MessageTrackerUnitTest, NotifyMessage) {
base::UnguessableToken message_id = base::UnguessableToken::Create();
MessageTrackerTestObserver observer(message_id);
message_tracker()->StartTrackingMessagingStage(
message_id, "Extensions.MessagePipeline.OpenChannelStatus",
mojom::ChannelType::kSendMessage);
message_tracker()->StopTrackingMessagingStage(
message_id, MessageTracker::OpenChannelMessagePipelineResult::kOpened);
histogram_tester().ExpectTotalCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
/*expected_count=*/1);
histogram_tester().ExpectBucketCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
MessageTracker::OpenChannelMessagePipelineResult::kOpened,
/*expected_count=*/1);
}
// Tests that the tracker correctly records and reports metrics when an
// extension message remains too long in its stage and becomes "hung".
TEST_F(MessageTrackerUnitTest, NotifyHungMessage) {
base::UnguessableToken message_id = base::UnguessableToken::Create();
MessageTrackerTestObserver observer(message_id);
message_tracker()->SetStageHungTimeoutForTest(base::Microseconds(1));
message_tracker()->StartTrackingMessagingStage(
message_id, "Extensions.MessagePipeline.OpenChannelStatus",
mojom::ChannelType::kSendMessage);
{
SCOPED_TRACE(
"waiting for timeout check to run after starting new message tracking");
observer.WaitForMessageHung();
}
histogram_tester().ExpectTotalCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
/*expected_count=*/1);
histogram_tester().ExpectBucketCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
MessageTracker::OpenChannelMessagePipelineResult::kHung,
/*expected_count=*/1);
}
// Tests that the tracker emits success metrics when an extension message hung
// check occurs *after* a message has successfully completed its messaging
// stage.
TEST_F(MessageTrackerUnitTest, NotifyOpenedMessageIfStoppedBeforeHung) {
base::UnguessableToken message_id = base::UnguessableToken::Create();
MessageTrackerTestObserver observer(message_id);
message_tracker()->SetStageHungTimeoutForTest(base::Seconds(1));
message_tracker()->StartTrackingMessagingStage(
message_id, "Extensions.MessagePipeline.OpenChannelStatus",
mojom::ChannelType::kSendMessage);
message_tracker()->StopTrackingMessagingStage(
message_id, MessageTracker::OpenChannelMessagePipelineResult::kOpened);
// This will wait for the hung check created by
// StartTrackingMessagingStage(), then proceed.
{
SCOPED_TRACE(
"waiting for hung check to run after starting and updating new "
"message tracking");
observer.WaitForMessageHung();
}
histogram_tester().ExpectTotalCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
/*expected_count=*/1);
histogram_tester().ExpectBucketCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
MessageTracker::OpenChannelMessagePipelineResult::kOpened,
/*expected_count=*/1);
}
// Tests that the tracker emits failure metrics when an extension message hung
// check occurs *before* a message has successfully completed its messaging
// stage.
TEST_F(MessageTrackerUnitTest, NotifyHungMessageIfStoppedAfterHung) {
base::UnguessableToken message_id = base::UnguessableToken::Create();
MessageTrackerTestObserver observer(message_id);
message_tracker()->SetStageHungTimeoutForTest(base::Seconds(1));
message_tracker()->StartTrackingMessagingStage(
message_id, "Extensions.MessagePipeline.OpenChannelStatus",
mojom::ChannelType::kSendMessage);
// This will wait for the hung check created by
// StartTrackingMessagingStage(), then proceed.
{
SCOPED_TRACE(
"waiting for timeout check to run after starting and updating new "
"message tracking");
observer.WaitForMessageHung();
}
message_tracker()->StopTrackingMessagingStage(
message_id, MessageTracker::OpenChannelMessagePipelineResult::kOpened);
histogram_tester().ExpectTotalCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
/*expected_count=*/1);
histogram_tester().ExpectBucketCount(
"Extensions.MessagePipeline.OpenChannelStatus.SendMessageChannel",
MessageTracker::OpenChannelMessagePipelineResult::kHung,
/*expected_count=*/1);
}
} // namespace extensions
|
