Bug 1771092 - Part 1: Add esModuleURI key to ProcessActorSidedOptions/WindowActorSidedOptions and support loading system ESM. r=kmag

Differential Revision: https://phabricator.services.mozilla.com/D147422

Author: arai-a

dom/chrome-webidl/JSProcessActor.webidl

@@ -62,10 +62,24 @@ dictionary ProcessActorOptions {
 dictionary ProcessActorSidedOptions {
   /**
    * The JSM path which should be loaded for the actor on this side.
-   * If not passed, the specified side cannot receive messages, but may send
-   * them using `sendAsyncMessage` or `sendQuery`.
+   *
+   * Mutually exclusive with `esModuleURI`.
+   *
+   * If neither this nor `esModuleURI` is passed, the specified side cannot receive
+   * messages, but may send them using `sendAsyncMessage` or `sendQuery`.
+   */
+  ByteString moduleURI;
+
+  /**
+   * The ESM path which should be loaded for the actor on this side.
+   *
+   * Mutually exclusive with `moduleURI`.
+   *
+   * If neither this nor `moduleURI` is passed, the specified side cannot
+   * receive messages, but may send them using `sendAsyncMessage` or
+   * `sendQuery`.
    */
-  required ByteString moduleURI;
+  ByteString esModuleURI;
 };
 
 dictionary ProcessActorChildOptions : ProcessActorSidedOptions {

dom/chrome-webidl/JSWindowActor.webidl

@@ -127,10 +127,24 @@ dictionary WindowActorOptions {
 dictionary WindowActorSidedOptions {
   /**
    * The JSM path which should be loaded for the actor on this side.
-   * If not passed, the specified side cannot receive messages, but may send
-   * them using `sendAsyncMessage` or `sendQuery`.
+   *
+   * Mutually exclusive with `esModuleURI`.
+   *
+   * If neither this nor `esModuleURI` is passed, the specified side cannot receive
+   * messages, but may send them using `sendAsyncMessage` or `sendQuery`.
+   */
+  ByteString moduleURI;
+
+  /**
+   * The ESM path which should be loaded for the actor on this side.
+   *
+   * Mutually exclusive with `moduleURI`.
+   *
+   * If neither this nor `moduleURI` is passed, the specified side cannot
+   * receive messages, but may send them using `sendAsyncMessage` or
+   * `sendQuery`.
    */
-  required ByteString moduleURI;
+  ByteString esModuleURI;
 };
 
 dictionary WindowActorEventListenerOptions : AddEventListenerOptions {

dom/ipc/PContent.ipdl

@@ -294,6 +294,10 @@ struct JSWindowActorInfo
   nsCString name;
   bool allFrames;
 
+  // True if `url` is for ESM.
+  // False if `url` is for JSM or nothing.
+  bool isESModule;
+
   // The module of the url.
   nsCString? url;
 
@@ -310,6 +314,11 @@ struct JSProcessActorInfo
 {
     // The name of the actor.
     nsCString name;
+
+    // True if `url` is for ESM.
+    // False if `url` is for JSM or nothing.
+    bool isESModule;
+
     // The module of the url.
     nsCString? url;
 

dom/ipc/jsactor/JSActorManager.cpp

@@ -65,18 +65,25 @@ already_AddRefed<JSActor> JSActorManager::GetActor(JSContext* aCx,
   MOZ_ASSERT(loader);
 
   // If a module URI was provided, use it to construct an instance of the actor.
-  JS::RootedObject actorObj(aCx);
-  if (side.mModuleURI) {
-    JS::RootedObject global(aCx);
-    JS::RootedObject exports(aCx);
-    aRv = loader->Import(aCx, side.mModuleURI.ref(), &global, &exports);
-    if (aRv.Failed()) {
-      return nullptr;
+  JS::Rooted<JSObject*> actorObj(aCx);
+  if (side.mModuleURI || side.mESModuleURI) {
+    JS::Rooted<JSObject*> exports(aCx);
+    if (side.mModuleURI) {
+      JS::Rooted<JSObject*> global(aCx);
+      aRv = loader->Import(aCx, side.mModuleURI.ref(), &global, &exports);
+      if (aRv.Failed()) {
+        return nullptr;
+      }
+    } else {
+      aRv = loader->ImportESModule(aCx, side.mESModuleURI.ref(), &exports);
+      if (aRv.Failed()) {
+        return nullptr;
+      }
     }
     MOZ_ASSERT(exports, "null exports!");
 
     // Load the specific property from our module.
-    JS::RootedValue ctor(aCx);
+    JS::Rooted<JS::Value> ctor(aCx);
     nsAutoCString ctorName(aName);
     ctorName.Append(isParent ? "Parent"_ns : "Child"_ns);
     if (!JS_GetProperty(aCx, exports, ctorName.get(), &ctor)) {

dom/ipc/jsactor/JSActorProtocolUtils.h

@@ -0,0 +1,117 @@
+/* -*- 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/. */
+
+#ifndef mozilla_dom_JSActorProtocolUtils_h
+#define mozilla_dom_JSActorProtocolUtils_h
+
+#include "mozilla/Assertions.h"   // MOZ_ASSERT
+#include "mozilla/ErrorResult.h"  // ErrorResult
+
+namespace mozilla {
+
+namespace dom {
+
+class JSActorProtocolUtils {
+ public:
+  template <typename ProtoT, typename ActorInfoT>
+  static void FromIPCShared(ProtoT& aProto, const ActorInfoT& aInfo) {
+    aProto->mRemoteTypes = aInfo.remoteTypes().Clone();
+
+    if (aInfo.isESModule()) {
+      aProto->mChild.mESModuleURI = aInfo.url();
+    } else {
+      aProto->mChild.mModuleURI = aInfo.url();
+    }
+
+    aProto->mChild.mObservers = aInfo.observers().Clone();
+  }
+
+  template <typename ProtoT, typename ActorInfoT>
+  static void ToIPCShared(ActorInfoT& aInfo, const ProtoT& aProto) {
+    aInfo.name() = aProto->mName;
+
+    aInfo.remoteTypes() = aProto->mRemoteTypes.Clone();
+
+    if (aProto->mChild.mModuleURI) {
+      aInfo.url() = aProto->mChild.mModuleURI;
+      aInfo.isESModule() = false;
+    } else {
+      aInfo.url() = aProto->mChild.mESModuleURI;
+      aInfo.isESModule() = true;
+    }
+
+    aInfo.observers() = aProto->mChild.mObservers.Clone();
+  }
+
+  template <typename ProtoT, typename ActorOptionsT>
+  static bool FromWebIDLOptionsShared(ProtoT& aProto,
+                                      const ActorOptionsT& aOptions,
+                                      ErrorResult& aRv) {
+    if (aOptions.mRemoteTypes.WasPassed()) {
+      MOZ_ASSERT(aOptions.mRemoteTypes.Value().Length());
+      aProto->mRemoteTypes = aOptions.mRemoteTypes.Value();
+    }
+
+    if (aOptions.mParent.WasPassed()) {
+      const auto& parentOptions = aOptions.mParent.Value();
+
+      if (parentOptions.mModuleURI.WasPassed()) {
+        if (parentOptions.mEsModuleURI.WasPassed()) {
+          aRv.ThrowNotSupportedError(
+              "moduleURI and esModuleURI are mutually exclusive.");
+          return false;
+        }
+
+        aProto->mParent.mModuleURI.emplace(parentOptions.mModuleURI.Value());
+      } else if (parentOptions.mEsModuleURI.WasPassed()) {
+        aProto->mParent.mESModuleURI.emplace(
+            parentOptions.mEsModuleURI.Value());
+      } else {
+        aRv.ThrowNotSupportedError(
+            "Either moduleURI or esModuleURI is required.");
+        return false;
+      }
+    }
+    if (aOptions.mChild.WasPassed()) {
+      const auto& childOptions = aOptions.mChild.Value();
+
+      if (childOptions.mModuleURI.WasPassed()) {
+        if (childOptions.mEsModuleURI.WasPassed()) {
+          aRv.ThrowNotSupportedError(
+              "moduleURI and esModuleURI are exclusive.");
+          return false;
+        }
+
+        aProto->mChild.mModuleURI.emplace(childOptions.mModuleURI.Value());
+      } else if (childOptions.mEsModuleURI.WasPassed()) {
+        aProto->mChild.mESModuleURI.emplace(childOptions.mEsModuleURI.Value());
+      } else {
+        aRv.ThrowNotSupportedError(
+            "Either moduleURI or esModuleURI is required.");
+        return false;
+      }
+    }
+
+    if (!aOptions.mChild.WasPassed() && !aOptions.mParent.WasPassed()) {
+      aRv.ThrowNotSupportedError(
+          "No point registering an actor with neither child nor parent "
+          "specifications.");
+      return false;
+    }
+
+    if (aOptions.mChild.WasPassed() &&
+        aOptions.mChild.Value().mObservers.WasPassed()) {
+      aProto->mChild.mObservers = aOptions.mChild.Value().mObservers.Value();
+    }
+
+    return true;
+  }
+};
+
+}  // namespace dom
+}  // namespace mozilla
+
+#endif  // mozilla_dom_JSActorProtocolUtils_h

dom/ipc/jsactor/JSActorService.h

@@ -99,6 +99,7 @@ class JSActorProtocol : public nsISupports {
  public:
   struct Sided {
     Maybe<nsCString> mModuleURI;
+    Maybe<nsCString> mESModuleURI;
   };
 
   virtual const Sided& Parent() const = 0;

dom/ipc/jsactor/JSProcessActorProtocol.cpp

@@ -12,7 +12,9 @@
 #include "mozilla/dom/ContentParent.h"
 #include "mozilla/dom/JSActorBinding.h"
 #include "mozilla/dom/PContent.h"
+
 #include "nsContentUtils.h"
+#include "JSActorProtocolUtils.h"
 
 namespace mozilla::dom {
 
@@ -31,13 +33,11 @@ JSProcessActorProtocol::FromIPC(const JSProcessActorInfo& aInfo) {
 
   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;
-  proto->mRemoteTypes = aInfo.remoteTypes().Clone();
-  proto->mChild.mModuleURI = aInfo.url();
-  proto->mChild.mObservers = aInfo.observers().Clone();
 
   return proto.forget();
 }
@@ -46,10 +46,8 @@ JSProcessActorInfo JSProcessActorProtocol::ToIPC() {
   MOZ_DIAGNOSTIC_ASSERT(XRE_IsParentProcess());
 
   JSProcessActorInfo info;
-  info.name() = mName;
-  info.remoteTypes() = mRemoteTypes.Clone();
-  info.url() = mChild.mModuleURI;
-  info.observers() = mChild.mObservers.Clone();
+  JSActorProtocolUtils::ToIPCShared(info, this);
+
   return info;
 }
 
@@ -60,31 +58,11 @@ JSProcessActorProtocol::FromWebIDLOptions(const nsACString& aName,
   MOZ_DIAGNOSTIC_ASSERT(XRE_IsParentProcess());
 
   RefPtr<JSProcessActorProtocol> proto = new JSProcessActorProtocol(aName);
-  proto->mIncludeParent = aOptions.mIncludeParent;
-
-  if (aOptions.mRemoteTypes.WasPassed()) {
-    MOZ_ASSERT(aOptions.mRemoteTypes.Value().Length());
-    proto->mRemoteTypes = aOptions.mRemoteTypes.Value();
-  }
-
-  if (aOptions.mParent.WasPassed()) {
-    proto->mParent.mModuleURI.emplace(aOptions.mParent.Value().mModuleURI);
-  }
-  if (aOptions.mChild.WasPassed()) {
-    proto->mChild.mModuleURI.emplace(aOptions.mChild.Value().mModuleURI);
-  }
-
-  if (!aOptions.mChild.WasPassed() && !aOptions.mParent.WasPassed()) {
-    aRv.ThrowNotSupportedError(
-        "No point registering an actor with neither child nor parent "
-        "specifications.");
+  if (!JSActorProtocolUtils::FromWebIDLOptionsShared(proto, aOptions, aRv)) {
     return nullptr;
   }
 
-  if (aOptions.mChild.WasPassed() &&
-      aOptions.mChild.Value().mObservers.WasPassed()) {
-    proto->mChild.mObservers = aOptions.mChild.Value().mObservers.Value();
-  }
+  proto->mIncludeParent = aOptions.mIncludeParent;
 
   return proto.forget();
 }

dom/ipc/jsactor/JSProcessActorProtocol.h

@@ -22,6 +22,7 @@ namespace dom {
 struct ProcessActorOptions;
 class JSProcessActorInfo;
 class EventTarget;
+class JSActorProtocolUtils;
 
 /**
  * Object corresponding to a single process actor protocol
@@ -66,6 +67,8 @@ class JSProcessActorProtocol final : public JSActorProtocol,
   nsTArray<nsCString> mRemoteTypes;
   bool mIncludeParent = false;
 
+  friend class JSActorProtocolUtils;
+
   ParentSide mParent;
   ChildSide mChild;
 };