/** * 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, itFailsFirefox, setupTestBrowserHooks, setupTestPageAndContextHooks, shortWaitForArrayToHaveAtLeastNElements, } from './mocha-utils.js'; describe('JSHandle', function () { setupTestBrowserHooks(); setupTestPageAndContextHooks(); describe('Page.evaluateHandle', function () { it('should work', async () => { const {page} = getTestState(); const windowHandle = await page.evaluateHandle(() => { return window; }); expect(windowHandle).toBeTruthy(); }); it('should return the RemoteObject', async () => { const {page} = getTestState(); const windowHandle = await page.evaluateHandle(() => { return window; }); expect(windowHandle.remoteObject()).toBeTruthy(); }); it('should accept object handle as an argument', async () => { const {page} = getTestState(); const navigatorHandle = await page.evaluateHandle(() => { return navigator; }); const text = await page.evaluate(e => { return e.userAgent; }, navigatorHandle); expect(text).toContain('Mozilla'); }); it('should accept object handle to primitive types', async () => { const {page} = getTestState(); const aHandle = await page.evaluateHandle(() => { return 5; }); const isFive = await page.evaluate(e => { return Object.is(e, 5); }, aHandle); expect(isFive).toBeTruthy(); }); it('should warn about recursive objects', async () => { const {page} = getTestState(); const test: {obj?: unknown} = {}; test.obj = test; let error!: Error; await page .evaluateHandle( opts => { // @ts-expect-error we are deliberately passing a bad type here // (nested object) return opts.elem; }, {test} ) .catch(error_ => { return (error = error_); }); expect(error.message).toContain('Recursive objects are not allowed.'); }); it('should accept object handle to unserializable value', async () => { const {page} = getTestState(); const aHandle = await page.evaluateHandle(() => { return Infinity; }); expect( await page.evaluate(e => { return Object.is(e, Infinity); }, aHandle) ).toBe(true); }); it('should use the same JS wrappers', async () => { const {page} = getTestState(); const aHandle = await page.evaluateHandle(() => { (globalThis as any).FOO = 123; return window; }); expect( await page.evaluate(e => { return (e as any).FOO; }, aHandle) ).toBe(123); }); }); describe('JSHandle.getProperty', function () { it('should work', async () => { const {page} = getTestState(); const aHandle = await page.evaluateHandle(() => { return { 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(() => { return {foo: 'bar'}; }); const json = await aHandle.jsonValue>(); expect(json).toEqual({foo: 'bar'}); }); it('works with jsonValues that are not objects', async () => { const {page} = getTestState(); const aHandle = await page.evaluateHandle(() => { return ['a', 'b']; }); const json = await aHandle.jsonValue(); expect(json).toEqual(['a', 'b']); }); it('works with jsonValues that are primitives', async () => { const {page} = getTestState(); const aHandle = await page.evaluateHandle(() => { return 'foo'; }); const json = await aHandle.jsonValue(); expect(json).toEqual('foo'); }); itFailsFirefox('should not work with dates', async () => { const {page} = getTestState(); const dateHandle = await page.evaluateHandle(() => { return 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!: Error; await windowHandle.jsonValue().catch(error_ => { return (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(() => { return { 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(() => { return 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(() => { return 2; }); const element = aHandle.asElement(); expect(element).toBeFalsy(); }); it('should return ElementHandle for TextNodes', async () => { const {page} = getTestState(); await page.setContent('
ee!
'); const aHandle = await page.evaluateHandle(() => { return document.querySelector('div')!.firstChild; }); const element = aHandle.asElement(); expect(element).toBeTruthy(); expect( await page.evaluate(e => { return e?.nodeType === Node.TEXT_NODE; }, element) ); }); }); describe('JSHandle.toString', function () { it('should work for primitives', async () => { const {page} = getTestState(); const numberHandle = await page.evaluateHandle(() => { return 2; }); expect(numberHandle.toString()).toBe('JSHandle:2'); const stringHandle = await page.evaluateHandle(() => { return 'a'; }); expect(stringHandle.toString()).toBe('JSHandle:a'); }); it('should work for complicated objects', async () => { const {page} = getTestState(); const aHandle = await page.evaluateHandle(() => { return 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' ); }); }); describe('JSHandle.clickablePoint', function () { it('should work', async () => { const {page} = getTestState(); await page.evaluate(() => { document.body.style.padding = '0'; document.body.style.margin = '0'; document.body.innerHTML = `
`; }); await page.evaluate(async () => { return new Promise(resolve => { return window.requestAnimationFrame(resolve); }); }); const divHandle = (await page.$('div'))!; expect(await divHandle.clickablePoint()).toEqual({ x: 45 + 60, // margin + middle point offset y: 45 + 30, // margin + middle point offset }); expect( await divHandle.clickablePoint({ x: 10, y: 15, }) ).toEqual({ x: 30 + 10, // margin + offset y: 30 + 15, // margin + offset }); }); it('should work for iframes', async () => { const {page} = getTestState(); await page.evaluate(() => { document.body.style.padding = '10px'; document.body.style.margin = '10px'; document.body.innerHTML = ` `; }); await page.evaluate(async () => { return new Promise(resolve => { return window.requestAnimationFrame(resolve); }); }); const frame = page.frames()[1]!; const divHandle = (await frame.$('div'))!; expect(await divHandle.clickablePoint()).toEqual({ x: 20 + 45 + 60, // iframe pos + margin + middle point offset y: 20 + 45 + 30, // iframe pos + margin + middle point offset }); expect( await divHandle.clickablePoint({ x: 10, y: 15, }) ).toEqual({ x: 20 + 30 + 10, // iframe pos + margin + offset y: 20 + 30 + 15, // iframe pos + margin + offset }); }); }); describe('JSHandle.click', function () { itFailsFirefox('should work', async () => { const {page} = getTestState(); const clicks: Array<[x: number, y: number]> = []; await page.exposeFunction('reportClick', (x: number, y: number): void => { clicks.push([x, y]); }); await page.evaluate(() => { document.body.style.padding = '0'; document.body.style.margin = '0'; document.body.innerHTML = `
`; document.body.addEventListener('click', e => { (window as any).reportClick(e.clientX, e.clientY); }); }); const divHandle = (await page.$('div'))!; await divHandle.click(); await divHandle.click({ offset: { x: 10, y: 15, }, }); await shortWaitForArrayToHaveAtLeastNElements(clicks, 2); expect(clicks).toEqual([ [45 + 60, 45 + 30], // margin + middle point offset [30 + 10, 30 + 15], // margin + offset ]); }); }); });