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-viewer): only offer "Display Aria" when the trace has both snapshot kinds (#42435)

Pavel Feldman267f5c6e71b0
diff --git a/packages/isomorphic/trace/traceModel.ts b/packages/isomorphic/trace/traceModel.ts
index b8aab18fc9..3580cc7d9d 100644
--- a/packages/isomorphic/trace/traceModel.ts
+++ b/packages/isomorphic/trace/traceModel.ts
@@ -80,6 +80,8 @@ export class TraceModel {
readonly errorDescriptors: ErrorDescription[];
readonly hasSource: boolean;
readonly hasStepData: boolean;
+ readonly hasDomSnapshots: boolean;
+ readonly hasAriaSnapshots: boolean;
readonly sdkLanguage: Language | undefined;
readonly testIdAttributeName: string | undefined;
readonly sources: Map<string, SourceModel>;
@@ -131,6 +133,8 @@ export class TraceModel {
this._ariaSnapshots.set(`${event.callId}/${event.phase}`, event);
this.videos.push(...(context.videos || []));
}
+ this.hasDomSnapshots = this.actions.some(action => !!action.beforeSnapshot || !!action.afterSnapshot || !!action.inputSnapshot);
+ this.hasAriaSnapshots = !!this._screenshots.size || !!this._ariaSnapshots.size;
this.attachments = this.actions.flatMap(action => action.attachments?.map(attachment => ({ ...attachment, callId: action.callId, traceUri })) ?? []);
this.visibleAttachments = this.attachments.filter(attachment => !attachment.name.startsWith('_'));
diff --git a/packages/trace-viewer/src/ui/ariaModeView.tsx b/packages/trace-viewer/src/ui/ariaModeView.tsx
index f9ed801ccf..6541b32bf5 100644
--- a/packages/trace-viewer/src/ui/ariaModeView.tsx
+++ b/packages/trace-viewer/src/ui/ariaModeView.tsx
@@ -36,6 +36,14 @@ export type AriaModeTargets = {
after?: AriaModeTarget;
};
+export function canToggleAriaMode(model: TraceModel | undefined): boolean {
+ return !!model?.hasDomSnapshots && !!model?.hasAriaSnapshots;
+}
+
+export function shouldDisplayAriaMode(model: TraceModel | undefined, setting: boolean): boolean {
+ return canToggleAriaMode(model) ? setting : !!model?.hasAriaSnapshots;
+}
+
// Mirrors the fallback logic in collectSnapshots(), but for screenshot / aria-snapshot events.
export function collectAriaModeTargets(model: TraceModel, action: ActionTraceEvent | undefined): AriaModeTargets {
if (!action)
diff --git a/packages/trace-viewer/src/ui/defaultSettingsView.tsx b/packages/trace-viewer/src/ui/defaultSettingsView.tsx
index 5844d0b5a9..d431340db9 100644
--- a/packages/trace-viewer/src/ui/defaultSettingsView.tsx
+++ b/packages/trace-viewer/src/ui/defaultSettingsView.tsx
@@ -18,13 +18,17 @@ import * as React from 'react';
import { type Setting, SettingsView } from './settingsView';
import { kThemeOptions, type Theme, useThemeSetting } from '@web/theme';
import { useSetting } from '@web/uiUtils';
+import { canToggleAriaMode, shouldDisplayAriaMode } from './ariaModeView';
+
+import type { TraceModel } from '@isomorphic/trace/traceModel';
/**
* A view of the collection of standard settings used between various applications
*/
export const DefaultSettingsView: React.FC<{
- location: 'ui-mode' | 'trace-viewer'
-}> = ({ location }) => {
+ location: 'ui-mode' | 'trace-viewer',
+ model?: TraceModel,
+}> = ({ location, model }) => {
const [
shouldPopulateCanvasFromScreenshot,
setShouldPopulateCanvasFromScreenshot,
@@ -32,6 +36,7 @@ export const DefaultSettingsView: React.FC<{
const [displayAriaMode, setDisplayAriaMode] = useSetting('displayAriaMode', false);
const [theme, setTheme] = useThemeSetting();
const [mergeFiles, setMergeFiles] = useSetting('mergeFiles', false);
+ const canToggleAria = canToggleAriaMode(model);
return (
<SettingsView
@@ -58,10 +63,13 @@ export const DefaultSettingsView: React.FC<{
},
{
type: 'check',
- value: displayAriaMode,
+ value: shouldDisplayAriaMode(model, displayAriaMode),
set: setDisplayAriaMode,
name: 'Display Aria',
- title: 'Display the action screenshot and aria snapshot instead of the DOM snapshot. Requires a trace recorded with screen and aria snapshots.',
+ disabled: !canToggleAria,
+ title: canToggleAria
+ ? 'Display the action screenshot and aria snapshot instead of the DOM snapshot.'
+ : 'The trace does not have both DOM and aria snapshots, so there is nothing to switch between.',
},
]}
/>
diff --git a/packages/trace-viewer/src/ui/settingsView.css b/packages/trace-viewer/src/ui/settingsView.css
index 3a0f2aaa93..82b288e2cb 100644
--- a/packages/trace-viewer/src/ui/settingsView.css
+++ b/packages/trace-viewer/src/ui/settingsView.css
@@ -64,3 +64,11 @@
align-items: center;
justify-content: center;
}
+
+.settings-view .setting-disabled {
+ opacity: 0.5;
+}
+
+.settings-view .setting-disabled label {
+ cursor: default;
+}
diff --git a/packages/trace-viewer/src/ui/settingsView.tsx b/packages/trace-viewer/src/ui/settingsView.tsx
index 39497d8b03..d7789ac2c8 100644
--- a/packages/trace-viewer/src/ui/settingsView.tsx
+++ b/packages/trace-viewer/src/ui/settingsView.tsx
@@ -15,12 +15,14 @@
*/
import * as React from 'react';
+import { clsx } from '@web/uiUtils';
import './settingsView.css';
export type Setting<Value extends string = string> = {
name: string;
title?: string;
count?: number;
+ disabled?: boolean;
} & ({
type: 'check',
value: boolean;
@@ -41,7 +43,7 @@ export const SettingsView = <Value extends string>(
const labelId = `setting-${setting.name.replaceAll(/\s+/g, '-')}`;
return (
- <div key={setting.name} className={`setting setting-${setting.type}`} title={setting.title}>
+ <div key={setting.name} className={clsx('setting', `setting-${setting.type}`, setting.disabled && 'setting-disabled')} title={setting.title}>
{renderSetting(setting, labelId)}
</div>
);
@@ -59,6 +61,7 @@ const renderSetting = <Value extends string>(setting: Setting<Value>, labelId: s
type='checkbox'
id={labelId}
checked={setting.value}
+ disabled={setting.disabled}
onChange={() => setting.set(!setting.value)}
/>
<label htmlFor={labelId}>{setting.name}{!!setting.count && <span className='setting-counter'>{setting.count}</span>}</label>
@@ -68,7 +71,7 @@ const renderSetting = <Value extends string>(setting: Setting<Value>, labelId: s
return (
<>
<label htmlFor={labelId}>{setting.name}:{!!setting.count && <span className='setting-counter'>{setting.count}</span>}</label>
- <select id={labelId} value={setting.value} onChange={e => setting.set(e.target.value as Value)}>
+ <select id={labelId} value={setting.value} disabled={setting.disabled} onChange={e => setting.set(e.target.value as Value)}>
{setting.options.map(option => (
<option key={option.value} value={option.value}>
{option.label}
diff --git a/packages/trace-viewer/src/ui/snapshotTab.tsx b/packages/trace-viewer/src/ui/snapshotTab.tsx
index 57757b79de..5a968cad2d 100644
--- a/packages/trace-viewer/src/ui/snapshotTab.tsx
+++ b/packages/trace-viewer/src/ui/snapshotTab.tsx
@@ -35,7 +35,7 @@ import { parseAriaSnapshot } from '@isomorphic/ariaSnapshot';
import yaml from 'yaml';
import { PlaybackButtons } from './playbackControl';
import type { PlaybackState } from './playbackControl';
-import { AriaModeView, collectAriaModeTargets } from './ariaModeView';
+import { AriaModeView, collectAriaModeTargets, shouldDisplayAriaMode } from './ariaModeView';
export type HighlightedElement = {
locator?: string,
@@ -57,7 +57,8 @@ export const SnapshotTabsView: React.FunctionComponent<{
const [snapshotTab, setSnapshotTab] = React.useState<'action'|'before'|'after'>('action');
const [shouldPopulateCanvasFromScreenshot] = useSetting('shouldPopulateCanvasFromScreenshot', false);
- const [displayAriaMode] = useSetting('displayAriaMode', false);
+ const [displayAriaModeSetting] = useSetting('displayAriaMode', false);
+ const displayAriaMode = shouldDisplayAriaMode(model, displayAriaModeSetting);
const snapshots = React.useMemo(() => {
return collectSnapshots(action);
diff --git a/packages/trace-viewer/src/ui/uiModeTraceView.tsx b/packages/trace-viewer/src/ui/uiModeTraceView.tsx
index 30b70a84cb..b167ac74ad 100644
--- a/packages/trace-viewer/src/ui/uiModeTraceView.tsx
+++ b/packages/trace-viewer/src/ui/uiModeTraceView.tsx
@@ -31,7 +31,8 @@ export const TraceView: React.FC<{
onOpenExternally?: (location: SourceLocation) => void,
revealSource?: boolean,
pathSeparator: string,
-}> = ({ item, rootDir, onOpenExternally, revealSource, pathSeparator }) => {
+ onModelChange?: (model: TraceModel | undefined) => void,
+}> = ({ item, rootDir, onOpenExternally, revealSource, pathSeparator, onModelChange }) => {
const [model, setModel] = React.useState<{ model: TraceModel, isLive: boolean } | undefined>(undefined);
const [counter, setCounter] = React.useState(0);
const pollTimer = React.useRef<NodeJS.Timeout | null>(null);
@@ -88,6 +89,10 @@ export const TraceView: React.FC<{
};
}, [outputDir, item, setModel, counter, setCounter, pathSeparator]);
+ React.useEffect(() => {
+ onModelChange?.(model?.model);
+ }, [model, onModelChange]);
+
return <Workbench
model={model?.model}
key='workbench'
diff --git a/packages/trace-viewer/src/ui/uiModeView.tsx b/packages/trace-viewer/src/ui/uiModeView.tsx
index 218a671f23..3bf380dd27 100644
--- a/packages/trace-viewer/src/ui/uiModeView.tsx
+++ b/packages/trace-viewer/src/ui/uiModeView.tsx
@@ -22,7 +22,7 @@ import { TeleSuiteUpdater, type TeleSuiteUpdaterProgress, type TeleSuiteUpdaterT
import type { TeleTestCase } from '@testIsomorphic/teleReceiver';
import type * as reporterTypes from 'playwright/types/testReporter';
import { SplitView } from '@web/components/splitView';
-import type { SourceLocation } from '@isomorphic/trace/traceModel';
+import type { SourceLocation, TraceModel } from '@isomorphic/trace/traceModel';
import './uiModeView.css';
import { ToolbarButton } from '@web/components/toolbarButton';
import { Toolbar } from '@web/components/toolbar';
@@ -125,6 +125,7 @@ export const UIModeView: React.FC<{}> = ({
const [settingsVisible, setSettingsVisible] = React.useState(false);
const [testingOptionsVisible, setTestingOptionsVisible] = React.useState(false);
const [revealSource, setRevealSource] = React.useState(false);
+ const [traceModel, setTraceModel] = React.useState<TraceModel | undefined>();
const onRevealSource = React.useCallback(() => setRevealSource(true), [setRevealSource]);
const [singleWorker, setSingleWorker] = useSetting<boolean>('single-worker', false);
@@ -479,6 +480,7 @@ export const UIModeView: React.FC<{}> = ({
<TraceView
pathSeparator={queryParams.pathSeparator}
item={selectedItem}
+ onModelChange={setTraceModel}
rootDir={testModel?.config?.rootDir}
revealSource={revealSource}
onOpenExternally={location => testServerConnection?.openNoReply({ location: { file: location.file, line: location.line, column: location.column } })}
@@ -565,7 +567,7 @@ export const UIModeView: React.FC<{}> = ({
/>
<div className='section-title'>Settings</div>
</Toolbar>
- {settingsVisible && <DefaultSettingsView location='ui-mode' />}
+ {settingsVisible && <DefaultSettingsView location='ui-mode' model={traceModel} />}
</div>
}
/>
diff --git a/packages/trace-viewer/src/ui/workbenchLoader.tsx b/packages/trace-viewer/src/ui/workbenchLoader.tsx
index e3718e6336..f5f16ee541 100644
--- a/packages/trace-viewer/src/ui/workbenchLoader.tsx
+++ b/packages/trace-viewer/src/ui/workbenchLoader.tsx
@@ -200,7 +200,7 @@ export const WorkbenchLoader: React.FunctionComponent<{
{model.title && <div className='title'>{model.title}</div>}
<div className='spacer'></div>
<DialogToolbarButton icon='settings-gear' title='Settings' dialogDataTestId='settings-toolbar-dialog'>
- <DefaultSettingsView location='trace-viewer' />
+ <DefaultSettingsView location='trace-viewer' model={model} />
</DialogToolbarButton>
</div>
<Workbench model={model} inert={showFileUploadDropArea} />
diff --git a/tests/library/trace-viewer.spec.ts b/tests/library/trace-viewer.spec.ts
index 7c7d855c88..3ef6620154 100644
--- a/tests/library/trace-viewer.spec.ts
+++ b/tests/library/trace-viewer.spec.ts
@@ -2236,6 +2236,34 @@ test('should display aria mode', async ({ runAndTrace, page }) => {
await expect(traceViewer.snapshotContainer).toBeVisible();
});
+test('should disable aria setting when there are no aria snapshots', async ({ runAndTrace, page }) => {
+ const traceViewer = await runAndTrace(async () => {
+ await page.setContent('<!DOCTYPE html><button>Click me</button>');
+ await page.locator('button').click();
+ }, { snapshots: { dom: true } });
+
+ await traceViewer.selectAction('Click');
+ await expect(traceViewer.snapshotContainer).toBeVisible();
+
+ await traceViewer.showSettings();
+ await expect(traceViewer.displayAriaSetting).toBeDisabled();
+ await expect(traceViewer.displayAriaSetting).toBeChecked({ checked: false });
+});
+
+test('should force aria mode when there are no dom snapshots', async ({ runAndTrace, page }) => {
+ const traceViewer = await runAndTrace(async () => {
+ await page.setContent('<!DOCTYPE html><button>Click me</button>');
+ await page.locator('button').click();
+ }, { snapshots: { aria: true, screen: true } });
+
+ await traceViewer.selectAction('Click');
+ await expect(traceViewer.page.locator('.aria-mode-view')).toContainText('button "Click me"');
+
+ await traceViewer.showSettings();
+ await expect(traceViewer.displayAriaSetting).toBeDisabled();
+ await expect(traceViewer.displayAriaSetting).toBeChecked({ checked: true });
+});
+
test('should render blob trace received from message', async ({ showTraceViewer }) => {
const traceViewer = await showTraceViewer(undefined, { host: 'localhost' });