Skip to content

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

chore(html): add speedboard with list of slowest tests (#37994)

Simon Knottb8f3338148c3
diff --git a/packages/html-reporter/src/chip.css b/packages/html-reporter/src/chip.css
index 66d1ea3d9d..b061b1c8cc 100644
--- a/packages/html-reporter/src/chip.css
+++ b/packages/html-reporter/src/chip.css
@@ -56,6 +56,11 @@
padding: 0;
}
+.chip-footer {
+ border-top: 1px solid var(--color-border-default);
+ padding: 8px;
+}
+
@media only screen and (max-width: 600px) {
.chip-header {
border-radius: 0;
diff --git a/packages/html-reporter/src/chip.tsx b/packages/html-reporter/src/chip.tsx
index 456c8157ed..df79a7181a 100644
--- a/packages/html-reporter/src/chip.tsx
+++ b/packages/html-reporter/src/chip.tsx
@@ -24,12 +24,13 @@ import { type AnchorID, useAnchor } from './links';
export const Chip: React.FC<{
header: React.JSX.Element | string,
+ footer?: React.JSX.Element | string,
expanded?: boolean,
noInsets?: boolean,
setExpanded?: (expanded: boolean) => void,
children?: any,
dataTestId?: string,
-}> = ({ header, expanded, setExpanded, children, noInsets, dataTestId }) => {
+}> = ({ header, footer, expanded, setExpanded, children, noInsets, dataTestId }) => {
const id = React.useId();
return <div className='chip' data-testid={dataTestId}>
<div
@@ -43,7 +44,10 @@ export const Chip: React.FC<{
{setExpanded && !expanded && icons.rightArrow()}
{header}
</div>
- {(!setExpanded || expanded) && <div id={id} role='region' className={clsx('chip-body', noInsets && 'chip-body-no-insets')}>{children}</div>}
+ {(!setExpanded || expanded) && <div id={id} role='region' className={clsx('chip-body', noInsets && 'chip-body-no-insets')}>
+ {children}
+ {footer && <div className='chip-footer'>{footer}</div>}
+ </div>}
</div>;
};
diff --git a/packages/html-reporter/src/common.css b/packages/html-reporter/src/common.css
index c34e279923..2cdb41bd3d 100644
--- a/packages/html-reporter/src/common.css
+++ b/packages/html-reporter/src/common.css
@@ -312,6 +312,10 @@ dialog {
margin-right: 0;
}
+.subnav-item .octicon.octicon-clock {
+ margin-right: 0;
+ color: var(--color-fg-default) !important;
+}
@media only screen and (max-width: 600px) {
.subnav-item, .form-control {
border-radius: 0 !important;
diff --git a/packages/html-reporter/src/headerView.tsx b/packages/html-reporter/src/headerView.tsx
index 9e39df53b8..d8c5f7165d 100644
--- a/packages/html-reporter/src/headerView.tsx
+++ b/packages/html-reporter/src/headerView.tsx
@@ -64,10 +64,15 @@ export const GlobalFilterView: React.FC<{
event => {
event.preventDefault();
const url = new URL(window.location.href);
+ const currentParams = new URLSearchParams(url.hash.slice(1));
// If <form/> onSubmit happens immediately after <input/> onChange, the filterText state is not updated yet.
// Using FormData here is a workaround to get the latest value.
const q = new FormData(event.target as HTMLFormElement).get('q') as string;
- url.hash = q ? '?' + new URLSearchParams({ q }) : '';
+ const params = new URLSearchParams({ q });
+ if (currentParams.has('speedboard'))
+ params.set('speedboard', '');
+ if (!!params.toString())
+ url.hash = '?' + params.toString();
navigate(url);
}
}>
@@ -93,6 +98,9 @@ const StatsNavView: React.FC<{
<NavLink token='failed' count={stats.unexpected} />
<NavLink token='flaky' count={stats.flaky} />
<NavLink token='skipped' count={stats.skipped} />
+ <Link className='subnav-item' href='#?speedboard' title='Speedboard'>
+ {icons.clock()}
+ </Link>
<SettingsButton />
</nav>;
};
@@ -135,24 +143,24 @@ const SettingsButton: React.FC = () => {
}}
onMouseDown={preventDefault}>
{icons.settings()}
+ <Dialog
+ open={settingsOpen}
+ minWidth={150}
+ verticalOffset={4}
+ requestClose={() => setSettingsOpen(false)}
+ anchor={settingsRef}
+ dataTestId='settings-dialog'
+ >
+ <label style={{ cursor: 'pointer', display: 'flex', alignItems: 'center', gap: 4 }} onClick={stopPropagation}>
+ <input type='checkbox' checked={darkMode} onChange={() => setDarkMode(!darkMode)}></input>
+ Dark mode
+ </label>
+ <label style={{ cursor: 'pointer', display: 'flex', alignItems: 'center', gap: 4 }} onClick={stopPropagation}>
+ <input type='checkbox' checked={mergeFiles} onChange={() => setMergeFiles(!mergeFiles)}></input>
+ Merge files
+ </label>
+ </Dialog>
</div>
- <Dialog
- open={settingsOpen}
- minWidth={150}
- verticalOffset={4}
- requestClose={() => setSettingsOpen(false)}
- anchor={settingsRef}
- dataTestId='settings-dialog'
- >
- <label style={{ cursor: 'pointer', display: 'flex', alignItems: 'center', gap: 4 }} onClick={stopPropagation}>
- <input type='checkbox' checked={darkMode} onChange={() => setDarkMode(!darkMode)}></input>
- Dark mode
- </label>
- <label style={{ cursor: 'pointer', display: 'flex', alignItems: 'center', gap: 4 }} onClick={stopPropagation}>
- <input type='checkbox' checked={mergeFiles} onChange={() => setMergeFiles(!mergeFiles)}></input>
- Merge files
- </label>
- </Dialog>
</>;
};
diff --git a/packages/html-reporter/src/icons.tsx b/packages/html-reporter/src/icons.tsx
index 85ce05c3fc..ab3aaa3b3d 100644
--- a/packages/html-reporter/src/icons.tsx
+++ b/packages/html-reporter/src/icons.tsx
@@ -60,7 +60,7 @@ export const check = () => {
};
export const clock = () => {
- return <svg aria-hidden='true' height='16' viewBox='0 0 16 16' version='1.1' width='16' data-view-component='true' className='octicon color-text-danger'>
+ return <svg aria-hidden='true' height='16' viewBox='0 0 16 16' version='1.1' width='16' data-view-component='true' className='octicon octicon-clock color-text-danger'>
<path fillRule='evenodd' d='M5.75.75A.75.75 0 016.5 0h3a.75.75 0 010 1.5h-.75v1l-.001.041a6.718 6.718 0 013.464 1.435l.007-.006.75-.75a.75.75 0 111.06 1.06l-.75.75-.006.007a6.75 6.75 0 11-10.548 0L2.72 5.03l-.75-.75a.75.75 0 011.06-1.06l.75.75.007.006A6.718 6.718 0 017.25 2.541a.756.756 0 010-.041v-1H6.5a.75.75 0 01-.75-.75zM8 14.5A5.25 5.25 0 108 4a5.25 5.25 0 000 10.5zm.389-6.7l1.33-1.33a.75.75 0 111.061 1.06L9.45 8.861A1.502 1.502 0 018 10.75a1.5 1.5 0 11.389-2.95z'></path>
</svg>;
};
diff --git a/packages/html-reporter/src/reportView.tsx b/packages/html-reporter/src/reportView.tsx
index 4cd5a4eba4..0b01a5446e 100644
--- a/packages/html-reporter/src/reportView.tsx
+++ b/packages/html-reporter/src/reportView.tsx
@@ -27,6 +27,7 @@ import { TestCaseView } from './testCaseView';
import { TestFilesHeader, TestFilesView } from './testFilesView';
import './theme.css';
import { useSetting } from '@web/uiUtils';
+import { Speedboard } from './speedboard';
declare global {
interface Window {
@@ -35,8 +36,9 @@ declare global {
}
// These are extracted to preserve the function identity between renders to avoid re-triggering effects.
-const testFilesRoutePredicate = (params: URLSearchParams) => !params.has('testId');
+const testFilesRoutePredicate = (params: URLSearchParams) => !params.has('testId') && !params.has('speedboard');
const testCaseRoutePredicate = (params: URLSearchParams) => params.has('testId');
+const speedboardRoutePredicate = (params: URLSearchParams) => params.has('speedboard');
type TestModelSummary = {
files: TestFileSummary[];
@@ -124,7 +126,7 @@ export const ReportView: React.FC<{
return <div className='htmlreport vbox px-4 pb-4'>
<main>
- {report?.json() && <GlobalFilterView stats={report.json().stats} filterText={filterText} setFilterText={setFilterText} />}
+ {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)}/>
<TestFilesView
@@ -134,8 +136,12 @@ export const ReportView: React.FC<{
projectNames={report?.json().projectNames || []}
/>
</Route>
+ <Route predicate={speedboardRoutePredicate}>
+ <TestFilesHeader report={report?.json()} filteredStats={filteredStats} metadataVisible={metadataVisible} toggleMetadataVisible={() => setMetadataVisible(visible => !visible)}/>
+ {report && <Speedboard filter={filter} report={report} />}
+ </Route>
<Route predicate={testCaseRoutePredicate}>
- {!!report && <TestCaseViewLoader report={report} next={next} prev={prev} testId={testId} testIdToFileIdMap={testIdToFileIdMap} />}
+ {report && <TestCaseViewLoader report={report} next={next} prev={prev} testId={testId} testIdToFileIdMap={testIdToFileIdMap} />}
</Route>
</main>
</div>;
diff --git a/packages/html-reporter/src/speedboard.tsx b/packages/html-reporter/src/speedboard.tsx
new file mode 100644
index 0000000000..001e7200e8
--- /dev/null
+++ b/packages/html-reporter/src/speedboard.tsx
@@ -0,0 +1,50 @@
+/**
+ * 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 React from 'react';
+import { Filter } from './filter';
+import { LoadedReport } from './loadedReport';
+import { TestFileView } from './testFileView';
+import * as icons from './icons';
+
+export function Speedboard({ filter, report }: { filter: Filter, report: LoadedReport}) {
+ return <>
+ <SlowestTests filter={filter} report={report} />
+ </>;
+}
+
+export function SlowestTests({ filter, report }: { filter: Filter, report: LoadedReport}) {
+ const [length, setLength] = React.useState(10);
+ const slowestTests = React.useMemo(() => {
+ const tests = report.json().files.flatMap(file => file.tests).filter(t => filter.matches(t));
+ return tests.sort((a, b) => b.duration - a.duration);
+ }, [report, filter]);
+ return <TestFileView
+ file={{
+ fileId: 'slowest',
+ fileName: 'Slowest Tests',
+ tests: slowestTests.slice(0, length),
+ stats: null as any,
+ }}
+ projectNames={report.json().projectNames}
+ footer={
+ <button className='link-badge' onClick={() => setLength(l => l + 10)}>
+ {icons.downArrow()}
+ Show more
+ </button>
+ }
+ />;
+}
diff --git a/packages/html-reporter/src/testFileView.tsx b/packages/html-reporter/src/testFileView.tsx
index 34e349b1e9..8a4dc31796 100644
--- a/packages/html-reporter/src/testFileView.tsx
+++ b/packages/html-reporter/src/testFileView.tsx
@@ -28,18 +28,21 @@ import { ProjectAndTagLabelsView } from './labels';
export const TestFileView: React.FC<React.PropsWithChildren<{
file: TestFileSummary;
projectNames: string[];
- isFileExpanded: (fileId: string) => boolean;
- setFileExpanded: (fileId: string, expanded: boolean) => void;
-}>> = ({ file, projectNames, isFileExpanded, setFileExpanded }) => {
+ isFileExpanded?: (fileId: string) => boolean;
+ setFileExpanded?: (fileId: string, expanded: boolean) => void;
+ footer?: React.JSX.Element | string;
+}>> = ({ file, projectNames, isFileExpanded, setFileExpanded, footer }) => {
const searchParams = React.useContext(SearchParamsContext);
const filterParam = searchParams.has('q') ? '&q=' + searchParams.get('q') : '';
return <Chip
- expanded={isFileExpanded(file.fileId)}
+ expanded={isFileExpanded ? isFileExpanded(file.fileId) : undefined}
noInsets={true}
- setExpanded={(expanded => setFileExpanded(file.fileId, expanded))}
+ setExpanded={setFileExpanded ? (expanded => setFileExpanded(file.fileId, expanded)) : undefined}
header={<span className='chip-header-allow-selection'>
{file.fileName}
- </span>}>
+ </span>}
+ footer={footer}
+ >
{file.tests.map(test =>
<div key={`test-${test.testId}`} className={clsx('test-file-test', 'test-file-test-outcome-' + test.outcome)}>
<div className='hbox' style={{ alignItems: 'flex-start' }}>