/** * Copyright (c) 2019 The xterm.js authors. All rights reserved. * @license MIT */ import { Browser, JSHandle, Page } from '@playwright/test'; import { deepStrictEqual } from 'assert'; import type { IRenderDimensions } from 'browser/renderer/shared/Types'; import type { IRenderService } from 'browser/services/Services'; import type { ICoreTerminal, IMarker } from 'common/Types'; import * as playwright from '@playwright/test'; import { PageFunction } from 'playwright-core/types/structs'; import { IBuffer, IBufferCell, IBufferLine, IBufferRange, IModes, ITerminalOptions, Terminal } from 'xterm'; import { EventEmitter } from '../../out/common/EventEmitter'; // TODO: We could avoid needing this import deepEqual = require('deep-equal'); export interface ITestContext { page: Page; termHandle: JSHandle; proxy: TerminalProxy; } export async function createTestContext(browser: Browser): Promise { const page = await browser.newPage(); page.on('console', e => console.log(`[${browser.browserType().name()}:${e.type()}]`, e)); page.on('pageerror', e => console.error(`[${browser.browserType().name()}]`, e)); await page.goto('/test'); const proxy = new TerminalProxy(page); proxy.initPage(); return { page, termHandle: await page.evaluateHandle('window.term'), proxy }; } type EnsureAsync = T extends PromiseLike ? T : Promise; type EnsureAsyncProperties = { [Key in keyof T]: EnsureAsync }; interface ITerminalProxy extends // Interfaces that the proxy implements with async values EnsureAsyncProperties> { // Custom proxy methods evaluate(pageFunction: PageFunction[], T>): Promise; write(data: string | Uint8Array): Promise; } export class TerminalProxy implements ITerminalProxy { constructor(private readonly _page: Page) { } /** * Initialize the proxy for a new playwright page. */ public async initPage(): Promise { await this._page.exposeFunction('onBell', () => this._onBell.fire()); await this._page.exposeFunction('onBinary', (e: string) => this._onBinary.fire(e)); await this._page.exposeFunction('onCursorMove', () => this._onCursorMove.fire()); await this._page.exposeFunction('onData', (e: string) => this._onData.fire(e)); await this._page.exposeFunction('onKey', (e: { key: string, domEvent: KeyboardEvent }) => this._onKey.fire(e)); await this._page.exposeFunction('onLineFeed', () => this._onLineFeed.fire()); await this._page.exposeFunction('onRender', (e: { start: number, end: number }) => this._onRender.fire(e)); await this._page.exposeFunction('onResize', (e: { cols: number, rows: number }) => this._onResize.fire(e)); await this._page.exposeFunction('onScroll', (e: number) => this._onScroll.fire(e)); await this._page.exposeFunction('onSelectionChange', () => this._onSelectionChange.fire()); await this._page.exposeFunction('onTitleChange', (e: string) => this._onTitleChange.fire(e)); } /** * Initialize the proxy for a new terminal object. */ public async initTerm(): Promise { for (const emitter of [ this._onBell, this._onBinary, this._onCursorMove, this._onData, this._onKey, this._onLineFeed, this._onRender, this._onResize, this._onScroll, this._onSelectionChange, this._onTitleChange ]) { emitter.clearListeners(); } await this.evaluate(([term]) => term.onBell((window as any).onBell)); await this.evaluate(([term]) => term.onBinary((window as any).onBinary)); await this.evaluate(([term]) => term.onCursorMove((window as any).onCursorMove)); await this.evaluate(([term]) => term.onData((window as any).onData)); await this.evaluate(([term]) => term.onKey((window as any).onKey)); await this.evaluate(([term]) => term.onLineFeed((window as any).onLineFeed)); await this.evaluate(([term]) => term.onRender((window as any).onRender)); await this.evaluate(([term]) => term.onResize((window as any).onResize)); await this.evaluate(([term]) => term.onScroll((window as any).onScroll)); await this.evaluate(([term]) => term.onSelectionChange((window as any).onSelectionChange)); await this.evaluate(([term]) => term.onTitleChange((window as any).onTitleChange)); } // #region Events private _onBell = new EventEmitter(); public readonly onBell = this._onBell.event; private _onBinary = new EventEmitter(); public readonly onBinary = this._onBinary.event; private _onCursorMove = new EventEmitter(); public readonly onCursorMove = this._onCursorMove.event; private _onData = new EventEmitter(); public readonly onData = this._onData.event; private _onKey = new EventEmitter<{ key: string, domEvent: KeyboardEvent }>(); public readonly onKey = this._onKey.event; private _onLineFeed = new EventEmitter(); public readonly onLineFeed = this._onLineFeed.event; private _onRender = new EventEmitter<{ start: number, end: number }>(); public readonly onRender = this._onRender.event; private _onResize = new EventEmitter<{ cols: number, rows: number }>(); public readonly onResize = this._onResize.event; private _onScroll = new EventEmitter(); public readonly onScroll = this._onScroll.event; private _onSelectionChange = new EventEmitter(); public readonly onSelectionChange = this._onSelectionChange.event; private _onTitleChange = new EventEmitter(); public readonly onTitleChange = this._onTitleChange.event; // #endregion // #region Simple properties public get cols(): Promise { return this.evaluate(([term]) => term.cols); } public get rows(): Promise { return this.evaluate(([term]) => term.rows); } public get modes(): Promise { return this.evaluate(([term]) => term.modes); } // #endregion // #region Complex properties public get buffer(): TerminalBufferNamespaceProxy { return new TerminalBufferNamespaceProxy(this._page, this); } /** * Exposes somewhat unsafe access to internals for testing things difficult to do with the regular * API */ public get core(): TerminalCoreProxy { return new TerminalCoreProxy(this._page, this); } // #endregion // #region Proxied methods public async dispose(): Promise { return this.evaluate(([term]) => term.dispose()); } public async reset(): Promise { return this.evaluate(([term]) => term.reset()); } public async clear(): Promise { return this.evaluate(([term]) => term.clear()); } public async focus(): Promise { return this.evaluate(([term]) => term.focus()); } public async blur(): Promise { return this.evaluate(([term]) => term.blur()); } public async hasSelection(): Promise { return this.evaluate(([term]) => term.hasSelection()); } public async getSelection(): Promise { return this.evaluate(([term]) => term.getSelection()); } public async getSelectionPosition(): Promise { return this.evaluate(([term]) => term.getSelectionPosition()); } public async selectAll(): Promise { return this.evaluate(([term]) => term.selectAll()); } public async clearSelection(): Promise { return this.evaluate(([term]) => term.clearSelection()); } public async select(column: number, row: number, length: number): Promise { return this._page.evaluate(([term, column, row, length]) => term.select(column, row, length), [await this.getHandle(), column, row, length] as const); } public async paste(data: string): Promise { return this._page.evaluate(([term, data]) => term.paste(data), [await this.getHandle(), data] as const); } public async getOption(key: T): Promise { return this._page.evaluate(([term, key]) => term.options[key as T], [await this.getHandle(), key] as const); } public async setOption(key: T, value: ITerminalOptions[T]): Promise { return this._page.evaluate(([term, key, value]) => term.options[key as T] = (value as ITerminalOptions[T]), [await this.getHandle(), key, value] as const); } public async setOptions(value: Partial): Promise { return this._page.evaluate(([term, value]) => { term.options = value; }, [await this.getHandle(), value] as const); } public async scrollToTop(): Promise { return this.evaluate(([term]) => term.scrollToTop()); } public async scrollToBottom(): Promise { return this.evaluate(([term]) => term.scrollToBottom()); } public async scrollPages(pageCount: number): Promise { return this._page.evaluate(([term, pageCount]) => term.scrollPages(pageCount), [await this.getHandle(), pageCount] as const); } public async scrollToLine(line: number): Promise { return this._page.evaluate(([term, line]) => term.scrollToLine(line), [await this.getHandle(), line] as const); } public async scrollLines(amount: number): Promise { return this._page.evaluate(([term, amount]) => term.scrollLines(amount), [await this.getHandle(), amount] as const); } public async write(data: string | Uint8Array): Promise { return this._page.evaluate(([term, data]) => { return new Promise(r => term.write(typeof data === 'string' ? data : new Uint8Array(data), r)); }, [await this.getHandle(), typeof data === 'string' ? data : Array.from(data)] as const); } public async writeln(data: string | Uint8Array): Promise { return this._page.evaluate(([term, data]) => { return new Promise(r => term.writeln(typeof data === 'string' ? data : new Uint8Array(data), r)); }, [await this.getHandle(), typeof data === 'string' ? data : Array.from(data)] as const); } public async resize(cols: number, rows: number): Promise { return this._page.evaluate(([term, cols, rows]) => term.resize(cols, rows), [await this.getHandle(), cols, rows] as const); } public async registerMarker(y: number): Promise { return this._page.evaluate(([term, y]) => term.registerMarker(y), [await this.getHandle(), y] as const); } // #endregion public async evaluate(pageFunction: PageFunction[], T>): Promise { return this._page.evaluate(pageFunction, [await this.getHandle()]); } public async evaluateHandle(pageFunction: PageFunction[], T>): Promise> { return this._page.evaluateHandle(pageFunction, [await this.getHandle()]); } public async getHandle(): Promise> { // This is async because it must be evaluated each time it is called since term may have changed return this._page.evaluateHandle('window.term'); } } class TerminalBufferNamespaceProxy { constructor( private readonly _page: Page, private readonly _proxy: TerminalProxy ) { } public get active(): TerminalBufferProxy { return new TerminalBufferProxy(this._page, this._proxy, this._proxy.evaluateHandle(([term]) => term.buffer.active)); } public get normal(): TerminalBufferProxy { return new TerminalBufferProxy(this._page, this._proxy, this._proxy.evaluateHandle(([term]) => term.buffer.normal)); } public get alternate(): TerminalBufferProxy { return new TerminalBufferProxy(this._page, this._proxy, this._proxy.evaluateHandle(([term]) => term.buffer.alternate)); } } class TerminalBufferProxy { constructor( private readonly _page: Page, private readonly _proxy: TerminalProxy, private readonly _handle: Promise> ) { } public get type(): Promise<'normal' | 'alternate'> { return this.evaluate(([buffer]) => buffer.type); } public get cursorY(): Promise { return this.evaluate(([buffer]) => buffer.cursorY); } public get cursorX(): Promise { return this.evaluate(([buffer]) => buffer.cursorX); } public get viewportY(): Promise { return this.evaluate(([buffer]) => buffer.viewportY); } public get baseY(): Promise { return this.evaluate(([buffer]) => buffer.baseY); } public get length(): Promise { return this.evaluate(([buffer]) => buffer.length); } public async getLine(y: number): Promise { const lineHandle = await this._page.evaluateHandle(([buffer, y]) => buffer.getLine(y), [await this._handle, y] as const); const value = await lineHandle.jsonValue(); if (value) { return new TerminalBufferLine(this._page, lineHandle as JSHandle); } return undefined; } public async evaluate(pageFunction: PageFunction[], T>): Promise { return this._page.evaluate(pageFunction, [await this._handle]); } } class TerminalBufferLine { constructor( private readonly _page: Page, private readonly _handle: JSHandle ) { } public get length(): Promise { return this.evaluate(([bufferLine]) => bufferLine.length); } public get isWrapped(): Promise { return this.evaluate(([bufferLine]) => bufferLine.isWrapped); } public translateToString(trimRight?: boolean, startColumn?: number, endColumn?: number): Promise { return this._page.evaluate(([bufferLine, trimRight, startColumn, endColumn]) => { return bufferLine.translateToString(trimRight, startColumn, endColumn); }, [this._handle, trimRight, startColumn, endColumn] as const); } public async getCell(x: number): Promise { const cellHandle = await this._page.evaluateHandle(([bufferLine, x]) => bufferLine.getCell(x), [this._handle, x] as const); const value = await cellHandle.jsonValue(); if (value) { return new TerminalBufferCell(this._page, cellHandle as JSHandle); } return undefined; } public async evaluate(pageFunction: PageFunction[], T>): Promise { return this._page.evaluate(pageFunction, [this._handle]); } } class TerminalBufferCell { constructor( private readonly _page: Page, private readonly _handle: JSHandle ) { } public getWidth(): Promise { return this.evaluate(([line]) => line.getWidth()); } public getChars(): Promise { return this.evaluate(([line]) => line.getChars()); } public async evaluate(pageFunction: PageFunction[], T>): Promise { return this._page.evaluate(pageFunction, [this._handle]); } } class TerminalCoreProxy { constructor( private readonly _page: Page, private readonly _proxy: TerminalProxy ) { } public get isDisposed(): Promise { return this.evaluate(([core]) => (core as any)._isDisposed); } public get renderDimensions(): Promise { return this.evaluate(([core]) => ((core as any)._renderService as IRenderService).dimensions); } public async triggerBinaryEvent(data: string): Promise { return this._page.evaluate(([core, data]) => core.coreService.triggerBinaryEvent(data), [await this._getCoreHandle(), data] as const); } private async _getCoreHandle(): Promise> { return this._proxy.evaluateHandle(([term]) => (term as any)._core as ICoreTerminal); } public async evaluate(pageFunction: PageFunction[], T>): Promise { return this._page.evaluate(pageFunction, [await this._getCoreHandle()]); } } export async function openTerminal(ctx: ITestContext, options: ITerminalOptions = {}): Promise { await ctx.page.evaluate(` if ('term' in window) { window.term.dispose(); } window.term = new Terminal(${JSON.stringify(options)}); window.term.open(document.querySelector('#terminal-container')); `); await ctx.page.waitForSelector('.xterm-rows'); ctx.termHandle = await ctx.page.evaluateHandle('window.term'); await ctx.proxy.initTerm(); } export async function pollFor(page: playwright.Page, evalOrFn: string | (() => Promise), val: T, preFn?: () => Promise, maxDuration?: number): Promise { if (preFn) { await preFn(); } const result = typeof evalOrFn === 'string' ? await page.evaluate(evalOrFn) : await evalOrFn(); if (process.env.DEBUG) { console.log('pollFor result: ', result); } if (!deepEqual(result, val)) { if (maxDuration === undefined) { maxDuration = 2000; } if (maxDuration <= 0) { deepStrictEqual(result, val, 'pollFor max duration exceeded'); } return new Promise(r => { setTimeout(() => r(pollFor(page, evalOrFn, val, preFn, maxDuration! - 10)), 10); }); } } export async function writeSync(page: playwright.Page, data: string): Promise { await page.evaluate(` window.ready = false; window.term.write('${data}', () => window.ready = true); `); await pollFor(page, 'window.ready', true); } export async function timeout(ms: number): Promise { return new Promise(r => setTimeout(r, ms)); } export function getBrowserType(): playwright.BrowserType | playwright.BrowserType | playwright.BrowserType { // Default to chromium let browserType: playwright.BrowserType | playwright.BrowserType | playwright.BrowserType = playwright['chromium']; const index = process.argv.indexOf('--browser'); if (index !== -1 && process.argv.length > index + 1 && typeof process.argv[index + 1] === 'string') { const string = process.argv[index + 1]; if (string === 'firefox' || string === 'webkit') { browserType = playwright[string]; } } return browserType; } export function launchBrowser(): Promise { const browserType = getBrowserType(); const options: Record = { headless: process.argv.includes('--headless') }; const index = process.argv.indexOf('--executablePath'); if (index > 0 && process.argv.length > index + 1 && typeof process.argv[index + 1] === 'string') { options.executablePath = process.argv[index + 1]; } return browserType.launch(options); }