playwright/test/frame-hierarchy.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 { it, expect } from './fixtures';
import { attachFrame, detachFrame } from './utils';
import type { Frame } from '../index';

function dumpFrames(frame: Frame, indentation: string = ''): string[] {
  let description = frame.url().replace(/:\d{4}\//, ':<PORT>/');
  if (frame.name())
    description += ' (' + frame.name() + ')';
  const result = [indentation + description];
  const childFrames = frame.childFrames();
  childFrames.sort((a, b) => {
    if (a.url() !== b.url())
      return a.url() < b.url() ? -1 : 1;
    return a.name() < b.name() ? -1 : 1;
  });
  for (const child of childFrames)
    result.push(...dumpFrames(child, '    ' + indentation));
  return result;
}

it('should handle nested frames', async ({page, server}) => {
  await page.goto(server.PREFIX + '/frames/nested-frames.html');
  expect(dumpFrames(page.mainFrame())).toEqual([
    'http://localhost:<PORT>/frames/nested-frames.html',
    '    http://localhost:<PORT>/frames/frame.html (aframe)',
    '    http://localhost:<PORT>/frames/two-frames.html (2frames)',
    '        http://localhost:<PORT>/frames/frame.html (dos)',
    '        http://localhost:<PORT>/frames/frame.html (uno)',
  ]);
});

it('should send events when frames are manipulated dynamically', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  // validate frameattached events
  const attachedFrames = [];
  page.on('frameattached', frame => attachedFrames.push(frame));
  await attachFrame(page, 'frame1', './assets/frame.html');
  expect(attachedFrames.length).toBe(1);
  expect(attachedFrames[0].url()).toContain('/assets/frame.html');

  // validate framenavigated events
  const navigatedFrames = [];
  page.on('framenavigated', frame => navigatedFrames.push(frame));
  await page.evaluate(() => {
    const frame = document.getElementById('frame1') as HTMLIFrameElement;
    frame.src = './empty.html';
    return new Promise(x => frame.onload = x);
  });
  expect(navigatedFrames.length).toBe(1);
  expect(navigatedFrames[0].url()).toBe(server.EMPTY_PAGE);

  // validate framedetached events
  const detachedFrames = [];
  page.on('framedetached', frame => detachedFrames.push(frame));
  await detachFrame(page, 'frame1');
  expect(detachedFrames.length).toBe(1);
  expect(detachedFrames[0].isDetached()).toBe(true);
});

it('should send "framenavigated" when navigating on anchor URLs', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  await Promise.all([
    page.goto(server.EMPTY_PAGE + '#foo'),
    page.waitForEvent('framenavigated')
  ]);
  expect(page.url()).toBe(server.EMPTY_PAGE + '#foo');
});

it('should persist mainFrame on cross-process navigation', async ({page, server}) => {
  await page.goto(server.EMPTY_PAGE);
  const mainFrame = page.mainFrame();
  await page.goto(server.CROSS_PROCESS_PREFIX + '/empty.html');
  expect(page.mainFrame() === mainFrame).toBeTruthy();
});

it('should not send attach/detach events for main frame', async ({page, server}) => {
  let hasEvents = false;
  page.on('frameattached', frame => hasEvents = true);
  page.on('framedetached', frame => hasEvents = true);
  await page.goto(server.EMPTY_PAGE);
  expect(hasEvents).toBe(false);
});

it('should detach child frames on navigation', async ({page, server}) => {
  let attachedFrames = [];
  let detachedFrames = [];
  let navigatedFrames = [];
  page.on('frameattached', frame => attachedFrames.push(frame));
  page.on('framedetached', frame => detachedFrames.push(frame));
  page.on('framenavigated', frame => navigatedFrames.push(frame));
  await page.goto(server.PREFIX + '/frames/nested-frames.html');
  expect(attachedFrames.length).toBe(4);
  expect(detachedFrames.length).toBe(0);
  expect(navigatedFrames.length).toBe(5);

  attachedFrames = [];
  detachedFrames = [];
  navigatedFrames = [];
  await page.goto(server.EMPTY_PAGE);
  expect(attachedFrames.length).toBe(0);
  expect(detachedFrames.length).toBe(4);
  expect(navigatedFrames.length).toBe(1);
});

it('should support framesets', async ({page, server}) => {
  let attachedFrames = [];
  let detachedFrames = [];
  let navigatedFrames = [];
  page.on('frameattached', frame => attachedFrames.push(frame));
  page.on('framedetached', frame => detachedFrames.push(frame));
  page.on('framenavigated', frame => navigatedFrames.push(frame));
  await page.goto(server.PREFIX + '/frames/frameset.html');
  expect(attachedFrames.length).toBe(4);
  expect(detachedFrames.length).toBe(0);
  expect(navigatedFrames.length).toBe(5);

  attachedFrames = [];
  detachedFrames = [];
  navigatedFrames = [];
  await page.goto(server.EMPTY_PAGE);
  expect(attachedFrames.length).toBe(0);
  expect(detachedFrames.length).toBe(4);
  expect(navigatedFrames.length).toBe(1);
});

it('should report frame from-inside shadow DOM', async ({page, server}) => {
  await page.goto(server.PREFIX + '/shadow.html');
  await page.evaluate(async url => {
    const frame = document.createElement('iframe');
    frame.src = url;
    document.body.shadowRoot.appendChild(frame);
    await new Promise(x => frame.onload = x);
  }, server.EMPTY_PAGE);
  expect(page.frames().length).toBe(2);
  expect(page.frames()[1].url()).toBe(server.EMPTY_PAGE);
});

it('should report frame.name()', async ({page, server}) => {
  await attachFrame(page, 'theFrameId', server.EMPTY_PAGE);
  await page.evaluate(url => {
    const frame = document.createElement('iframe');
    frame.name = 'theFrameName';
    frame.src = url;
    document.body.appendChild(frame);
    return new Promise(x => frame.onload = x);
  }, server.EMPTY_PAGE);
  expect(page.frames()[0].name()).toBe('');
  expect(page.frames()[1].name()).toBe('theFrameId');
  expect(page.frames()[2].name()).toBe('theFrameName');
});

it('should report frame.parent()', async ({page, server}) => {
  await attachFrame(page, 'frame1', server.EMPTY_PAGE);
  await attachFrame(page, 'frame2', server.EMPTY_PAGE);
  expect(page.frames()[0].parentFrame()).toBe(null);
  expect(page.frames()[1].parentFrame()).toBe(page.mainFrame());
  expect(page.frames()[2].parentFrame()).toBe(page.mainFrame());
});

it('should report different frame instance when frame re-attaches', async ({page, server}) => {
  const frame1 = await attachFrame(page, 'frame1', server.EMPTY_PAGE);
  await page.evaluate(() => {
    window['frame'] = document.querySelector('#frame1');
    window['frame'].remove();
  });
  expect(frame1.isDetached()).toBe(true);
  const [frame2] = await Promise.all([
    page.waitForEvent('frameattached'),
    page.evaluate(() => document.body.appendChild(window['frame'])),
  ]);
  expect(frame2.isDetached()).toBe(false);
  expect(frame1).not.toBe(frame2);
});

it('should refuse to display x-frame-options:deny iframe', (test, { browserName }) => {
  test.fixme(browserName === 'firefox');
}, async ({page, server}) => {
  server.setRoute('/x-frame-options-deny.html', async (req, res) => {
    res.setHeader('Content-Type', 'text/html');
    res.setHeader('X-Frame-Options', 'DENY');
    res.end(`<!DOCTYPE html><html><head><title>login</title></head><body style="background-color: red;"><p>dangerous login page</p></body></html>`);
  });
  await page.goto(server.EMPTY_PAGE);
  const refusalText = new Promise(f => {
    page.on('console', msg => {
      if (msg.text().match(/Refused to display/i))
        f(msg.text());
    });
  });
  await page.setContent(`<iframe src="${server.CROSS_PROCESS_PREFIX}/x-frame-options-deny.html"></iframe>`);
  expect(await refusalText).toMatch(/Refused to display .* in a frame because it set 'X-Frame-Options' to 'deny'./i);
});

it('should return frame.page()', async ({page, server}) => {
  await page.goto(server.PREFIX + '/frames/one-frame.html');
  expect(page.mainFrame().page()).toBe(page);
  expect(page.mainFrame().childFrames()[0].page()).toBe(page);
});