Skip to content

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

chore(trace): split settings into ui and per-model (#37974)

Pavel Feldman2686c090d997
diff --git a/packages/trace-viewer/src/ui/actionList.tsx b/packages/trace-viewer/src/ui/actionList.tsx
index d4f2dd1a0a..b2b0ebc757 100644
--- a/packages/trace-viewer/src/ui/actionList.tsx
+++ b/packages/trace-viewer/src/ui/actionList.tsx
@@ -14,7 +14,7 @@
limitations under the License.
*/
-import type { ActionTraceEvent, AfterActionTraceEventAttachment } from '@trace/trace';
+import type { ActionTraceEvent } from '@trace/trace';
import { clsx, msToString } from '@web/uiUtils';
import * as React from 'react';
import './actionList.css';
@@ -34,11 +34,13 @@ export interface ActionListProps {
selectedAction: ActionTraceEventInContext | undefined,
selectedTime: Boundaries | undefined,
setSelectedTime: (time: Boundaries | undefined) => void,
+ treeState: TreeState,
+ setTreeState: (treeState: TreeState) => void,
sdkLanguage: Language | undefined;
onSelected?: (action: ActionTraceEventInContext) => void,
onHighlighted?: (action: ActionTraceEventInContext | undefined) => void,
revealConsole?: () => void,
- revealAttachment(attachment: AfterActionTraceEventAttachment): void,
+ revealActionAttachment?(callId: string): void,
isLive?: boolean,
}
@@ -49,14 +51,15 @@ export const ActionList: React.FC<ActionListProps> = ({
selectedAction,
selectedTime,
setSelectedTime,
+ treeState,
+ setTreeState,
sdkLanguage,
onSelected,
onHighlighted,
revealConsole,
- revealAttachment,
+ revealActionAttachment,
isLive,
}) => {
- const [treeState, setTreeState] = React.useState<TreeState>({ expandedItems: new Map() });
const { rootItem, itemMap } = React.useMemo(() => modelUtil.buildActionTree(actions), [actions]);
const { selectedItem } = React.useMemo(() => {
@@ -73,8 +76,9 @@ export const ActionList: React.FC<ActionListProps> = ({
}, [setSelectedTime]);
const render = React.useCallback((item: ActionTreeItem) => {
- return renderAction(item.action!, { sdkLanguage, revealConsole, revealAttachment, isLive, showDuration: true, showBadges: true });
- }, [isLive, revealConsole, revealAttachment, sdkLanguage]);
+ const showAttachments = !!revealActionAttachment && !!item.action?.attachments?.length;
+ return renderAction(item.action!, { sdkLanguage, revealConsole, revealActionAttachment: () => revealActionAttachment?.(item.action!.callId), isLive, showDuration: true, showBadges: true, showAttachments });
+ }, [isLive, revealConsole, revealActionAttachment, sdkLanguage]);
const isVisible = React.useCallback((item: ActionTreeItem) => {
return !selectedTime || !item.action || (item.action!.startTime <= selectedTime.maximum && item.action!.endTime >= selectedTime.minimum);
@@ -111,14 +115,14 @@ export const renderAction = (
options: {
sdkLanguage?: Language,
revealConsole?: () => void,
- revealAttachment?(attachment: AfterActionTraceEventAttachment): void,
+ revealActionAttachment?(): void,
isLive?: boolean,
showDuration?: boolean,
showBadges?: boolean,
+ showAttachments?: boolean,
}) => {
- const { sdkLanguage, revealConsole, revealAttachment, isLive, showDuration, showBadges } = options;
+ const { sdkLanguage, revealConsole, revealActionAttachment, isLive, showDuration, showBadges, showAttachments } = options;
const { errors, warnings } = modelUtil.stats(action);
- const showAttachments = !!action.attachments?.length && !!revealAttachment;
const locator = action.params.selector ? asLocatorDescription(sdkLanguage || 'javascript', action.params.selector) : undefined;
@@ -135,7 +139,7 @@ export const renderAction = (
<div className='hbox'>
<span className='action-title-method' title={title}>{elements}</span>
{(showDuration || showBadges || showAttachments || isSkipped) && <div className='spacer'></div>}
- {showAttachments && <ToolbarButton icon='attach' title='Open Attachment' onClick={() => revealAttachment(action.attachments![0])} />}
+ {showAttachments && <ToolbarButton icon='attach' title='Open Attachment' onClick={() => revealActionAttachment?.()} />}
{showDuration && !isSkipped && <div className='action-duration'>{time || <span className='codicon codicon-loading'></span>}</div>}
{isSkipped && <span className={clsx('action-skipped', 'codicon', testStatusIcon('skipped'))} title='skipped'></span>}
{showBadges && <div className='action-icons' onClick={() => revealConsole?.()}>
diff --git a/packages/trace-viewer/src/ui/attachmentsTab.tsx b/packages/trace-viewer/src/ui/attachmentsTab.tsx
index 3a9322ecdc..1f7d813542 100644
--- a/packages/trace-viewer/src/ui/attachmentsTab.tsx
+++ b/packages/trace-viewer/src/ui/attachmentsTab.tsx
@@ -23,18 +23,17 @@ import { isTextualMimeType } from '@isomorphic/mimeType';
import { Expandable } from '@web/components/expandable';
import { linkifyText } from '@web/renderUtils';
import { clsx, useFlash } from '@web/uiUtils';
-import { TraceModelContext } from './traceModelContext';
+import { useTraceModel } from './traceModelContext';
import type { Attachment, MultiTraceModel } from './modelUtil';
-import type { AfterActionTraceEventAttachment } from '@trace/trace';
type ExpandableAttachmentProps = {
attachment: Attachment;
- reveal?: any;
+ reveal: any;
};
const ExpandableAttachment: React.FunctionComponent<ExpandableAttachmentProps> = ({ attachment, reveal }) => {
- const model = React.useContext(TraceModelContext);
+ const model = useTraceModel();
const [expanded, setExpanded] = React.useState(false);
const [attachmentText, setAttachmentText] = React.useState<string | null>(null);
const [placeholder, setPlaceholder] = React.useState<string | null>(null);
@@ -94,9 +93,9 @@ const ExpandableAttachment: React.FunctionComponent<ExpandableAttachmentProps> =
};
export const AttachmentsTab: React.FunctionComponent<{
- revealedAttachment?: [AfterActionTraceEventAttachment, number],
-}> = ({ revealedAttachment }) => {
- const model = React.useContext(TraceModelContext);
+ revealedAttachmentCallId?: { callId: string },
+}> = ({ revealedAttachmentCallId }) => {
+ const model = useTraceModel();
const { diffMap, screenshots, attachments } = React.useMemo(() => {
const attachments = new Set(model?.visibleAttachments ?? []);
const screenshots = new Set<Attachment>();
@@ -149,17 +148,13 @@ export const AttachmentsTab: React.FunctionComponent<{
return <div className='attachment-item' key={attachmentKey(a, i)}>
<ExpandableAttachment
attachment={a}
- reveal={(!!revealedAttachment && isEqualAttachment(a, revealedAttachment[0])) ? revealedAttachment : undefined}
+ reveal={!!revealedAttachmentCallId && a.callId === revealedAttachmentCallId.callId ? revealedAttachmentCallId : undefined}
/>
</div>;
})}
</div>;
};
-function isEqualAttachment(a: Attachment, b: AfterActionTraceEventAttachment): boolean {
- return a.name === b.name && a.path === b.path && a.sha1 === b.sha1;
-}
-
export function attachmentURL(model: MultiTraceModel | undefined, attachment: Attachment) {
if (model && attachment.sha1)
return model.createRelativeUrl(`sha1/${attachment.sha1}`) ;
diff --git a/packages/trace-viewer/src/ui/consoleTab.tsx b/packages/trace-viewer/src/ui/consoleTab.tsx
index 28550cb15b..f56005afdc 100644
--- a/packages/trace-viewer/src/ui/consoleTab.tsx
+++ b/packages/trace-viewer/src/ui/consoleTab.tsx
@@ -130,7 +130,7 @@ export const ConsoleTab: React.FunctionComponent<{
boundaries: Boundaries,
consoleModel: ConsoleTabModel,
selectedTime?: Boundaries | undefined,
- onEntryHovered?: (entry: ConsoleEntry | undefined) => void,
+ onEntryHovered?: (ordinal: number | undefined) => void,
onAccepted?: (entry: ConsoleEntry) => void,
}> = ({ consoleModel, boundaries, onEntryHovered, onAccepted }) => {
if (!consoleModel.entries.length)
@@ -140,7 +140,7 @@ export const ConsoleTab: React.FunctionComponent<{
<ConsoleListView
name='console'
onAccepted={onAccepted}
- onHighlighted={onEntryHovered}
+ onHighlighted={entry => onEntryHovered?.(entry ? consoleModel.entries.indexOf(entry) : undefined)}
items={consoleModel.entries}
isError={entry => entry.isError}
isWarning={entry => entry.isWarning}
diff --git a/packages/trace-viewer/src/ui/errorsTab.tsx b/packages/trace-viewer/src/ui/errorsTab.tsx
index 717714a827..21f12e83d4 100644
--- a/packages/trace-viewer/src/ui/errorsTab.tsx
+++ b/packages/trace-viewer/src/ui/errorsTab.tsx
@@ -27,7 +27,7 @@ import { copyPrompt, stripAnsiEscapes } from '@web/shared/prompts';
import { MetadataWithCommitInfo } from '@testIsomorphic/types';
import { calculateSha1 } from './sourceTab';
import type { StackFrame } from '@protocol/channels';
-import { TraceModelContext } from './traceModelContext';
+import { useTraceModel } from './traceModelContext';
const CopyPromptButton: React.FC<{ prompt: string }> = ({ prompt }) => {
return (
@@ -91,7 +91,7 @@ export const ErrorsTab: React.FunctionComponent<{
revealInSource: (error: modelUtil.ErrorDescription) => void,
testRunMetadata: MetadataWithCommitInfo | undefined,
}> = ({ errorsModel, sdkLanguage, revealInSource, wallTime, testRunMetadata }) => {
- const model = React.useContext(TraceModelContext);
+ const model = useTraceModel();
const errorContext = useAsyncMemo(async () => {
const attachment = model?.attachments.find(a => a.name === 'error-context');
if (!attachment)
diff --git a/packages/trace-viewer/src/ui/filmStrip.tsx b/packages/trace-viewer/src/ui/filmStrip.tsx
index 73b8b1410c..935a205433 100644
--- a/packages/trace-viewer/src/ui/filmStrip.tsx
+++ b/packages/trace-viewer/src/ui/filmStrip.tsx
@@ -22,7 +22,7 @@ import type { PageEntry } from '../types/entries';
import type { ActionTraceEventInContext } from './modelUtil';
import { renderAction } from './actionList';
import type { Language } from '@isomorphic/locatorGenerators';
-import { TraceModelContext } from './traceModelContext';
+import { useTraceModel } from './traceModelContext';
export type FilmStripPreviewPoint = {
x: number;
@@ -39,7 +39,7 @@ export const FilmStrip: React.FunctionComponent<{
boundaries: Boundaries,
previewPoint?: FilmStripPreviewPoint,
}> = ({ boundaries, previewPoint }) => {
- const model = React.useContext(TraceModelContext);
+ const model = useTraceModel();
const [measure, ref] = useMeasure<HTMLDivElement>();
const lanesRef = React.useRef<HTMLDivElement>(null);
@@ -90,7 +90,7 @@ const FilmStripLane: React.FunctionComponent<{
page: PageEntry,
width: number,
}> = ({ boundaries, page, width }) => {
- const model = React.useContext(TraceModelContext);
+ const model = useTraceModel();
const viewportSize = { width: 0, height: 0 };
const screencastFrames = page.screencastFrames;
for (const frame of screencastFrames) {
diff --git a/packages/trace-viewer/src/ui/liveWorkbenchLoader.tsx b/packages/trace-viewer/src/ui/liveWorkbenchLoader.tsx
index e97bc0f7d6..d01b64e3c0 100644
--- a/packages/trace-viewer/src/ui/liveWorkbenchLoader.tsx
+++ b/packages/trace-viewer/src/ui/liveWorkbenchLoader.tsx
@@ -20,7 +20,6 @@ import './workbenchLoader.css';
import { Workbench } from './workbench';
import type { ContextEntry } from '../types/entries';
-import { TraceModelContext } from './traceModelContext';
export const LiveWorkbenchLoader: React.FC<{ traceJson: string }> = ({ traceJson }) => {
const [model, setModel] = React.useState<MultiTraceModel | undefined>(undefined);
@@ -49,9 +48,7 @@ export const LiveWorkbenchLoader: React.FC<{ traceJson: string }> = ({ traceJson
};
}, [traceJson, counter]);
- return <TraceModelContext.Provider value={model}>
- <Workbench isLive={true} />
- </TraceModelContext.Provider>;
+ return <Workbench isLive={true} model={model} />;
};
async function loadSingleTraceFile(traceJson: string): Promise<MultiTraceModel> {
diff --git a/packages/trace-viewer/src/ui/modelUtil.ts b/packages/trace-viewer/src/ui/modelUtil.ts
index c78bee156f..d245e7acc3 100644
--- a/packages/trace-viewer/src/ui/modelUtil.ts
+++ b/packages/trace-viewer/src/ui/modelUtil.ts
@@ -59,7 +59,7 @@ export type ErrorDescription = {
message: string;
};
-export type Attachment = trace.AfterActionTraceEventAttachment;
+export type Attachment = trace.AfterActionTraceEventAttachment & { callId: string };
export class MultiTraceModel {
readonly startTime: number;
@@ -112,7 +112,7 @@ export class MultiTraceModel {
this.hasSource = contexts.some(c => c.hasSource);
this.hasStepData = contexts.some(context => context.origin === 'testRunner');
this.resources = [...contexts.map(c => c.resources)].flat();
- this.attachments = this.actions.flatMap(action => action.attachments?.map(attachment => ({ ...attachment, traceUrl })) ?? []);
+ this.attachments = this.actions.flatMap(action => action.attachments?.map(attachment => ({ ...attachment, callId: action.callId, traceUrl })) ?? []);
this.visibleAttachments = this.attachments.filter(attachment => !attachment.name.startsWith('_'));
this.events.sort((a1, a2) => a1.time - a2.time);
diff --git a/packages/trace-viewer/src/ui/networkResourceDetails.tsx b/packages/trace-viewer/src/ui/networkResourceDetails.tsx
index 1dfdb11196..1184b9141e 100644
--- a/packages/trace-viewer/src/ui/networkResourceDetails.tsx
+++ b/packages/trace-viewer/src/ui/networkResourceDetails.tsx
@@ -26,7 +26,7 @@ import { getAPIRequestCodeGen } from './codegen';
import type { Language } from '@isomorphic/locatorGenerators';
import { msToString, useAsyncMemo } from '@web/uiUtils';
import type { Entry } from '@trace/har';
-import { TraceModelContext } from './traceModelContext';
+import { useTraceModel } from './traceModelContext';
type RequestBody = { text: string, mimeType?: string } | null;
@@ -38,7 +38,7 @@ export const NetworkResourceDetails: React.FunctionComponent<{
onClose: () => void;
}> = ({ resource, sdkLanguage, startTimeOffset, onClose }) => {
const [selectedTab, setSelectedTab] = React.useState('request');
- const model = React.useContext(TraceModelContext);
+ const model = useTraceModel();
const requestBody = useAsyncMemo<RequestBody>(async () => {
if (model && resource.request.postData) {
@@ -147,7 +147,7 @@ const ResponseTab: React.FunctionComponent<{
const BodyTab: React.FunctionComponent<{
resource: ResourceSnapshot;
}> = ({ resource }) => {
- const model = React.useContext(TraceModelContext);
+ const model = useTraceModel();
const [responseBody, setResponseBody] = React.useState<{ dataUrl?: string, text?: string, mimeType?: string, font?: BufferSource } | null>(null);
React.useEffect(() => {
diff --git a/packages/trace-viewer/src/ui/networkTab.tsx b/packages/trace-viewer/src/ui/networkTab.tsx
index 437eea7813..24fe2034d9 100644
--- a/packages/trace-viewer/src/ui/networkTab.tsx
+++ b/packages/trace-viewer/src/ui/networkTab.tsx
@@ -34,6 +34,7 @@ type NetworkTabModel = {
};
type RenderedEntry = {
+ ordinal: number,
name: { name: string, url: string },
method: string,
status: { code: number, text: string },
@@ -66,15 +67,15 @@ export function useNetworkTabModel(model: MultiTraceModel | undefined, selectedT
export const NetworkTab: React.FunctionComponent<{
boundaries: Boundaries,
networkModel: NetworkTabModel,
- onEntryHovered?: (entry: Entry | undefined) => void,
+ onResourceHovered?: (ordinal: number | undefined) => void,
sdkLanguage: Language,
-}> = ({ boundaries, networkModel, onEntryHovered, sdkLanguage }) => {
+}> = ({ boundaries, networkModel, onResourceHovered, sdkLanguage }) => {
const [sorting, setSorting] = React.useState<Sorting | undefined>(undefined);
const [selectedEntry, setSelectedEntry] = React.useState<RenderedEntry | undefined>(undefined);
const [filterState, setFilterState] = React.useState(defaultFilterState);
const { renderedEntries } = React.useMemo(() => {
- const renderedEntries = networkModel.resources.map(entry => renderEntry(entry, boundaries, networkModel.contextIdMap)).filter(filterEntry(filterState));
+ const renderedEntries = networkModel.resources.map((entry, i) => renderEntry(entry, boundaries, networkModel.contextIdMap, i)).filter(filterEntry(filterState));
if (sorting)
sort(renderedEntries, sorting);
return { renderedEntries };
@@ -98,7 +99,7 @@ export const NetworkTab: React.FunctionComponent<{
items={renderedEntries}
selectedItem={selectedEntry}
onSelected={item => setSelectedEntry(item)}
- onHighlighted={item => onEntryHovered?.(item?.resource)}
+ onHighlighted={item => onResourceHovered?.(item?.ordinal)}
columns={visibleColumns(!!selectedEntry, renderedEntries)}
columnTitle={columnTitle}
columnWidths={columnWidths}
@@ -261,7 +262,7 @@ function hasMultipleContexts(renderedEntries: RenderedEntry[]): boolean {
return false;
}
-const renderEntry = (resource: Entry, boundaries: Boundaries, contextIdGenerator: ContextIdMap): RenderedEntry => {
+const renderEntry = (resource: Entry, boundaries: Boundaries, contextIdGenerator: ContextIdMap, ordinal: number): RenderedEntry => {
const routeStatus = formatRouteStatus(resource);
let resourceName: string;
try {
@@ -280,6 +281,7 @@ const renderEntry = (resource: Entry, boundaries: Boundaries, contextIdGenerator
contentType = charset[1];
return {
+ ordinal,
name: { name: resourceName, url: resource.request.url },
method: resource.request.method,
status: { code: resource.response.status, text: resource.response.statusText },
diff --git a/packages/trace-viewer/src/ui/sourceTab.tsx b/packages/trace-viewer/src/ui/sourceTab.tsx
index 11c7c571f7..3799096cb1 100644
--- a/packages/trace-viewer/src/ui/sourceTab.tsx
+++ b/packages/trace-viewer/src/ui/sourceTab.tsx
@@ -26,10 +26,10 @@ import type { StackFrame } from '@protocol/channels';
import { CopyToClipboard } from './copyToClipboard';
import { ToolbarButton } from '@web/components/toolbarButton';
import { Toolbar } from '@web/components/toolbar';
-import { TraceModelContext } from './traceModelContext';
+import { useTraceModel } from './traceModelContext';
function useSources(stack: StackFrame[] | undefined, selectedFrame: number, sources: Map<string, SourceModel>, rootDir?: string, fallbackLocation?: SourceLocation) {
- const model = React.useContext(TraceModelContext);
+ const model = useTraceModel();
return useAsyncMemo<{ source: SourceModel, targetLine?: number, fileName?: string, highlight: SourceHighlight[], location?: SourceLocation }>(async () => {
const actionLocation = stack?.[selectedFrame];
const location = actionLocation?.file ? actionLocation : fallbackLocation;
diff --git a/packages/trace-viewer/src/ui/timeline.tsx b/packages/trace-viewer/src/ui/timeline.tsx
index 6b3344d99d..fe78c9f20f 100644
--- a/packages/trace-viewer/src/ui/timeline.tsx
+++ b/packages/trace-viewer/src/ui/timeline.tsx
@@ -42,15 +42,16 @@ type TimelineBar = {
export const Timeline: React.FunctionComponent<{
model: MultiTraceModel | undefined,
consoleEntries: ConsoleEntry[] | undefined,
+ networkResources: Entry[] | undefined,
boundaries: Boundaries,
highlightedAction: ActionTraceEventInContext | undefined,
- highlightedEntry: Entry | undefined,
- highlightedConsoleEntry: ConsoleEntry | undefined,
+ highlightedResourceOrdinal: number | undefined,
+ highlightedConsoleEntryOrdinal: number | undefined,
onSelected: (action: ActionTraceEventInContext) => void,
selectedTime: Boundaries | undefined,
setSelectedTime: (time: Boundaries | undefined) => void,
sdkLanguage: Language,
-}> = ({ model, boundaries, consoleEntries, onSelected, highlightedAction, highlightedEntry, highlightedConsoleEntry, selectedTime, setSelectedTime, sdkLanguage }) => {
+}> = ({ model, boundaries, consoleEntries, networkResources, onSelected, highlightedAction, highlightedResourceOrdinal, highlightedConsoleEntryOrdinal, selectedTime, setSelectedTime, sdkLanguage }) => {
const [measure, ref] = useMeasure<HTMLDivElement>();
const [dragWindow, setDragWindow] = React.useState<{ startX: number, endX: number, pivot?: number, type: 'resize' | 'move' } | undefined>();
const [previewPoint, setPreviewPoint] = React.useState<FilmStripPreviewPoint | undefined>();
@@ -118,14 +119,14 @@ export const Timeline: React.FunctionComponent<{
for (const bar of bars) {
if (highlightedAction)
bar.active = bar.action === highlightedAction;
- else if (highlightedEntry)
- bar.active = bar.resource === highlightedEntry;
- else if (highlightedConsoleEntry)
- bar.active = bar.consoleMessage === highlightedConsoleEntry;
+ else if (highlightedResourceOrdinal !== undefined)
+ bar.active = bar.resource === networkResources?.[highlightedResourceOrdinal];
+ else if (highlightedConsoleEntryOrdinal !== undefined)
+ bar.active = bar.consoleMessage === consoleEntries?.[highlightedConsoleEntryOrdinal];
else
bar.active = false;
}
- }, [bars, highlightedAction, highlightedEntry, highlightedConsoleEntry]);
+ }, [bars, highlightedAction, highlightedResourceOrdinal, highlightedConsoleEntryOrdinal, consoleEntries, networkResources]);
const onMouseDown = React.useCallback((event: React.MouseEvent) => {
setPreviewPoint(undefined);
diff --git a/packages/trace-viewer/src/ui/traceModelContext.tsx b/packages/trace-viewer/src/ui/traceModelContext.tsx
index ab4adf95ab..8e930ae7fa 100644
--- a/packages/trace-viewer/src/ui/traceModelContext.tsx
+++ b/packages/trace-viewer/src/ui/traceModelContext.tsx
@@ -18,3 +18,7 @@ import * as React from 'react';
import type { MultiTraceModel } from './modelUtil';
export const TraceModelContext = React.createContext<MultiTraceModel | undefined>(undefined);
+
+export const useTraceModel = () => {
+ return React.useContext(TraceModelContext);
+};
diff --git a/packages/trace-viewer/src/ui/uiModeTraceView.tsx b/packages/trace-viewer/src/ui/uiModeTraceView.tsx
index 17d60de7da..211639103b 100644
--- a/packages/trace-viewer/src/ui/uiModeTraceView.tsx
+++ b/packages/trace-viewer/src/ui/uiModeTraceView.tsx
@@ -24,7 +24,6 @@ import type { ContextEntry } from '../types/entries';
import type { SourceLocation } from './modelUtil';
import { MultiTraceModel } from './modelUtil';
import { Workbench } from './workbench';
-import { TraceModelContext } from './traceModelContext';
export const TraceView: React.FC<{
item: { treeItem?: TreeItem, testFile?: SourceLocation, testCase?: reporterTypes.TestCase },
@@ -89,19 +88,18 @@ export const TraceView: React.FC<{
};
}, [outputDir, item, setModel, counter, setCounter, pathSeparator]);
- return <TraceModelContext.Provider value={model?.model}>
- <Workbench
- key='workbench'
- showSourcesFirst={true}
- rootDir={rootDir}
- fallbackLocation={item.testFile}
- isLive={model?.isLive}
- status={item.treeItem?.status}
- annotations={item.testCase?.annotations ?? []}
- onOpenExternally={onOpenExternally}
- revealSource={revealSource}
- />
- </TraceModelContext.Provider>;
+ return <Workbench
+ model={model?.model}
+ key='workbench'
+ showSourcesFirst={true}
+ rootDir={rootDir}
+ fallbackLocation={item.testFile}
+ isLive={model?.isLive}
+ status={item.treeItem?.status}
+ annotations={item.testCase?.annotations ?? []}
+ onOpenExternally={onOpenExternally}
+ revealSource={revealSource}
+ />;
};
const outputDirForTestCase = (testCase: reporterTypes.TestCase): string | undefined => {
diff --git a/packages/trace-viewer/src/ui/workbench.tsx b/packages/trace-viewer/src/ui/workbench.tsx
index b529746094..f9157ed800 100644
--- a/packages/trace-viewer/src/ui/workbench.tsx
+++ b/packages/trace-viewer/src/ui/workbench.tsx
@@ -20,7 +20,6 @@ import { ActionList } from './actionList';
import { CallTab } from './callTab';
import { LogTab } from './logTab';
import { ErrorsTab, useErrorsTabModel } from './errorsTab';
-import type { ConsoleEntry } from './consoleTab';
import { ConsoleTab, useConsoleTabModel } from './consoleTab';
import type * as modelUtil from './modelUtil';
import { NetworkTab, useNetworkTabModel } from './networkTab';
@@ -35,12 +34,10 @@ import { AnnotationsTab } from './annotationsTab';
import type { Boundaries } from './geometry';
import { InspectorTab } from './inspectorTab';
import { ToolbarButton } from '@web/components/toolbarButton';
-import { useSetting, msToString, clsx } from '@web/uiUtils';
-import type { Entry } from '@trace/har';
+import { useSetting, msToString, clsx, usePartitionedState, togglePartition } from '@web/uiUtils';
import './workbench.css';
import { testStatusIcon, testStatusText } from './testUtils';
import type { UITestStatus } from './testUtils';
-import type { AfterActionTraceEventAttachment } from '@trace/trace';
import type { HighlightedElement } from './snapshotTab';
import type { TestAnnotation } from '@playwright/test';
import { MetadataWithCommitInfo } from '@testIsomorphic/types';
@@ -48,39 +45,60 @@ import type { ActionGroup } from '@isomorphic/protocolFormatter';
import { DialogToolbarButton } from '@web/components/dialogToolbarButton';
import { SettingsView } from './settingsView';
import { TraceModelContext } from './traceModelContext';
-
-export const Workbench: React.FunctionComponent<{
- showSourcesFirst?: boolean,
- rootDir?: string,
- fallbackLocation?: modelUtil.SourceLocation,
- isLive?: boolean,
- hideTimeline?: boolean,
- status?: UITestStatus,
+import type { TreeState } from '@web/components/treeView';
+
+export type WorkbenchProps = {
+ model: modelUtil.MultiTraceModel | undefined;
+ showSourcesFirst?: boolean;
+ rootDir?: string;
+ fallbackLocation?: modelUtil.SourceLocation;
+ isLive?: boolean;
+ hideTimeline?: boolean;
+ status?: UITestStatus;
annotations?: TestAnnotation[];
- inert?: boolean,
- onOpenExternally?: (location: modelUtil.SourceLocation) => void,
- revealSource?: boolean,
- testRunMetadata?: MetadataWithCommitInfo,
-}> = ({ showSourcesFirst, rootDir, fallbackLocation, isLive, hideTimeline, status, annotations, inert, onOpenExternally, revealSource, testRunMetadata }) => {
- const model = React.useContext(TraceModelContext);
- const [selectedCallId, setSelectedCallId] = React.useState<string | undefined>(undefined);
- const [revealedError, setRevealedError] = React.useState<modelUtil.ErrorDescription | undefined>(undefined);
- const [revealedAttachment, setRevealedAttachment] = React.useState<[attachment: AfterActionTraceEventAttachment, renderCounter: number] | undefined>(undefined);
- const [highlightedCallId, setHighlightedCallId] = React.useState<string | undefined>();
- const [highlightedEntry, setHighlightedEntry] = React.useState<Entry | undefined>();
- const [highlightedConsoleMessage, setHighlightedConsoleMessage] = React.useState<ConsoleEntry | undefined>();
- const [selectedNavigatorTab, setSelectedNavigatorTab] = React.useState<string>('actions');
+ inert?: boolean;
+ onOpenExternally?: (location: modelUtil.SourceLocation) => void;
+ revealSource?: boolean;
+ testRunMetadata?: MetadataWithCommitInfo;
+};
+
+export const Workbench: React.FunctionComponent<WorkbenchProps> = props => {
+ const partition = props.model?.traceUrl ?? 'default';
+ return <TraceModelContext.Provider value={props.model}>
+ <PartitionedWorkbench partition={partition} {...props} />;
+ </TraceModelContext.Provider>;
+};
+
+const PartitionedWorkbench: React.FunctionComponent<WorkbenchProps & { partition: string }> = props => {
+ const { partition, model, showSourcesFirst, rootDir, fallbackLocation, isLive, hideTimeline, status, annotations, inert, onOpenExternally, revealSource, testRunMetadata } = props;
+
+ // UI settings, shared for all models.
+ const [selectedNavigatorTab, setSelectedNavigatorTab] = useSetting<string>('navigatorTab', 'actions');
const [selectedPropertiesTab, setSelectedPropertiesTab] = useSetting<string>('propertiesTab', showSourcesFirst ? 'source' : 'call');
- const [isInspecting, setIsInspectingState] = React.useState(false);
- const [highlightedElement, setHighlightedElement] = React.useState<HighlightedElement>({ lastEdited: 'none' });
- const [selectedTime, setSelectedTime] = React.useState<Boundaries | undefined>();
const [sidebarLocation, setSidebarLocation] = useSetting<'bottom' | 'right'>('propertiesSidebarLocation', 'bottom');
const [actionsFilter] = useSetting<ActionGroup[]>('actionsFilter', []);
+ // Per-model settings, should be primitive non-retaining types.
+ // These will be turned into per-model state in the following patches.
+ const [selectedCallId, setSelectedCallId] = usePartitionedState<string | undefined>('selectedCallId');
+ const [selectedTime, setSelectedTime] = usePartitionedState<Boundaries | undefined>('selectedTime');
+ const [highlightedCallId, setHighlightedCallId] = usePartitionedState<string | undefined>('highlightedCallId');
+ const [revealedErrorKey, setRevealedErrorKey] = usePartitionedState<string | undefined>('revealedErrorKey');
+ const [highlightedConsoleMessageOrdinal, setHighlightedConsoleMessageOrdinal] = usePartitionedState<number | undefined>('highlightedConsoleMessageOrdinal');
+ const [revealedAttachmentCallId, setRevealedAttachmentCallId] = usePartitionedState<{ callId: string } | undefined>('revealedAttachmentCallId');
+ const [highlightedResourceOrdinal, setHighlightedResourceOrdinal] = usePartitionedState<number | undefined>('highlightedResourceOrdinal');
+ const [treeState, setTreeState] = usePartitionedState<TreeState>('treeState', { expandedItems: new Map() });
+
+ togglePartition(partition);
+
+ // Transient state
+ const [highlightedElement, setHighlightedElement] = React.useState<HighlightedElement>({ lastEdited: 'none' });
+ const [isInspecting, setIsInspectingState] = React.useState(false);
+
const setSelectedAction = React.useCallback((action: modelUtil.ActionTraceEventInContext | undefined) => {
setSelectedCallId(action?.callId);
- setRevealedError(undefined);
- }, []);
+ setRevealedErrorKey(undefined);
+ }, [setSelectedCallId, setRevealedErrorKey]);
const actions = React.useMemo(() => model?.filteredActions(actionsFilter), [model, actionsFilter]);
const hiddenActionsCount = (model?.actions.length ?? 0) - (actions?.length ?? 0);
@@ -91,14 +109,14 @@ export const Workbench: React.FunctionComponent<{
const setHighlightedAction = React.useCallback((highlightedAction: modelUtil.ActionTraceEventInContext | undefined) => {
setHighlightedCallId(highlightedAction?.callId);
- }, []);
+ }, [setHighlightedCallId]);
const sources = React.useMemo(() => model?.sources || new Map<string, modelUtil.SourceModel>(), [model]);
React.useEffect(() => {
setSelectedTime(undefined);
- setRevealedError(undefined);
- }, [model]);
+ setRevealedErrorKey(undefined);
+ }, [model, setSelectedTime, setRevealedErrorKey]);
const selectedAction = React.useMemo(() => {
if (selectedCallId) {
@@ -128,12 +146,6 @@ export const Workbench: React.FunctionComponent<{
return highlightedAction || selectedAction;
}, [selectedAction, highlightedAction]);
- const revealedStack = React.useMemo(() => {
- if (revealedError)
- return revealedError.stack;
- return activeAction?.stack;
- }, [activeAction, revealedError]);
-
const onActionSelected = React.useCallback((action: modelUtil.ActionTraceEventInContext) => {
setSelectedAction(action);
setHighlightedAction(undefined);
@@ -156,15 +168,10 @@ export const Workbench: React.FunctionComponent<{
selectPropertiesTab('inspector');
}, [selectPropertiesTab]);
- const revealAttachment = React.useCallback((attachment: AfterActionTraceEventAttachment) => {
+ const revealActionAttachment = React.useCallback((callId: string) => {
selectPropertiesTab('attachments');
- setRevealedAttachment(currentValue => {
- if (!currentValue)
- return [attachment, 0];
- const revealCounter = currentValue[1];
- return [attachment, revealCounter + 1];
- });
- }, [selectPropertiesTab]);
+ setRevealedAttachmentCallId({ callId });
+ }, [selectPropertiesTab, setRevealedAttachmentCallId]);
React.useEffect(() => {
if (revealSource)
@@ -175,6 +182,12 @@ export const Workbench: React.FunctionComponent<{
const networkModel = useNetworkTabModel(model, selectedTime);
const errorsModel = useErrorsTabModel(model);
+ const revealedStack = React.useMemo(() => {
+ if (revealedErrorKey !== undefined)
+ return errorsModel.errors.get(revealedErrorKey)?.stack;
+ return activeAction?.stack;
+ }, [activeAction, revealedErrorKey, errorsModel]);
+
const sdkLanguage = model?.sdkLanguage || 'javascript';
const inspectorTab: TabbedPaneTabModel = {
@@ -205,7 +218,7 @@ export const Workbench: React.FunctionComponent<{
if (error.action)
setSelectedAction(error.action);
else
- setRevealedError(error);
+ setRevealedErrorKey(error.message);
selectPropertiesTab('source');
}} wallTime={model?.wallTime ?? 0} />
};
@@ -238,20 +251,20 @@ export const Workbench: React.FunctionComponent<{
boundaries={boundaries}
selectedTime={selectedTime}
onAccepted={m => setSelectedTime({ minimum: m.timestamp, maximum: m.timestamp })}
- onEntryHovered={setHighlightedConsoleMessage}
+ onEntryHovered={setHighlightedConsoleMessageOrdinal}
/>
};
const networkTab: TabbedPaneTabModel = {
id: 'network',
title: 'Network',
count: networkModel.resources.length,
- render: () => <NetworkTab boundaries={boundaries} networkModel={networkModel} onEntryHovered={setHighlightedEntry} sdkLanguage={model?.sdkLanguage ?? 'javascript'} />
+ render: () => <NetworkTab boundaries={boundaries} networkModel={networkModel} onResourceHovered={setHighlightedResourceOrdinal} sdkLanguage={model?.sdkLanguage ?? 'javascript'} />
};
const attachmentsTab: TabbedPaneTabModel = {
id: 'attachments',
title: 'Attachments',
count: model?.visibleAttachments.length,
- render: () => <AttachmentsTab revealedAttachment={revealedAttachment} />
+ render: () => <AttachmentsTab revealedAttachmentCallId={revealedAttachmentCallId} />
};
const tabs: TabbedPaneTabModel[] = [
@@ -314,9 +327,11 @@ export const Workbench: React.FunctionComponent<{
selectedAction={model ? selectedAction : undefined}
selectedTime={selectedTime}
setSelectedTime={setSelectedTime}
+ treeState={treeState}
+ setTreeState={setTreeState}
onSelected={onActionSelected}
onHighlighted={setHighlightedAction}
- revealAttachment={revealAttachment}
+ revealActionAttachment={revealActionAttachment}
revealConsole={() => selectPropertiesTab('console')}
isLive={isLive}
/>
@@ -336,10 +351,11 @@ export const Workbench: React.FunctionComponent<{
{!hideTimeline && <Timeline
model={model}
consoleEntries={consoleModel.entries}
+ networkResources={networkModel.resources}
boundaries={boundaries}
highlightedAction={highlightedAction}
- highlightedEntry={highlightedEntry}
- highlightedConsoleEntry={highlightedConsoleMessage}
+ highlightedResourceOrdinal={highlightedResourceOrdinal}
+ highlightedConsoleEntryOrdinal={highlightedConsoleMessageOrdinal}
onSelected={onActionSelected}
sdkLanguage={sdkLanguage}
selectedTime={selectedTime}
diff --git a/packages/trace-viewer/src/ui/workbenchLoader.tsx b/packages/trace-viewer/src/ui/workbenchLoader.tsx
index 0683b3a8a9..655bdd3535 100644
--- a/packages/trace-viewer/src/ui/workbenchLoader.tsx
+++ b/packages/trace-viewer/src/ui/workbenchLoader.tsx
@@ -22,7 +22,6 @@ import { TestServerConnection, WebSocketTestServerTransport } from '@testIsomorp
import { DialogToolbarButton } from '@web/components/dialogToolbarButton';
import { Dialog } from '@web/shared/dialog';
import { DefaultSettingsView } from './defaultSettingsView';
-import { TraceModelContext } from './traceModelContext';
export const WorkbenchLoader: React.FunctionComponent<{
}> = () => {
@@ -187,9 +186,7 @@ export const WorkbenchLoader: React.FunctionComponent<{
<DefaultSettingsView />
</DialogToolbarButton>
</div>
- <TraceModelContext.Provider value={model}>
- <Workbench inert={showFileUploadDropArea} />
- </TraceModelContext.Provider>
+ <Workbench model={model} inert={showFileUploadDropArea} />
{fileForLocalModeError && <div className='drop-target'>
<div>Trace Viewer uses Service Workers to show traces. To view trace:</div>
<div style={{ paddingTop: 20 }}>
diff --git a/packages/web/src/uiUtils.ts b/packages/web/src/uiUtils.ts
index f7e94f1b52..db4b672cec 100644
--- a/packages/web/src/uiUtils.ts
+++ b/packages/web/src/uiUtils.ts
@@ -172,6 +172,34 @@ export function useSetting<S>(name: string | undefined, defaultValue: S): [S, Re
return [value, setValueWrapper];
}
+const partitions = new Map<string, Record<string, any>>();
+const hooks = new Map<string, { setter: React.Dispatch<React.SetStateAction<any>>, defaultValue: any }>();
+let currentPartition: string | undefined;
+
+export function usePartitionedState<S>(name: string, defaultValue?: S): [S, React.Dispatch<React.SetStateAction<S>>] {
+ const [value, setValue] = React.useState<S | undefined>();
+ hooks.set(name, { setter: setValue, defaultValue });
+
+ const setValueWrapper = React.useCallback((newValue: React.SetStateAction<S>) => {
+ const state = partitions.get(currentPartition || 'default') || {};
+ state[name] = newValue;
+ partitions.set(currentPartition || 'default', state);
+ setValue(newValue as S);
+ }, [name]);
+
+ return [value as S, setValueWrapper];
+}
+
+export function togglePartition(partition: string) {
+ if (currentPartition === partition)
+ return;
+
+ currentPartition = partition;
+ const store = partitions.get(partition) || {};
+ for (const [name, value] of hooks.entries())
+ value.setter(store[name] || value.defaultValue);
+}
+
declare global {
interface Window {
saveSettings?(): void;
diff --git a/tests/playwright-test/ui-mode-trace.spec.ts b/tests/playwright-test/ui-mode-trace.spec.ts
index 53c204fbf2..79d8e5b2a2 100644
--- a/tests/playwright-test/ui-mode-trace.spec.ts
+++ b/tests/playwright-test/ui-mode-trace.spec.ts
@@ -715,3 +715,50 @@ test('should be able to create and dispose APIRequestContext inside Promise.all'
/After Hooks[\d.]+m?s/,
]);
});
+
+test('should partition action tree state by test', async ({ runUITest }) => {
+ const { page } = await runUITest({
+ 'a.test.ts': `
+ import { test, expect } from '@playwright/test';
+ test('test1', async ({ page }) => {
+ await page.setContent('<button>Submit</button>');
+ await page.getByRole('button').click();
+ });
+ test('test2', async ({ page }) => {
+ await page.setContent('<button>Submit</button>');
+ await page.evaluate('1+1');
+ });
+ `,
+ });
+
+ await page.getByTitle('Run all').click();
+ await page.getByTestId('test-tree').getByText('test1').click();
+
+ const actionsTree = page.getByTestId('actions-tree');
+ await actionsTree.getByRole('treeitem', { name: 'After Hooks' }).click();
+ await page.keyboard.press('ArrowRight');
+
+ await expect(actionsTree).toMatchAriaSnapshot(`
+ - treeitem /After Hooks/ [expanded] [selected]:
+ - group:
+ - treeitem /Fixture \"page\"/
+ - treeitem /Fixture \"context\"/
+ `);
+
+ await page.getByTestId('test-tree').getByText('test2').click();
+
+ await expect(actionsTree).toMatchAriaSnapshot(`
+ - treeitem /Evaluate/ [selected]
+ - treeitem /After Hooks/:
+ - /children: equal
+ `);
+
+ await page.getByTestId('test-tree').getByText('test1').click();
+
+ await expect(actionsTree).toMatchAriaSnapshot(`
+ - treeitem /After Hooks/ [expanded] [selected]:
+ - group:
+ - treeitem /Fixture \"page\"/
+ - treeitem /Fixture \"context\"/
+ `);
+});