playwright/test/page-wait-for-request.spec.ts

/**
 * Copyright 2017 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 { it, expect } from './fixtures';

import vm from 'vm';

it('should work', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const [request] = await Promise.all([
    page.waitForRequest(server.PREFIX + '/digits/2.png'),
    page.evaluate(() => {
      fetch('/digits/1.png');
      fetch('/digits/2.png');
      fetch('/digits/3.png');
    })
  ]);
  expect(request.url()).toBe(server.PREFIX + '/digits/2.png');
});

it('should work with predicate', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const [request] = await Promise.all([
    page.waitForEvent('request', request => request.url() === server.PREFIX + '/digits/2.png'),
    page.evaluate(() => {
      fetch('/digits/1.png');
      fetch('/digits/2.png');
      fetch('/digits/3.png');
    })
  ]);
  expect(request.url()).toBe(server.PREFIX + '/digits/2.png');
});

it('should respect timeout', async ({page, playwright}) => {
  let error = null;
  await page.waitForEvent('request', { predicate: () => false, timeout: 1 }).catch(e => error = e);
  expect(error).toBeInstanceOf(playwright.errors.TimeoutError);
});

it('should respect default timeout', async ({page, playwright}) => {
  let error = null;
  page.setDefaultTimeout(1);
  await page.waitForEvent('request', () => false).catch(e => error = e);
  expect(error).toBeInstanceOf(playwright.errors.TimeoutError);
});

it('should log the url', async ({page}) => {
  const error = await page.waitForRequest('long-long-long-long-long-long-long-long-long-long-long-long-long-long.css', { timeout: 100 }).catch(e => e);
  expect(error.message).toContain('waiting for request "long-long-long-long-long-long-long-long-long-long-…"');
});

it('should work with no timeout', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const [request] = await Promise.all([
    page.waitForRequest(server.PREFIX + '/digits/2.png', {timeout: 0}),
    page.evaluate(() => setTimeout(() => {
      fetch('/digits/1.png');
      fetch('/digits/2.png');
      fetch('/digits/3.png');
    }, 50))
  ]);
  expect(request.url()).toBe(server.PREFIX + '/digits/2.png');
});

it('should work with url match', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const [request] = await Promise.all([
    page.waitForRequest(/digits\/\d\.png/),
    page.evaluate(() => {
      fetch('/digits/1.png');
    })
  ]);
  expect(request.url()).toBe(server.PREFIX + '/digits/1.png');
});

it('should work with url match regular expression from a different context', async ({page, server}) => {
  const ctx = vm.createContext();
  const regexp = vm.runInContext('new RegExp(/digits\\/\\d\\.png/)', ctx);

  await page.goto(server.EMPTY_PAGE);
  const [request] = await Promise.all([
    page.waitForRequest(regexp),
    page.evaluate(() => {
      fetch('/digits/1.png');
    })
  ]);
  expect(request.url()).toBe(server.PREFIX + '/digits/1.png');
});

it('should return correct postData buffer for utf-8 body', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const value = 'baẞ';
  const [request] = await Promise.all([
    page.waitForRequest('**'),
    page.evaluate(({url, value}) => {
      const request = new Request(url, {
        method: 'POST',
        body: JSON.stringify(value),
      });
      request.headers.set('content-type', 'application/json;charset=UTF-8');
      return fetch(request);
    }, {url: server.PREFIX + '/title.html', value})
  ]);
  expect(request.postDataBuffer().equals(Buffer.from(JSON.stringify(value), 'utf-8'))).toBe(true);
  expect(request.postDataJSON()).toBe(value);
});