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
|
// 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.
#ifndef EXTENSIONS_TEST_EXTENSION_BACKGROUND_PAGE_WAITER_H_
#define EXTENSIONS_TEST_EXTENSION_BACKGROUND_PAGE_WAITER_H_
#include "base/memory/raw_ptr.h"
#include "extensions/common/extension.h"
namespace content {
class BrowserContext;
}
namespace extensions {
// A class to wait for an extension's background to reach a certain state.
// NOTE: See also ExtensionHostTestHelper.
// * Use this class when you need to wait for a _state_ - e.g., for the
// extension's background context to be initialized - and you don't
// necessarily care when it happened. The state may already be active.
// * Use ExtensionHostTestHelper when you need to wait for an expected
// _event_ - such as host destruction.
// See also
// https://chromium.googlesource.com/chromium/src/+/main/docs/patterns/synchronous-runloop.md#events-vs-states
// TODO(devlin): Rename this to ExtensionBackgroundContextWaiter? It supports
// service workers in addition to background (and event) pages.
class ExtensionBackgroundPageWaiter {
public:
ExtensionBackgroundPageWaiter(content::BrowserContext* browser_context,
const Extension& extension);
ExtensionBackgroundPageWaiter(const ExtensionBackgroundPageWaiter& other) =
delete;
ExtensionBackgroundPageWaiter& operator=(
const ExtensionBackgroundPageWaiter& other) = delete;
~ExtensionBackgroundPageWaiter();
// Returns true if this class can wait for the specified `extension`. If
// false, populates `reason` with why it can't (e.g., the extension has
// no background context).
static bool CanWaitFor(const Extension& extension, std::string& reason);
// Waits for the extension's background context to have initialized at some
// point. This doesn't require the background context to be currently open,
// in the case of lazy background contexts.
// NOTE: The only way to determine if a lazy background context was previously
// initialized is by checking for registered events. If a background context
// was fully initialized and shut down without registering any event
// listeners, this will spin indefinitely.
void WaitForBackgroundInitialized();
// Waits for the extension background context to currently be open and active.
// Note: this does not (yet) support worker-based extensions.
void WaitForBackgroundOpen();
// Waits for the extension background context to be closed.
// Note: this does not (yet) support worker-based extensions.
void WaitForBackgroundClosed();
private:
void WaitForBackgroundWorkerInitialized();
void WaitForBackgroundPageInitialized();
const raw_ptr<content::BrowserContext> browser_context_;
scoped_refptr<const Extension> extension_;
};
} // namespace extensions
#endif // EXTENSIONS_TEST_EXTENSION_BACKGROUND_PAGE_WAITER_H_
|
