Quellcode-Bibliothek script.sys.mjs   Sprache: unbekannt

/* 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/. */

import { RootBiDiModule } from "chrome://remote/content/webdriver-bidi/modules/RootBiDiModule.sys.mjs";

const lazy = {};

ChromeUtils.defineESModuleGetters(lazy, {
  assert: "chrome://remote/content/shared/webdriver/Assert.sys.mjs",
  BrowsingContextListener:
    "chrome://remote/content/shared/listeners/BrowsingContextListener.sys.mjs",
  ContextDescriptorType:
    "chrome://remote/content/shared/messagehandler/MessageHandler.sys.mjs",
  error: "chrome://remote/content/shared/webdriver/Errors.sys.mjs",
  generateUUID: "chrome://remote/content/shared/UUID.sys.mjs",
  isParentProcess:
    "chrome://remote/content/shared/BrowsingContextUtils.sys.mjs",
  NavigableManager: "chrome://remote/content/shared/NavigableManager.sys.mjs",
  OwnershipModel: "chrome://remote/content/webdriver-bidi/RemoteValue.sys.mjs",
  pprint: "chrome://remote/content/shared/Format.sys.mjs",
  processExtraData:
    "chrome://remote/content/webdriver-bidi/modules/Intercept.sys.mjs",
  RealmType: "chrome://remote/content/shared/Realm.sys.mjs",
  RemoteAgent: "chrome://remote/content/components/RemoteAgent.sys.mjs",
  SessionDataCategory:
    "chrome://remote/content/shared/messagehandler/sessiondata/SessionData.sys.mjs",
  SessionDataMethod:
    "chrome://remote/content/shared/messagehandler/sessiondata/SessionData.sys.mjs",
  setDefaultAndAssertSerializationOptions:
    "chrome://remote/content/webdriver-bidi/RemoteValue.sys.mjs",
  UserContextManager:
    "chrome://remote/content/shared/UserContextManager.sys.mjs",
  waitForTopBrowsingContextToBeReady:
    "chrome://remote/content/shared/BrowsingContextUtils.sys.mjs",
  WindowGlobalMessageHandler:
    "chrome://remote/content/shared/messagehandler/WindowGlobalMessageHandler.sys.mjs",
  workerListenerRegistry:
    "chrome://remote/content/shared/js-process-actors/WebDriverWorkerListenerActor.sys.mjs",
});

/**
 * @typedef {string} ScriptEvaluateResultType
 */

/**
 * Enum of possible evaluation result types.
 *
 * @readonly
 * @enum {ScriptEvaluateResultType}
 */
const ScriptEvaluateResultType = {
  Exception: "exception",
  Success: "success",
};

/**
 * An object that holds information about the preload script.
 *
 * @typedef PreloadScript
 *
 * @property {Array<ChannelValue>=} arguments
 *    The arguments to pass to the function call.
 * @property {Array<string>=} navigables
 *    The list of navigable browser ids where
 *    the preload script should be executed.
 * @property {string} functionDeclaration
 *    The expression to evaluate.
 * @property {string=} sandbox
 *    The name of the sandbox.
 * @property {Array<string>=} userContexts
 *    The list of internal user context ids where
 *    the preload script should be executed.
 */

class ScriptModule extends RootBiDiModule {
  #submittedContextsCreated;
  #contextListener;
  #preloadScriptMap;
  #realmInfoMap;
  #subscribedEvents;

  constructor(messageHandler) {
    super(messageHandler);

    this.#contextListener = new lazy.BrowsingContextListener();
    this.#contextListener.on("attached", this.#onContextAttached);
    this.#contextListener.on("discarded", this.#onContextDiscarded);

    // Set of browsing context ids for which "browsingContext.contextCreated" event was sent.
    this.#submittedContextsCreated = new Set();

    // Map in which the keys are UUIDs, and the values are structs
    // of the type PreloadScript.
    this.#preloadScriptMap = new Map();

    // Map with browsing contexts as keys and realm info object
    // as values.
    this.#realmInfoMap = new WeakMap();

    // Set of event names which have active subscriptions.
    this.#subscribedEvents = new Set();
  }

  destroy() {
    this.#contextListener.off("attached", this.#onContextAttached);
    this.#contextListener.off("discarded", this.#onContextDiscarded);
    this.#contextListener.destroy();

    this.#submittedContextsCreated = null;
    this.#preloadScriptMap = null;
    this.#realmInfoMap = null;
    this.#subscribedEvents = null;
  }

  /**
   * Used as return value for script.addPreloadScript command.
   *
   * @typedef AddPreloadScriptResult
   *
   * @property {string} script
   *    The unique id associated with added preload script.
   */

  /**
   * @typedef ChannelProperties
   *
   * @property {string} channel
   *     The channel id.
   * @property {SerializationOptions=} serializationOptions
   *     An object which holds the information of how the result of evaluation
   *     in case of ECMAScript objects should be serialized.
   * @property {OwnershipModel=} ownership
   *     The ownership model to use for the results of this evaluation. Defaults
   *     to `OwnershipModel.None`.
   */

  /**
   * Represents a channel used to send custom messages from preload script
   * to clients.
   *
   * @typedef ChannelValue
   *
   * @property {'channel'} type
   * @property {ChannelProperties} value
   */

  /**
   * Adds a preload script, which runs on creation of a new Window,
   * before any author-defined script have run.
   *
   * @param {object=} options
   * @param {Array<ChannelValue>=} options.arguments
   *     The arguments to pass to the function call.
   * @param {Array<string>=} options.contexts
   *     The list of the browsing context ids.
   * @param {string} options.functionDeclaration
   *     The expression to evaluate.
   * @param {string=} options.sandbox
   *     The name of the sandbox. If the value is null or empty
   *     string, the default realm will be used.
   * @param {Array<string>=} options.userContexts
   *     The list of the user context ids.
   *
   * @returns {AddPreloadScriptResult}
   *
   * @throws {InvalidArgumentError}
   *     If any of the arguments does not have the expected type.
   */
  async addPreloadScript(options = {}) {
    const {
      arguments: commandArguments = [],
      contexts: contextIds = null,
      functionDeclaration,
      sandbox = null,
      userContexts: userContextIds = null,
    } = options;
    let userContexts = null;
    let navigables = null;

    if (contextIds !== null) {
      lazy.assert.isNonEmptyArray(
        contextIds,
        lazy.pprint`Expected "contexts" to be a non-empty array, got ${contextIds}`
      );

      for (const contextId of contextIds) {
        lazy.assert.string(
          contextId,
          lazy.pprint`Expected elements of "contexts" to be a string, got ${contextId}`
        );
      }
    } else if (userContextIds !== null) {
      lazy.assert.isNonEmptyArray(
        userContextIds,
        lazy.pprint`Expected "userContextIds" to be a non-empty array, got ${userContextIds}`
      );

      for (const userContextId of userContextIds) {
        lazy.assert.string(
          userContextId,
          lazy.pprint`Expected elements of "userContexts" to be a string, got ${userContextId}`
        );
      }
    }

    lazy.assert.string(
      functionDeclaration,
      lazy.pprint`Expected "functionDeclaration" to be a string, got ${functionDeclaration}`
    );

    if (sandbox != null) {
      lazy.assert.string(
        sandbox,
        lazy.pprint`Expected "sandbox" to be a string, got ${sandbox}`
      );
    }

    lazy.assert.array(
      commandArguments,
      lazy.pprint`Expected "arguments" to be an array, got ${commandArguments}`
    );

    commandArguments.forEach(({ type, value }) => {
      lazy.assert.that(
        t => t === "channel",
        lazy.pprint`Expected argument "type" to be "channel", got ${type}`
      )(type);
      this.#assertChannelArgument(value);
    });

    if (contextIds !== null && userContextIds !== null) {
      throw new lazy.error.InvalidArgumentError(
        `Providing both "contexts" and "userContexts" arguments is not supported`
      );
    }

    if (contextIds !== null) {
      navigables = new Set();

      for (const contextId of contextIds) {
        const context = this._getNavigable(contextId);

        lazy.assert.topLevel(
          context,
          lazy.pprint`Browsing context with id ${contextId} is not top-level`
        );

        navigables.add(context.browserId);
      }
    } else if (userContextIds !== null) {
      userContexts = new Set();

      for (const userContextId of userContextIds) {
        const internalId =
          lazy.UserContextManager.getInternalIdById(userContextId);

        if (internalId === null) {
          throw new lazy.error.NoSuchUserContextError(
            `User context with id: ${userContextId} doesn't exist`
          );
        }

        userContexts.add(internalId);
      }
    }

    const script = lazy.generateUUID();
    const preloadScript = {
      arguments: commandArguments,
      contexts: navigables,
      functionDeclaration,
      sandbox,
      userContexts,
    };

    this.#preloadScriptMap.set(script, preloadScript);

    const preloadScriptDataItem = {
      category: lazy.SessionDataCategory.PreloadScript,
      moduleName: "_configuration",
      values: [
        {
          ...preloadScript,
          script,
        },
      ],
    };

    if (navigables === null && userContexts === null) {
      await this.messageHandler.addSessionDataItem({
        ...preloadScriptDataItem,
        contextDescriptor: {
          type: lazy.ContextDescriptorType.All,
        },
      });
    } else {
      const preloadScriptDataItems = [];

      if (navigables === null) {
        for (const id of userContexts) {
          preloadScriptDataItems.push({
            ...preloadScriptDataItem,
            contextDescriptor: {
              type: lazy.ContextDescriptorType.UserContext,
              id,
            },
            method: lazy.SessionDataMethod.Add,
          });
        }
      } else {
        for (const id of navigables) {
          preloadScriptDataItems.push({
            ...preloadScriptDataItem,
            contextDescriptor: {
              type: lazy.ContextDescriptorType.TopBrowsingContext,
              id,
            },
            method: lazy.SessionDataMethod.Add,
          });
        }
      }

      await this.messageHandler.updateSessionData(preloadScriptDataItems);
    }

    return { script };
  }

  /**
   * Used to represent a frame of a JavaScript stack trace.
   *
   * @typedef StackFrame
   *
   * @property {number} columnNumber
   * @property {string} functionName
   * @property {number} lineNumber
   * @property {string} url
   */

  /**
   * Used to represent a JavaScript stack at a point in script execution.
   *
   * @typedef StackTrace
   *
   * @property {Array<StackFrame>} callFrames
   */

  /**
   * Used to represent a JavaScript exception.
   *
   * @typedef ExceptionDetails
   *
   * @property {number} columnNumber
   * @property {RemoteValue} exception
   * @property {number} lineNumber
   * @property {StackTrace} stackTrace
   * @property {string} text
   */

  /**
   * Used as return value for script.evaluate, as one of the available variants
   * {ScriptEvaluateResultException} or {ScriptEvaluateResultSuccess}.
   *
   * @typedef ScriptEvaluateResult
   */

  /**
   * Used as return value for script.evaluate when the script completes with a
   * thrown exception.
   *
   * @typedef ScriptEvaluateResultException
   *
   * @property {ExceptionDetails} exceptionDetails
   * @property {string} realm
   * @property {ScriptEvaluateResultType} [type=ScriptEvaluateResultType.Exception]
   */

  /**
   * Used as return value for script.evaluate when the script completes
   * normally.
   *
   * @typedef ScriptEvaluateResultSuccess
   *
   * @property {string} realm
   * @property {RemoteValue} result
   * @property {ScriptEvaluateResultType} [type=ScriptEvaluateResultType.Success]
   */

  /**
   * Calls a provided function with given arguments and scope in the provided
   * target, which is either a realm or a browsing context.
   *
   * @param {object=} options
   * @param {Array<RemoteValue>=} options.arguments
   *     The arguments to pass to the function call.
   * @param {boolean} options.awaitPromise
   *     Determines if the command should wait for the return value of the
   *     expression to resolve, if this return value is a Promise.
   * @param {string} options.functionDeclaration
   *     The expression to evaluate.
   * @param {OwnershipModel=} options.resultOwnership
   *     The ownership model to use for the results of this evaluation. Defaults
   *     to `OwnershipModel.None`.
   * @param {SerializationOptions=} options.serializationOptions
   *     An object which holds the information of how the result of evaluation
   *     in case of ECMAScript objects should be serialized.
   * @param {object} options.target
   *     The target for the evaluation, which either matches the definition for
   *     a RealmTarget or for ContextTarget.
   * @param {RemoteValue=} options.this
   *     The value of the this keyword for the function call.
   * @param {boolean=} options.userActivation
   *     Determines whether execution should be treated as initiated by user.
   *     Defaults to `false`.
   *
   * @returns {ScriptEvaluateResult}
   *
   * @throws {InvalidArgumentError}
   *     If any of the arguments does not have the expected type.
   * @throws {NoSuchFrameError}
   *     If the target cannot be found.
   */
  async callFunction(options = {}) {
    const {
      arguments: commandArguments = null,
      awaitPromise,
      functionDeclaration,
      resultOwnership = lazy.OwnershipModel.None,
      serializationOptions,
      target = {},
      this: thisParameter = null,
      userActivation = false,
    } = options;

    lazy.assert.string(
      functionDeclaration,
      lazy.pprint`Expected "functionDeclaration" to be a string, got ${functionDeclaration}`
    );

    lazy.assert.boolean(
      awaitPromise,
      lazy.pprint`Expected "awaitPromise" to be a boolean, got ${awaitPromise}`
    );

    lazy.assert.boolean(
      userActivation,
      lazy.pprint`Expected "userActivation" to be a boolean, got ${userActivation}`
    );

    this.#assertResultOwnership(resultOwnership);

    if (commandArguments != null) {
      lazy.assert.array(
        commandArguments,
        lazy.pprint`Expected "arguments" to be an array, got ${commandArguments}`
      );
      commandArguments.forEach(({ type, value }) => {
        if (type === "channel") {
          this.#assertChannelArgument(value);
        }
      });
    }

    const { contextId, realmId, sandbox } = this.#assertTarget(target);
    const context = await this.#getContextFromTarget({
      contextId,
      realmId,
      supportsChromeScope: true,
    });

    // Bug 2030901: this check should be handled by getContextFromTarget via
    // _getNavigable, but at the moment this would regress other commands.
    this.#assertParentProcessScriptAccess(context);

    const serializationOptionsWithDefaults =
      lazy.setDefaultAndAssertSerializationOptions(serializationOptions);

    const evaluationResult = await this._forwardToWindowGlobal(
      "callFunctionDeclaration",
      context.id,
      {
        awaitPromise,
        commandArguments,
        functionDeclaration,
        realmId,
        resultOwnership,
        sandbox,
        serializationOptions: serializationOptionsWithDefaults,
        thisParameter,
        userActivation,
      }
    );

    return this.#buildReturnValue(evaluationResult);
  }

  /**
   * The script.disown command disowns the given handles. This does not
   * guarantee the handled object will be garbage collected, as there can be
   * other handles or strong ECMAScript references.
   *
   * @param {object=} options
   * @param {Array<string>} options.handles
   *     Array of handle ids to disown.
   * @param {object} options.target
   *     The target owning the handles, which either matches the definition for
   *     a RealmTarget or for ContextTarget.
   */
  async disown(options = {}) {
    const { handles, target = {} } = options;

    lazy.assert.array(
      handles,
      lazy.pprint`Expected "handles" to be an array, got ${handles}`
    );
    handles.forEach(handle => {
      lazy.assert.string(
        handle,
        lazy.pprint`Expected "handles" to be an array of strings, got ${handle}`
      );
    });

    const { contextId, realmId, sandbox } = this.#assertTarget(target);
    const context = await this.#getContextFromTarget({ contextId, realmId });
    await this._forwardToWindowGlobal("disownHandles", context.id, {
      handles,
      realmId,
      sandbox,
    });
  }

  /**
   * Evaluate a provided expression in the provided target, which is either a
   * realm or a browsing context.
   *
   * @param {object=} options
   * @param {boolean} options.awaitPromise
   *     Determines if the command should wait for the return value of the
   *     expression to resolve, if this return value is a Promise.
   * @param {string} options.expression
   *     The expression to evaluate.
   * @param {OwnershipModel=} options.resultOwnership
   *     The ownership model to use for the results of this evaluation. Defaults
   *     to `OwnershipModel.None`.
   * @param {SerializationOptions=} options.serializationOptions
   *     An object which holds the information of how the result of evaluation
   *     in case of ECMAScript objects should be serialized.
   * @param {object} options.target
   *     The target for the evaluation, which either matches the definition for
   *     a RealmTarget or for ContextTarget.
   * @param {boolean=} options.userActivation
   *     Determines whether execution should be treated as initiated by user.
   *     Defaults to `false`.
   *
   * @returns {ScriptEvaluateResult}
   *
   * @throws {InvalidArgumentError}
   *     If any of the arguments does not have the expected type.
   * @throws {NoSuchFrameError}
   *     If the target cannot be found.
   */
  async evaluate(options = {}) {
    const {
      awaitPromise,
      expression: source,
      resultOwnership = lazy.OwnershipModel.None,
      serializationOptions,
      target = {},
      userActivation = false,
    } = options;

    lazy.assert.string(
      source,
      lazy.pprint`Expected "expression" to be a string, got ${source}`
    );

    lazy.assert.boolean(
      awaitPromise,
      lazy.pprint`Expected "awaitPromise" to be a boolean, got ${awaitPromise}`
    );

    lazy.assert.boolean(
      userActivation,
      lazy.pprint`Expected "userActivation" to be a boolean, got ${userActivation}`
    );

    this.#assertResultOwnership(resultOwnership);

    const { contextId, realmId, sandbox } = this.#assertTarget(target);
    const context = await this.#getContextFromTarget({
      contextId,
      realmId,
      supportsChromeScope: true,
    });

    // Bug 2030901: this check should be handled by getContextFromTarget via
    // _getNavigable, but at the moment this would regress other commands.
    this.#assertParentProcessScriptAccess(context);

    const serializationOptionsWithDefaults =
      lazy.setDefaultAndAssertSerializationOptions(serializationOptions);

    const evaluationResult = await this._forwardToWindowGlobal(
      "evaluateExpression",
      context.id,
      {
        awaitPromise,
        expression: source,
        realmId,
        resultOwnership,
        sandbox,
        serializationOptions: serializationOptionsWithDefaults,
        userActivation,
      }
    );

    return this.#buildReturnValue(evaluationResult);
  }

  /**
   * An object that holds basic information about a realm.
   *
   * @typedef BaseRealmInfo
   *
   * @property {string} id
   *     The realm unique identifier.
   * @property {string} origin
   *     The serialization of an origin.
   */

  /**
   *
   * @typedef WindowRealmInfoProperties
   *
   * @property {string} context
   *     The browsing context id, associated with the realm.
   * @property {string=} sandbox
   *     The name of the sandbox. If the value is null or empty
   *     string, the default realm will be returned.
   * @property {RealmType.Window} type
   *     The window realm type.
   */

  /* eslint-disable jsdoc/valid-types */
  /**
   * An object that holds information about a window realm.
   *
   * @typedef {BaseRealmInfo & WindowRealmInfoProperties} WindowRealmInfo
   */
  /* eslint-enable jsdoc/valid-types */

  /**
   * An object that holds information about a realm.
   *
   * @typedef {WindowRealmInfo} RealmInfo
   */

  /**
   * An object that holds a list of realms.
   *
   * @typedef ScriptGetRealmsResult
   *
   * @property {Array<RealmInfo>} realms
   *     List of realms.
   */

  /**
   * Returns a list of all realms, optionally filtered to realms
   * of a specific type, or to the realms associated with
   * a specified browsing context.
   *
   * @param {object=} options
   * @param {string=} options.context
   *     The id of the browsing context to filter
   *     only realms associated with it. If not provided, return realms
   *     associated with all browsing contexts.
   * @param {RealmType=} options.type
   *     Type of realm to filter.
   *     If not provided, return realms of all types.
   *
   * @returns {ScriptGetRealmsResult}
   *
   * @throws {InvalidArgumentError}
   *     If any of the arguments does not have the expected type.
   * @throws {NoSuchFrameError}
   *     If the context cannot be found.
   */
  async getRealms(options = {}) {
    const { context: contextId = null, type = null } = options;
    const destination = {};

    if (contextId !== null) {
      lazy.assert.string(
        contextId,
        lazy.pprint`Expected "context" to be a string, got ${contextId}`
      );
      destination.id = this._getNavigable(contextId).id;
    } else {
      destination.contextDescriptor = {
        type: lazy.ContextDescriptorType.All,
      };
    }

    if (type !== null) {
      const supportedRealmTypes = Object.values(lazy.RealmType);
      if (!supportedRealmTypes.includes(type)) {
        throw new lazy.error.InvalidArgumentError(
          `Expected "type" to be one of ${supportedRealmTypes}, got ${type}`
        );
      }

      const unsupportedRealmTypes = [
        lazy.RealmType.AudioWorklet,
        lazy.RealmType.PaintWorklet,
        lazy.RealmType.Worker,
        lazy.RealmType.Worklet,
      ];
      if (unsupportedRealmTypes.includes(type)) {
        throw new lazy.error.UnsupportedOperationError(
          `Unsupported "type": ${type}`
        );
      }
    }

    const realms = await this.#getRealmInfos(destination);
    return {
      realms: type === null ? realms : realms.filter(r => r.type === type),
    };
  }

  /**
   * Removes a preload script.
   *
   * @param {object=} options
   * @param {string} options.script
   *     The unique id associated with a preload script.
   *
   * @throws {InvalidArgumentError}
   *     If any of the arguments does not have the expected type.
   * @throws {NoSuchScriptError}
   *     If the script cannot be found.
   */
  async removePreloadScript(options = {}) {
    const { script } = options;

    lazy.assert.string(
      script,
      lazy.pprint`Expected "script" to be a string, got ${script}`
    );

    if (!this.#preloadScriptMap.has(script)) {
      throw new lazy.error.NoSuchScriptError(
        `Preload script with id ${script} not found`
      );
    }

    const preloadScript = this.#preloadScriptMap.get(script);
    const sessionDataItem = {
      category: lazy.SessionDataCategory.PreloadScript,
      moduleName: "_configuration",
      values: [
        {
          ...preloadScript,
          script,
        },
      ],
    };

    if (
      preloadScript.contexts === null &&
      preloadScript.userContexts === null
    ) {
      await this.messageHandler.removeSessionDataItem({
        ...sessionDataItem,
        contextDescriptor: {
          type: lazy.ContextDescriptorType.All,
        },
      });
    } else {
      const sessionDataItemToUpdate = [];

      if (preloadScript.contexts === null) {
        for (const id of preloadScript.userContexts) {
          sessionDataItemToUpdate.push({
            ...sessionDataItem,
            contextDescriptor: {
              type: lazy.ContextDescriptorType.UserContext,
              id,
            },
            method: lazy.SessionDataMethod.Remove,
          });
        }
      } else {
        for (const id of preloadScript.contexts) {
          sessionDataItemToUpdate.push({
            ...sessionDataItem,
            contextDescriptor: {
              type: lazy.ContextDescriptorType.TopBrowsingContext,
              id,
            },
            method: lazy.SessionDataMethod.Remove,
          });
        }
      }

      await this.messageHandler.updateSessionData(sessionDataItemToUpdate);
    }

    this.#preloadScriptMap.delete(script);
  }

  #assertChannelArgument(value) {
    lazy.assert.object(
      value,
      lazy.pprint`Expected channel argument to be an object, got ${value}`
    );
    const {
      channel,
      ownership = lazy.OwnershipModel.None,
      serializationOptions,
    } = value;
    lazy.assert.string(
      channel,
      lazy.pprint`Expected channel argument "channel" to be a string, got ${channel}`
    );
    lazy.setDefaultAndAssertSerializationOptions(serializationOptions);
    lazy.assert.that(
      ownershipValue =>
        [lazy.OwnershipModel.None, lazy.OwnershipModel.Root].includes(
          ownershipValue
        ),
      `Expected channel argument "ownership" to be one of ${Object.values(
        lazy.OwnershipModel
      )}, ` + lazy.pprint`got ${ownership}`
    )(ownership);

    return true;
  }

  #assertParentProcessScriptAccess(context) {
    // `supportsChromeScope` only checks browsingContext.isContent, but about
    // pages can have isContent=true but still run in parent process.
    if (!lazy.RemoteAgent.allowSystemAccess && lazy.isParentProcess(context)) {
      throw new lazy.error.UnsupportedOperationError(
        `script.evaluate and script.callFunction are not supported for parent process browsing contexts: ${context.id}`
      );
    }
  }

  #assertResultOwnership(resultOwnership) {
    if (
      ![lazy.OwnershipModel.None, lazy.OwnershipModel.Root].includes(
        resultOwnership
      )
    ) {
      throw new lazy.error.InvalidArgumentError(
        `Expected "resultOwnership" to be one of ${Object.values(
          lazy.OwnershipModel
        )}, ` + lazy.pprint`got ${resultOwnership}`
      );
    }
  }

  #assertTarget(target) {
    lazy.assert.object(
      target,
      lazy.pprint`Expected "target" to be an object, got ${target}`
    );

    const { context: contextId = null, sandbox = null } = target;
    let { realm: realmId = null } = target;

    if (contextId != null) {
      lazy.assert.string(
        contextId,
        lazy.pprint`Expected target "context" to be a string, got ${contextId}`
      );

      if (sandbox != null) {
        lazy.assert.string(
          sandbox,
          lazy.pprint`Expected target "sandbox" to be a string, got ${sandbox}`
        );
      }

      // Ignore realm if context is provided.
      realmId = null;
    } else if (realmId != null) {
      lazy.assert.string(
        realmId,
        lazy.pprint`Expected target "realm" to be a string, got ${realmId}`
      );
    } else {
      throw new lazy.error.InvalidArgumentError(`No context or realm provided`);
    }

    return { contextId, realmId, sandbox };
  }

  #buildReturnValue(evaluationResult) {
    evaluationResult = lazy.processExtraData(
      this.messageHandler.sessionId,
      evaluationResult
    );

    const rv = { realm: evaluationResult.realmId };
    switch (evaluationResult.evaluationStatus) {
      // TODO: Compare with EvaluationStatus.Normal after Bug 1774444 is fixed.
      case "normal":
        rv.type = ScriptEvaluateResultType.Success;
        rv.result = evaluationResult.result;
        break;
      // TODO: Compare with EvaluationStatus.Throw after Bug 1774444 is fixed.
      case "throw":
        rv.type = ScriptEvaluateResultType.Exception;
        rv.exceptionDetails = evaluationResult.exceptionDetails;
        break;
      default:
        throw new lazy.error.UnsupportedOperationError(
          `Unsupported evaluation status ${evaluationResult.evaluationStatus}`
        );
    }
    return rv;
  }

  #getBrowsingContextIdByInnerWindowId(innerWindowId) {
    const windowGlobalParent =
      WindowGlobalParent.getByInnerWindowId(innerWindowId);
    return windowGlobalParent?.browsingContext.id;
  }

  async #getContextFromTarget({
    contextId,
    realmId,
    supportsChromeScope = false,
  }) {
    if (contextId !== null) {
      return this._getNavigable(contextId, { supportsChromeScope });
    }

    const destination = {
      contextDescriptor: {
        type: lazy.ContextDescriptorType.All,
      },
    };
    const realmInfos = await this.#getWindowRealmInfos(destination);
    const realm = realmInfos.find(info => info.realm == realmId);

    if (realm && realm.context !== null) {
      return this._getNavigable(realm.context, { supportsChromeScope });
    }

    throw new lazy.error.NoSuchFrameError(`Realm with id ${realmId} not found`);
  }

  async #getRealmInfos(destination) {
    const windowRealms = await this.#getWindowRealmInfos(destination);
    const workerRealms = this.#getWorkerRealmInfos(destination);
    return [...windowRealms, ...workerRealms];
  }

  async #getWindowRealmInfos(destination) {
    let realms = await this.messageHandler.forwardCommand({
      moduleName: "script",
      commandName: "getWindowRealms",
      destination: {
        type: lazy.WindowGlobalMessageHandler.type,
        ...destination,
      },
      retryOnAbort: true,
    });

    const isBroadcast = !!destination.contextDescriptor;
    if (!isBroadcast) {
      realms = [realms];
    }

    return realms
      .flat()
      .map(realm => {
        // Resolve browsing context to a TabManager id.
        realm.context = lazy.NavigableManager.getIdForBrowsingContext(
          realm.context
        );
        return realm;
      })
      .filter(realm => realm.context !== null);
  }

  #getWorkerRealmInfo(workerData) {
    const { id, type, url } = workerData;

    const realmInfo = {
      origin: url,
      realm: id,
    };

    switch (type) {
      case Ci.nsIWorkerDebugger.TYPE_DEDICATED: {
        const owners = this.#getWorkerOwners(workerData);
        realmInfo.owners = owners;
        realmInfo.type = lazy.RealmType.DedicatedWorker;
        break;
      }
      case Ci.nsIWorkerDebugger.TYPE_SHARED: {
        realmInfo.type = lazy.RealmType.SharedWorker;
        break;
      }
      case Ci.nsIWorkerDebugger.TYPE_SERVICE: {
        realmInfo.type = lazy.RealmType.ServiceWorker;
        break;
      }
      default:
        throw new Error(`Unexpected worker type ${type}`);
    }

    return realmInfo;
  }

  #getWorkerRealmInfos(destination) {
    const workers = lazy.workerListenerRegistry.getWorkers();
    const realmInfos = [];

    for (const workerData of workers) {
      if (workerData.isChrome) {
        // Bug 2016576: Support workers for chrome scope.
        continue;
      }

      if (destination.id !== undefined) {
        const workerBrowsingContextIds =
          this.#getWorkerBrowsingContexts(workerData);
        if (!workerBrowsingContextIds.includes(destination.id)) {
          continue;
        }
      }

      realmInfos.push(this.#getWorkerRealmInfo(workerData));
    }

    return realmInfos;
  }

  /**
   * Retrieve all browsing contexts related to a given worker.
   *
   * @param {object} workerData
   *     Worker event payload from the WorkerListenerRegistry
   *
   * @returns {Array<BrowsingContext>}
   *     Array of browsing contexts related to the worker.
   */
  #getWorkerBrowsingContexts(workerData) {
    // Bug 2014206: For shared workers, windowIDs currently crash and the event
    // contains an empty array.
    // Bug 2016096: For service workers, windowIDs is currently always empty.
    return workerData.windowIDs
      .map(innerWindowId =>
        this.#getBrowsingContextIdByInnerWindowId(innerWindowId)
      )
      .filter(Boolean);
  }

  /**
   * Implements https://w3c.github.io/webdriver-bidi/#get-the-workers-owners
   * This implementation diverges from the spec since the worker global is not
   * accessible in the parent process.
   *
   * @param {object} workerData
   *     Worker event payload from the WorkerListenerRegistry
   *
   * @returns {Array<string>}
   *     Array of realm ids.
   */
  #getWorkerOwners(workerData) {
    const owners = [];
    for (const innerWindowId of workerData.windowIDs) {
      const windowRealms = this.messageHandler.realms.get(innerWindowId);
      if (windowRealms) {
        const defaultRealm = [...windowRealms.values()].find(
          realm => !realm.sandbox
        );
        if (defaultRealm) {
          owners.push(defaultRealm.realm);
        }
      }
    }
    return owners;
  }

  #hasEventSubscriptionToContextCreated(browsingContext) {
    const sessionData =
      this.messageHandler.sessionData.getSessionDataForContext(
        "browsingContext",
        "event",
        browsingContext
      );

    return sessionData.some(
      item => item.value === "browsingContext.contextCreated"
    );
  }

  #onContextAttached = async (eventName, data) => {
    const { browsingContext } = data;
    // If there is a subscription for "browsingContext.contextCreated" event,
    // do not send "script.realmCreated" event yet and
    // wait until the "browsingContext.contextCreated" event is submitted
    if (
      this.#realmInfoMap.has(browsingContext) &&
      !this.#hasEventSubscriptionToContextCreated(browsingContext)
    ) {
      // If `waitForTopBrowsingContextToBeReady` returns `null`,
      // it means that the browsing context was discarded.
      // Do not send an event in this case.
      if (
        !browsingContext.parent &&
        (await lazy.waitForTopBrowsingContextToBeReady(browsingContext)) ===
          null
      ) {
        return;
      }

      this.#sendDelayedRealmCreatedEvent(browsingContext);
    }
  };

  #onContextDiscarded = (eventName, data) => {
    const { browsingContext, why } = data;

    // Filter out top-level browsing contexts that are destroyed because of a
    // cross-group navigation.
    if (why !== "replace") {
      const contextId =
        lazy.NavigableManager.getIdForBrowsingContext(browsingContext);
      this.#submittedContextsCreated.delete(contextId);
    }
  };

  #onContextCreatedSubmitted = (eventName, { browsingContext }) => {
    const contextId =
      lazy.NavigableManager.getIdForBrowsingContext(browsingContext);
    this.#submittedContextsCreated.add(contextId);

    if (this.#realmInfoMap.has(browsingContext)) {
      this.#sendDelayedRealmCreatedEvent(browsingContext);
    }
  };

  #onRealmCreated = (eventName, { realmInfo }) => {
    const browsingContext = realmInfo.context;

    // Resolve browsing context to a TabManager id.
    const contextId =
      lazy.NavigableManager.getIdForBrowsingContext(browsingContext);

    // Do not emit the event, if the browsing context is gone, not created, not ready yet,
    // or if the browsing context with the subscription for
    // "browsingContext.contextCreated" event is not received yet.
    if (
      contextId === null ||
      (!browsingContext.currentWindowGlobal && !browsingContext.parent) ||
      (this.#hasEventSubscriptionToContextCreated(browsingContext) &&
        !this.#submittedContextsCreated.has(contextId))
    ) {
      // Save the realm info to send it when the browsing context is ready.
      this.#realmInfoMap.set(browsingContext, realmInfo);
      return;
    }

    this.#sendRealmCreatedEvent(realmInfo, browsingContext, contextId);
  };

  #onRealmDestroyed = (eventName, { realm, context }) => {
    this._emitEventForBrowsingContext(context.id, "script.realmDestroyed", {
      realm,
    });
  };

  #onWorkerRegistered = (eventName, workerData) => {
    if (workerData.isChrome) {
      // Bug 2016576: Support workers for chrome scope.
      return;
    }

    this._emitEventForBrowsingContexts(
      this.#getWorkerBrowsingContexts(workerData),
      "script.realmCreated",
      this.#getWorkerRealmInfo(workerData)
    );
  };

  #onWorkerUnregistered = (eventName, workerData) => {
    const { id, isChrome } = workerData;

    if (isChrome) {
      // Bug 2016576: Support workers for chrome scope.
      return;
    }

    const realmInfo = {
      realm: id,
    };

    this._emitEventForBrowsingContexts(
      this.#getWorkerBrowsingContexts(workerData),
      "script.realmDestroyed",
      realmInfo
    );
  };

  #sendDelayedRealmCreatedEvent(browsingContext) {
    if (this.#realmInfoMap?.has(browsingContext)) {
      const realmInfo = this.#realmInfoMap.get(browsingContext);
      // Resolve browsing context to a TabManager id.
      const browsingContextId = lazy.NavigableManager.getIdForBrowsingContext(
        realmInfo.context
      );
      this.#sendRealmCreatedEvent(
        realmInfo,
        browsingContext,
        browsingContextId
      );
      this.#realmInfoMap.delete(browsingContext);
    }
  }

  #sendRealmCreatedEvent(realmInfo, context, browsingContextId) {
    realmInfo.context = browsingContextId;

    this._emitEventForBrowsingContext(
      context.id,
      "script.realmCreated",
      realmInfo
    );
  }

  #startListeningOnRealmCreated() {
    if (!this.#subscribedEvents.has("script.realmCreated")) {
      this.messageHandler.on("realm-created", this.#onRealmCreated);
      this.messageHandler.on(
        "browsingContext._contextCreatedEmitted",
        this.#onContextCreatedSubmitted
      );
      this.#contextListener.startListening();
      lazy.workerListenerRegistry.on(
        "worker-registered",
        this.#onWorkerRegistered
      );
    }
  }

  #stopListeningOnRealmCreated() {
    if (this.#subscribedEvents.has("script.realmCreated")) {
      this.messageHandler.off("realm-created", this.#onRealmCreated);
      this.messageHandler.off(
        "browsingContext._contextCreatedEmitted",
        this.#onContextCreatedSubmitted
      );
      this.#contextListener.stopListening();
      lazy.workerListenerRegistry.off(
        "worker-registered",
        this.#onWorkerRegistered
      );
    }
  }

  #startListeningOnRealmDestroyed() {
    if (!this.#subscribedEvents.has("script.realmDestroyed")) {
      this.messageHandler.on("realm-destroyed", this.#onRealmDestroyed);
      lazy.workerListenerRegistry.on(
        "worker-unregistered",
        this.#onWorkerUnregistered
      );
    }
  }

  #stopListeningOnRealmDestroyed() {
    if (this.#subscribedEvents.has("script.realmDestroyed")) {
      this.messageHandler.off("realm-destroyed", this.#onRealmDestroyed);
      lazy.workerListenerRegistry.off(
        "worker-unregistered",
        this.#onWorkerUnregistered
      );
    }
  }

  #subscribeEvent(event) {
    switch (event) {
      case "script.realmCreated": {
        this.#startListeningOnRealmCreated();
        this.#subscribedEvents.add(event);
        break;
      }
      case "script.realmDestroyed": {
        this.#startListeningOnRealmDestroyed();
        this.#subscribedEvents.add(event);
        break;
      }
    }
  }

  #unsubscribeEvent(event) {
    switch (event) {
      case "script.realmCreated": {
        this.#stopListeningOnRealmCreated();
        this.#subscribedEvents.delete(event);
        break;
      }
      case "script.realmDestroyed": {
        this.#stopListeningOnRealmDestroyed();
        this.#subscribedEvents.delete(event);
        break;
      }
    }
  }

  _applySessionData(params) {
    // TODO: Bug 1775231. Move this logic to a shared module or an abstract
    // class.
    const { category } = params;
    if (category === "event") {
      const filteredSessionData = params.sessionData.filter(item =>
        this.messageHandler.matchesContext(item.contextDescriptor)
      );
      for (const event of this.#subscribedEvents.values()) {
        const hasSessionItem = filteredSessionData.some(
          item => item.value === event
        );
        // If there are no session items for this context, we should unsubscribe from the event.
        if (!hasSessionItem) {
          this.#unsubscribeEvent(event);
        }
      }

      // Subscribe to all events, which have an item in SessionData.
      for (const { value } of filteredSessionData) {
        this.#subscribeEvent(value);
      }
    }
  }

  static get supportedEvents() {
    return ["script.message", "script.realmCreated", "script.realmDestroyed"];
  }
}

export const script = ScriptModule;