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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
content / browser / locks / lock_manager_browsertest.cc [blame]
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/test_timeouts.h"
#include "build/build_config.h"
#include "content/browser/feature_observer.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/feature_observer_client.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/common/content_client.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/content_browser_test.h"
#include "content/public/test/content_browser_test_content_browser_client.h"
#include "content/public/test/content_browser_test_utils.h"
#include "content/public/test/content_mock_cert_verifier.h"
#include "content/shell/browser/shell.h"
#include "net/dns/mock_host_resolver.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#if BUILDFLAG(IS_ANDROID)
#include "base/android/build_info.h"
#endif
namespace content {
namespace {
class TestBrowserClient : public ContentBrowserTestContentBrowserClient {
public:
explicit TestBrowserClient(FeatureObserverClient* feature_observer_client)
: feature_observer_client_(feature_observer_client) {}
~TestBrowserClient() override = default;
FeatureObserverClient* GetFeatureObserverClient() override {
return feature_observer_client_;
}
TestBrowserClient(const TestBrowserClient&) = delete;
TestBrowserClient& operator=(const TestBrowserClient&) = delete;
private:
raw_ptr<FeatureObserverClient> feature_observer_client_;
};
class MockObserverClient : public FeatureObserverClient {
public:
MockObserverClient() = default;
~MockObserverClient() override = default;
// PerformanceManagerFeatureObserver implementation:
MOCK_METHOD2(OnStartUsing,
void(GlobalRenderFrameHostId id,
blink::mojom::ObservedFeatureType type));
MOCK_METHOD2(OnStopUsing,
void(GlobalRenderFrameHostId id,
blink::mojom::ObservedFeatureType type));
};
void RunLoopWithTimeout() {
base::RunLoop run_loop;
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE, run_loop.QuitClosure(), TestTimeouts::tiny_timeout());
run_loop.Run();
}
} // namespace
class LockManagerBrowserTest : public ContentBrowserTest {
public:
LockManagerBrowserTest() = default;
~LockManagerBrowserTest() override = default;
LockManagerBrowserTest(const LockManagerBrowserTest&) = delete;
LockManagerBrowserTest& operator=(const LockManagerBrowserTest&) = delete;
void SetUpOnMainThread() override {
ContentBrowserTest::SetUpOnMainThread();
mock_cert_verifier_.mock_cert_verifier()->set_default_result(net::OK);
test_browser_client_ =
std::make_unique<TestBrowserClient>(&mock_observer_client_);
host_resolver()->AddRule("*", "127.0.0.1");
server_.ServeFilesFromSourceDirectory(GetTestDataFilePath());
ASSERT_TRUE(server_.Start());
}
void TearDownOnMainThread() override {
ContentBrowserTest::TearDownOnMainThread();
test_browser_client_.reset();
}
void SetUpCommandLine(base::CommandLine* command_line) override {
mock_cert_verifier_.SetUpCommandLine(command_line);
}
void SetUpInProcessBrowserTestFixture() override {
ContentBrowserTest::SetUpInProcessBrowserTestFixture();
mock_cert_verifier_.SetUpInProcessBrowserTestFixture();
}
void TearDownInProcessBrowserTestFixture() override {
ContentBrowserTest::TearDownInProcessBrowserTestFixture();
mock_cert_verifier_.TearDownInProcessBrowserTestFixture();
}
bool CheckShouldRunTestAndNavigate() const {
EXPECT_TRUE(NavigateToURL(shell(), GetLocksURL("a.com")));
return true;
}
GURL GetLocksURL(const std::string& hostname) const {
return server_.GetURL(hostname, "/locks/locks.html");
}
testing::StrictMock<MockObserverClient> mock_observer_client_;
private:
content::ContentMockCertVerifier mock_cert_verifier_;
net::EmbeddedTestServer server_{net::EmbeddedTestServer::TYPE_HTTPS};
std::unique_ptr<TestBrowserClient> test_browser_client_;
};
// Verify that content::FeatureObserver is notified when a frame acquires a
// single locks.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverSingleLock) {
if (!CheckShouldRunTestAndNavigate())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetPrimaryMainFrame();
GlobalRenderFrameHostId rfh_id = rfh->GetGlobalId();
{
// Acquire a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStartUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnStartUsing is invoked.
run_loop.Run();
}
{
// Release a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStopUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "ReleaseLock('lock_a');"));
// Quit when OnStopUsing is invoked.
run_loop.Run();
}
}
// Verify that content::FeatureObserver is notified when a frame acquires
// multiple locks (notifications only when the number of held locks switches
// between zero and non-zero).
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverTwoLocks) {
if (!CheckShouldRunTestAndNavigate())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetPrimaryMainFrame();
GlobalRenderFrameHostId rfh_id = rfh->GetGlobalId();
{
// Acquire a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStartUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnStartUsing is invoked.
run_loop.Run();
}
// Acquire a second lock. Don't expect a notification.
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_b');"));
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
// Release a lock. Don't expect a notification.
EXPECT_TRUE(ExecJs(rfh, "ReleaseLock('lock_a');"));
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
{
// Release a lock. Expect observer notification, because number of held
// locks is now zero.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStopUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "ReleaseLock('lock_b');"));
// Quit when OnStopUsing is invoked.
run_loop.Run();
}
}
// Verify that content::FeatureObserver is notified that a frame stopped holding
// locks when it is navigated away.
// TODO(crbug.com/40815542): Flakes on all platforms.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, DISABLED_ObserverNavigate) {
if (!CheckShouldRunTestAndNavigate())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetPrimaryMainFrame();
GlobalRenderFrameHostId rfh_id = rfh->GetGlobalId();
{
// Acquire a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStartUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnStartUsing is invoked.
run_loop.Run();
}
{
// Navigate away. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStopUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(NavigateToURL(shell(), GetLocksURL("b.com")));
// Quit when OnStopUsing is invoked.
run_loop.Run();
}
}
// Verify that content::FeatureObserver is notified when a frame steals a lock
// from another frame.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverStealLock) {
if (!CheckShouldRunTestAndNavigate())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetPrimaryMainFrame();
GlobalRenderFrameHostId rfh_id = rfh->GetGlobalId();
{
// Acquire a lock in first WebContents lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStartUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(rfh, "AcquireLock('lock_a');"));
// Quit when OnStartUsing is invoked.
run_loop.Run();
}
// Open another WebContents and navigate.
Shell* other_shell =
Shell::CreateNewWindow(shell()->web_contents()->GetBrowserContext(),
GURL(), nullptr, gfx::Size());
EXPECT_TRUE(NavigateToURL(other_shell, GetLocksURL("a.com")));
RenderFrameHost* other_rfh =
other_shell->web_contents()->GetPrimaryMainFrame();
GlobalRenderFrameHostId other_rfh_id = other_rfh->GetGlobalId();
{
// Steal the lock from other WebContents. Expect observer notifications.
//
base::RunLoop run_loop;
// Wait for the thief and the victim to be notified, but in any order.
int callback_count = 0;
auto callback = [&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) {
callback_count++;
if (callback_count == 2)
run_loop.Quit();
};
EXPECT_CALL(
mock_observer_client_,
OnStopUsing(rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce(callback);
EXPECT_CALL(
mock_observer_client_,
OnStartUsing(other_rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce(callback);
EXPECT_TRUE(ExecJs(other_rfh, "StealLock('lock_a');"));
// Quit after the lock has been released and then grabbed.
run_loop.Run();
}
{
// Release a lock. Expect observer notification.
base::RunLoop run_loop;
EXPECT_CALL(
mock_observer_client_,
OnStopUsing(other_rfh_id, blink::mojom::ObservedFeatureType::kWebLock))
.WillOnce([&](GlobalRenderFrameHostId,
blink::mojom::ObservedFeatureType) { run_loop.Quit(); });
EXPECT_TRUE(ExecJs(other_rfh, "ReleaseLock('lock_a');"));
// Quit when OnStopUsing is invoked.
run_loop.Run();
}
}
// Verify that content::FeatureObserver is *not* notified when a lock is
// acquired by a dedicated worker.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverDedicatedWorker) {
if (!CheckShouldRunTestAndNavigate())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetPrimaryMainFrame();
// Use EvalJs() instead of ExecJs() to ensure that this doesn't return before
// the lock is acquired and released by the worker.
EXPECT_TRUE(EvalJs(rfh, R"(
(async () => {
await AcquireReleaseLockFromDedicatedWorker();
return true;
}) ();
)")
.ExtractBool());
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
}
// SharedWorkers are not enabled on Android. https://crbug.com/154571
#if !BUILDFLAG(IS_ANDROID)
// Verify that content::FeatureObserver is *not* notified when a lock is
// acquired by a shared worker.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverSharedWorker) {
if (!CheckShouldRunTestAndNavigate())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetPrimaryMainFrame();
// Use EvalJs() instead of ExecJs() to ensure that this doesn't return before
// the lock is acquired and released by the worker.
EXPECT_TRUE(EvalJs(rfh, R"(
(async () => {
await AcquireReleaseLockFromSharedWorker();
return true;
}) ();
)")
.ExtractBool());
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
}
#endif // !BUILDFLAG(IS_ANDROID)
// Verify that content::FeatureObserver is *not* notified when a lock is
// acquired by a service worker.
IN_PROC_BROWSER_TEST_F(LockManagerBrowserTest, ObserverServiceWorker) {
if (!CheckShouldRunTestAndNavigate())
return;
RenderFrameHost* rfh = shell()->web_contents()->GetPrimaryMainFrame();
// Use EvalJs() instead of ExecJs() to ensure that this doesn't return before
// the lock is acquired and released by the worker.
EXPECT_TRUE(EvalJs(rfh, R"(
(async () => {
await AcquireReleaseLockFromServiceWorker();
return true;
}) ();
)")
.ExtractBool());
// Wait a short timeout to make sure that the observer is not notified.
RunLoopWithTimeout();
}
} // namespace content