-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test: new switchToWindowWithTitle w/ Extension communication
- Loading branch information
1 parent
624763a
commit 2ab973d
Showing
17 changed files
with
716 additions
and
296 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
112 changes: 112 additions & 0 deletions
112
test/e2e/background-socket/server-mocha-to-background.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| import events from 'events'; | ||
| import log from 'loglevel'; | ||
| import { WebSocketServer } from 'ws'; | ||
| import { WindowProperties } from './window-handles'; | ||
|
|
||
| /** | ||
| * This singleton class runs on the Mocha/Selenium test. | ||
| * It's used to communicate from the Mocha/Selenium test to the Extension background script (service worker in MV3). | ||
| */ | ||
| class ServerMochaToBackground { | ||
| private server: WebSocketServer; | ||
|
|
||
| private ws: WebSocket | null = null; | ||
|
|
||
| private eventEmitter; | ||
|
|
||
| constructor() { | ||
| this.server = new WebSocketServer({ port: 8111 }); | ||
|
|
||
| log.debug('ServerMochaToBackground created'); | ||
|
|
||
| this.server.on('connection', (ws: WebSocket) => { | ||
| this.ws = ws; | ||
|
|
||
| ws.onmessage = (ev: MessageEvent) => this.receivedMessage(ev.data); | ||
| }); | ||
|
|
||
| this.eventEmitter = new events.EventEmitter(); | ||
| } | ||
|
|
||
| // This function is never explicitly called, but in teh future it could be | ||
| stop() { | ||
| if (this.ws) { | ||
| this.ws.close(); | ||
| } | ||
|
|
||
| this.server.close(); | ||
|
|
||
| log.debug('ServerMochaToBackground stopped'); | ||
| } | ||
|
|
||
| // Send a message to the Extension background script (service worker in MV3) | ||
| send(message: string | object) { | ||
| if (!this.ws) { | ||
| log.debug('No client connected'); | ||
| return; | ||
| } | ||
|
|
||
| if (typeof message === 'string') { | ||
| this.ws.send(message); | ||
| } else { | ||
| this.ws.send(JSON.stringify(message)); | ||
| } | ||
| } | ||
|
|
||
| // Handle messages received from the Extension background script (service worker in MV3) | ||
| private receivedMessage(message: string) { | ||
| let msg; | ||
|
|
||
| try { | ||
| msg = JSON.parse(message); | ||
| } catch (e) { | ||
| log.error('error in JSON', e); | ||
| return; | ||
| } | ||
|
|
||
| if (msg.command === 'openTabs') { | ||
| this.eventEmitter.emit('openTabs', msg); | ||
| } else if (msg.command === 'notFound') { | ||
| throw new Error('No window found by background script'); | ||
| } | ||
| } | ||
|
|
||
| // This is not used in the current code, but could be used in the future | ||
| queryTabs(tabTitle: string) { | ||
| this.send({ command: 'queryTabs', title: tabTitle }); | ||
| } | ||
|
|
||
| // Sends the message to the Extension, and waits for a response | ||
| async waitUntilWindowWithProperty(property: WindowProperties, value: string) { | ||
| this.send({ command: 'waitUntilWindowWithProperty', property, value }); | ||
|
|
||
| const tabs = await this.waitForResponse(); | ||
| log.debug('got the response', tabs); | ||
|
|
||
| // The return value here is less useful than we had hoped, because the tabs | ||
| // are not in the same order as driver.getAllWindowHandles() | ||
| return tabs; | ||
| } | ||
|
|
||
| // This is a way to wait for an event async, without timeouts or polling | ||
| async waitForResponse() { | ||
| return new Promise((resolve) => { | ||
| this.eventEmitter.on('openTabs', resolve); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| // Singleton setup below | ||
| let _serverMochaToBackground: ServerMochaToBackground; | ||
|
|
||
| export function getServerMochaToBackground() { | ||
| if (!_serverMochaToBackground) { | ||
| startServerMochaToBackground(); | ||
| } | ||
|
|
||
| return _serverMochaToBackground; | ||
| } | ||
|
|
||
| function startServerMochaToBackground() { | ||
| _serverMochaToBackground = new ServerMochaToBackground(); | ||
| } |
136 changes: 136 additions & 0 deletions
136
test/e2e/background-socket/socket-background-to-mocha.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| import log from 'loglevel'; | ||
| import { WindowProperties } from './window-handles'; | ||
|
|
||
| /** | ||
| * This singleton class runs on the Extension background script (service worker in MV3). | ||
| * It's used to communicate from the Extension background script to the Mocha/Selenium test. | ||
| * The main advantage is that it can call chrome.tabs.query(). | ||
| * We had hoped it would be able to call chrome.tabs.highlight(), but Selenium doesn't see the tab change. | ||
| */ | ||
| class SocketBackgroundToMocha { | ||
| private client: WebSocket; | ||
|
|
||
| constructor() { | ||
| this.client = new WebSocket('ws://localhost:8111'); | ||
|
|
||
| this.client.onopen = () => log.debug('WebSocket connection opened'); | ||
|
|
||
| this.client.onmessage = (event: MessageEvent) => | ||
| this.receivedMessage(event.data); | ||
|
|
||
| this.client.onclose = () => log.debug('WebSocket connection closed'); | ||
|
|
||
| this.client.onerror = (error) => log.error('WebSocket error:', error); | ||
| } | ||
|
|
||
| /** | ||
| * Waits until a window with the given property is open. | ||
| * delayStep = 200ms, timeout = 10s | ||
| * | ||
| * You can think of this kind of like a template function: | ||
| * If `property` is `title`, then this becomes `waitUntilWindowWithTitle` | ||
| * If `property` is `url`, then this becomes `waitUntilWindowWithUrl` | ||
| * Remember that `a[property]` becomes `a.title` or `a.url` | ||
| * | ||
| * @param property - 'title' or 'url' | ||
| * @param value - The value we're searching for and want to wait for | ||
| * @returns The handle of the window tab with the given property value | ||
| */ | ||
| async waitUntilWindowWithProperty(property: WindowProperties, value: string) { | ||
| let tabs: chrome.tabs.Tab[] = []; | ||
| const delayStep = 200; | ||
| const timeout = 10000; | ||
|
|
||
| for ( | ||
| let timeElapsed = 0; | ||
| timeElapsed <= timeout; | ||
| timeElapsed += delayStep | ||
| ) { | ||
| tabs = await this.queryTabs({}); | ||
|
|
||
| const index = tabs.findIndex((a) => a[property] === value); | ||
|
|
||
| if (index !== -1) { | ||
| this.send({ command: 'openTabs', tabs: this.cleanTabs(tabs) }); | ||
| return; | ||
| } | ||
|
|
||
| // wait for delayStep milliseconds | ||
| await new Promise((resolve) => setTimeout(resolve, delayStep)); | ||
| } | ||
|
|
||
| // The window was not found at the end of the timeout | ||
| this.send({ command: 'notFound', tabs: this.cleanTabs(tabs) }); | ||
| } | ||
|
|
||
| // This function exists to support both MV2 and MV3 | ||
| private async queryTabs(queryInfo: object): Promise<chrome.tabs.Tab[]> { | ||
| if ( | ||
| process.env.ENABLE_MV3 === 'true' || | ||
| process.env.ENABLE_MV3 === undefined | ||
| ) { | ||
| // With MV3, chrome.tabs.query has an await form | ||
| return await chrome.tabs.query(queryInfo); | ||
| } | ||
|
|
||
| // With MV2, we have to wrap chrome.tabs.query in a Promise | ||
| return new Promise((resolve) => { | ||
| chrome.tabs.query(queryInfo, (tabs: chrome.tabs.Tab[]) => { | ||
| resolve(tabs); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| // Clean up the tab data before sending them to the client | ||
| private cleanTabs(tabs: chrome.tabs.Tab[]): chrome.tabs.Tab[] { | ||
| return tabs.map((tab) => { | ||
| // This field can be very long, and is not needed | ||
| if (tab.favIconUrl && tab.favIconUrl.length > 40) { | ||
| tab.favIconUrl = undefined; | ||
| } | ||
|
|
||
| return tab; | ||
| }); | ||
| } | ||
|
|
||
| // Send a message to the Mocha/Selenium test | ||
| send(message: string | object) { | ||
| if (typeof message === 'string') { | ||
| this.client.send(message); | ||
| } else { | ||
| this.client.send(JSON.stringify(message)); | ||
| } | ||
| } | ||
|
|
||
| // Handle messages received from the Mocha/Selenium test | ||
| private async receivedMessage(message: string) { | ||
| const msg = JSON.parse(message); | ||
|
|
||
| log.debug('Received message:', msg); | ||
|
|
||
| if (msg.command === 'queryTabs') { | ||
| const tabs = await this.queryTabs({ title: msg.title }); | ||
| log.debug('Sending tabs:', tabs); | ||
| this.send({ command: 'openTabs', tabs: this.cleanTabs(tabs) }); | ||
| } else if (msg.command === 'waitUntilWindowWithProperty') { | ||
| this.waitUntilWindowWithProperty(msg.property, msg.value); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Singleton setup below | ||
| let _socketBackgroundToMocha: SocketBackgroundToMocha; | ||
|
|
||
| export function getSocketBackgroundToMocha() { | ||
| if (!_socketBackgroundToMocha) { | ||
| startSocketBackgroundToMocha(); | ||
| } | ||
|
|
||
| return _socketBackgroundToMocha; | ||
| } | ||
|
|
||
| function startSocketBackgroundToMocha() { | ||
| if (process.env.IN_TEST) { | ||
| _socketBackgroundToMocha = new SocketBackgroundToMocha(); | ||
| } | ||
| } |
Oops, something went wrong.