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 218 219 220
|
// Copyright 2025 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/service_worker/service_worker_state.h"
#include "base/metrics/histogram_macros.h"
#include "content/public/browser/render_process_host.h"
#include "extensions/browser/process_manager.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_features.h"
namespace extensions {
namespace {
// Prevent check on multiple workers per extension for testing purposes.
bool g_allow_multiple_workers_per_extension = false;
} // namespace
ServiceWorkerState::ServiceWorkerState(
content::ServiceWorkerContext* service_worker_context,
const ProcessManager* process_manager)
: service_worker_context_(service_worker_context),
process_manager_(process_manager) {
service_worker_context_observation_.Observe(service_worker_context_);
}
ServiceWorkerState::~ServiceWorkerState() = default;
void ServiceWorkerState::AddObserver(Observer* observer) {
observers_.AddObserver(observer);
}
void ServiceWorkerState::RemoveObserver(Observer* observer) {
observers_.RemoveObserver(observer);
}
void ServiceWorkerState::SetBrowserState(BrowserState browser_state) {
browser_state_ = browser_state;
}
void ServiceWorkerState::SetRendererState(RendererState renderer_state) {
renderer_state_ = renderer_state;
}
void ServiceWorkerState::Reset() {
worker_id_.reset();
browser_state_ = BrowserState::kNotActive;
renderer_state_ = RendererState::kNotActive;
}
bool ServiceWorkerState::IsStarting() const {
return worker_starting_;
}
bool ServiceWorkerState::IsReady() const {
return browser_state_ == BrowserState::kActive &&
renderer_state_ == RendererState::kActive && worker_id_.has_value();
}
void ServiceWorkerState::SetWorkerId(const WorkerId& worker_id) {
if (worker_id_ && *worker_id_ != worker_id) {
// Sanity check that the old worker is gone.
// TODO(crbug.com/40936639): remove
// `g_allow_multiple_workers_per_extension` once bug is fixed so that this
// DCHECK() will be default behavior everywhere. Also upgrade to a CHECK
// once the bug is completely fixed.
DCHECK(!process_manager_->HasServiceWorker(*worker_id_) ||
g_allow_multiple_workers_per_extension);
// Clear stale renderer state if there's any.
renderer_state_ = RendererState::kNotActive;
}
worker_id_ = worker_id;
}
void ServiceWorkerState::StartWorker(const SequencedContextId& context_id) {
CHECK(!IsReady());
if (worker_starting_) {
return;
}
worker_starting_ = true;
const GURL scope =
Extension::GetServiceWorkerScopeFromExtensionId(context_id.extension_id);
service_worker_context_->StartWorkerForScope(
scope, blink::StorageKey::CreateFirstParty(url::Origin::Create(scope)),
base::BindOnce(&ServiceWorkerState::DidStartWorkerForScope,
weak_factory_.GetWeakPtr(), context_id, base::Time::Now()),
base::BindOnce(&ServiceWorkerState::DidStartWorkerFail,
weak_factory_.GetWeakPtr(), context_id,
base::Time::Now()));
}
void ServiceWorkerState::DidStartWorkerForScope(
const SequencedContextId& context_id,
base::Time start_time,
int64_t version_id,
int process_id,
int thread_id) {
UMA_HISTOGRAM_BOOLEAN("Extensions.ServiceWorkerBackground.StartWorkerStatus",
true);
UMA_HISTOGRAM_TIMES("Extensions.ServiceWorkerBackground.StartWorkerTime",
base::Time::Now() - start_time);
DCHECK_NE(BrowserState::kActive, browser_state())
<< "Worker was already loaded";
const ExtensionId& extension_id = context_id.extension_id;
const WorkerId worker_id = {extension_id, process_id, version_id, thread_id};
// HACK: The service worker layer might invoke this callback with an ID for a
// RenderProcessHost that has already terminated. This isn't the right fix for
// this, because it results in the internal state here stalling out - we'll
// wait on the browser side to be ready, which will never happen. This should
// be cleaned up on the next activation sequence, but this still isn't good.
// The proper fix here is that the service worker layer shouldn't be invoking
// this callback with stale processes.
// https://crbug.com/1335821.
if (!content::RenderProcessHost::FromID(process_id)) {
// This is definitely hit, and often enough that we can't NOTREACHED(),
// CHECK(), or DumpWithoutCrashing(). Instead, log an error and gracefully
// return.
// TODO(crbug.com/40913640): Investigate and fix.
LOG(ERROR) << "Received bad DidStartWorkerForScope() message. "
"No corresponding RenderProcessHost.";
return;
}
SetWorkerId(worker_id);
SetBrowserState(BrowserState::kActive);
NotifyObserversIfReady(context_id);
}
void ServiceWorkerState::DidStartWorkerFail(
const SequencedContextId& context_id,
base::Time start_time,
content::StatusCodeResponse status) {
worker_starting_ = false;
for (auto& observer : observers_) {
observer.OnWorkerStartFail(context_id, start_time, status);
}
}
void ServiceWorkerState::DidStartServiceWorkerContext(
const SequencedContextId& context_id,
const WorkerId& worker_id) {
DCHECK_NE(RendererState::kActive, renderer_state())
<< "Worker already started";
SetWorkerId(worker_id);
SetRendererState(RendererState::kActive);
NotifyObserversIfReady(context_id);
}
void ServiceWorkerState::NotifyObserversIfReady(
const SequencedContextId& context_id) {
if (IsReady()) {
worker_starting_ = false;
if (!base::FeatureList::IsEnabled(
extensions_features::kOptimizeServiceWorkerStartRequests)) {
SetBrowserState(ServiceWorkerState::BrowserState::kReady);
}
for (auto& observer : observers_) {
observer.OnWorkerStart(context_id, *worker_id_);
}
}
}
void ServiceWorkerState::OnStopping(
int64_t version_id,
const content::ServiceWorkerRunningInfo& worker_info) {
// TODO(crbug.com/40936639): Confirming this is true in order to allow for
// synchronous notification of this status change.
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
// Check that the version ID of the worker that is stopping refers to an
// extension service worker that is tracked by this class. Service workers
// registered for subscopes via `navigation.serviceWorker.register()` rather
// than being declared in the manifest's background section are not allowed
// to use extensions API, and should be ignored here. See crbug.com/395536907.
if (worker_id_ && worker_id_->version_id == version_id) {
// Untrack all the worker state because once a worker begin stopping or
// stops, a new instance must start before the worker can be considered
// ready to receive tasks/events again and the renderer stop notifications
// are not 100% reliable.
Reset();
}
for (auto& observer : observers_) {
observer.OnWorkerStop(version_id, worker_info);
}
}
void ServiceWorkerState::OnStopped(
int64_t version_id,
const content::ServiceWorkerRunningInfo& worker_info) {
// If `OnStopping` was not called for some reason, try again here.
if (browser_state_ != BrowserState::kNotActive) {
OnStopping(version_id, worker_info);
}
}
// static
base::AutoReset<bool>
ServiceWorkerState::AllowMultipleWorkersPerExtensionForTesting() {
return base::AutoReset<bool>(&g_allow_multiple_workers_per_extension, true);
}
void ServiceWorkerState::StopObservingContextForTest() {
service_worker_context_observation_.Reset();
}
} // namespace extensions
|