Build cleanly with GCC 9
[WebKit-https.git] / Source / WebCore / workers / Worker.cpp
1 /*
2  * Copyright (C) 2008-2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All Rights Reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #include "config.h"
28 #include "Worker.h"
29
30 #include "ContentSecurityPolicy.h"
31 #include "Event.h"
32 #include "EventNames.h"
33 #include "InspectorInstrumentation.h"
34 #include "LoaderStrategy.h"
35 #include "PlatformStrategies.h"
36 #include "ResourceResponse.h"
37 #include "SecurityOrigin.h"
38 #include "WorkerGlobalScopeProxy.h"
39 #include "WorkerScriptLoader.h"
40 #include "WorkerThread.h"
41 #include <JavaScriptCore/IdentifiersFactory.h>
42 #include <wtf/HashSet.h>
43 #include <wtf/MainThread.h>
44 #include <wtf/NeverDestroyed.h>
45
46 namespace WebCore {
47
48 static HashSet<Worker*>& allWorkers()
49 {
50     static NeverDestroyed<HashSet<Worker*>> set;
51     return set;
52 }
53
54 void Worker::networkStateChanged(bool isOnLine)
55 {
56     for (auto* worker : allWorkers())
57         worker->notifyNetworkStateChange(isOnLine);
58 }
59
60 inline Worker::Worker(ScriptExecutionContext& context, JSC::RuntimeFlags runtimeFlags, const Options& options)
61     : ActiveDOMObject(&context)
62     , m_name(options.name)
63     , m_identifier("worker:" + Inspector::IdentifiersFactory::createIdentifier())
64     , m_contextProxy(WorkerGlobalScopeProxy::create(*this))
65     , m_runtimeFlags(runtimeFlags)
66 {
67     static bool addedListener;
68     if (!addedListener) {
69         platformStrategies()->loaderStrategy()->addOnlineStateChangeListener(&networkStateChanged);
70         addedListener = true;
71     }
72
73     auto addResult = allWorkers().add(this);
74     ASSERT_UNUSED(addResult, addResult.isNewEntry);
75 }
76
77 ExceptionOr<Ref<Worker>> Worker::create(ScriptExecutionContext& context, JSC::RuntimeFlags runtimeFlags, const String& url, const Options& options)
78 {
79     ASSERT(isMainThread());
80
81     // We don't currently support nested workers, so workers can only be created from documents.
82     ASSERT_WITH_SECURITY_IMPLICATION(context.isDocument());
83
84     auto worker = adoptRef(*new Worker(context, runtimeFlags, options));
85
86     worker->suspendIfNeeded();
87
88     bool shouldBypassMainWorldContentSecurityPolicy = context.shouldBypassMainWorldContentSecurityPolicy();
89     auto scriptURL = worker->resolveURL(url, shouldBypassMainWorldContentSecurityPolicy);
90     if (scriptURL.hasException())
91         return scriptURL.releaseException();
92
93     worker->m_shouldBypassMainWorldContentSecurityPolicy = shouldBypassMainWorldContentSecurityPolicy;
94
95     // The worker context does not exist while loading, so we must ensure that the worker object is not collected, nor are its event listeners.
96     worker->setPendingActivity(worker.get());
97
98     // https://html.spec.whatwg.org/multipage/workers.html#official-moment-of-creation
99     worker->m_workerCreationTime = MonotonicTime::now();
100
101     worker->m_scriptLoader = WorkerScriptLoader::create();
102     auto contentSecurityPolicyEnforcement = shouldBypassMainWorldContentSecurityPolicy ? ContentSecurityPolicyEnforcement::DoNotEnforce : ContentSecurityPolicyEnforcement::EnforceChildSrcDirective;
103
104     ResourceRequest request { scriptURL.releaseReturnValue() };
105     request.setInitiatorIdentifier(worker->m_identifier);
106
107     FetchOptions fetchOptions;
108     fetchOptions.mode = FetchOptions::Mode::SameOrigin;
109     fetchOptions.cache = FetchOptions::Cache::Default;
110     fetchOptions.redirect = FetchOptions::Redirect::Follow;
111     fetchOptions.destination = FetchOptions::Destination::Worker;
112     worker->m_scriptLoader->loadAsynchronously(context, WTFMove(request), WTFMove(fetchOptions), contentSecurityPolicyEnforcement, ServiceWorkersMode::All, worker);
113     return worker;
114 }
115
116 Worker::~Worker()
117 {
118     ASSERT(isMainThread());
119     ASSERT(scriptExecutionContext()); // The context is protected by worker context proxy, so it cannot be destroyed while a Worker exists.
120     allWorkers().remove(this);
121     m_contextProxy.workerObjectDestroyed();
122 }
123
124 ExceptionOr<void> Worker::postMessage(JSC::ExecState& state, JSC::JSValue messageValue, Vector<JSC::Strong<JSC::JSObject>>&& transfer)
125 {
126     Vector<RefPtr<MessagePort>> ports;
127     auto message = SerializedScriptValue::create(state, messageValue, WTFMove(transfer), ports, SerializationContext::WorkerPostMessage);
128     if (message.hasException())
129         return message.releaseException();
130
131     // Disentangle the port in preparation for sending it to the remote context.
132     auto channels = MessagePort::disentanglePorts(WTFMove(ports));
133     if (channels.hasException())
134         return channels.releaseException();
135
136     m_contextProxy.postMessageToWorkerGlobalScope({ message.releaseReturnValue(), channels.releaseReturnValue() });
137     return { };
138 }
139
140 void Worker::terminate()
141 {
142     m_contextProxy.terminateWorkerGlobalScope();
143 }
144
145 bool Worker::canSuspendForDocumentSuspension() const
146 {
147     // FIXME: It is not currently possible to suspend a worker, so pages with workers can not go into page cache.
148     return false;
149 }
150
151 const char* Worker::activeDOMObjectName() const
152 {
153     return "Worker";
154 }
155
156 void Worker::stop()
157 {
158     terminate();
159 }
160
161 bool Worker::hasPendingActivity() const
162 {
163     return m_contextProxy.hasPendingActivity() || ActiveDOMObject::hasPendingActivity();
164 }
165
166 void Worker::notifyNetworkStateChange(bool isOnLine)
167 {
168     m_contextProxy.notifyNetworkStateChange(isOnLine);
169 }
170
171 void Worker::didReceiveResponse(unsigned long identifier, const ResourceResponse& response)
172 {
173     const URL& responseURL = response.url();
174     if (!responseURL.protocolIsBlob() && !responseURL.protocolIs("file") && !SecurityOrigin::create(responseURL)->isUnique())
175         m_contentSecurityPolicyResponseHeaders = ContentSecurityPolicyResponseHeaders(response);
176     InspectorInstrumentation::didReceiveScriptResponse(scriptExecutionContext(), identifier);
177 }
178
179 void Worker::notifyFinished()
180 {
181     auto* context = scriptExecutionContext();
182     PAL::SessionID sessionID = context ? context->sessionID() : PAL::SessionID();
183
184     if (m_scriptLoader->failed() || !sessionID.isValid())
185         dispatchEvent(Event::create(eventNames().errorEvent, Event::CanBubble::No, Event::IsCancelable::Yes));
186     else {
187         bool isOnline = platformStrategies()->loaderStrategy()->isOnLine();
188         const ContentSecurityPolicyResponseHeaders& contentSecurityPolicyResponseHeaders = m_contentSecurityPolicyResponseHeaders ? m_contentSecurityPolicyResponseHeaders.value() : scriptExecutionContext()->contentSecurityPolicy()->responseHeaders();
189         m_contextProxy.startWorkerGlobalScope(m_scriptLoader->url(), m_name, scriptExecutionContext()->userAgent(m_scriptLoader->url()), isOnline, m_scriptLoader->script(), contentSecurityPolicyResponseHeaders, m_shouldBypassMainWorldContentSecurityPolicy, m_workerCreationTime, m_runtimeFlags, sessionID);
190         InspectorInstrumentation::scriptImported(*scriptExecutionContext(), m_scriptLoader->identifier(), m_scriptLoader->script());
191     }
192     m_scriptLoader = nullptr;
193
194     unsetPendingActivity(*this);
195 }
196
197 } // namespace WebCore