Merge branch 'master' into es2021

This commit is contained in:
Daniel Imms
2023-09-03 07:20:20 -07:00
committed by GitHub
32 changed files with 3815 additions and 3230 deletions
-96
View File
@@ -1,96 +0,0 @@
/**
* Copyright (c) 2017 The xterm.js authors. All rights reserved.
* @license MIT
*/
import { pollFor, openTerminal, launchBrowser } from './TestUtils';
import { Browser, Page } from 'playwright';
const APP = 'http://127.0.0.1:3001/test';
let browser: Browser;
let page: Page;
const width = 800;
const height = 600;
describe('CharWidth Integration Tests', function(): void {
before(async function(): Promise<any> {
browser = await launchBrowser();
page = await (await browser.newContext()).newPage();
await page.setViewportSize({ width, height });
await page.goto(APP);
await openTerminal(page, { rows: 5, cols: 30 });
});
after(() => {
browser.close();
});
describe('getStringCellWidth', () => {
beforeEach(async () => {
await page.evaluate(`window.term.reset()`);
});
it('ASCII chars', async function(): Promise<void> {
const input = 'This is just ASCII text.#';
await page.evaluate(`window.term.write('${input}')`);
await pollFor(page, () => sumWidths(0, 1, '#'), 25);
});
it('combining chars', async function(): Promise<void> {
const input = 'e\u0301e\u0301e\u0301e\u0301e\u0301e\u0301e\u0301e\u0301e\u0301#';
await page.evaluate(`window.term.write('${input}')`);
await pollFor(page, () => sumWidths(0, 1, '#'), 10);
});
it('surrogate chars', async function(): Promise<void> {
const input = '𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞𝄞#';
await page.evaluate(`window.term.write('${input}')`);
await pollFor(page, () => sumWidths(0, 1, '#'), 28);
});
it('surrogate combining chars', async function(): Promise<void> {
const input = '𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301𓂀\u0301#';
await page.evaluate(`window.term.write('${input}')`);
await pollFor(page, () => sumWidths(0, 1, '#'), 12);
});
it('fullwidth chars', async function(): Promise<void> {
const input = '1234567890#';
await page.evaluate(`window.term.write('${input}')`);
await pollFor(page, () => sumWidths(0, 1, '#'), 21);
});
it('fullwidth chars offset 1', async function(): Promise<void> {
const input = 'a1234567890#';
await page.evaluate(`window.term.write('${input}')`);
await pollFor(page, () => sumWidths(0, 1, '#'), 22);
});
// TODO: multiline tests once #1685 is resolved
});
});
async function sumWidths(start: number, end: number, sentinel: string): Promise<number> {
await page.evaluate(`
(function() {
window.result = 0;
const buffer = window.term.buffer.active;
for (let i = ${start}; i < ${end}; i++) {
const line = buffer.getLine(i);
let j = 0;
while (true) {
const cell = line.getCell(j++);
if (!cell) {
break;
}
window.result += cell.getWidth();
if (cell.getChars() === '${sentinel}') {
return;
}
}
}
})();
`);
return await page.evaluate(`window.result`);
}
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
-213
View File
@@ -1,213 +0,0 @@
/**
* Copyright (c) 2019 The xterm.js authors. All rights reserved.
* @license MIT
*/
import { assert } from 'chai';
import { writeSync, openTerminal, launchBrowser } from './TestUtils';
import { Browser, Page } from 'playwright';
const APP = 'http://127.0.0.1:3001/test';
let browser: Browser;
let page: Page;
const width = 800;
const height = 600;
describe('Parser Integration Tests', function (): void {
before(async function (): Promise<any> {
browser = await launchBrowser();
page = await (await browser.newContext()).newPage();
await page.setViewportSize({ width, height });
await page.goto(APP);
await openTerminal(page);
});
after(async () => browser.close());
describe('registerCsiHandler', () => {
it('should call custom CSI handler with js array params', async () => {
await page.evaluate(`
window.term.reset();
window._customCsiHandlerParams = [];
const _customCsiHandler = window.term.parser.registerCsiHandler({final: 'm'}, (params, collect) => {
window._customCsiHandlerParams.push(params);
return false;
}, '');
`);
await writeSync(page, '\x1b[38;5;123mparams\x1b[38:2::50:100:150msubparams');
assert.deepEqual(await page.evaluate(`window._customCsiHandlerParams`), [
[38, 5, 123],
[38, [2, -1, 50, 100, 150]]
]);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customCsiHandlerCallStack = [];
const _customCsiHandlerA = window.term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, params => {
window._customCsiHandlerCallStack.push(['A', params]);
return false;
});
const _customCsiHandlerB = window.term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, async params => {
await new Promise(res => setTimeout(res, 50));
window._customCsiHandlerCallStack.push(['B', params]);
return false;
});
const _customCsiHandlerC = window.term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, params => {
window._customCsiHandlerCallStack.push(['C', params]);
return false;
});
`);
await writeSync(page, '\x1b[1;2+Z');
assert.deepEqual(await page.evaluate(`window._customCsiHandlerCallStack`), [
['C', [1, 2]],
['B', [1, 2]],
['A', [1, 2]]
]);
});
});
describe('registerDcsHandler', () => {
it('should respects return value', async () => {
await page.evaluate(`
window.term.reset();
window._customDcsHandlerCallStack = [];
const _customDcsHandlerA = window.term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window._customDcsHandlerCallStack.push(['A', params, data]);
return false;
});
const _customDcsHandlerB = window.term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window._customDcsHandlerCallStack.push(['B', params, data]);
return true;
});
const _customDcsHandlerC = window.term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window._customDcsHandlerCallStack.push(['C', params, data]);
return false;
});
`);
await writeSync(page, '\x1bP1;2+psome data\x1b\\\\');
assert.deepEqual(await page.evaluate(`window._customDcsHandlerCallStack`), [
['C', [1, 2], 'some data'],
['B', [1, 2], 'some data']
]);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customDcsHandlerCallStack = [];
const _customDcsHandlerA = window.term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, (data, params) => {
window._customDcsHandlerCallStack.push(['A', params, data]);
return false;
});
const _customDcsHandlerB = window.term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, async (data, params) => {
await new Promise(res => setTimeout(res, 50));
window._customDcsHandlerCallStack.push(['B', params, data]);
return false;
});
const _customDcsHandlerC = window.term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, (data, params) => {
window._customDcsHandlerCallStack.push(['C', params, data]);
return false;
});
`);
await writeSync(page, '\x1bP1;2+qsome data\x1b\\\\');
assert.deepEqual(await page.evaluate(`window._customDcsHandlerCallStack`), [
['C', [1, 2], 'some data'],
['B', [1, 2], 'some data'],
['A', [1, 2], 'some data']
]);
});
});
describe('registerEscHandler', () => {
it('should respects return value', async () => {
await page.evaluate(`
window.term.reset();
window._customEscHandlerCallStack = [];
const _customEscHandlerA = window.term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window._customEscHandlerCallStack.push('A');
return false;
});
const _customEscHandlerB = window.term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window._customEscHandlerCallStack.push('B');
return true;
});
const _customEscHandlerC = window.term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window._customEscHandlerCallStack.push('C');
return false;
});
`);
await writeSync(page, '\x1b(B');
assert.deepEqual(await page.evaluate(`window._customEscHandlerCallStack`), ['C', 'B']);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customEscHandlerCallStack = [];
const _customEscHandlerA = window.term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, () => {
window._customEscHandlerCallStack.push('A');
return false;
});
const _customEscHandlerB = window.term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, async () => {
await new Promise(res => setTimeout(res, 50));
window._customEscHandlerCallStack.push('B');
return false;
});
const _customEscHandlerC = window.term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, () => {
window._customEscHandlerCallStack.push('C');
return false;
});
`);
await writeSync(page, '\x1b(Z');
assert.deepEqual(await page.evaluate(`window._customEscHandlerCallStack`), ['C', 'B', 'A']);
});
});
describe('registerOscHandler', () => {
it('should respects return value', async () => {
await page.evaluate(`
window.term.reset();
window._customOscHandlerCallStack = [];
const _customOscHandlerA = window.term.parser.registerOscHandler(1234, data => {
window._customOscHandlerCallStack.push(['A', data]);
return false;
});
const _customOscHandlerB = window.term.parser.registerOscHandler(1234, data => {
window._customOscHandlerCallStack.push(['B', data]);
return true;
});
const _customOscHandlerC = window.term.parser.registerOscHandler(1234, data => {
window._customOscHandlerCallStack.push(['C', data]);
return false;
});
`);
await writeSync(page, '\x1b]1234;some data\x07');
assert.deepEqual(await page.evaluate(`window._customOscHandlerCallStack`), [
['C', 'some data'],
['B', 'some data']
]);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customOscHandlerCallStack = [];
const _customOscHandlerA = window.term.parser.registerOscHandler(666, data => {
window._customOscHandlerCallStack.push(['A', data]);
return false;
});
const _customOscHandlerB = window.term.parser.registerOscHandler(666, async data => {
await new Promise(res => setTimeout(res, 50));
window._customOscHandlerCallStack.push(['B', data]);
return false;
});
const _customOscHandlerC = window.term.parser.registerOscHandler(666, data => {
window._customOscHandlerCallStack.push(['C', data]);
return false;
});
`);
await writeSync(page, '\x1b]666;some data\x07');
assert.deepEqual(await page.evaluate(`window._customOscHandlerCallStack`), [
['C', 'some data'],
['B', 'some data'],
['A', 'some data']
]);
});
});
});
+1
View File
@@ -0,0 +1 @@
This project contains helpers for the legacy playwright tests. Currently addons use this as a dependency, when all addons have moved over to use `@playright/test` this can be removed.
File diff suppressed because it is too large Load Diff
+2 -2
View File
@@ -3,10 +3,10 @@
* @license MIT
*/
import * as playwright from 'playwright';
import * as playwright from '@playwright/test';
import deepEqual = require('deep-equal');
import { ITerminalInitOnlyOptions, ITerminalOptions } from 'xterm';
import { deepStrictEqual, fail } from 'assert';
import { deepStrictEqual } from 'assert';
export async function pollFor<T>(page: playwright.Page, evalOrFn: string | (() => Promise<T>), val: T, preFn?: () => Promise<void>, maxDuration?: number): Promise<void> {
if (preFn) {