@serenity-js/playwright/src/screenplay/models/PlaywrightBrowsingSessionWithPage.ts

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

import { CorrelationId } from '@serenity-js/core/lib/model';
import type { BrowserCapabilities } from '@serenity-js/web';
import type * as playwright from 'playwright-core';

import type { ExtraBrowserContextOptions } from '../../ExtraBrowserContextOptions';
import { PlaywrightBrowsingSession } from './PlaywrightBrowsingSession';
import { PlaywrightPage } from './PlaywrightPage';

/**
 *  @group Models
 */
export class PlaywrightBrowsingSessionWithPage extends PlaywrightBrowsingSession {
    private readonly playwrightManagedPageId: CorrelationId = CorrelationId.create();

    constructor(
        protected readonly page: playwright.Page,
        browserContextOptions: ExtraBrowserContextOptions,
        selectors: playwright.Selectors,
    ) {
        super(browserContextOptions, selectors);
    }

    protected override async registerCurrentPage(): Promise<PlaywrightPage> {
        await this.browserContext();

        const playwrightPage = new PlaywrightPage(this, this.page, this.extraBrowserContextOptions, this.playwrightManagedPageId);

        this.register(playwrightPage);

        return playwrightPage;
    }

    protected override async createBrowserContext(): Promise<playwright.BrowserContext> {
        return this.page.context();
    }

    /**
     * Closes any newly opened pages, leaving only the original one managed by Playwright Test.
     */
    async closeAllPages(): Promise<void> {
        for (const page of this.pages.values()) {
            if (! page.id.equals(this.playwrightManagedPageId)) {
                await page.close();
            }
        }

        this.pages.clear();
        this.currentBrowserPage = undefined;
    }

    override async browserCapabilities(): Promise<BrowserCapabilities> {
        const browser = this.page.context().browser();
        return {
            browserName: (browser as any)._initializer.name,   // todo: raise a PR to Playwright to expose this information
            platformName: process.platform,                    // todo: get the actual platform from Playwright
            browserVersion: browser.version()
        }
    }
}