chore: expose _evaluateFunction (#36701)

2025-07-16 14:36:31 -07:00 · 2025-07-16 14:36:31 -07:00 · ba6740a842
parent 8e4627826a
commit ba6740a842
6 changed files with 30 additions and 0 deletions
--- a/packages/playwright-core/src/client/frame.ts
+++ b/packages/playwright-core/src/client/frame.ts
@ -199,6 +199,11 @@ export class Frame extends ChannelOwner<channels.FrameChannel> implements api.Fr
    return parseResult(result.value);
  }

+  async _evaluateFunction(functionDeclaration: string) {
+    const result = await this._channel.evaluateExpression({ expression: functionDeclaration, isFunction: true, arg: serializeArgument(undefined) });
+    return parseResult(result.value);
+  }
+
  async _evaluateExposeUtilityScript<R, Arg>(pageFunction: structs.PageFunction<Arg, R>, arg?: Arg): Promise<R> {
    assertMaxArguments(arguments.length, 2);
    const result = await this._channel.evaluateExpression({ expression: String(pageFunction), isFunction: typeof pageFunction === 'function', arg: serializeArgument(arg) });
--- a/packages/playwright-core/src/client/jsHandle.ts
+++ b/packages/playwright-core/src/client/jsHandle.ts
@ -41,6 +41,11 @@ export class JSHandle<T = any> extends ChannelOwner<channels.JSHandleChannel> im
    return parseResult(result.value);
  }

+  async _evaluateFunction(functionDeclaration: string) {
+    const result = await this._channel.evaluateExpression({ expression: functionDeclaration, isFunction: true, arg: serializeArgument(undefined) });
+    return parseResult(result.value);
+  }
+
  async evaluateHandle<R, Arg>(pageFunction: structs.PageFunctionOn<T, Arg, R>, arg?: Arg): Promise<structs.SmartHandle<R>> {
    const result = await this._channel.evaluateExpressionHandle({ expression: String(pageFunction), isFunction: typeof pageFunction === 'function', arg: serializeArgument(arg) });
    return JSHandle.from(result.handle) as any as structs.SmartHandle<R>;
--- a/packages/playwright-core/src/client/locator.ts
+++ b/packages/playwright-core/src/client/locator.ts
@ -128,6 +128,10 @@ export class Locator implements api.Locator {
    return await this._withElement(h => h.evaluate(pageFunction, arg), { title: 'Evaluate', timeout: options?.timeout });
  }

+  async _evaluateFunction(functionDeclaration: string, options?: TimeoutOptions) {
+    return await this._withElement(h => h._evaluateFunction(functionDeclaration), { title: 'Evaluate', timeout: options?.timeout });
+  }
+
  async evaluateAll<R, Arg>(pageFunction: structs.PageFunctionOn<Element[], Arg, R>, arg?: Arg): Promise<R> {
    return await this._frame.$$eval(this._selector, pageFunction, arg);
  }
--- a/packages/playwright-core/src/client/page.ts
+++ b/packages/playwright-core/src/client/page.ts
@ -509,6 +509,10 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
    return await this._mainFrame.evaluate(pageFunction, arg);
  }

+  async _evaluateFunction(functionDeclaration: string) {
+    return this._mainFrame._evaluateFunction(functionDeclaration);
+  }
+
  async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any) {
    const source = await evaluationScript(this._platform, script, arg);
    await this._channel.addInitScript({ source });
--- a/tests/page/locator-evaluate.spec.ts
+++ b/tests/page/locator-evaluate.spec.ts
@ -54,3 +54,10 @@ it('should not throw in case of missing selector for all', async ({ page, server
  const nodesLength = await element.evaluateAll(nodes => nodes.length);
  expect(nodesLength).toBe(0);
 });
+
+it('should allow calling _evaluateFunction', async ({ page }) => {
+  await page.setContent('<html><body><div class="tweet"><div class="like">100</div><div class="retweets">10</div></div></body></html>');
+  const tweet = page.locator('.tweet .like') as any;
+  const content = await tweet._evaluateFunction('node => node.innerText');
+  expect(content).toBe('100');
+});
--- a/tests/page/page-evaluate.spec.ts
+++ b/tests/page/page-evaluate.spec.ts
@ -858,3 +858,8 @@ it('should ignore dangerous object keys', async ({ page }) => {
  const result = await page.evaluate(arg => arg, input);
  expect(result).toEqual({ safeKey: 'safeValue' });
 });
+
+it('should allow calling _evaluateFunction', async ({ page }) => {
+  const result = await (page as any)._evaluateFunction('() => 7 * 3');
+  expect(result).toBe(21);
+});