test/e2e/application/frame-tree_test.ts

// Copyright 2020 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import {assert} from 'chai';

import {expectError} from '../../conductor/events.js';
import {
  $$,
  click,
  getBrowserAndPages,
  getTestServerPort,
  goToResource,
  pressKey,
  waitFor,
  waitForFunction,
} from '../../shared/helper.js';
import {describe, it} from '../../shared/mocha-extensions.js';
import {
  doubleClickSourceTreeItem,
  getFrameTreeTitles,
  getTrimmedTextContent,
  navigateToApplicationTab,
} from '../helpers/application-helpers.js';
import {setIgnoreListPattern} from '../helpers/settings-helpers.js';

const TOP_FRAME_SELECTOR = '[aria-label="top"]';
const WEB_WORKERS_SELECTOR = '[aria-label="Web Workers"]';
const SERVICE_WORKERS_SELECTOR = '[aria-label="top"] ~ ol [aria-label="Service Workers"]';
const OPENED_WINDOWS_SELECTOR = '[aria-label="Opened Windows"]';
const IFRAME_FRAME_ID_SELECTOR = '[aria-label="frameId (iframe.html)"]';
const MAIN_FRAME_SELECTOR = '[aria-label="frameId (main-frame.html)"]';
const IFRAME_SELECTOR = '[aria-label="iframe.html"]';
const EXPAND_STACKTRACE_BUTTON_SELECTOR = '.arrow-icon-button';
const STACKTRACE_ROW_SELECTOR = '.stack-trace-row';
const STACKTRACE_ROW_LINK_SELECTOR = '.stack-trace-row .link';
const APPLICATION_PANEL_SELECTED_SELECTOR = '.tabbed-pane-header-tab.selected[aria-label="Application"]';

const getTrailingURL = (text: string): string => {
  const match = text.match(/http.*$/);
  return match ? match[0] : '';
};

const ensureApplicationPanel = async () => {
  if ((await $$(APPLICATION_PANEL_SELECTED_SELECTOR)).length === 0) {
    await waitForFunction(async () => {
      await click('#tab-resources');
      return (await $$(APPLICATION_PANEL_SELECTED_SELECTOR)).length === 1;
    });
  }
};

declare global {
  interface Window {
    iFrameWindow: Window|null|undefined;
  }
}

describe('The Application Tab', async () => {
  afterEach(async () => {
    const {target} = getBrowserAndPages();
    await target.evaluate(async () => {
      const registrations = await navigator.serviceWorker.getRegistrations();
      await Promise.all(registrations.map(registration => registration.unregister()));
    });
  });

  // Update and reactivate when the whole FrameDetailsView is a custom component
  it('shows details for a frame when clicked on in the frame tree', async () => {
    const {target} = getBrowserAndPages();
    await navigateToApplicationTab(target, 'frame-tree');
    await click('#tab-resources');
    await doubleClickSourceTreeItem(TOP_FRAME_SELECTOR);

    const fieldValuesTextContent = await waitForFunction(async () => {
      const fieldValues = await getTrimmedTextContent('devtools-report-value');
      if (fieldValues[0]) {
        // This contains some CSS from the svg icon link being rendered. It's
        // system-specific, so we get rid of it and only look at the (URL) text.
        fieldValues[0] = getTrailingURL(fieldValues[0]);
      }
      if (fieldValues[9] && fieldValues[9].includes('accelerometer')) {
        fieldValues[9] = 'accelerometer';
      }
      // Make sure the length is equivalent to the expected value below
      if (fieldValues.length === 10) {
        return fieldValues;
      }
      return undefined;
    });
    const expected = [
      `https://localhost:${getTestServerPort()}/test/e2e/resources/application/frame-tree.html`,
      `https://localhost:${getTestServerPort()}`,
      '<#document>',
      'Yes\xA0Localhost is always a secure context',
      'No',
      'None',
      'UnsafeNone',
      'unavailable\xA0requires cross-origin isolated context',
      'unavailable\xA0Learn more',
      'accelerometer',
    ];

    assert.deepEqual(fieldValuesTextContent, expected);
  });

  it('shows stack traces for OOPIF', async () => {
    expectError('Request CacheStorage.requestCacheNames failed. {"code":-32602,"message":"Invalid security origin"}');
    await goToResource('application/js-oopif.html');
    await ensureApplicationPanel();
    await waitForFunction(async () => {
      await doubleClickSourceTreeItem(TOP_FRAME_SELECTOR);
      await doubleClickSourceTreeItem(IFRAME_SELECTOR);
      return (await $$(EXPAND_STACKTRACE_BUTTON_SELECTOR)).length === 1;
    });
    const stackTraceRowsTextContent = await waitForFunction(async () => {
      await ensureApplicationPanel();
      await click(EXPAND_STACKTRACE_BUTTON_SELECTOR);
      const stackTraceRows = await getTrimmedTextContent(STACKTRACE_ROW_SELECTOR);
      // Make sure the length is equivalent to the expected value below
      if (stackTraceRows.length === 3) {
        return stackTraceRows;
      }
      return undefined;
    });
    const expected = [
      'second\xA0@\xA0js-oopif.html:13',
      'first\xA0@\xA0js-oopif.js:3',
      '(anonymous)\xA0@\xA0js-oopif.js:6',
    ];
    assert.deepEqual(stackTraceRowsTextContent, expected);
  });

  it('stack traces for OOPIF with ignore listed frames can be expanded and collapsed', async () => {
    expectError('Request CacheStorage.requestCacheNames failed. {"code":-32602,"message":"Invalid security origin"}');
    await setIgnoreListPattern('js-oopif.js');
    await goToResource('application/js-oopif.html');
    await ensureApplicationPanel();
    await waitForFunction(async () => {
      await doubleClickSourceTreeItem(TOP_FRAME_SELECTOR);
      await doubleClickSourceTreeItem(IFRAME_SELECTOR);
      return (await $$(EXPAND_STACKTRACE_BUTTON_SELECTOR)).length === 1;
    });
    let stackTraceRowsTextContent = await waitForFunction(async () => {
      await ensureApplicationPanel();
      await click(EXPAND_STACKTRACE_BUTTON_SELECTOR);
      const stackTraceRows = await getTrimmedTextContent(STACKTRACE_ROW_SELECTOR);
      // Make sure the length is equivalent to the expected value below
      if (stackTraceRows.length === 2) {
        return stackTraceRows;
      }
      return undefined;
    });
    const expectedCollapsed = [
      'second\xA0@\xA0js-oopif.html:13',
      'Show 2 more frames',
    ];
    assert.deepEqual(stackTraceRowsTextContent, expectedCollapsed);

    // Expand all frames
    await click(STACKTRACE_ROW_LINK_SELECTOR);
    stackTraceRowsTextContent = await waitForFunction(async () => {
      const stackTraceRows = await getTrimmedTextContent(STACKTRACE_ROW_SELECTOR);
      // Make sure the length is equivalent to the expected value below
      if (stackTraceRows.length === 4) {
        return stackTraceRows;
      }
      return undefined;
    });

    const expectedFull = [
      'second\xA0@\xA0js-oopif.html:13',
      'first\xA0@\xA0js-oopif.js:3',
      '(anonymous)\xA0@\xA0js-oopif.js:6',
      'Show less',
    ];
    assert.deepEqual(stackTraceRowsTextContent, expectedFull);

    await click(STACKTRACE_ROW_LINK_SELECTOR);
    stackTraceRowsTextContent = await waitForFunction(async () => {
      const stackTraceRows = await getTrimmedTextContent(STACKTRACE_ROW_SELECTOR);
      // Make sure the length is equivalent to the expected value below
      if (stackTraceRows.length === 2) {
        return stackTraceRows;
      }
      return undefined;
    });
    assert.deepEqual(stackTraceRowsTextContent, expectedCollapsed);
  });

  it('shows details for opened windows in the frame tree', async () => {
    const {target} = getBrowserAndPages();
    await navigateToApplicationTab(target, 'frame-tree');
    await click('#tab-resources');
    await doubleClickSourceTreeItem(TOP_FRAME_SELECTOR);

    await target.evaluate(() => {
      window.iFrameWindow = window.open('iframe.html');
    });

    await doubleClickSourceTreeItem(OPENED_WINDOWS_SELECTOR);
    await waitFor(`${OPENED_WINDOWS_SELECTOR} + ol li:first-child`);
    void pressKey('ArrowDown');

    const fieldValuesTextContent = await waitForFunction(async () => {
      const fieldValues = await getTrimmedTextContent('.report-field-value');
      // Make sure the length is equivalent to the expected value below
      if (fieldValues.length === 3) {
        return fieldValues;
      }
      return undefined;
    });
    const expected = [
      `https://localhost:${getTestServerPort()}/test/e2e/resources/application/iframe.html`,
      '<#document>',
      'Yes',
    ];
    assert.deepEqual(fieldValuesTextContent, expected);
    await target.evaluate(() => {
      window.iFrameWindow?.close();
    });
  });

  it('shows dedicated workers in the frame tree', async () => {
    expectError('Request CacheStorage.requestCacheNames failed. {"code":-32602,"message":"Invalid security origin"}');
    const {target} = getBrowserAndPages();
    await goToResource('application/frame-tree.html');
    await click('#tab-resources');
    await doubleClickSourceTreeItem(TOP_FRAME_SELECTOR);
    // DevTools is not ready yet when the worker is being initially attached.
    // We therefore need to reload the page to see the worker in DevTools.
    await target.reload();
    await doubleClickSourceTreeItem(WEB_WORKERS_SELECTOR);
    await waitFor(`${WEB_WORKERS_SELECTOR} + ol li:first-child`);
    void pressKey('ArrowDown');

    const fieldValuesTextContent = await waitForFunction(async () => {
      const fieldValues = await getTrimmedTextContent('.report-field-value');
      // Make sure the length is equivalent to the expected value below
      if (fieldValues.length === 3) {
        return fieldValues;
      }
      return undefined;
    });
    const expected = [
      `https://localhost:${getTestServerPort()}/test/e2e/resources/application/dedicated-worker.js`,
      'Web Worker',
      'None',
    ];
    assert.deepEqual(fieldValuesTextContent, expected);
  });

  it('shows service workers in the frame tree', async () => {
    expectError('Request CacheStorage.requestCacheNames failed. {"code":-32602,"message":"Invalid security origin"}');
    await goToResource('application/service-worker-network.html');
    await click('#tab-resources');
    await doubleClickSourceTreeItem(TOP_FRAME_SELECTOR);
    await doubleClickSourceTreeItem(SERVICE_WORKERS_SELECTOR);
    await waitFor(`${SERVICE_WORKERS_SELECTOR} + ol li:first-child`);
    void pressKey('ArrowDown');

    const fieldValuesTextContent = await waitForFunction(async () => {
      const fieldValues = await getTrimmedTextContent('.report-field-value');
      // Make sure the length is equivalent to the expected value below
      if (fieldValues.length === 3) {
        return fieldValues;
      }
      return undefined;
    });
    const expected = [
      `https://localhost:${getTestServerPort()}/test/e2e/resources/application/service-worker.js`,
      'Service Worker',
      'None',
    ];
    assert.deepEqual(fieldValuesTextContent, expected);
  });

  // Update and reactivate when the whole FrameDetailsView is a custom component
  it('can handle when JS writes to frame', async () => {
    expectError('Request CacheStorage.requestCacheNames failed. {"code":-32602,"message":"Invalid security origin"}');
    const {target} = getBrowserAndPages();
    await goToResource('application/main-frame.html');
    await click('#tab-resources');
    await doubleClickSourceTreeItem(TOP_FRAME_SELECTOR);
    await doubleClickSourceTreeItem(IFRAME_FRAME_ID_SELECTOR);

    // check iframe's URL after pageload
    const fieldValuesTextContent = await waitForFunction(async () => {
      const fieldValues = await getTrimmedTextContent('devtools-report-value');
      if (fieldValues[0]) {
        // This contains some CSS from the svg icon link being rendered. It's
        // system-specific, so we get rid of it and only look at the (URL) text.
        fieldValues[0] = getTrailingURL(fieldValues[0]);
      }
      if (fieldValues[9] && fieldValues[9].includes('accelerometer')) {
        fieldValues[9] = 'accelerometer';
      }
      // Make sure the length is equivalent to the expected value below
      if (fieldValues.length === 10) {
        return fieldValues;
      }
      return undefined;
    });
    const expected = [
      `https://localhost:${getTestServerPort()}/test/e2e/resources/application/iframe.html`,
      `https://localhost:${getTestServerPort()}`,
      '<iframe>',
      'Yes\xA0Localhost is always a secure context',
      'No',
      'None',
      'UnsafeNone',
      'unavailable\xA0requires cross-origin isolated context',
      'unavailable\xA0Learn more',
      'accelerometer',
    ];
    assert.deepEqual(fieldValuesTextContent, expected);

    assert.deepEqual(await getFrameTreeTitles(), ['top', 'frameId (iframe.html)', 'iframe.html', 'main-frame.html']);

    // write to the iframe using 'document.write()'
    await target.evaluate(() => {
      const frame = document.getElementById('frameId') as HTMLIFrameElement;
      const doc = frame.contentDocument;
      if (doc) {
        doc.open();
        doc.write('<h1>Hello world !</h1>');
        doc.close();
      }
    });

    // check that iframe's URL has changed
    await doubleClickSourceTreeItem(MAIN_FRAME_SELECTOR);
    const fieldValuesTextContent2 = await waitForFunction(async () => {
      const fieldValues = await getTrimmedTextContent('devtools-report-value');
      if (fieldValues[0]) {
        fieldValues[0] = getTrailingURL(fieldValues[0]);
      }
      if (fieldValues[9] && fieldValues[9].includes('accelerometer')) {
        fieldValues[9] = 'accelerometer';
      }
      // Make sure the length is equivalent to the expected value below
      if (fieldValues.length === 10) {
        return fieldValues;
      }
      return undefined;
    });
    const expected2 = [
      `https://localhost:${getTestServerPort()}/test/e2e/resources/application/main-frame.html`,
      `https://localhost:${getTestServerPort()}`,
      '<iframe>',
      'Yes\xA0Localhost is always a secure context',
      'No',
      'None',
      'UnsafeNone',
      'unavailable\xA0requires cross-origin isolated context',
      'unavailable\xA0Learn more',
      'accelerometer',
    ];
    assert.deepEqual(fieldValuesTextContent2, expected2);

    assert.deepEqual(
        await getFrameTreeTitles(), ['top', 'frameId (main-frame.html)', 'Document not available', 'main-frame.html']);
  });
});