playwright/test/workers.spec.js

/**
 * 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.
 */

const utils = require('./utils');
const { waitEvent } = utils;

/**
 * @type {PageTestSuite}
 */
module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT}) {
  const {describe, xdescribe, fdescribe} = testRunner;
  const {it, fit, xit, dit} = testRunner;
  const {beforeAll, beforeEach, afterAll, afterEach} = testRunner;

  describe('Workers', function() {
    it('Page.workers', async function({page, server}) {
      await Promise.all([
        page.waitForEvent('workercreated'),
        page.goto(server.PREFIX + '/worker/worker.html')]);
      const worker = page.workers()[0];
      expect(worker.url()).toContain('worker.js');

      expect(await worker.evaluate(() => self['workerFunction']())).toBe('worker function result');

      await page.goto(server.EMPTY_PAGE);
      expect(page.workers().length).toBe(0);
    });
    it('should emit created and destroyed events', async function({page}) {
      const workerCreatedPromise = page.waitForEvent('workercreated');
      const workerObj = await page.evaluateHandle(() => new Worker(URL.createObjectURL(new Blob(['1'], {type: 'application/javascript'}))));
      const worker = await workerCreatedPromise;
      const workerThisObj = await worker.evaluateHandle(() => this);
      const workerDestroyedPromise = new Promise(x => page.once('workerdestroyed', x));
      await page.evaluate(workerObj => workerObj.terminate(), workerObj);
      expect(await workerDestroyedPromise).toBe(worker);
      const error = await workerThisObj.getProperty('self').catch(error => error);
      expect(error.message).toContain('Most likely the worker has been closed.');
    });
    it('should report console logs', async function({page}) {
      const [message] = await Promise.all([
        waitEvent(page, 'console'),
        page.evaluate(() => new Worker(URL.createObjectURL(new Blob(['console.log(1)'], {type: 'application/javascript'})))),
      ]);
      expect(message.text()).toBe('1');
    });
    it('should have JSHandles for console logs', async function({page}) {
      const logPromise = new Promise(x => page.on('console', x));
      await page.evaluate(() => new Worker(URL.createObjectURL(new Blob(['console.log(1,2,3,this)'], {type: 'application/javascript'}))));
      const log = await logPromise;
      expect(log.text()).toBe('1 2 3 JSHandle@object');
      expect(log.args().length).toBe(4);
      expect(await (await log.args()[3].getProperty('origin')).jsonValue()).toBe('null');
    });
    it('should evaluate', async function({page}) {
      const workerCreatedPromise = page.waitForEvent('workercreated');
      page.evaluate(() => new Worker(URL.createObjectURL(new Blob(['console.log(1)'], {type: 'application/javascript'}))));
      const worker = await workerCreatedPromise;
      expect(await worker.evaluate('1+1')).toBe(2);
    });
    it('should report errors', async function({page}) {
      const errorPromise = new Promise(x => page.on('pageerror', x));
      page.evaluate(() => new Worker(URL.createObjectURL(new Blob([`setTimeout(() => { throw new Error('this is my error'); })`], {type: 'application/javascript'}))));
      const errorLog = await errorPromise;
      expect(errorLog.message).toContain('this is my error');
    });
    it('should clear upon navigation', async function({server, page}) {
      await page.goto(server.EMPTY_PAGE);
      const workerCreatedPromise = page.waitForEvent('workercreated');
      page.evaluate(() => new Worker(URL.createObjectURL(new Blob(['console.log(1)'], {type: 'application/javascript'}))));
      await workerCreatedPromise;
      expect(page.workers().length).toBe(1);
      let destroyed = false;
      page.once('workerdestroyed', () => destroyed = true);
      await page.goto(server.PREFIX + '/one-style.html');
      expect(destroyed).toBe(true);
      expect(page.workers().length).toBe(0);
    });
    it('should clear upon cross-process navigation', async function({server, page}) {
      await page.goto(server.EMPTY_PAGE);
      const workerCreatedPromise = page.waitForEvent('workercreated');
      page.evaluate(() => new Worker(URL.createObjectURL(new Blob(['console.log(1)'], {type: 'application/javascript'}))));
      await workerCreatedPromise;
      expect(page.workers().length).toBe(1);
      let destroyed = false;
      page.once('workerdestroyed', () => destroyed = true);
      await page.goto(server.CROSS_PROCESS_PREFIX + '/empty.html');
      expect(destroyed).toBe(true);
      expect(page.workers().length).toBe(0);
    });
    it('should report network activity', async function({page, server}) {
      const [worker] = await Promise.all([
        page.waitForEvent('workercreated'),
        page.goto(server.PREFIX + '/worker/worker.html'),
      ]);
      const url = server.PREFIX + '/one-style.css';
      const requestPromise = page.waitForRequest(url);
      const responsePromise = page.waitForResponse(url);
      await worker.evaluate(url => fetch(url).then(response => response.text()).then(console.log), url);
      const request = await requestPromise;
      const response = await responsePromise;
      expect(request.url()).toBe(url);
      expect(response.request()).toBe(request);
      expect(response.ok()).toBe(true);
    });
    it('should report network activity on worker creation', async function({page, server}) {
      // Chromium needs waitForDebugger enabled for this one.
      await page.goto(server.EMPTY_PAGE);
      const url = server.PREFIX + '/one-style.css';
      const requestPromise = page.waitForRequest(url);
      const responsePromise = page.waitForResponse(url);
      await page.evaluate(url => new Worker(URL.createObjectURL(new Blob([`
        fetch("${url}").then(response => response.text()).then(console.log);
      `], {type: 'application/javascript'}))), url);
      const request = await requestPromise;
      const response = await responsePromise;
      expect(request.url()).toBe(url);
      expect(response.request()).toBe(request);
      expect(response.ok()).toBe(true);
    });
    false && it.skip(FFOX)('should report web socket activity', async function({page, server}) {
      const [worker] = await Promise.all([
        page.waitForEvent('workercreated'),
        page.goto(server.PREFIX + '/worker/worker.html'),
      ]);
      const log = [];
      let socketClosed;
      const socketClosePromise = new Promise(f => socketClosed = f);
      page.on('websocket', ws => {
        ws.on('open', () => log.push(`open<${ws.url()}>`));
        ws.on('close', () => { log.push('close'); socketClosed(); });
      });
      worker.evaluate((port) => {
        const ws = new WebSocket('ws://localhost:' + port + '/ws');
        ws.addEventListener('open', () => ws.close());
      }, server.PORT);

      await socketClosePromise;
      expect(log.join(':')).toBe(`open<ws://localhost:${server.PORT}/ws>:close`);
    });
  });
};