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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
content / browser / service_worker / service_worker_test_utils.cc [blame]
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/342213636): Remove this and spanify to fix the errors.
#pragma allow_unsafe_buffers
#endif
#include "content/browser/service_worker/service_worker_test_utils.h"
#include <algorithm>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/barrier_closure.h"
#include "base/containers/span.h"
#include "base/memory/raw_ref.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/bind.h"
#include "base/time/time.h"
#include "base/uuid.h"
#include "content/browser/renderer_host/frame_tree_node.h"
#include "content/browser/service_worker/embedded_worker_test_helper.h"
#include "content/browser/service_worker/service_worker_client.h"
#include "content/browser/service_worker/service_worker_consts.h"
#include "content/browser/service_worker/service_worker_container_host.h"
#include "content/browser/service_worker/service_worker_context_core.h"
#include "content/browser/service_worker/service_worker_host.h"
#include "content/browser/service_worker/service_worker_registration.h"
#include "content/common/frame.mojom.h"
#include "content/common/frame_messages.mojom.h"
#include "content/public/browser/child_process_host.h"
#include "content/public/common/alternative_error_page_override_info.mojom.h"
#include "content/public/test/policy_container_utils.h"
#include "mojo/public/cpp/bindings/pending_associated_remote.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "mojo/public/cpp/bindings/self_owned_receiver.h"
#include "mojo/public/cpp/system/data_pipe.h"
#include "mojo/public/cpp/system/data_pipe_utils.h"
#include "net/base/completion_once_callback.h"
#include "net/base/io_buffer.h"
#include "net/base/test_completion_callback.h"
#include "net/http/http_response_info.h"
#include "net/http/http_util.h"
#include "third_party/blink/public/common/loader/throttling_url_loader.h"
#include "third_party/blink/public/common/navigation/navigation_params.h"
#include "third_party/blink/public/common/storage_key/storage_key.h"
#include "third_party/blink/public/mojom/back_forward_cache_not_restored_reasons.mojom-blink.h"
#include "third_party/blink/public/mojom/loader/referrer.mojom.h"
#include "third_party/blink/public/mojom/loader/transferrable_url_loader.mojom.h"
#include "third_party/blink/public/mojom/service_worker/service_worker_registration_options.mojom.h"
#include "url/origin.h"
namespace content {
namespace {
// The minimal DidCommitProvisionalLoadParams passing mojom validation.
mojom::DidCommitProvisionalLoadParamsPtr
MinimalDidCommitNavigationLoadParams() {
auto params = mojom::DidCommitProvisionalLoadParams::New();
params->referrer = blink::mojom::Referrer::New();
params->navigation_token = base::UnguessableToken::Create();
return params;
}
class FakeNavigationClient : public mojom::NavigationClient {
public:
using ReceivedProviderInfoCallback = base::OnceCallback<void(
blink::mojom::ServiceWorkerContainerInfoForClientPtr)>;
explicit FakeNavigationClient(
ReceivedProviderInfoCallback on_received_callback)
: on_received_callback_(std::move(on_received_callback)) {}
FakeNavigationClient(const FakeNavigationClient&) = delete;
FakeNavigationClient& operator=(const FakeNavigationClient&) = delete;
~FakeNavigationClient() override = default;
private:
// mojom::NavigationClient implementation:
void CommitNavigation(
blink::mojom::CommonNavigationParamsPtr common_params,
blink::mojom::CommitNavigationParamsPtr commit_params,
network::mojom::URLResponseHeadPtr response_head,
mojo::ScopedDataPipeConsumerHandle response_body,
network::mojom::URLLoaderClientEndpointsPtr url_loader_client_endpoints,
std::unique_ptr<blink::PendingURLLoaderFactoryBundle>
subresource_loader_factories,
std::optional<std::vector<blink::mojom::TransferrableURLLoaderPtr>>
subresource_overrides,
blink::mojom::ControllerServiceWorkerInfoPtr
controller_service_worker_info,
blink::mojom::ServiceWorkerContainerInfoForClientPtr container_info,
mojo::PendingRemote<network::mojom::URLLoaderFactory>
subresource_proxying_loader_factory,
mojo::PendingRemote<network::mojom::URLLoaderFactory>
keep_alive_loader_factory,
mojo::PendingAssociatedRemote<blink::mojom::FetchLaterLoaderFactory>
fetch_later_loader_factory,
const blink::DocumentToken& document_token,
const base::UnguessableToken& devtools_navigation_token,
const base::Uuid& base_auction_nonce,
const std::optional<blink::ParsedPermissionsPolicy>& permissions_policy,
blink::mojom::PolicyContainerPtr policy_container,
mojo::PendingRemote<blink::mojom::CodeCacheHost> code_cache_host,
mojo::PendingRemote<blink::mojom::CodeCacheHost>
code_cache_host_for_background,
mojom::CookieManagerInfoPtr cookie_manager_info,
mojom::StorageInfoPtr storage_info,
CommitNavigationCallback callback) override {
std::move(on_received_callback_).Run(std::move(container_info));
std::move(callback).Run(MinimalDidCommitNavigationLoadParams(), nullptr);
}
void CommitFailedNavigation(
blink::mojom::CommonNavigationParamsPtr common_params,
blink::mojom::CommitNavigationParamsPtr commit_params,
bool has_stale_copy_in_cache,
int error_code,
int extended_error_code,
const net::ResolveErrorInfo& resolve_error_info,
const std::optional<std::string>& error_page_content,
std::unique_ptr<blink::PendingURLLoaderFactoryBundle> subresource_loaders,
const blink::DocumentToken& document_token,
blink::mojom::PolicyContainerPtr policy_container,
mojom::AlternativeErrorPageOverrideInfoPtr alternative_error_page_info,
CommitFailedNavigationCallback callback) override {
std::move(callback).Run(MinimalDidCommitNavigationLoadParams(), nullptr);
}
ReceivedProviderInfoCallback on_received_callback_;
};
class ResourceWriter {
public:
ResourceWriter(
const mojo::Remote<storage::mojom::ServiceWorkerStorageControl>& storage,
const GURL& script_url,
const std::vector<std::pair<std::string, std::string>>& headers,
const std::string& body,
const std::string& meta_data)
: storage_(storage),
script_url_(script_url),
headers_(headers),
body_(body),
meta_data_(meta_data) {}
void Start(WriteToDiskCacheCallback callback) {
DCHECK(storage_->is_connected());
callback_ = std::move(callback);
(*storage_)->GetNewResourceId(base::BindOnce(
&ResourceWriter::DidGetResourceId, base::Unretained(this)));
}
void StartWithResourceId(int64_t resource_id,
WriteToDiskCacheCallback callback) {
DCHECK(storage_->is_connected());
callback_ = std::move(callback);
DidGetResourceId(resource_id);
}
private:
void DidGetResourceId(int64_t resource_id) {
DCHECK(storage_->is_connected());
DCHECK_NE(resource_id, blink::mojom::kInvalidServiceWorkerResourceId);
resource_id_ = resource_id;
(*storage_)->CreateResourceWriter(
resource_id, body_writer_.BindNewPipeAndPassReceiver());
(*storage_)->CreateResourceMetadataWriter(
resource_id, metadata_writer_.BindNewPipeAndPassReceiver());
auto response_head = network::mojom::URLResponseHead::New();
response_head->headers = base::MakeRefCounted<net::HttpResponseHeaders>(
net::HttpUtil::AssembleRawHeaders("HTTP/1.1 200 OK\n"));
response_head->request_time = base::Time::Now();
response_head->response_time = base::Time::Now();
response_head->content_length = body_.size();
for (const auto& header : headers_)
response_head->headers->AddHeader(header.first, header.second);
body_writer_->WriteResponseHead(
std::move(response_head),
base::BindOnce(&ResourceWriter::DidWriteResponseHead,
base::Unretained(this)));
}
void DidWriteResponseHead(int result) {
DCHECK_GE(result, 0);
mojo_base::BigBuffer buffer(base::as_bytes(base::make_span(body_)));
body_writer_->WriteData(
std::move(buffer),
base::BindOnce(&ResourceWriter::DidWriteData, base::Unretained(this)));
}
void DidWriteData(int result) {
DCHECK_EQ(result, static_cast<int>(body_.size()));
mojo_base::BigBuffer buffer(base::as_bytes(base::make_span(meta_data_)));
metadata_writer_->WriteMetadata(
std::move(buffer), base::BindOnce(&ResourceWriter::DidWriteMetadata,
base::Unretained(this)));
}
void DidWriteMetadata(int result) {
DCHECK_EQ(result, static_cast<int>(meta_data_.size()));
std::move(callback_).Run(storage::mojom::ServiceWorkerResourceRecord::New(
resource_id_, script_url_, body_.size(), /*sha256_checksum=*/""));
}
const raw_ref<const mojo::Remote<storage::mojom::ServiceWorkerStorageControl>>
storage_;
const GURL script_url_;
const std::vector<std::pair<std::string, std::string>> headers_;
const std::string body_;
const std::string meta_data_;
WriteToDiskCacheCallback callback_;
int64_t resource_id_ = blink::mojom::kInvalidServiceWorkerResourceId;
mojo::Remote<storage::mojom::ServiceWorkerResourceWriter> body_writer_;
mojo::Remote<storage::mojom::ServiceWorkerResourceMetadataWriter>
metadata_writer_;
};
void OnWriteToDiskCacheFinished(
std::unique_ptr<ResourceWriter> self_owned_writer,
WriteToDiskCacheCallback callback,
storage::mojom::ServiceWorkerResourceRecordPtr record) {
std::move(callback).Run(std::move(record));
}
} // namespace
CommittedServiceWorkerClient::CommittedServiceWorkerClient(
CommittedServiceWorkerClient&& other) = default;
CommittedServiceWorkerClient::~CommittedServiceWorkerClient() = default;
CommittedServiceWorkerClient::CommittedServiceWorkerClient(
ScopedServiceWorkerClient service_worker_client,
const GlobalRenderFrameHostId& render_frame_host_id)
: service_worker_client_(std::move(service_worker_client.AsWeakPtr())) {
// Establish a dummy connection to allow sending messages without errors.
mojo::PendingRemote<network::mojom::CrossOriginEmbedderPolicyReporter>
reporter;
auto dummy = reporter.InitWithNewPipeAndPassReceiver();
// In production code this is called from NavigationRequest in the browser
// process right before navigation commit.
auto [container_info, controller_info] =
std::move(service_worker_client)
.CommitResponseAndRelease(render_frame_host_id,
PolicyContainerPolicies(),
std::move(reporter), ukm::kInvalidSourceId);
// We establish a message pipe for connecting |navigation_client_| to a fake
// navigation client, then simulate sending the navigation commit IPC which
// carries a service worker container info over it, then the container info
// received there gets its |host_remote| and |client_receiver| associated
// with a message pipe so that their users later can make Mojo calls without
// crash.
blink::mojom::ServiceWorkerContainerInfoForClientPtr received_info;
base::RunLoop loop(base::RunLoop::Type::kNestableTasksAllowed);
mojo::MakeSelfOwnedReceiver(
std::make_unique<FakeNavigationClient>(base::BindOnce(
[](base::OnceClosure quit_closure,
blink::mojom::ServiceWorkerContainerInfoForClientPtr* out_info,
blink::mojom::ServiceWorkerContainerInfoForClientPtr info) {
*out_info = std::move(info);
std::move(quit_closure).Run();
},
loop.QuitClosure(), &received_info)),
navigation_client_.BindNewPipeAndPassReceiver());
navigation_client_->CommitNavigation(
blink::CreateCommonNavigationParams(),
blink::CreateCommitNavigationParams(),
network::mojom::URLResponseHead::New(),
mojo::ScopedDataPipeConsumerHandle(),
/*url_loader_client_endpoints=*/nullptr,
/*subresource_loader_factories=*/nullptr,
/*subresource_overrides=*/std::nullopt,
/*controller_service_worker_info=*/std::move(controller_info),
std::move(container_info),
/*subresource_proxying_loader_factory=*/mojo::NullRemote(),
/*keep_alive_loader_factory=*/mojo::NullRemote(),
/*fetch_later_loader_factory=*/mojo::NullAssociatedRemote(),
/*document_token=*/blink::DocumentToken(),
/*devtools_navigation_token=*/base::UnguessableToken::Create(),
/*base_auction_nonce=*/base::Uuid::GenerateRandomV4(),
std::vector<blink::ParsedPermissionsPolicyDeclaration>(),
CreateStubPolicyContainer(), /*code_cache_host=*/mojo::NullRemote(),
/*code_cache_host_for_background=*/mojo::NullRemote(),
/*cookie_manager_info=*/nullptr,
/*storage_info=*/nullptr,
base::BindOnce(
[](mojom::DidCommitProvisionalLoadParamsPtr validated_params,
mojom::DidCommitProvisionalLoadInterfaceParamsPtr
interface_params) {}));
service_worker_client_->SetContainerReady();
loop.Run();
client_receiver_ = std::move(received_info->client_receiver);
host_remote_.Bind(std::move(received_info->host_remote));
}
CommittedServiceWorkerClient::CommittedServiceWorkerClient(
ScopedServiceWorkerClient service_worker_client)
: service_worker_client_(std::move(service_worker_client.AsWeakPtr())) {
// For worker cases the mojo call is not emulated (just not implemented).
auto [received_info, controller_info] =
std::move(service_worker_client)
.CommitResponseAndRelease(
/*render_frame_host_id=*/std::nullopt, PolicyContainerPolicies(),
/*coep_reporter=*/{}, ukm::kInvalidSourceId);
service_worker_client_->SetContainerReady();
client_receiver_ = std::move(received_info->client_receiver);
host_remote_.Bind(std::move(received_info->host_remote));
}
ServiceWorkerContainerHost& CommittedServiceWorkerClient::container_host()
const {
CHECK(service_worker_client_->container_host());
return *service_worker_client_->container_host();
}
base::OnceCallback<void(blink::ServiceWorkerStatusCode)>
ReceiveServiceWorkerStatus(std::optional<blink::ServiceWorkerStatusCode>* out,
base::OnceClosure quit_closure) {
return base::BindOnce(
[](base::OnceClosure quit_closure,
std::optional<blink::ServiceWorkerStatusCode>* out,
blink::ServiceWorkerStatusCode result) {
*out = result;
std::move(quit_closure).Run();
},
std::move(quit_closure), out);
}
blink::ServiceWorkerStatusCode WarmUpServiceWorker(
ServiceWorkerVersion* version) {
blink::ServiceWorkerStatusCode status;
base::RunLoop run_loop;
version->StartWorker(ServiceWorkerMetrics::EventType::WARM_UP,
base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status) {
status = result_status;
run_loop.Quit();
}));
run_loop.Run();
return status;
}
bool WarmUpServiceWorker(ServiceWorkerContext& service_worker_context,
const GURL& url) {
bool successed = false;
base::RunLoop run_loop;
service_worker_context.WarmUpServiceWorker(
url, blink::StorageKey::CreateFirstParty(url::Origin::Create(url)),
base::BindLambdaForTesting([&]() {
successed = true;
run_loop.Quit();
}));
run_loop.Run();
return successed;
}
blink::ServiceWorkerStatusCode StartServiceWorker(
ServiceWorkerVersion* version) {
blink::ServiceWorkerStatusCode status;
base::RunLoop run_loop;
version->StartWorker(ServiceWorkerMetrics::EventType::UNKNOWN,
base::BindLambdaForTesting(
[&](blink::ServiceWorkerStatusCode result_status) {
status = result_status;
run_loop.Quit();
}));
run_loop.Run();
return status;
}
void StopServiceWorker(ServiceWorkerVersion* version) {
base::RunLoop run_loop;
version->StopWorker(run_loop.QuitClosure());
run_loop.Run();
}
ScopedServiceWorkerClient CreateServiceWorkerClient(
ServiceWorkerContextCore* context,
bool are_ancestors_secure,
FrameTreeNodeId frame_tree_node_id) {
return ScopedServiceWorkerClient(
context->service_worker_client_owner().CreateServiceWorkerClientForWindow(
are_ancestors_secure, frame_tree_node_id));
}
ScopedServiceWorkerClient CreateServiceWorkerClient(
ServiceWorkerContextCore* context,
const GURL& document_url,
const url::Origin& top_frame_origin,
bool are_ancestors_secure,
FrameTreeNodeId frame_tree_node_id) {
ScopedServiceWorkerClient service_worker_client = CreateServiceWorkerClient(
context, are_ancestors_secure, frame_tree_node_id);
service_worker_client->UpdateUrls(
document_url, top_frame_origin,
blink::StorageKey::CreateFirstParty(top_frame_origin));
return service_worker_client;
}
ScopedServiceWorkerClient CreateServiceWorkerClient(
ServiceWorkerContextCore* context,
const GURL& document_url,
bool are_ancestors_secure,
FrameTreeNodeId frame_tree_node_id) {
return CreateServiceWorkerClient(context, document_url,
url::Origin::Create(document_url),
are_ancestors_secure, frame_tree_node_id);
}
std::unique_ptr<ServiceWorkerHost> CreateServiceWorkerHost(
int process_id,
bool is_parent_frame_secure,
ServiceWorkerVersion& hosted_version,
base::WeakPtr<ServiceWorkerContextCore> context) {
auto provider_info =
blink::mojom::ServiceWorkerProviderInfoForStartWorker::New();
auto host = std::make_unique<ServiceWorkerHost>(
provider_info->host_remote.InitWithNewEndpointAndPassReceiver(),
hosted_version, std::move(context));
mojo::PendingReceiver<service_manager::mojom::InterfaceProvider>
pending_interface_provider;
host->CompleteStartWorkerPreparation(
process_id,
provider_info->browser_interface_broker.InitWithNewPipeAndPassReceiver(),
pending_interface_provider.InitWithNewPipeAndPassRemote());
return host;
// `provider_info->host_remote`, `provider_info->browser_interface_broker` and
// `pending_interface_provider` are currently not used in tests and destroyed
// here.
}
scoped_refptr<ServiceWorkerRegistration> CreateNewServiceWorkerRegistration(
ServiceWorkerRegistry* registry,
const blink::mojom::ServiceWorkerRegistrationOptions& options,
const blink::StorageKey& key) {
scoped_refptr<ServiceWorkerRegistration> registration;
// Using nestable run loop because:
// * The CreateNewRegistration() internally uses a mojo remote and the
// receiver of the remote lives in the same process/sequence in tests.
// * When the receiver lives in the same process, a nested task is posted so
// that a mojo message sent to the receiver can be dispatched.
// * Default run loop doesn't execute nested tasks. Tests will hang when
// default run loop is used.
// TODO(bashi): Figure out a way to avoid using nested loop as it's
// problematic.
base::RunLoop run_loop(base::RunLoop::Type::kNestableTasksAllowed);
registry->CreateNewRegistration(
options, key, blink::mojom::AncestorFrameType::kNormalFrame,
base::BindLambdaForTesting(
[&](scoped_refptr<ServiceWorkerRegistration> new_registration) {
registration = std::move(new_registration);
run_loop.Quit();
}));
run_loop.Run();
DCHECK(registration);
return registration;
}
scoped_refptr<ServiceWorkerVersion> CreateNewServiceWorkerVersion(
ServiceWorkerRegistry* registry,
scoped_refptr<ServiceWorkerRegistration> registration,
const GURL& script_url,
blink::mojom::ScriptType script_type) {
scoped_refptr<ServiceWorkerVersion> version;
// See comments in CreateNewServiceWorkerRegistration() why nestable tasks
// allowed.
base::RunLoop run_loop(base::RunLoop::Type::kNestableTasksAllowed);
registry->CreateNewVersion(
std::move(registration), script_url, script_type,
base::BindLambdaForTesting(
[&](scoped_refptr<ServiceWorkerVersion> new_version) {
version = std::move(new_version);
run_loop.Quit();
}));
run_loop.Run();
DCHECK(version);
return version;
}
scoped_refptr<ServiceWorkerRegistration>
CreateServiceWorkerRegistrationAndVersion(ServiceWorkerContextCore* context,
const GURL& scope,
const GURL& script,
const blink::StorageKey& key,
int64_t resource_id) {
blink::mojom::ServiceWorkerRegistrationOptions options;
options.scope = scope;
scoped_refptr<ServiceWorkerRegistration> registration =
CreateNewServiceWorkerRegistration(context->registry(), options, key);
scoped_refptr<ServiceWorkerVersion> version =
CreateNewServiceWorkerVersion(context->registry(), registration.get(),
script, blink::mojom::ScriptType::kClassic);
std::vector<storage::mojom::ServiceWorkerResourceRecordPtr> records;
records.push_back(storage::mojom::ServiceWorkerResourceRecord::New(
resource_id, script,
/*size_bytes=*/100, /*sha256_checksum=*/""));
version->script_cache_map()->SetResources(records);
version->set_fetch_handler_type(
ServiceWorkerVersion::FetchHandlerType::kNotSkippable);
version->SetStatus(ServiceWorkerVersion::INSTALLED);
registration->SetWaitingVersion(version);
return registration;
}
storage::mojom::ServiceWorkerResourceRecordPtr WriteToDiskCacheWithIdSync(
mojo::Remote<storage::mojom::ServiceWorkerStorageControl>& storage,
const GURL& script_url,
int64_t resource_id,
const std::vector<std::pair<std::string, std::string>>& headers,
const std::string& body,
const std::string& meta_data) {
storage::mojom::ServiceWorkerResourceRecordPtr record;
ResourceWriter writer(storage, script_url, headers, body, meta_data);
base::RunLoop loop;
writer.StartWithResourceId(
resource_id,
base::BindLambdaForTesting(
[&](storage::mojom::ServiceWorkerResourceRecordPtr result) {
record = std::move(result);
loop.Quit();
}));
loop.Run();
return record;
}
storage::mojom::ServiceWorkerResourceRecordPtr WriteToDiskCacheSync(
mojo::Remote<storage::mojom::ServiceWorkerStorageControl>& storage,
const GURL& script_url,
const std::vector<std::pair<std::string, std::string>>& headers,
const std::string& body,
const std::string& meta_data) {
storage::mojom::ServiceWorkerResourceRecordPtr record;
ResourceWriter writer(storage, script_url, headers, body, meta_data);
base::RunLoop loop;
writer.Start(base::BindLambdaForTesting(
[&](storage::mojom::ServiceWorkerResourceRecordPtr result) {
record = std::move(result);
loop.Quit();
}));
loop.Run();
return record;
}
void WriteToDiskCacheAsync(
mojo::Remote<storage::mojom::ServiceWorkerStorageControl>& storage,
const GURL& script_url,
const std::vector<std::pair<std::string, std::string>>& headers,
const std::string& body,
const std::string& meta_data,
WriteToDiskCacheCallback callback) {
auto writer = std::make_unique<ResourceWriter>(storage, script_url, headers,
body, meta_data);
auto* raw_writer = writer.get();
raw_writer->Start(base::BindOnce(&OnWriteToDiskCacheFinished,
std::move(writer), std::move(callback)));
}
int64_t GetNewResourceIdSync(
mojo::Remote<storage::mojom::ServiceWorkerStorageControl>& storage) {
base::RunLoop run_loop;
int64_t resource_id;
storage->GetNewResourceId(
base::BindLambdaForTesting([&](int64_t new_resource_id) {
DCHECK_NE(new_resource_id,
blink::mojom::kInvalidServiceWorkerResourceId);
resource_id = new_resource_id;
run_loop.Quit();
}));
run_loop.Run();
return resource_id;
}
MockServiceWorkerResourceReader::MockServiceWorkerResourceReader() = default;
MockServiceWorkerResourceReader::~MockServiceWorkerResourceReader() = default;
mojo::PendingRemote<storage::mojom::ServiceWorkerResourceReader>
MockServiceWorkerResourceReader::BindNewPipeAndPassRemote(
base::OnceClosure disconnect_handler) {
auto remote = receiver_.BindNewPipeAndPassRemote();
receiver_.set_disconnect_handler(std::move(disconnect_handler));
return remote;
}
void MockServiceWorkerResourceReader::ReadResponseHead(
storage::mojom::ServiceWorkerResourceReader::ReadResponseHeadCallback
callback) {
pending_read_response_head_callback_ = std::move(callback);
}
void MockServiceWorkerResourceReader::PrepareReadData(
int64_t,
PrepareReadDataCallback callback) {
DCHECK(!body_.is_valid());
mojo::ScopedDataPipeConsumerHandle consumer;
MojoCreateDataPipeOptions options;
options.struct_size = sizeof(MojoCreateDataPipeOptions);
options.flags = MOJO_CREATE_DATA_PIPE_FLAG_NONE;
options.element_num_bytes = 1;
options.capacity_num_bytes = expected_max_data_bytes_;
mojo::CreateDataPipe(&options, body_, consumer);
std::move(callback).Run(std::move(std::move(consumer)));
}
void MockServiceWorkerResourceReader::ReadData(ReadDataCallback callback) {
// Calling `callback` anyway just to satisfy mojo constraint, but the timing
// and the argument are incorrect (e.g. `callback` should be called after all
// reads are completed). So far this is OK because no one in tests checks the
// response here.
std::move(callback).Run(0);
}
void MockServiceWorkerResourceReader::ExpectReadResponseHead(size_t len,
int result) {
expected_reads_.push(ExpectedRead(len, result));
}
void MockServiceWorkerResourceReader::ExpectReadResponseHeadOk(size_t len) {
expected_reads_.push(ExpectedRead(len, len));
}
void MockServiceWorkerResourceReader::ExpectReadData(const char* data,
size_t len,
int result) {
expected_max_data_bytes_ = std::max(expected_max_data_bytes_, len);
expected_reads_.push(ExpectedRead(data, len, result));
}
void MockServiceWorkerResourceReader::ExpectReadDataOk(
const std::string& data) {
expected_reads_.push(ExpectedRead(data.data(), data.size(), data.size()));
}
void MockServiceWorkerResourceReader::ExpectReadOk(
const std::vector<std::string>& stored_data,
const size_t bytes_stored) {
ExpectReadResponseHeadOk(bytes_stored);
for (const auto& data : stored_data)
ExpectReadDataOk(data);
}
void MockServiceWorkerResourceReader::CompletePendingRead() {
DCHECK(!expected_reads_.empty());
ExpectedRead expected = expected_reads_.front();
expected_reads_.pop();
// Make sure that all messages are received at this point.
receiver_.FlushForTesting();
if (expected.is_head) {
DCHECK(pending_read_response_head_callback_);
auto response_head = network::mojom::URLResponseHead::New();
response_head->headers =
base::MakeRefCounted<net::HttpResponseHeaders>("HTTP/1.0 200 OK\0\0");
response_head->content_length = expected.len;
std::move(pending_read_response_head_callback_)
.Run(expected.result, std::move(response_head),
/*metadata=*/std::nullopt);
} else {
if (expected.len == 0) {
body_.reset();
} else {
DCHECK(body_.is_valid());
EXPECT_TRUE(mojo::BlockingCopyFromString(
std::string(expected.data, expected.len), body_));
}
}
// Wait until the body is received by the user of the response reader.
base::RunLoop().RunUntilIdle();
}
MockServiceWorkerResourceWriter::MockServiceWorkerResourceWriter() = default;
MockServiceWorkerResourceWriter::~MockServiceWorkerResourceWriter() = default;
mojo::PendingRemote<storage::mojom::ServiceWorkerResourceWriter>
MockServiceWorkerResourceWriter::BindNewPipeAndPassRemote(
base::OnceClosure disconnect_handler) {
auto remote = receiver_.BindNewPipeAndPassRemote();
receiver_.set_disconnect_handler(std::move(disconnect_handler));
return remote;
}
void MockServiceWorkerResourceWriter::WriteResponseHead(
network::mojom::URLResponseHeadPtr response_head,
WriteResponseHeadCallback callback) {
DCHECK(!expected_writes_.empty());
ExpectedWrite write = expected_writes_.front();
EXPECT_TRUE(write.is_head);
if (write.result > 0) {
EXPECT_EQ(write.length, static_cast<size_t>(response_head->content_length));
head_written_ += response_head->content_length;
}
pending_callback_ = std::move(callback);
}
void MockServiceWorkerResourceWriter::WriteData(mojo_base::BigBuffer data,
WriteDataCallback callback) {
DCHECK(!expected_writes_.empty());
ExpectedWrite write = expected_writes_.front();
EXPECT_FALSE(write.is_head);
if (write.result > 0) {
EXPECT_EQ(write.length, data.size());
data_written_ += data.size();
}
pending_callback_ = std::move(callback);
}
void MockServiceWorkerResourceWriter::ExpectWriteResponseHeadOk(size_t length) {
ExpectWriteResponseHead(length, length);
}
void MockServiceWorkerResourceWriter::ExpectWriteDataOk(size_t length) {
ExpectWriteData(length, length);
}
void MockServiceWorkerResourceWriter::ExpectWriteResponseHead(size_t length,
int result) {
DCHECK_NE(net::ERR_IO_PENDING, result);
ExpectedWrite expected(true, length, result);
expected_writes_.push(expected);
}
void MockServiceWorkerResourceWriter::ExpectWriteData(size_t length,
int result) {
DCHECK_NE(net::ERR_IO_PENDING, result);
ExpectedWrite expected(false, length, result);
expected_writes_.push(expected);
}
void MockServiceWorkerResourceWriter::CompletePendingWrite() {
// Make sure that all messages are received at this point.
receiver_.FlushForTesting();
DCHECK(!expected_writes_.empty());
DCHECK(pending_callback_);
ExpectedWrite write = expected_writes_.front();
expected_writes_.pop();
std::move(pending_callback_).Run(write.result);
// Wait until |pending_callback_| finishes.
base::RunLoop().RunUntilIdle();
}
ServiceWorkerUpdateCheckTestUtils::ServiceWorkerUpdateCheckTestUtils() =
default;
ServiceWorkerUpdateCheckTestUtils::~ServiceWorkerUpdateCheckTestUtils() =
default;
std::unique_ptr<ServiceWorkerCacheWriter>
ServiceWorkerUpdateCheckTestUtils::CreatePausedCacheWriter(
EmbeddedWorkerTestHelper* worker_test_helper,
size_t bytes_compared,
const std::string& new_headers,
scoped_refptr<network::MojoToNetPendingBuffer> pending_network_buffer,
uint32_t consumed_size,
int64_t old_resource_id,
int64_t new_resource_id) {
mojo::Remote<storage::mojom::ServiceWorkerResourceReader> compare_reader;
worker_test_helper->context()
->registry()
->GetRemoteStorageControl()
->CreateResourceReader(old_resource_id,
compare_reader.BindNewPipeAndPassReceiver());
mojo::Remote<storage::mojom::ServiceWorkerResourceReader> copy_reader;
worker_test_helper->context()
->registry()
->GetRemoteStorageControl()
->CreateResourceReader(old_resource_id,
copy_reader.BindNewPipeAndPassReceiver());
mojo::Remote<storage::mojom::ServiceWorkerResourceWriter> writer;
worker_test_helper->context()
->registry()
->GetRemoteStorageControl()
->CreateResourceWriter(new_resource_id,
writer.BindNewPipeAndPassReceiver());
auto cache_writer = ServiceWorkerCacheWriter::CreateForComparison(
std::move(compare_reader), std::move(copy_reader), std::move(writer),
new_resource_id, /*pause_when_not_identical=*/true,
ServiceWorkerCacheWriter::ChecksumUpdateTiming::kCacheMismatch);
cache_writer->response_head_to_write_ =
network::mojom::URLResponseHead::New();
cache_writer->response_head_to_write_->request_time = base::Time::Now();
cache_writer->response_head_to_write_->response_time = base::Time::Now();
cache_writer->response_head_to_write_->headers =
base::MakeRefCounted<net::HttpResponseHeaders>(new_headers);
cache_writer->bytes_compared_ = bytes_compared;
cache_writer->data_to_write_ =
base::MakeRefCounted<net::WrappedIOBuffer>(base::make_span(
pending_network_buffer ? pending_network_buffer->buffer() : nullptr,
pending_network_buffer ? pending_network_buffer->size() : 0));
cache_writer->len_to_write_ = consumed_size;
cache_writer->bytes_written_ = 0;
cache_writer->io_pending_ = true;
cache_writer->state_ = ServiceWorkerCacheWriter::State::STATE_PAUSING;
return cache_writer;
}
std::unique_ptr<ServiceWorkerSingleScriptUpdateChecker::PausedState>
ServiceWorkerUpdateCheckTestUtils::CreateUpdateCheckerPausedState(
std::unique_ptr<ServiceWorkerCacheWriter> cache_writer,
ServiceWorkerUpdatedScriptLoader::LoaderState network_loader_state,
ServiceWorkerUpdatedScriptLoader::WriterState body_writer_state,
scoped_refptr<network::MojoToNetPendingBuffer> pending_network_buffer,
uint32_t consumed_size) {
mojo::Remote<network::mojom::URLLoaderClient> network_loader_client;
mojo::PendingReceiver<network::mojom::URLLoaderClient>
network_loader_client_receiver =
network_loader_client.BindNewPipeAndPassReceiver();
return std::make_unique<ServiceWorkerSingleScriptUpdateChecker::PausedState>(
std::move(cache_writer), /*network_loader=*/nullptr,
std::move(network_loader_client),
std::move(network_loader_client_receiver),
std::move(pending_network_buffer), consumed_size, network_loader_state,
body_writer_state);
}
void ServiceWorkerUpdateCheckTestUtils::SetComparedScriptInfoForVersion(
const GURL& script_url,
int64_t resource_id,
ServiceWorkerSingleScriptUpdateChecker::Result compare_result,
std::unique_ptr<ServiceWorkerSingleScriptUpdateChecker::PausedState>
paused_state,
ServiceWorkerVersion* version) {
std::map<GURL, ServiceWorkerUpdateChecker::ComparedScriptInfo> info_map;
info_map.emplace(script_url,
ServiceWorkerUpdateChecker::ComparedScriptInfo(
resource_id, compare_result, std::move(paused_state),
/*failure_info=*/nullptr));
version->PrepareForUpdate(
std::move(info_map),
(compare_result ==
ServiceWorkerSingleScriptUpdateChecker::Result::kDifferent)
? script_url
: GURL(),
base::MakeRefCounted<PolicyContainerHost>());
}
void ServiceWorkerUpdateCheckTestUtils::
CreateAndSetComparedScriptInfoForVersion(
const GURL& script_url,
size_t bytes_compared,
const std::string& new_headers,
const std::string& diff_data_block,
int64_t old_resource_id,
int64_t new_resource_id,
EmbeddedWorkerTestHelper* worker_test_helper,
ServiceWorkerUpdatedScriptLoader::LoaderState network_loader_state,
ServiceWorkerUpdatedScriptLoader::WriterState body_writer_state,
ServiceWorkerSingleScriptUpdateChecker::Result compare_result,
ServiceWorkerVersion* version,
mojo::ScopedDataPipeProducerHandle* out_body_handle) {
scoped_refptr<network::MojoToNetPendingBuffer> pending_buffer;
uint32_t bytes_available = 0;
if (!diff_data_block.empty()) {
mojo::ScopedDataPipeConsumerHandle network_consumer;
// Create a data pipe which has the new block sent from the network.
ASSERT_EQ(MOJO_RESULT_OK, mojo::CreateDataPipe(nullptr, *out_body_handle,
network_consumer));
ASSERT_EQ(
MOJO_RESULT_OK,
(*out_body_handle)->WriteAllData(base::as_byte_span(diff_data_block)));
base::RunLoop().RunUntilIdle();
// Read the data to make a pending buffer.
ASSERT_EQ(MOJO_RESULT_OK, network::MojoToNetPendingBuffer::BeginRead(
&network_consumer, &pending_buffer));
bytes_available = pending_buffer->size();
ASSERT_EQ(diff_data_block.size(), bytes_available);
}
auto cache_writer = CreatePausedCacheWriter(
worker_test_helper, bytes_compared, new_headers, pending_buffer,
bytes_available, old_resource_id, new_resource_id);
auto paused_state = CreateUpdateCheckerPausedState(
std::move(cache_writer), network_loader_state, body_writer_state,
pending_buffer, bytes_available);
SetComparedScriptInfoForVersion(script_url, old_resource_id, compare_result,
std::move(paused_state), version);
}
bool ServiceWorkerUpdateCheckTestUtils::VerifyStoredResponse(
int64_t resource_id,
mojo::Remote<storage::mojom::ServiceWorkerStorageControl>& storage,
const std::string& expected_body) {
DCHECK(storage);
if (resource_id == blink::mojom::kInvalidServiceWorkerResourceId)
return false;
mojo::Remote<storage::mojom::ServiceWorkerResourceReader> reader;
storage->CreateResourceReader(resource_id,
reader.BindNewPipeAndPassReceiver());
// Verify the response status.
size_t response_data_size = 0;
{
int rv;
std::string status_text;
base::RunLoop loop;
reader->ReadResponseHead(base::BindLambdaForTesting(
[&](int status, network::mojom::URLResponseHeadPtr response_head,
std::optional<mojo_base::BigBuffer> metadata) {
rv = status;
status_text = response_head->headers->GetStatusText();
response_data_size = response_head->content_length;
loop.Quit();
}));
loop.Run();
if (rv < 0)
return false;
EXPECT_LT(0, rv);
EXPECT_EQ("OK", status_text);
}
// Verify the response body.
{
mojo::ScopedDataPipeConsumerHandle data_consumer;
base::RunLoop loop;
reader->PrepareReadData(response_data_size,
base::BindLambdaForTesting(
[&](mojo::ScopedDataPipeConsumerHandle pipe) {
data_consumer = std::move(pipe);
loop.Quit();
}));
loop.Run();
int32_t rv;
base::RunLoop loop2;
reader->ReadData(base::BindLambdaForTesting([&](int32_t status) {
rv = status;
loop2.Quit();
}));
std::string body = ReadDataPipe(std::move(data_consumer));
loop2.Run();
if (rv < 0)
return false;
EXPECT_EQ(static_cast<int>(expected_body.size()), rv);
EXPECT_EQ(expected_body, body);
}
return true;
}
void ReadDataPipeInternal(mojo::DataPipeConsumerHandle handle,
std::string* result,
base::OnceClosure quit_closure) {
while (true) {
base::span<const uint8_t> buffer;
MojoResult rv = handle.BeginReadData(MOJO_READ_DATA_FLAG_NONE, buffer);
switch (rv) {
case MOJO_RESULT_BUSY:
case MOJO_RESULT_INVALID_ARGUMENT:
NOTREACHED_IN_MIGRATION();
return;
case MOJO_RESULT_FAILED_PRECONDITION:
std::move(quit_closure).Run();
return;
case MOJO_RESULT_SHOULD_WAIT:
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(&ReadDataPipeInternal, handle, result,
std::move(quit_closure)));
return;
case MOJO_RESULT_OK:
EXPECT_NE(nullptr, buffer.data());
EXPECT_GT(buffer.size(), 0u);
size_t before_size = result->size();
result->append(base::as_string_view(buffer));
size_t read_size = result->size() - before_size;
EXPECT_EQ(buffer.size(), read_size);
rv = handle.EndReadData(read_size);
EXPECT_EQ(MOJO_RESULT_OK, rv);
break;
}
}
NOTREACHED_IN_MIGRATION();
return;
}
std::string ReadDataPipe(mojo::ScopedDataPipeConsumerHandle handle) {
EXPECT_TRUE(handle.is_valid());
std::string result;
base::RunLoop loop;
ReadDataPipeInternal(handle.get(), &result, loop.QuitClosure());
loop.Run();
return result;
}
} // namespace content