1 files changed, 76 insertions, 0 deletions
diff --git a/devtools/server/connectors/js-window-actor/WindowGlobalLogger.sys.mjs b/devtools/server/connectors/js-window-actor/WindowGlobalLogger.sys.mjs
new file mode 100644
index 0000000000..ae15c030fe
--- /dev/null
+++ b/devtools/server/connectors/js-window-actor/WindowGlobalLogger.sys.mjs
@@ -0,0 +1,76 @@
+/* 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/. */
+
+function getWindowGlobalUri(windowGlobal) {
+  let windowGlobalUri = "";
+
+  if (windowGlobal.documentURI) {
+    // If windowGlobal is a WindowGlobalParent documentURI should be available.
+    windowGlobalUri = windowGlobal.documentURI.spec;
+  } else if (windowGlobal.browsingContext?.window) {
+    // If windowGlobal is a WindowGlobalChild, this code runs in the same
+    // process as the document and we can directly access the window.location
+    // object.
+    windowGlobalUri = windowGlobal.browsingContext.window.location.href;
+    if (!windowGlobalUri) {
+      windowGlobalUri =
+        windowGlobal.browsingContext.window.document.documentURI;
+    }
+  }
+
+  return windowGlobalUri;
+}
+
+export const WindowGlobalLogger = {
+  /**
+   * This logger can run from the content or parent process, and windowGlobal
+   * will either be of type `WindowGlobalParent` or `WindowGlobalChild`.
+   *
+   * The interface for each type can be found in WindowGlobalActors.webidl
+   * (https://searchfox.org/mozilla-central/source/dom/chrome-webidl/WindowGlobalActors.webidl)
+   *
+   * @param {WindowGlobalParent|WindowGlobalChild} windowGlobal
+   *        The window global to log. See WindowGlobalActors.webidl for details
+   *        about the types.
+   * @param {String} message
+   *        A custom message that will be displayed at the beginning of the log.
+   */
+  logWindowGlobal(windowGlobal, message) {
+    const { browsingContext } = windowGlobal;
+    const { parent } = browsingContext;
+    const windowGlobalUri = getWindowGlobalUri(windowGlobal);
+    const isInitialDocument =
+      "isInitialDocument" in windowGlobal
+        ? windowGlobal.isInitialDocument
+        : windowGlobal.browsingContext.window?.document.isInitialDocument;
+
+    const details = [];
+    details.push(
+      "BrowsingContext.browserId: " + browsingContext.browserId,
+      "BrowsingContext.id: " + browsingContext.id,
+      "innerWindowId: " + windowGlobal.innerWindowId,
+      "opener.id: " + browsingContext.opener?.id,
+      "pid: " + windowGlobal.osPid,
+      "isClosed: " + windowGlobal.isClosed,
+      "isInProcess: " + windowGlobal.isInProcess,
+      "isCurrentGlobal: " + windowGlobal.isCurrentGlobal,
+      "isProcessRoot: " + windowGlobal.isProcessRoot,
+      "currentRemoteType: " + browsingContext.currentRemoteType,
+      "hasParent: " + (parent ? parent.id : "no"),
+      "uri: " + (windowGlobalUri ? windowGlobalUri : "no uri"),
+      "isProcessRoot: " + windowGlobal.isProcessRoot,
+      "BrowsingContext.isContent: " + windowGlobal.browsingContext.isContent,
+      "isInitialDocument: " + isInitialDocument
+    );
+
+    const header = "[WindowGlobalLogger] " + message;
+
+    // Use a padding for multiline display.
+    const padding = "    ";
+    const formattedDetails = details.map(s => padding + s);
+    const detailsString = formattedDetails.join("\n");
+
+    dump(header + "\n" + detailsString + "\n");
+  },
+};