fune/dom/ipc/jsactor/JSWindowActorChild.cpp
Kris Maglione e01b754b29 Bug 1672263: Use ThrowInvalidStateError with useful messages in JSWindowActorChild. r=nika
Currently, when JS callers try to access certain JSWindowActors before an
actor is initialized, or after it's destroyed, we throw a generic
`NS_ERROR_INVALID_STATE_ERROR` exception without any useful information about
the failure.

This patch changes that to use `ThrowInvalidStateError`, with a message
including the property name, the actor name, and details about whether the
error occurred because the actor has not been initialized or because it has
already been destroyed.

Differential Revision: https://phabricator.services.mozilla.com/D96628
2020-11-10 22:04:49 +00:00

155 lines
4.8 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "mozilla/dom/JSWindowActorBinding.h"
#include "mozilla/dom/JSWindowActorChild.h"
#include "mozilla/dom/ContentChild.h"
#include "mozilla/dom/WindowGlobalChild.h"
#include "mozilla/dom/WindowGlobalParent.h"
#include "mozilla/dom/WindowProxyHolder.h"
#include "mozilla/dom/MessageManagerBinding.h"
#include "mozilla/dom/BrowsingContext.h"
#include "nsGlobalWindowInner.h"
namespace mozilla::dom {
JSWindowActorChild::~JSWindowActorChild() { MOZ_ASSERT(!mManager); }
JSObject* JSWindowActorChild::WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) {
return JSWindowActorChild_Binding::Wrap(aCx, this, aGivenProto);
}
WindowGlobalChild* JSWindowActorChild::GetManager() const { return mManager; }
void JSWindowActorChild::Init(const nsACString& aName,
WindowGlobalChild* aManager) {
MOZ_ASSERT(!mManager, "Cannot Init() a JSWindowActorChild twice!");
SetName(aName);
mManager = aManager;
InvokeCallback(CallbackFunction::ActorCreated);
}
void JSWindowActorChild::SendRawMessage(
const JSActorMessageMeta& aMeta, Maybe<ipc::StructuredCloneData>&& aData,
Maybe<ipc::StructuredCloneData>&& aStack, ErrorResult& aRv) {
if (NS_WARN_IF(!CanSend() || !mManager || !mManager->CanSend())) {
aRv.ThrowInvalidStateError("JSWindowActorChild cannot send at the moment");
return;
}
if (mManager->IsInProcess()) {
SendRawMessageInProcess(
aMeta, std::move(aData), std::move(aStack),
[manager{mManager}]() { return manager->GetParentActor(); });
return;
}
size_t length = 0;
if (aData) {
length += aData->DataLength();
}
if (aStack) {
length += aStack->DataLength();
}
if (NS_WARN_IF(!AllowMessage(aMeta, length))) {
aRv.ThrowDataCloneError(
nsPrintfCString("JSWindowActorChild serialization error: data too "
"large, in actor '%s'",
PromiseFlatCString(aMeta.actorName()).get()));
return;
}
// Cross-process case - send data over WindowGlobalChild to other side.
ContentChild* cc = ContentChild::GetSingleton();
Maybe<ClonedMessageData> msgData;
if (aData) {
msgData.emplace();
if (NS_WARN_IF(!aData->BuildClonedMessageDataForChild(cc, *msgData))) {
aRv.ThrowDataCloneError(
nsPrintfCString("JSWindowActorChild serialization error: cannot "
"clone, in actor '%s'",
PromiseFlatCString(aMeta.actorName()).get()));
return;
}
}
Maybe<ClonedMessageData> stackData;
if (aStack) {
stackData.emplace();
if (!aStack->BuildClonedMessageDataForChild(cc, *stackData)) {
stackData.reset();
}
}
if (NS_WARN_IF(!mManager->SendRawMessage(aMeta, msgData, stackData))) {
aRv.ThrowOperationError(
nsPrintfCString("JSWindowActorChild send error in actor '%s'",
PromiseFlatCString(aMeta.actorName()).get()));
return;
}
}
Document* JSWindowActorChild::GetDocument(ErrorResult& aRv) {
if (!mManager) {
ThrowStateErrorForGetter("document", aRv);
return nullptr;
}
nsGlobalWindowInner* window = mManager->GetWindowGlobal();
return window ? window->GetDocument() : nullptr;
}
BrowsingContext* JSWindowActorChild::GetBrowsingContext(ErrorResult& aRv) {
if (!mManager) {
ThrowStateErrorForGetter("browsingContext", aRv);
return nullptr;
}
return mManager->BrowsingContext();
}
nsIDocShell* JSWindowActorChild::GetDocShell(ErrorResult& aRv) {
if (!mManager) {
ThrowStateErrorForGetter("docShell", aRv);
return nullptr;
}
return mManager->BrowsingContext()->GetDocShell();
}
Nullable<WindowProxyHolder> JSWindowActorChild::GetContentWindow(
ErrorResult& aRv) {
if (!mManager) {
ThrowStateErrorForGetter("contentWindow", aRv);
return nullptr;
}
if (nsGlobalWindowInner* window = mManager->GetWindowGlobal()) {
if (window->IsCurrentInnerWindow()) {
return WindowProxyHolder(window->GetBrowsingContext());
}
}
return nullptr;
}
void JSWindowActorChild::ClearManager() { mManager = nullptr; }
NS_IMPL_CYCLE_COLLECTION_INHERITED(JSWindowActorChild, JSActor, mManager)
NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN_INHERITED(JSWindowActorChild, JSActor)
NS_IMPL_CYCLE_COLLECTION_TRACE_END
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(JSWindowActorChild)
NS_INTERFACE_MAP_END_INHERITING(JSActor)
NS_IMPL_ADDREF_INHERITED(JSWindowActorChild, JSActor)
NS_IMPL_RELEASE_INHERITED(JSWindowActorChild, JSActor)
} // namespace mozilla::dom