Skip to content

Commit

Permalink
feat(executioncontext): warn on nested js handle (#3591)
Browse files Browse the repository at this point in the history
ExecutionContext.evaluateHandle accepts arguments that are either
serializable, or JSHandles. A potential confusion is that it *does not*
accept arguments that *contain* JSHandles.

This patch adds a log message warning when it encounters that situation.

Fixes #3562
  • Loading branch information
bgschiller authored and aslushnikov committed Jan 14, 2019
1 parent d346cb5 commit 7fabf32
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 9 deletions.
25 changes: 16 additions & 9 deletions lib/ExecutionContext.js
Expand Up @@ -111,15 +111,22 @@ class ExecutionContext {
throw new Error('Passed function is not well-serializable!');
}
}

const { exceptionDetails, result: remoteObject } = await this._client.send('Runtime.callFunctionOn', {
functionDeclaration: functionText + '\n' + suffix + '\n',
executionContextId: this._contextId,
arguments: args.map(convertArgument.bind(this)),
returnByValue: false,
awaitPromise: true,
userGesture: true
}).catch(rewriteError);
let callFunctionOnPromise;
try {
callFunctionOnPromise = this._client.send('Runtime.callFunctionOn', {
functionDeclaration: functionText + '\n' + suffix + '\n',
executionContextId: this._contextId,
arguments: args.map(convertArgument.bind(this)),
returnByValue: false,
awaitPromise: true,
userGesture: true
});
} catch (err) {
if (err instanceof TypeError && err.message === 'Converting circular structure to JSON')
err.message += ' Are you passing a nested JSHandle?';
throw err;
}
const { exceptionDetails, result: remoteObject } = await callFunctionOnPromise.catch(rewriteError);
if (exceptionDetails)
throw new Error('Evaluation failed: ' + helper.getExceptionMessage(exceptionDetails));
return createJSHandle(this, remoteObject);
Expand Down
9 changes: 9 additions & 0 deletions test/jshandle.spec.js
Expand Up @@ -34,6 +34,15 @@ module.exports.addTests = function({testRunner, expect}) {
const isFive = await page.evaluate(e => Object.is(e, 5), aHandle);
expect(isFive).toBeTruthy();
});
it('should warn on nested object handles', async({page, server}) => {
const aHandle = await page.evaluateHandle(() => document.body);
let error = null;
await page.evaluateHandle(
opts => opts.elem.querySelector('p'),
{ elem: aHandle }
).catch(e => error = e);
expect(error.message).toContain('Are you passing a nested JSHandle?');
});
});

describe('JSHandle.getProperty', function() {
Expand Down

0 comments on commit 7fabf32

Please sign in to comment.