1002 lines
38 KiB
TypeScript
Raw Normal View History

2023-03-01 15:27:23 -08:00
/**
* 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 '@web/third_party/vscode/codicon.css';
import { Workbench } from './workbench';
2023-03-01 15:27:23 -08:00
import '@web/common.css';
import React from 'react';
2023-03-08 17:33:27 -08:00
import { TreeView } from '@web/components/treeView';
import type { TreeState } from '@web/components/treeView';
import { baseFullConfig, TeleReporterReceiver, TeleSuite } from '@testIsomorphic/teleReceiver';
import type { TeleTestCase } from '@testIsomorphic/teleReceiver';
import type { FullConfig, Suite, TestCase, Location, TestError } from '@playwright/test/types/testReporter';
2023-03-01 15:27:23 -08:00
import { SplitView } from '@web/components/splitView';
import { idForAction, MultiTraceModel } from './modelUtil';
import type { SourceLocation } from './modelUtil';
import './uiModeView.css';
import { ToolbarButton } from '@web/components/toolbarButton';
import { Toolbar } from '@web/components/toolbar';
import type { ContextEntry } from '../entries';
2023-03-07 14:24:50 -08:00
import type { XtermDataSource } from '@web/components/xtermWrapper';
import { XtermWrapper } from '@web/components/xtermWrapper';
2023-03-10 12:41:00 -08:00
import { Expandable } from '@web/components/expandable';
2023-03-13 22:19:31 -07:00
import { toggleTheme } from '@web/theme';
import { artifactsFolderName } from '@testIsomorphic/folders';
import { msToString, settings, useSetting } from '@web/uiUtils';
import type { ActionTraceEvent } from '@trace/trace';
import { connect } from './wsPort';
2023-03-01 15:27:23 -08:00
let updateRootSuite: (config: FullConfig, rootSuite: Suite, loadErrors: TestError[], progress: Progress | undefined) => void = () => {};
let runWatchedTests = (fileNames: string[]) => {};
let xtermSize = { cols: 80, rows: 24 };
2023-03-01 15:27:23 -08:00
let sendMessage: (method: string, params?: any) => Promise<any> = async () => {};
2023-03-07 14:24:50 -08:00
const xtermDataSource: XtermDataSource = {
pending: [],
clear: () => {},
write: data => xtermDataSource.pending.push(data),
resize: (cols: number, rows: number) => {
xtermSize = { cols, rows };
sendMessageNoReply('resizeTerminal', { cols, rows });
},
2023-03-07 14:24:50 -08:00
};
type TestModel = {
config: FullConfig | undefined;
rootSuite: Suite | undefined;
loadErrors: TestError[];
};
export const UIModeView: React.FC<{}> = ({
2023-03-01 15:27:23 -08:00
}) => {
2023-03-13 22:19:31 -07:00
const [filterText, setFilterText] = React.useState<string>('');
const [isShowingOutput, setIsShowingOutput] = React.useState<boolean>(false);
const [statusFilters, setStatusFilters] = React.useState<Map<string, boolean>>(new Map([
['passed', false],
['failed', false],
['skipped', false],
]));
const [projectFilters, setProjectFilters] = React.useState<Map<string, boolean>>(new Map());
const [testModel, setTestModel] = React.useState<TestModel>({ config: undefined, rootSuite: undefined, loadErrors: [] });
2023-03-19 12:04:19 -07:00
const [progress, setProgress] = React.useState<Progress & { total: number } | undefined>();
const [selectedItem, setSelectedItem] = React.useState<{ testFile?: SourceLocation, testCase?: TestCase }>({});
2023-03-20 13:45:35 -07:00
const [visibleTestIds, setVisibleTestIds] = React.useState<Set<string>>(new Set());
2023-03-13 22:19:31 -07:00
const [isLoading, setIsLoading] = React.useState<boolean>(false);
2023-03-19 12:04:19 -07:00
const [runningState, setRunningState] = React.useState<{ testIds: Set<string>, itemSelectedByUser?: boolean } | undefined>();
const [watchAll, setWatchAll] = useSetting<boolean>('watch-all', false);
const [watchedTreeIds, setWatchedTreeIds] = React.useState<{ value: Set<string> }>({ value: new Set() });
2023-03-20 13:45:35 -07:00
const runTestPromiseChain = React.useRef(Promise.resolve());
const runTestBacklog = React.useRef<Set<string>>(new Set());
const [collapseAllCount, setCollapseAllCount] = React.useState(0);
const [isDisconnected, setIsDisconnected] = React.useState(false);
const [hasBrowsers, setHasBrowsers] = React.useState(true);
const inputRef = React.useRef<HTMLInputElement>(null);
const reloadTests = React.useCallback(() => {
2023-03-13 22:19:31 -07:00
setIsLoading(true);
setWatchedTreeIds({ value: new Set() });
updateRootSuite(baseFullConfig, new TeleSuite('', 'root'), [], undefined);
refreshRootSuite(true).then(async () => {
2023-03-13 22:19:31 -07:00
setIsLoading(false);
const { hasBrowsers } = await sendMessage('checkBrowsers');
setHasBrowsers(hasBrowsers);
2023-03-13 22:19:31 -07:00
});
}, []);
2023-03-13 22:19:31 -07:00
React.useEffect(() => {
inputRef.current?.focus();
setIsLoading(true);
connect({ onEvent: dispatchEvent, onClose: () => setIsDisconnected(true) }).then(send => {
sendMessage = send;
reloadTests();
});
}, [reloadTests]);
2023-03-07 12:43:16 -08:00
updateRootSuite = React.useCallback((config: FullConfig, rootSuite: Suite, loadErrors: TestError[], newProgress: Progress | undefined) => {
const selectedProjects = config.configFile ? settings.getObject<string[] | undefined>(config.configFile + ':projects', undefined) : undefined;
2023-03-13 22:19:31 -07:00
for (const projectName of projectFilters.keys()) {
if (!rootSuite.suites.find(s => s.title === projectName))
2023-03-13 22:19:31 -07:00
projectFilters.delete(projectName);
}
for (const projectSuite of rootSuite.suites) {
2023-03-13 22:19:31 -07:00
if (!projectFilters.has(projectSuite.title))
projectFilters.set(projectSuite.title, !!selectedProjects?.includes(projectSuite.title));
}
if (!selectedProjects && projectFilters.size && ![...projectFilters.values()].includes(true))
2023-03-13 22:19:31 -07:00
projectFilters.set(projectFilters.entries().next().value[0], true);
setTestModel({ config, rootSuite, loadErrors });
2023-03-13 22:19:31 -07:00
setProjectFilters(new Map(projectFilters));
2023-03-19 12:04:19 -07:00
if (runningState && newProgress)
setProgress({ ...newProgress, total: runningState.testIds.size });
else if (!newProgress)
setProgress(undefined);
}, [projectFilters, runningState]);
2023-03-07 12:43:16 -08:00
2023-03-20 13:45:35 -07:00
const runTests = React.useCallback((mode: 'queue-if-busy' | 'bounce-if-busy', testIds: Set<string>) => {
if (mode === 'bounce-if-busy' && runningState)
return;
runTestBacklog.current = new Set([...runTestBacklog.current, ...testIds]);
2023-03-20 13:45:35 -07:00
runTestPromiseChain.current = runTestPromiseChain.current.then(async () => {
const testIds = runTestBacklog.current;
runTestBacklog.current = new Set();
if (!testIds.size)
return;
2023-03-20 13:45:35 -07:00
// Clear test results.
{
for (const test of testModel.rootSuite?.allTests() || []) {
if (testIds.has(test.id)) {
(test as TeleTestCase)._clearResults();
2023-03-20 13:45:35 -07:00
(test as TeleTestCase)._createTestResult('pending');
}
2023-03-20 13:45:35 -07:00
}
setTestModel({ ...testModel });
}
2023-03-20 13:45:35 -07:00
const time = ' [' + new Date().toLocaleTimeString() + ']';
xtermDataSource.write('\x1B[2m—'.repeat(Math.max(0, xtermSize.cols - time.length)) + time + '\x1B[22m');
setProgress({ total: testIds.size, passed: 0, failed: 0, skipped: 0 });
setRunningState({ testIds });
await sendMessage('run', { testIds: [...testIds], projects: [...projectFilters].filter(([_, v]) => v).map(([p]) => p) });
// Clear pending tests in case of interrupt.
for (const test of testModel.rootSuite?.allTests() || []) {
if (test.results[0]?.duration === -1)
(test as TeleTestCase)._clearResults();
}
setTestModel({ ...testModel });
2023-03-12 10:42:02 -07:00
setRunningState(undefined);
2023-03-07 12:43:16 -08:00
});
}, [projectFilters, runningState, testModel]);
2023-03-07 12:43:16 -08:00
2023-03-12 10:42:02 -07:00
const isRunningTest = !!runningState;
2023-03-15 11:17:03 -07:00
return <div className='vbox ui-mode'>
{isDisconnected && <div className='drop-target'>
<div className='title'>UI Mode disconnected</div>
<div><a href='#' onClick={() => window.location.reload()}>Reload the page</a> to reconnect</div>
</div>}
<SplitView sidebarSize={250} minSidebarSize={125} orientation='horizontal' sidebarIsFirst={true}>
<div className='vbox'>
<div className={'vbox' + (isShowingOutput ? '' : ' hidden')}>
<Toolbar>
2023-03-19 12:04:19 -07:00
<div className='section-title' style={{ flex: 'none' }}>Output</div>
<ToolbarButton icon='circle-slash' title='Clear output' onClick={() => xtermDataSource.clear()}></ToolbarButton>
<div className='spacer'></div>
<ToolbarButton icon='close' title='Close' onClick={() => setIsShowingOutput(false)}></ToolbarButton>
</Toolbar>
2023-03-19 12:04:19 -07:00
<XtermWrapper source={xtermDataSource}></XtermWrapper>
</div>
<div className={'vbox' + (isShowingOutput ? ' hidden' : '')}>
2023-03-19 12:04:19 -07:00
<TraceView item={selectedItem} rootDir={testModel.config?.rootDir} />
</div>
</div>
<div className='vbox ui-mode-sidebar'>
<Toolbar noShadow={true} noMinHeight={true}>
<img src='playwright-logo.svg' />
2023-03-13 22:19:31 -07:00
<div className='section-title'>Playwright</div>
<ToolbarButton icon='color-mode' title='Toggle color mode' onClick={() => toggleTheme()} />
2023-03-13 22:19:31 -07:00
<ToolbarButton icon='refresh' title='Reload' onClick={() => reloadTests()} disabled={isRunningTest || isLoading}></ToolbarButton>
<ToolbarButton icon='terminal' title='Toggle output' toggled={isShowingOutput} onClick={() => { setIsShowingOutput(!isShowingOutput); }} />
{!hasBrowsers && <ToolbarButton icon='lightbulb-autofix' style={{ color: 'var(--vscode-errorForeground)' }}title='Install browsers' toggled={isShowingOutput} onClick={() => {
setIsShowingOutput(true);
sendMessage('installBrowsers').then(async () => {
setIsShowingOutput(false);
const { hasBrowsers } = await sendMessage('checkBrowsers');
setHasBrowsers(hasBrowsers);
});
}} />}
2023-03-13 22:19:31 -07:00
</Toolbar>
<FiltersView
filterText={filterText}
setFilterText={setFilterText}
statusFilters={statusFilters}
setStatusFilters={setStatusFilters}
projectFilters={projectFilters}
setProjectFilters={setProjectFilters}
testModel={testModel}
2023-03-20 13:45:35 -07:00
runTests={() => runTests('bounce-if-busy', visibleTestIds)} />
2023-03-19 12:04:19 -07:00
<Toolbar noMinHeight={true}>
{!isRunningTest && !progress && <div className='section-title'>Tests</div>}
{!isRunningTest && progress && <div data-testid='status-line' className='status-line'>
<div>{progress.passed}/{progress.total} passed ({(progress.passed / progress.total) * 100 | 0}%)</div>
</div>}
{isRunningTest && progress && <div data-testid='status-line' className='status-line'>
<div>Running {progress.passed}/{runningState.testIds.size} passed ({(progress.passed / runningState.testIds.size) * 100 | 0}%)</div>
</div>}
2023-03-20 13:45:35 -07:00
<ToolbarButton icon='play' title='Run all' onClick={() => runTests('bounce-if-busy', visibleTestIds)} disabled={isRunningTest || isLoading}></ToolbarButton>
2023-03-13 22:19:31 -07:00
<ToolbarButton icon='debug-stop' title='Stop' onClick={() => sendMessageNoReply('stop')} disabled={!isRunningTest || isLoading}></ToolbarButton>
<ToolbarButton icon='eye' title='Watch all' toggled={watchAll} onClick={() => setWatchAll(!watchAll)}></ToolbarButton>
<ToolbarButton icon='collapse-all' title='Collapse all' onClick={() => {
setCollapseAllCount(collapseAllCount + 1);
}} />
2023-03-07 14:24:50 -08:00
</Toolbar>
<TestList
2023-03-13 22:19:31 -07:00
statusFilters={statusFilters}
projectFilters={projectFilters}
filterText={filterText}
testModel={testModel}
2023-03-12 10:42:02 -07:00
runningState={runningState}
2023-03-07 14:24:50 -08:00
runTests={runTests}
2023-03-19 12:04:19 -07:00
onItemSelected={setSelectedItem}
setVisibleTestIds={setVisibleTestIds}
watchAll={watchAll}
watchedTreeIds={watchedTreeIds}
setWatchedTreeIds={setWatchedTreeIds}
isLoading={isLoading}
requestedCollapseAllCount={collapseAllCount} />
2023-03-07 14:24:50 -08:00
</div>
</SplitView>
</div>;
2023-03-07 12:43:16 -08:00
};
2023-03-13 22:19:31 -07:00
const FiltersView: React.FC<{
filterText: string;
setFilterText: (text: string) => void;
statusFilters: Map<string, boolean>;
setStatusFilters: (filters: Map<string, boolean>) => void;
projectFilters: Map<string, boolean>;
setProjectFilters: (filters: Map<string, boolean>) => void;
testModel: TestModel | undefined,
2023-03-13 22:19:31 -07:00
runTests: () => void;
}> = ({ filterText, setFilterText, statusFilters, setStatusFilters, projectFilters, setProjectFilters, testModel, runTests }) => {
2023-03-13 22:19:31 -07:00
const [expanded, setExpanded] = React.useState(false);
const inputRef = React.useRef<HTMLInputElement>(null);
React.useEffect(() => {
inputRef.current?.focus();
}, []);
const statusLine = [...statusFilters.entries()].filter(([_, v]) => v).map(([s]) => s).join(' ') || 'all';
const projectsLine = [...projectFilters.entries()].filter(([_, v]) => v).map(([p]) => p).join(' ') || 'all';
return <div className='filters'>
<Expandable
expanded={expanded}
setExpanded={setExpanded}
title={<input ref={inputRef} type='search' placeholder='Filter (e.g. text, @tag)' spellCheck={false} value={filterText}
onChange={e => {
setFilterText(e.target.value);
}}
onKeyDown={e => {
if (e.key === 'Enter')
runTests();
}} />}>
</Expandable>
<div className='filter-summary' title={'Status: ' + statusLine + '\nProjects: ' + projectsLine} onClick={() => setExpanded(!expanded)}>
2023-03-13 22:19:31 -07:00
<span className='filter-label'>Status:</span> {statusLine}
<span className='filter-label'>Projects:</span> {projectsLine}
</div>
{expanded && <div className='hbox' style={{ marginLeft: 14 }}>
<div className='filter-list'>
{[...statusFilters.entries()].map(([status, value]) => {
return <div className='filter-entry'>
<label>
<input type='checkbox' checked={value} onClick={() => {
const copy = new Map(statusFilters);
copy.set(status, !copy.get(status));
setStatusFilters(copy);
}}/>
<div>{status}</div>
</label>
</div>;
})}
</div>
<div className='filter-list'>
{[...projectFilters.entries()].map(([projectName, value]) => {
return <div className='filter-entry'>
<label>
<input type='checkbox' checked={value} onClick={() => {
const copy = new Map(projectFilters);
copy.set(projectName, !copy.get(projectName));
setProjectFilters(copy);
const configFile = testModel?.config?.configFile;
if (configFile)
settings.setObject(configFile + ':projects', [...copy.entries()].filter(([_, v]) => v).map(([k]) => k));
}}/>
<div>{projectName}</div>
</label>
</div>;
})}
</div>
2023-03-13 22:19:31 -07:00
</div>}
</div>;
};
const TestTreeView = TreeView<TreeItem>;
2023-03-08 17:33:27 -08:00
2023-03-13 22:19:31 -07:00
const TestList: React.FC<{
statusFilters: Map<string, boolean>,
projectFilters: Map<string, boolean>,
filterText: string,
testModel: TestModel,
2023-03-20 13:45:35 -07:00
runTests: (mode: 'bounce-if-busy' | 'queue-if-busy', testIds: Set<string>) => void,
2023-03-12 10:42:02 -07:00
runningState?: { testIds: Set<string>, itemSelectedByUser?: boolean },
watchAll: boolean,
watchedTreeIds: { value: Set<string> },
setWatchedTreeIds: (ids: { value: Set<string> }) => void,
isLoading?: boolean,
2023-03-20 13:45:35 -07:00
setVisibleTestIds: (testIds: Set<string>) => void,
onItemSelected: (item: { testCase?: TestCase, testFile?: SourceLocation }) => void,
requestedCollapseAllCount: number,
}> = ({ statusFilters, projectFilters, filterText, testModel, runTests, runningState, watchAll, watchedTreeIds, setWatchedTreeIds, isLoading, onItemSelected, setVisibleTestIds, requestedCollapseAllCount }) => {
2023-03-08 17:33:27 -08:00
const [treeState, setTreeState] = React.useState<TreeState>({ expandedItems: new Map() });
2023-03-07 12:43:16 -08:00
const [selectedTreeItemId, setSelectedTreeItemId] = React.useState<string | undefined>();
const [collapseAllCount, setCollapseAllCount] = React.useState(requestedCollapseAllCount);
2023-03-01 15:27:23 -08:00
// Build the test tree.
const { rootItem, treeItemMap, fileNames } = React.useMemo(() => {
let rootItem = createTree(testModel.rootSuite, testModel.loadErrors, projectFilters);
filterTree(rootItem, filterText, statusFilters, runningState?.testIds);
sortAndPropagateStatus(rootItem);
rootItem = shortenRoot(rootItem);
hideOnlyTests(rootItem);
const treeItemMap = new Map<string, TreeItem>();
const visibleTestIds = new Set<string>();
const fileNames = new Set<string>();
const visit = (treeItem: TreeItem) => {
if (treeItem.kind === 'group' && treeItem.location.file)
fileNames.add(treeItem.location.file);
if (treeItem.kind === 'case')
treeItem.tests.forEach(t => visibleTestIds.add(t.id));
treeItem.children.forEach(visit);
treeItemMap.set(treeItem.id, treeItem);
};
2023-03-08 17:33:27 -08:00
visit(rootItem);
2023-03-20 13:45:35 -07:00
setVisibleTestIds(visibleTestIds);
return { rootItem, treeItemMap, fileNames };
}, [filterText, testModel, statusFilters, projectFilters, setVisibleTestIds, runningState]);
// Look for a first failure within the run batch to select it.
2023-03-12 10:42:02 -07:00
React.useEffect(() => {
// If collapse was requested, clear the expanded items and return w/o selected item.
if (collapseAllCount !== requestedCollapseAllCount) {
treeState.expandedItems.clear();
for (const item of treeItemMap.keys())
treeState.expandedItems.set(item, false);
setCollapseAllCount(requestedCollapseAllCount);
setSelectedTreeItemId(undefined);
setTreeState({ ...treeState });
return;
}
2023-03-12 10:42:02 -07:00
if (!runningState || runningState.itemSelectedByUser)
return;
let selectedTreeItem: TreeItem | undefined;
const visit = (treeItem: TreeItem) => {
2023-03-13 22:19:31 -07:00
treeItem.children.forEach(visit);
2023-03-12 10:42:02 -07:00
if (selectedTreeItem)
return;
if (treeItem.status === 'failed') {
if (treeItem.kind === 'test' && runningState.testIds.has(treeItem.test.id))
selectedTreeItem = treeItem;
else if (treeItem.kind === 'case' && runningState.testIds.has(treeItem.tests[0]?.id))
selectedTreeItem = treeItem;
}
};
visit(rootItem);
if (selectedTreeItem)
setSelectedTreeItemId(selectedTreeItem.id);
}, [runningState, setSelectedTreeItemId, rootItem, collapseAllCount, setCollapseAllCount, requestedCollapseAllCount, treeState, setTreeState, treeItemMap]);
2023-03-12 10:42:02 -07:00
// Compute selected item.
2023-03-08 17:33:27 -08:00
const { selectedTreeItem } = React.useMemo(() => {
const selectedTreeItem = selectedTreeItemId ? treeItemMap.get(selectedTreeItemId) : undefined;
let testFile: SourceLocation | undefined;
if (selectedTreeItem) {
testFile = {
file: selectedTreeItem.location.file,
line: selectedTreeItem.location.line,
source: {
errors: testModel.loadErrors.filter(e => e.location?.file === selectedTreeItem.location.file).map(e => ({ line: e.location!.line, message: e.message! })),
content: undefined,
}
};
}
2023-03-08 17:33:27 -08:00
let selectedTest: TestCase | undefined;
if (selectedTreeItem?.kind === 'test')
2023-03-08 17:33:27 -08:00
selectedTest = selectedTreeItem.test;
else if (selectedTreeItem?.kind === 'case' && selectedTreeItem.tests.length === 1)
selectedTest = selectedTreeItem.tests[0];
onItemSelected({ testCase: selectedTest, testFile });
2023-03-08 17:33:27 -08:00
return { selectedTreeItem };
}, [onItemSelected, selectedTreeItemId, testModel, treeItemMap]);
// Update watch all.
React.useEffect(() => {
if (isLoading)
return;
if (watchAll) {
sendMessageNoReply('watch', { fileNames: [...fileNames] });
} else {
const fileNames = new Set<string>();
for (const itemId of watchedTreeIds.value) {
2023-03-21 12:03:26 -07:00
const treeItem = treeItemMap.get(itemId);
const fileName = treeItem?.location.file;
if (fileName)
fileNames.add(fileName);
}
sendMessageNoReply('watch', { fileNames: [...fileNames] });
}
}, [isLoading, rootItem, fileNames, watchAll, watchedTreeIds, treeItemMap]);
const runTreeItem = (treeItem: TreeItem) => {
setSelectedTreeItemId(treeItem.id);
2023-03-20 13:45:35 -07:00
runTests('bounce-if-busy', collectTestIds(treeItem));
};
2023-03-20 13:45:35 -07:00
runWatchedTests = (changedTestFiles: string[]) => {
const testIds: string[] = [];
2023-03-20 13:45:35 -07:00
const set = new Set(changedTestFiles);
if (watchAll) {
const visit = (treeItem: TreeItem) => {
2023-03-20 13:45:35 -07:00
const fileName = treeItem.location.file;
if (fileName && set.has(fileName))
testIds.push(...collectTestIds(treeItem));
2023-03-20 13:45:35 -07:00
if (treeItem.kind === 'group' && treeItem.subKind === 'folder')
treeItem.children.forEach(visit);
};
visit(rootItem);
} else {
for (const treeId of watchedTreeIds.value) {
2023-03-21 12:03:26 -07:00
const treeItem = treeItemMap.get(treeId);
const fileName = treeItem?.location.file;
if (fileName && set.has(fileName))
testIds.push(...collectTestIds(treeItem));
}
}
2023-03-20 13:45:35 -07:00
runTests('queue-if-busy', new Set(testIds));
};
return <TestTreeView
treeState={treeState}
setTreeState={setTreeState}
rootItem={rootItem}
dataTestId='test-tree'
render={treeItem => {
return <div className='hbox ui-mode-list-item'>
<div className='ui-mode-list-item-title'>{treeItem.title}</div>
{!!treeItem.duration && treeItem.status !== 'skipped' && <div className='ui-mode-list-item-time'>{msToString(treeItem.duration)}</div>}
<Toolbar noMinHeight={true} noShadow={true}>
<ToolbarButton icon='play' title='Run' onClick={() => runTreeItem(treeItem)} disabled={!!runningState}></ToolbarButton>
<ToolbarButton icon='go-to-file' title='Open in VS Code' onClick={() => sendMessageNoReply('open', { location: locationToOpen(treeItem) })} style={(treeItem.kind === 'group' && treeItem.subKind === 'folder') ? { visibility: 'hidden' } : {}}></ToolbarButton>
{!watchAll && <ToolbarButton icon='eye' title='Watch' onClick={() => {
if (watchedTreeIds.value.has(treeItem.id))
watchedTreeIds.value.delete(treeItem.id);
else
watchedTreeIds.value.add(treeItem.id);
setWatchedTreeIds({ ...watchedTreeIds });
}} toggled={watchedTreeIds.value.has(treeItem.id)}></ToolbarButton>}
</Toolbar>
</div>;
}}
icon={treeItem => {
if (treeItem.status === 'scheduled')
return 'codicon-clock';
if (treeItem.status === 'running')
return 'codicon-loading';
if (treeItem.status === 'failed')
return 'codicon-error';
if (treeItem.status === 'passed')
return 'codicon-check';
if (treeItem.status === 'skipped')
return 'codicon-circle-slash';
return 'codicon-circle-outline';
}}
selectedItem={selectedTreeItem}
onAccepted={runTreeItem}
onSelected={treeItem => {
2023-03-12 10:42:02 -07:00
if (runningState)
runningState.itemSelectedByUser = true;
setSelectedTreeItemId(treeItem.id);
}}
isError={treeItem => treeItem.kind === 'group' ? treeItem.hasLoadErrors : false}
autoExpandDepth={filterText ? 5 : 1}
noItemsMessage={isLoading ? 'Loading\u2026' : 'No tests'} />;
2023-03-07 14:24:50 -08:00
};
2023-03-15 11:17:03 -07:00
const TraceView: React.FC<{
item: { testFile?: SourceLocation, testCase?: TestCase },
2023-03-19 12:04:19 -07:00
rootDir?: string,
}> = ({ item, rootDir }) => {
const [model, setModel] = React.useState<{ model: MultiTraceModel, isLive: boolean } | undefined>();
const [counter, setCounter] = React.useState(0);
2023-03-15 11:17:03 -07:00
const pollTimer = React.useRef<NodeJS.Timeout | null>(null);
2023-03-01 15:27:23 -08:00
const { outputDir } = React.useMemo(() => {
2023-03-19 12:04:19 -07:00
const outputDir = item.testCase ? outputDirForTestCase(item.testCase) : undefined;
return { outputDir };
2023-03-19 12:04:19 -07:00
}, [item]);
// Preserve user selection upon live-reloading trace model by persisting the action id.
// This avoids auto-selection of the last action every time we reload the model.
const [selectedActionId, setSelectedActionId] = React.useState<string | undefined>();
const onSelectionChanged = React.useCallback((action: ActionTraceEvent) => setSelectedActionId(idForAction(action)), [setSelectedActionId]);
const initialSelection = selectedActionId ? model?.model.actions.find(a => idForAction(a) === selectedActionId) : undefined;
2023-03-01 15:27:23 -08:00
React.useEffect(() => {
2023-03-15 11:17:03 -07:00
if (pollTimer.current)
clearTimeout(pollTimer.current);
const result = item.testCase?.results[0];
if (!result) {
setModel(undefined);
return;
}
// Test finished.
const attachment = result && result.duration >= 0 && result.attachments.find(a => a.name === 'trace');
if (attachment && attachment.path) {
loadSingleTraceFile(attachment.path).then(model => setModel({ model, isLive: false }));
2023-03-15 11:17:03 -07:00
return;
}
if (!outputDir) {
setModel(undefined);
return;
}
2023-03-19 12:04:19 -07:00
const traceLocation = `${outputDir}/${artifactsFolderName(result!.workerIndex)}/traces/${item.testCase?.id}.json`;
2023-03-15 11:17:03 -07:00
// Start polling running test.
pollTimer.current = setTimeout(async () => {
try {
const model = await loadSingleTraceFile(traceLocation);
setModel({ model, isLive: true });
} catch {
setModel(undefined);
} finally {
setCounter(counter + 1);
}
}, 500);
return () => {
if (pollTimer.current)
clearTimeout(pollTimer.current);
};
}, [outputDir, item, setModel, counter, setCounter]);
2023-03-19 12:04:19 -07:00
return <Workbench
key='workbench'
model={model?.model}
2023-03-19 12:04:19 -07:00
hideStackFrames={true}
showSourcesFirst={true}
rootDir={rootDir}
initialSelection={initialSelection}
onSelectionChanged={onSelectionChanged}
fallbackLocation={item.testFile}
2023-08-18 17:53:03 -07:00
isLive={model?.isLive} />;
2023-03-01 15:27:23 -08:00
};
let receiver: TeleReporterReceiver | undefined;
let throttleTimer: NodeJS.Timeout | undefined;
let throttleData: { config: FullConfig, rootSuite: Suite, loadErrors: TestError[], progress: Progress } | undefined;
const throttledAction = () => {
clearTimeout(throttleTimer);
throttleTimer = undefined;
updateRootSuite(throttleData!.config, throttleData!.rootSuite, throttleData!.loadErrors, throttleData!.progress);
};
const throttleUpdateRootSuite = (config: FullConfig, rootSuite: Suite, loadErrors: TestError[], progress: Progress, immediate = false) => {
throttleData = { config, rootSuite, loadErrors, progress };
if (immediate)
throttledAction();
else if (!throttleTimer)
throttleTimer = setTimeout(throttledAction, 250);
};
2023-03-13 22:19:31 -07:00
const refreshRootSuite = (eraseResults: boolean): Promise<void> => {
if (!eraseResults)
return sendMessage('list', {});
let rootSuite: Suite;
const loadErrors: TestError[] = [];
const progress: Progress = {
passed: 0,
failed: 0,
skipped: 0,
};
let config: FullConfig;
receiver = new TeleReporterReceiver(pathSeparator, {
version: () => 'v2',
onConfigure: (c: FullConfig) => {
config = c;
},
onBegin: (suite: Suite) => {
if (!rootSuite)
rootSuite = suite;
progress.passed = 0;
progress.failed = 0;
progress.skipped = 0;
throttleUpdateRootSuite(config, rootSuite, loadErrors, progress, true);
},
onEnd: () => {
throttleUpdateRootSuite(config, rootSuite, loadErrors, progress, true);
},
onTestBegin: () => {
throttleUpdateRootSuite(config, rootSuite, loadErrors, progress);
},
onTestEnd: (test: TestCase) => {
if (test.outcome() === 'skipped')
++progress.skipped;
else if (test.outcome() === 'unexpected')
++progress.failed;
else
++progress.passed;
throttleUpdateRootSuite(config, rootSuite, loadErrors, progress);
},
2023-03-21 12:03:26 -07:00
onError: (error: TestError) => {
xtermDataSource.write((error.stack || error.value || '') + '\n');
loadErrors.push(error);
throttleUpdateRootSuite(config, rootSuite ?? new TeleSuite('', 'root'), loadErrors, progress);
},
printsToStdio: () => {
return false;
2023-03-21 12:03:26 -07:00
},
onStdOut: () => {},
onStdErr: () => {},
onExit: () => {},
onStepBegin: () => {},
onStepEnd: () => {},
}, true);
receiver._setClearPreviousResultsWhenTestBegins();
2023-03-13 22:19:31 -07:00
return sendMessage('list', {});
};
2023-03-01 15:27:23 -08:00
const sendMessageNoReply = (method: string, params?: any) => {
if ((window as any)._overrideProtocolForTest) {
(window as any)._overrideProtocolForTest({ method, params }).catch(() => {});
return;
}
sendMessage(method, params).catch((e: Error) => {
// eslint-disable-next-line no-console
console.error(e);
2023-03-01 15:27:23 -08:00
});
};
const dispatchEvent = (method: string, params?: any) => {
if (method === 'listChanged') {
refreshRootSuite(false).catch(() => {});
return;
}
if (method === 'testFilesChanged') {
runWatchedTests(params.testFileNames);
return;
}
if (method === 'stdio') {
if (params.buffer) {
const data = atob(params.buffer);
xtermDataSource.write(data);
} else {
xtermDataSource.write(params.text);
}
return;
}
receiver?.dispatch({ method, params })?.catch(() => {});
};
const outputDirForTestCase = (testCase: TestCase): string | undefined => {
for (let suite: Suite | undefined = testCase.parent; suite; suite = suite.parent) {
if (suite.project())
return suite.project()?.outputDir;
}
return undefined;
};
const locationToOpen = (treeItem?: TreeItem) => {
if (!treeItem)
return;
return treeItem.location.file + ':' + treeItem.location.line;
};
2023-03-20 13:45:35 -07:00
const collectTestIds = (treeItem?: TreeItem): Set<string> => {
const testIds = new Set<string>();
if (!treeItem)
2023-03-20 13:45:35 -07:00
return testIds;
const visit = (treeItem: TreeItem) => {
2023-03-08 17:33:27 -08:00
if (treeItem.kind === 'case')
2023-03-20 13:45:35 -07:00
treeItem.tests.map(t => t.id).forEach(id => testIds.add(id));
2023-03-08 17:33:27 -08:00
else if (treeItem.kind === 'test')
2023-03-20 13:45:35 -07:00
testIds.add(treeItem.id);
2023-03-08 17:33:27 -08:00
else
treeItem.children?.forEach(visit);
};
visit(treeItem);
return testIds;
};
type Progress = {
passed: number;
failed: number;
skipped: number;
};
type TreeItemBase = {
kind: 'root' | 'group' | 'case' | 'test',
id: string;
title: string;
location: Location,
duration: number;
2023-03-12 10:42:02 -07:00
parent: TreeItem | undefined;
2023-03-08 17:33:27 -08:00
children: TreeItem[];
status: 'none' | 'running' | 'scheduled' | 'passed' | 'failed' | 'skipped';
};
type GroupItem = TreeItemBase & {
kind: 'group';
subKind: 'folder' | 'file' | 'describe';
hasLoadErrors: boolean;
children: (TestCaseItem | GroupItem)[];
};
type TestCaseItem = TreeItemBase & {
kind: 'case',
2023-03-08 17:33:27 -08:00
tests: TestCase[];
2023-03-10 12:41:00 -08:00
children: TestItem[];
};
type TestItem = TreeItemBase & {
kind: 'test',
test: TestCase;
2023-03-10 12:41:00 -08:00
project: string;
};
type TreeItem = GroupItem | TestCaseItem | TestItem;
function getFileItem(rootItem: GroupItem, filePath: string[], isFile: boolean, fileItems: Map<string, GroupItem>): GroupItem {
if (filePath.length === 0)
return rootItem;
const fileName = filePath.join(pathSeparator);
const existingFileItem = fileItems.get(fileName);
if (existingFileItem)
return existingFileItem;
const parentFileItem = getFileItem(rootItem, filePath.slice(0, filePath.length - 1), false, fileItems);
const fileItem: GroupItem = {
kind: 'group',
subKind: isFile ? 'file' : 'folder',
id: fileName,
title: filePath[filePath.length - 1],
location: { file: fileName, line: 0, column: 0 },
duration: 0,
parent: parentFileItem,
children: [],
status: 'none',
hasLoadErrors: false,
};
parentFileItem.children.push(fileItem);
fileItems.set(fileName, fileItem);
return fileItem;
}
function createTree(rootSuite: Suite | undefined, loadErrors: TestError[], projectFilters: Map<string, boolean>): GroupItem {
2023-03-13 22:19:31 -07:00
const filterProjects = [...projectFilters.values()].some(Boolean);
const rootItem: GroupItem = {
kind: 'group',
subKind: 'folder',
2023-03-08 17:33:27 -08:00
id: 'root',
title: '',
location: { file: '', line: 0, column: 0 },
duration: 0,
2023-03-12 10:42:02 -07:00
parent: undefined,
2023-03-08 17:33:27 -08:00
children: [],
status: 'none',
hasLoadErrors: false,
2023-03-08 17:33:27 -08:00
};
const visitSuite = (projectName: string, parentSuite: Suite, parentGroup: GroupItem) => {
for (const suite of parentSuite.suites) {
const title = suite.title || '<anonymous>';
let group = parentGroup.children.find(item => item.title === title) as GroupItem | undefined;
if (!group) {
group = {
kind: 'group',
subKind: 'describe',
id: parentGroup.id + '\x1e' + title,
title,
location: suite.location!,
duration: 0,
2023-03-12 10:42:02 -07:00
parent: parentGroup,
children: [],
status: 'none',
hasLoadErrors: false,
};
parentGroup.children.push(group);
}
visitSuite(projectName, suite, group);
}
for (const test of parentSuite.tests) {
const title = test.title;
let testCaseItem = parentGroup.children.find(t => t.title === title) as TestCaseItem;
if (!testCaseItem) {
testCaseItem = {
kind: 'case',
id: parentGroup.id + '\x1e' + title,
title,
2023-03-12 10:42:02 -07:00
parent: parentGroup,
2023-03-08 17:33:27 -08:00
children: [],
tests: [],
location: test.location,
duration: 0,
status: 'none',
};
parentGroup.children.push(testCaseItem);
}
const result = (test as TeleTestCase).results[0];
let status: 'none' | 'running' | 'scheduled' | 'passed' | 'failed' | 'skipped' = 'none';
if (result?.statusEx === 'scheduled')
status = 'scheduled';
else if (result?.statusEx === 'running')
status = 'running';
else if (result?.status === 'skipped')
status = 'skipped';
else if (result?.status === 'interrupted')
status = 'none';
else if (result && test.outcome() !== 'expected')
status = 'failed';
else if (result && test.outcome() === 'expected')
status = 'passed';
testCaseItem.tests.push(test);
testCaseItem.children.push({
kind: 'test',
id: test.id,
title: projectName,
location: test.location!,
test,
2023-03-12 10:42:02 -07:00
parent: testCaseItem,
children: [],
status,
duration: test.results.length ? Math.max(0, test.results[0].duration) : 0,
project: projectName,
});
testCaseItem.duration = (testCaseItem.children as TestItem[]).reduce((a, b) => a + b.duration, 0);
}
};
const fileMap = new Map<string, GroupItem>();
for (const projectSuite of rootSuite?.suites || []) {
2023-03-13 22:19:31 -07:00
if (filterProjects && !projectFilters.get(projectSuite.title))
continue;
for (const fileSuite of projectSuite.suites) {
const fileItem = getFileItem(rootItem, fileSuite.location!.file.split(pathSeparator), true, fileMap);
visitSuite(projectSuite.title, fileSuite, fileItem);
}
}
for (const loadError of loadErrors) {
if (!loadError.location)
continue;
const fileItem = getFileItem(rootItem, loadError.location.file.split(pathSeparator), true, fileMap);
fileItem.hasLoadErrors = true;
}
return rootItem;
}
function filterTree(rootItem: GroupItem, filterText: string, statusFilters: Map<string, boolean>, runningTestIds: Set<string> | undefined) {
2023-03-13 22:19:31 -07:00
const tokens = filterText.trim().toLowerCase().split(' ');
const filtersStatuses = [...statusFilters.values()].some(Boolean);
2023-03-10 12:41:00 -08:00
const filter = (testCase: TestCaseItem) => {
const title = testCase.tests[0].titlePath().join(' ').toLowerCase();
if (!tokens.every(token => title.includes(token)) && !testCase.tests.some(t => runningTestIds?.has(t.id)))
2023-03-10 12:41:00 -08:00
return false;
testCase.children = (testCase.children as TestItem[]).filter(test => {
return !filtersStatuses || runningTestIds?.has(test.id) || statusFilters.get(test.status);
});
2023-03-10 12:41:00 -08:00
testCase.tests = (testCase.children as TestItem[]).map(c => c.test);
return !!testCase.children.length;
};
const visit = (treeItem: GroupItem) => {
const newChildren: (GroupItem | TestCaseItem)[] = [];
for (const child of treeItem.children) {
if (child.kind === 'case') {
2023-03-10 12:41:00 -08:00
if (filter(child))
newChildren.push(child);
} else {
visit(child);
if (child.children.length || child.hasLoadErrors)
newChildren.push(child);
}
}
treeItem.children = newChildren;
};
visit(rootItem);
}
function sortAndPropagateStatus(treeItem: TreeItem) {
for (const child of treeItem.children)
sortAndPropagateStatus(child);
if (treeItem.kind === 'group') {
treeItem.children.sort((a, b) => {
const fc = a.location.file.localeCompare(b.location.file);
return fc || a.location.line - b.location.line;
});
}
let allPassed = treeItem.children.length > 0;
let allSkipped = treeItem.children.length > 0;
let hasFailed = false;
let hasRunning = false;
let hasScheduled = false;
for (const child of treeItem.children) {
allSkipped = allSkipped && child.status === 'skipped';
allPassed = allPassed && (child.status === 'passed' || child.status === 'skipped');
hasFailed = hasFailed || child.status === 'failed';
hasRunning = hasRunning || child.status === 'running';
hasScheduled = hasScheduled || child.status === 'scheduled';
}
if (hasRunning)
treeItem.status = 'running';
else if (hasScheduled)
treeItem.status = 'scheduled';
else if (hasFailed)
treeItem.status = 'failed';
else if (allSkipped)
treeItem.status = 'skipped';
else if (allPassed)
treeItem.status = 'passed';
}
function shortenRoot(rootItem: GroupItem): GroupItem {
let shortRoot = rootItem;
while (shortRoot.children.length === 1 && shortRoot.children[0].kind === 'group' && shortRoot.children[0].subKind === 'folder')
shortRoot = shortRoot.children[0];
shortRoot.location = rootItem.location;
return shortRoot;
}
function hideOnlyTests(rootItem: GroupItem) {
2023-03-08 17:33:27 -08:00
const visit = (treeItem: TreeItem) => {
if (treeItem.kind === 'case' && treeItem.children.length === 1)
treeItem.children = [];
else
treeItem.children.forEach(visit);
};
visit(rootItem);
}
async function loadSingleTraceFile(url: string): Promise<MultiTraceModel> {
const params = new URLSearchParams();
params.set('trace', url);
const response = await fetch(`contexts?${params.toString()}`);
const contextEntries = await response.json() as ContextEntry[];
return new MultiTraceModel(contextEntries);
}
const pathSeparator = navigator.userAgent.toLowerCase().includes('windows') ? '\\' : '/';