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
|
// 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 "third_party/blink/renderer/modules/wake_lock/wake_lock_sentinel.h"
#include "base/functional/callback.h"
#include "base/run_loop.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise.h"
#include "third_party/blink/renderer/bindings/core/v8/script_promise_resolver.h"
#include "third_party/blink/renderer/core/dom/events/native_event_listener.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/core/frame/local_frame.h"
#include "third_party/blink/renderer/core/frame/navigator.h"
#include "third_party/blink/renderer/modules/event_target_modules_names.h"
#include "third_party/blink/renderer/modules/wake_lock/wake_lock.h"
#include "third_party/blink/renderer/modules/wake_lock/wake_lock_manager.h"
#include "third_party/blink/renderer/modules/wake_lock/wake_lock_test_utils.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/testing/task_environment.h"
#include "v8/include/v8.h"
namespace blink {
namespace {
class SyncEventListener final : public NativeEventListener {
public:
explicit SyncEventListener(base::OnceClosure invocation_callback)
: invocation_callback_(std::move(invocation_callback)) {}
void Invoke(ExecutionContext*, Event*) override {
DCHECK(invocation_callback_);
std::move(invocation_callback_).Run();
}
private:
base::OnceClosure invocation_callback_;
};
} // namespace
TEST(WakeLockSentinelTest, SentinelType) {
test::TaskEnvironment task_environment;
MockWakeLockService wake_lock_service;
WakeLockTestingContext context(&wake_lock_service);
auto* sentinel = MakeGarbageCollected<WakeLockSentinel>(
context.GetScriptState(), V8WakeLockType::Enum::kScreen,
/*manager=*/nullptr);
EXPECT_EQ("screen", sentinel->type().AsString());
sentinel = MakeGarbageCollected<WakeLockSentinel>(
context.GetScriptState(), V8WakeLockType::Enum::kSystem,
/*manager=*/nullptr);
EXPECT_EQ("system", sentinel->type().AsString());
}
TEST(WakeLockSentinelTest, SentinelReleased) {
test::TaskEnvironment task_environment;
MockWakeLockService wake_lock_service;
WakeLockTestingContext context(&wake_lock_service);
auto* manager = MakeGarbageCollected<WakeLockManager>(
context.DomWindow(), V8WakeLockType::Enum::kScreen);
auto* sentinel = MakeGarbageCollected<WakeLockSentinel>(
context.GetScriptState(), V8WakeLockType::Enum::kScreen, manager);
EXPECT_FALSE(sentinel->released());
manager = MakeGarbageCollected<WakeLockManager>(
context.DomWindow(), V8WakeLockType::Enum::kSystem);
sentinel = MakeGarbageCollected<WakeLockSentinel>(
context.GetScriptState(), V8WakeLockType::Enum::kSystem, manager);
EXPECT_FALSE(sentinel->released());
}
TEST(WakeLockSentinelTest, MultipleReleaseCalls) {
test::TaskEnvironment task_environment;
MockWakeLockService wake_lock_service;
WakeLockTestingContext context(&wake_lock_service);
auto* manager = MakeGarbageCollected<WakeLockManager>(
context.DomWindow(), V8WakeLockType::Enum::kScreen);
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<WakeLockSentinel>>(
context.GetScriptState());
auto promise = resolver->Promise();
manager->AcquireWakeLock(resolver);
context.WaitForPromiseFulfillment(promise);
auto* sentinel = ScriptPromiseUtils::GetPromiseResolutionAsWakeLockSentinel(
context.GetScriptState()->GetIsolate(), promise);
ASSERT_NE(nullptr, sentinel);
EXPECT_FALSE(sentinel->released());
base::RunLoop run_loop;
auto* event_listener =
MakeGarbageCollected<SyncEventListener>(run_loop.QuitClosure());
sentinel->addEventListener(event_type_names::kRelease, event_listener,
/*use_capture=*/false);
sentinel->release(context.GetScriptState());
run_loop.Run();
sentinel->removeEventListener(event_type_names::kRelease, event_listener,
/*use_capture=*/false);
EXPECT_EQ(nullptr, sentinel->manager_);
EXPECT_TRUE(sentinel->released());
event_listener = MakeGarbageCollected<SyncEventListener>(WTF::BindOnce([]() {
EXPECT_TRUE(false) << "This event handler should not be reached.";
}));
sentinel->addEventListener(event_type_names::kRelease, event_listener);
sentinel->release(context.GetScriptState());
EXPECT_TRUE(sentinel->released());
}
TEST(WakeLockSentinelTest, ContextDestruction) {
test::TaskEnvironment task_environment;
MockWakeLockService wake_lock_service;
WakeLockTestingContext context(&wake_lock_service);
context.GetPermissionService().SetPermissionResponse(
V8WakeLockType::Enum::kScreen, mojom::blink::PermissionStatus::GRANTED);
auto* screen_resolver =
MakeGarbageCollected<ScriptPromiseResolver<WakeLockSentinel>>(
context.GetScriptState());
auto screen_promise = screen_resolver->Promise();
auto* wake_lock = WakeLock::wakeLock(*context.DomWindow()->navigator());
wake_lock->DoRequest(V8WakeLockType::Enum::kScreen, screen_resolver);
WakeLockManager* manager =
wake_lock->managers_[static_cast<size_t>(V8WakeLockType::Enum::kScreen)];
ASSERT_TRUE(manager);
context.WaitForPromiseFulfillment(screen_promise);
auto* sentinel = ScriptPromiseUtils::GetPromiseResolutionAsWakeLockSentinel(
context.GetScriptState()->GetIsolate(), screen_promise);
ASSERT_TRUE(sentinel);
auto* event_listener =
MakeGarbageCollected<SyncEventListener>(WTF::BindOnce([]() {
EXPECT_TRUE(false) << "This event handler should not be reached.";
}));
sentinel->addEventListener(event_type_names::kRelease, event_listener);
EXPECT_TRUE(sentinel->HasPendingActivity());
context.DomWindow()->FrameDestroyed();
// If the method returns false the object can be GC'ed.
EXPECT_FALSE(sentinel->HasPendingActivity());
}
TEST(WakeLockSentinelTest, HasPendingActivityConditions) {
test::TaskEnvironment task_environment;
MockWakeLockService wake_lock_service;
WakeLockTestingContext context(&wake_lock_service);
auto* manager = MakeGarbageCollected<WakeLockManager>(
context.DomWindow(), V8WakeLockType::Enum::kScreen);
auto* resolver =
MakeGarbageCollected<ScriptPromiseResolver<WakeLockSentinel>>(
context.GetScriptState());
auto promise = resolver->Promise();
manager->AcquireWakeLock(resolver);
context.WaitForPromiseFulfillment(promise);
auto* sentinel = ScriptPromiseUtils::GetPromiseResolutionAsWakeLockSentinel(
context.GetScriptState()->GetIsolate(), promise);
ASSERT_TRUE(sentinel);
// A new WakeLockSentinel was created and it can be GC'ed.
EXPECT_FALSE(sentinel->HasPendingActivity());
base::RunLoop run_loop;
auto* event_listener =
MakeGarbageCollected<SyncEventListener>(run_loop.QuitClosure());
sentinel->addEventListener(event_type_names::kRelease, event_listener);
// The sentinel cannot be GC'ed, it has an event listener and it has not been
// released.
EXPECT_TRUE(sentinel->HasPendingActivity());
// An event such as a page visibility change will eventually call this method.
manager->ClearWakeLocks();
run_loop.Run();
// The sentinel can be GC'ed even though it still has an event listener, as
// it has already been released.
EXPECT_FALSE(sentinel->HasPendingActivity());
}
} // namespace blink
|