Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

10.0 KB
Raw Blame
/*
  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 { FilteredStats, TestCase, TestCaseSummary, TestFile, TestFileSummary } from './types';
import * as React from 'react';
import './colors.css';
import './common.css';
import { Filter, filterWithQuery } from './filter';
import { HeaderView, GlobalFilterView } from './headerView';
import { navigate, Route, testResultHref, useSearchParams } from './links';
import type { LoadedReport } from './loadedReport';
import './reportView.css';
import { TestCaseView } from './testCaseView';
import { TestFilesHeader, TestFilesView } from './testFilesView';
import './theme.css';
import { Speedboard } from './speedboard';

declare global {
  interface Window {
    playwrightReportBase64?: string;
  }
}

// These are extracted to preserve the function identity between renders to avoid re-triggering effects.
const testFilesRoutePredicate = (params: URLSearchParams) => !params.has('testId') && !params.has('speedboard');
const testCaseRoutePredicate = (params: URLSearchParams) => params.has('testId');
const speedboardRoutePredicate = (params: URLSearchParams) => params.has('speedboard') && !params.has('testId');

type TestModelSummary = {
  files: TestFileSummary[];
  tests: TestCaseSummary[];
};

export const ReportView: React.FC<{
  report: LoadedReport | undefined,
}> = ({ report }) => {
  const searchParams = useSearchParams();
  const [expandedFiles, setExpandedFiles] = React.useState<Map<string, boolean>>(new Map());
  const [filterText, setFilterText] = React.useState(searchParams.get('q') || '');
  const [metadataVisible, setMetadataVisible] = React.useState(false);
  const [errorsVisible, setErrorsVisible] = React.useState(true);
  const speedboard = searchParams.has('speedboard');
  const mergeFiles = !!report?.json()?.options.mergeFiles;
  const testId = searchParams.get('testId');
  const q = searchParams.get('q')?.toString() || '';
  const filterParam = q ? '&q=' + q : '';
  const reportTitle = report?.json()?.options.title;

  const testIdToFileIdMap = React.useMemo(() => {
    const map = new Map<string, string>();
    for (const file of report?.json().files || []) {
      for (const test of file.tests)
        map.set(test.testId, file.fileId);
    }
    return map;
  }, [report]);

  const filter = React.useMemo(() => Filter.parse(filterText), [filterText]);
  const filteredStats = React.useMemo(() => filter.empty() ? undefined : computeStats(report?.json().files || [], filter), [report, filter]);
  const testModel = React.useMemo(() => {
    if (speedboard)
      return createSpeedboardFilesModel(report, filter);
    if (mergeFiles)
      return createMergedFilesModel(report, filter);
    return createFilesModel(report, filter);
  }, [report, filter, mergeFiles, speedboard]);

  const { prev, next } = React.useMemo(() => {
    const index = testModel.tests.findIndex(t => t.testId === testId);
    const prev = index > 0 ? testModel.tests[index - 1] : undefined;
    const next = index < testModel.tests.length - 1 ? testModel.tests[index + 1] : undefined;
    return { prev, next };
  }, [testId, testModel]);

  React.useEffect(() => {
    const handleKeyDown = (event: KeyboardEvent) => {
      if (event.target instanceof HTMLInputElement || event.target instanceof HTMLTextAreaElement || event.shiftKey || event.ctrlKey || event.metaKey || event.altKey)
        return;

      const params = new URLSearchParams(searchParams);
      switch (event.key) {
        case 'a':
          event.preventDefault();
          navigate('#?');
          break;
        case 'p':
          event.preventDefault();
          params.delete('testId');
          params.delete('speedboard');
          navigate(filterWithQuery(params, 's:passed', false));
          break;
        case 'f':
          event.preventDefault();
          params.delete('testId');
          params.delete('speedboard');
          navigate(filterWithQuery(params, 's:failed', false));
          break;
        case 'ArrowLeft':
          if (prev) {
            event.preventDefault();
            params.delete('testId');
            navigate(testResultHref({ test: prev }, params) + filterParam);
          }
          break;
        case 'ArrowRight':
          if (next) {
            event.preventDefault();
            params.delete('testId');
            navigate(testResultHref({ test: next }, params) + filterParam);
          }
          break;
      }
    };

    document.addEventListener('keydown', handleKeyDown);
    return () => document.removeEventListener('keydown', handleKeyDown);
  }, [prev, next, filterParam, q, searchParams]);

  React.useEffect(() => {
    if (reportTitle)
      document.title = reportTitle;
    else
      document.title = 'Playwright Test Report';
  }, [reportTitle]);

  return <div className='htmlreport vbox px-4 pb-4'>
    <main>
      {report && <GlobalFilterView stats={report.json().stats} filterText={filterText} setFilterText={setFilterText} />}
      <Route predicate={testFilesRoutePredicate}>
        <TestFilesHeader
          report={report?.json()}
          filteredStats={filteredStats}
          metadataVisible={metadataVisible}
          toggleMetadataVisible={() => setMetadataVisible(visible => !visible)}
          errorsVisible={errorsVisible}
          setErrorsVisible={setErrorsVisible}/>
        <TestFilesView
          files={testModel.files}
          expandedFiles={expandedFiles}
          setExpandedFiles={setExpandedFiles}
          projectNames={report?.json().projectNames || []}
        />
      </Route>
      <Route predicate={speedboardRoutePredicate}>
        <TestFilesHeader
          report={report?.json()}
          filteredStats={filteredStats}
          metadataVisible={metadataVisible}
          toggleMetadataVisible={() => setMetadataVisible(visible => !visible)}
          errorsVisible={errorsVisible}
          setErrorsVisible={setErrorsVisible}/>
        {report && <Speedboard report={report} tests={testModel.tests} />}
      </Route>
      <Route predicate={testCaseRoutePredicate}>
        {report && <TestCaseViewLoader report={report} next={next} prev={prev} testId={testId} testIdToFileIdMap={testIdToFileIdMap} />}
      </Route>
    </main>
  </div>;
};

const TestCaseViewLoader: React.FC<{
  report: LoadedReport,
  testId: string | null,
  next?: TestCaseSummary,
  prev?: TestCaseSummary,
  testIdToFileIdMap: Map<string, string>,
}> = ({ report, testIdToFileIdMap, next, prev, testId }) => {
  const [test, setTest] = React.useState<TestCase | 'loading' | 'not-found'>('loading');
  const run = +(useSearchParams().get('run') || '0');

  React.useEffect(() => {
    (async () => {
      if (!testId || (typeof test === 'object' && testId === test.testId))
        return;
      const fileId = testIdToFileIdMap.get(testId);
      if (!fileId) {
        setTest('not-found');
        return;
      }
      const file = await report.entry(`${fileId}.json`) as TestFile;
      setTest(file?.tests.find(t => t.testId === testId) || 'not-found');
    })();
  }, [test, report, testId, testIdToFileIdMap]);

  if (test === 'loading')
    return <div className='test-case-column'></div>;

  if (test === 'not-found') {
    return <div className='test-case-column'>
      <HeaderView title='Test not found' />
      <div className='test-case-location'>Test ID: {testId}</div>
    </div>;
  }

  return <div className='test-case-column'>
    <TestCaseView
      report={report}
      next={next}
      prev={prev}
      test={test}
      run={run}
    />
  </div>;
};

function computeStats(files: TestFileSummary[], filter: Filter): FilteredStats {
  const stats: FilteredStats = {
    total: 0,
    duration: 0,
  };
  for (const file of files) {
    const tests = file.tests.filter(t => filter.matches(t));
    stats.total += tests.length;
    for (const test of tests)
      stats.duration += test.duration;
  }
  return stats;
}

function createFilesModel(report: LoadedReport | undefined, filter: Filter): TestModelSummary {
  const result: TestModelSummary = { files: [], tests: [] };
  for (const file of report?.json().files || []) {
    const tests = file.tests.filter(t => filter.matches(t));
    if (tests.length)
      result.files.push({ ...file, tests });
    result.tests.push(...tests);
  }
  return result;
}

function createMergedFilesModel(report: LoadedReport | undefined, filter: Filter): TestModelSummary {
  const groups: TestFileSummary[] = [];
  const groupMap = new Map<string, TestFileSummary>();

  for (const file of report?.json().files || []) {
    const tests = file.tests.filter(t => filter.matches(t));
    for (const test of tests) {
      const describe = test.path[0] ?? '<anonymous>';
      let group = groupMap.get(describe);
      if (!group) {
        group = {
          fileId: describe,
          fileName: describe,
          tests: [],
          stats: { total: 0, expected: 0, unexpected: 0, flaky: 0, skipped: 0, ok: true }
        };
        groupMap.set(describe, group);
        groups.push(group);
      }
      const testCopy = { ...test, path: test.path.slice(1) };
      group.tests.push(testCopy);
    }
  }

  groups.sort((a, b) => a.fileName.localeCompare(b.fileName));

  const result: TestModelSummary = { files: groups, tests: [] };
  for (const group of groups)
    result.tests.push(...group.tests);
  return result;
}

function createSpeedboardFilesModel(report: LoadedReport | undefined, filter: Filter): TestModelSummary {
  const files = report?.json().files || [];
  const tests = files.flatMap(file => file.tests).filter(t => filter.matches(t));
  tests.sort((a, b) => b.duration - a.duration);
  return {
    files: [],
    tests,
  };
}