Deprecate ActiveDOMObject::canSuspendForDocumentSuspension()
[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 "ErrorEvent.h"
32 #include "Event.h"
33 #include "EventNames.h"
34 #include "InspectorInstrumentation.h"
35 #include "LoaderStrategy.h"
36 #include "PlatformStrategies.h"
37 #include "ResourceResponse.h"
38 #include "SecurityOrigin.h"
39 #include "WorkerGlobalScopeProxy.h"
40 #include "WorkerScriptLoader.h"
41 #include "WorkerThread.h"
42 #include <JavaScriptCore/IdentifiersFactory.h>
43 #include <JavaScriptCore/ScriptCallStack.h>
44 #include <wtf/HashSet.h>
45 #include <wtf/IsoMallocInlines.h>
46 #include <wtf/MainThread.h>
47 #include <wtf/NeverDestroyed.h>
48 #include <wtf/Scope.h>
49
50 namespace WebCore {
51
52 WTF_MAKE_ISO_ALLOCATED_IMPL(Worker);
53
54 static HashSet<Worker*>& allWorkers()
55 {
56     static NeverDestroyed<HashSet<Worker*>> set;
57     return set;
58 }
59
60 void Worker::networkStateChanged(bool isOnLine)
61 {
62     for (auto* worker : allWorkers())
63         worker->notifyNetworkStateChange(isOnLine);
64 }
65
66 inline Worker::Worker(ScriptExecutionContext& context, JSC::RuntimeFlags runtimeFlags, const Options& options)
67     : ActiveDOMObject(&context)
68     , m_name(options.name)
69     , m_identifier("worker:" + Inspector::IdentifiersFactory::createIdentifier())
70     , m_contextProxy(WorkerGlobalScopeProxy::create(*this))
71     , m_runtimeFlags(runtimeFlags)
72     , m_eventQueue(GenericEventQueue::create(*this))
73 {
74     static bool addedListener;
75     if (!addedListener) {
76         platformStrategies()->loaderStrategy()->addOnlineStateChangeListener(&networkStateChanged);
77         addedListener = true;
78     }
79
80     auto addResult = allWorkers().add(this);
81     ASSERT_UNUSED(addResult, addResult.isNewEntry);
82 }
83
84 ExceptionOr<Ref<Worker>> Worker::create(ScriptExecutionContext& context, JSC::RuntimeFlags runtimeFlags, const String& url, const Options& options)
85 {
86     ASSERT(isMainThread());
87
88     // We don't currently support nested workers, so workers can only be created from documents.
89     ASSERT_WITH_SECURITY_IMPLICATION(context.isDocument());
90
91     auto worker = adoptRef(*new Worker(context, runtimeFlags, options));
92
93     worker->suspendIfNeeded();
94
95     bool shouldBypassMainWorldContentSecurityPolicy = context.shouldBypassMainWorldContentSecurityPolicy();
96     auto scriptURL = worker->resolveURL(url, shouldBypassMainWorldContentSecurityPolicy);
97     if (scriptURL.hasException())
98         return scriptURL.releaseException();
99
100     worker->m_shouldBypassMainWorldContentSecurityPolicy = shouldBypassMainWorldContentSecurityPolicy;
101
102     // The worker context does not exist while loading, so we must ensure that the worker object is not collected, nor are its event listeners.
103     worker->setPendingActivity(worker.get());
104
105     // https://html.spec.whatwg.org/multipage/workers.html#official-moment-of-creation
106     worker->m_workerCreationTime = MonotonicTime::now();
107
108     worker->m_scriptLoader = WorkerScriptLoader::create();
109     auto contentSecurityPolicyEnforcement = shouldBypassMainWorldContentSecurityPolicy ? ContentSecurityPolicyEnforcement::DoNotEnforce : ContentSecurityPolicyEnforcement::EnforceChildSrcDirective;
110
111     ResourceRequest request { scriptURL.releaseReturnValue() };
112     request.setInitiatorIdentifier(worker->m_identifier);
113
114     FetchOptions fetchOptions;
115     fetchOptions.mode = FetchOptions::Mode::SameOrigin;
116     fetchOptions.cache = FetchOptions::Cache::Default;
117     fetchOptions.redirect = FetchOptions::Redirect::Follow;
118     fetchOptions.destination = FetchOptions::Destination::Worker;
119     worker->m_scriptLoader->loadAsynchronously(context, WTFMove(request), WTFMove(fetchOptions), contentSecurityPolicyEnforcement, ServiceWorkersMode::All, worker);
120     return worker;
121 }
122
123 Worker::~Worker()
124 {
125     ASSERT(isMainThread());
126     ASSERT(scriptExecutionContext()); // The context is protected by worker context proxy, so it cannot be destroyed while a Worker exists.
127     allWorkers().remove(this);
128     m_contextProxy.workerObjectDestroyed();
129 }
130
131 ExceptionOr<void> Worker::postMessage(JSC::ExecState& state, JSC::JSValue messageValue, Vector<JSC::Strong<JSC::JSObject>>&& transfer)
132 {
133     Vector<RefPtr<MessagePort>> ports;
134     auto message = SerializedScriptValue::create(state, messageValue, WTFMove(transfer), ports, SerializationContext::WorkerPostMessage);
135     if (message.hasException())
136         return message.releaseException();
137
138     // Disentangle the port in preparation for sending it to the remote context.
139     auto channels = MessagePort::disentanglePorts(WTFMove(ports));
140     if (channels.hasException())
141         return channels.releaseException();
142
143     m_contextProxy.postMessageToWorkerGlobalScope({ message.releaseReturnValue(), channels.releaseReturnValue() });
144     return { };
145 }
146
147 void Worker::terminate()
148 {
149     m_contextProxy.terminateWorkerGlobalScope();
150     m_eventQueue->cancelAllEvents();
151 }
152
153 const char* Worker::activeDOMObjectName() const
154 {
155     return "Worker";
156 }
157
158 void Worker::stop()
159 {
160     terminate();
161 }
162
163 bool Worker::hasPendingActivity() const
164 {
165     return m_contextProxy.hasPendingActivity() || ActiveDOMObject::hasPendingActivity() || m_eventQueue->hasPendingEvents();
166 }
167
168 void Worker::notifyNetworkStateChange(bool isOnLine)
169 {
170     m_contextProxy.notifyNetworkStateChange(isOnLine);
171 }
172
173 void Worker::didReceiveResponse(unsigned long identifier, const ResourceResponse& response)
174 {
175     const URL& responseURL = response.url();
176     if (!responseURL.protocolIsBlob() && !responseURL.protocolIs("file") && !SecurityOrigin::create(responseURL)->isUnique())
177         m_contentSecurityPolicyResponseHeaders = ContentSecurityPolicyResponseHeaders(response);
178     InspectorInstrumentation::didReceiveScriptResponse(scriptExecutionContext(), identifier);
179 }
180
181 void Worker::notifyFinished()
182 {
183     auto clearLoader = makeScopeExit([this] {
184         m_scriptLoader = nullptr;
185         unsetPendingActivity(*this);
186     });
187
188     auto* context = scriptExecutionContext();
189     if (!context)
190         return;
191
192     if (m_scriptLoader->failed()) {
193         enqueueEvent(Event::create(eventNames().errorEvent, Event::CanBubble::No, Event::IsCancelable::Yes));
194         return;
195     }
196
197     bool isOnline = platformStrategies()->loaderStrategy()->isOnLine();
198     const ContentSecurityPolicyResponseHeaders& contentSecurityPolicyResponseHeaders = m_contentSecurityPolicyResponseHeaders ? m_contentSecurityPolicyResponseHeaders.value() : context->contentSecurityPolicy()->responseHeaders();
199     m_contextProxy.startWorkerGlobalScope(m_scriptLoader->url(), m_name, context->userAgent(m_scriptLoader->url()), isOnline, m_scriptLoader->script(), contentSecurityPolicyResponseHeaders, m_shouldBypassMainWorldContentSecurityPolicy, m_workerCreationTime, m_runtimeFlags);
200     InspectorInstrumentation::scriptImported(*context, m_scriptLoader->identifier(), m_scriptLoader->script());
201 }
202
203 void Worker::enqueueEvent(Ref<Event>&& event)
204 {
205     m_eventQueue->enqueueEvent(WTFMove(event));
206 }
207
208 void Worker::dispatchEvent(Event& event)
209 {
210     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(!m_eventQueue->isSuspended());
211
212     AbstractWorker::dispatchEvent(event);
213     if (is<ErrorEvent>(event) && !event.defaultPrevented() && event.isTrusted() && scriptExecutionContext()) {
214         auto& errorEvent = downcast<ErrorEvent>(event);
215         scriptExecutionContext()->reportException(errorEvent.message(), errorEvent.lineno(), errorEvent.colno(), errorEvent.filename(), nullptr, nullptr);
216     }
217 }
218
219 } // namespace WebCore