Skip to content

Move cdp code to webdriver.js #9131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 4, 2021
Merged

Move cdp code to webdriver.js #9131

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5978a1c
Move cdp code to webdriver.js
raju249 Feb 2, 2021
03ec839
Fix and run tests for devtools
raju249 Feb 3, 2021
12b0de9
Merge branch 'trunk' into refactor-js-cdp
harsha509 Feb 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 0 additions & 256 deletions javascript/node/selenium-webdriver/chromium.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,7 @@ const command = require('./lib/command')
const error = require('./lib/error')
const Symbols = require('./lib/symbols')
const webdriver = require('./lib/webdriver')
const WebSocket = require('ws')
const cdp = require('./devtools/CDPConnection')
const remote = require('./remote')
const cdpTargets = ['page', 'browser']
const fs = require('fs')

/**
* Custom command names supported by Chromium WebDriver.
Expand Down Expand Up @@ -709,151 +705,6 @@ class Driver extends webdriver.WebDriver {
)
}

/**
* Creates a new WebSocket connection.
* @return {!Promise<resolved>} A new CDP instance.
*/
async createCDPConnection(target) {
const caps = await this.getCapabilities()
const seOptions = caps['map_'].get('se:options') || new Map()
const vendorInfo =
caps['map_'].get(this.VENDOR_COMMAND_PREFIX + ':chromeOptions') ||
new Map()
const debuggerUrl = seOptions['cdp'] || vendorInfo['debuggerAddress']
this._wsUrl = await this.getWsUrl(debuggerUrl, target)

return new Promise((resolve, reject) => {
try {
this._wsConnection = new WebSocket(this._wsUrl)
} catch (err) {
reject(err)
return
}

this._wsConnection.on('open', () => {
this._cdpConnection = new cdp.CdpConnection(this._wsConnection)
resolve(this._cdpConnection)
})

this._wsConnection.on('error', (error) => {
reject(error)
})
})
}

/**
* Retrieves 'webSocketDebuggerUrl' by sending a http request using debugger address
* @param {string} debuggerAddress
* @param {string} target
* @return {string} Returns parsed webSocketDebuggerUrl obtained from the http request
*/
async getWsUrl(debuggerAddress, target) {
if (target && cdpTargets.indexOf(target.toLowerCase()) === -1) {
throw new error.InvalidArgumentError('invalid target value')
}
let path = '/json/version'

if (target === 'page') {
path = '/json'
}
let request = new http.Request('GET', path)
let client = new http.HttpClient('http://' + debuggerAddress)
let response = await client.send(request)
let url = JSON.parse(response.body)['webSocketDebuggerUrl']
if (target.toLowerCase() === 'page') {
url = JSON.parse(response.body)[0]['webSocketDebuggerUrl']
}

return url
}

/**
* Sets a listener for Fetch.authRequired event from CDP
* If event is triggered, it enter username and password
* and allows the test to move forward
* @param {string} username
* @param {string} password
* @param connection CDP Connection
*/
async register(username, password, connection) {
await connection.execute(
'Network.setCacheDisabled',
this.getRandomNumber(1, 10),
{
cacheDisabled: true,
},
null
)

this._wsConnection.on('message', (message) => {
const params = JSON.parse(message)

if (params.method === 'Fetch.authRequired') {
const requestParams = params['params']
connection.execute(
'Fetch.continueWithAuth',
this.getRandomNumber(1, 10),
{
requestId: requestParams['requestId'],
authChallengeResponse: {
response: 'ProvideCredentials',
username: username,
password: password,
},
}
)
} else if (params.method === 'Fetch.requestPaused') {
const requestPausedParams = params['params']
connection.execute(
'Fetch.continueRequest',
this.getRandomNumber(1, 10),
{
requestId: requestPausedParams['requestId'],
}
)
}
})

await connection.execute(
'Fetch.enable',
1,
{
handleAuthRequests: true,
},
null
)
}

/**
*
* @param connection
* @param callback
* @returns {Promise<void>}
*/
async onLogEvent(connection, callback) {
await connection.execute(
'Runtime.enable',
this.getRandomNumber(1, 10),
{},
null
)

this._wsConnection.on('message', (message) => {
const params = JSON.parse(message)

if (params.method === 'Runtime.consoleAPICalled') {
const consoleEventParams = params['params']
let event = {
type: consoleEventParams['type'],
timestamp: new Date(consoleEventParams['timestamp']),
args: consoleEventParams['args'],
}

callback(event)
}
})
}

/**
* Set a permission state to the given value.
*
Expand All @@ -872,113 +723,6 @@ class Driver extends webdriver.WebDriver {
)
}

/**
*
* @param connection
* @param callback
* @returns {Promise<void>}
*/
async onLogException(connection, callback) {
await connection.execute(
'Runtime.enable',
this.getRandomNumber(1, 10),
{},
null
)

this._wsConnection.on('message', (message) => {
const params = JSON.parse(message)

if (params.method === 'Runtime.exceptionThrown') {
const exceptionEventParams = params['params']
let event = {
exceptionDetails: exceptionEventParams['exceptionDetails'],
timestamp: new Date(exceptionEventParams['timestamp']),
}

callback(event)
}
})
}

/**
* @param connection
* @param callback
* @returns {Promise<void>}
*/
async logMutationEvents(connection, callback) {
await connection.execute(
'Runtime.enable',
this.getRandomNumber(1, 10),
{},
null
)
await connection.execute(
'Page.enable',
this.getRandomNumber(1, 10),
{},
null
)

await connection.execute(
'Runtime.addBinding',
this.getRandomNumber(1, 10),
{
name: '__webdriver_attribute',
},
null
)

let mutationListener = ''
try {
// Depending on what is running the code it could appear in 2 different places which is why we try
// here and then the other location
mutationListener = fs
.readFileSync(
'./javascript/node/selenium-webdriver/lib/atoms/mutation-listener.js',
'utf-8'
)
.toString()
} catch {
mutationListener = fs
.readFileSync('./lib/atoms/mutation-listener.js', 'utf-8')
.toString()
}

this.executeScript(mutationListener)

await connection.execute(
'Page.addScriptToEvaluateOnNewDocument',
this.getRandomNumber(1, 10),
{
source: mutationListener,
},
null
)

this._wsConnection.on('message', async (message) => {
const params = JSON.parse(message)
if (params.method === 'Runtime.bindingCalled') {
let payload = JSON.parse(params['params']['payload'])
let elements = await this.findElements({
css: '*[data-__webdriver_id=' + payload['target'],
})

if (elements.length === 0) {
return
}

let event = {
element: elements[0],
attribute_name: payload['name'],
current_value: payload['value'],
old_value: payload['oldValue'],
}
callback(event)
}
})
}

/**
* Sends a DevTools command to change the browser's download directory.
*
Expand Down
Loading