/** * 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 utils from './utils.js'; import sinon from 'sinon'; import expect from 'expect'; import { getTestState, setupTestBrowserHooks, setupTestPageAndContextHooks, itFailsFirefox, } from './mocha-utils'; // eslint-disable-line import/extensions describe('waittask specs', function () { setupTestBrowserHooks(); setupTestPageAndContextHooks(); describe('Page.waitFor', function () { /* This method is deprecated but we don't want the warnings showing up in * tests. Until we remove this method we still want to ensure we don't break * it. */ beforeEach(() => sinon.stub(console, 'warn').callsFake(() => {})); it('should wait for selector', async () => { const { page, server } = getTestState(); let found = false; const waitFor = page.waitFor('div').then(() => (found = true)); await page.goto(server.EMPTY_PAGE); expect(found).toBe(false); await page.goto(server.PREFIX + '/grid.html'); await waitFor; expect(found).toBe(true); }); it('should wait for an xpath', async () => { const { page, server } = getTestState(); let found = false; const waitFor = page.waitFor('//div').then(() => (found = true)); await page.goto(server.EMPTY_PAGE); expect(found).toBe(false); await page.goto(server.PREFIX + '/grid.html'); await waitFor; expect(found).toBe(true); }); it('should allow you to select an element with parenthesis-starting xpath', async () => { const { page, server } = getTestState(); let found = false; const waitFor = page.waitFor('(//img)[200]').then(() => { found = true; }); await page.goto(server.EMPTY_PAGE); expect(found).toBe(false); await page.goto(server.PREFIX + '/grid.html'); await waitFor; expect(found).toBe(true); }); it('should not allow you to select an element with single slash xpath', async () => { const { page } = getTestState(); await page.setContent(`
some text
`); let error = null; await page.waitFor('/html/body/div').catch((error_) => (error = error_)); expect(error).toBeTruthy(); }); it('should timeout', async () => { const { page } = getTestState(); const startTime = Date.now(); const timeout = 42; await page.waitFor(timeout); expect(Date.now() - startTime).not.toBeLessThan(timeout / 2); }); it('should work with multiline body', async () => { const { page } = getTestState(); const result = await page.waitForFunction(` (() => true)() `); expect(await result.jsonValue()).toBe(true); }); it('should wait for predicate', async () => { const { page } = getTestState(); await Promise.all([ page.waitFor(() => window.innerWidth < 100), page.setViewport({ width: 10, height: 10 }), ]); }); it('should throw when unknown type', async () => { const { page } = getTestState(); let error = null; // @ts-expect-error purposefully passing bad type for test await page.waitFor({ foo: 'bar' }).catch((error_) => (error = error_)); expect(error.message).toContain('Unsupported target type'); }); it('should wait for predicate with arguments', async () => { const { page } = getTestState(); await page.waitFor((arg1, arg2) => arg1 !== arg2, {}, 1, 2); }); it('should log a deprecation warning', async () => { const { page } = getTestState(); await page.waitFor(() => true); const consoleWarnStub = console.warn as sinon.SinonSpy; expect(consoleWarnStub.calledOnce).toBe(true); expect( consoleWarnStub.firstCall.calledWith( 'waitFor is deprecated and will be removed in a future release. See https://github.com/puppeteer/puppeteer/issues/6214 for details and how to migrate your code.' ) ).toBe(true); expect((console.warn as sinon.SinonSpy).calledOnce).toBe(true); }); }); describe('Frame.waitForFunction', function () { it('should accept a string', async () => { const { page } = getTestState(); const watchdog = page.waitForFunction('window.__FOO === 1'); await page.evaluate(() => (globalThis.__FOO = 1)); await watchdog; }); it('should work when resolved right before execution context disposal', async () => { const { page } = getTestState(); await page.evaluateOnNewDocument(() => (globalThis.__RELOADED = true)); await page.waitForFunction(() => { if (!globalThis.__RELOADED) window.location.reload(); return true; }); }); it('should poll on interval', async () => { const { page } = getTestState(); let success = false; const startTime = Date.now(); const polling = 100; const watchdog = page .waitForFunction(() => globalThis.__FOO === 'hit', { polling }) .then(() => (success = true)); await page.evaluate(() => (globalThis.__FOO = 'hit')); expect(success).toBe(false); await page.evaluate(() => document.body.appendChild(document.createElement('div')) ); await watchdog; expect(Date.now() - startTime).not.toBeLessThan(polling / 2); }); it('should poll on interval async', async () => { const { page } = getTestState(); let success = false; const startTime = Date.now(); const polling = 100; const watchdog = page .waitForFunction(async () => globalThis.__FOO === 'hit', { polling }) .then(() => (success = true)); await page.evaluate(async () => (globalThis.__FOO = 'hit')); expect(success).toBe(false); await page.evaluate(async () => document.body.appendChild(document.createElement('div')) ); await watchdog; expect(Date.now() - startTime).not.toBeLessThan(polling / 2); }); it('should poll on mutation', async () => { const { page } = getTestState(); let success = false; const watchdog = page .waitForFunction(() => globalThis.__FOO === 'hit', { polling: 'mutation', }) .then(() => (success = true)); await page.evaluate(() => (globalThis.__FOO = 'hit')); expect(success).toBe(false); await page.evaluate(() => document.body.appendChild(document.createElement('div')) ); await watchdog; }); it('should poll on mutation async', async () => { const { page } = getTestState(); let success = false; const watchdog = page .waitForFunction(async () => globalThis.__FOO === 'hit', { polling: 'mutation', }) .then(() => (success = true)); await page.evaluate(async () => (globalThis.__FOO = 'hit')); expect(success).toBe(false); await page.evaluate(async () => document.body.appendChild(document.createElement('div')) ); await watchdog; }); it('should poll on raf', async () => { const { page } = getTestState(); const watchdog = page.waitForFunction(() => globalThis.__FOO === 'hit', { polling: 'raf', }); await page.evaluate(() => (globalThis.__FOO = 'hit')); await watchdog; }); it('should poll on raf async', async () => { const { page } = getTestState(); const watchdog = page.waitForFunction( async () => globalThis.__FOO === 'hit', { polling: 'raf', } ); await page.evaluate(async () => (globalThis.__FOO = 'hit')); await watchdog; }); itFailsFirefox('should work with strict CSP policy', async () => { const { page, server } = getTestState(); server.setCSP('/empty.html', 'script-src ' + server.PREFIX); await page.goto(server.EMPTY_PAGE); let error = null; await Promise.all([ page .waitForFunction(() => globalThis.__FOO === 'hit', { polling: 'raf' }) .catch((error_) => (error = error_)), page.evaluate(() => (globalThis.__FOO = 'hit')), ]); expect(error).toBe(null); }); it('should throw on bad polling value', async () => { const { page } = getTestState(); let error = null; try { await page.waitForFunction(() => !!document.body, { polling: 'unknown', }); } catch (error_) { error = error_; } expect(error).toBeTruthy(); expect(error.message).toContain('polling'); }); it('should throw negative polling interval', async () => { const { page } = getTestState(); let error = null; try { await page.waitForFunction(() => !!document.body, { polling: -10 }); } catch (error_) { error = error_; } expect(error).toBeTruthy(); expect(error.message).toContain('Cannot poll with non-positive interval'); }); it('should return the success value as a JSHandle', async () => { const { page } = getTestState(); expect(await (await page.waitForFunction(() => 5)).jsonValue()).toBe(5); }); it('should return the window as a success value', async () => { const { page } = getTestState(); expect(await page.waitForFunction(() => window)).toBeTruthy(); }); it('should accept ElementHandle arguments', async () => { const { page } = getTestState(); await page.setContent('
'); const div = await page.$('div'); let resolved = false; const waitForFunction = page .waitForFunction( (element) => element.localName === 'div' && !element.parentElement, {}, div ) .then(() => (resolved = true)); expect(resolved).toBe(false); await page.evaluate((element: HTMLElement) => element.remove(), div); await waitForFunction; }); it('should respect timeout', async () => { const { page, puppeteer } = getTestState(); let error = null; await page .waitForFunction('false', { timeout: 10 }) .catch((error_) => (error = error_)); expect(error).toBeTruthy(); expect(error.message).toContain('waiting for function failed: timeout'); expect(error).toBeInstanceOf(puppeteer.errors.TimeoutError); }); it('should respect default timeout', async () => { const { page, puppeteer } = getTestState(); page.setDefaultTimeout(1); let error = null; await page.waitForFunction('false').catch((error_) => (error = error_)); expect(error).toBeInstanceOf(puppeteer.errors.TimeoutError); expect(error.message).toContain('waiting for function failed: timeout'); }); it('should disable timeout when its set to 0', async () => { const { page } = getTestState(); const watchdog = page.waitForFunction( () => { globalThis.__counter = (globalThis.__counter || 0) + 1; return globalThis.__injected; }, { timeout: 0, polling: 10 } ); await page.waitForFunction(() => globalThis.__counter > 10); await page.evaluate(() => (globalThis.__injected = true)); await watchdog; }); it('should survive cross-process navigation', async () => { const { page, server } = getTestState(); let fooFound = false; const waitForFunction = page .waitForFunction('globalThis.__FOO === 1') .then(() => (fooFound = true)); await page.goto(server.EMPTY_PAGE); expect(fooFound).toBe(false); await page.reload(); expect(fooFound).toBe(false); await page.goto(server.CROSS_PROCESS_PREFIX + '/grid.html'); expect(fooFound).toBe(false); await page.evaluate(() => (globalThis.__FOO = 1)); await waitForFunction; expect(fooFound).toBe(true); }); it('should survive navigations', async () => { const { page, server } = getTestState(); const watchdog = page.waitForFunction(() => globalThis.__done); await page.goto(server.EMPTY_PAGE); await page.goto(server.PREFIX + '/consolelog.html'); await page.evaluate(() => (globalThis.__done = true)); await watchdog; }); }); describe('Page.waitForTimeout', () => { it('waits for the given timeout before resolving', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); const startTime = Date.now(); await page.waitForTimeout(1000); const endTime = Date.now(); /* In a perfect world endTime - startTime would be exactly 1000 but we * expect some fluctuations and for it to be off by a little bit. So to * avoid a flaky test we'll make sure it waited for roughly 1 second. */ expect(endTime - startTime).toBeGreaterThan(700); expect(endTime - startTime).toBeLessThan(1300); }); }); describe('Frame.waitForTimeout', () => { it('waits for the given timeout before resolving', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); const frame = page.mainFrame(); const startTime = Date.now(); await frame.waitForTimeout(1000); const endTime = Date.now(); /* In a perfect world endTime - startTime would be exactly 1000 but we * expect some fluctuations and for it to be off by a little bit. So to * avoid a flaky test we'll make sure it waited for roughly 1 second */ expect(endTime - startTime).toBeGreaterThan(700); expect(endTime - startTime).toBeLessThan(1300); }); }); describe('Frame.waitForSelector', function () { const addElement = (tag) => document.body.appendChild(document.createElement(tag)); it('should immediately resolve promise if node exists', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); const frame = page.mainFrame(); await frame.waitForSelector('*'); await frame.evaluate(addElement, 'div'); await frame.waitForSelector('div'); }); itFailsFirefox('should work with removed MutationObserver', async () => { const { page } = getTestState(); await page.evaluate(() => delete window.MutationObserver); const [handle] = await Promise.all([ page.waitForSelector('.zombo'), page.setContent(`
anything
`), ]); expect( await page.evaluate((x: HTMLElement) => x.textContent, handle) ).toBe('anything'); }); it('should resolve promise when node is added', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); const frame = page.mainFrame(); const watchdog = frame.waitForSelector('div'); await frame.evaluate(addElement, 'br'); await frame.evaluate(addElement, 'div'); const eHandle = await watchdog; const tagName = await eHandle .getProperty('tagName') .then((e) => e.jsonValue()); expect(tagName).toBe('DIV'); }); it('should work when node is added through innerHTML', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); const watchdog = page.waitForSelector('h3 div'); await page.evaluate(addElement, 'span'); await page.evaluate( () => (document.querySelector('span').innerHTML = '

') ); await watchdog; }); itFailsFirefox( 'Page.waitForSelector is shortcut for main frame', async () => { const { page, server } = getTestState(); await page.goto(server.EMPTY_PAGE); await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE); const otherFrame = page.frames()[1]; const watchdog = page.waitForSelector('div'); await otherFrame.evaluate(addElement, 'div'); await page.evaluate(addElement, 'div'); const eHandle = await watchdog; expect(eHandle.executionContext().frame()).toBe(page.mainFrame()); } ); itFailsFirefox('should run in specified frame', async () => { const { page, server } = getTestState(); await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE); await utils.attachFrame(page, 'frame2', server.EMPTY_PAGE); const frame1 = page.frames()[1]; const frame2 = page.frames()[2]; const waitForSelectorPromise = frame2.waitForSelector('div'); await frame1.evaluate(addElement, 'div'); await frame2.evaluate(addElement, 'div'); const eHandle = await waitForSelectorPromise; expect(eHandle.executionContext().frame()).toBe(frame2); }); itFailsFirefox('should throw when frame is detached', async () => { const { page, server } = getTestState(); await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE); const frame = page.frames()[1]; let waitError = null; const waitPromise = frame .waitForSelector('.box') .catch((error) => (waitError = error)); await utils.detachFrame(page, 'frame1'); await waitPromise; expect(waitError).toBeTruthy(); expect(waitError.message).toContain( 'waitForFunction failed: frame got detached.' ); }); it('should survive cross-process navigation', async () => { const { page, server } = getTestState(); let boxFound = false; const waitForSelector = page .waitForSelector('.box') .then(() => (boxFound = true)); await page.goto(server.EMPTY_PAGE); expect(boxFound).toBe(false); await page.reload(); expect(boxFound).toBe(false); await page.goto(server.CROSS_PROCESS_PREFIX + '/grid.html'); await waitForSelector; expect(boxFound).toBe(true); }); it('should wait for visible', async () => { const { page } = getTestState(); let divFound = false; const waitForSelector = page .waitForSelector('div', { visible: true }) .then(() => (divFound = true)); await page.setContent( `
1
` ); expect(divFound).toBe(false); await page.evaluate(() => document.querySelector('div').style.removeProperty('display') ); expect(divFound).toBe(false); await page.evaluate(() => document.querySelector('div').style.removeProperty('visibility') ); expect(await waitForSelector).toBe(true); expect(divFound).toBe(true); }); it('should wait for visible recursively', async () => { const { page } = getTestState(); let divVisible = false; const waitForSelector = page .waitForSelector('div#inner', { visible: true }) .then(() => (divVisible = true)); await page.setContent( `
hi
` ); expect(divVisible).toBe(false); await page.evaluate(() => document.querySelector('div').style.removeProperty('display') ); expect(divVisible).toBe(false); await page.evaluate(() => document.querySelector('div').style.removeProperty('visibility') ); expect(await waitForSelector).toBe(true); expect(divVisible).toBe(true); }); it('hidden should wait for visibility: hidden', async () => { const { page } = getTestState(); let divHidden = false; await page.setContent(`
`); const waitForSelector = page .waitForSelector('div', { hidden: true }) .then(() => (divHidden = true)); await page.waitForSelector('div'); // do a round trip expect(divHidden).toBe(false); await page.evaluate(() => document.querySelector('div').style.setProperty('visibility', 'hidden') ); expect(await waitForSelector).toBe(true); expect(divHidden).toBe(true); }); it('hidden should wait for display: none', async () => { const { page } = getTestState(); let divHidden = false; await page.setContent(`
`); const waitForSelector = page .waitForSelector('div', { hidden: true }) .then(() => (divHidden = true)); await page.waitForSelector('div'); // do a round trip expect(divHidden).toBe(false); await page.evaluate(() => document.querySelector('div').style.setProperty('display', 'none') ); expect(await waitForSelector).toBe(true); expect(divHidden).toBe(true); }); it('hidden should wait for removal', async () => { const { page } = getTestState(); await page.setContent(`
`); let divRemoved = false; const waitForSelector = page .waitForSelector('div', { hidden: true }) .then(() => (divRemoved = true)); await page.waitForSelector('div'); // do a round trip expect(divRemoved).toBe(false); await page.evaluate(() => document.querySelector('div').remove()); expect(await waitForSelector).toBe(true); expect(divRemoved).toBe(true); }); it('should return null if waiting to hide non-existing element', async () => { const { page } = getTestState(); const handle = await page.waitForSelector('non-existing', { hidden: true, }); expect(handle).toBe(null); }); it('should respect timeout', async () => { const { page, puppeteer } = getTestState(); let error = null; await page .waitForSelector('div', { timeout: 10 }) .catch((error_) => (error = error_)); expect(error).toBeTruthy(); expect(error.message).toContain( 'waiting for selector `div` failed: timeout' ); expect(error).toBeInstanceOf(puppeteer.errors.TimeoutError); }); it('should have an error message specifically for awaiting an element to be hidden', async () => { const { page } = getTestState(); await page.setContent(`
`); let error = null; await page .waitForSelector('div', { hidden: true, timeout: 10 }) .catch((error_) => (error = error_)); expect(error).toBeTruthy(); expect(error.message).toContain( 'waiting for selector `div` to be hidden failed: timeout' ); }); it('should respond to node attribute mutation', async () => { const { page } = getTestState(); let divFound = false; const waitForSelector = page .waitForSelector('.zombo') .then(() => (divFound = true)); await page.setContent(`
`); expect(divFound).toBe(false); await page.evaluate( () => (document.querySelector('div').className = 'zombo') ); expect(await waitForSelector).toBe(true); }); it('should return the element handle', async () => { const { page } = getTestState(); const waitForSelector = page.waitForSelector('.zombo'); await page.setContent(`
anything
`); expect( await page.evaluate( (x: HTMLElement) => x.textContent, await waitForSelector ) ).toBe('anything'); }); it('should have correct stack trace for timeout', async () => { const { page } = getTestState(); let error; await page .waitForSelector('.zombo', { timeout: 10 }) .catch((error_) => (error = error_)); expect(error.stack).toContain('waiting for selector `.zombo` failed'); // The extension is ts here as Mocha maps back via sourcemaps. expect(error.stack).toContain('waittask.spec.ts'); }); }); describe('Frame.waitForXPath', function () { const addElement = (tag) => document.body.appendChild(document.createElement(tag)); it('should support some fancy xpath', async () => { const { page } = getTestState(); await page.setContent(`

red herring

hello world

`); const waitForXPath = page.waitForXPath( '//p[normalize-space(.)="hello world"]' ); expect( await page.evaluate( (x: HTMLElement) => x.textContent, await waitForXPath ) ).toBe('hello world '); }); it('should respect timeout', async () => { const { page, puppeteer } = getTestState(); let error = null; await page .waitForXPath('//div', { timeout: 10 }) .catch((error_) => (error = error_)); expect(error).toBeTruthy(); expect(error.message).toContain( 'waiting for XPath `//div` failed: timeout' ); expect(error).toBeInstanceOf(puppeteer.errors.TimeoutError); }); itFailsFirefox('should run in specified frame', async () => { const { page, server } = getTestState(); await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE); await utils.attachFrame(page, 'frame2', server.EMPTY_PAGE); const frame1 = page.frames()[1]; const frame2 = page.frames()[2]; const waitForXPathPromise = frame2.waitForXPath('//div'); await frame1.evaluate(addElement, 'div'); await frame2.evaluate(addElement, 'div'); const eHandle = await waitForXPathPromise; expect(eHandle.executionContext().frame()).toBe(frame2); }); itFailsFirefox('should throw when frame is detached', async () => { const { page, server } = getTestState(); await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE); const frame = page.frames()[1]; let waitError = null; const waitPromise = frame .waitForXPath('//*[@class="box"]') .catch((error) => (waitError = error)); await utils.detachFrame(page, 'frame1'); await waitPromise; expect(waitError).toBeTruthy(); expect(waitError.message).toContain( 'waitForFunction failed: frame got detached.' ); }); it('hidden should wait for display: none', async () => { const { page } = getTestState(); let divHidden = false; await page.setContent(`
`); const waitForXPath = page .waitForXPath('//div', { hidden: true }) .then(() => (divHidden = true)); await page.waitForXPath('//div'); // do a round trip expect(divHidden).toBe(false); await page.evaluate(() => document.querySelector('div').style.setProperty('display', 'none') ); expect(await waitForXPath).toBe(true); expect(divHidden).toBe(true); }); it('should return the element handle', async () => { const { page } = getTestState(); const waitForXPath = page.waitForXPath('//*[@class="zombo"]'); await page.setContent(`
anything
`); expect( await page.evaluate( (x: HTMLElement) => x.textContent, await waitForXPath ) ).toBe('anything'); }); it('should allow you to select a text node', async () => { const { page } = getTestState(); await page.setContent(`
some text
`); const text = await page.waitForXPath('//div/text()'); expect(await (await text.getProperty('nodeType')).jsonValue()).toBe( 3 /* Node.TEXT_NODE */ ); }); it('should allow you to select an element with single slash', async () => { const { page } = getTestState(); await page.setContent(`
some text
`); const waitForXPath = page.waitForXPath('/html/body/div'); expect( await page.evaluate( (x: HTMLElement) => x.textContent, await waitForXPath ) ).toBe('some text'); }); }); });