import fs from 'fs-extra' import { chromium, webkit, firefox, Browser, BrowserContext, Page, ElementHandle, devices, Locator, Request as PlaywrightRequest, Response as PlaywrightResponse, } from 'playwright' import path from 'path' type EventType = 'request' | 'response' type PageLog = { source: string; message: string; args: unknown[] } let page: Page let browser: Browser | undefined let context: BrowserContext | undefined let contextHasJSEnabled: boolean = true let pageLogs: Array | PageLog> = [] let websocketFrames: Array<{ payload: string | Buffer }> = [] const tracePlaywright = process.env.TRACE_PLAYWRIGHT const defaultTimeout = process.env.NEXT_E2E_TEST_TIMEOUT ? parseInt(process.env.NEXT_E2E_TEST_TIMEOUT, 10) : // In development mode, compilation can take longer due to lower CPU // availability in GitHub Actions. 60 * 1000 // loose global to register teardown functions before quitting the browser instance. // This is due to `quit` can be called anytime outside of Playwright's lifecycle, // which can create corrupted state by terminating the context. // [TODO] global `quit` might need to be removed, instead should introduce per-instance teardown const pendingTeardown: Array<() => Promise> = [] export async function quit() { await Promise.all(pendingTeardown.map((fn) => fn())) await context?.close() await browser?.close() context = undefined browser = undefined } async function teardown(tearDownFn: () => Promise) { pendingTeardown.push(tearDownFn) await tearDownFn() pendingTeardown.splice(pendingTeardown.indexOf(tearDownFn), 1) } interface ElementHandleExt extends ElementHandle { getComputedCss(prop: string): Promise text(): Promise } export class Playwright { private activeTrace?: string private eventCallbacks: Record void>> = { request: new Set(), response: new Set(), } private async initContextTracing(url: string, context: BrowserContext) { if (!tracePlaywright) { return } try { // Clean up if any previous traces are still active await teardown(this.teardownTracing.bind(this)) await context.tracing.start({ screenshots: true, snapshots: true, sources: true, }) this.activeTrace = encodeURIComponent(url) } catch (e) { this.activeTrace = undefined } } private async teardownTracing() { if (!this.activeTrace) { return } try { const traceDir = path.join(__dirname, '../../traces') const traceOutputPath = path.join( traceDir, `${path .relative(path.join(__dirname, '../../'), process.env.TEST_FILE_PATH!) .replace(/\//g, '-')}`, `playwright-${this.activeTrace}-${Date.now()}.zip` ) await fs.remove(traceOutputPath) await context!.tracing.stop({ path: traceOutputPath, }) } catch (e) { require('console').warn('Failed to teardown playwright tracing', e) } finally { this.activeTrace = undefined } } on( event: 'request', cb: (request: PlaywrightRequest) => void | Promise ): void on( event: 'response', cb: (request: PlaywrightResponse) => void | Promise ): void on(event: EventType, cb: (...args: any[]) => void) { if (!this.eventCallbacks[event]) { throw new Error( `Invalid event passed to browser.on, received ${event}. Valid events are ${Object.keys( this.eventCallbacks )}` ) } this.eventCallbacks[event]?.add(cb) } off( event: 'request', cb: (request: PlaywrightRequest) => void | Promise ): void off( event: 'response', cb: (request: PlaywrightResponse) => void | Promise ): void off(event: EventType, cb: (...args: any[]) => void) { this.eventCallbacks[event]?.delete(cb) } async setup( browserName: string, locale: string, javaScriptEnabled: boolean, ignoreHTTPSErrors: boolean, headless: boolean, userAgent: string | undefined ) { let device if (process.env.DEVICE_NAME) { device = devices[process.env.DEVICE_NAME] if (!device) { throw new Error( `Invalid playwright device name ${process.env.DEVICE_NAME}` ) } } if (browser) { if (contextHasJSEnabled !== javaScriptEnabled) { // If we have switched from having JS enable/disabled we need to recreate the context. await teardown(this.teardownTracing.bind(this)) await context?.close() context = await browser.newContext({ locale, javaScriptEnabled, ignoreHTTPSErrors, ...(userAgent ? { userAgent } : {}), ...device, }) contextHasJSEnabled = javaScriptEnabled } return } browser = await this.launchBrowser(browserName, { headless }) context = await browser.newContext({ locale, javaScriptEnabled, ignoreHTTPSErrors, ...(userAgent ? { userAgent } : {}), ...device, }) contextHasJSEnabled = javaScriptEnabled } async close(): Promise { await teardown(this.teardownTracing.bind(this)) await page?.close() } async launchBrowser(browserName: string, launchOptions: Record) { if (browserName === 'safari') { return await webkit.launch(launchOptions) } else if (browserName === 'firefox') { return await firefox.launch({ ...launchOptions, firefoxUserPrefs: { ...launchOptions.firefoxUserPrefs, // The "fission.webContentIsolationStrategy" pref must be // set to 1 on Firefox due to the bug where a new history // state is pushed on a page reload. // See https://github.com/microsoft/playwright/issues/22640 // See https://bugzilla.mozilla.org/show_bug.cgi?id=1832341 'fission.webContentIsolationStrategy': 1, }, }) } else { return await chromium.launch({ devtools: !launchOptions.headless, ...launchOptions, ignoreDefaultArgs: ['--disable-back-forward-cache'], }) } } async get(url: string): Promise { await page.goto(url) } async loadPage( url: string, opts?: { disableCache?: boolean cpuThrottleRate?: number pushErrorAsConsoleLog?: boolean beforePageLoad?: (page: Page) => void | Promise } ) { await this.close() // clean-up existing pages for (const oldPage of context!.pages()) { await oldPage.close() } await this.initContextTracing(url, context!) page = await context!.newPage() page.setDefaultTimeout(defaultTimeout) page.setDefaultNavigationTimeout(defaultTimeout) pageLogs = [] websocketFrames = [] page.on('console', (msg) => { console.log('browser log:', msg) pageLogs.push( Promise.all( msg.args().map((handle) => handle.jsonValue().catch(() => {})) ).then((args) => ({ source: msg.type(), message: msg.text(), args })) ) }) page.on('crash', () => { console.error('page crashed') }) page.on('pageerror', (error) => { console.error('page error', error) if (opts?.pushErrorAsConsoleLog) { pageLogs.push({ source: 'error', message: error.message, args: [] }) } }) page.on('request', (req) => { this.eventCallbacks.request.forEach((cb) => cb(req)) }) page.on('response', (res) => { this.eventCallbacks.response.forEach((cb) => cb(res)) }) if (opts?.disableCache) { // TODO: this doesn't seem to work (dev tools does not check the box as expected) const session = await context!.newCDPSession(page) session.send('Network.setCacheDisabled', { cacheDisabled: true }) } if (opts?.cpuThrottleRate) { const session = await context!.newCDPSession(page) // https://chromedevtools.github.io/devtools-protocol/tot/Emulation/#method-setCPUThrottlingRate session.send('Emulation.setCPUThrottlingRate', { rate: opts.cpuThrottleRate, }) } page.on('websocket', (ws) => { if (tracePlaywright) { page .evaluate(`console.log('connected to ws at ${ws.url()}')`) .catch(() => {}) ws.on('close', () => page .evaluate(`console.log('closed websocket ${ws.url()}')`) .catch(() => {}) ) } ws.on('framereceived', (frame) => { websocketFrames.push({ payload: frame.payload }) if (tracePlaywright) { page .evaluate(`console.log('received ws message ${frame.payload}')`) .catch(() => {}) } }) }) await opts?.beforePageLoad?.(page) await page.goto(url, { waitUntil: 'load' }) } back(options?: Parameters[0]) { // do not preserve the previous chained value, it might be invalid after a navigation. return this.startChain(async () => { await page.goBack(options) }) } forward(options?: Parameters[0]) { // do not preserve the previous chained value, it might be invalid after a navigation. return this.startChain(async () => { await page.goForward(options) }) } refresh() { // do not preserve the previous chained value, it's likely to be invalid after a reload. return this.startChain(async () => { await page.reload() }) } setDimensions({ width, height }: { height: number; width: number }) { return this.startOrPreserveChain(() => page.setViewportSize({ width, height }) ) } addCookie(opts: { name: string; value: string }) { return this.startOrPreserveChain(async () => context!.addCookies([ { path: '/', domain: await page.evaluate('window.location.hostname'), ...opts, }, ]) ) } deleteCookies() { return this.startOrPreserveChain(async () => context!.clearCookies()) } private wrapElement(el: ElementHandle, selector: string): ElementHandleExt { function getComputedCss(prop: string) { return page.evaluate( function (args) { const style = getComputedStyle(document.querySelector(args.selector)!) return style[args.prop] || null }, { selector, prop } ) } return Object.assign(el, { selector, getComputedCss, text: () => el.innerText(), }) } elementByCss(selector: string) { return this.waitForElementByCss(selector, 5_000) } hasElementByCss(selector: string) { return this.startChain(() => page.locator(selector).isVisible()) } elementById(id: string) { return this.elementByCss(`#${id}`) } getValue(this: Playwright) { return this.continueChain((el) => el.inputValue()) } text(this: Playwright) { return this.continueChain((el) => el.innerText()) } type(this: Playwright, text: string) { return this.continueChain(async (el) => { await el.type(text) return el }) } moveTo(this: Playwright) { return this.continueChain(async (el) => { await el.hover() return el }) } async getComputedCss(this: Playwright, prop: string) { return this.continueChain((el) => el.getComputedCss(prop)) } async getAttribute(this: Playwright, attr: string) { return this.continueChain((el) => el.getAttribute(attr)) } hasElementByCssSelector(selector: string) { return this.eval(`!!document.querySelector('${selector}')`) } keydown(key: string) { return this.startOrPreserveChain(() => page.keyboard.down(key)) } keyup(key: string) { return this.startOrPreserveChain(() => page.keyboard.up(key)) } click(this: Playwright) { return this.continueChain(async (el) => { await el.click() return el }) } touchStart(this: Playwright) { return this.continueChain(async (el) => { await el.dispatchEvent('touchstart') return el }) } elementsByCss(selector: string) { return this.startChain(() => page.$$(selector).then((els) => { return els.map((el) => { const origGetAttribute = el.getAttribute.bind(el) el.getAttribute = (name) => { // ensure getAttribute defaults to empty string to // match selenium return origGetAttribute(name).then((val) => val || '') } return el }) }) ) } waitForElementByCss(selector: string, timeout = 10_000) { return this.startChain(async () => { const el = await page.waitForSelector(selector, { timeout, state: 'attached', }) // it seems selenium waits longer and tests rely on this behavior // so we wait for the load event fire before returning await page.waitForLoadState() return this.wrapElement(el, selector) }) } waitForCondition(snippet: string, timeout?: number) { return this.startOrPreserveChain(async () => { await page.waitForFunction(snippet, { timeout }) }) } // TODO: this should default to unknown, but a lot of tests use and rely on the result being `any` eval any>( fn: TFn, ...args: Parameters ): Playwright> & Promise> // TODO: this is ugly, the type parameter is basically a hidden cast eval(fn: string, ...args: any[]): Playwright & Promise eval( fn: string | ((...args: any[]) => any), ...args: any[] ): Playwright & Promise eval( fn: string | ((...args: any[]) => any), ...args: any[] ): Playwright & Promise { return this.startChain(async () => page .evaluate(fn, ...args) .catch((err) => { // TODO: gross, why are we doing this console.error('eval error:', err) return null! }) .finally(async () => { await page.waitForLoadState() }) ) } async log(options?: { includeArgs?: T }) { return this.startChain( () => options?.includeArgs ? Promise.all(pageLogs) : Promise.all(pageLogs).then((logs) => logs.map(({ source, message }) => ({ source, message })) ) // TODO: Starting with TypeScript 5.8 we might not need this type cast. ) as Promise< T extends true ? { source: string; message: string; args: unknown[] }[] : { source: string; message: string }[] > } async websocketFrames() { return this.startChain(() => websocketFrames) } async url() { return this.startChain(() => page.url()) } async waitForIdleNetwork() { return this.startOrPreserveChain(() => { return page.waitForLoadState('networkidle') }) } locateRedbox(): Locator { return page.locator( 'nextjs-portal [aria-labelledby="nextjs__container_errors_label"]' ) } locateDevToolsIndicator(): Locator { return page.locator('nextjs-portal [data-nextjs-dev-tools-button]') } locator(selector: string, options?: Parameters<(typeof page)['locator']>[1]) { return page.locator(selector, options) } /** A call that expects to be chained after a previous call, because it needs its value. */ private continueChain(nextCall: (value: TCurrent) => Promise) { return this._chain(true, nextCall) } /** Start a chain. If continuing, it overwrites the current chained value. */ private startChain(nextCall: () => TNext | Promise) { return this._chain(false, nextCall) } /** Either start or continue a chain. If continuing, it preserves the current chained value. */ private startOrPreserveChain(nextCall: () => Promise) { return this._chain(false, async (value) => { await nextCall() return value }) } // necessary for the type of the function below readonly [Symbol.toStringTag]: string = 'Playwright' private _chain( this: Playwright, mustBeChained: boolean, nextCall: (current: TCurrent) => TNext | Promise ): Playwright & Promise { const syncError = new Error('next-browser-base-chain-error') // If `this` is actually a proxy created by a previous chained call, it'll act like it has a `promise` property. // (see proxy code below) type MaybeChained = Playwright & { promise?: Promise } const self = this as MaybeChained let currentPromise = self.promise if (!currentPromise) { if (mustBeChained) { // Note that this should also be enforced by the type system // by adding appropriate `(this: Playwright)` type annotations // to methods that expect to be chained, but tests can bypass this (or not be checked because they use JS) throw new Error( 'Expected this call to be chained after a previous call' ) } else { // We're handling a call that does not expect to be chained after a previous one, // so it's safe to default the current value to undefined -- we don't need a value to invoke `nextCall` currentPromise = Promise.resolve(undefined as TCurrent) } } const promise = currentPromise.then(nextCall).catch((reason: unknown) => { // TODO: only patch the stacktrace if the sync callstack is missing from it if (reason && typeof reason === 'object' && 'stack' in reason) { const syncCallStack = syncError.stack!.split(syncError.message)[1] reason.stack += `\n${syncCallStack}` } throw reason }) function get(target: Playwright, p: string | symbol): any { switch (p) { case 'promise': return promise case 'then': return promise.then.bind(promise) case 'catch': return promise.catch.bind(promise) case 'finally': return promise.finally.bind(promise) default: return target[p] } } // @ts-expect-error: we're changing `TCurrent` into TNext via proxy hacks return new Proxy(this, { get, }) } }