8370ec88ae
This change started as a small change to pull types from DefinitelyTyped over to
Puppeteer for the `evaluateHandle` function but instead ended up also fixing
what looks to be a long standing issue with our existing documentation.
`evaluateHandle` can in fact return an `ElementHandle` rather than a `JSHandle`.
Note that `ElementHandle` extends `JSHandle` so whilst the docs are technically
correct (all ElementHandles are JSHandles) it's confusing because JSHandles
don't have methods like `click` on them, but ElementHandles do.
if you return something that is an HTML element:
```
const button = page.evaluateHandle(() => document.querySelector('button'));
// this is an ElementHandle, not a JSHandle
```
Therefore I've updated the original docs and added a large explanation to the
TSDoc for `page.evaluateHandle`.
In TypeScript land we'll assume the function will return a `JSHandle` but you
can tell TS otherwise via the generic argument, which can only be `JSHandle`
(the default) or `ElementHandle`:
```
const button = page.evaluateHandle<ElementHandle>(() => document.querySelector('button'));
```
274 lines
9.0 KiB
TypeScript
274 lines
9.0 KiB
TypeScript
/**
|
|
* Copyright 2018 Google Inc. All rights reserved.
|
|
*
|
|
* 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 expect from 'expect';
|
|
import {
|
|
getTestState,
|
|
setupTestBrowserHooks,
|
|
setupTestPageAndContextHooks,
|
|
itFailsFirefox,
|
|
} from './mocha-utils';
|
|
|
|
describe('JSHandle', function () {
|
|
setupTestBrowserHooks();
|
|
setupTestPageAndContextHooks();
|
|
|
|
describe('Page.evaluateHandle', function () {
|
|
it('should work', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const windowHandle = await page.evaluateHandle(() => window);
|
|
expect(windowHandle).toBeTruthy();
|
|
});
|
|
it('should accept object handle as an argument', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const navigatorHandle = await page.evaluateHandle(() => navigator);
|
|
const text = await page.evaluate((e) => e.userAgent, navigatorHandle);
|
|
expect(text).toContain('Mozilla');
|
|
});
|
|
it('should accept object handle to primitive types', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => 5);
|
|
const isFive = await page.evaluate((e) => Object.is(e, 5), aHandle);
|
|
expect(isFive).toBeTruthy();
|
|
});
|
|
it('should warn on nested object handles', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => document.body);
|
|
let error = null;
|
|
await page
|
|
// @ts-expect-error we are deliberately passing a bad type here (nested object)
|
|
.evaluateHandle((opts) => opts.elem.querySelector('p'), {
|
|
elem: aHandle,
|
|
})
|
|
.catch((error_) => (error = error_));
|
|
expect(error.message).toContain('Are you passing a nested JSHandle?');
|
|
});
|
|
it('should accept object handle to unserializable value', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => Infinity);
|
|
expect(await page.evaluate((e) => Object.is(e, Infinity), aHandle)).toBe(
|
|
true
|
|
);
|
|
});
|
|
it('should use the same JS wrappers', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => {
|
|
globalThis.FOO = 123;
|
|
return window;
|
|
});
|
|
expect(await page.evaluate((e) => e.FOO, aHandle)).toBe(123);
|
|
});
|
|
it('should work with primitives', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => {
|
|
globalThis.FOO = 123;
|
|
return window;
|
|
});
|
|
expect(await page.evaluate((e) => e.FOO, aHandle)).toBe(123);
|
|
});
|
|
});
|
|
|
|
describe('JSHandle.getProperty', function () {
|
|
it('should work', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => ({
|
|
one: 1,
|
|
two: 2,
|
|
three: 3,
|
|
}));
|
|
const twoHandle = await aHandle.getProperty('two');
|
|
expect(await twoHandle.jsonValue()).toEqual(2);
|
|
});
|
|
});
|
|
|
|
describe('JSHandle.jsonValue', function () {
|
|
it('should work', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => ({ foo: 'bar' }));
|
|
const json = await aHandle.jsonValue();
|
|
expect(json).toEqual({ foo: 'bar' });
|
|
});
|
|
itFailsFirefox('should not work with dates', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const dateHandle = await page.evaluateHandle(
|
|
() => new Date('2017-09-26T00:00:00.000Z')
|
|
);
|
|
const json = await dateHandle.jsonValue();
|
|
expect(json).toEqual({});
|
|
});
|
|
it('should throw for circular objects', async () => {
|
|
const { page, isChrome } = getTestState();
|
|
|
|
const windowHandle = await page.evaluateHandle('window');
|
|
let error = null;
|
|
await windowHandle.jsonValue().catch((error_) => (error = error_));
|
|
if (isChrome)
|
|
expect(error.message).toContain('Object reference chain is too long');
|
|
else expect(error.message).toContain('Object is not serializable');
|
|
});
|
|
});
|
|
|
|
describe('JSHandle.getProperties', function () {
|
|
it('should work', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => ({
|
|
foo: 'bar',
|
|
}));
|
|
const properties = await aHandle.getProperties();
|
|
const foo = properties.get('foo');
|
|
expect(foo).toBeTruthy();
|
|
expect(await foo.jsonValue()).toBe('bar');
|
|
});
|
|
it('should return even non-own properties', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => {
|
|
class A {
|
|
a: string;
|
|
constructor() {
|
|
this.a = '1';
|
|
}
|
|
}
|
|
class B extends A {
|
|
b: string;
|
|
constructor() {
|
|
super();
|
|
this.b = '2';
|
|
}
|
|
}
|
|
return new B();
|
|
});
|
|
const properties = await aHandle.getProperties();
|
|
expect(await properties.get('a').jsonValue()).toBe('1');
|
|
expect(await properties.get('b').jsonValue()).toBe('2');
|
|
});
|
|
});
|
|
|
|
describe('JSHandle.asElement', function () {
|
|
it('should work', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => document.body);
|
|
const element = aHandle.asElement();
|
|
expect(element).toBeTruthy();
|
|
});
|
|
it('should return null for non-elements', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => 2);
|
|
const element = aHandle.asElement();
|
|
expect(element).toBeFalsy();
|
|
});
|
|
it('should return ElementHandle for TextNodes', async () => {
|
|
const { page } = getTestState();
|
|
|
|
await page.setContent('<div>ee!</div>');
|
|
const aHandle = await page.evaluateHandle(
|
|
() => document.querySelector('div').firstChild
|
|
);
|
|
const element = aHandle.asElement();
|
|
expect(element).toBeTruthy();
|
|
expect(
|
|
await page.evaluate((e) => e.nodeType === Node.TEXT_NODE, element)
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('JSHandle.toString', function () {
|
|
it('should work for primitives', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const numberHandle = await page.evaluateHandle(() => 2);
|
|
expect(numberHandle.toString()).toBe('JSHandle:2');
|
|
const stringHandle = await page.evaluateHandle(() => 'a');
|
|
expect(stringHandle.toString()).toBe('JSHandle:a');
|
|
});
|
|
it('should work for complicated objects', async () => {
|
|
const { page } = getTestState();
|
|
|
|
const aHandle = await page.evaluateHandle(() => window);
|
|
expect(aHandle.toString()).toBe('JSHandle@object');
|
|
});
|
|
it('should work with different subtypes', async () => {
|
|
const { page } = getTestState();
|
|
|
|
expect((await page.evaluateHandle('(function(){})')).toString()).toBe(
|
|
'JSHandle@function'
|
|
);
|
|
expect((await page.evaluateHandle('12')).toString()).toBe('JSHandle:12');
|
|
expect((await page.evaluateHandle('true')).toString()).toBe(
|
|
'JSHandle:true'
|
|
);
|
|
expect((await page.evaluateHandle('undefined')).toString()).toBe(
|
|
'JSHandle:undefined'
|
|
);
|
|
expect((await page.evaluateHandle('"foo"')).toString()).toBe(
|
|
'JSHandle:foo'
|
|
);
|
|
expect((await page.evaluateHandle('Symbol()')).toString()).toBe(
|
|
'JSHandle@symbol'
|
|
);
|
|
expect((await page.evaluateHandle('new Map()')).toString()).toBe(
|
|
'JSHandle@map'
|
|
);
|
|
expect((await page.evaluateHandle('new Set()')).toString()).toBe(
|
|
'JSHandle@set'
|
|
);
|
|
expect((await page.evaluateHandle('[]')).toString()).toBe(
|
|
'JSHandle@array'
|
|
);
|
|
expect((await page.evaluateHandle('null')).toString()).toBe(
|
|
'JSHandle:null'
|
|
);
|
|
expect((await page.evaluateHandle('/foo/')).toString()).toBe(
|
|
'JSHandle@regexp'
|
|
);
|
|
expect((await page.evaluateHandle('document.body')).toString()).toBe(
|
|
'JSHandle@node'
|
|
);
|
|
expect((await page.evaluateHandle('new Date()')).toString()).toBe(
|
|
'JSHandle@date'
|
|
);
|
|
expect((await page.evaluateHandle('new WeakMap()')).toString()).toBe(
|
|
'JSHandle@weakmap'
|
|
);
|
|
expect((await page.evaluateHandle('new WeakSet()')).toString()).toBe(
|
|
'JSHandle@weakset'
|
|
);
|
|
expect((await page.evaluateHandle('new Error()')).toString()).toBe(
|
|
'JSHandle@error'
|
|
);
|
|
expect((await page.evaluateHandle('new Int32Array()')).toString()).toBe(
|
|
'JSHandle@typedarray'
|
|
);
|
|
expect((await page.evaluateHandle('new Proxy({}, {})')).toString()).toBe(
|
|
'JSHandle@proxy'
|
|
);
|
|
});
|
|
});
|
|
});
|