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
|
/*
* 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 <WebCore/BackgroundFetchInformation.h>
#include <WebCore/NotificationClient.h>
#include <WebCore/NotificationEventType.h>
#include <WebCore/PushSubscriptionData.h>
#include <WebCore/ScriptExecutionContextIdentifier.h>
#include <WebCore/ServiceWorkerContextData.h>
#include <WebCore/ServiceWorkerFetch.h>
#include <WebCore/ServiceWorkerIdentifier.h>
#include <WebCore/Settings.h>
#include <WebCore/Timer.h>
#include <WebCore/WorkerThread.h>
#include <wtf/CheckedRef.h>
#include <wtf/OptionSet.h>
namespace WebCore {
class CacheStorageProvider;
class ContentSecurityPolicyResponseHeaders;
class ExtendableEvent;
class MessagePortChannel;
class SerializedScriptValue;
class WorkerObjectProxy;
struct MessageWithMessagePorts;
struct NotificationData;
struct NotificationPayload;
enum class AdvancedPrivacyProtections : uint16_t;
class ServiceWorkerThread final : public WorkerThread {
public:
static Ref<ServiceWorkerThread> create(ServiceWorkerContextData&&, ServiceWorkerData&&, String&& userAgent, WorkerThreadMode, const SettingsValues&, WorkerLoaderProxy&, WorkerDebuggerProxy&, WorkerBadgeProxy&, IDBClient::IDBConnectionProxy*, SocketProvider*, std::unique_ptr<NotificationClient>&&, PAL::SessionID, std::optional<uint64_t>, OptionSet<AdvancedPrivacyProtections>);
virtual ~ServiceWorkerThread();
WorkerObjectProxy& workerObjectProxy() const;
void start(Function<void(const String&, bool)>&&);
void willPostTaskToFireInstallEvent();
void willPostTaskToFireActivateEvent();
void willPostTaskToFireMessageEvent();
void willPostTaskToFirePushSubscriptionChangeEvent();
void queueTaskToFireFetchEvent(Ref<ServiceWorkerFetch::Client>&&, ResourceRequest&&, String&& referrer, FetchOptions&&, SWServerConnectionIdentifier, FetchIdentifier, bool isServiceWorkerNavigationPreloadEnabled, String&& clientIdentifier, String&& resultingClientIdentifier);
void queueTaskToPostMessage(MessageWithMessagePorts&&, ServiceWorkerOrClientData&& sourceData);
void queueTaskToFireInstallEvent();
void queueTaskToFireActivateEvent();
void queueTaskToFirePushEvent(std::optional<Vector<uint8_t>>&&, std::optional<NotificationPayload>&&, Function<void(bool, std::optional<NotificationPayload>&&)>&&);
#if ENABLE(DECLARATIVE_WEB_PUSH)
void queueTaskToFireDeclarativePushEvent(NotificationPayload&&, Function<void(bool, std::optional<NotificationPayload>&&)>&&);
#endif
void queueTaskToFirePushSubscriptionChangeEvent(std::optional<PushSubscriptionData>&& newSubscriptionData, std::optional<PushSubscriptionData>&& oldSubscriptionData);
#if ENABLE(NOTIFICATION_EVENT)
void queueTaskToFireNotificationEvent(NotificationData&&, NotificationEventType, Function<void(bool)>&&);
#endif
void queueTaskToFireBackgroundFetchEvent(BackgroundFetchInformation&&, Function<void(bool)>&&);
void queueTaskToFireBackgroundFetchClickEvent(BackgroundFetchInformation&&, Function<void(bool)>&&);
ServiceWorkerIdentifier identifier() const { return m_serviceWorkerIdentifier; }
std::optional<ServiceWorkerJobDataIdentifier> jobDataIdentifier() const { return m_jobDataIdentifier; }
bool doesHandleFetch() const { return m_doesHandleFetch; }
void startFetchEventMonitoring();
void stopFetchEventMonitoring() { m_isHandlingFetchEvent = false; }
void startFunctionalEventMonitoring();
void stopFunctionalEventMonitoring() { m_isHandlingFunctionalEvent = false; }
void startNotificationPayloadFunctionalEventMonitoring();
void stopNotificationPayloadFunctionalEventMonitoring() { m_isHandlingNotificationPayloadFunctionalEvent = false; }
protected:
Ref<WorkerGlobalScope> createWorkerGlobalScope(const WorkerParameters&, Ref<SecurityOrigin>&&, Ref<SecurityOrigin>&& topOrigin) final;
void runEventLoop() override;
private:
WEBCORE_EXPORT ServiceWorkerThread(ServiceWorkerContextData&&, ServiceWorkerData&&, String&& userAgent, WorkerThreadMode, const SettingsValues&, WorkerLoaderProxy&, WorkerDebuggerProxy&, WorkerBadgeProxy&, IDBClient::IDBConnectionProxy*, SocketProvider*, std::unique_ptr<NotificationClient>&&, PAL::SessionID, std::optional<uint64_t>, OptionSet<AdvancedPrivacyProtections>);
ASCIILiteral threadName() const final { return "WebCore: ServiceWorker"_s; }
void finishedEvaluatingScript() final;
bool isServiceWorkerThread() const final { return true; }
void finishedFiringInstallEvent(bool hasRejectedAnyPromise);
void finishedFiringActivateEvent();
void finishedFiringMessageEvent();
void finishedFiringPushSubscriptionChangeEvent();
void finishedStarting();
void startHeartBeatTimer();
void heartBeatTimerFired();
void installEventTimerFired();
ServiceWorkerIdentifier m_serviceWorkerIdentifier;
std::optional<ServiceWorkerJobDataIdentifier> m_jobDataIdentifier;
std::optional<ServiceWorkerContextData> m_contextData; // Becomes std::nullopt after the ServiceWorkerGlobalScope has been created.
std::optional<ServiceWorkerData> m_workerData; // Becomes std::nullopt after the ServiceWorkerGlobalScope has been created.
const CheckedRef<WorkerObjectProxy> m_workerObjectProxy;
bool m_doesHandleFetch { false };
bool m_isHandlingFetchEvent { false };
bool m_isHandlingFunctionalEvent { false };
bool m_isHandlingNotificationPayloadFunctionalEvent { false };
uint64_t m_pushSubscriptionChangeEventCount { 0 };
uint64_t m_messageEventCount { 0 };
enum class State { Idle, Starting, Installing, Activating };
State m_state { State::Idle };
bool m_ongoingHeartBeatCheck { false };
static constexpr Seconds heartBeatTimeout { 60_s };
static constexpr Seconds heartBeatTimeoutForTest { 1_s };
Seconds m_heartBeatTimeout { heartBeatTimeout };
Timer m_heartBeatTimer;
std::unique_ptr<NotificationClient> m_notificationClient;
};
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ServiceWorkerThread)
static bool isType(const WebCore::WorkerOrWorkletThread& thread) { return thread.isServiceWorkerThread(); }
SPECIALIZE_TYPE_TRAITS_END()
|
