Source code
Revision control
Copy as Markdown
Other Tools
/* 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
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",
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",
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",
SessionDataMethod:
"chrome://remote/content/shared/messagehandler/sessiondata/SessionData.sys.mjs",
setDefaultAndAssertSerializationOptions:
"chrome://remote/content/webdriver-bidi/RemoteValue.sys.mjs",
TabManager: "chrome://remote/content/shared/TabManager.sys.mjs",
WindowGlobalMessageHandler:
"chrome://remote/content/shared/messagehandler/WindowGlobalMessageHandler.sys.mjs",
});
/**
* @typedef {string} ScriptEvaluateResultType
*/
/**
* Enum of possible evaluation result types.
*
* @readonly
* @enum {ScriptEvaluateResultType}
*/
const ScriptEvaluateResultType = {
Exception: "exception",
Success: "success",
};
class ScriptModule extends RootBiDiModule {
#preloadScriptMap;
#subscribedEvents;
constructor(messageHandler) {
super(messageHandler);
// Map in which the keys are UUIDs, and the values are structs
// with an item named expression, which is a string,
// and an item named sandbox which is a string or null.
this.#preloadScriptMap = new Map();
// Set of event names which have active subscriptions.
this.#subscribedEvents = new Set();
}
destroy() {
this.#preloadScriptMap = 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.
*
* @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,
} = options;
let contexts = null;
if (contextIds != null) {
lazy.assert.array(
contextIds,
lazy.pprint`Expected "contexts" to be an array, got ${contextIds}`
);
lazy.assert.that(
contexts => !!contexts.length,
lazy.pprint`Expected "contexts" array to have at least one item, got ${contextIds}`
)(contextIds);
contexts = new Set();
for (const contextId of contextIds) {
lazy.assert.string(
contextId,
lazy.pprint`Expected elements of "contexts" to be a string, got ${contextId}`
);
const context = this.#getBrowsingContext(contextId);
if (context.parent) {
throw new lazy.error.InvalidArgumentError(
`Context with id ${contextId} is not a top-level browsing context`
);
}
contexts.add(context.browserId);
}
}
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);
});
const script = lazy.generateUUID();
const preloadScript = {
arguments: commandArguments,
contexts,
functionDeclaration,
sandbox,
};
this.#preloadScriptMap.set(script, preloadScript);
const preloadScriptDataItem = {
category: "preload-script",
moduleName: "script",
values: [
{
...preloadScript,
script,
},
],
};
if (contexts === null) {
await this.messageHandler.addSessionDataItem({
...preloadScriptDataItem,
contextDescriptor: {
type: lazy.ContextDescriptorType.All,
},
});
} else {
const preloadScriptDataItems = [];
for (const id of contexts) {
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 });
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 });
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.#getBrowsingContext(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}`
);
}
// Remove this check when other realm types are supported
if (type !== lazy.RealmType.Window) {
throw new lazy.error.UnsupportedOperationError(
`Unsupported "type": ${type}. Only "type" ${lazy.RealmType.Window} is currently supported.`
);
}
}
return { realms: await this.#getRealmInfos(destination) };
}
/**
* 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: "preload-script",
moduleName: "script",
values: [
{
...preloadScript,
script,
},
],
};
if (preloadScript.contexts === null) {
await this.messageHandler.removeSessionDataItem({
...sessionDataItem,
contextDescriptor: {
type: lazy.ContextDescriptorType.All,
},
});
} else {
const sessionDataItemToUpdate = [];
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(
ownership =>
[lazy.OwnershipModel.None, lazy.OwnershipModel.Root].includes(
ownership
),
`Expected channel argument "ownership" to be one of ${Object.values(
lazy.OwnershipModel
)}, ` + lazy.pprint`got ${ownership}`
)(ownership);
return true;
}
#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) {
case "normal":
rv.type = ScriptEvaluateResultType.Success;
rv.result = evaluationResult.result;
break;
case "throw":
rv.type = ScriptEvaluateResultType.Exception;
rv.exceptionDetails = evaluationResult.exceptionDetails;
break;
default:
throw new lazy.error.UnsupportedOperationError(
`Unsupported evaluation status ${evaluationResult.evaluationStatus}`
);
}
return rv;
}
#getBrowsingContext(contextId) {
const context = lazy.TabManager.getBrowsingContextById(contextId);
if (context === null) {
throw new lazy.error.NoSuchFrameError(
`Browsing Context with id ${contextId} not found`
);
}
if (!context.currentWindowGlobal) {
throw new lazy.error.NoSuchFrameError(
`No window found for BrowsingContext with id ${contextId}`
);
}
return context;
}
async #getContextFromTarget({ contextId, realmId }) {
if (contextId !== null) {
return this.#getBrowsingContext(contextId);
}
const destination = {
contextDescriptor: {
type: lazy.ContextDescriptorType.All,
},
};
const realms = await this.#getRealmInfos(destination);
const realm = realms.find(realm => realm.realm == realmId);
if (realm && realm.context !== null) {
return this.#getBrowsingContext(realm.context);
}
throw new lazy.error.NoSuchFrameError(`Realm with id ${realmId} not found`);
}
async #getRealmInfos(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.TabManager.getIdForBrowsingContext(realm.context);
return realm;
})
.filter(realm => realm.context !== null);
}
#onRealmCreated = (eventName, { realmInfo }) => {
// Resolve browsing context to a TabManager id.
const context = lazy.TabManager.getIdForBrowsingContext(realmInfo.context);
const browsingContextId = realmInfo.context.id;
// Do not emit the event, if the browsing context is gone.
if (context === null) {
return;
}
realmInfo.context = context;
this._emitEventForBrowsingContext(
browsingContextId,
"script.realmCreated",
realmInfo
);
};
#onRealmDestroyed = (eventName, { realm, context }) => {
this._emitEventForBrowsingContext(context.id, "script.realmDestroyed", {
realm,
});
};
#startListingOnRealmCreated() {
if (!this.#subscribedEvents.has("script.realmCreated")) {
this.messageHandler.on("realm-created", this.#onRealmCreated);
}
}
#stopListingOnRealmCreated() {
if (this.#subscribedEvents.has("script.realmCreated")) {
this.messageHandler.off("realm-created", this.#onRealmCreated);
}
}
#startListingOnRealmDestroyed() {
if (!this.#subscribedEvents.has("script.realmDestroyed")) {
this.messageHandler.on("realm-destroyed", this.#onRealmDestroyed);
}
}
#stopListingOnRealmDestroyed() {
if (this.#subscribedEvents.has("script.realmDestroyed")) {
this.messageHandler.off("realm-destroyed", this.#onRealmDestroyed);
}
}
#subscribeEvent(event) {
switch (event) {
case "script.realmCreated": {
this.#startListingOnRealmCreated();
this.#subscribedEvents.add(event);
break;
}
case "script.realmDestroyed": {
this.#startListingOnRealmDestroyed();
this.#subscribedEvents.add(event);
break;
}
}
}
#unsubscribeEvent(event) {
switch (event) {
case "script.realmCreated": {
this.#stopListingOnRealmCreated();
this.#subscribedEvents.delete(event);
break;
}
case "script.realmDestroyed": {
this.#stopListingOnRealmDestroyed();
this.#subscribedEvents.delete(event);
break;
}
}
}
_applySessionData(params) {
// 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;