Skip to content

chore: port websocket in ext to bidi #31209

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 2 commits into from
Apr 18, 2025
Merged

chore: port websocket in ext to bidi #31209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f76f89d
chore: cut over web extension methods to use webdriver BiDi to automa…
AtofStryker Oct 23, 2024
45259dd
Merge branch 'release/15.0.0' into chore/port_websocket_in_ext_to_bidi
AtofStryker Apr 15, 2025
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
229 changes: 0 additions & 229 deletions packages/extension/app/v2/background.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,9 @@
const get = require('lodash/get')
const map = require('lodash/map')
const pick = require('lodash/pick')
const once = require('lodash/once')
const Promise = require('bluebird')
const browser = require('webextension-polyfill')
const { cookieMatches } = require('@packages/server/lib/automation/util')

const client = require('./client')
const util = require('../../lib/util')

const COOKIE_PROPS = ['url', 'name', 'path', 'secure', 'domain']
const GET_ALL_PROPS = COOKIE_PROPS.concat(['session', 'storeId'])
// https://developer.chrome.com/extensions/cookies#method-set
const SET_PROPS = COOKIE_PROPS.concat(['value', 'httpOnly', 'expirationDate', 'sameSite'])

const httpRe = /^http/

// normalize into null when empty array
const firstOrNull = (cookies) => {
return cookies[0] != null ? cookies[0] : null
}

const checkIfFirefox = async () => {
if (!browser || !get(browser, 'runtime.getBrowserInfo')) {
Expand Down Expand Up @@ -91,29 +75,8 @@ const connect = function (host, path, extraOpts) {

ws.on('automation:request', (id, msg, data) => {
switch (msg) {
case 'get:cookies':
return invoke('getCookies', id, data)
case 'get:cookie':
return invoke('getCookie', id, data)
case 'set:cookie':
return invoke('setCookie', id, data)
case 'set:cookies':
case 'add:cookies':
return invoke('setCookies', id, data)
case 'clear:cookies':
return invoke('clearCookies', id, data)
case 'clear:cookie':
return invoke('clearCookie', id, data)
case 'is:automation:client:connected':
return invoke('verify', id, data)
case 'focus:browser:window':
return invoke('focus', id)
case 'take:screenshot':
return invoke('takeScreenshot', id)
case 'reset:browser:state':
return invoke('resetBrowserState', id)
case 'reset:browser:tabs:for:next:spec':
return invoke('resetBrowserTabsForNextSpec', id)
default:
return fail(id, { message: `No handler registered for: '${msg}'` })
}
Expand All @@ -136,207 +99,15 @@ const connect = function (host, path, extraOpts) {
return ws
}

const setOneCookie = (props) => {
// only get the url if its not already set
if (props.url == null) {
props.url = util.getCookieUrl(props)
}

if (props.hostOnly) {
// If the hostOnly prop is available, delete the domain.
// This will wind up setting a hostOnly cookie based on the calculated cookieURL above.
delete props.domain
}

if (props.domain === 'localhost') {
delete props.domain
}

props = pick(props, SET_PROPS)

return Promise.try(() => {
return browser.cookies.set(props)
})
}

const clearOneCookie = (cookie = {}) => {
const url = util.getCookieUrl(cookie)
const props = { url, name: cookie.name }

const throwError = function (err) {
throw (err != null ? err : new Error(`Removing cookie failed for: ${JSON.stringify(props)}`))
}

return Promise.try(() => {
if (!cookie.name) {
throw new Error(`Removing cookie failed for: ${JSON.stringify(cookie)}. Cookie did not include a name`)
}

return browser.cookies.remove(props)
}).then((details) => {
return cookie
}).catch(throwError)
}

const clearAllCookies = (cookies) => {
return Promise.mapSeries(cookies, clearOneCookie)
}

const automation = {
connect,

getAll (filter = {}) {
filter = pick(filter, GET_ALL_PROPS)

// Firefox's filtering doesn't match the behavior we want, so we do it
// ourselves. for example, getting { domain: example.com } cookies will
// return cookies for example.com and all subdomains, whereas we want an
// exact match for only "example.com".
return Promise.try(() => {
return browser.cookies.getAll({ url: filter.url })
.then((cookies) => {
return cookies.filter((cookie) => {
return cookieMatches(cookie, filter)
})
})
})
},

getCookies (filter, fn) {
return this.getAll(filter)
.then(fn)
},

getCookie (filter, fn) {
return this.getAll(filter)
.then(firstOrNull)
.then(fn)
},

setCookie (props = {}, fn) {
return setOneCookie(props)
.then(fn)
},

setCookies (propsArr = [], fn) {
return Promise.mapSeries(propsArr, setOneCookie)
.then(fn)
},

clearCookie (filter, fn) {
return this.getCookie(filter)
.then((cookie) => {
if (!cookie) return null

return clearOneCookie(cookie)
})
.then(fn)
},

clearCookies (cookies, fn) {
return clearAllCookies(cookies)
.then(fn)
},

focus (fn) {
// lets just make this simple and whatever is the current
// window bring that into focus
//
// TODO: if we REALLY want to be nice its possible we can
// figure out the exact window that's running Cypress but
// that's too much work with too little value at the moment
return Promise.try(() => {
return browser.windows.getCurrent()
}).then((window) => {
return browser.windows.update(window.id, { focused: true })
}).then(fn)
},

resetBrowserState (fn) {
// We remove browser data. Firefox goes through this path, while chrome goes through cdp automation
// Note that firefox does not support fileSystems or serverBoundCertificates
// (https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browsingData/DataTypeSet).
return browser.browsingData.remove({}, { cache: true, cookies: true, downloads: true, formData: true, history: true, indexedDB: true, localStorage: true, passwords: true, pluginData: true, serviceWorkers: true }).then(fn)
},

resetBrowserTabsForNextSpec (callback) {
return Promise.try(() => {
return browser.windows.getCurrent({ populate: true })
}).then(async (currentWindowInfo) => {
const windows = await browser.windows.getAll().catch(() => [])

for (const window of windows) {
// remove/close the window if it's not the current window
if (window.id !== currentWindowInfo.id) {
// tslint:disable-next-line:no-empty
await browser.windows.remove(window.id).catch(() => {})
}
}

return currentWindowInfo
}).then(async (currentWindowInfo) => {
let newTabId = null

try {
// in versions of Firefox 124 and up, firefox no longer creates a new tab for us when we close all tabs in the browser.
// to keep change minimal and backwards compatible, we are creating an 'about:blank' tab here to keep the behavior consistent.
// this works in previous versions as well since one tab is left, hence one will not be created for us in Firefox 123 and below
const newAboutBlankTab = await browser.tabs.create({ url: 'about:blank', active: false })

newTabId = newAboutBlankTab.id
} catch (e) {
undefined
}

return browser.tabs.remove(currentWindowInfo.tabs.map((tab) => tab.id).filter((tab) => tab.id !== newTabId))
}).then(callback)
},

query (data) {
const code = `var s; (s = document.getElementById('${data.element}')) && s.textContent`

const queryTab = (tab) => {
return Promise.try(() => {
return browser.tabs.executeScript(tab.id, { code })
}).then((results) => {
if (!results || (results[0] !== data.randomString)) {
throw new Error('Executed script did not return result')
}
})
}

return Promise.try(() => {
return browser.tabs.query({ windowType: 'normal' })
}).filter((tab) => {
// the tab's url must begin with
// http or https so that we filter out
// about:blank and chrome:// urls
// which will throw errors!
return httpRe.test(tab.url)
}).then((tabs) => {
// generate array of promises
return map(tabs, queryTab)
}).any()
},

verify (data, fn) {
return this.query(data)
.then(fn)
},

lastFocusedWindow () {
return Promise.try(() => {
return browser.windows.getLastFocused()
})
},

takeScreenshot (fn) {
return this.lastFocusedWindow()
.then((win) => {
return browser.tabs.captureVisibleTab(win.id, { format: 'png' })
})
.then(fn)
},
}

module.exports = automation
Loading