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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
content / browser / background_fetch / storage / get_initialization_data_task.cc [blame]
// Copyright 2018 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/background_fetch/storage/get_initialization_data_task.h"
#include "base/barrier_closure.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/raw_ptr.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/task_traits.h"
#include "content/browser/background_fetch/background_fetch.pb.h"
#include "content/browser/background_fetch/background_fetch_data_manager.h"
#include "content/browser/background_fetch/background_fetch_request_info.h"
#include "content/browser/background_fetch/storage/database_helpers.h"
#include "content/browser/background_fetch/storage/image_helpers.h"
#include "content/browser/background_fetch/storage/mark_registration_for_deletion_task.h"
#include "content/browser/service_worker/service_worker_context_wrapper.h"
#include "content/common/fetch/fetch_api_request_proto.h"
#include "third_party/blink/public/common/manifest/manifest.h"
#include "ui/gfx/image/image.h"
#include "url/origin.h"
namespace content {
namespace background_fetch {
namespace {
// Base class with all the common implementation for the SubTasks
// needed in this file.
class InitializationSubTask : public DatabaseTask {
public:
// Holds data used by all SubTasks.
struct SubTaskInit {
SubTaskInit() = delete;
SubTaskInit(int64_t service_worker_registration_id,
std::string unique_id,
BackgroundFetchInitializationData* initialization_data)
: service_worker_registration_id(service_worker_registration_id),
unique_id(std::move(unique_id)),
initialization_data(initialization_data) {}
~SubTaskInit() = default;
// Service Worker Database metadata.
int64_t service_worker_registration_id;
std::string unique_id;
// The results to report.
raw_ptr<BackgroundFetchInitializationData, DanglingUntriaged>
initialization_data;
};
InitializationSubTask(DatabaseTaskHost* host,
const SubTaskInit& sub_task_init,
base::OnceClosure done_closure)
: DatabaseTask(host),
sub_task_init_(sub_task_init),
done_closure_(std::move(done_closure)) {
DCHECK(sub_task_init_.initialization_data);
}
InitializationSubTask(const InitializationSubTask&) = delete;
InitializationSubTask& operator=(const InitializationSubTask&) = delete;
~InitializationSubTask() override = default;
protected:
void FinishWithError(blink::mojom::BackgroundFetchError error) override {
if (error != blink::mojom::BackgroundFetchError::NONE)
sub_task_init_.initialization_data->error = error;
std::move(done_closure_).Run();
Finished(); // Destroys |this|.
}
SubTaskInit& sub_task_init() { return sub_task_init_; }
private:
SubTaskInit sub_task_init_;
base::OnceClosure done_closure_;
};
// Fills the BackgroundFetchInitializationData with the most recent UI title.
class GetUIOptionsTask : public InitializationSubTask {
public:
GetUIOptionsTask(DatabaseTaskHost* host,
const SubTaskInit& sub_task_init,
base::OnceClosure done_closure)
: InitializationSubTask(host, sub_task_init, std::move(done_closure)) {}
~GetUIOptionsTask() override = default;
void Start() override {
service_worker_context()->GetRegistrationUserData(
sub_task_init().service_worker_registration_id,
{UIOptionsKey(sub_task_init().unique_id)},
base::BindOnce(&GetUIOptionsTask::DidGetUIOptions,
weak_factory_.GetWeakPtr()));
}
private:
void DidGetUIOptions(const std::vector<std::string>& data,
blink::ServiceWorkerStatusCode status) {
switch (ToDatabaseStatus(status)) {
case DatabaseStatus::kFailed:
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
case DatabaseStatus::kNotFound:
case DatabaseStatus::kOk:
break;
}
if (data.size() != 1u) {
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
}
proto::BackgroundFetchUIOptions ui_options;
if (!ui_options.ParseFromString(data[0])) {
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
}
if (!ui_options.title().empty())
sub_task_init().initialization_data->ui_title = ui_options.title();
if (!ui_options.icon().empty()) {
// Start an icon deserialization SubTask on another thread, then finish.
DeserializeIcon(std::unique_ptr<std::string>(ui_options.release_icon()),
base::BindOnce(&GetUIOptionsTask::DidDeserializeIcon,
weak_factory_.GetWeakPtr()));
} else {
FinishWithError(blink::mojom::BackgroundFetchError::NONE);
}
}
void DidDeserializeIcon(SkBitmap icon) {
sub_task_init().initialization_data->icon = std::move(icon);
FinishWithError(blink::mojom::BackgroundFetchError::NONE);
}
base::WeakPtrFactory<GetUIOptionsTask> weak_factory_{this}; // Keep as last.
};
// Gets the number of completed fetches, the number of active fetches,
// and deletes inconsistencies in state transitions.
// 1. Get all completed requests.
// 2. Delete matching active requests.
// 3. Get active requests.
// 4. Delete matching pending requests.
class GetRequestsTask : public InitializationSubTask {
public:
GetRequestsTask(DatabaseTaskHost* host,
const SubTaskInit& sub_task_init,
base::OnceClosure done_closure)
: InitializationSubTask(host, sub_task_init, std::move(done_closure)) {}
GetRequestsTask(const GetRequestsTask&) = delete;
GetRequestsTask& operator=(const GetRequestsTask&) = delete;
~GetRequestsTask() override = default;
void Start() override {
service_worker_context()->GetRegistrationUserDataByKeyPrefix(
sub_task_init().service_worker_registration_id,
CompletedRequestKeyPrefix(sub_task_init().unique_id),
base::BindOnce(&GetRequestsTask::DidGetCompletedRequests,
weak_factory_.GetWeakPtr()));
}
private:
void DidGetCompletedRequests(const std::vector<std::string>& data,
blink::ServiceWorkerStatusCode status) {
switch (ToDatabaseStatus(status)) {
case DatabaseStatus::kFailed:
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
case DatabaseStatus::kNotFound:
case DatabaseStatus::kOk:
break;
}
sub_task_init().initialization_data->num_completed_requests = data.size();
std::vector<std::string> active_requests_to_delete;
active_requests_to_delete.reserve(data.size());
for (const std::string& serialized_completed_request : data) {
proto::BackgroundFetchCompletedRequest completed_request;
if (!completed_request.ParseFromString(serialized_completed_request) ||
sub_task_init().unique_id != completed_request.unique_id()) {
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
}
active_requests_to_delete.push_back(ActiveRequestKey(
completed_request.unique_id(), completed_request.request_index()));
}
if (active_requests_to_delete.empty()) {
DidClearActiveRequests(blink::ServiceWorkerStatusCode::kOk);
return;
}
service_worker_context()->ClearRegistrationUserData(
sub_task_init().service_worker_registration_id,
std::move(active_requests_to_delete),
base::BindOnce(&GetRequestsTask::DidClearActiveRequests,
weak_factory_.GetWeakPtr()));
}
void DidClearActiveRequests(blink::ServiceWorkerStatusCode status) {
switch (ToDatabaseStatus(status)) {
case DatabaseStatus::kFailed:
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
case DatabaseStatus::kNotFound:
case DatabaseStatus::kOk:
break;
}
service_worker_context()->GetRegistrationUserDataByKeyPrefix(
sub_task_init().service_worker_registration_id,
ActiveRequestKeyPrefix(sub_task_init().unique_id),
base::BindOnce(&GetRequestsTask::DidGetRemainingActiveRequests,
weak_factory_.GetWeakPtr()));
}
void DidGetRemainingActiveRequests(const std::vector<std::string>& data,
blink::ServiceWorkerStatusCode status) {
switch (ToDatabaseStatus(status)) {
case DatabaseStatus::kFailed:
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
case DatabaseStatus::kNotFound:
case DatabaseStatus::kOk:
break;
}
std::vector<std::string> pending_requests_to_delete;
pending_requests_to_delete.reserve(data.size());
for (const std::string& serialized_active_request : data) {
proto::BackgroundFetchActiveRequest active_request;
if (!active_request.ParseFromString(serialized_active_request)) {
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
}
DCHECK_EQ(sub_task_init().unique_id, active_request.unique_id());
auto request_info = base::MakeRefCounted<BackgroundFetchRequestInfo>(
active_request.request_index(),
DeserializeFetchRequestFromString(
active_request.serialized_request()),
active_request.request_body_size());
request_info->SetDownloadGuid(active_request.download_guid());
sub_task_init().initialization_data->active_fetch_requests.push_back(
std::move(request_info));
pending_requests_to_delete.push_back(PendingRequestKey(
active_request.unique_id(), active_request.request_index()));
}
if (pending_requests_to_delete.empty()) {
DidClearPendingRequests(blink::ServiceWorkerStatusCode::kOk);
return;
}
service_worker_context()->ClearRegistrationUserData(
sub_task_init().service_worker_registration_id,
std::move(pending_requests_to_delete),
base::BindOnce(&GetRequestsTask::DidClearPendingRequests,
weak_factory_.GetWeakPtr()));
}
void DidClearPendingRequests(blink::ServiceWorkerStatusCode status) {
switch (ToDatabaseStatus(status)) {
case DatabaseStatus::kFailed:
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
case DatabaseStatus::kNotFound:
case DatabaseStatus::kOk:
break;
}
FinishWithError(blink::mojom::BackgroundFetchError::NONE);
}
base::WeakPtrFactory<GetRequestsTask> weak_factory_{this}; // Keep as last.
};
// Fills the BackgroundFetchInitializationData with all the relevant information
// stored in the BackgroundFetchMetadata proto.
class FillFromMetadataTask : public InitializationSubTask {
public:
FillFromMetadataTask(DatabaseTaskHost* host,
const SubTaskInit& sub_task_init,
base::OnceClosure done_closure)
: InitializationSubTask(host, sub_task_init, std::move(done_closure)) {}
FillFromMetadataTask(const FillFromMetadataTask&) = delete;
FillFromMetadataTask& operator=(const FillFromMetadataTask&) = delete;
~FillFromMetadataTask() override = default;
void Start() override {
service_worker_context()->GetRegistrationUserDataByKeyPrefix(
sub_task_init().service_worker_registration_id,
{RegistrationKey(sub_task_init().unique_id)},
base::BindOnce(&FillFromMetadataTask::DidGetMetadata,
weak_factory_.GetWeakPtr()));
}
private:
void DidGetMetadata(const std::vector<std::string>& data,
blink::ServiceWorkerStatusCode status) {
switch (ToDatabaseStatus(status)) {
case DatabaseStatus::kFailed:
case DatabaseStatus::kNotFound:
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
case DatabaseStatus::kOk:
break;
}
if (data.size() != 1u) {
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
}
proto::BackgroundFetchMetadata metadata;
if (!metadata.ParseFromString(data[0])) {
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
}
if (sub_task_init().unique_id != metadata.registration().unique_id()) {
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
}
// Fill BackgroundFetchRegistrationId.
sub_task_init().initialization_data->registration_id =
BackgroundFetchRegistrationId(
sub_task_init().service_worker_registration_id,
GetMetadataStorageKey(metadata),
metadata.registration().developer_id(),
metadata.registration().unique_id());
// Fill BackgroundFetchRegistrationData.
auto& registration_data =
sub_task_init().initialization_data->registration_data;
ToBackgroundFetchRegistration(metadata, registration_data.get());
// Total number of requests.
sub_task_init().initialization_data->num_requests = metadata.num_fetches();
// Fill BackgroundFetchOptions.
auto& options = sub_task_init().initialization_data->options;
options->title = metadata.options().title();
options->download_total = metadata.options().download_total();
options->icons.reserve(metadata.options().icons_size());
for (const auto& icon : metadata.options().icons()) {
blink::Manifest::ImageResource ir;
ir.src = GURL(icon.src());
ir.type = base::ASCIIToUTF16(icon.type());
ir.sizes.reserve(icon.sizes_size());
for (const auto& size : icon.sizes())
ir.sizes.emplace_back(size.width(), size.height());
ir.purpose.reserve(icon.purpose_size());
for (auto purpose : icon.purpose()) {
switch (purpose) {
case proto::ImageResource_Purpose_ANY:
ir.purpose.push_back(
blink::mojom::ManifestImageResource_Purpose::ANY);
break;
case proto::ImageResource_Purpose_MONOCHROME:
ir.purpose.push_back(
blink::mojom::ManifestImageResource_Purpose::MONOCHROME);
break;
}
}
}
sub_task_init().initialization_data->isolation_info =
net::IsolationInfo::Deserialize(metadata.isolation_info());
FinishWithError(blink::mojom::BackgroundFetchError::NONE);
}
base::WeakPtrFactory<FillFromMetadataTask> weak_factory_{
this}; // Keep as last.
};
// Asynchronously calls the SubTasks required to collect all the information for
// the BackgroundFetchInitializationData.
class FillBackgroundFetchInitializationDataTask : public InitializationSubTask {
public:
FillBackgroundFetchInitializationDataTask(DatabaseTaskHost* host,
const SubTaskInit& sub_task_init,
base::OnceClosure done_closure)
: InitializationSubTask(host, sub_task_init, std::move(done_closure)) {}
FillBackgroundFetchInitializationDataTask(
const FillBackgroundFetchInitializationDataTask&) = delete;
FillBackgroundFetchInitializationDataTask& operator=(
const FillBackgroundFetchInitializationDataTask&) = delete;
~FillBackgroundFetchInitializationDataTask() override = default;
void Start() override {
// We need 3 queries to get the initialization data. These are wrapped
// in a BarrierClosure to avoid querying them serially.
// 1. Metadata
// 2. Request statuses and state sanitization
// 3. UI Options (+ icon deserialization)
base::RepeatingClosure barrier_closure = base::BarrierClosure(
3u, base::BindOnce(&FillBackgroundFetchInitializationDataTask::
DidQueryInitializationData,
weak_factory_.GetWeakPtr()));
AddSubTask(std::make_unique<FillFromMetadataTask>(this, sub_task_init(),
barrier_closure));
AddSubTask(std::make_unique<GetRequestsTask>(this, sub_task_init(),
barrier_closure));
AddSubTask(std::make_unique<GetUIOptionsTask>(this, sub_task_init(),
barrier_closure));
}
void DidQueryInitializationData() {
FinishWithError(sub_task_init().initialization_data->error);
}
private:
base::WeakPtrFactory<FillBackgroundFetchInitializationDataTask> weak_factory_{
this}; // Keep as last.
};
} // namespace
BackgroundFetchInitializationData::BackgroundFetchInitializationData() =
default;
BackgroundFetchInitializationData::BackgroundFetchInitializationData(
BackgroundFetchInitializationData&&) = default;
BackgroundFetchInitializationData::~BackgroundFetchInitializationData() =
default;
GetInitializationDataTask::GetInitializationDataTask(
DatabaseTaskHost* host,
GetInitializationDataCallback callback)
: DatabaseTask(host), callback_(std::move(callback)) {}
GetInitializationDataTask::~GetInitializationDataTask() = default;
void GetInitializationDataTask::Start() {
service_worker_context()->GetUserDataForAllRegistrationsByKeyPrefix(
kActiveRegistrationUniqueIdKeyPrefix,
base::BindOnce(&GetInitializationDataTask::DidGetRegistrations,
weak_factory_.GetWeakPtr()));
}
void GetInitializationDataTask::DidGetRegistrations(
const std::vector<std::pair<int64_t, std::string>>& user_data,
blink::ServiceWorkerStatusCode status) {
switch (ToDatabaseStatus(status)) {
case DatabaseStatus::kFailed:
FinishWithError(blink::mojom::BackgroundFetchError::STORAGE_ERROR);
return;
case DatabaseStatus::kNotFound:
case DatabaseStatus::kOk:
break;
}
if (user_data.empty()) {
FinishWithError(blink::mojom::BackgroundFetchError::NONE);
return;
}
base::RepeatingClosure barrier_closure = base::BarrierClosure(
user_data.size(),
base::BindOnce(&GetInitializationDataTask::FinishWithError,
weak_factory_.GetWeakPtr(),
blink::mojom::BackgroundFetchError::NONE));
for (const auto& ud : user_data) {
auto insertion_result = initialization_data_map_.emplace(
ud.second, BackgroundFetchInitializationData());
DCHECK(insertion_result.second); // Check unique_id is in fact unique.
AddSubTask(std::make_unique<FillBackgroundFetchInitializationDataTask>(
this,
InitializationSubTask::SubTaskInit{
ud.first, ud.second,
/* initialization_data= */ &insertion_result.first->second},
barrier_closure));
}
}
void GetInitializationDataTask::FinishWithError(
blink::mojom::BackgroundFetchError error) {
std::vector<BackgroundFetchInitializationData> results;
results.reserve(initialization_data_map_.size());
for (auto& data : initialization_data_map_) {
if (data.second.error == blink::mojom::BackgroundFetchError::NONE) {
// If we successfully extracted all the data, move it to the
// initialization vector to be handed over to create a controller.
results.emplace_back(std::move(data.second));
} else if (!data.second.registration_id.developer_id().empty()) {
// There was an error in getting the initialization data
// (e.g. corrupt data, SWDB error). If the Developer ID of the fetch
// is available, mark the registration for deletion.
// Note that the Developer ID isn't available if the metadata extraction
// failed.
// TODO(crbug.com/40585668): Getting the Developer ID should be possible
// since it is part of the key for when we got the Unique ID.
AddDatabaseTask(std::make_unique<MarkRegistrationForDeletionTask>(
data_manager(), data.second.registration_id,
/* check_for_failure= */ false, base::DoNothing()));
}
if (data.second.error ==
blink::mojom::BackgroundFetchError::STORAGE_ERROR) {
// The subtasks only access the Service Worker storage, so if there is
// a storage error, that would be the cause.
SetStorageError(BackgroundFetchStorageError::kServiceWorkerStorageError);
}
}
std::move(callback_).Run(error, std::move(results));
Finished(); // Destroys |this|.
}
} // namespace background_fetch
} // namespace content