feat: implement detailed errors for evaluation (#10114)

docs/api/index.md

@@ -128,7 +128,6 @@ sidebar_label: API
 | [defaultArgs](./puppeteer.defaultargs.md)                                                     |                                                                                                                               |
 | [devices](./puppeteer.devices.md)                                                             |                                                                                                                               |
 | [errors](./puppeteer.errors.md)                                                               |                                                                                                                               |
-| [EVALUATION_SCRIPT_URL](./puppeteer.evaluation_script_url.md)                                 |                                                                                                                               |
 | [executablePath](./puppeteer.executablepath.md)                                               |                                                                                                                               |
 | [KnownDevices](./puppeteer.knowndevices.md)                                                   | A list of devices to be used with [Page.emulate()](./puppeteer.page.emulate.md).                                              |
 | [launch](./puppeteer.launch.md)                                                               |                                                                                                                               |

packages/puppeteer-core/src/common/Coverage.ts

@@ -19,9 +19,13 @@ import {Protocol} from 'devtools-protocol';
 import {assert} from '../util/assert.js';
 
 import {CDPSession} from './Connection.js';
-import {EVALUATION_SCRIPT_URL} from './ExecutionContext.js';
-import {addEventListener, debugError, PuppeteerEventListener} from './util.js';
-import {removeEventListeners} from './util.js';
+import {
+  addEventListener,
+  debugError,
+  PuppeteerEventListener,
+  PuppeteerURL,
+  removeEventListeners,
+} from './util.js';
 
 /**
  * @internal
@@ -264,7 +268,7 @@ export class JSCoverage {
     event: Protocol.Debugger.ScriptParsedEvent
   ): Promise<void> {
     // Ignore puppeteer-injected scripts
-    if (event.url === EVALUATION_SCRIPT_URL) {
+    if (PuppeteerURL.isPuppeteerURL(event.url)) {
       return;
     }
     // Ignore other anonymous scripts unless the reportAnonymousScripts option is true.

packages/puppeteer-core/src/common/ElementHandle.ts

@@ -41,7 +41,7 @@ import {LazyArg} from './LazyArg.js';
 import {CDPPage} from './Page.js';
 import {ElementFor, EvaluateFuncWith, HandleFor, NodeFor} from './types.js';
 import {KeyInput} from './USKeyboardLayout.js';
-import {debugError, isString} from './util.js';
+import {debugError, isString, withSourcePuppeteerURLIfNone} from './util.js';
 
 const applyOffsetsToQuad = (
   quad: Point[],
@@ -138,6 +138,7 @@ export class CDPElementHandle<
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$eval.name, pageFunction);
     const elementHandle = await this.$(selector);
     if (!elementHandle) {
       throw new Error(
@@ -161,6 +162,7 @@ export class CDPElementHandle<
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$$eval.name, pageFunction);
     const results = await this.$$(selector);
     const elements = await this.evaluateHandle((_, ...elements) => {
       return elements;

packages/puppeteer-core/src/common/ExecutionContext.ts

@@ -32,18 +32,20 @@ import {LazyArg} from './LazyArg.js';
 import {scriptInjector} from './ScriptInjector.js';
 import {EvaluateFunc, HandleFor} from './types.js';
 import {
+  PuppeteerURL,
+  createEvaluationError,
   createJSHandle,
-  getExceptionMessage,
+  getSourcePuppeteerURLIfAvailable,
   isString,
   valueFromRemoteObject,
 } from './util.js';
 
-/**
- * @public
- */
-export const EVALUATION_SCRIPT_URL = 'pptr://__puppeteer_evaluation_script__';
 const SOURCE_URL_REGEX = /^[\040\t]*\/\/[@#] sourceURL=\s*(\S*?)\s*$/m;
 
+const getSourceUrlComment = (url: string) => {
+  return `//# sourceURL=${url}`;
+};
+
 /**
  * Represents a context for JavaScript execution.
  *
@@ -270,14 +272,17 @@ export class ExecutionContext {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<HandleFor<Awaited<ReturnType<Func>>> | Awaited<ReturnType<Func>>> {
-    const suffix = `//# sourceURL=${EVALUATION_SCRIPT_URL}`;
+    const sourceUrlComment = getSourceUrlComment(
+      getSourcePuppeteerURLIfAvailable(pageFunction)?.toString() ??
+        PuppeteerURL.INTERNAL_URL
+    );
 
     if (isString(pageFunction)) {
       const contextId = this._contextId;
       const expression = pageFunction;
       const expressionWithSourceUrl = SOURCE_URL_REGEX.test(expression)
         ? expression
-        : expression + '\n' + suffix;
+        : `${expression}\n${sourceUrlComment}\n`;
 
       const {exceptionDetails, result: remoteObject} = await this._client
         .send('Runtime.evaluate', {
@@ -290,20 +295,24 @@ export class ExecutionContext {
         .catch(rewriteError);
 
       if (exceptionDetails) {
-        throw new Error(
-          'Evaluation failed: ' + getExceptionMessage(exceptionDetails)
-        );
+        throw createEvaluationError(exceptionDetails);
       }
 
       return returnByValue
         ? valueFromRemoteObject(remoteObject)
         : createJSHandle(this, remoteObject);
     }
 
+    const functionDeclaration = stringifyFunction(pageFunction);
+    const functionDeclarationWithSourceUrl = SOURCE_URL_REGEX.test(
+      functionDeclaration
+    )
+      ? functionDeclaration
+      : `${functionDeclaration}\n${sourceUrlComment}\n`;
     let callFunctionOnPromise;
     try {
       callFunctionOnPromise = this._client.send('Runtime.callFunctionOn', {
-        functionDeclaration: `${stringifyFunction(pageFunction)}\n${suffix}\n`,
+        functionDeclaration: functionDeclarationWithSourceUrl,
         executionContextId: this._contextId,
         arguments: await Promise.all(args.map(convertArgument.bind(this))),
         returnByValue,
@@ -322,9 +331,7 @@ export class ExecutionContext {
     const {exceptionDetails, result: remoteObject} =
       await callFunctionOnPromise.catch(rewriteError);
     if (exceptionDetails) {
-      throw new Error(
-        'Evaluation failed: ' + getExceptionMessage(exceptionDetails)
-      );
+      throw createEvaluationError(exceptionDetails);
     }
     return returnByValue
       ? valueFromRemoteObject(remoteObject)

packages/puppeteer-core/src/common/Frame.ts

@@ -39,7 +39,7 @@ import {MAIN_WORLD, PUPPETEER_WORLD} from './IsolatedWorlds.js';
 import {LazyArg} from './LazyArg.js';
 import {LifecycleWatcher, PuppeteerLifeCycleEvent} from './LifecycleWatcher.js';
 import {EvaluateFunc, EvaluateFuncWith, HandleFor, NodeFor} from './types.js';
-import {importFSPromises} from './util.js';
+import {importFSPromises, withSourcePuppeteerURLIfNone} from './util.js';
 
 /**
  * @public
@@ -459,6 +459,10 @@ export class Frame {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluateHandle.name,
+      pageFunction
+    );
     return this.worlds[MAIN_WORLD].evaluateHandle(pageFunction, ...args);
   }
 
@@ -475,6 +479,10 @@ export class Frame {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluate.name,
+      pageFunction
+    );
     return this.worlds[MAIN_WORLD].evaluate(pageFunction, ...args);
   }
 
@@ -536,6 +544,7 @@ export class Frame {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$eval.name, pageFunction);
     return this.worlds[MAIN_WORLD].$eval(selector, pageFunction, ...args);
   }
 
@@ -571,6 +580,7 @@ export class Frame {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$$eval.name, pageFunction);
     return this.worlds[MAIN_WORLD].$$eval(selector, pageFunction, ...args);
   }
 

packages/puppeteer-core/src/common/FrameManager.ts

@@ -23,15 +23,15 @@ import {isErrorLike} from '../util/ErrorLike.js';
 import {CDPSession, isTargetClosedError} from './Connection.js';
 import {DeviceRequestPromptManager} from './DeviceRequestPrompt.js';
 import {EventEmitter} from './EventEmitter.js';
-import {EVALUATION_SCRIPT_URL, ExecutionContext} from './ExecutionContext.js';
+import {ExecutionContext} from './ExecutionContext.js';
 import {Frame} from './Frame.js';
 import {FrameTree} from './FrameTree.js';
 import {IsolatedWorld} from './IsolatedWorld.js';
 import {MAIN_WORLD, PUPPETEER_WORLD} from './IsolatedWorlds.js';
 import {NetworkManager} from './NetworkManager.js';
 import {Target} from './Target.js';
 import {TimeoutSettings} from './TimeoutSettings.js';
-import {debugError} from './util.js';
+import {debugError, PuppeteerURL} from './util.js';
 
 const UTILITY_WORLD_NAME = '__puppeteer_utility_world__';
 
@@ -349,7 +349,7 @@ export class FrameManager extends EventEmitter {
     }
 
     await session.send('Page.addScriptToEvaluateOnNewDocument', {
-      source: `//# sourceURL=${EVALUATION_SCRIPT_URL}`,
+      source: `//# sourceURL=${PuppeteerURL.INTERNAL_URL}`,
       worldName: name,
     });
 

packages/puppeteer-core/src/common/IsolatedWorld.ts

@@ -42,6 +42,7 @@ import {
   createJSHandle,
   debugError,
   setPageContent,
+  withSourcePuppeteerURLIfNone,
 } from './util.js';
 import {TaskManager, WaitTask} from './WaitTask.js';
 
@@ -183,6 +184,10 @@ export class IsolatedWorld {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluateHandle.name,
+      pageFunction
+    );
     const context = await this.executionContext();
     return context.evaluateHandle(pageFunction, ...args);
   }
@@ -194,6 +199,10 @@ export class IsolatedWorld {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluate.name,
+      pageFunction
+    );
     const context = await this.executionContext();
     return context.evaluate(pageFunction, ...args);
   }
@@ -240,6 +249,7 @@ export class IsolatedWorld {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$eval.name, pageFunction);
     const document = await this.document();
     return document.$eval(selector, pageFunction, ...args);
   }
@@ -256,6 +266,7 @@ export class IsolatedWorld {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$$eval.name, pageFunction);
     const document = await this.document();
     return document.$$eval(selector, pageFunction, ...args);
   }

packages/puppeteer-core/src/common/JSHandle.ts

@@ -23,7 +23,12 @@ import {CDPSession} from './Connection.js';
 import type {CDPElementHandle} from './ElementHandle.js';
 import {ExecutionContext} from './ExecutionContext.js';
 import {EvaluateFuncWith, HandleFor, HandleOr} from './types.js';
-import {createJSHandle, releaseObject, valueFromRemoteObject} from './util.js';
+import {
+  createJSHandle,
+  releaseObject,
+  valueFromRemoteObject,
+  withSourcePuppeteerURLIfNone,
+} from './util.js';
 
 declare const __JSHandleSymbol: unique symbol;
 
@@ -71,6 +76,10 @@ export class CDPJSHandle<T = unknown> extends JSHandle<T> {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluate.name,
+      pageFunction
+    );
     return await this.executionContext().evaluate(pageFunction, this, ...args);
   }
 
@@ -84,6 +93,10 @@ export class CDPJSHandle<T = unknown> extends JSHandle<T> {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluateHandle.name,
+      pageFunction
+    );
     return await this.executionContext().evaluateHandle(
       pageFunction,
       this,

packages/puppeteer-core/src/common/Page.ts

@@ -85,10 +85,10 @@ import {
   NodeFor,
 } from './types.js';
 import {
+  createClientError,
   createJSHandle,
   debugError,
   evaluationString,
-  getExceptionMessage,
   getReadableAsBuffer,
   getReadableFromProtocolStream,
   isString,
@@ -97,6 +97,7 @@ import {
   valueFromRemoteObject,
   waitForEvent,
   waitWithTimeout,
+  withSourcePuppeteerURLIfNone,
 } from './util.js';
 import {WebWorker} from './WebWorker.js';
 
@@ -518,6 +519,10 @@ export class CDPPage extends Page {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluateHandle.name,
+      pageFunction
+    );
     const context = await this.mainFrame().executionContext();
     return context.evaluateHandle(pageFunction, ...args);
   }
@@ -549,6 +554,7 @@ export class CDPPage extends Page {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$eval.name, pageFunction);
     return this.mainFrame().$eval(selector, pageFunction, ...args);
   }
 
@@ -564,6 +570,7 @@ export class CDPPage extends Page {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(this.$$eval.name, pageFunction);
     return this.mainFrame().$$eval(selector, pageFunction, ...args);
   }
 
@@ -735,10 +742,7 @@ export class CDPPage extends Page {
   }
 
   #handleException(exceptionDetails: Protocol.Runtime.ExceptionDetails): void {
-    const message = getExceptionMessage(exceptionDetails);
-    const err = new Error(message);
-    err.stack = ''; // Don't report clientside error with a node stack attached
-    this.emit(PageEmittedEvents.PageError, err);
+    this.emit(PageEmittedEvents.PageError, createClientError(exceptionDetails));
   }
 
   async #onConsoleAPI(
@@ -1257,6 +1261,10 @@ export class CDPPage extends Page {
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>> {
+    pageFunction = withSourcePuppeteerURLIfNone(
+      this.evaluate.name,
+      pageFunction
+    );
     return this.#frameManager.mainFrame().evaluate(pageFunction, ...args);
   }