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
|
// Copyright 2022 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/browser/api/offscreen/lifetime_enforcer_factories.h"
#include "base/check.h"
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/types/cxx23_to_underlying.h"
#include "extensions/browser/api/offscreen/audio_lifetime_enforcer.h"
#include "extensions/browser/api/offscreen/offscreen_document_lifetime_enforcer.h"
#include "extensions/common/api/offscreen.h"
namespace extensions {
namespace {
LifetimeEnforcerFactories::TestingOverride* g_testing_override = nullptr;
// A lifetime enforcer that gives offscreen documents unbounded lifetime. This
// can be used for both reasons that may always have unbounded life (like
// testing) and for reasons for which we do not have custom lifetime enforcement
// yet.
class EmptyLifetimeEnforcer : public OffscreenDocumentLifetimeEnforcer {
public:
EmptyLifetimeEnforcer(OffscreenDocumentHost* offscreen_document,
TerminationCallback termination_callback,
NotifyInactiveCallback notify_inactive_callback)
: OffscreenDocumentLifetimeEnforcer(offscreen_document,
std::move(termination_callback),
std::move(notify_inactive_callback)) {
}
~EmptyLifetimeEnforcer() override = default;
// OffscreenDocumentLifetimeEnforcer:
bool IsActive() override {
// For the empty lifetime enforcer, we always assume the document is
// active.
return true;
}
};
std::unique_ptr<OffscreenDocumentLifetimeEnforcer> CreateEmptyEnforcer(
OffscreenDocumentHost* offscreen_document,
OffscreenDocumentLifetimeEnforcer::TerminationCallback termination_callback,
OffscreenDocumentLifetimeEnforcer::NotifyInactiveCallback
notify_inactive_callback) {
return std::make_unique<EmptyLifetimeEnforcer>(
offscreen_document, std::move(termination_callback),
std::move(notify_inactive_callback));
}
std::unique_ptr<OffscreenDocumentLifetimeEnforcer> CreateAudioLifetimeEnforcer(
OffscreenDocumentHost* offscreen_document,
OffscreenDocumentLifetimeEnforcer::TerminationCallback termination_callback,
OffscreenDocumentLifetimeEnforcer::NotifyInactiveCallback
notify_inactive_callback) {
return std::make_unique<AudioLifetimeEnforcer>(
offscreen_document, std::move(termination_callback),
std::move(notify_inactive_callback));
}
LifetimeEnforcerFactories& GetFactoriesInstance() {
static base::NoDestructor<LifetimeEnforcerFactories> instance;
return *instance;
}
using FactoryMethodPtr = std::unique_ptr<OffscreenDocumentLifetimeEnforcer> (*)(
OffscreenDocumentHost*,
OffscreenDocumentLifetimeEnforcer::TerminationCallback,
OffscreenDocumentLifetimeEnforcer::NotifyInactiveCallback);
struct ReasonAndFactoryMethodPair {
api::offscreen::Reason reason;
FactoryMethodPtr factory_method;
};
// A mapping between each of the different reasons and their corresponding
// factory methods.
constexpr ReasonAndFactoryMethodPair kReasonAndFactoryMethodPairs[] = {
{api::offscreen::Reason::kTesting, &CreateEmptyEnforcer},
{api::offscreen::Reason::kAudioPlayback, &CreateAudioLifetimeEnforcer},
// The following reasons do not currently have bespoke lifetime enforcement.
// This enforcement can be added on as-appropriate basis.
{api::offscreen::Reason::kIframeScripting, &CreateEmptyEnforcer},
{api::offscreen::Reason::kDomScraping, &CreateEmptyEnforcer},
{api::offscreen::Reason::kBlobs, &CreateEmptyEnforcer},
{api::offscreen::Reason::kDomParser, &CreateEmptyEnforcer},
{api::offscreen::Reason::kUserMedia, &CreateEmptyEnforcer},
{api::offscreen::Reason::kDisplayMedia, &CreateEmptyEnforcer},
{api::offscreen::Reason::kWebRtc, &CreateEmptyEnforcer},
{api::offscreen::Reason::kClipboard, &CreateEmptyEnforcer},
{api::offscreen::Reason::kLocalStorage, &CreateEmptyEnforcer},
{api::offscreen::Reason::kWorkers, &CreateEmptyEnforcer},
{api::offscreen::Reason::kBatteryStatus, &CreateEmptyEnforcer},
{api::offscreen::Reason::kMatchMedia, &CreateEmptyEnforcer},
{api::offscreen::Reason::kGeolocation, &CreateEmptyEnforcer}};
static_assert(std::size(kReasonAndFactoryMethodPairs) ==
base::to_underlying(api::offscreen::Reason::kMaxValue),
"Factory method size does not equal reason size.");
} // namespace
LifetimeEnforcerFactories::LifetimeEnforcerFactories() {
InitializeFactories();
}
LifetimeEnforcerFactories::~LifetimeEnforcerFactories() = default;
// static
std::unique_ptr<OffscreenDocumentLifetimeEnforcer>
LifetimeEnforcerFactories::GetLifetimeEnforcer(
api::offscreen::Reason reason,
OffscreenDocumentHost* offscreen_document,
OffscreenDocumentLifetimeEnforcer::TerminationCallback termination_callback,
OffscreenDocumentLifetimeEnforcer::NotifyInactiveCallback
notify_inactive_callback) {
if (g_testing_override) {
auto iter = g_testing_override->map().find(reason);
if (iter != g_testing_override->map().end()) {
return iter->second.Run(offscreen_document,
std::move(termination_callback),
std::move(notify_inactive_callback));
}
}
auto& factories = GetFactoriesInstance();
auto iter = factories.map_.find(reason);
CHECK(iter != factories.map_.end())
<< "No factory registered for: " << api::offscreen::ToString(reason);
return iter->second.Run(offscreen_document, std::move(termination_callback),
std::move(notify_inactive_callback));
}
LifetimeEnforcerFactories::TestingOverride::TestingOverride() {
DCHECK_EQ(nullptr, g_testing_override)
<< "Only a single factory override map is allowed at a time.";
g_testing_override = this;
}
LifetimeEnforcerFactories::TestingOverride::~TestingOverride() {
DCHECK_EQ(this, g_testing_override)
<< "Only a single factory override map is allowed at a time.";
g_testing_override = nullptr;
}
void LifetimeEnforcerFactories::InitializeFactories() {
for (const auto& entry : kReasonAndFactoryMethodPairs) {
map_.emplace(entry.reason, base::BindRepeating(entry.factory_method));
}
}
} // namespace extensions
|
