Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore(bidi): Improve object previews (#38562)
Holger Benled3de0ba9e87
diff --git a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts b/packages/playwright-core/src/server/bidi/bidiExecutionContext.tsindex cef9cbdfa9..80de8dcdf4 100644--- a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts+++ b/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts@@ -187,14 +187,65 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {}}-function renderPreview(remoteObject: bidi.Script.RemoteValue): string | undefined {- if (remoteObject.type === 'undefined')- return 'undefined';- if (remoteObject.type === 'null')- return 'null';- if ('value' in remoteObject)- return String(remoteObject.value);- return `<${remoteObject.type}>`;+function renderPreview(remoteObject: bidi.Script.RemoteValue, nested = false): string {+ switch (remoteObject.type) {+ case 'undefined':+ case 'null':+ return remoteObject.type;+ case 'number':+ case 'boolean':+ case 'string':+ return String(remoteObject.value);+ case 'bigint':+ return `${remoteObject.value}n`;+ case 'date':+ return String(new Date(remoteObject.value));+ case 'regexp':+ return String(new RegExp(remoteObject.value.pattern, remoteObject.value.flags));+ case 'node':+ return remoteObject.value?.localName || 'Node';+ case 'object':+ if (nested)+ return 'Object';+ const tokens = [];+ for (const [name, value] of remoteObject.value || []) {+ if (typeof name === 'string')+ tokens.push(`${name}: ${renderPreview(value, true)}`);+ }+ return `{${tokens.join(', ')}}`;+ case 'array':+ case 'htmlcollection':+ case 'nodelist':+ if (nested || !remoteObject.value)+ return remoteObject.value ? `Array(${remoteObject.value.length})` : 'Array';+ return `[${remoteObject.value.map(v => renderPreview(v, true)).join(', ')}]`;+ case 'map':+ return remoteObject.value ? `Map(${remoteObject.value.length})` : 'Map';+ case 'set':+ return remoteObject.value ? `Set(${remoteObject.value.length})` : 'Set';+ case 'arraybuffer':+ return 'ArrayBuffer';+ case 'error':+ return 'Error';+ case 'function':+ return 'Function';+ case 'generator':+ return 'Generator';+ case 'promise':+ return 'Promise';+ case 'proxy':+ return 'Proxy';+ case 'symbol':+ return 'Symbol()';+ case 'typedarray':+ return 'TypedArray';+ case 'weakmap':+ return 'WeakMap';+ case 'weakset':+ return 'WeakSet';+ case 'window':+ return 'Window';+ }}function remoteObjectValue(remoteObject: bidi.Script.RemoteValue): any {@@ -215,5 +266,8 @@ export function createHandle(context: js.ExecutionContext, remoteObject: bidi.Screturn new dom.ElementHandle(context, remoteObject.handle!);}const objectId = 'handle' in remoteObject ? remoteObject.handle : undefined;- return new js.JSHandle(context, remoteObject.type, renderPreview(remoteObject), objectId, remoteObjectValue(remoteObject));+ const preview = renderPreview(remoteObject);+ const handle = new js.JSHandle(context, remoteObject.type, preview, objectId, remoteObjectValue(remoteObject));+ handle._setPreview(preview);+ return handle;}diff --git a/packages/playwright-core/src/server/bidi/bidiPage.ts b/packages/playwright-core/src/server/bidi/bidiPage.tsindex 4e37488bb5..9304412533 100644--- a/packages/playwright-core/src/server/bidi/bidiPage.ts+++ b/packages/playwright-core/src/server/bidi/bidiPage.ts@@ -287,7 +287,7 @@ export class BidiPage implements PageDelegate {const callFrame = params.stackTrace?.callFrames[0];const location = callFrame ?? { url: '', lineNumber: 1, columnNumber: 1 };- this._page.addConsoleMessage(null, entry.method, entry.args.map(arg => createHandle(context, arg)), location, params.text || undefined);+ this._page.addConsoleMessage(null, entry.method, entry.args.map(arg => createHandle(context, arg)), location);}private async _onFileDialogOpened(params: bidi.Input.FileDialogInfo) {diff --git a/tests/page/jshandle-to-string.spec.ts b/tests/page/jshandle-to-string.spec.tsindex 6b90352bd5..cd3eeb3480 100644--- a/tests/page/jshandle-to-string.spec.ts+++ b/tests/page/jshandle-to-string.spec.ts@@ -24,9 +24,9 @@ it('should work for primitives', async ({ page }) => {expect(stringHandle.toString()).toBe('a');});-it('should work for complicated objects', async ({ page, browserName }) => {+it('should work for complicated objects', async ({ page, browserName, channel }) => {const aHandle = await page.evaluateHandle(() => window);- if (browserName !== 'firefox')+ if (browserName !== 'firefox' || channel?.startsWith('moz-firefox'))expect(aHandle.toString()).toBe('Window');elseexpect(aHandle.toString()).toBe('JSHandle@object');@@ -56,8 +56,12 @@ it('should work for promises', async ({ page }) => {expect(bHandle.toString()).toBe('Promise');});-it('should work with different subtypes @smoke', async ({ page, browserName }) => {- expect((await page.evaluateHandle('(function(){})')).toString()).toContain('function');+it('should work with different subtypes @smoke', async ({ page, browserName, channel }) => {+ const isBiDi = channel?.startsWith('bidi-chrom') || channel?.startsWith('moz-firefox');+ if (!isBiDi)+ expect((await page.evaluateHandle('(function(){})')).toString()).toContain('function');+ else+ expect((await page.evaluateHandle('(function(){})')).toString()).toBe('Function');expect((await page.evaluateHandle('12')).toString()).toBe('12');expect((await page.evaluateHandle('true')).toString()).toBe('true');expect((await page.evaluateHandle('undefined')).toString()).toBe('undefined');@@ -72,12 +76,16 @@ it('should work with different subtypes @smoke', async ({ page, browserName }) =expect((await page.evaluateHandle('new WeakMap()')).toString()).toBe('WeakMap');expect((await page.evaluateHandle('new WeakSet()')).toString()).toBe('WeakSet');expect((await page.evaluateHandle('new Error()')).toString()).toContain('Error');- expect((await page.evaluateHandle('new Proxy({}, {})')).toString()).toBe((browserName === 'chromium') ? 'Proxy(Object)' : 'Proxy');+ expect((await page.evaluateHandle('new Proxy({}, {})')).toString()).toBe((browserName === 'chromium' && !isBiDi) ? 'Proxy(Object)' : 'Proxy');});-it('should work with previewable subtypes', async ({ page, browserName }) => {- it.skip(browserName === 'firefox');+it('should work with previewable subtypes', async ({ page, browserName, channel }) => {+ const isBiDi = channel?.startsWith('bidi-chrom') || channel?.startsWith('moz-firefox');+ it.skip(browserName === 'firefox' && !isBiDi);expect((await page.evaluateHandle('/foo/')).toString()).toBe('/foo/');expect((await page.evaluateHandle('new Date(0)')).toString()).toContain('GMT');- expect((await page.evaluateHandle('new Int32Array()')).toString()).toContain('Int32Array');+ if (!isBiDi)+ expect((await page.evaluateHandle('new Int32Array()')).toString()).toContain('Int32Array');+ else+ expect((await page.evaluateHandle('new Int32Array()')).toString()).toBe('TypedArray');});diff --git a/tests/page/page-event-console.spec.ts b/tests/page/page-event-console.spec.tsindex 4c1e7e5a79..0165017a9f 100644--- a/tests/page/page-event-console.spec.ts+++ b/tests/page/page-event-console.spec.ts@@ -18,14 +18,14 @@import { test as it, expect } from './pageTest';import util from 'util';-it('should work @smoke', async ({ page, browserName }) => {+it('should work @smoke', async ({ page, browserName, channel }) => {let message = null;page.once('console', m => message = m);await Promise.all([page.evaluate(() => console.log('hello', 5, { foo: 'bar' })),page.waitForEvent('console')]);- if (browserName !== 'firefox')+ if (browserName !== 'firefox' || channel?.startsWith('moz-firefox'))expect(message.text()).toEqual('hello 5 {foo: bar}');elseexpect(message.text()).toEqual('hello 5 JSHandle@object');@@ -114,14 +114,14 @@ it('should format the message correctly with time/timeLog/timeEnd', async ({ pagexpect(messages[1].text()).toMatch(/foo time: \d+.\d+ ?ms/);});-it('should not fail for window object', async ({ page, browserName }) => {+it('should not fail for window object', async ({ page, browserName, channel }) => {let message = null;page.once('console', msg => message = msg);await Promise.all([page.evaluate(() => console.error(window)),page.waitForEvent('console')]);- if (browserName !== 'firefox')+ if (browserName !== 'firefox' || channel?.startsWith('moz-firefox'))expect(message.text()).toEqual('Window');elseexpect(message.text()).toEqual('JSHandle@object');@@ -178,14 +178,14 @@ it('should not throw when there are console messages in detached iframes', asyncexpect(await popup.evaluate('1 + 1')).toBe(2);});-it('should use object previews for arrays and objects', async ({ page, browserName }) => {+it('should use object previews for arrays and objects', async ({ page, browserName, channel }) => {let text: string;page.on('console', message => {text = message.text();});await page.evaluate(() => console.log([1, 2, 3], { a: 1 }, window));- if (browserName !== 'firefox')+ if (browserName !== 'firefox' || channel?.startsWith('moz-firefox'))expect(text).toEqual('[1, 2, 3] {a: 1} Window');elseexpect(text).toEqual('Array JSHandle@object JSHandle@object');@@ -197,14 +197,12 @@ it('should use object previews for errors', async ({ page, browserName, channeltext = message.text();});await page.evaluate(() => console.log(new Error('Exception')));- if (channel?.startsWith('bidi-chrom'))- expect(text).toEqual('error');+ if (channel?.startsWith('bidi-chrom') || browserName === 'firefox')+ expect(text).toEqual('Error');else if (browserName === 'chromium')expect(text).toContain('.evaluate');- else if (browserName === 'webkit' || channel?.startsWith('moz-firefox'))+ else if (browserName === 'webkit')expect(text).toEqual('Error: Exception');- else if (browserName === 'firefox')- expect(text).toEqual('Error');});it('do not update console count on unhandled rejections', async ({ page }) => {