Skip to content

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

chore: move actions filter from settings to actions toolbar (#37186)

Dmitry Gozmanf52c5057381e
diff --git a/packages/trace-viewer/src/ui/defaultSettingsView.tsx b/packages/trace-viewer/src/ui/defaultSettingsView.tsx
index 5c12f82345..9d55570878 100644
--- a/packages/trace-viewer/src/ui/defaultSettingsView.tsx
+++ b/packages/trace-viewer/src/ui/defaultSettingsView.tsx
@@ -18,7 +18,6 @@ import * as React from 'react';
import { SettingsView } from './settingsView';
import { useDarkModeSetting } from '@web/theme';
import { useSetting } from '@web/uiUtils';
-import type { ActionGroup } from '@isomorphic/protocolFormatter';
/**
* A view of the collection of standard settings used between various applications
@@ -28,7 +27,6 @@ export const DefaultSettingsView: React.FC<{}> = () => {
shouldPopulateCanvasFromScreenshot,
setShouldPopulateCanvasFromScreenshot,
] = useSetting('shouldPopulateCanvasFromScreenshot', false);
- const [actionsFilter, setActionsFilter] = useSetting<ActionGroup[]>('actionsFilter', []);
const [darkMode, setDarkMode] = useDarkModeSetting();
return (
@@ -47,24 +45,6 @@ export const DefaultSettingsView: React.FC<{}> = () => {
name: 'Display canvas content',
title: 'Attempt to display the captured canvas appearance in the snapshot preview. May not be accurate.',
},
- {
- type: 'check',
- value: actionsFilter.includes('getter'),
- set: value => setActionsFilter(value ? [...actionsFilter, 'getter'] : actionsFilter.filter(a => a !== 'getter')),
- name: 'Show getter actions',
- },
- {
- type: 'check',
- value: actionsFilter.includes('route'),
- set: value => setActionsFilter(value ? [...actionsFilter, 'route'] : actionsFilter.filter(a => a !== 'route')),
- name: 'Show route actions',
- },
- {
- type: 'check',
- value: actionsFilter.includes('configuration'),
- set: value => setActionsFilter(value ? [...actionsFilter, 'configuration'] : actionsFilter.filter(a => a !== 'configuration')),
- name: 'Show configuration actions',
- },
]}
/>
);
diff --git a/packages/trace-viewer/src/ui/settingsToolbarButton.tsx b/packages/trace-viewer/src/ui/settingsToolbarButton.tsx
deleted file mode 100644
index d447400776..0000000000
--- a/packages/trace-viewer/src/ui/settingsToolbarButton.tsx
+++ /dev/null
@@ -1,52 +0,0 @@
-/*
- 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 * as React from 'react';
-import { Dialog } from '@web/components/dialog';
-import { ToolbarButton } from '@web/components/toolbarButton';
-import { DefaultSettingsView } from './defaultSettingsView';
-
-export const SettingsToolbarButton: React.FC<{}> = () => {
- const hostingRef = React.useRef<HTMLButtonElement>(null);
-
- const [open, setOpen] = React.useState(false);
-
- return (
- <>
- <ToolbarButton
- ref={hostingRef}
- icon='settings-gear'
- title='Settings'
- onClick={() => setOpen(current => !current)}
- />
- <Dialog
- style={{
- backgroundColor: 'var(--vscode-sideBar-background)',
- padding: '4px 8px'
- }}
- open={open}
- width={200}
- // TODO: Temporary spacing until design of toolbar buttons is revisited
- verticalOffset={8}
- requestClose={() => setOpen(false)}
- anchor={hostingRef}
- dataTestId='settings-toolbar-dialog'
- >
- <DefaultSettingsView />
- </Dialog>
- </>
- );
-};
diff --git a/packages/trace-viewer/src/ui/workbench.tsx b/packages/trace-viewer/src/ui/workbench.tsx
index 9c0a3fccc3..2581b672cb 100644
--- a/packages/trace-viewer/src/ui/workbench.tsx
+++ b/packages/trace-viewer/src/ui/workbench.tsx
@@ -45,6 +45,8 @@ import type { HighlightedElement } from './snapshotTab';
import type { TestAnnotation } from '@playwright/test';
import { MetadataWithCommitInfo } from '@testIsomorphic/types';
import type { ActionGroup } from '@isomorphic/protocolFormatter';
+import { DialogToolbarButton } from '@web/components/dialog';
+import { SettingsView } from './settingsView';
export const Workbench: React.FunctionComponent<{
model?: modelUtil.MultiTraceModel,
@@ -358,6 +360,7 @@ export const Workbench: React.FunctionComponent<{
tabs={[actionsTab, metadataTab]}
selectedTab={selectedNavigatorTab}
setSelectedTab={setSelectedNavigatorTab}
+ rightToolbar={[<ActionsFilterButton key='filter'/>]}
/>
}
/>}
@@ -379,3 +382,31 @@ export const Workbench: React.FunctionComponent<{
/>
</div>;
};
+
+const ActionsFilterButton: React.FC<{}> = () => {
+ const [actionsFilter, setActionsFilter] = useSetting<ActionGroup[]>('actionsFilter', []);
+ return <DialogToolbarButton icon='filter' title='Filter actions'>
+ <SettingsView
+ settings={[
+ {
+ type: 'check',
+ value: actionsFilter.includes('getter'),
+ set: value => setActionsFilter(value ? [...actionsFilter, 'getter'] : actionsFilter.filter(a => a !== 'getter')),
+ name: 'Getters',
+ },
+ {
+ type: 'check',
+ value: actionsFilter.includes('route'),
+ set: value => setActionsFilter(value ? [...actionsFilter, 'route'] : actionsFilter.filter(a => a !== 'route')),
+ name: 'Network routes',
+ },
+ {
+ type: 'check',
+ value: actionsFilter.includes('configuration'),
+ set: value => setActionsFilter(value ? [...actionsFilter, 'configuration'] : actionsFilter.filter(a => a !== 'configuration')),
+ name: 'Configuration',
+ },
+ ]}
+ />
+ </DialogToolbarButton>;
+};
diff --git a/packages/trace-viewer/src/ui/workbenchLoader.tsx b/packages/trace-viewer/src/ui/workbenchLoader.tsx
index 747ffa4e3f..06ae35afa5 100644
--- a/packages/trace-viewer/src/ui/workbenchLoader.tsx
+++ b/packages/trace-viewer/src/ui/workbenchLoader.tsx
@@ -20,8 +20,8 @@ import { MultiTraceModel } from './modelUtil';
import './workbenchLoader.css';
import { Workbench } from './workbench';
import { TestServerConnection, WebSocketTestServerTransport } from '@testIsomorphic/testServerConnection';
-import { SettingsToolbarButton } from './settingsToolbarButton';
-import { Dialog } from '@web/components/dialog';
+import { Dialog, DialogToolbarButton } from '@web/components/dialog';
+import { DefaultSettingsView } from './defaultSettingsView';
export const WorkbenchLoader: React.FunctionComponent<{
}> = () => {
@@ -193,7 +193,9 @@ export const WorkbenchLoader: React.FunctionComponent<{
<div className='product'>Playwright</div>
{model.title && <div className='title'>{model.title}</div>}
<div className='spacer'></div>
- <SettingsToolbarButton />
+ <DialogToolbarButton icon='settings-gear' title='Settings' dialogDataTestId='settings-toolbar-dialog'>
+ <DefaultSettingsView />
+ </DialogToolbarButton>
</div>
<Workbench model={model} inert={showFileUploadDropArea} />
{fileForLocalModeError && <div className='drop-target'>
diff --git a/packages/web/src/components/dialog.tsx b/packages/web/src/components/dialog.tsx
index 9c73b509ea..4e2972e4f6 100644
--- a/packages/web/src/components/dialog.tsx
+++ b/packages/web/src/components/dialog.tsx
@@ -15,6 +15,7 @@
*/
import * as React from 'react';
+import { ToolbarButton } from './toolbarButton';
export interface DialogProps {
className?: string;
@@ -56,7 +57,7 @@ export const Dialog: React.FC<React.PropsWithChildren<DialogProps>> = ({
top: bounds.bottom + (verticalOffset ?? 0),
left: buildTopLeftCoord(bounds, width ?? 0),
width,
- zIndex: 1,
+ zIndex: 100,
...externalStyle
};
}
@@ -163,3 +164,39 @@ const buildTopLeftCoordWithAlignment = (
};
}
};
+
+export interface DialogToolbarButtonProps {
+ title?: string;
+ icon?: string;
+ dialogDataTestId?: string;
+}
+
+export const DialogToolbarButton: React.FC<React.PropsWithChildren<DialogToolbarButtonProps>> = ({ title, icon, dialogDataTestId, children }) => {
+ const hostingRef = React.useRef<HTMLButtonElement>(null);
+ const [open, setOpen] = React.useState(false);
+ return (
+ <>
+ <ToolbarButton
+ ref={hostingRef}
+ icon={icon}
+ title={title}
+ onClick={() => setOpen(current => !current)}
+ />
+ <Dialog
+ style={{
+ backgroundColor: 'var(--vscode-sideBar-background)',
+ padding: '4px 8px'
+ }}
+ open={open}
+ width={200}
+ // TODO: Temporary spacing until design of toolbar buttons is revisited
+ verticalOffset={8}
+ requestClose={() => setOpen(false)}
+ anchor={hostingRef}
+ dataTestId={dialogDataTestId}
+ >
+ {children}
+ </Dialog>
+ </>
+ );
+};
diff --git a/tests/config/traceViewerFixtures.ts b/tests/config/traceViewerFixtures.ts
index 6d839675ba..9dedc6c579 100644
--- a/tests/config/traceViewerFixtures.ts
+++ b/tests/config/traceViewerFixtures.ts
@@ -73,11 +73,11 @@ class TraceViewerPage {
@step
async showAllActions() {
- await this.page.getByRole('button', { name: 'Settings' }).click();
- await this.page.locator('.setting').getByText('Show route actions').click();
- await this.page.locator('.setting').getByText('Show getter actions').click();
- await this.page.locator('.setting').getByText('Show configuration actions').click();
- await this.page.getByRole('button', { name: 'Settings' }).click();
+ await this.page.getByRole('button', { name: 'Filter actions' }).click();
+ await this.page.locator('.setting').getByText('Network routes').click();
+ await this.page.locator('.setting').getByText('Getters').click();
+ await this.page.locator('.setting').getByText('Configuration').click();
+ await this.page.getByRole('button', { name: 'Filter actions' }).click();
}
stackFrames(options: { selected?: boolean } = {}) {
diff --git a/tests/playwright-test/ui-mode-trace.spec.ts b/tests/playwright-test/ui-mode-trace.spec.ts
index 56c4607bef..48fd3873e5 100644
--- a/tests/playwright-test/ui-mode-trace.spec.ts
+++ b/tests/playwright-test/ui-mode-trace.spec.ts
@@ -506,10 +506,11 @@ test('should hide boxed fixtures and contents, reveal upon show all actions sett
- treeitem /After Hooks/
`);
- await page.getByText('Settings').click();
- await page.getByText('Show route actions').click();
- await page.getByText('Show configuration actions').click();
- await page.getByText('Show getter actions').click();
+ await page.getByRole('button', { name: 'Filter actions' }).click();
+ await page.locator('.setting').getByText('Network routes').click();
+ await page.locator('.setting').getByText('Getters').click();
+ await page.locator('.setting').getByText('Configuration').click();
+ await page.getByRole('button', { name: 'Filter actions' }).click();
await page.getByTestId('actions-tree').getByRole('treeitem', { name: 'Before Hooks' }).locator('.codicon-chevron-right').click();
await page.getByTestId('actions-tree').getByRole('treeitem', { name: 'Fixture "fixture"' }).locator('.codicon-chevron-right').click();