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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
content / renderer / media / renderer_web_media_player_delegate_browsertest.cc [blame]
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/renderer/media/renderer_web_media_player_delegate.h"
#include <memory>
#include <tuple>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/location.h"
#include "base/run_loop.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/simple_test_tick_clock.h"
#include "content/public/test/render_view_test.h"
#include "content/renderer/render_process.h"
#include "content/test/test_render_frame.h"
#include "media/base/media_content_type.h"
#include "media/base/media_switches.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/mojom/frame/lifecycle.mojom.h"
#include "third_party/blink/public/platform/scheduler/test/renderer_scheduler_test_support.h"
using testing::NiceMock;
using testing::Return;
using testing::StrictMock;
namespace media {
namespace {
constexpr base::TimeDelta kIdleTimeout = base::Seconds(1);
}
class MockWebMediaPlayerDelegateObserver
: public blink::WebMediaPlayerDelegate::Observer {
public:
MockWebMediaPlayerDelegateObserver() {}
~MockWebMediaPlayerDelegateObserver() {}
// WebMediaPlayerDelegate::Observer implementation.
MOCK_METHOD0(OnPageHidden, void());
MOCK_METHOD0(OnPageShown, void());
MOCK_METHOD0(OnFrameHidden, void());
MOCK_METHOD0(OnFrameShown, void());
MOCK_METHOD0(OnIdleTimeout, void());
};
class RendererWebMediaPlayerDelegateTest : public content::RenderViewTest {
public:
RendererWebMediaPlayerDelegateTest() {}
RendererWebMediaPlayerDelegateTest(
const RendererWebMediaPlayerDelegateTest&) = delete;
RendererWebMediaPlayerDelegateTest& operator=(
const RendererWebMediaPlayerDelegateTest&) = delete;
~RendererWebMediaPlayerDelegateTest() override {}
void SetUp() override {
RenderViewTest::SetUp();
// Start the tick clock off at a non-null value.
tick_clock_.Advance(base::Seconds(1234));
delegate_manager_ =
std::make_unique<RendererWebMediaPlayerDelegate>(GetMainRenderFrame());
delegate_manager_->SetIdleCleanupParamsForTesting(
kIdleTimeout, base::TimeDelta(), &tick_clock_, false);
}
void TearDown() override {
delegate_manager_.reset();
RenderViewTest::TearDown();
}
protected:
void SetIsLowEndDeviceForTesting() {
delegate_manager_->SetIdleCleanupParamsForTesting(
kIdleTimeout, base::TimeDelta(), &tick_clock_, true);
}
void SetNonZeroIdleTimeout() {
delegate_manager_->SetIdleCleanupParamsForTesting(
kIdleTimeout, base::Seconds(1), &tick_clock_, true);
}
void RunLoopOnce() {
base::RunLoop run_loop;
blink::scheduler::GetSingleThreadTaskRunnerForTesting()->PostTask(
FROM_HERE, run_loop.QuitClosure());
run_loop.Run();
}
std::unique_ptr<RendererWebMediaPlayerDelegate> delegate_manager_;
StrictMock<MockWebMediaPlayerDelegateObserver> observer_1_, observer_2_,
observer_3_;
base::SimpleTestTickClock tick_clock_;
};
TEST_F(RendererWebMediaPlayerDelegateTest, TheTimerIsInitiallyStopped) {
ASSERT_FALSE(delegate_manager_->IsIdleCleanupTimerRunningForTesting());
}
TEST_F(RendererWebMediaPlayerDelegateTest, AddingAnIdleObserverStartsTheTimer) {
const int delegate_id_1 = delegate_manager_->AddObserver(&observer_1_);
delegate_manager_->SetIdle(delegate_id_1, true);
RunLoopOnce();
ASSERT_TRUE(delegate_manager_->IsIdleCleanupTimerRunningForTesting());
}
TEST_F(RendererWebMediaPlayerDelegateTest, RemovingAllObserversStopsTheTimer) {
const int delegate_id_1 = delegate_manager_->AddObserver(&observer_1_);
delegate_manager_->SetIdle(delegate_id_1, true);
RunLoopOnce();
delegate_manager_->RemoveObserver(delegate_id_1);
RunLoopOnce();
ASSERT_FALSE(delegate_manager_->IsIdleCleanupTimerRunningForTesting());
}
TEST_F(RendererWebMediaPlayerDelegateTest, PlaySuspendsLowEndIdleDelegates) {
SetIsLowEndDeviceForTesting();
const int delegate_id_1 = delegate_manager_->AddObserver(&observer_1_);
delegate_manager_->SetIdle(delegate_id_1, true);
const int delegate_id_2 = delegate_manager_->AddObserver(&observer_2_);
delegate_manager_->SetIdle(delegate_id_2, true);
RunLoopOnce();
// Calling play on the first player should suspend the other idle player.
EXPECT_CALL(observer_2_, OnIdleTimeout());
delegate_manager_->DidMediaMetadataChange(
delegate_id_1, true, true, media::MediaContentType::kPersistent);
delegate_manager_->DidPlay(delegate_id_1);
delegate_manager_->SetIdle(delegate_id_1, false);
tick_clock_.Advance(base::Microseconds(1));
RunLoopOnce();
}
TEST_F(RendererWebMediaPlayerDelegateTest, MaxLowEndIdleDelegates) {
SetIsLowEndDeviceForTesting();
int delegate_id_1 = delegate_manager_->AddObserver(&observer_1_);
delegate_manager_->SetIdle(delegate_id_1, true);
int delegate_id_2 = delegate_manager_->AddObserver(&observer_2_);
delegate_manager_->SetIdle(delegate_id_2, true);
RunLoopOnce();
// Just adding a third idle observer should suspend all idle players.
EXPECT_CALL(observer_1_, OnIdleTimeout());
EXPECT_CALL(observer_2_, OnIdleTimeout());
int delegate_id_3 = delegate_manager_->AddObserver(&observer_3_);
delegate_manager_->SetIdle(delegate_id_3, true);
EXPECT_CALL(observer_3_, OnIdleTimeout());
tick_clock_.Advance(base::Microseconds(1));
RunLoopOnce();
}
TEST_F(RendererWebMediaPlayerDelegateTest,
SuspendRequestsAreOnlySentOnceIfHandled) {
int delegate_id_1 = delegate_manager_->AddObserver(&observer_1_);
delegate_manager_->SetIdle(delegate_id_1, true);
EXPECT_CALL(observer_1_, OnIdleTimeout());
tick_clock_.Advance(kIdleTimeout + base::Microseconds(1));
base::RunLoop().RunUntilIdle();
}
TEST_F(RendererWebMediaPlayerDelegateTest,
SuspendRequestsAreOnlySentOnceIfNotHandled) {
SetNonZeroIdleTimeout();
int delegate_id_1 = delegate_manager_->AddObserver(&observer_1_);
delegate_manager_->SetIdle(delegate_id_1, true);
EXPECT_CALL(observer_1_, OnIdleTimeout());
tick_clock_.Advance(kIdleTimeout + base::Microseconds(1));
base::RunLoop().RunUntilIdle();
delegate_manager_->ClearStaleFlag(delegate_id_1);
ASSERT_TRUE(delegate_manager_->IsIdleCleanupTimerRunningForTesting());
// Make sure that OnIdleTimeout isn't called again immediately.
base::RunLoop().RunUntilIdle();
}
TEST_F(RendererWebMediaPlayerDelegateTest, IdleDelegatesAreSuspended) {
// Add one non-idle observer and one idle observer.
const int delegate_id_1 = delegate_manager_->AddObserver(&observer_1_);
const int delegate_id_2 = delegate_manager_->AddObserver(&observer_2_);
delegate_manager_->SetIdle(delegate_id_2, true);
// The idle cleanup task should suspend the second delegate while the first is
// kept alive.
{
EXPECT_CALL(observer_2_, OnIdleTimeout());
tick_clock_.Advance(kIdleTimeout + base::Microseconds(1));
RunLoopOnce();
}
// Once the player is idle, it should be suspended after |kIdleTimeout|.
delegate_manager_->SetIdle(delegate_id_1, true);
{
EXPECT_CALL(observer_1_, OnIdleTimeout());
tick_clock_.Advance(kIdleTimeout + base::Microseconds(1));
RunLoopOnce();
}
}
TEST_F(RendererWebMediaPlayerDelegateTest, FrameVisibilityChanged) {
delegate_manager_->AddObserver(&observer_1_);
// The frame is initially rendered.
EXPECT_CALL(observer_1_, OnFrameHidden()).Times(testing::Exactly(1));
delegate_manager_->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kNotRendered);
EXPECT_CALL(observer_1_, OnFrameShown()).Times(testing::Exactly(1));
delegate_manager_->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kRenderedInViewport);
}
class RendererWebMediaPlayerDelegateVisibilityTest
: public content::RenderViewTest {
public:
RendererWebMediaPlayerDelegateVisibilityTest() = default;
RendererWebMediaPlayerDelegateVisibilityTest(
const RendererWebMediaPlayerDelegateVisibilityTest&) = delete;
RendererWebMediaPlayerDelegateVisibilityTest& operator=(
const RendererWebMediaPlayerDelegateVisibilityTest&) = delete;
~RendererWebMediaPlayerDelegateVisibilityTest() override = default;
void SetUp() override {
RenderViewTest::SetUp();
LoadHTML("<iframe src='data:text/html,frame 1'></iframe>");
blink::WebFrame* web_frame = frame()->GetWebFrame();
content::TestRenderFrame* child_frame =
static_cast<content::TestRenderFrame*>(
content::RenderFrameImpl::FromWebFrame(
web_frame->FirstChild()->ToWebLocalFrame()));
delegate_manager_ =
std::make_unique<RendererWebMediaPlayerDelegate>(child_frame);
}
void TearDown() override {
delegate_manager_.reset();
RenderViewTest::TearDown();
}
content::TestRenderFrame* frame() {
return static_cast<content::TestRenderFrame*>(GetMainRenderFrame());
}
std::unique_ptr<RendererWebMediaPlayerDelegate> delegate_manager_;
StrictMock<MockWebMediaPlayerDelegateObserver> child_frame_observer_;
};
TEST_F(RendererWebMediaPlayerDelegateVisibilityTest, NotRendered) {
delegate_manager_->SetFrameHiddenForTesting(false);
delegate_manager_->AddObserver(&child_frame_observer_);
blink::WebFrame* web_frame = frame()->GetWebFrame();
content::TestRenderFrame* child_frame =
static_cast<content::TestRenderFrame*>(
content::RenderFrameImpl::FromWebFrame(
web_frame->FirstChild()->ToWebLocalFrame()));
EXPECT_CALL(child_frame_observer_, OnFrameShown()).Times(testing::Exactly(0));
EXPECT_CALL(child_frame_observer_, OnFrameHidden())
.Times(testing::Exactly(1));
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kNotRendered);
}
TEST_F(RendererWebMediaPlayerDelegateVisibilityTest, RenderedInViewport) {
delegate_manager_->SetFrameHiddenForTesting(true);
delegate_manager_->AddObserver(&child_frame_observer_);
blink::WebFrame* web_frame = frame()->GetWebFrame();
content::TestRenderFrame* child_frame =
static_cast<content::TestRenderFrame*>(
content::RenderFrameImpl::FromWebFrame(
web_frame->FirstChild()->ToWebLocalFrame()));
EXPECT_CALL(child_frame_observer_, OnFrameShown()).Times(testing::Exactly(1));
EXPECT_CALL(child_frame_observer_, OnFrameHidden())
.Times(testing::Exactly(0));
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kRenderedInViewport);
}
TEST_F(RendererWebMediaPlayerDelegateVisibilityTest, RenderedOutOfViewport) {
delegate_manager_->SetFrameHiddenForTesting(true);
delegate_manager_->AddObserver(&child_frame_observer_);
blink::WebFrame* web_frame = frame()->GetWebFrame();
content::TestRenderFrame* child_frame =
static_cast<content::TestRenderFrame*>(
content::RenderFrameImpl::FromWebFrame(
web_frame->FirstChild()->ToWebLocalFrame()));
EXPECT_CALL(child_frame_observer_, OnFrameShown()).Times(testing::Exactly(1));
EXPECT_CALL(child_frame_observer_, OnFrameHidden())
.Times(testing::Exactly(0));
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kRenderedOutOfViewport);
}
TEST_F(RendererWebMediaPlayerDelegateVisibilityTest,
RenderedToOutOfViewportDoesNotTriggerEvents) {
delegate_manager_->SetFrameHiddenForTesting(false);
delegate_manager_->AddObserver(&child_frame_observer_);
blink::WebFrame* web_frame = frame()->GetWebFrame();
content::TestRenderFrame* child_frame =
static_cast<content::TestRenderFrame*>(
content::RenderFrameImpl::FromWebFrame(
web_frame->FirstChild()->ToWebLocalFrame()));
EXPECT_CALL(child_frame_observer_, OnFrameShown()).Times(testing::Exactly(0));
EXPECT_CALL(child_frame_observer_, OnFrameHidden())
.Times(testing::Exactly(0));
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kRenderedInViewport);
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kRenderedOutOfViewport);
}
TEST_F(RendererWebMediaPlayerDelegateVisibilityTest,
RepeatedNotificationsDoNotTriggerEvents) {
delegate_manager_->SetFrameHiddenForTesting(false);
delegate_manager_->AddObserver(&child_frame_observer_);
blink::WebFrame* web_frame = frame()->GetWebFrame();
content::TestRenderFrame* child_frame =
static_cast<content::TestRenderFrame*>(
content::RenderFrameImpl::FromWebFrame(
web_frame->FirstChild()->ToWebLocalFrame()));
EXPECT_CALL(child_frame_observer_, OnFrameShown()).Times(testing::Exactly(0));
EXPECT_CALL(child_frame_observer_, OnFrameHidden())
.Times(testing::Exactly(1));
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kNotRendered);
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kNotRendered);
child_frame->OnFrameVisibilityChanged(
blink::mojom::FrameVisibility::kNotRendered);
}
} // namespace media