fune/dom/ipc/jsactor/JSProcessActorProtocol.cpp
Alexandre Poirot b3006699b6 Bug 1864128 - Allow loading JSProcess Actors in the DevTools specific module loader. r=arai
Passing `loadInDevToolsLoader` to JSProcess actor options will force loading
both parent and content modules in the distinct module loader used by DevTools.

This distinct module loader is maintained by mozJSModuleLoader and is used
by the DevTools Browser Console/Toolbox to debug privileged JS code
typically using the "shared JSM Global" from DevTools modules
loaded in a distinct and specific DevTools module loader.

Differential Revision: https://phabricator.services.mozilla.com/D193280
2023-11-21 10:02:47 +00:00

149 lines
4.9 KiB
C++

/* -*- 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, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "mozilla/dom/JSProcessActorProtocol.h"
#include "mozilla/dom/InProcessChild.h"
#include "mozilla/dom/JSProcessActorBinding.h"
#include "mozilla/dom/ContentChild.h"
#include "mozilla/dom/ContentParent.h"
#include "mozilla/dom/JSActorBinding.h"
#include "mozilla/dom/PContent.h"
#include "nsContentUtils.h"
#include "JSActorProtocolUtils.h"
namespace mozilla::dom {
NS_IMPL_CYCLE_COLLECTING_ADDREF(JSProcessActorProtocol)
NS_IMPL_CYCLE_COLLECTING_RELEASE(JSProcessActorProtocol)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(JSProcessActorProtocol)
NS_INTERFACE_MAP_ENTRY(nsIObserver)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTION(JSProcessActorProtocol)
/* static */ already_AddRefed<JSProcessActorProtocol>
JSProcessActorProtocol::FromIPC(const JSProcessActorInfo& aInfo) {
MOZ_DIAGNOSTIC_ASSERT(XRE_IsContentProcess());
RefPtr<JSProcessActorProtocol> proto =
new JSProcessActorProtocol(aInfo.name());
JSActorProtocolUtils::FromIPCShared(proto, aInfo);
// Content processes aren't the parent process, so this flag is irrelevant and
// not propagated.
proto->mIncludeParent = false;
return proto.forget();
}
JSProcessActorInfo JSProcessActorProtocol::ToIPC() {
MOZ_DIAGNOSTIC_ASSERT(XRE_IsParentProcess());
JSProcessActorInfo info;
JSActorProtocolUtils::ToIPCShared(info, this);
return info;
}
already_AddRefed<JSProcessActorProtocol>
JSProcessActorProtocol::FromWebIDLOptions(const nsACString& aName,
const ProcessActorOptions& aOptions,
ErrorResult& aRv) {
MOZ_DIAGNOSTIC_ASSERT(XRE_IsParentProcess());
RefPtr<JSProcessActorProtocol> proto = new JSProcessActorProtocol(aName);
if (!JSActorProtocolUtils::FromWebIDLOptionsShared(proto, aOptions, aRv)) {
return nullptr;
}
proto->mIncludeParent = aOptions.mIncludeParent;
proto->mLoadInDevToolsLoader = aOptions.mLoadInDevToolsLoader;
return proto.forget();
}
NS_IMETHODIMP JSProcessActorProtocol::Observe(nsISupports* aSubject,
const char* aTopic,
const char16_t* aData) {
MOZ_ASSERT(nsContentUtils::IsSafeToRunScript());
RefPtr<JSActorManager> manager;
if (XRE_IsParentProcess()) {
manager = InProcessChild::Singleton();
} else {
manager = ContentChild::GetSingleton();
}
// Ensure our actor is present.
AutoJSAPI jsapi;
jsapi.Init();
RefPtr<JSActor> actor = manager->GetActor(jsapi.cx(), mName, IgnoreErrors());
if (!actor || NS_WARN_IF(!actor->GetWrapperPreserveColor())) {
return NS_OK;
}
// Build a observer callback.
JS::Rooted<JSObject*> global(jsapi.cx(),
JS::GetNonCCWObjectGlobal(actor->GetWrapper()));
RefPtr<MozObserverCallback> observerCallback =
new MozObserverCallback(actor->GetWrapper(), global, nullptr, nullptr);
observerCallback->Observe(aSubject, nsDependentCString(aTopic),
aData ? nsDependentString(aData) : VoidString());
return NS_OK;
}
void JSProcessActorProtocol::AddObservers() {
nsCOMPtr<nsIObserverService> os = services::GetObserverService();
for (auto& topic : mChild.mObservers) {
// This makes the observer service hold an owning reference to the
// JSProcessActorProtocol. The JSWindowActorProtocol objects will be living
// for the full lifetime of the content process, thus the extra strong
// referencec doesn't have a negative impact.
os->AddObserver(this, topic.get(), false);
}
}
void JSProcessActorProtocol::RemoveObservers() {
nsCOMPtr<nsIObserverService> os = services::GetObserverService();
for (auto& topic : mChild.mObservers) {
os->RemoveObserver(this, topic.get());
}
}
bool JSProcessActorProtocol::RemoteTypePrefixMatches(
const nsDependentCSubstring& aRemoteType) {
for (auto& remoteType : mRemoteTypes) {
if (StringBeginsWith(aRemoteType, remoteType)) {
return true;
}
}
return false;
}
bool JSProcessActorProtocol::Matches(const nsACString& aRemoteType,
ErrorResult& aRv) {
if (!mIncludeParent && aRemoteType.IsEmpty()) {
aRv.ThrowNotSupportedError(nsPrintfCString(
"Process protocol '%s' doesn't match the parent process", mName.get()));
return false;
}
if (!mRemoteTypes.IsEmpty() &&
!RemoteTypePrefixMatches(RemoteTypePrefix(aRemoteType))) {
aRv.ThrowNotSupportedError(nsPrintfCString(
"Process protocol '%s' doesn't support remote type '%s'", mName.get(),
PromiseFlatCString(aRemoteType).get()));
return false;
}
return true;
}
} // namespace mozilla::dom