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
|
/*
* Copyright (C) 2017 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "ClientOrigin.h"
#include "ContentSecurityPolicyResponseHeaders.h"
#include "CrossOriginEmbedderPolicy.h"
#include "ScriptExecutionContextIdentifier.h"
#include "ServiceWorkerClientData.h"
#include "ServiceWorkerContextData.h"
#include "ServiceWorkerData.h"
#include "ServiceWorkerIdentifier.h"
#include "ServiceWorkerRegistrationKey.h"
#include "ServiceWorkerTypes.h"
#include "Site.h"
#include "Timer.h"
#include <wtf/ApproximateTime.h>
#include <wtf/CompletionHandler.h>
#include <wtf/RefCountedAndCanMakeWeakPtr.h>
#include <wtf/RobinHoodHashMap.h>
#include <wtf/URLHash.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class SWServer;
class SWServerRegistration;
class SWServerToContextConnection;
struct ServiceWorkerClientQueryOptions;
struct ServiceWorkerContextData;
struct ServiceWorkerJobDataIdentifier;
enum class WorkerThreadMode : bool;
enum class WorkerType : bool;
class SWServerWorker : public RefCountedAndCanMakeWeakPtr<SWServerWorker> {
public:
template <typename... Args> static Ref<SWServerWorker> create(Args&&... args)
{
return adoptRef(*new SWServerWorker(std::forward<Args>(args)...));
}
SWServerWorker(const SWServerWorker&) = delete;
WEBCORE_EXPORT ~SWServerWorker();
WEBCORE_EXPORT void terminate(CompletionHandler<void()>&& = [] { });
WEBCORE_EXPORT void whenTerminated(CompletionHandler<void()>&&);
WEBCORE_EXPORT void whenActivated(CompletionHandler<void(bool)>&&);
enum class State {
Running,
Terminating,
NotRunning,
};
bool isRunning() const { return m_state == State::Running; }
bool isTerminating() const { return m_state == State::Terminating; }
bool isNotRunning() const { return m_state == State::NotRunning; }
void setState(State);
SWServer* server() { return m_server.get(); }
const ServiceWorkerRegistrationKey& registrationKey() const { return m_registrationKey; }
RegistrableDomain firstPartyForCookies() const { return m_registrationKey.firstPartyForCookies(); }
const URL& scriptURL() const { return m_data.scriptURL; }
const ScriptBuffer& script() const { return m_script; }
const CertificateInfo& certificateInfo() const { return m_certificateInfo; }
WorkerType type() const { return m_data.type; }
ServiceWorkerIdentifier identifier() const { return m_data.identifier; }
ServiceWorkerState state() const { return m_data.state; }
bool isActive() const { return m_data.state == ServiceWorkerState::Activated || m_data.state == ServiceWorkerState::Activating; }
void setState(ServiceWorkerState);
bool hasPendingEvents() const { return m_hasPendingEvents; }
void setHasPendingEvents(bool);
void scriptContextFailedToStart(const std::optional<ServiceWorkerJobDataIdentifier>&, const String& message);
void scriptContextStarted(const std::optional<ServiceWorkerJobDataIdentifier>&, bool doesHandleFetch);
void didFinishInstall(const std::optional<ServiceWorkerJobDataIdentifier>&, bool wasSuccessful);
void didFinishActivation();
void contextTerminated();
WEBCORE_EXPORT std::optional<ServiceWorkerClientData> findClientByIdentifier(const ScriptExecutionContextIdentifier&) const;
WEBCORE_EXPORT void findClientByVisibleIdentifier(const String& clientIdentifier, CompletionHandler<void(std::optional<WebCore::ServiceWorkerClientData>&&)>&&);
void matchAll(const ServiceWorkerClientQueryOptions&, ServiceWorkerClientsMatchAllCallback&&);
void setScriptResource(URL&&, ServiceWorkerContextData::ImportedScript&&);
void didSaveScriptsToDisk(ScriptBuffer&& mainScript, MemoryCompactRobinHoodHashMap<URL, ScriptBuffer>&& importedScripts);
WEBCORE_EXPORT void skipWaiting();
bool isSkipWaitingFlagSet() const { return m_isSkipWaitingFlagSet; }
WEBCORE_EXPORT static SWServerWorker* existingWorkerForIdentifier(ServiceWorkerIdentifier);
static HashMap<ServiceWorkerIdentifier, WeakRef<SWServerWorker>>& allWorkers();
const ServiceWorkerData& data() const { return m_data; }
ServiceWorkerContextData contextData() const;
WEBCORE_EXPORT const ClientOrigin& origin() const;
const RegistrableDomain& topRegistrableDomain() const { return m_topSite.domain(); }
const Site& topSite() const { return m_topSite; }
WEBCORE_EXPORT std::optional<ScriptExecutionContextIdentifier> serviceWorkerPageIdentifier() const;
WEBCORE_EXPORT SWServerToContextConnection* contextConnection();
String userAgent() const;
bool shouldSkipFetchEvent() const { return m_shouldSkipHandleFetch; }
WEBCORE_EXPORT SWServerRegistration* registration() const;
void setHasTimedOutAnyFetchTasks() { m_hasTimedOutAnyFetchTasks = true; }
bool hasTimedOutAnyFetchTasks() const { return m_hasTimedOutAnyFetchTasks; }
void didFailHeartBeatCheck();
void updateAppInitiatedValue(LastNavigationWasAppInitiated);
WorkerThreadMode workerThreadMode() const;
void incrementFunctionalEventCounter() { ++m_functionalEventCounter; }
void decrementFunctionalEventCounter();
void setAsInspected(bool);
bool shouldContinue() const { return !!m_functionalEventCounter || m_isInspected; }
WEBCORE_EXPORT bool isClientActiveServiceWorker(ScriptExecutionContextIdentifier) const;
Vector<URL> importedScriptURLs() const;
const MemoryCompactRobinHoodHashMap<URL, ServiceWorkerContextData::ImportedScript>& scriptResourceMap() const { return m_scriptResourceMap; }
bool matchingImportedScripts(const Vector<std::pair<URL, ScriptBuffer>>&) const;
void markActivateEventAsFired() { m_isActivateEventFired = true; }
void needsRunning() { m_lastNeedRunningTime = ApproximateTime::now(); }
bool isIdle(Seconds) const;
private:
SWServerWorker(SWServer&, SWServerRegistration&, const URL&, const ScriptBuffer&, const CertificateInfo&, const ContentSecurityPolicyResponseHeaders&, const CrossOriginEmbedderPolicy&, String&& referrerPolicy, WorkerType, ServiceWorkerIdentifier, MemoryCompactRobinHoodHashMap<URL, ServiceWorkerContextData::ImportedScript>&&);
void callWhenActivatedHandler(bool success);
void startTermination(CompletionHandler<void()>&&);
void terminationCompleted();
void terminationTimerFired();
void terminationIfPossibleTimerFired();
void callTerminationCallbacks();
void terminateIfPossible();
bool shouldBeTerminated() const;
RefPtr<SWServer> protectedServer() const;
WeakPtr<SWServer> m_server;
ServiceWorkerRegistrationKey m_registrationKey;
WeakPtr<SWServerRegistration> m_registration;
ServiceWorkerData m_data;
ScriptBuffer m_script;
CertificateInfo m_certificateInfo;
ContentSecurityPolicyResponseHeaders m_contentSecurityPolicy;
CrossOriginEmbedderPolicy m_crossOriginEmbedderPolicy;
String m_referrerPolicy;
bool m_hasPendingEvents { false };
State m_state { State::NotRunning };
mutable std::optional<ClientOrigin> m_origin;
Site m_topSite;
bool m_isSkipWaitingFlagSet { false };
Vector<CompletionHandler<void(bool)>> m_whenActivatedHandlers;
MemoryCompactRobinHoodHashMap<URL, ServiceWorkerContextData::ImportedScript> m_scriptResourceMap;
bool m_shouldSkipHandleFetch { false };
bool m_hasTimedOutAnyFetchTasks { false };
Vector<CompletionHandler<void()>> m_terminationCallbacks;
Timer m_terminationTimer;
Timer m_terminationIfPossibleTimer;
LastNavigationWasAppInitiated m_lastNavigationWasAppInitiated;
int m_functionalEventCounter { 0 };
bool m_isInspected { false };
bool m_isActivateEventFired { false };
ApproximateTime m_lastNeedRunningTime;
};
} // namespace WebCore
|
