@serenity-js/playwright
Version:
Adapter that integrates @serenity-js/web with Playwright, enabling Serenity/JS reporting and using the Screenplay Pattern to write component and end-to-end test scenarios
103 lines • 3.85 kB
JavaScript
import { CorrelationId } from '@serenity-js/core/model';
import { PlaywrightBrowsingSession } from './PlaywrightBrowsingSession.js';
import { PlaywrightPage } from './PlaywrightPage.js';
/**
* Playwright-specific implementation of [`BrowsingSession`](https://serenity-js.org/api/web/class/BrowsingSession/)
* for Electron applications.
*
* Use this class when you have an already-launched `ElectronApplication` instance,
* typically in Playwright Test scenarios where the app is managed per-worker.
*
* ## Example
*
* ```ts
* import { _electron as electron } from 'playwright';
* import { actorCalled } from '@serenity-js/core';
* import { BrowseTheWebWithPlaywright } from '@serenity-js/playwright';
*
* const electronApp = await electron.launch({ args: ['main.js'] });
*
* const actor = actorCalled('Tester').whoCan(
* BrowseTheWebWithPlaywright.usingElectronApp(electronApp)
* );
*
* // After tests, close the app manually
* await electronApp.close();
* ```
*
* @group Models
*/
export class PlaywrightBrowsingSessionWithElectron extends PlaywrightBrowsingSession {
electronApp;
constructor(electronApp, extraBrowserContextOptions, selectors) {
super(extraBrowserContextOptions, selectors);
this.electronApp = electronApp;
}
async createBrowserContext() {
return this.electronApp.context();
}
async registerCurrentPage() {
// Ensure browser context is initialized before accessing windows
await this.browserContext();
const windows = this.electronApp.windows();
let targetPage;
if (windows.length === 0) {
// Wait for the first window to open
targetPage = await this.electronApp.firstWindow();
}
else {
// Use the last opened window
targetPage = windows.at(-1);
}
// Check if this window is already registered
const allPages = await this.allPages();
for (const page of allPages) {
const nativePage = await page.nativePage();
if (nativePage === targetPage) {
return page;
}
}
// Create and register a new PlaywrightPage
const playwrightPage = new PlaywrightPage(this, targetPage, this.extraBrowserContextOptions, CorrelationId.create());
this.register(playwrightPage);
// Set up close handler for automatic deregistration
targetPage.on('close', () => {
this.deregister(playwrightPage.id);
});
return playwrightPage;
}
/**
* Closes all Electron windows but does NOT close the Electron application itself.
* The application lifecycle is managed externally.
*/
async closeAllPages() {
const pages = await this.allPages();
for (const page of pages) {
await page.close();
}
}
/**
* Returns [basic meta-data](https://serenity-js.org/api/web/interface/BrowserCapabilities/) about the Electron application.
*
* **Please note** that since Playwright does not expose information about the operating system
* the tests are running on, **Serenity/JS assumes that the tests are running locally**
* and therefore returns the value of Node.js `process.platform` for `platformName`.
*/
async browserCapabilities() {
return {
browserName: 'electron',
platformName: process.platform,
browserVersion: await this.getElectronVersion(),
};
}
async getElectronVersion() {
try {
const version = await this.electronApp.evaluate(() => process.versions.electron);
return version || 'unknown';
}
catch {
return 'unknown';
}
}
}
//# sourceMappingURL=PlaywrightBrowsingSessionWithElectron.js.map