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 deserialization of BiDi values (#38587)
Holger Benl8f6fd1b57c3d
diff --git a/packages/playwright-core/src/server/bidi/bidiDeserializer.ts b/packages/playwright-core/src/server/bidi/bidiDeserializer.tsnew file mode 100644index 0000000000..bd09192d65--- /dev/null+++ b/packages/playwright-core/src/server/bidi/bidiDeserializer.ts@@ -0,0 +1,115 @@+/**+ * Copyright (c) Microsoft Corporation.+ *+ * Licensed under the Apache License, Version 2.0 (the 'License');+ * you may not use this file except in compliance with the License.+ * You may obtain a copy of the License at+ *+ * http://www.apache.org/licenses/LICENSE-2.0+ *+ * Unless required by applicable law or agreed to in writing, software+ * distributed under the License is distributed on an 'AS IS' BASIS,+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ * See the License for the specific language governing permissions and+ * limitations under the License.+ */++import * as bidi from './third_party/bidiProtocol';+import { parseUnserializableValue } from '../javascript';++export function deserializeBidiValue(result: bidi.Script.RemoteValue, internalIdMap = new Map<bidi.Script.InternalId, any>()): any {+ switch (result.type) {+ case 'undefined':+ return undefined;+ case 'null':+ return null;+ case 'number':+ return typeof result.value === 'number' ? result.value : parseUnserializableValue(result.value);+ case 'boolean':+ return Boolean(result.value);+ case 'string':+ return result.value;+ case 'bigint':+ return BigInt(result.value);+ case 'array':+ return deserializeBidiList(result, internalIdMap);+ case 'arraybuffer':+ return getValue(result, internalIdMap, () => ({}));+ case 'date':+ return getValue(result, internalIdMap, () => new Date(result.value));+ case 'error':+ return getValue(result, internalIdMap, () => { const error = new Error(); error.stack = ''; return error; });+ case 'function':+ return undefined;+ case 'generator':+ return getValue(result, internalIdMap, () => ({}));+ case 'htmlcollection':+ return { ...deserializeBidiList(result, internalIdMap) };+ case 'map':+ return getValue(result, internalIdMap, () => ({}));+ case 'node':+ return 'ref: <Node>';+ case 'nodelist':+ return { ...deserializeBidiList(result, internalIdMap) };+ case 'object':+ return deserializeBidiMapping(result, internalIdMap);+ case 'promise':+ return getValue(result, internalIdMap, () => ({}));+ case 'proxy':+ return getValue(result, internalIdMap, () => ({}));+ case 'regexp':+ return getValue(result, internalIdMap, () => new RegExp(result.value.pattern, result.value.flags));+ case 'set':+ return getValue(result, internalIdMap, () => ({}));+ case 'symbol':+ return undefined;+ case 'typedarray':+ return undefined;+ case 'weakmap':+ return getValue(result, internalIdMap, () => ({}));+ case 'weakset':+ return getValue(result, internalIdMap, () => ({}));+ case 'window':+ return 'ref: <Window>';+ }+}++function getValue(bidiValue: bidi.Script.RemoteValue, internalIdMap: Map<bidi.Script.InternalId, any>, defaultValue: () => any) {+ if ('internalId' in bidiValue && bidiValue.internalId) {+ if (internalIdMap.has(bidiValue.internalId)) {+ return internalIdMap.get(bidiValue.internalId);+ } else {+ const value = defaultValue();+ internalIdMap.set(bidiValue.internalId, value);+ return value;+ }+ } else {+ return defaultValue();+ }+}++function deserializeBidiList(+ bidiValue: bidi.Script.ArrayRemoteValue | bidi.Script.SetRemoteValue | bidi.Script.NodeListRemoteValue | bidi.Script.HtmlCollectionRemoteValue,+ internalIdMap: Map<bidi.Script.InternalId, any>+) {+ const result = getValue(bidiValue, internalIdMap, () => []);+ for (const val of bidiValue.value || [])+ result.push(deserializeBidiValue(val, internalIdMap));+ return result;+}++function deserializeBidiMapping(+ bidiValue: bidi.Script.ObjectRemoteValue | bidi.Script.MapRemoteValue,+ internalIdMap: Map<bidi.Script.InternalId, any>+) {+ const result = getValue(bidiValue, internalIdMap, () => ({}));+ for (const [serializedKey, serializedValue] of bidiValue.value || []) {+ const key =+ typeof serializedKey === 'string'+ ? serializedKey+ : deserializeBidiValue(serializedKey, internalIdMap);+ const value = deserializeBidiValue(serializedValue, internalIdMap);+ result[key] = value;+ }+ return result;+}diff --git a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts b/packages/playwright-core/src/server/bidi/bidiExecutionContext.tsindex 14b46a3e4a..be222c80bd 100644--- a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts+++ b/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts@@ -18,9 +18,9 @@ import { assert } from '../../utils';import { parseEvaluationResultValue } from '../../utils/isomorphic/utilityScriptSerializers';import * as js from '../javascript';import * as dom from '../dom';-import { BidiDeserializer } from './third_party/bidiDeserializer';import * as bidi from './third_party/bidiProtocol';import { BidiSerializer } from './third_party/bidiSerializer';+import { deserializeBidiValue } from './bidiDeserializer';import type { BidiSession } from './bidiConnection';@@ -55,7 +55,7 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {userActivation: true,});if (response.type === 'success')- return BidiDeserializer.deserialize(response.result);+ return deserializeBidiValue(response.result);if (response.type === 'exception')throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text);throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));@@ -98,7 +98,7 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {throw new js.JavaScriptErrorInEvaluate(response.exceptionDetails.text);if (response.type === 'success') {if (returnByValue)- return parseEvaluationResultValue(BidiDeserializer.deserialize(response.result));+ return parseEvaluationResultValue(deserializeBidiValue(response.result));return createHandle(utilityScript._context, response.result);}throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));@@ -251,18 +251,6 @@ function renderPreview(remoteObject: bidi.Script.RemoteValue, nested = false): s}}-function remoteObjectValue(remoteObject: bidi.Script.RemoteValue): any {- if (remoteObject.type === 'undefined')- return undefined;- if (remoteObject.type === 'null')- return null;- if (remoteObject.type === 'number' && typeof remoteObject.value === 'string')- return js.parseUnserializableValue(remoteObject.value);- if ('value' in remoteObject)- return remoteObject.value;- return undefined;-}-export function createHandle(context: js.ExecutionContext, remoteObject: bidi.Script.RemoteValue): js.JSHandle {if (remoteObject.type === 'node') {assert(context instanceof dom.FrameExecutionContext);@@ -270,7 +258,7 @@ export function createHandle(context: js.ExecutionContext, remoteObject: bidi.Sc}const objectId = 'handle' in remoteObject ? remoteObject.handle : undefined;const preview = renderPreview(remoteObject);- const handle = new js.JSHandle(context, remoteObject.type, preview, objectId, remoteObjectValue(remoteObject));+ const handle = new js.JSHandle(context, remoteObject.type, preview, objectId, deserializeBidiValue(remoteObject));handle._setPreview(preview);return handle;}diff --git a/packages/playwright-core/src/server/bidi/third_party/bidiDeserializer.ts b/packages/playwright-core/src/server/bidi/third_party/bidiDeserializer.tsdeleted file mode 100644index 33ee3e4fda..0000000000--- a/packages/playwright-core/src/server/bidi/third_party/bidiDeserializer.ts+++ /dev/null@@ -1,92 +0,0 @@-/**- * @license- * Copyright 2024 Google Inc.- * Modifications copyright (c) Microsoft Corporation.- * SPDX-License-Identifier: Apache-2.0- */--// Copied from upstream: https://github.com/puppeteer/puppeteer/blob/main/packages/puppeteer-core/src/bidi/Deserializer.ts--import type * as Bidi from './bidiProtocol';--/* eslint-disable object-curly-spacing */--/**- * @internal- */-export class BidiDeserializer {- static deserialize(result: Bidi.Script.RemoteValue): any {- if (!result)- return undefined;-- switch (result.type) {- case 'array':- return result.value?.map(value => {- return BidiDeserializer.deserialize(value);- });- case 'set':- return result.value?.reduce((acc: Set<unknown>, value) => {- return acc.add(BidiDeserializer.deserialize(value));- }, new Set());- case 'object':- return result.value?.reduce((acc: Record<any, unknown>, tuple) => {- const {key, value} = BidiDeserializer._deserializeTuple(tuple);- acc[key as any] = value;- return acc;- }, {});- case 'map':- return result.value?.reduce((acc: Map<unknown, unknown>, tuple) => {- const {key, value} = BidiDeserializer._deserializeTuple(tuple);- return acc.set(key, value);- }, new Map());- case 'promise':- return {};- case 'regexp':- return new RegExp(result.value.pattern, result.value.flags);- case 'date':- return new Date(result.value);- case 'undefined':- return undefined;- case 'null':- return null;- case 'number':- return BidiDeserializer._deserializeNumber(result.value);- case 'bigint':- return BigInt(result.value);- case 'boolean':- return Boolean(result.value);- case 'string':- return result.value;- }-- throw new Error(`Deserialization of type ${result.type} not supported.`);- }-- static _deserializeNumber(value: Bidi.Script.SpecialNumber | number): number {- switch (value) {- case '-0':- return -0;- case 'NaN':- return NaN;- case 'Infinity':- return Infinity;- case '-Infinity':- return -Infinity;- default:- return value;- }- }-- static _deserializeTuple([serializedKey, serializedValue]: [- Bidi.Script.RemoteValue | string,- Bidi.Script.RemoteValue,- ]): {key: unknown; value: unknown} {- const key =- typeof serializedKey === 'string'- ? serializedKey- : BidiDeserializer.deserialize(serializedKey);- const value = BidiDeserializer.deserialize(serializedValue);-- return {key, value};- }-}