Implement "UpdateWorkerState" and use it
[WebKit-https.git] / Source / WebCore / workers / service / server / SWClientConnection.cpp
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "SWClientConnection.h"
28
29 #if ENABLE(SERVICE_WORKER)
30
31 #include "Document.h"
32 #include "ExceptionData.h"
33 #include "MessageEvent.h"
34 #include "ServiceWorkerContainer.h"
35 #include "ServiceWorkerFetchResult.h"
36 #include "ServiceWorkerJobData.h"
37 #include "ServiceWorkerRegistration.h"
38
39 namespace WebCore {
40
41 SWClientConnection::SWClientConnection() = default;
42
43 SWClientConnection::~SWClientConnection() = default;
44
45 void SWClientConnection::scheduleJob(ServiceWorkerJob& job)
46 {
47     auto addResult = m_scheduledJobs.add(job.data().identifier(), &job);
48     ASSERT_UNUSED(addResult, addResult.isNewEntry);
49
50     scheduleJobInServer(job.data());
51 }
52
53 void SWClientConnection::finishedFetchingScript(ServiceWorkerJob& job, const String& script)
54 {
55     ASSERT(m_scheduledJobs.get(job.data().identifier()) == &job);
56
57     finishFetchingScriptInServer({ job.data().identifier(), job.data().connectionIdentifier(), job.data().registrationKey(), script, { } });
58 }
59
60 void SWClientConnection::failedFetchingScript(ServiceWorkerJob& job, const ResourceError& error)
61 {
62     ASSERT(m_scheduledJobs.get(job.data().identifier()) == &job);
63
64     finishFetchingScriptInServer({ job.data().identifier(), job.data().connectionIdentifier(), job.data().registrationKey(), { }, error });
65 }
66
67 void SWClientConnection::jobRejectedInServer(uint64_t jobIdentifier, const ExceptionData& exceptionData)
68 {
69     auto job = m_scheduledJobs.take(jobIdentifier);
70     if (!job) {
71         LOG_ERROR("Job %" PRIu64 " rejected from server, but was not found", jobIdentifier);
72         return;
73     }
74
75     job->failedWithException(exceptionData.toException());
76 }
77
78 void SWClientConnection::registrationJobResolvedInServer(uint64_t jobIdentifier, ServiceWorkerRegistrationData&& registrationData)
79 {
80     auto job = m_scheduledJobs.take(jobIdentifier);
81     if (!job) {
82         LOG_ERROR("Job %" PRIu64 " resolved in server, but was not found", jobIdentifier);
83         return;
84     }
85
86     job->resolvedWithRegistration(WTFMove(registrationData));
87 }
88
89 void SWClientConnection::unregistrationJobResolvedInServer(uint64_t jobIdentifier, bool unregistrationResult)
90 {
91     auto job = m_scheduledJobs.take(jobIdentifier);
92     if (!job) {
93         LOG_ERROR("Job %" PRIu64 " resolved in server, but was not found", jobIdentifier);
94         return;
95     }
96
97     job->resolvedWithUnregistrationResult(unregistrationResult);
98 }
99
100 void SWClientConnection::startScriptFetchForServer(uint64_t jobIdentifier)
101 {
102     auto job = m_scheduledJobs.get(jobIdentifier);
103     if (!job) {
104         LOG_ERROR("Job %" PRIu64 " instructed to start fetch from server, but job was not found", jobIdentifier);
105
106         // FIXME: Should message back to the server here to signal failure to fetch,
107         // but we currently need the registration key to do so, and don't have it here.
108         // In the future we'll refactor to have a global, cross-process job identifier that can be used to overcome this.
109
110         return;
111     }
112
113     job->startScriptFetch();
114 }
115
116 void SWClientConnection::postMessageToServiceWorkerClient(uint64_t destinationScriptExecutionContextIdentifier, Ref<SerializedScriptValue>&& message, ServiceWorkerIdentifier sourceIdentifier, const String& sourceOrigin)
117 {
118     // FIXME: destinationScriptExecutionContextIdentifier can only identify a Document at the moment.
119     auto* destinationDocument = Document::allDocumentsMap().get(destinationScriptExecutionContextIdentifier);
120     if (!destinationDocument)
121         return;
122
123     auto* container = destinationDocument->serviceWorkerContainer();
124     if (!container)
125         return;
126
127     std::optional<MessageEventSource> source;
128     auto* activeServiceWorker = destinationDocument->activeServiceWorker();
129     if (activeServiceWorker && activeServiceWorker->identifier() == sourceIdentifier)
130         source = MessageEventSource { RefPtr<ServiceWorker> { activeServiceWorker } };
131     else {
132         // FIXME: Pass in valid scriptURL.
133         source = MessageEventSource { RefPtr<ServiceWorker> { ServiceWorker::create(*destinationDocument, sourceIdentifier, URL()) } };
134     }
135
136     // FIXME: We should pass in ports.
137     auto messageEvent = MessageEvent::create({ }, WTFMove(message), sourceOrigin, { }, WTFMove(source));
138     container->dispatchEvent(messageEvent);
139 }
140
141 void SWClientConnection::forEachContainer(const WTF::Function<void(ServiceWorkerContainer&)>& apply)
142 {
143     // FIXME: We should iterate over all service worker clients, not only documents.
144     for (auto& document : Document::allDocuments()) {
145         if (auto* container = document->serviceWorkerContainer())
146             apply(*container);
147     }
148 }
149
150 void SWClientConnection::updateRegistrationState(const ServiceWorkerRegistrationKey& key, ServiceWorkerRegistrationState state, std::optional<ServiceWorkerIdentifier> serviceWorkerIdentifier)
151 {
152     forEachContainer([&](ServiceWorkerContainer& container) {
153         container.updateRegistrationState(key, state, serviceWorkerIdentifier);
154     });
155 }
156
157 void SWClientConnection::updateWorkerState(ServiceWorkerIdentifier worker, ServiceWorkerState state)
158 {
159     const auto& matchingWorkers = ServiceWorker::allWorkers().get(worker);
160     
161     for (auto* worker : matchingWorkers)
162         worker->updateWorkerState(state);
163 }
164
165 void SWClientConnection::fireUpdateFoundEvent(const ServiceWorkerRegistrationKey& key)
166 {
167     forEachContainer([&](ServiceWorkerContainer& container) {
168         container.fireUpdateFoundEvent(key);
169     });
170 }
171
172 void SWClientConnection::firePostInstallEvents(const ServiceWorkerRegistrationKey& key)
173 {
174     forEachContainer([&](ServiceWorkerContainer& container) {
175         container.firePostInstallEvents(key);
176     });
177 }
178
179 } // namespace WebCore
180
181 #endif // ENABLE(SERVICE_WORKER)