blob: 68badf08929a5023d6097fec7602767defedf3ee [file] [log] [blame]
/*
* Copyright (C) 2009, 2010 Google Inc. All rights reserved.
* Copyright (C) 2016 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:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
* OWNER OR 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.
*/
#include "config.h"
#include "WorkerThreadableLoader.h"
#include "ContentSecurityPolicy.h"
#include "DedicatedWorkerGlobalScope.h"
#include "Document.h"
#include "DocumentThreadableLoader.h"
#include "InspectorInstrumentation.h"
#include "Performance.h"
#include "ResourceError.h"
#include "ResourceRequest.h"
#include "ResourceResponse.h"
#include "ResourceTiming.h"
#include "SecurityOrigin.h"
#include "ServiceWorker.h"
#include "ServiceWorkerGlobalScope.h"
#include "ThreadableLoader.h"
#include "WorkerGlobalScope.h"
#include "WorkerLoaderProxy.h"
#include "WorkerOrWorkletGlobalScope.h"
#include "WorkerThread.h"
#include <wtf/MainThread.h>
#include <wtf/Vector.h>
namespace WebCore {
WorkerThreadableLoader::WorkerThreadableLoader(WorkerOrWorkletGlobalScope& workerOrWorkletGlobalScope, ThreadableLoaderClient& client, const String& taskMode, ResourceRequest&& request, const ThreadableLoaderOptions& options, const String& referrer)
: m_workerClientWrapper(ThreadableLoaderClientWrapper::create(client, options.initiator))
, m_bridge(*new MainThreadBridge(m_workerClientWrapper.get(), workerOrWorkletGlobalScope.workerOrWorkletThread()->workerLoaderProxy(), workerOrWorkletGlobalScope.identifier(), taskMode, WTFMove(request), options, referrer.isEmpty() ? workerOrWorkletGlobalScope.url().strippedForUseAsReferrer() : referrer, workerOrWorkletGlobalScope))
{
}
WorkerThreadableLoader::~WorkerThreadableLoader()
{
m_bridge.destroy();
}
void WorkerThreadableLoader::loadResourceSynchronously(WorkerOrWorkletGlobalScope& workerOrWorkletGlobalScope, ResourceRequest&& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
{
WorkerRunLoop& runLoop = workerOrWorkletGlobalScope.workerOrWorkletThread()->runLoop();
// Create a unique mode just for this synchronous resource load.
auto mode = makeString("loadResourceSynchronouslyMode", runLoop.createUniqueId());
auto loader = WorkerThreadableLoader::create(workerOrWorkletGlobalScope, client, mode, WTFMove(request), options, String());
bool success = true;
while (!loader->done() && success)
success = runLoop.runInMode(&workerOrWorkletGlobalScope, mode);
if (!loader->done() && !success)
loader->cancel();
}
void WorkerThreadableLoader::cancel()
{
m_bridge.cancel();
}
void WorkerThreadableLoader::computeIsDone()
{
m_bridge.computeIsDone();
}
struct LoaderTaskOptions {
WTF_MAKE_STRUCT_FAST_ALLOCATED;
LoaderTaskOptions(const ThreadableLoaderOptions&, const String&, Ref<SecurityOrigin>&&);
ThreadableLoaderOptions options;
String referrer;
Ref<SecurityOrigin> origin;
};
LoaderTaskOptions::LoaderTaskOptions(const ThreadableLoaderOptions& options, const String& referrer, Ref<SecurityOrigin>&& origin)
: options(options.isolatedCopy())
, referrer(referrer.isolatedCopy())
, origin(WTFMove(origin))
{
}
WorkerThreadableLoader::MainThreadBridge::MainThreadBridge(ThreadableLoaderClientWrapper& workerClientWrapper, WorkerLoaderProxy& loaderProxy, ScriptExecutionContextIdentifier contextIdentifier, const String& taskMode,
ResourceRequest&& request, const ThreadableLoaderOptions& options, const String& outgoingReferrer, WorkerOrWorkletGlobalScope& globalScope)
: m_workerClientWrapper(&workerClientWrapper)
, m_loaderProxy(loaderProxy)
, m_taskMode(taskMode.isolatedCopy())
, m_workerRequestIdentifier { ResourceLoaderIdentifier::generate() }
, m_contextIdentifier(contextIdentifier)
{
auto* securityOrigin = globalScope.securityOrigin();
auto* contentSecurityPolicy = globalScope.contentSecurityPolicy();
ASSERT(securityOrigin);
ASSERT(contentSecurityPolicy);
auto securityOriginCopy = securityOrigin->isolatedCopy();
auto contentSecurityPolicyCopy = makeUnique<ContentSecurityPolicy>(globalScope.url().isolatedCopy());
contentSecurityPolicyCopy->copyStateFrom(contentSecurityPolicy);
contentSecurityPolicyCopy->copyUpgradeInsecureRequestStateFrom(*contentSecurityPolicy);
auto crossOriginEmbedderPolicyCopy = globalScope.crossOriginEmbedderPolicy().isolatedCopy();
auto optionsCopy = makeUnique<LoaderTaskOptions>(options, request.httpReferrer().isNull() ? outgoingReferrer : request.httpReferrer(), WTFMove(securityOriginCopy));
// All loads start out as Document. Inside WorkerThreadableLoader we upgrade this to a Worker load.
ASSERT(optionsCopy->options.initiatorContext == InitiatorContext::Document);
optionsCopy->options.initiatorContext = InitiatorContext::Worker;
#if ENABLE(SERVICE_WORKER)
if (optionsCopy->options.serviceWorkersMode == ServiceWorkersMode::All) {
if (is<ServiceWorkerGlobalScope>(globalScope))
optionsCopy->options.serviceWorkersMode = ServiceWorkersMode::None;
else if (auto* activeServiceWorker = globalScope.activeServiceWorker()) {
optionsCopy->options.serviceWorkerRegistrationIdentifier = activeServiceWorker->registrationIdentifier();
optionsCopy->options.serviceWorkersMode = ServiceWorkersMode::All;
} else if (is<DedicatedWorkerGlobalScope>(globalScope))
optionsCopy->options.serviceWorkersMode = ServiceWorkersMode::None;
else
optionsCopy->options.serviceWorkersMode = ServiceWorkersMode::All;
}
#endif
if (!optionsCopy->options.clientIdentifier)
optionsCopy->options.clientIdentifier = globalScope.identifier();
if (is<WorkerGlobalScope>(globalScope))
InspectorInstrumentation::willSendRequest(downcast<WorkerGlobalScope>(globalScope), m_workerRequestIdentifier, request);
// Can we benefit from request being an r-value to create more efficiently its isolated copy?
m_loaderProxy.postTaskToLoader([this, request = WTFMove(request).isolatedCopy(), options = WTFMove(optionsCopy), contentSecurityPolicyCopy = WTFMove(contentSecurityPolicyCopy), crossOriginEmbedderPolicyCopy = WTFMove(crossOriginEmbedderPolicyCopy)](ScriptExecutionContext& context) mutable {
ASSERT(isMainThread());
Document& document = downcast<Document>(context);
// FIXME: If the site requests a local resource, then this will return a non-zero value but the sync path will return a 0 value.
// Either this should return 0 or the other code path should call a failure callback.
m_mainThreadLoader = DocumentThreadableLoader::create(document, *this, WTFMove(request), options->options, WTFMove(options->origin), WTFMove(contentSecurityPolicyCopy), WTFMove(crossOriginEmbedderPolicyCopy), WTFMove(options->referrer), DocumentThreadableLoader::ShouldLogError::No);
ASSERT(m_mainThreadLoader || m_loadingFinished);
});
}
void WorkerThreadableLoader::MainThreadBridge::destroy()
{
// Ensure that no more client callbacks are done in the worker context's thread.
clearClientWrapper();
// "delete this" and m_mainThreadLoader::deref() on the worker object's thread.
m_loaderProxy.postTaskToLoader([self = std::unique_ptr<WorkerThreadableLoader::MainThreadBridge>(this)] (ScriptExecutionContext& context) {
ASSERT(isMainThread());
ASSERT_UNUSED(context, context.isDocument());
if (self->m_mainThreadLoader)
self->m_mainThreadLoader->clearClient();
});
}
void WorkerThreadableLoader::MainThreadBridge::cancel()
{
m_loaderProxy.postTaskToLoader([this] (ScriptExecutionContext& context) {
ASSERT(isMainThread());
ASSERT_UNUSED(context, context.isDocument());
if (!m_mainThreadLoader)
return;
m_mainThreadLoader->cancel();
m_mainThreadLoader = nullptr;
});
// Taking a ref of client wrapper as call to didFail may take out the last reference of it.
Ref<ThreadableLoaderClientWrapper> protectedWorkerClientWrapper(*m_workerClientWrapper);
// If the client hasn't reached a termination state, then transition it by sending a cancellation error.
// Note: no more client callbacks will be done after this method -- we clear the client wrapper to ensure that.
ResourceError error(ResourceError::Type::Cancellation);
protectedWorkerClientWrapper->didFail(error);
protectedWorkerClientWrapper->clearClient();
}
void WorkerThreadableLoader::MainThreadBridge::computeIsDone()
{
m_loaderProxy.postTaskToLoader([this](auto&) {
if (!m_mainThreadLoader) {
notifyIsDone(true);
return;
}
m_mainThreadLoader->computeIsDone();
});
}
void WorkerThreadableLoader::MainThreadBridge::notifyIsDone(bool isDone)
{
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, isDone](auto&) {
protectedWorkerClientWrapper->notifyIsDone(isDone);
}, m_taskMode);
}
void WorkerThreadableLoader::MainThreadBridge::clearClientWrapper()
{
m_workerClientWrapper->clearClient();
}
void WorkerThreadableLoader::MainThreadBridge::redirectReceived(const URL& redirectURL)
{
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, redirectURL = redirectURL.isolatedCopy()] (ScriptExecutionContext& context) mutable {
ASSERT_UNUSED(context, context.isWorkerGlobalScope() || context.isWorkletGlobalScope());
protectedWorkerClientWrapper->redirectReceived(redirectURL);
}, m_taskMode);
}
void WorkerThreadableLoader::MainThreadBridge::didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
{
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, bytesSent, totalBytesToBeSent] (ScriptExecutionContext& context) mutable {
ASSERT_UNUSED(context, context.isWorkerGlobalScope() || context.isWorkletGlobalScope());
protectedWorkerClientWrapper->didSendData(bytesSent, totalBytesToBeSent);
}, m_taskMode);
}
void WorkerThreadableLoader::MainThreadBridge::didReceiveResponse(ResourceLoaderIdentifier identifier, const ResourceResponse& response)
{
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, workerRequestIdentifier = m_workerRequestIdentifier, identifier, responseData = response.crossThreadData()] (ScriptExecutionContext& context) mutable {
ASSERT(context.isWorkerGlobalScope() || context.isWorkletGlobalScope());
auto response = ResourceResponse::fromCrossThreadData(WTFMove(responseData));
protectedWorkerClientWrapper->didReceiveResponse(identifier, response);
if (is<WorkerGlobalScope>(context))
InspectorInstrumentation::didReceiveResourceResponse(downcast<WorkerGlobalScope>(context), workerRequestIdentifier, response);
}, m_taskMode);
}
void WorkerThreadableLoader::MainThreadBridge::didReceiveData(const SharedBuffer& data)
{
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, workerRequestIdentifier = m_workerRequestIdentifier, buffer = Ref { data }] (ScriptExecutionContext& context) {
ASSERT(context.isWorkerGlobalScope() || context.isWorkletGlobalScope());
protectedWorkerClientWrapper->didReceiveData(buffer);
if (is<WorkerGlobalScope>(context))
InspectorInstrumentation::didReceiveData(downcast<WorkerGlobalScope>(context), workerRequestIdentifier, buffer);
}, m_taskMode);
}
void WorkerThreadableLoader::MainThreadBridge::didFinishLoading(ResourceLoaderIdentifier identifier, const NetworkLoadMetrics& metrics)
{
m_loadingFinished = true;
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, workerRequestIdentifier = m_workerRequestIdentifier, metrics = metrics.isolatedCopy(), identifier] (ScriptExecutionContext& context) mutable {
ASSERT(context.isWorkerGlobalScope() || context.isWorkletGlobalScope());
protectedWorkerClientWrapper->didFinishLoading(identifier, metrics);
if (is<WorkerGlobalScope>(context))
InspectorInstrumentation::didFinishLoading(downcast<WorkerGlobalScope>(context), workerRequestIdentifier, metrics);
}, m_taskMode);
}
void WorkerThreadableLoader::MainThreadBridge::didFail(const ResourceError& error)
{
m_loadingFinished = true;
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, workerRequestIdentifier = m_workerRequestIdentifier, error = error.isolatedCopy()] (ScriptExecutionContext& context) mutable {
ASSERT(context.isWorkerGlobalScope() || context.isWorkletGlobalScope());
ThreadableLoader::logError(context, error, protectedWorkerClientWrapper->initiator());
protectedWorkerClientWrapper->didFail(error);
if (is<WorkerGlobalScope>(context))
InspectorInstrumentation::didFailLoading(downcast<WorkerGlobalScope>(context), workerRequestIdentifier, error);
}, m_taskMode);
}
void WorkerThreadableLoader::MainThreadBridge::didFinishTiming(const ResourceTiming& resourceTiming)
{
m_networkLoadMetrics = resourceTiming.networkLoadMetrics();
ScriptExecutionContext::postTaskForModeToWorkerOrWorklet(m_contextIdentifier, [protectedWorkerClientWrapper = Ref { *m_workerClientWrapper }, resourceTiming = resourceTiming.isolatedCopy()] (ScriptExecutionContext& context) mutable {
ASSERT(context.isWorkerGlobalScope() || context.isWorkletGlobalScope());
ASSERT(!resourceTiming.initiator().isEmpty());
// No need to notify clients, just add the performance timing entry.
if (is<WorkerGlobalScope>(context))
downcast<WorkerGlobalScope>(context).performance().addResourceTiming(WTFMove(resourceTiming));
}, m_taskMode);
}
} // namespace WebCore