playwright/tests/library/browsercontext-expose-function.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 type { BrowserContext } from '@playwright/test';
import { contextTest as it, expect } from '../config/browserTest';

it('expose binding should work', async ({ context }) => {
  let bindingSource;
  await context.exposeBinding('add', (source, a, b) => {
    bindingSource = source;
    return a + b;
  });
  const page = await context.newPage();
  const result = await page.evaluate('add(5, 6)');
  expect(bindingSource.context).toBe(context);
  expect(bindingSource.page).toBe(page);
  expect(bindingSource.frame).toBe(page.mainFrame());
  expect(result).toEqual(11);
});

it('should work', async ({ context, server }) => {
  await context.exposeFunction('add', (a, b) => a + b);
  const page = await context.newPage();
  await page.exposeFunction('mul', (a, b) => a * b);
  await context.exposeFunction('sub', (a, b) => a - b);
  await context.exposeBinding('addHandle', async ({ frame }, a, b) => {
    const handle = await frame.evaluateHandle(([a, b]) => a + b, [a, b]);
    return handle;
  });
  const result = await page.evaluate('(async () => ({ mul: await mul(9, 4), add: await add(9, 4), sub: await sub(9, 4), addHandle: await addHandle(5, 6) }))()');
  expect(result).toEqual({ mul: 36, add: 13, sub: 5, addHandle: 11 });
});

it('should throw for duplicate registrations', async ({ context, server }) => {
  await context.exposeFunction('foo', () => {});
  await context.exposeFunction('bar', () => {});
  let error = await context.exposeFunction('foo', () => {}).catch(e => e);
  expect(error.message).toContain('Function "foo" has been already registered');
  const page = await context.newPage();
  error = await page.exposeFunction('foo', () => {}).catch(e => e);
  expect(error.message).toContain('Function "foo" has been already registered in the browser context');
  await page.exposeFunction('baz', () => {});
  error = await context.exposeFunction('baz', () => {}).catch(e => e);
  expect(error.message).toContain('Function "baz" has been already registered in one of the pages');
});

it('should be callable from-inside addInitScript', async ({ context, server }) => {
  let args = [];
  await context.exposeFunction('woof', function(arg) {
    args.push(arg);
  });
  await context.addInitScript('window["woof"]("context")');
  const page = await context.newPage();
  await page.evaluate('undefined');
  expect(args).toEqual(['context']);
  args = [];
  await page.addInitScript('window["woof"]("page")');
  await page.reload();
  expect(args).toEqual(['context', 'page']);
});

it('exposeBindingHandle should work', async ({ context }) => {
  let target;
  await context.exposeBinding('logme', (source, t) => {
    target = t;
    return 17;
  }, { handle: true });
  const page = await context.newPage();
  const result = await page.evaluate(async function() {
    return window['logme']({ foo: 42 });
  });
  expect(await target.evaluate(x => x.foo)).toBe(42);
  expect(result).toEqual(17);
});

it('should work with CSP', async ({ page, context, server }) => {
  server.setCSP('/empty.html', 'default-src "self"');
  await page.goto(server.EMPTY_PAGE);
  let called = false;
  await context.exposeBinding('hi', () => called = true);
  await page.evaluate(() => (window as any).hi());
  expect(called).toBe(true);
});

it('should re-add binding after reset', async ({ browserType, browser }) => {
  const defaultContextOptions = (browserType as any)._defaultContextOptions;
  let context: BrowserContext = await (browser as any)._newContextForReuse(defaultContextOptions);

  await context.exposeFunction('add', function(a, b) {
    return Promise.resolve(a - b);
  });
  let page = await context.newPage();
  expect(await page.evaluate('add(7, 6)')).toBe(1);

  context = await (browser as any)._newContextForReuse(defaultContextOptions);
  await context.exposeFunction('add', function(a, b) {
    return Promise.resolve(a + b);
  });

  page = context.pages()[0];
  expect(await page.evaluate('add(5, 6)')).toBe(11);
  await page.reload();
  expect(await page.evaluate('add(5, 6)')).toBe(11);
});