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
|
// Copyright 2020 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/test/extension_background_page_waiter.h"
#include "base/run_loop.h"
#include "base/test/bind.h"
#include "content/public/browser/browser_context.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/extension_host.h"
#include "extensions/browser/extension_host_test_helper.h"
#include "extensions/browser/lazy_context_id.h"
#include "extensions/browser/lazy_context_task_queue.h"
#include "extensions/browser/process_manager.h"
#include "extensions/common/extension_features.h"
#include "extensions/common/manifest_handlers/background_info.h"
#include "extensions/common/manifest_handlers/incognito_info.h"
#include "extensions/common/mojom/view_type.mojom.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace extensions {
ExtensionBackgroundPageWaiter::ExtensionBackgroundPageWaiter(
content::BrowserContext* browser_context,
const Extension& extension)
: browser_context_(browser_context),
extension_(base::WrapRefCounted(&extension)) {
std::string reason;
if (!CanWaitFor(*extension_, reason))
ADD_FAILURE() << "Attempting to wait for an invalid extension: " << reason;
if (browser_context_->IsOffTheRecord() &&
!IncognitoInfo::IsSplitMode(extension_.get())) {
ADD_FAILURE() << "Trying to wait for an incognito background page from a "
<< "spanning mode extension. Use the on-the-record context.";
}
}
// static
bool ExtensionBackgroundPageWaiter::CanWaitFor(const Extension& extension,
std::string& reason_out) {
if (extension.is_hosted_app()) {
// Little known fact: hosted apps can have background pages. They are
// handled separately in BackgroundContents[Service], and don't use the
// same infrastructure. They're also deprecated. Don't worry about them.
// (If we see flakiness in loading hosted apps, we could potentially
// rejigger this to accommodate for them as well, but it's unclear if it's
// a problem that needs solving.)
reason_out = "ExtensionBackgroundPageWaiter does not support hosted apps.";
return false;
}
if (!BackgroundInfo::HasBackgroundPage(&extension) &&
!BackgroundInfo::IsServiceWorkerBased(&extension)) {
reason_out = "Extension has no background context.";
return false;
}
return true;
}
ExtensionBackgroundPageWaiter::~ExtensionBackgroundPageWaiter() = default;
void ExtensionBackgroundPageWaiter::WaitForBackgroundInitialized() {
if (BackgroundInfo::IsServiceWorkerBased(extension_.get())) {
WaitForBackgroundWorkerInitialized();
return;
}
DCHECK(BackgroundInfo::HasBackgroundPage(extension_.get()));
WaitForBackgroundPageInitialized();
}
void ExtensionBackgroundPageWaiter::WaitForBackgroundWorkerInitialized() {
const auto context_id =
LazyContextId::ForExtension(browser_context_, extension_.get());
LazyContextTaskQueue* task_queue = context_id.GetTaskQueue();
// If the worker is already active and ready to run tasks, we're done.
if (base::FeatureList::IsEnabled(
extensions_features::kOptimizeServiceWorkerStartRequests) &&
task_queue->IsReadyToRunTasks(browser_context_, extension_.get())) {
return;
}
// The worker isn't ready. Queue a no-op task. When the task executes,
// the worker will be ready to receive events.
base::RunLoop run_loop;
auto quit_loop_adapter =
[&run_loop](std::unique_ptr<LazyContextTaskQueue::ContextInfo>) {
run_loop.QuitWhenIdle();
};
task_queue->AddPendingTask(context_id,
base::BindLambdaForTesting(quit_loop_adapter));
run_loop.Run();
}
void ExtensionBackgroundPageWaiter::WaitForBackgroundPageInitialized() {
ProcessManager* process_manager = ProcessManager::Get(browser_context_);
ExtensionHost* extension_host =
process_manager->GetBackgroundHostForExtension(extension_->id());
// Note: This duplicates a bit of logic from WaitForBackgroundOpen(). We
// can't just put the lazy background check from below first and then call
// WaitForBackgroundOpen() directly because we want to accommodate for the
// case of a lazy background page that is active and is still completing its
// first load, but has registered some event listeners.
if (extension_host) {
if (extension_host->has_loaded_once()) {
// The background host exists and has loaded; we're done.
return;
}
// Wait for the background to finish loading.
ExtensionHostTestHelper host_helper(browser_context_, extension_->id());
host_helper.RestrictToHost(extension_host);
host_helper.WaitForHostCompletedFirstLoad();
return;
}
// There isn't a currently-active background page.
// If the extension has a lazy background page, it's possible that it's
// already been loaded and unloaded, which we consider to be initialized. As
// a proxy for this, check if there are registered events. This isn't a
// perfect solution, because
// a) We might be waiting on a subsequent background page load, and
// b) The extension might not register any events (which would normally be
// a bug in event page-based extensions, but not always).
// But, it's a decent proxy for now.
if (BackgroundInfo::HasLazyBackgroundPage(extension_.get()) &&
EventRouter::Get(browser_context_)
->HasRegisteredEvents(extension_->id())) {
return;
}
// Otherwise, wait for a new background page to initialize.
WaitForBackgroundOpen();
}
void ExtensionBackgroundPageWaiter::WaitForBackgroundOpen() {
ProcessManager* process_manager = ProcessManager::Get(browser_context_);
ExtensionHost* extension_host =
process_manager->GetBackgroundHostForExtension(extension_->id());
if (extension_host && !extension_host->has_loaded_once()) {
// Wait for host to finish loading.
ExtensionHostTestHelper host_helper(browser_context_, extension_->id());
host_helper.RestrictToHost(extension_host);
host_helper.WaitForHostCompletedFirstLoad();
} else if (!extension_host) {
ExtensionHostTestHelper host_helper(browser_context_, extension_->id());
host_helper.RestrictToType(mojom::ViewType::kExtensionBackgroundPage);
extension_host = host_helper.WaitForHostCompletedFirstLoad();
}
// NOTE: We can't actually always assert that the `extension_host` is present
// here. It could be null if the host started and then synchronously shut
// down, since ExtensionHostTestHelper::WaitFor*() methods spin the run loop.
// With this, tests that cause the background page to close quickly (e.g.
// after 1ms of inactivity) can result in the host having already closed at
// this point. However, *if* the host is around, we can verify that it
// properly finished loading.
if (extension_host) {
ASSERT_TRUE(extension_host->has_loaded_once());
ASSERT_EQ(extension_host,
process_manager->GetBackgroundHostForExtension(extension_->id()));
}
}
void ExtensionBackgroundPageWaiter::WaitForBackgroundClosed() {
ProcessManager* process_manager = ProcessManager::Get(browser_context_);
ExtensionHost* extension_host =
process_manager->GetBackgroundHostForExtension(extension_->id());
if (!extension_host)
return; // Background page already closed.
ExtensionHostTestHelper host_helper(browser_context_, extension_->id());
host_helper.RestrictToHost(extension_host);
host_helper.WaitForHostDestroyed();
ASSERT_FALSE(
process_manager->GetBackgroundHostForExtension(extension_->id()));
}
} // namespace extensions
|
