playwright/test/wait-for-selector.spec.ts

/**
 * Copyright 2018 Google Inc. All rights reserved.
 * Modifications copyright (c) Microsoft Corporation.
 *
 * 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 './playwright.fixtures';
import utils from './utils';

async function giveItTimeToLog(frame) {
  await frame.evaluate(() => new Promise(f => requestAnimationFrame(() => requestAnimationFrame(f))));
  await frame.evaluate(() => new Promise(f => requestAnimationFrame(() => requestAnimationFrame(f))));
}

const addElement = tag => document.body.appendChild(document.createElement(tag));

it('should throw on waitFor', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  let error;
  await page.waitForSelector('*', { waitFor: 'attached' } as any).catch(e => error = e);
  expect(error.message).toContain('options.waitFor is not supported, did you mean options.state?');
});

it('should tolerate waitFor=visible', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  let error = false;
  await page.waitForSelector('*', { waitFor: 'visible' } as any).catch(() => error = true);
  expect(error).toBe(false);
});

it('should immediately resolve promise if node exists', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const frame = page.mainFrame();
  await frame.waitForSelector('*');
  await frame.evaluate(addElement, 'div');
  await frame.waitForSelector('div', { state: 'attached'});
});

it('elementHandle.waitForSelector should immediately resolve if node exists', async({page}) => {
  await page.setContent(`<span>extra</span><div><span>target</span></div>`);
  const div = await page.$('div');
  const span = await div.waitForSelector('span', { state: 'attached' });
  expect(await span.evaluate(e => e.textContent)).toBe('target');
});

it('elementHandle.waitForSelector should wait', async({page}) => {
  await page.setContent(`<div></div>`);
  const div = await page.$('div');
  const promise = div.waitForSelector('span', { state: 'attached' });
  await div.evaluate(div => div.innerHTML = '<span>target</span>');
  const span = await promise;
  expect(await span.evaluate(e => e.textContent)).toBe('target');
});

it('elementHandle.waitForSelector should timeout', async({page}) => {
  await page.setContent(`<div></div>`);
  const div = await page.$('div');
  const error = await div.waitForSelector('span', { timeout: 100 }).catch(e => e);
  expect(error.message).toContain('Timeout 100ms exceeded.');
});

it('elementHandle.waitForSelector should throw on navigation', async({page, server}) => {
  await page.setContent(`<div></div>`);
  const div = await page.$('div');
  const promise = div.waitForSelector('span').catch(e => e);
  // Give it some time before navigating.
  for (let i = 0; i < 10; i++)
    await page.evaluate(() => 1);
  await page.goto(server.EMPTY_PAGE);
  const error = await promise;
  expect(error.message).toContain('Execution context was destroyed, most likely because of a navigation');
});

it('should work with removed MutationObserver', async({page, server}) => {
  await page.evaluate(() => delete window.MutationObserver);
  const [handle] = await Promise.all([
    page.waitForSelector('.zombo'),
    page.setContent(`<div class='zombo'>anything</div>`),
  ]);
  expect(await page.evaluate(x => x.textContent, handle)).toBe('anything');
});

it('should resolve promise when node is added', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const frame = page.mainFrame();
  const watchdog = frame.waitForSelector('div', { state: 'attached' });
  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 report logs while waiting for visible', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const frame = page.mainFrame();
  const watchdog = frame.waitForSelector('div', { timeout: 5000 });

  await frame.evaluate(() => {
    const div = document.createElement('div');
    div.className = 'foo bar';
    div.id = 'mydiv';
    div.setAttribute('style', 'display: none');
    div.setAttribute('foo', '123456789012345678901234567890123456789012345678901234567890');
    div.textContent = 'abcdefghijklmnopqrstuvwyxzabcdefghijklmnopqrstuvwyxzabcdefghijklmnopqrstuvwyxz';
    document.body.appendChild(div);
  });
  await giveItTimeToLog(frame);

  await frame.evaluate(() => document.querySelector('div').remove());
  await giveItTimeToLog(frame);

  await frame.evaluate(() => {
    const div = document.createElement('div');
    div.className = 'another';
    div.style.display = 'none';
    document.body.appendChild(div);
  });
  await giveItTimeToLog(frame);

  const error = await watchdog.catch(e => e);
  expect(error.message).toContain(`frame.waitForSelector: Timeout 5000ms exceeded.`);
  expect(error.message).toContain(`waiting for selector "div" to be visible`);
  expect(error.message).toContain(`selector resolved to hidden <div id="mydiv" class="foo bar" foo="1234567890123456…>abcdefghijklmnopqrstuvwyxzabcdefghijklmnopqrstuvw…</div>`);
  expect(error.message).toContain(`selector did not resolve to any element`);
  expect(error.message).toContain(`selector resolved to hidden <div class="another"></div>`);
});

it('should report logs while waiting for hidden', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const frame = page.mainFrame();
  await frame.evaluate(() => {
    const div = document.createElement('div');
    div.className = 'foo bar';
    div.id = 'mydiv';
    div.textContent = 'hello';
    document.body.appendChild(div);
  });

  const watchdog = frame.waitForSelector('div', { state: 'hidden', timeout: 5000 });
  await giveItTimeToLog(frame);

  await frame.evaluate(() => {
    document.querySelector('div').remove();
    const div = document.createElement('div');
    div.className = 'another';
    div.textContent = 'hello';
    document.body.appendChild(div);
  });
  await giveItTimeToLog(frame);

  const error = await watchdog.catch(e => e);
  expect(error.message).toContain(`frame.waitForSelector: Timeout 5000ms exceeded.`);
  expect(error.message).toContain(`waiting for selector "div" to be hidden`);
  expect(error.message).toContain(`selector resolved to visible <div id="mydiv" class="foo bar">hello</div>`);
  expect(error.message).toContain(`selector resolved to visible <div class="another">hello</div>`);
});

it('should resolve promise when node is added in shadow dom', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const watchdog = page.waitForSelector('span');
  await page.evaluate(() => {
    const div = document.createElement('div');
    div.attachShadow({mode: 'open'});
    document.body.appendChild(div);
  });
  await page.evaluate(() => new Promise(f => setTimeout(f, 100)));
  await page.evaluate(() => {
    const span = document.createElement('span');
    span.textContent = 'Hello from shadow';
    document.querySelector('div').shadowRoot.appendChild(span);
  });
  const handle = await watchdog;
  expect(await handle.evaluate(e => e.textContent)).toBe('Hello from shadow');
});

it('should work when node is added through innerHTML', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const watchdog = page.waitForSelector('h3 div', { state: 'attached'});
  await page.evaluate(addElement, 'span');
  await page.evaluate(() => document.querySelector('span').innerHTML = '<h3><div></div></h3>');
  await watchdog;
});

it('page.waitForSelector is shortcut for main frame', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE);
  const otherFrame = page.frames()[1];
  const watchdog = page.waitForSelector('div', { state: 'attached' });
  await otherFrame.evaluate(addElement, 'div');
  await page.evaluate(addElement, 'div');
  const eHandle = await watchdog;
  expect(await eHandle.ownerFrame()).toBe(page.mainFrame());
});

it('should run in specified frame', async({page, server}) => {
  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', { state: 'attached' });
  await frame1.evaluate(addElement, 'div');
  await frame2.evaluate(addElement, 'div');
  const eHandle = await waitForSelectorPromise;
  expect(await eHandle.ownerFrame()).toBe(frame2);
});

it('should throw when frame is detached', async({page, server}) => {
  await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE);
  const frame = page.frames()[1];
  let waitError = null;
  const waitPromise = frame.waitForSelector('.box').catch(e => waitError = e);
  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({page, server}) => {
  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({page, server}) => {
  let divFound = false;
  const waitForSelector = page.waitForSelector('div').then(() => divFound = true);
  await page.setContent(`<div style='display: none; visibility: hidden;'>1</div>`);
  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 not consider visible when zero-sized', async({page, server}) => {
  await page.setContent(`<div style='width: 0; height: 0;'>1</div>`);
  let error = await page.waitForSelector('div', { timeout: 1000 }).catch(e => e);
  expect(error.message).toContain('page.waitForSelector: Timeout 1000ms exceeded');
  await page.evaluate(() => document.querySelector('div').style.width = '10px');
  error = await page.waitForSelector('div', { timeout: 1000 }).catch(e => e);
  expect(error.message).toContain('page.waitForSelector: Timeout 1000ms exceeded');
  await page.evaluate(() => document.querySelector('div').style.height = '10px');
  expect(await page.waitForSelector('div', { timeout: 1000 })).toBeTruthy();
});

it('should wait for visible recursively', async({page, server}) => {
  let divVisible = false;
  const waitForSelector = page.waitForSelector('div#inner').then(() => divVisible = true);
  await page.setContent(`<div style='display: none; visibility: hidden;'><div id="inner">hi</div></div>`);
  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 hidden', async({page, server}) => {
  let divHidden = false;
  await page.setContent(`<div style='display: block;'>content</div>`);
  const waitForSelector = page.waitForSelector('div', { state: 'hidden' }).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({page, server}) => {
  let divHidden = false;
  await page.setContent(`<div style='display: block;'>content</div>`);
  const waitForSelector = page.waitForSelector('div', { state: 'hidden' }).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({page, server}) => {
  await page.setContent(`<div>content</div>`);
  let divRemoved = false;
  const waitForSelector = page.waitForSelector('div', { state: 'hidden' }).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({page, server}) => {
  const handle = await page.waitForSelector('non-existing', { state: 'hidden' });
  expect(handle).toBe(null);
});

it('should respect timeout', async({page, playwright}) => {
  let error = null;
  await page.waitForSelector('div', { timeout: 3000, state: 'attached' }).catch(e => error = e);
  expect(error).toBeTruthy();
  expect(error.message).toContain('page.waitForSelector: Timeout 3000ms exceeded');
  expect(error.message).toContain('waiting for selector "div"');
  expect(error).toBeInstanceOf(playwright.errors.TimeoutError);
});

it('should have an error message specifically for awaiting an element to be hidden', async({page, server}) => {
  await page.setContent(`<div>content</div>`);
  let error = null;
  await page.waitForSelector('div', { state: 'hidden', timeout: 1000 }).catch(e => error = e);
  expect(error).toBeTruthy();
  expect(error.message).toContain('page.waitForSelector: Timeout 1000ms exceeded');
  expect(error.message).toContain('waiting for selector "div" to be hidden');
});

it('should respond to node attribute mutation', async({page, server}) => {
  let divFound = false;
  const waitForSelector = page.waitForSelector('.zombo', { state: 'attached'}).then(() => divFound = true);
  await page.setContent(`<div class='notZombo'></div>`);
  expect(divFound).toBe(false);
  await page.evaluate(() => document.querySelector('div').className = 'zombo');
  expect(await waitForSelector).toBe(true);
});

it('should return the element handle', async({page, server}) => {
  const waitForSelector = page.waitForSelector('.zombo');
  await page.setContent(`<div class='zombo'>anything</div>`);
  expect(await page.evaluate(x => x.textContent, await waitForSelector)).toBe('anything');
});

it('should have correct stack trace for timeout', async({page, server}) => {
  let error;
  await page.waitForSelector('.zombo', { timeout: 10 }).catch(e => error = e);
  expect(error.stack).toContain('wait-for-selector');
});

it('should throw for unknown state option', async({page, server}) => {
  await page.setContent('<section>test</section>');
  const error = await page.waitForSelector('section', { state: 'foo' as any}).catch(e => e);
  expect(error.message).toContain('state: expected one of (attached|detached|visible|hidden)');
});

it('should throw for visibility option', async({page, server}) => {
  await page.setContent('<section>test</section>');
  const error = await page.waitForSelector('section', { visibility: 'hidden' } as any).catch(e => e);
  expect(error.message).toContain('options.visibility is not supported, did you mean options.state?');
});

it('should throw for true state option', async({page, server}) => {
  await page.setContent('<section>test</section>');
  const error = await page.waitForSelector('section', { state: true as any }).catch(e => e);
  expect(error.message).toContain('state: expected one of (attached|detached|visible|hidden)');
});

it('should throw for false state option', async({page, server}) => {
  await page.setContent('<section>test</section>');
  const error = await page.waitForSelector('section', { state: false as any }).catch(e => e);
  expect(error.message).toContain('state: expected one of (attached|detached|visible|hidden)');
});

it('should support >> selector syntax', async({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const frame = page.mainFrame();
  const watchdog = frame.waitForSelector('css=div >> css=span', { state: 'attached'});
  await frame.evaluate(addElement, 'br');
  await frame.evaluate(addElement, 'div');
  await frame.evaluate(() => document.querySelector('div').appendChild(document.createElement('span')));
  const eHandle = await watchdog;
  const tagName = await eHandle.getProperty('tagName').then(e => e.jsonValue());
  expect(tagName).toBe('SPAN');
});

it('should wait for detached if already detached', async({page, server}) => {
  await page.setContent('<section id="testAttribute">43543</section>');
  expect(await page.waitForSelector('css=div', { state: 'detached'})).toBe(null);
});

it('should wait for detached', async({page, server}) => {
  await page.setContent('<section id="testAttribute"><div>43543</div></section>');
  let done = false;
  const waitFor = page.waitForSelector('css=div', { state: 'detached'}).then(() => done = true);
  expect(done).toBe(false);
  await page.waitForSelector('css=section');
  expect(done).toBe(false);
  await page.$eval('div', div => div.remove());
  expect(await waitFor).toBe(true);
  expect(done).toBe(true);
});

it('should support some fancy xpath', async({page, server}) => {
  await page.setContent(`<p>red herring</p><p>hello  world  </p>`);
  const waitForXPath = page.waitForSelector('//p[normalize-space(.)="hello world"]');
  expect(await page.evaluate(x => x.textContent, await waitForXPath)).toBe('hello  world  ');
});

it('should respect timeout xpath', async({page, playwright}) => {
  let error = null;
  await page.waitForSelector('//div', { state: 'attached', timeout: 3000 }).catch(e => error = e);
  expect(error).toBeTruthy();
  expect(error.message).toContain('page.waitForSelector: Timeout 3000ms exceeded');
  expect(error.message).toContain('waiting for selector "//div"');
  expect(error).toBeInstanceOf(playwright.errors.TimeoutError);
});

it('should run in specified frame xpath', async({page, server}) => {
  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.waitForSelector('//div', { state: 'attached' });
  await frame1.evaluate(addElement, 'div');
  await frame2.evaluate(addElement, 'div');
  const eHandle = await waitForXPathPromise;
  expect(await eHandle.ownerFrame()).toBe(frame2);
});

it('should throw when frame is detached xpath', async({page, server}) => {
  await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE);
  const frame = page.frames()[1];
  let waitError = null;
  const waitPromise = frame.waitForSelector('//*[@class="box"]').catch(e => waitError = e);
  await utils.detachFrame(page, 'frame1');
  await waitPromise;
  expect(waitError).toBeTruthy();
  expect(waitError.message).toContain('waitForFunction failed: frame got detached.');
});

it('should return the element handle xpath', async({page, server}) => {
  const waitForXPath = page.waitForSelector('//*[@class="zombo"]');
  await page.setContent(`<div class='zombo'>anything</div>`);
  expect(await page.evaluate(x => x.textContent, await waitForXPath)).toBe('anything');
});

it('should allow you to select an element with single slash xpath', async({page, server}) => {
  await page.setContent(`<div>some text</div>`);
  const waitForXPath = page.waitForSelector('//html/body/div');
  expect(await page.evaluate(x => x.textContent, await waitForXPath)).toBe('some text');
});