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
|
// 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 "extensions/browser/process_manager.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)
: service_worker_context_(service_worker_context) {
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::kNotStarted;
renderer_state_ = RendererState::kNotActive;
}
bool ServiceWorkerState::IsReady() const {
return browser_state_ == BrowserState::kStarted &&
renderer_state_ == RendererState::kActive && worker_id_.has_value();
}
void ServiceWorkerState::SetWorkerId(const WorkerId& worker_id,
const ProcessManager* process_manager) {
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::DidStartServiceWorkerContext(
const WorkerId& worker_id,
const ProcessManager* process_manager) {
DCHECK_NE(RendererState::kActive, renderer_state())
<< "Worker already started";
SetWorkerId(worker_id, process_manager);
SetRendererState(RendererState::kActive);
}
void ServiceWorkerState::DidStartWorkerForScope(
const WorkerId& worker_id,
base::Time start_time,
const ProcessManager* process_manager) {
UMA_HISTOGRAM_BOOLEAN("Extensions.ServiceWorkerBackground.StartWorkerStatus",
true);
UMA_HISTOGRAM_TIMES("Extensions.ServiceWorkerBackground.StartWorkerTime",
base::Time::Now() - start_time);
DCHECK_NE(BrowserState::kStarted, browser_state())
<< "Worker was already loaded";
SetWorkerId(worker_id, process_manager);
SetBrowserState(BrowserState::kStarted);
}
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::kNotStarted) {
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
|