Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
#include "XMLHttpRequestWorker.h"
#include "nsIDOMEventListener.h"
#include "GeckoProfiler.h"
#include "jsfriendapi.h"
#include "js/ArrayBuffer.h" // JS::Is{,Detached}ArrayBufferObject
#include "js/GCPolicyAPI.h"
#include "js/JSON.h"
#include "js/RootingAPI.h" // JS::{Handle,Heap,PersistentRooted}
#include "js/TracingAPI.h"
#include "js/Value.h" // JS::{Undefined,}Value
#include "mozilla/ArrayUtils.h"
#include "mozilla/HoldDropJSObjects.h"
#include "mozilla/dom/Exceptions.h"
#include "mozilla/dom/Event.h"
#include "mozilla/dom/File.h"
#include "mozilla/dom/FormData.h"
#include "mozilla/dom/ProgressEvent.h"
#include "mozilla/dom/SerializedStackHolder.h"
#include "mozilla/dom/StreamBlobImpl.h"
#include "mozilla/dom/StructuredCloneHolder.h"
#include "mozilla/dom/URLSearchParams.h"
#include "mozilla/dom/WorkerScope.h"
#include "mozilla/dom/WorkerRef.h"
#include "mozilla/dom/WorkerRunnable.h"
#include "mozilla/dom/XMLHttpRequestBinding.h"
#include "mozilla/Telemetry.h"
#include "nsComponentManagerUtils.h"
#include "nsContentUtils.h"
#include "nsJSUtils.h"
#include "nsThreadUtils.h"
#include "XMLHttpRequestMainThread.h"
#include "XMLHttpRequestUpload.h"
#include "mozilla/UniquePtr.h"
extern mozilla::LazyLogModule gXMLHttpRequestLog;
namespace mozilla::dom {
using EventType = XMLHttpRequest::EventType;
using Events = XMLHttpRequest::Events;
/**
* XMLHttpRequest in workers
*
* XHR in workers is implemented by proxying calls/events/etc between the
* worker thread and an XMLHttpRequest on the main thread. The glue
* object here is the Proxy, which lives on both threads. All other objects
* live on either the main thread (the XMLHttpRequest) or the worker thread
* (the worker and XHR private objects).
*
* The main thread XHR is always operated in async mode, even for sync XHR
* in workers. Calls made on the worker thread are proxied to the main thread
* synchronously (meaning the worker thread is blocked until the call
* returns). Each proxied call spins up a sync queue, which captures any
* synchronously dispatched events and ensures that they run synchronously
* on the worker as well. Asynchronously dispatched events are posted to the
* worker thread to run asynchronously. Some of the XHR state is mirrored on
* the worker thread to avoid needing a cross-thread call on every property
* access.
*
* The XHR private is stored in the private slot of the XHR JSObject on the
* worker thread. It is destroyed when that JSObject is GCd. The private
* roots its JSObject while network activity is in progress. It also
* adds itself as a feature to the worker to give itself a chance to clean up
* if the worker goes away during an XHR call. It is important that the
* rooting and feature registration (collectively called pinning) happens at
* the proper times. If we pin for too long we can cause memory leaks or even
* shutdown hangs. If we don't pin for long enough we introduce a GC hazard.
*
* The XHR is pinned from the time Send is called to roughly the time loadend
* is received. There are some complications involved with Abort and XHR
* reuse. We maintain a counter on the main thread of how many times Send was
* called on this XHR, and we decrement the counter every time we receive a
* loadend event. When the counter reaches zero we dispatch a runnable to the
* worker thread to unpin the XHR. We only decrement the counter if the
* dispatch was successful, because the worker may no longer be accepting
* regular runnables. In the event that we reach Proxy::Teardown and there
* the outstanding Send count is still non-zero, we dispatch a control
* runnable which is guaranteed to run.
*
* NB: Some of this could probably be simplified now that we have the
* inner/outer channel ids.
*/
class Proxy final : public nsIDOMEventListener {
public:
// Read on multiple threads.
RefPtr<ThreadSafeWorkerRef> mWorkerRef;
const ClientInfo mClientInfo;
const Maybe<ServiceWorkerDescriptor> mController;
// Only ever dereferenced and/or checked on the worker thread. Cleared
// explicitly on the worker thread inside XMLHttpRequestWorker::ReleaseProxy.
WeakPtr<XMLHttpRequestWorker> mXMLHttpRequestPrivate;
// XHR Params:
bool mMozAnon;
bool mMozSystem;
// Only touched on the main thread.
RefPtr<XMLHttpRequestMainThread> mXHR;
RefPtr<XMLHttpRequestUpload> mXHRUpload;
nsCOMPtr<nsIEventTarget> mSyncLoopTarget;
nsCOMPtr<nsIEventTarget> mSyncEventResponseTarget;
uint32_t mInnerEventStreamId;
uint32_t mInnerChannelId;
uint32_t mOutstandingSendCount;
// Only touched on the worker thread.
uint32_t mOuterChannelId;
uint32_t mOpenCount;
uint64_t mLastLoaded;
uint64_t mLastTotal;
uint64_t mLastUploadLoaded;
uint64_t mLastUploadTotal;
nsresult mLastErrorDetailAtLoadend;
bool mIsSyncXHR;
bool mLastLengthComputable;
bool mLastUploadLengthComputable;
bool mSeenUploadLoadStart;
bool mSeenUploadLoadEnd;
// Only touched on the main thread.
bool mUploadEventListenersAttached;
bool mMainThreadSeenLoadStart;
bool mInOpen;
public:
Proxy(XMLHttpRequestWorker* aXHRPrivate, const ClientInfo& aClientInfo,
const Maybe<ServiceWorkerDescriptor>& aController, bool aMozAnon,
bool aMozSystem)
: mClientInfo(aClientInfo),
mController(aController),
mXMLHttpRequestPrivate(aXHRPrivate),
mMozAnon(aMozAnon),
mMozSystem(aMozSystem),
mInnerEventStreamId(aXHRPrivate->EventStreamId()),
mInnerChannelId(0),
mOutstandingSendCount(0),
mOuterChannelId(0),
mOpenCount(0),
mLastLoaded(0),
mLastTotal(0),
mLastUploadLoaded(0),
mLastUploadTotal(0),
mLastErrorDetailAtLoadend(NS_OK),
mIsSyncXHR(false),
mLastLengthComputable(false),
mLastUploadLengthComputable(false),
mSeenUploadLoadStart(false),
mSeenUploadLoadEnd(false),
mUploadEventListenersAttached(false),
mMainThreadSeenLoadStart(false),
mInOpen(false) {}
NS_DECL_THREADSAFE_ISUPPORTS
NS_DECL_NSIDOMEVENTLISTENER
// This method is called in OpenRunnable::MainThreadRunInternal(). The
// OpenRunnable has to provide a valid WorkerPrivate for the Proxy's
// initialization since OpenRunnable is a WorkerMainThreadRunnable, which
// holds a ThreadSafeWorkerRef and blocks Worker's shutdown until the
// execution returns back to the worker thread.
bool Init(WorkerPrivate* aWorkerPrivate);
void Teardown();
bool AddRemoveEventListeners(bool aUpload, bool aAdd);
void Reset() {
AssertIsOnMainThread();
if (mUploadEventListenersAttached) {
AddRemoveEventListeners(true, false);
}
}
already_AddRefed<nsIEventTarget> GetEventTarget() {
AssertIsOnMainThread();
nsCOMPtr<nsIEventTarget> target =
mSyncEventResponseTarget ? mSyncEventResponseTarget : mSyncLoopTarget;
return target.forget();
}
WorkerPrivate* Private() const {
if (mWorkerRef) {
return mWorkerRef->Private();
}
return nullptr;
}
#ifdef DEBUG
void DebugStoreWorkerRef(RefPtr<ThreadSafeWorkerRef>& aWorkerRef) {
MOZ_ASSERT(!NS_IsMainThread());
MutexAutoLock lock(mXHR->mTSWorkerRefMutex);
mXHR->mTSWorkerRef = aWorkerRef;
}
void DebugForgetWorkerRef() {
MOZ_ASSERT(!NS_IsMainThread());
MutexAutoLock lock(mXHR->mTSWorkerRefMutex);
mXHR->mTSWorkerRef = nullptr;
}
#endif
private:
~Proxy() {
MOZ_ASSERT(!mXHR);
MOZ_ASSERT(!mXHRUpload);
MOZ_ASSERT(!mOutstandingSendCount);
}
};
class WorkerThreadProxySyncRunnable : public WorkerMainThreadRunnable {
protected:
RefPtr<Proxy> mProxy;
private:
// mErrorCode is set on the main thread by MainThreadRun and it's used at the
// end of the Dispatch() to return the error code.
nsresult mErrorCode;
public:
WorkerThreadProxySyncRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy)
: WorkerMainThreadRunnable(aWorkerPrivate, "XHR"_ns),
mProxy(aProxy),
mErrorCode(NS_OK) {
MOZ_ASSERT(aWorkerPrivate);
MOZ_ASSERT(aProxy);
aWorkerPrivate->AssertIsOnWorkerThread();
}
void Dispatch(WorkerPrivate* aWorkerPrivate, WorkerStatus aFailStatus,
ErrorResult& aRv) {
MOZ_ASSERT(aWorkerPrivate);
aWorkerPrivate->AssertIsOnWorkerThread();
WorkerMainThreadRunnable::Dispatch(aWorkerPrivate, aFailStatus, aRv);
if (NS_WARN_IF(aRv.Failed())) {
return;
}
if (NS_FAILED(mErrorCode)) {
aRv.Throw(mErrorCode);
}
}
protected:
virtual ~WorkerThreadProxySyncRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) = 0;
private:
virtual bool MainThreadRun() override;
};
class SendRunnable final : public WorkerThreadProxySyncRunnable {
RefPtr<BlobImpl> mBlobImpl;
// WorkerMainThreadRunnable has a member mSyncLoopTarget to perform the
// synchronous dispatch. The mSyncLoopTarget will be released after
// WorkerMainThreadRunnable::Dispatch().
// However, to perform sync XHR, an additional sync loop is needed to wait
// for the sync XHR response. This is because XMLHttpRequestMainThread
// performs xhr in async way, and it causes the response to not be
// available before SendRunnable returns back to the worker thread.
// This is the event target to the additional sync loop.
nsCOMPtr<nsIEventTarget> mSyncXHRSyncLoopTarget;
bool mHasUploadListeners;
public:
SendRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
BlobImpl* aBlobImpl)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mBlobImpl(aBlobImpl),
mHasUploadListeners(false) {}
void SetHaveUploadListeners(bool aHasUploadListeners) {
mHasUploadListeners = aHasUploadListeners;
}
void SetSyncXHRSyncLoopTarget(nsIEventTarget* aSyncXHRSyncLoopTarget) {
mSyncXHRSyncLoopTarget = aSyncXHRSyncLoopTarget;
}
private:
~SendRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override;
};
namespace {
class MainThreadProxyRunnable : public MainThreadWorkerSyncRunnable {
protected:
RefPtr<Proxy> mProxy;
MainThreadProxyRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
const char* aName = "MainThreadProxyRunnable")
: MainThreadWorkerSyncRunnable(aProxy->GetEventTarget(), aName),
mProxy(aProxy) {
MOZ_ASSERT(aProxy);
}
virtual ~MainThreadProxyRunnable() = default;
};
class AsyncTeardownRunnable final : public Runnable {
RefPtr<Proxy> mProxy;
public:
explicit AsyncTeardownRunnable(Proxy* aProxy)
: Runnable("dom::AsyncTeardownRunnable"), mProxy(aProxy) {
MOZ_ASSERT(aProxy);
}
private:
~AsyncTeardownRunnable() = default;
NS_IMETHOD
Run() override {
AssertIsOnMainThread();
mProxy->Teardown();
mProxy = nullptr;
return NS_OK;
}
};
class LoadStartDetectionRunnable final : public Runnable,
public nsIDOMEventListener {
RefPtr<Proxy> mProxy;
RefPtr<XMLHttpRequest> mXHR;
uint32_t mChannelId;
bool mReceivedLoadStart;
class ProxyCompleteRunnable final : public MainThreadProxyRunnable {
uint32_t mChannelId;
public:
ProxyCompleteRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
uint32_t aChannelId)
: MainThreadProxyRunnable(aWorkerPrivate, aProxy,
"ProxyCompleteRunnable"),
mChannelId(aChannelId) {}
private:
~ProxyCompleteRunnable() = default;
virtual bool WorkerRun(JSContext* aCx,
WorkerPrivate* aWorkerPrivate) override {
if (mChannelId != mProxy->mOuterChannelId) {
// Threads raced, this event is now obsolete.
return true;
}
if (mSyncLoopTarget) {
aWorkerPrivate->StopSyncLoop(mSyncLoopTarget, NS_OK);
}
XMLHttpRequestWorker* xhrw = mProxy->mXMLHttpRequestPrivate.get();
if (xhrw && xhrw->SendInProgress()) {
xhrw->Unpin();
}
return true;
}
nsresult Cancel() override { return Run(); }
};
public:
explicit LoadStartDetectionRunnable(Proxy* aProxy)
: Runnable("dom::LoadStartDetectionRunnable"),
mProxy(aProxy),
mXHR(aProxy->mXHR),
mChannelId(mProxy->mInnerChannelId),
mReceivedLoadStart(false) {
AssertIsOnMainThread();
}
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_NSIRUNNABLE
NS_DECL_NSIDOMEVENTLISTENER
bool RegisterAndDispatch() {
AssertIsOnMainThread();
if (NS_FAILED(
mXHR->AddEventListener(Events::loadstart, this, false, false))) {
NS_WARNING("Failed to add event listener!");
return false;
}
MOZ_ASSERT_DEBUG_OR_FUZZING(mProxy && mProxy->Private());
return NS_SUCCEEDED(mProxy->Private()->DispatchToMainThread(this));
}
private:
~LoadStartDetectionRunnable() { AssertIsOnMainThread(); }
};
class EventRunnable final : public MainThreadProxyRunnable {
const EventType& mType;
UniquePtr<XMLHttpRequestWorker::ResponseData> mResponseData;
nsString mResponseURL;
nsCString mStatusText;
uint64_t mLoaded;
uint64_t mTotal;
uint32_t mEventStreamId;
uint32_t mStatus;
uint16_t mReadyState;
bool mUploadEvent;
bool mProgressEvent;
bool mLengthComputable;
nsresult mStatusResult;
nsresult mErrorDetail;
// mScopeObj is used in PreDispatch only. We init it in our constructor, and
// reset() in PreDispatch, to ensure that it's not still linked into the
// runtime once we go off-thread.
JS::PersistentRooted<JSObject*> mScopeObj;
public:
EventRunnable(Proxy* aProxy, bool aUploadEvent, const EventType& aType,
bool aLengthComputable, uint64_t aLoaded, uint64_t aTotal,
JS::Handle<JSObject*> aScopeObj)
: MainThreadProxyRunnable(aProxy->Private(), aProxy, "EventRunnable"),
mType(aType),
mResponseData(new XMLHttpRequestWorker::ResponseData()),
mLoaded(aLoaded),
mTotal(aTotal),
mEventStreamId(aProxy->mInnerEventStreamId),
mStatus(0),
mReadyState(0),
mUploadEvent(aUploadEvent),
mProgressEvent(true),
mLengthComputable(aLengthComputable),
mStatusResult(NS_OK),
mErrorDetail(NS_OK),
mScopeObj(RootingCx(), aScopeObj) {}
EventRunnable(Proxy* aProxy, bool aUploadEvent, const EventType& aType,
JS::Handle<JSObject*> aScopeObj)
: MainThreadProxyRunnable(aProxy->Private(), aProxy, "EventRunnable"),
mType(aType),
mResponseData(new XMLHttpRequestWorker::ResponseData()),
mLoaded(0),
mTotal(0),
mEventStreamId(aProxy->mInnerEventStreamId),
mStatus(0),
mReadyState(0),
mUploadEvent(aUploadEvent),
mProgressEvent(false),
mLengthComputable(0),
mStatusResult(NS_OK),
mErrorDetail(NS_OK),
mScopeObj(RootingCx(), aScopeObj) {}
private:
~EventRunnable() = default;
bool PreDispatch(WorkerPrivate* /* unused */) final;
bool WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override;
};
class SyncTeardownRunnable final : public WorkerThreadProxySyncRunnable {
public:
SyncTeardownRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy) {}
private:
~SyncTeardownRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->Teardown();
MOZ_ASSERT(!mProxy->mSyncLoopTarget);
}
};
class SetBackgroundRequestRunnable final
: public WorkerThreadProxySyncRunnable {
bool mValue;
public:
SetBackgroundRequestRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
bool aValue)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy), mValue(aValue) {}
private:
~SetBackgroundRequestRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
// XXXedgar, do we intend to ignore the errors?
mProxy->mXHR->SetMozBackgroundRequest(mValue, aRv);
}
};
class SetWithCredentialsRunnable final : public WorkerThreadProxySyncRunnable {
bool mValue;
public:
SetWithCredentialsRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
bool aValue)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy), mValue(aValue) {}
private:
~SetWithCredentialsRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->mXHR->SetWithCredentials(mValue, aRv);
}
};
class SetResponseTypeRunnable final : public WorkerThreadProxySyncRunnable {
XMLHttpRequestResponseType mResponseType;
public:
SetResponseTypeRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
XMLHttpRequestResponseType aResponseType)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mResponseType(aResponseType) {}
XMLHttpRequestResponseType ResponseType() { return mResponseType; }
private:
~SetResponseTypeRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->mXHR->SetResponseTypeRaw(mResponseType);
mResponseType = mProxy->mXHR->ResponseType();
}
};
class SetTimeoutRunnable final : public WorkerThreadProxySyncRunnable {
uint32_t mTimeout;
public:
SetTimeoutRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
uint32_t aTimeout)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mTimeout(aTimeout) {}
private:
~SetTimeoutRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->mXHR->SetTimeout(mTimeout, aRv);
}
};
class AbortRunnable final : public WorkerThreadProxySyncRunnable {
public:
AbortRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy) {}
private:
~AbortRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override;
};
class GetAllResponseHeadersRunnable final
: public WorkerThreadProxySyncRunnable {
nsCString& mResponseHeaders;
public:
GetAllResponseHeadersRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
nsCString& aResponseHeaders)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mResponseHeaders(aResponseHeaders) {}
private:
~GetAllResponseHeadersRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->mXHR->GetAllResponseHeaders(mResponseHeaders, aRv);
}
};
class GetResponseHeaderRunnable final : public WorkerThreadProxySyncRunnable {
const nsCString mHeader;
nsCString& mValue;
public:
GetResponseHeaderRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
const nsACString& aHeader, nsCString& aValue)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mHeader(aHeader),
mValue(aValue) {}
private:
~GetResponseHeaderRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->mXHR->GetResponseHeader(mHeader, mValue, aRv);
}
};
class OpenRunnable final : public WorkerThreadProxySyncRunnable {
nsCString mMethod;
nsString mURL;
Optional<nsAString> mUser;
nsString mUserStr;
Optional<nsAString> mPassword;
nsString mPasswordStr;
bool mBackgroundRequest;
bool mWithCredentials;
uint32_t mTimeout;
XMLHttpRequestResponseType mResponseType;
const nsString mMimeTypeOverride;
// Remember the worker thread's stack when the XHR was opened, so that it can
// be passed on to the net monitor.
UniquePtr<SerializedStackHolder> mOriginStack;
// Remember the worker thread's stack when the XHR was opened for profiling
// purposes.
UniquePtr<ProfileChunkedBuffer> mSource;
public:
OpenRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
const nsACString& aMethod, const nsAString& aURL,
const Optional<nsAString>& aUser,
const Optional<nsAString>& aPassword, bool aBackgroundRequest,
bool aWithCredentials, uint32_t aTimeout,
XMLHttpRequestResponseType aResponseType,
const nsString& aMimeTypeOverride,
UniquePtr<SerializedStackHolder> aOriginStack,
UniquePtr<ProfileChunkedBuffer> aSource = nullptr)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mMethod(aMethod),
mURL(aURL),
mBackgroundRequest(aBackgroundRequest),
mWithCredentials(aWithCredentials),
mTimeout(aTimeout),
mResponseType(aResponseType),
mMimeTypeOverride(aMimeTypeOverride),
mOriginStack(std::move(aOriginStack)),
mSource(std::move(aSource)) {
if (aUser.WasPassed()) {
mUserStr = aUser.Value();
mUser = &mUserStr;
}
if (aPassword.WasPassed()) {
mPasswordStr = aPassword.Value();
mPassword = &mPasswordStr;
}
}
private:
~OpenRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
MOZ_ASSERT_IF(mProxy->mWorkerRef,
mProxy->mWorkerRef->Private() == mWorkerRef->Private());
// mProxy wants a valid ThreadSafeWorkerRef for the duration of our call,
// but mProxy->mWorkerRef may be null if a send is not currently active,
// so save the existing value for the duration of the call.
RefPtr<ThreadSafeWorkerRef> oldWorker = std::move(mProxy->mWorkerRef);
// WorkerMainThreadRunnable::mWorkerRef must not be nullptr here, since
// when get here, it means this WorkerMainThreadRunnable had already be
// dispatched successfully and the execution is on the main thread.
MOZ_ASSERT_DEBUG_OR_FUZZING(mWorkerRef);
// Set mProxy->mWorkerRef as OpenRunnable::mWorkerRef which is from
// WorkerMainThreadRunnable during the runnable execution.
// Let OpenRunnable keep a reference for dispatching
// MainThreadStopSyncRunnable back to the Worker thread after the main
// thread execution completes.
mProxy->mWorkerRef = mWorkerRef;
MainThreadRunInternal(aRv);
// Restore the previous activated WorkerRef for send.
mProxy->mWorkerRef = std::move(oldWorker);
}
void MainThreadRunInternal(ErrorResult& aRv);
};
class SetRequestHeaderRunnable final : public WorkerThreadProxySyncRunnable {
nsCString mHeader;
nsCString mValue;
public:
SetRequestHeaderRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
const nsACString& aHeader, const nsACString& aValue)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mHeader(aHeader),
mValue(aValue) {}
private:
~SetRequestHeaderRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->mXHR->SetRequestHeader(mHeader, mValue, aRv);
}
};
class OverrideMimeTypeRunnable final : public WorkerThreadProxySyncRunnable {
nsString mMimeType;
public:
OverrideMimeTypeRunnable(WorkerPrivate* aWorkerPrivate, Proxy* aProxy,
const nsAString& aMimeType)
: WorkerThreadProxySyncRunnable(aWorkerPrivate, aProxy),
mMimeType(aMimeType) {}
private:
~OverrideMimeTypeRunnable() = default;
virtual void RunOnMainThread(ErrorResult& aRv) override {
mProxy->mXHR->OverrideMimeType(mMimeType, aRv);
}
};
class AutoUnpinXHR {
XMLHttpRequestWorker* mXMLHttpRequestPrivate;
public:
explicit AutoUnpinXHR(XMLHttpRequestWorker* aXMLHttpRequestPrivate)
: mXMLHttpRequestPrivate(aXMLHttpRequestPrivate) {
MOZ_ASSERT(aXMLHttpRequestPrivate);
}
~AutoUnpinXHR() {
if (mXMLHttpRequestPrivate) {
mXMLHttpRequestPrivate->Unpin();
}
}
void Clear() { mXMLHttpRequestPrivate = nullptr; }
};
} // namespace
bool Proxy::Init(WorkerPrivate* aWorkerPrivate) {
AssertIsOnMainThread();
MOZ_ASSERT(aWorkerPrivate);
if (mXHR) {
return true;
}
nsPIDOMWindowInner* ownerWindow = aWorkerPrivate->GetWindow();
if (ownerWindow && !ownerWindow->IsCurrentInnerWindow()) {
NS_WARNING("Window has navigated, cannot create XHR here.");
return false;
}
mXHR = new XMLHttpRequestMainThread(ownerWindow ? ownerWindow->AsGlobal()
: nullptr);
mXHR->Construct(aWorkerPrivate->GetPrincipal(),
aWorkerPrivate->CookieJarSettings(), true,
aWorkerPrivate->GetBaseURI(), aWorkerPrivate->GetLoadGroup(),
aWorkerPrivate->GetPerformanceStorage(),
aWorkerPrivate->CSPEventListener());
mXHR->SetParameters(mMozAnon, mMozSystem);
mXHR->SetClientInfoAndController(mClientInfo, mController);
ErrorResult rv;
mXHRUpload = mXHR->GetUpload(rv);
if (NS_WARN_IF(rv.Failed())) {
mXHR = nullptr;
return false;
}
if (!AddRemoveEventListeners(false, true)) {
mXHR = nullptr;
mXHRUpload = nullptr;
return false;
}
return true;
}
void Proxy::Teardown() {
AssertIsOnMainThread();
if (mXHR) {
Reset();
// NB: We are intentionally dropping events coming from xhr.abort on the
// floor.
AddRemoveEventListeners(false, false);
ErrorResult rv;
mXHR->Abort(rv);
if (NS_WARN_IF(rv.Failed())) {
rv.SuppressException();
}
if (mOutstandingSendCount) {
if (mSyncLoopTarget) {
// We have an unclosed sync loop. Fix that now.
RefPtr<MainThreadStopSyncLoopRunnable> runnable =
new MainThreadStopSyncLoopRunnable(std::move(mSyncLoopTarget),
NS_ERROR_FAILURE);
MOZ_ALWAYS_TRUE(runnable->Dispatch(mWorkerRef->Private()));
}
mOutstandingSendCount = 0;
}
mWorkerRef = nullptr;
mXHRUpload = nullptr;
mXHR = nullptr;
}
MOZ_ASSERT(!mWorkerRef);
MOZ_ASSERT(!mSyncLoopTarget);
// If there are rare edge cases left that violate our invariants
// just ensure that they won't harm us too much.
mWorkerRef = nullptr;
mSyncLoopTarget = nullptr;
}
bool Proxy::AddRemoveEventListeners(bool aUpload, bool aAdd) {
AssertIsOnMainThread();
NS_ASSERTION(!aUpload || (mUploadEventListenersAttached && !aAdd) ||
(!mUploadEventListenersAttached && aAdd),
"Messed up logic for upload listeners!");
RefPtr<DOMEventTargetHelper> targetHelper =
aUpload ? static_cast<XMLHttpRequestUpload*>(mXHRUpload.get())
: static_cast<XMLHttpRequestEventTarget*>(mXHR.get());
MOZ_ASSERT(targetHelper, "This should never fail!");
for (const EventType* type : Events::All) {
if (aUpload && *type == Events::readystatechange) {
continue;
}
if (aAdd) {
if (NS_FAILED(targetHelper->AddEventListener(*type, this, false))) {
return false;
}
} else {
targetHelper->RemoveEventListener(*type, this, false);
}
}
if (aUpload) {
mUploadEventListenersAttached = aAdd;
}
return true;
}
NS_IMPL_ISUPPORTS(Proxy, nsIDOMEventListener)
NS_IMETHODIMP
Proxy::HandleEvent(Event* aEvent) {
AssertIsOnMainThread();
// EventRunnable::WorkerRun will bail out if mXMLHttpRequestWorker is null,
// so we do not need to prevent the dispatch from the main thread such that
// we do not need to touch it off-worker-thread.
if (!mWorkerRef) {
NS_ERROR("Shouldn't get here!");
return NS_OK;
}
nsAutoString _type;
aEvent->GetType(_type);
const EventType* typePtr = Events::Find(_type);
MOZ_DIAGNOSTIC_ASSERT(typePtr, "Shouldn't get non-XMLHttpRequest events");
const EventType& type = *typePtr;
bool isUploadTarget = mXHR != aEvent->GetTarget();
ProgressEvent* progressEvent = aEvent->AsProgressEvent();
if (mInOpen && type == Events::readystatechange) {
if (mXHR->ReadyState() == 1) {
mInnerEventStreamId++;
}
}
{
AutoJSAPI jsapi;
JSObject* junkScope = xpc::UnprivilegedJunkScope(fallible);
if (!junkScope || !jsapi.Init(junkScope)) {
return NS_ERROR_FAILURE;
}
JSContext* cx = jsapi.cx();
JS::Rooted<JS::Value> value(cx);
if (!GetOrCreateDOMReflectorNoWrap(cx, mXHR, &value)) {
return NS_ERROR_FAILURE;
}
JS::Rooted<JSObject*> scope(cx, &value.toObject());
RefPtr<EventRunnable> runnable;
if (progressEvent) {
if (!mIsSyncXHR || type != Events::progress) {
runnable = new EventRunnable(
this, isUploadTarget, type, progressEvent->LengthComputable(),
progressEvent->Loaded(), progressEvent->Total(), scope);
}
} else {
runnable = new EventRunnable(this, isUploadTarget, type, scope);
}
if (runnable) {
runnable->Dispatch(mWorkerRef->Private());
}
}
if (!isUploadTarget) {
if (type == Events::loadstart) {
mMainThreadSeenLoadStart = true;
} else if (mMainThreadSeenLoadStart && type == Events::loadend) {
mMainThreadSeenLoadStart = false;
RefPtr<LoadStartDetectionRunnable> runnable =
new LoadStartDetectionRunnable(this);
if (!runnable->RegisterAndDispatch()) {
NS_WARNING("Failed to dispatch LoadStartDetectionRunnable!");
}
}
}
return NS_OK;
}
NS_IMPL_ISUPPORTS_INHERITED(LoadStartDetectionRunnable, Runnable,
nsIDOMEventListener)
NS_IMETHODIMP
LoadStartDetectionRunnable::Run() {
AssertIsOnMainThread();
mXHR->RemoveEventListener(Events::loadstart, this, false);
if (!mReceivedLoadStart) {
if (mProxy->mOutstandingSendCount > 1) {
mProxy->mOutstandingSendCount--;
} else if (mProxy->mOutstandingSendCount == 1) {
mProxy->Reset();
RefPtr<ProxyCompleteRunnable> runnable =
new ProxyCompleteRunnable(mProxy->Private(), mProxy, mChannelId);
if (runnable->Dispatch(mProxy->Private())) {
mProxy->mWorkerRef = nullptr;
mProxy->mSyncLoopTarget = nullptr;
mProxy->mOutstandingSendCount--;
}
}
}
mProxy = nullptr;
mXHR = nullptr;
return NS_OK;
}
NS_IMETHODIMP
LoadStartDetectionRunnable::HandleEvent(Event* aEvent) {
AssertIsOnMainThread();
#ifdef DEBUG
{
nsAutoString type;
aEvent->GetType(type);
MOZ_ASSERT(type == Events::loadstart);
}
#endif
mReceivedLoadStart = true;
return NS_OK;
}
bool EventRunnable::PreDispatch(WorkerPrivate* /* unused */) {
AssertIsOnMainThread();
AutoJSAPI jsapi;
DebugOnly<bool> ok = jsapi.Init(xpc::NativeGlobal(mScopeObj));
MOZ_ASSERT(ok);
JSContext* cx = jsapi.cx();
// Now keep the mScopeObj alive for the duration
JS::Rooted<JSObject*> scopeObj(cx, mScopeObj);
// And reset mScopeObj now, before we have a chance to run its destructor on
// some background thread.
mScopeObj.reset();
RefPtr<XMLHttpRequestMainThread>& xhr = mProxy->mXHR;
MOZ_ASSERT(xhr);
ErrorResult rv;
XMLHttpRequestResponseType type = xhr->ResponseType();
// We want to take the result data only if this is available.
if (mType == Events::readystatechange) {
switch (type) {
case XMLHttpRequestResponseType::_empty:
case XMLHttpRequestResponseType::Text: {
xhr->GetResponseText(mResponseData->mResponseText, rv);
mResponseData->mResponseResult = rv.StealNSResult();
break;
}
case XMLHttpRequestResponseType::Blob: {
mResponseData->mResponseBlobImpl = xhr->GetResponseBlobImpl();
break;
}
case XMLHttpRequestResponseType::Arraybuffer: {
mResponseData->mResponseArrayBufferBuilder =
xhr->GetResponseArrayBufferBuilder();
break;
}
case XMLHttpRequestResponseType::Json: {
mResponseData->mResponseResult =
xhr->GetResponseTextForJSON(mResponseData->mResponseJSON);
break;
}
default:
MOZ_ASSERT_UNREACHABLE("Invalid response type");
return false;
}
}
mStatus = xhr->GetStatus(rv);
mStatusResult = rv.StealNSResult();
mErrorDetail = xhr->ErrorDetail();
xhr->GetStatusText(mStatusText, rv);
MOZ_ASSERT(!rv.Failed());
mReadyState = xhr->ReadyState();