playwright/test/evaluation.spec.js

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

const utils = require('./utils');
const path = require('path');
const {FFOX, CHROMIUM, WEBKIT} = utils.testOptions(browserType);

describe('Page.evaluate', function() {
  it('should work', async({page, server}) => {
    const result = await page.evaluate(() => 7 * 3);
    expect(result).toBe(21);
  });
  it('should transfer NaN', async({page, server}) => {
    const result = await page.evaluate(a => a, NaN);
    expect(Object.is(result, NaN)).toBe(true);
  });
  it('should transfer -0', async({page, server}) => {
    const result = await page.evaluate(a => a, -0);
    expect(Object.is(result, -0)).toBe(true);
  });
  it('should transfer Infinity', async({page, server}) => {
    const result = await page.evaluate(a => a, Infinity);
    expect(Object.is(result, Infinity)).toBe(true);
  });
  it('should transfer -Infinity', async({page, server}) => {
    const result = await page.evaluate(a => a, -Infinity);
    expect(Object.is(result, -Infinity)).toBe(true);
  });
  it('should transfer arrays', async({page, server}) => {
    const result = await page.evaluate(a => a, [1, 2, 3]);
    expect(result).toEqual([1,2,3]);
  });
  it('should transfer arrays as arrays, not objects', async({page, server}) => {
    const result = await page.evaluate(a => Array.isArray(a), [1, 2, 3]);
    expect(result).toBe(true);
  });
  it('should transfer maps as empty objects', async({page, server}) => {
    const result = await page.evaluate(a => a.x.constructor.name + ' ' + JSON.stringify(a.x), {x: new Map([[1, 2]])});
    expect(result).toBe('Object {}');
  });
  it('should modify global environment', async({page}) => {
    await page.evaluate(() => window.globalVar = 123);
    expect(await page.evaluate('globalVar')).toBe(123);
  });
  it('should evaluate in the page context', async({page, server}) => {
    await page.goto(server.PREFIX + '/global-var.html');
    expect(await page.evaluate('globalVar')).toBe(123);
  });
  it('should return undefined for objects with symbols', async({page, server}) => {
    expect(await page.evaluate(() => [Symbol('foo4')])).toBe(undefined);
    expect(await page.evaluate(() => {
      const a = { };
      a[Symbol('foo4')] = 42;
      return a;
    })).toEqual({});
    expect(await page.evaluate(() => {
      return { foo: [{ a: Symbol('foo4') }] };
    })).toBe(undefined);
  });
  it('should work with function shorthands', async({page, server}) => {
    const a = {
      sum([a, b]) { return a + b; },
      async mult([a, b]) { return a * b; }
    };
    expect(await page.evaluate(a.sum, [1, 2])).toBe(3);
    expect(await page.evaluate(a.mult, [2, 4])).toBe(8);
  });
  it('should work with unicode chars', async({page, server}) => {
    const result = await page.evaluate(a => a['中文字符'], {'中文字符': 42});
    expect(result).toBe(42);
  });
  it('should throw when evaluation triggers reload', async({page, server}) => {
    let error = null;
    await page.evaluate(() => {
      location.reload();
      return new Promise(() => {});
    }).catch(e => error = e);
    expect(error.message).toContain('navigation');
  });
  it('should await promise', async({page, server}) => {
    const result = await page.evaluate(() => Promise.resolve(8 * 7));
    expect(result).toBe(56);
  });
  it('should work right after framenavigated', async({page, server}) => {
    let frameEvaluation = null;
    page.on('framenavigated', async frame => {
      frameEvaluation = frame.evaluate(() => 6 * 7);
    });
    await page.goto(server.EMPTY_PAGE);
    expect(await frameEvaluation).toBe(42);
  });
  it('should work right after a cross-origin navigation', async({page, server}) => {
      await page.goto(server.EMPTY_PAGE);
      let frameEvaluation = null;
      page.on('framenavigated', async frame => {
        frameEvaluation = frame.evaluate(() => 6 * 7);
      });
      await page.goto(server.CROSS_PROCESS_PREFIX + '/empty.html');
      expect(await frameEvaluation).toBe(42);
  });
  it('should work from-inside an exposed function', async({page, server}) => {
    // Setup inpage callback, which calls Page.evaluate
    await page.exposeFunction('callController', async function(a, b) {
      return await page.evaluate(({ a, b }) => a * b, { a, b });
    });
    const result = await page.evaluate(async function() {
      return await callController(9, 3);
    });
    expect(result).toBe(27);
  });
  it('should reject promise with exception', async({page, server}) => {
    let error = null;
    await page.evaluate(() => not_existing_object.property).catch(e => error = e);
    expect(error).toBeTruthy();
    expect(error.message).toContain('not_existing_object');
  });
  it('should support thrown strings as error messages', async({page, server}) => {
    let error = null;
    await page.evaluate(() => { throw 'qwerty'; }).catch(e => error = e);
    expect(error).toBeTruthy();
    expect(error.message).toContain('qwerty');
  });
  it('should support thrown numbers as error messages', async({page, server}) => {
    let error = null;
    await page.evaluate(() => { throw 100500; }).catch(e => error = e);
    expect(error).toBeTruthy();
    expect(error.message).toContain('100500');
  });
  it('should return complex objects', async({page, server}) => {
    const object = {foo: 'bar!'};
    const result = await page.evaluate(a => a, object);
    expect(result).not.toBe(object);
    expect(result).toEqual(object);
  });
  it('should return NaN', async({page, server}) => {
    const result = await page.evaluate(() => NaN);
    expect(Object.is(result, NaN)).toBe(true);
  });
  it('should return -0', async({page, server}) => {
    const result = await page.evaluate(() => -0);
    expect(Object.is(result, -0)).toBe(true);
  });
  it('should return Infinity', async({page, server}) => {
    const result = await page.evaluate(() => Infinity);
    expect(Object.is(result, Infinity)).toBe(true);
  });
  it('should return -Infinity', async({page, server}) => {
    const result = await page.evaluate(() => -Infinity);
    expect(Object.is(result, -Infinity)).toBe(true);
  });
  it('should accept "undefined" as one of multiple parameters', async({page, server}) => {
    const result = await page.evaluate(({ a, b }) => Object.is(a, undefined) && Object.is(b, 'foo'), { a: undefined, b: 'foo' });
    expect(result).toBe(true);
  });
  it('should properly serialize undefined arguments', async({page}) => {
    expect(await page.evaluate(x => ({a: x}), undefined)).toEqual({});
  });
  it('should properly serialize undefined fields', async({page}) => {
    expect(await page.evaluate(() => ({a: undefined}))).toEqual({});
  });
  it('should properly serialize null arguments', async({page}) => {
    expect(await page.evaluate(x => x, null)).toEqual(null);
  });
  it('should properly serialize null fields', async({page}) => {
    expect(await page.evaluate(() => ({a: null}))).toEqual({a: null});
  });
  it('should return undefined for non-serializable objects', async({page, server}) => {
    expect(await page.evaluate(() => window)).toBe(undefined);
  });
  it('should fail for circular object', async({page, server}) => {
    const result = await page.evaluate(() => {
      const a = {};
      const b = {a};
      a.b = b;
      return a;
    });
    expect(result).toBe(undefined);
  });
  it('should be able to throw a tricky error', async({page, server}) => {
    const windowHandle = await page.evaluateHandle(() => window);
    const errorText = await windowHandle.jsonValue().catch(e => e.message);
    const error = await page.evaluate(errorText => {
      throw new Error(errorText);
    }, errorText).catch(e => e);
    expect(error.message).toContain(errorText);
  });
  it('should accept a string', async({page, server}) => {
    const result = await page.evaluate('1 + 2');
    expect(result).toBe(3);
  });
  it('should accept a string with semi colons', async({page, server}) => {
    const result = await page.evaluate('1 + 5;');
    expect(result).toBe(6);
  });
  it('should accept a string with comments', async({page, server}) => {
    const result = await page.evaluate('2 + 5;\n// do some math!');
    expect(result).toBe(7);
  });
  it('should accept element handle as an argument', async({page, server}) => {
    await page.setContent('<section>42</section>');
    const element = await page.$('section');
    const text = await page.evaluate(e => e.textContent, element);
    expect(text).toBe('42');
  });
  it('should throw if underlying element was disposed', async({page, server}) => {
    await page.setContent('<section>39</section>');
    const element = await page.$('section');
    expect(element).toBeTruthy();
    await element.dispose();
    let error = null;
    await page.evaluate(e => e.textContent, element).catch(e => error = e);
    expect(error.message).toContain('JSHandle is disposed');
  });
  it('should simulate a user gesture', async({page, server}) => {
    const result = await page.evaluate(() => {
      document.body.appendChild(document.createTextNode('test'));
      document.execCommand('selectAll');
      return document.execCommand('copy');
    });
    expect(result).toBe(true);
  });
  it('should throw a nice error after a navigation', async({page, server}) => {
    const errorPromise = page.evaluate(() => new Promise(f => window.__resolve = f)).catch(e => e);
    await Promise.all([
      page.waitForNavigation(),
      page.evaluate(() => {
        window.location.reload();
        setTimeout(() => window.__resolve(42), 1000);
      })
    ]);
    const error = await errorPromise;
    expect(error.message).toContain('navigation');
  });
  it('should not throw an error when evaluation does a navigation', async({page, server}) => {
    await page.goto(server.PREFIX + '/one-style.html');
    const result = await page.evaluate(() => {
      window.location = '/empty.html';
      return [42];
    });
    expect(result).toEqual([42]);
  });
  it.slow()('should transfer 100Mb of data from page to node.js', async({page, server}) => {
    const a = await page.evaluate(() => Array(100 * 1024 * 1024 + 1).join('a'));
    expect(a.length).toBe(100 * 1024 * 1024);
  });
  it('should throw error with detailed information on exception inside promise ', async({page, server}) => {
    let error = null;
    await page.evaluate(() => new Promise(() => {
      throw new Error('Error in promise');
    })).catch(e => error = e);
    expect(error.message).toContain('Error in promise');
  });
  it('should work even when JSON is set to null', async ({ page }) => {
    await page.evaluate(() => { window.JSON.stringify = null; window.JSON = null; });
    const result = await page.evaluate(() => ({abc: 123}));
    expect(result).toEqual({abc: 123});
  });
  it('should await promise from popup', async function({page, server}) {
    await page.goto(server.EMPTY_PAGE);
    const result = await page.evaluate(() => {
      const win = window.open('about:blank');
      return new win.Promise(f => f(42));
    });
    expect(result).toBe(42);
  });
  it('should work with new Function() and CSP', async({page, server}) => {
    server.setCSP('/empty.html', 'script-src ' + server.PREFIX);
    await page.goto(server.PREFIX + '/empty.html');
    expect(await page.evaluate(() => new Function('return true')())).toBe(true);
  });
});

describe('Page.addInitScript', function() {
  it('should evaluate before anything else on the page', async({page, server}) => {
    await page.addInitScript(function(){
      window.injected = 123;
    });
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.result)).toBe(123);
  });
  it('should work with a path', async({page, server}) => {
    await page.addInitScript({ path: path.join(__dirname, 'assets/injectedfile.js') });
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.result)).toBe(123);
  });
  it('should work with content', async({page, server}) => {
    await page.addInitScript({ content: 'window.injected = 123' });
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.result)).toBe(123);
  });
  it('should throw without path and content', async({page, server}) => {
    const error = await page.addInitScript({ foo: 'bar' }).catch(e => e);
    expect(error.message).toBe('Either path or content property must be present');
  });
  it('should work with browser context scripts', async({browser, server}) => {
    const context = await browser.newContext();
    await context.addInitScript(() => window.temp = 123);
    const page = await context.newPage();
    await page.addInitScript(() => window.injected = window.temp);
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.result)).toBe(123);
    await context.close();
  });
  it('should work with browser context scripts with a path', async({browser, server}) => {
    const context = await browser.newContext();
    await context.addInitScript({ path: path.join(__dirname, 'assets/injectedfile.js') });
    const page = await context.newPage();
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.result)).toBe(123);
    await context.close();
  });
  it('should work with browser context scripts for already created pages', async({browser, server}) => {
    const context = await browser.newContext();
    const page = await context.newPage();
    await context.addInitScript(() => window.temp = 123);
    await page.addInitScript(() => window.injected = window.temp);
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.result)).toBe(123);
    await context.close();
  });
  it('should support multiple scripts', async({page, server}) => {
    await page.addInitScript(function(){
      window.script1 = 1;
    });
    await page.addInitScript(function(){
      window.script2 = 2;
    });
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.script1)).toBe(1);
    expect(await page.evaluate(() => window.script2)).toBe(2);
  });
  it('should work with CSP', async({page, server}) => {
    server.setCSP('/empty.html', 'script-src ' + server.PREFIX);
    await page.addInitScript(function(){
      window.injected = 123;
    });
    await page.goto(server.PREFIX + '/empty.html');
    expect(await page.evaluate(() => window.injected)).toBe(123);

    // Make sure CSP works.
    await page.addScriptTag({content: 'window.e = 10;'}).catch(e => void e);
    expect(await page.evaluate(() => window.e)).toBe(undefined);
  });
  it('should work after a cross origin navigation', async({page, server}) => {
    await page.goto(server.CROSS_PROCESS_PREFIX);
    await page.addInitScript(function(){
      window.injected = 123;
    });
    await page.goto(server.PREFIX + '/tamperable.html');
    expect(await page.evaluate(() => window.result)).toBe(123);
  });
});

describe('Frame.evaluate', function() {
  it('should have different execution contexts', async({page, server}) => {
    await page.goto(server.EMPTY_PAGE);
    await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE);
    expect(page.frames().length).toBe(2);
    await page.frames()[0].evaluate(() => window.FOO = 'foo');
    await page.frames()[1].evaluate(() => window.FOO = 'bar');
    expect(await page.frames()[0].evaluate(() => window.FOO)).toBe('foo');
    expect(await page.frames()[1].evaluate(() => window.FOO)).toBe('bar');
  });
  it('should have correct execution contexts', async({page, server}) => {
    await page.goto(server.PREFIX + '/frames/one-frame.html');
    expect(page.frames().length).toBe(2);
    expect(await page.frames()[0].evaluate(() => document.body.textContent.trim())).toBe('');
    expect(await page.frames()[1].evaluate(() => document.body.textContent.trim())).toBe(`Hi, I'm frame`);
  });

  function expectContexts(page, count) {
    if (CHROMIUM)
      expect(page._delegate._mainFrameSession._contextIdToContext.size).toBe(count);
    else
      expect(page._delegate._contextIdToContext.size).toBe(count);
  }
  it('should dispose context on navigation', async({page, server}) => {
    await page.goto(server.PREFIX + '/frames/one-frame.html');
    expect(page.frames().length).toBe(2);
    expectContexts(page, 4);
    await page.goto(server.EMPTY_PAGE);
    expectContexts(page, 2);
  });
  it('should dispose context on cross-origin navigation', async({page, server}) => {
    await page.goto(server.PREFIX + '/frames/one-frame.html');
    expect(page.frames().length).toBe(2);
    expectContexts(page, 4);
    await page.goto(server.CROSS_PROCESS_PREFIX + '/empty.html');
    expectContexts(page, 2);
  });

  it('should execute after cross-site navigation', async({page, server}) => {
    await page.goto(server.EMPTY_PAGE);
    const mainFrame = page.mainFrame();
    expect(await mainFrame.evaluate(() => window.location.href)).toContain('localhost');
    await page.goto(server.CROSS_PROCESS_PREFIX + '/empty.html');
    expect(await mainFrame.evaluate(() => window.location.href)).toContain('127');
  });
  it('should not allow cross-frame js handles', async({page, server}) => {
    // TODO: this should actually be possible because frames script each other,
    // but protocol implementations do not support this. For now, assume current
    // behavior.
    await page.goto(server.PREFIX + '/frames/one-frame.html');
    const handle = await page.evaluateHandle(() => {
      const iframe = document.querySelector('iframe');
      const foo = { bar: 'baz' };
      iframe.contentWindow.__foo = foo;
      return foo;
    });
    const childFrame = page.mainFrame().childFrames()[0];
    const childResult = await childFrame.evaluate(() => window.__foo);
    expect(childResult).toEqual({ bar: 'baz' });
    const error = await childFrame.evaluate(foo => foo.bar, handle).catch(e => e);
    expect(error.message).toBe('JSHandles can be evaluated only in the context they were created!');
  });
  it('should allow cross-frame element handles', async({page, server}) => {
    await page.goto(server.PREFIX + '/frames/one-frame.html');
    const bodyHandle = await page.mainFrame().childFrames()[0].$('body');
    const result = await page.evaluate(body => body.innerHTML, bodyHandle);
    expect(result.trim()).toBe('<div>Hi, I\'m frame</div>');
  });
  it('should not allow cross-frame element handles when frames do not script each other', async({page, server}) => {
    await page.goto(server.EMPTY_PAGE);
    const frame = await utils.attachFrame(page, 'frame1', server.CROSS_PROCESS_PREFIX + '/empty.html');
    const bodyHandle = await frame.$('body');
    const error = await page.evaluate(body => body.innerHTML, bodyHandle).catch(e => e);
    expect(error.message).toContain('Unable to adopt element handle from a different document');
  });
  it.fail(FFOX)('should return non-empty Node.constructor.name in utility context', async({page,server}) => {
    await page.goto(server.EMPTY_PAGE);
    await utils.attachFrame(page, 'frame1', server.EMPTY_PAGE);
    const frame = page.frames()[1];
    const context = await frame._utilityContext();
    const elementHandle = await context.evaluateHandleInternal(() => window.top.document.querySelector('#frame1'));
    const constructorName = await context.evaluateInternal(node => node.constructor.name, elementHandle);
    expect(constructorName).toBe('HTMLIFrameElement');
  });
});