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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
|
// 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 "content/browser/service_worker/service_worker_synthetic_response_manager.h"
#include "base/trace_event/trace_event.h"
#include "content/browser/service_worker/service_worker_fetch_dispatcher.h"
#include "content/common/service_worker/race_network_request_url_loader_client.h"
#include "mojo/public/cpp/system/data_pipe.h"
#include "net/http/http_status_code.h"
#include "services/network/public/cpp/header_util.h"
#include "services/network/public/mojom/url_response_head.mojom.h"
#include "third_party/blink/public/common/service_worker/service_worker_status_code.h"
#include "third_party/blink/public/mojom/fetch/fetch_api_response.mojom.h"
#include "third_party/blink/public/mojom/service_worker/service_worker_stream_handle.mojom.h"
namespace content {
namespace {
// Convert `network::mojom::URLResponseHead` to
// `blink::mojom::FetchAPIResponse`.
//
// TODO(crbug.com/352578800): Ensure converted fields are really sufficient.
blink::mojom::FetchAPIResponsePtr GetFetchAPIResponse(
network::mojom::URLResponseHeadPtr head) {
auto out_response = blink::mojom::FetchAPIResponse::New();
out_response->status_code = net::HTTP_OK;
out_response->response_time = base::Time::Now();
out_response->url_list = head->url_list_via_service_worker;
out_response->response_type = head->response_type;
out_response->padding = head->padding;
out_response->mime_type.emplace(head->mime_type);
out_response->response_source = head->service_worker_response_source;
out_response->cache_storage_cache_name.emplace(
head->cache_storage_cache_name);
out_response->cors_exposed_header_names = head->cors_exposed_header_names;
out_response->parsed_headers = head->parsed_headers.Clone();
out_response->connection_info = head->connection_info;
out_response->alpn_negotiated_protocol = head->alpn_negotiated_protocol;
out_response->was_fetched_via_spdy = head->was_fetched_via_spdy;
out_response->has_range_requested = head->has_range_requested;
out_response->auth_challenge_info = head->auth_challenge_info;
// Parse headers.
size_t iter = 0;
std::string header_name;
std::string header_value;
while (
head->headers->EnumerateHeaderLines(&iter, &header_name, &header_value)) {
if (out_response->headers.contains(header_name)) {
// TODO(crbug.com/352578800): Confirm if other headers work with comma
// separated values. We need to handle multiple Accept-CH headers, but
// `headers` in FetchAPIResponse is a string based key-value map. So we
// make multiple header values into one comma separated string.
header_value =
base::StrCat({out_response->headers[header_name], ",", header_value});
}
out_response->headers[header_name] = header_value;
}
return out_response;
}
} // namespace
class ServiceWorkerSyntheticResponseManager::SyntheticResponseURLLoaderClient
: public network::mojom::URLLoaderClient {
public:
SyntheticResponseURLLoaderClient(
OnReceiveResponseCallback receive_response_callback,
OnCompleteCallback complete_callback)
: receive_response_callback_(std::move(receive_response_callback)),
complete_callback_(std::move(complete_callback)) {}
SyntheticResponseURLLoaderClient(const SyntheticResponseURLLoaderClient&) =
delete;
SyntheticResponseURLLoaderClient& operator=(
const SyntheticResponseURLLoaderClient&) = delete;
void Bind(mojo::PendingRemote<network::mojom::URLLoaderClient>* remote) {
receiver_.Bind(remote->InitWithNewPipeAndPassReceiver());
}
private:
// network::mojom::URLLoaderClient implementation:
void OnReceiveEarlyHints(network::mojom::EarlyHintsPtr early_hints) override {
}
void OnReceiveResponse(
network::mojom::URLResponseHeadPtr response_head,
mojo::ScopedDataPipeConsumerHandle body,
std::optional<mojo_base::BigBuffer> cached_metadata) override {
receive_response_callback_.Run(response_head.Clone(), std::move(body));
}
void OnReceiveRedirect(
const net::RedirectInfo& redirect_info,
network::mojom::URLResponseHeadPtr response_head) override {}
void OnUploadProgress(int64_t current_position,
int64_t total_size,
OnUploadProgressCallback ack_callback) override {}
void OnTransferSizeUpdated(int32_t transfer_size_diff) override {}
void OnComplete(const network::URLLoaderCompletionStatus& status) override {
std::move(complete_callback_).Run(status);
}
OnReceiveResponseCallback receive_response_callback_;
OnCompleteCallback complete_callback_;
mojo::Receiver<network::mojom::URLLoaderClient> receiver_{this};
};
ServiceWorkerSyntheticResponseManager::ServiceWorkerSyntheticResponseManager(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
scoped_refptr<ServiceWorkerVersion> version)
: url_loader_factory_(url_loader_factory), version_(version) {
TRACE_EVENT("ServiceWorker",
"ServiceWorkerSyntheticResponseManager::"
"ServiceWorkerSyntheticResponseManager");
write_buffer_manager_.emplace();
status_ = write_buffer_manager_->is_data_pipe_created() &&
version_->GetResponseHeadForSyntheticResponse()
? SyntheticResponseStatus::kReady
: SyntheticResponseStatus::kNotReady;
}
ServiceWorkerSyntheticResponseManager::
~ServiceWorkerSyntheticResponseManager() = default;
void ServiceWorkerSyntheticResponseManager::StartRequest(
int request_id,
uint32_t options,
const network::ResourceRequest& request,
OnReceiveResponseCallback receive_response_callback,
OnCompleteCallback complete_callback) {
TRACE_EVENT("ServiceWorker",
"ServiceWorkerSyntheticResponseManager::StartRequest");
response_callback_ = std::move(receive_response_callback);
complete_callback_ = std::move(complete_callback);
client_ = std::make_unique<SyntheticResponseURLLoaderClient>(
base::BindRepeating(
&ServiceWorkerSyntheticResponseManager::OnReceiveResponse,
weak_factory_.GetWeakPtr()),
base::BindOnce(&ServiceWorkerSyntheticResponseManager::OnComplete,
weak_factory_.GetWeakPtr()));
mojo::PendingRemote<network::mojom::URLLoaderClient> client_to_pass;
client_->Bind(&client_to_pass);
// TODO(crbug.com/352578800): Consider updating `request` with mode:
// same-origin and redirect_mode: error to avoid concerns around origin
// boundaries.
//
// TODO(crbug.com/352578800): Create and use own traffic_annotation tag.
url_loader_factory_->CreateLoaderAndStart(
url_loader_.InitWithNewPipeAndPassReceiver(), request_id, options,
request, std::move(client_to_pass),
net::MutableNetworkTrafficAnnotationTag(
ServiceWorkerRaceNetworkRequestURLLoaderClient::
NetworkTrafficAnnotationTag()));
}
void ServiceWorkerSyntheticResponseManager::StartSyntheticResponse(
FetchCallback callback) {
CHECK_EQ(status_, SyntheticResponseStatus::kReady);
TRACE_EVENT("ServiceWorker",
"ServiceWorkerSyntheticResponseManager::StartSyntheticResponse");
auto response_head = version_->GetResponseHeadForSyntheticResponse();
CHECK(response_head);
blink::mojom::FetchAPIResponsePtr response =
GetFetchAPIResponse(response_head.Clone());
CHECK(response);
auto stream_handle = blink::mojom::ServiceWorkerStreamHandle::New();
stream_handle->stream = write_buffer_manager_->ReleaseConsumerHandle();
stream_handle->callback_receiver =
stream_callback_.BindNewPipeAndPassReceiver();
auto timing = blink::mojom::ServiceWorkerFetchEventTiming::New();
timing->dispatch_event_time = base::TimeTicks::Now();
std::move(callback).Run(
blink::ServiceWorkerStatusCode::kOk,
ServiceWorkerFetchDispatcher::FetchEventResult::kGotResponse,
std::move(response), std::move(stream_handle), std::move(timing),
version_);
}
void ServiceWorkerSyntheticResponseManager::SetResponseHead(
network::mojom::URLResponseHeadPtr response_head) {
version_->SetMainScriptResponse(
std::make_unique<ServiceWorkerVersion::MainScriptResponse>(
*response_head.Clone()));
version_->SetResponseHeadForSyntheticResponse(*response_head.Clone());
}
void ServiceWorkerSyntheticResponseManager::OnReceiveResponse(
network::mojom::URLResponseHeadPtr response_head,
mojo::ScopedDataPipeConsumerHandle body) {
TRACE_EVENT("ServiceWorker",
"ServiceWorkerSyntheticResponseManager::OnReceiveResponse");
// If the response is successful, update the response head to the latest one.
if (network::IsSuccessfulStatus(response_head->headers->response_code())) {
SetResponseHead(response_head.Clone());
}
switch (status_) {
case SyntheticResponseStatus::kReady:
CHECK(write_buffer_manager_.has_value());
read_buffer_manager_.emplace(std::move(body));
read_buffer_manager_->Watch(
base::BindRepeating(&ServiceWorkerSyntheticResponseManager::Read,
weak_factory_.GetWeakPtr()));
write_buffer_manager_->Watch(
base::BindRepeating(&ServiceWorkerSyntheticResponseManager::Write,
weak_factory_.GetWeakPtr()));
read_buffer_manager_->ArmOrNotify();
break;
case SyntheticResponseStatus::kNotReady:
std::move(response_callback_)
.Run(std::move(response_head), std::move(body));
break;
}
}
void ServiceWorkerSyntheticResponseManager::OnComplete(
const network::URLLoaderCompletionStatus& status) {
TRACE_EVENT("ServiceWorker",
"ServiceWorkerSyntheticResponseManager::OnComplete");
std::move(complete_callback_).Run(status);
}
void ServiceWorkerSyntheticResponseManager::Read(
MojoResult result,
const mojo::HandleSignalsState& state) {
if (result != MOJO_RESULT_OK) {
return;
}
CHECK(read_buffer_manager_.has_value());
if (read_buffer_manager_->BytesRemaining() > 0) {
write_buffer_manager_->ArmOrNotify();
return;
}
auto [read_result, read_buffer] = read_buffer_manager_->ReadData();
switch (read_result) {
case MOJO_RESULT_OK:
write_buffer_manager_->ArmOrNotify();
return;
case MOJO_RESULT_FAILED_PRECONDITION:
read_buffer_manager_->CancelWatching();
write_buffer_manager_->CancelWatching();
write_buffer_manager_->ResetProducer();
CHECK(stream_callback_);
// Perhaps this assumption is wrong because the write operation may not be
// completed at the timing of when the read buffer is empty.
stream_callback_->OnCompleted();
return;
case MOJO_RESULT_BUSY:
case MOJO_RESULT_SHOULD_WAIT:
return;
default:
return;
}
}
void ServiceWorkerSyntheticResponseManager::Write(
MojoResult result,
const mojo::HandleSignalsState& state) {
if (result != MOJO_RESULT_OK) {
return;
}
CHECK(read_buffer_manager_.has_value());
if (read_buffer_manager_->BytesRemaining() == 0) {
read_buffer_manager_->ArmOrNotify();
return;
}
base::span<const char> read_buffer = read_buffer_manager_->RemainingBuffer();
size_t num_bytes_to_consume = read_buffer.size();
if (write_buffer_manager_->IsWatching()) {
result = write_buffer_manager_->BeginWriteData();
switch (result) {
case MOJO_RESULT_OK:
num_bytes_to_consume =
write_buffer_manager_->CopyAndCompleteWriteData(read_buffer);
read_buffer_manager_->ConsumeData(num_bytes_to_consume);
read_buffer_manager_->ArmOrNotify();
return;
case MOJO_RESULT_FAILED_PRECONDITION:
// abort
return;
case MOJO_RESULT_SHOULD_WAIT:
write_buffer_manager_->EndWriteData(0);
write_buffer_manager_->ArmOrNotify();
return;
}
}
}
} // namespace content
|