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: pass JSHandles instead of ObjectId to/from context delegate (#34895)
Yury Semikhatskydbbdabfd1bbe
diff --git a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts b/packages/playwright-core/src/server/bidi/bidiExecutionContext.tsindex c9b1890af9..431e1b9841 100644--- a/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts+++ b/packages/playwright-core/src/server/bidi/bidiExecutionContext.ts@@ -61,7 +61,7 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));}- async rawEvaluateHandle(expression: string): Promise<js.ObjectId> {+ async rawEvaluateHandle(context: js.ExecutionContext, expression: string): Promise<js.JSHandle> {const response = await this._session.send('script.evaluate', {expression,target: this._target,@@ -72,7 +72,7 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {});if (response.type === 'success') {if ('handle' in response.result)- return response.result.handle!;+ return createHandle(context, response.result);throw new js.JavaScriptErrorInEvaluate('Cannot get handle: ' + JSON.stringify(response.result));}if (response.type === 'exception')@@ -80,14 +80,14 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {throw new js.JavaScriptErrorInEvaluate('Unexpected response type: ' + JSON.stringify(response));}- async evaluateWithArguments(functionDeclaration: string, returnByValue: boolean, utilityScript: js.JSHandle<any>, values: any[], objectIds: string[]): Promise<any> {+ async evaluateWithArguments(functionDeclaration: string, returnByValue: boolean, utilityScript: js.JSHandle, values: any[], handles: js.JSHandle[]): Promise<any> {const response = await this._session.send('script.callFunction', {functionDeclaration,target: this._target,arguments: [{ handle: utilityScript._objectId! },...values.map(BidiSerializer.serialize),- ...objectIds.map(handle => ({ handle })),+ ...handles.map(handle => ({ handle: handle._objectId! })),],resultOwnership: returnByValue ? undefined : bidi.Script.ResultOwnership.Root, // Necessary for the handle to be returned.serializationOptions: returnByValue ? {} : { maxObjectDepth: 0, maxDomDepth: 0 },@@ -121,10 +121,12 @@ export class BidiExecutionContext implements js.ExecutionContextDelegate {return map;}- async releaseHandle(objectId: js.ObjectId): Promise<void> {+ async releaseHandle(handle: js.JSHandle): Promise<void> {+ if (!handle._objectId)+ return;await this._session.send('script.disown', {target: this._target,- handles: [objectId],+ handles: [handle._objectId],});}diff --git a/packages/playwright-core/src/server/chromium/crExecutionContext.ts b/packages/playwright-core/src/server/chromium/crExecutionContext.tsindex 4f4c505422..da11f1e686 100644--- a/packages/playwright-core/src/server/chromium/crExecutionContext.ts+++ b/packages/playwright-core/src/server/chromium/crExecutionContext.ts@@ -46,24 +46,24 @@ export class CRExecutionContext implements js.ExecutionContextDelegate {return remoteObject.value;}- async rawEvaluateHandle(expression: string): Promise<js.ObjectId> {+ async rawEvaluateHandle(context: js.ExecutionContext, expression: string): Promise<js.JSHandle> {const { exceptionDetails, result: remoteObject } = await this._client.send('Runtime.evaluate', {expression,contextId: this._contextId,}).catch(rewriteError);if (exceptionDetails)throw new js.JavaScriptErrorInEvaluate(getExceptionMessage(exceptionDetails));- return remoteObject.objectId!;+ return createHandle(context, remoteObject);}- async evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: js.JSHandle<any>, values: any[], objectIds: string[]): Promise<any> {+ async evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: js.JSHandle, values: any[], handles: js.JSHandle[]): Promise<any> {const { exceptionDetails, result: remoteObject } = await this._client.send('Runtime.callFunctionOn', {functionDeclaration: expression,objectId: utilityScript._objectId,arguments: [{ objectId: utilityScript._objectId },...values.map(value => ({ value })),- ...objectIds.map(objectId => ({ objectId })),+ ...handles.map(handle => ({ objectId: handle._objectId! })),],returnByValue,awaitPromise: true,@@ -88,8 +88,10 @@ export class CRExecutionContext implements js.ExecutionContextDelegate {return result;}- async releaseHandle(objectId: js.ObjectId): Promise<void> {- await releaseObject(this._client, objectId);+ async releaseHandle(handle: js.JSHandle): Promise<void> {+ if (!handle._objectId)+ return;+ await releaseObject(this._client, handle._objectId);}}diff --git a/packages/playwright-core/src/server/dom.ts b/packages/playwright-core/src/server/dom.tsindex 3366a1a50d..fbea38b814 100644--- a/packages/playwright-core/src/server/dom.ts+++ b/packages/playwright-core/src/server/dom.ts@@ -105,7 +105,11 @@ export class FrameExecutionContext extends js.ExecutionContext {);})();`;- this._injectedScriptPromise = this.rawEvaluateHandle(source).then(objectId => new js.JSHandle(this, 'object', 'InjectedScript', objectId));+ this._injectedScriptPromise = this.rawEvaluateHandle(source)+ .then(handle => {+ handle._setPreview('InjectedScript');+ return handle;+ });}return this._injectedScriptPromise;}@@ -118,7 +122,7 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {declare readonly _objectId: string;readonly _frame: frames.Frame;- constructor(context: FrameExecutionContext, objectId: js.ObjectId) {+ constructor(context: FrameExecutionContext, objectId: string) {super(context, 'node', undefined, objectId);this._page = context.frame._page;this._frame = context.frame;diff --git a/packages/playwright-core/src/server/firefox/ffExecutionContext.ts b/packages/playwright-core/src/server/firefox/ffExecutionContext.tsindex d0388ae2fe..1b9af6bfaa 100644--- a/packages/playwright-core/src/server/firefox/ffExecutionContext.ts+++ b/packages/playwright-core/src/server/firefox/ffExecutionContext.ts@@ -44,23 +44,23 @@ export class FFExecutionContext implements js.ExecutionContextDelegate {return payload.result!.value;}- async rawEvaluateHandle(expression: string): Promise<js.ObjectId> {+ async rawEvaluateHandle(context: js.ExecutionContext, expression: string): Promise<js.JSHandle> {const payload = await this._session.send('Runtime.evaluate', {expression,returnByValue: false,executionContextId: this._executionContextId,}).catch(rewriteError);checkException(payload.exceptionDetails);- return payload.result!.objectId!;+ return createHandle(context, payload.result!);}- async evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: js.JSHandle<any>, values: any[], objectIds: string[]): Promise<any> {+ async evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: js.JSHandle, values: any[], handles: js.JSHandle[]): Promise<any> {const payload = await this._session.send('Runtime.callFunction', {functionDeclaration: expression,args: [{ objectId: utilityScript._objectId, value: undefined },...values.map(value => ({ value })),- ...objectIds.map(objectId => ({ objectId, value: undefined })),+ ...handles.map(handle => ({ objectId: handle._objectId!, value: undefined })),],returnByValue,executionContextId: this._executionContextId@@ -82,10 +82,12 @@ export class FFExecutionContext implements js.ExecutionContextDelegate {return result;}- async releaseHandle(objectId: js.ObjectId): Promise<void> {+ async releaseHandle(handle: js.JSHandle): Promise<void> {+ if (!handle._objectId)+ return;await this._session.send('Runtime.disposeObject', {executionContextId: this._executionContextId,- objectId+ objectId: handle._objectId,});}}diff --git a/packages/playwright-core/src/server/javascript.ts b/packages/playwright-core/src/server/javascript.tsindex edb0d95bc9..f01cb88bcf 100644--- a/packages/playwright-core/src/server/javascript.ts+++ b/packages/playwright-core/src/server/javascript.ts@@ -23,8 +23,6 @@ import { LongStandingScope } from '../utils/isomorphic/manualPromise';import type * as dom from './dom';import type { UtilityScript } from './injected/utilityScript';-export type ObjectId = string;-interface TaggedAsJSHandle<T> {__jshandle: T;}@@ -49,10 +47,10 @@ export type SmartHandle<T> = T extends Node ? dom.ElementHandle<T> : JSHandle<T>export interface ExecutionContextDelegate {rawEvaluateJSON(expression: string): Promise<any>;- rawEvaluateHandle(expression: string): Promise<ObjectId>;- evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: JSHandle<any>, values: any[], objectIds: ObjectId[]): Promise<any>;+ rawEvaluateHandle(context: ExecutionContext, expression: string): Promise<JSHandle>;+ evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: JSHandle, values: any[], handles: JSHandle[]): Promise<any>;getProperties(object: JSHandle): Promise<Map<string, JSHandle>>;- releaseHandle(objectId: ObjectId): Promise<void>;+ releaseHandle(handle: JSHandle): Promise<void>;}export class ExecutionContext extends SdkObject {@@ -79,21 +77,21 @@ export class ExecutionContext extends SdkObject {return this._raceAgainstContextDestroyed(this.delegate.rawEvaluateJSON(expression));}- rawEvaluateHandle(expression: string): Promise<ObjectId> {- return this._raceAgainstContextDestroyed(this.delegate.rawEvaluateHandle(expression));+ rawEvaluateHandle(expression: string): Promise<JSHandle> {+ return this._raceAgainstContextDestroyed(this.delegate.rawEvaluateHandle(this, expression));}- async evaluateWithArguments(expression: string, returnByValue: boolean, values: any[], objectIds: ObjectId[]): Promise<any> {+ async evaluateWithArguments(expression: string, returnByValue: boolean, values: any[], handles: JSHandle[]): Promise<any> {const utilityScript = await this._utilityScript();- return this._raceAgainstContextDestroyed(this.delegate.evaluateWithArguments(expression, returnByValue, utilityScript, values, objectIds));+ return this._raceAgainstContextDestroyed(this.delegate.evaluateWithArguments(expression, returnByValue, utilityScript, values, handles));}getProperties(object: JSHandle): Promise<Map<string, JSHandle>> {return this._raceAgainstContextDestroyed(this.delegate.getProperties(object));}- releaseHandle(objectId: ObjectId): Promise<void> {- return this.delegate.releaseHandle(objectId);+ releaseHandle(handle: JSHandle): Promise<void> {+ return this.delegate.releaseHandle(handle);}adoptIfNeeded(handle: JSHandle): Promise<JSHandle> | null {@@ -108,7 +106,11 @@ export class ExecutionContext extends SdkObject {${utilityScriptSource.source}return new (module.exports.UtilityScript())(${isUnderTest()});})();`;- this._utilityScriptPromise = this._raceAgainstContextDestroyed(this.delegate.rawEvaluateHandle(source).then(objectId => new JSHandle(this, 'object', 'UtilityScript', objectId)));+ this._utilityScriptPromise = this._raceAgainstContextDestroyed(this.delegate.rawEvaluateHandle(this, source))+ .then(handle => {+ handle._setPreview('UtilityScript');+ return handle;+ });}return this._utilityScriptPromise;}@@ -122,13 +124,13 @@ export class JSHandle<T = any> extends SdkObject {__jshandle: T = true as any;readonly _context: ExecutionContext;_disposed = false;- readonly _objectId: ObjectId | undefined;+ readonly _objectId: string | undefined;readonly _value: any;private _objectType: string;protected _preview: string;private _previewCallback: ((preview: string) => void) | undefined;- constructor(context: ExecutionContext, type: string, preview: string | undefined, objectId?: ObjectId, value?: any) {+ constructor(context: ExecutionContext, type: string, preview: string | undefined, objectId?: string, value?: any) {super(context, 'handle');this._context = context;this._objectId = objectId;@@ -185,7 +187,7 @@ export class JSHandle<T = any> extends SdkObject {if (!this._objectId)return this._value;const script = `(utilityScript, ...args) => utilityScript.jsonValue(...args)`;- return this._context.evaluateWithArguments(script, true, [true], [this._objectId]);+ return this._context.evaluateWithArguments(script, true, [true], [this]);}asElement(): dom.ElementHandle | null {@@ -197,7 +199,7 @@ export class JSHandle<T = any> extends SdkObject {return;this._disposed = true;if (this._objectId) {- this._context.releaseHandle(this._objectId).catch(e => {});+ this._context.releaseHandle(this).catch(e => {});if ((globalThis as any).leakedJSHandles)(globalThis as any).leakedJSHandles.delete(this);}@@ -254,11 +256,11 @@ export async function evaluateExpression(context: ExecutionContext, expression:return { fallThrough: handle };}));- const utilityScriptObjectIds: ObjectId[] = [];+ const utilityScriptObjects: JSHandle[] = [];for (const handle of await Promise.all(handles)) {if (handle._context !== context)throw new JavaScriptErrorInEvaluate('JSHandles can be evaluated only in the context they were created!');- utilityScriptObjectIds.push(handle._objectId!);+ utilityScriptObjects.push(handle);}// See UtilityScript for arguments.@@ -266,7 +268,7 @@ export async function evaluateExpression(context: ExecutionContext, expression:const script = `(utilityScript, ...args) => utilityScript.evaluate(...args)`;try {- return await context.evaluateWithArguments(script, options.returnByValue || false, utilityScriptValues, utilityScriptObjectIds);+ return await context.evaluateWithArguments(script, options.returnByValue || false, utilityScriptValues, utilityScriptObjects);} finally {toDispose.map(handlePromise => handlePromise.then(handle => handle.dispose()));}diff --git a/packages/playwright-core/src/server/webkit/wkExecutionContext.ts b/packages/playwright-core/src/server/webkit/wkExecutionContext.tsindex f9386d3adc..c7533d1ac5 100644--- a/packages/playwright-core/src/server/webkit/wkExecutionContext.ts+++ b/packages/playwright-core/src/server/webkit/wkExecutionContext.ts@@ -48,7 +48,7 @@ export class WKExecutionContext implements js.ExecutionContextDelegate {}}- async rawEvaluateHandle(expression: string): Promise<js.ObjectId> {+ async rawEvaluateHandle(context: js.ExecutionContext, expression: string): Promise<js.JSHandle> {try {const response = await this._session.send('Runtime.evaluate', {expression,@@ -57,13 +57,13 @@ export class WKExecutionContext implements js.ExecutionContextDelegate {});if (response.wasThrown)throw new js.JavaScriptErrorInEvaluate(response.result.description);- return response.result.objectId!;+ return createHandle(context, response.result);} catch (error) {throw rewriteError(error);}}- async evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: js.JSHandle<any>, values: any[], objectIds: string[]): Promise<any> {+ async evaluateWithArguments(expression: string, returnByValue: boolean, utilityScript: js.JSHandle<any>, values: any[], handles: js.JSHandle[]): Promise<any> {try {const response = await this._session.send('Runtime.callFunctionOn', {functionDeclaration: expression,@@ -71,7 +71,7 @@ export class WKExecutionContext implements js.ExecutionContextDelegate {arguments: [{ objectId: utilityScript._objectId },...values.map(value => ({ value })),- ...objectIds.map(objectId => ({ objectId })),+ ...handles.map(handle => ({ objectId: handle._objectId! })),],returnByValue,emulateUserGesture: true,@@ -101,8 +101,10 @@ export class WKExecutionContext implements js.ExecutionContextDelegate {return result;}- async releaseHandle(objectId: js.ObjectId): Promise<void> {- await this._session.send('Runtime.releaseObject', { objectId });+ async releaseHandle(handle: js.JSHandle): Promise<void> {+ if (!handle._objectId)+ return;+ await this._session.send('Runtime.releaseObject', { objectId: handle._objectId });}}