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
|
// 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.
#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_WAKE_LOCK_WAKE_LOCK_TEST_UTILS_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_WAKE_LOCK_WAKE_LOCK_TEST_UTILS_H_
#include <array>
#include <optional>
#include "base/functional/callback.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "mojo/public/cpp/bindings/receiver_set.h"
#include "services/device/public/mojom/wake_lock.mojom-blink.h"
#include "third_party/blink/public/mojom/permissions/permission.mojom-blink.h"
#include "third_party/blink/public/mojom/wake_lock/wake_lock.mojom-blink.h"
#include "third_party/blink/renderer/bindings/core/v8/script_function.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_binding_for_testing.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/modules/wake_lock/wake_lock_type.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
#include "v8/include/v8.h"
namespace blink {
class DOMException;
class WakeLockSentinel;
// Mock WakeLock implementation that tracks whether it's bound or acquired, and
// provides a few helper methods to synchronously wait for RequestWakeLock()
// and CancelWakeLock() to be called.
class MockWakeLock : public device::mojom::blink::WakeLock {
public:
MockWakeLock();
~MockWakeLock() override;
bool is_acquired() const { return is_acquired_; }
void Bind(mojo::PendingReceiver<device::mojom::blink::WakeLock> receiver);
// Forcefully terminate a binding to test connection errors.
void Unbind();
// Synchronously wait for RequestWakeLock() to be called.
void WaitForRequest();
// Synchronously wait for CancelWakeLock() to be called.
void WaitForCancelation();
private:
void OnConnectionError();
// device::mojom::blink::WakeLock implementation
void RequestWakeLock() override;
void CancelWakeLock() override;
void AddClient(
mojo::PendingReceiver<device::mojom::blink::WakeLock>) override;
void ChangeType(device::mojom::blink::WakeLockType,
ChangeTypeCallback) override;
void HasWakeLockForTests(HasWakeLockForTestsCallback) override;
bool is_acquired_ = false;
base::OnceClosure request_wake_lock_callback_;
base::OnceClosure cancel_wake_lock_callback_;
mojo::Receiver<device::mojom::blink::WakeLock> receiver_{this};
};
// Mock WakeLockService implementation that creates a MockWakeLock in its
// GetWakeLock() implementation.
class MockWakeLockService : public mojom::blink::WakeLockService {
public:
MockWakeLockService();
~MockWakeLockService() override;
void BindRequest(mojo::ScopedMessagePipeHandle handle);
MockWakeLock& get_wake_lock(V8WakeLockType::Enum type);
private:
// mojom::blink::WakeLockService implementation
void GetWakeLock(
device::mojom::blink::WakeLockType type,
device::mojom::blink::WakeLockReason reason,
const String& description,
mojo::PendingReceiver<device::mojom::blink::WakeLock> receiver) override;
std::array<MockWakeLock, V8WakeLockType::kEnumSize> mock_wake_lock_;
mojo::ReceiverSet<mojom::blink::WakeLockService> receivers_;
};
// Mock PermissionService implementation. It only implements the bits required
// by the Wake Lock code, and it mimics what we do in the content and chrome
// layers: screen locks are always granted, system locks are always denied.
class MockPermissionService final : public mojom::blink::PermissionService {
public:
MockPermissionService();
~MockPermissionService() override;
void BindRequest(mojo::ScopedMessagePipeHandle handle);
void SetPermissionResponse(V8WakeLockType::Enum,
mojom::blink::PermissionStatus);
void WaitForPermissionRequest(V8WakeLockType::Enum);
private:
bool GetWakeLockTypeFromDescriptor(
const mojom::blink::PermissionDescriptorPtr& descriptor,
V8WakeLockType::Enum* output);
// mojom::blink::PermissionService implementation
void HasPermission(mojom::blink::PermissionDescriptorPtr permission,
HasPermissionCallback) override;
void RegisterPageEmbeddedPermissionControl(
Vector<mojom::blink::PermissionDescriptorPtr> permissions,
mojo::PendingRemote<mojom::blink::EmbeddedPermissionControlClient> client)
override;
void RequestPageEmbeddedPermission(
mojom::blink::EmbeddedPermissionRequestDescriptorPtr permissions,
RequestPageEmbeddedPermissionCallback) override;
void RequestPermission(mojom::blink::PermissionDescriptorPtr permission,
bool user_gesture,
RequestPermissionCallback) override;
void RequestPermissions(
Vector<mojom::blink::PermissionDescriptorPtr> permissions,
bool user_gesture,
RequestPermissionsCallback) override;
void RevokePermission(mojom::blink::PermissionDescriptorPtr permission,
RevokePermissionCallback) override;
void AddPermissionObserver(
mojom::blink::PermissionDescriptorPtr permission,
mojom::blink::PermissionStatus last_known_status,
mojo::PendingRemote<mojom::blink::PermissionObserver>) override;
void AddCombinedPermissionObserver(
mojom::blink::PermissionDescriptorPtr permission,
mojom::blink::PermissionStatus last_known_status,
mojo::PendingRemote<mojom::blink::PermissionObserver>) override;
void NotifyEventListener(mojom::blink::PermissionDescriptorPtr permission,
const String& event_type,
bool is_added) override;
void OnConnectionError();
mojo::Receiver<mojom::blink::PermissionService> receiver_{this};
std::array<std::optional<mojom::blink::PermissionStatus>,
V8WakeLockType::kEnumSize>
permission_responses_;
std::array<base::OnceClosure, V8WakeLockType::kEnumSize>
request_permission_callbacks_;
};
// Overrides requests for WakeLockService with MockWakeLockService instances.
//
// Usage:
// TEST(Foo, Bar) {
// MockWakeLockService mock_service;
// WakeLockTestingContext context(&mock_service);
// mojo::Remote<mojom::blink::WakeLockService> service;
// context.DomWindow()->GetBrowserInterfaceBroker().GetInterface(
// service.BindNewPipeAndPassReceiver());
// service->GetWakeLock(...); // Will call mock_service.GetWakeLock().
// }
class WakeLockTestingContext final {
STACK_ALLOCATED();
public:
WakeLockTestingContext(MockWakeLockService* mock_wake_lock_service);
~WakeLockTestingContext();
LocalDOMWindow* DomWindow();
LocalFrame* Frame();
ScriptState* GetScriptState();
MockPermissionService& GetPermissionService();
// Synchronously waits for |promise| to be fulfilled.
void WaitForPromiseFulfillment(ScriptPromise<WakeLockSentinel> promise);
// Synchronously waits for |promise| to be rejected.
void WaitForPromiseRejection(ScriptPromise<WakeLockSentinel> promise);
private:
MockPermissionService permission_service_;
V8TestingScope testing_scope_;
};
// Utility functions to retrieve promise data out of a ScriptPromise.
class ScriptPromiseUtils final {
public:
// Shorthand for getting a PromiseState out of a ScriptPromise.
static v8::Promise::PromiseState GetPromiseState(
const ScriptPromise<WakeLockSentinel>& promise);
// Shorthand for getting a DOMException* out of a ScriptPromise. This
// assumes the promise has been resolved with a DOMException. If the
// conversion fails, nullptr is returned.
static DOMException* GetPromiseResolutionAsDOMException(
v8::Isolate*,
const ScriptPromise<WakeLockSentinel>&);
// Shorthand for getting a WakeLockSentinel* out of a ScriptPromise.
// This assumes the promise has been resolved with a WakeLockSentinel. If the
// conversion fails, nullptr is returned.
static WakeLockSentinel* GetPromiseResolutionAsWakeLockSentinel(
v8::Isolate*,
const ScriptPromise<WakeLockSentinel>&);
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_MODULES_WAKE_LOCK_WAKE_LOCK_TEST_UTILS_H_
|
