2024-03-13 10:07:55 +05:30
|
|
|
// Licensed to the Software Freedom Conservancy (SFC) under one
|
|
|
|
|
// or more contributor license agreements. See the NOTICE file
|
|
|
|
|
// distributed with this work for additional information
|
|
|
|
|
// regarding copyright ownership. The SFC licenses this file
|
|
|
|
|
// to you under the Apache License, Version 2.0 (the
|
|
|
|
|
// "License"); you may not use this file except in compliance
|
|
|
|
|
// with the License. You may obtain a copy of the License at
|
|
|
|
|
//
|
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
//
|
|
|
|
|
// Unless required by applicable law or agreed to in writing,
|
|
|
|
|
// software distributed under the License is distributed on an
|
|
|
|
|
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
|
|
|
// KIND, either express or implied. See the License for the
|
|
|
|
|
// specific language governing permissions and limitations
|
|
|
|
|
// under the License.
|
|
|
|
|
|
2025-02-17 22:24:27 +05:30
|
|
|
const { WindowState, ClientWindowInfo } = require('./clientWindowInfo')
|
|
|
|
|
|
2024-04-03 10:05:52 +05:30
|
|
|
/**
|
|
|
|
|
* Represents the commands and events under Browser Module.
|
|
|
|
|
* Described in https://w3c.github.io/webdriver-bidi/#module-browser
|
|
|
|
|
*/
|
2024-03-13 10:07:55 +05:30
|
|
|
class Browser {
|
|
|
|
|
constructor(driver) {
|
|
|
|
|
this._driver = driver
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async init() {
|
|
|
|
|
if (!(await this._driver.getCapabilities()).get('webSocketUrl')) {
|
|
|
|
|
throw Error('WebDriver instance must support BiDi protocol')
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
this.bidi = await this._driver.getBidi()
|
|
|
|
|
}
|
|
|
|
|
|
2024-04-03 10:05:52 +05:30
|
|
|
/**
|
|
|
|
|
* Creates a new user context.
|
|
|
|
|
* @returns {Promise<string>} A promise that resolves to the user context id.
|
|
|
|
|
*/
|
2024-03-13 10:07:55 +05:30
|
|
|
async createUserContext() {
|
|
|
|
|
const command = {
|
|
|
|
|
method: 'browser.createUserContext',
|
|
|
|
|
params: {},
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let response = await this.bidi.send(command)
|
|
|
|
|
|
|
|
|
|
return response.result.userContext
|
|
|
|
|
}
|
|
|
|
|
|
2024-04-03 10:05:52 +05:30
|
|
|
/**
|
|
|
|
|
* Gets the list of all user contexts.
|
|
|
|
|
* @returns {Promise<string[]>} A promise that resolves to an array of user context ids.
|
|
|
|
|
*/
|
2024-03-13 10:07:55 +05:30
|
|
|
async getUserContexts() {
|
|
|
|
|
const command = {
|
|
|
|
|
method: 'browser.getUserContexts',
|
|
|
|
|
params: {},
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let response = await this.bidi.send(command)
|
|
|
|
|
|
|
|
|
|
let userContexts = []
|
|
|
|
|
|
|
|
|
|
let userContextsArray = response.result.userContexts
|
|
|
|
|
|
|
|
|
|
for (let userContextJson of userContextsArray) {
|
|
|
|
|
userContexts.push(userContextJson.userContext)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return userContexts
|
|
|
|
|
}
|
|
|
|
|
|
2024-04-03 10:05:52 +05:30
|
|
|
/**
|
|
|
|
|
* Removes a user context.
|
|
|
|
|
* @param {string} userContext The user context id to be removed.
|
|
|
|
|
* @returns {Promise<void>}
|
|
|
|
|
*/
|
2024-03-13 10:07:55 +05:30
|
|
|
async removeUserContext(userContext) {
|
|
|
|
|
const command = {
|
|
|
|
|
method: 'browser.removeUserContext',
|
|
|
|
|
params: { userContext: userContext },
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
await this.bidi.send(command)
|
|
|
|
|
}
|
2025-02-17 22:24:27 +05:30
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Gets information about all client windows.
|
|
|
|
|
* @returns {Promise<ClientWindowInfo[]>} Array of client window information
|
|
|
|
|
*/
|
|
|
|
|
async getClientWindows() {
|
|
|
|
|
const command = {
|
|
|
|
|
method: 'browser.getClientWindows',
|
|
|
|
|
params: {},
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const response = await this.bidi.send(command)
|
|
|
|
|
return response.result.clientWindows.map((window) => ClientWindowInfo.fromJson(window))
|
|
|
|
|
}
|
2024-03-13 10:07:55 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async function getBrowserInstance(driver) {
|
|
|
|
|
let instance = new Browser(driver)
|
|
|
|
|
await instance.init()
|
|
|
|
|
return instance
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
module.exports = getBrowserInstance
|
2025-02-17 22:24:27 +05:30
|
|
|
module.exports.WindowState = WindowState
|
