Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: put "auto expect" codegen feature under a checkbox (#37038)
Dmitry Gozmana27f50dfb9cd
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex f704da03f4..e5368ca120 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -459,6 +459,7 @@ scheme.DebugControllerSetReportStateChangedResult = tOptional(tObject({}));scheme.DebugControllerSetRecorderModeParams = tObject({mode: tEnum(['inspecting', 'recording', 'none']),testIdAttributeName: tOptional(tString),+ generateAutoExpect: tOptional(tBoolean),});scheme.DebugControllerSetRecorderModeResult = tOptional(tObject({}));scheme.DebugControllerHighlightParams = tObject({diff --git a/packages/playwright-core/src/server/codegen/language.ts b/packages/playwright-core/src/server/codegen/language.tsindex cef97252a8..1da8a91561 100644--- a/packages/playwright-core/src/server/codegen/language.ts+++ b/packages/playwright-core/src/server/codegen/language.ts@@ -22,16 +22,16 @@ import type * as actions from '@recorder/actions';export function generateCode(actions: actions.ActionInContext[], languageGenerator: LanguageGenerator, options: LanguageGeneratorOptions) {const header = languageGenerator.generateHeader(options);const footer = languageGenerator.generateFooter(options.saveStorage);- const actionTexts = actions.map(a => generateActionText(languageGenerator, a)).filter(Boolean) as string[];+ const actionTexts = actions.map(a => generateActionText(languageGenerator, a, !!options.generateAutoExpect)).filter(Boolean) as string[];const text = [header, ...actionTexts, footer].join('\n');return { header, footer, actionTexts, text };}-function generateActionText(generator: LanguageGenerator, action: actions.ActionInContext): string | undefined {+function generateActionText(generator: LanguageGenerator, action: actions.ActionInContext, generateAutoExpect: boolean): string | undefined {let text = generator.generateAction(action);if (!text)return;- if (action.action.preconditionSelector) {+ if (generateAutoExpect && action.action.preconditionSelector) {const expectAction: actions.ActionInContext = {frame: action.frame,startTime: action.startTime,@@ -44,7 +44,7 @@ function generateActionText(generator: LanguageGenerator, action: actions.Action};const expectText = generator.generateAction(expectAction);if (expectText)- text = expectText + '\n' + text;+ text = expectText + '\n\n' + text;}return text;}diff --git a/packages/playwright-core/src/server/codegen/types.ts b/packages/playwright-core/src/server/codegen/types.tsindex da3583e2f6..c4d3c827bf 100644--- a/packages/playwright-core/src/server/codegen/types.ts+++ b/packages/playwright-core/src/server/codegen/types.ts@@ -25,6 +25,7 @@ export type LanguageGeneratorOptions = {contextOptions: BrowserContextOptions;deviceName?: string;saveStorage?: string;+ generateAutoExpect?: boolean;};export interface LanguageGenerator {diff --git a/packages/playwright-core/src/server/debugController.ts b/packages/playwright-core/src/server/debugController.tsindex 295b18c136..a9c4aafc7d 100644--- a/packages/playwright-core/src/server/debugController.ts+++ b/packages/playwright-core/src/server/debugController.ts@@ -45,6 +45,7 @@ export class DebugController extends SdkObject {private _trackHierarchyListener: InstrumentationListener | undefined;private _playwright: Playwright;_sdkLanguage: Language = 'javascript';+ _generateAutoExpect = false;constructor(playwright: Playwright) {super({ attribution: { isInternalPlaywright: true }, instrumentation: createInstrumentation() } as any, undefined, 'DebugController');@@ -73,8 +74,9 @@ export class DebugController extends SdkObject {}}- async setRecorderMode(progress: Progress, params: { mode: Mode, testIdAttributeName?: string }) {+ async setRecorderMode(progress: Progress, params: { mode: Mode, testIdAttributeName?: string, generateAutoExpect?: boolean }) {await progress.race(this._closeBrowsersWithoutPages());+ this._generateAutoExpect = !!params.generateAutoExpect;if (params.mode === 'none') {for (const recorder of await progress.race(this._allRecorders())) {@@ -181,6 +183,7 @@ function wireListeners(recorder: Recorder, debugController: DebugController) {browserName: 'chromium',launchOptions: {},contextOptions: {},+ generateAutoExpect: debugController._generateAutoExpect,});debugController.emit(DebugController.Events.SourceChanged, { text, header, footer, actions: actionTexts });};diff --git a/packages/playwright-core/src/server/recorder/recorderApp.ts b/packages/playwright-core/src/server/recorder/recorderApp.tsindex c590096a20..5d1ffb81bd 100644--- a/packages/playwright-core/src/server/recorder/recorderApp.ts+++ b/packages/playwright-core/src/server/recorder/recorderApp.ts@@ -138,6 +138,11 @@ export class RecorderApp {}return;}+ if (data.event === 'setAutoExpect') {+ this._languageGeneratorOptions.generateAutoExpect = data.params.autoExpect;+ this._updateActions();+ return;+ }if (data.event === 'setMode') {this._recorder.setMode(data.params.mode);return;diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 10749d68c6..31bde8e1a7 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -770,9 +770,11 @@ export type DebugControllerSetReportStateChangedResult = void;export type DebugControllerSetRecorderModeParams = {mode: 'inspecting' | 'recording' | 'none',testIdAttributeName?: string,+ generateAutoExpect?: boolean,};export type DebugControllerSetRecorderModeOptions = {testIdAttributeName?: string,+ generateAutoExpect?: boolean,};export type DebugControllerSetRecorderModeResult = void;export type DebugControllerHighlightParams = {diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex b6ab404173..f2e9a0bf0e 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -895,6 +895,7 @@ DebugController:- recording- nonetestIdAttributeName: string?+ generateAutoExpect: boolean?highlight:internal: truediff --git a/packages/recorder/src/recorder.css b/packages/recorder/src/recorder.cssindex fa7ce623db..defde39efb 100644--- a/packages/recorder/src/recorder.css+++ b/packages/recorder/src/recorder.css@@ -57,3 +57,20 @@ body.dark-mode .recorder .toolbar-button.toggled.circle-large-filled {.recorder .selector-input {flex: auto;}++.setting {+ display: flex;+ align-items: center;+}++.setting label {+ text-overflow: ellipsis;+ white-space: nowrap;+ overflow: hidden;+ cursor: pointer;+}++.setting input {+ margin-right: 5px;+ flex-shrink: 0;+}diff --git a/packages/recorder/src/recorder.tsx b/packages/recorder/src/recorder.tsxindex 3a6a8332bd..de464bec8a 100644--- a/packages/recorder/src/recorder.tsx+++ b/packages/recorder/src/recorder.tsx@@ -26,10 +26,11 @@ import * as React from 'react';import { CallLogView } from './callLog';import './recorder.css';import { asLocator } from '@isomorphic/locatorGenerators';-import { toggleTheme } from '@web/theme';+import { useDarkModeSetting } from '@web/theme';import { copy, useSetting } from '@web/uiUtils';import yaml from 'yaml';import { parseAriaSnapshot } from '@isomorphic/ariaSnapshot';+import { Dialog } from '@web/components/dialog';export interface RecorderProps {sources: Source[],@@ -48,8 +49,16 @@ export const Recorder: React.FC<RecorderProps> = ({const [selectedTab, setSelectedTab] = useSetting<string>('recorderPropertiesTab', 'log');const [ariaSnapshot, setAriaSnapshot] = React.useState<string | undefined>();const [ariaSnapshotErrors, setAriaSnapshotErrors] = React.useState<SourceHighlight[]>();+ const [settingsOpen, setSettingsOpen] = React.useState(false);+ const [darkMode, setDarkMode] = useDarkModeSetting();+ const [autoExpect, setAutoExpect] = useSetting<boolean>('autoExpect', false);+ const settingsButtonRef = React.useRef<HTMLButtonElement>(null);window.playwrightSelectSource = selectedSourceId => setSelectedFileId(selectedSourceId);+ React.useEffect(() => {+ window.dispatch({ event: 'setAutoExpect', params: { autoExpect } });+ }, [autoExpect]);+const source = React.useMemo(() => {const source = sources.find(s => s.id === selectedFileId);return source ?? emptySource();@@ -178,7 +187,33 @@ export const Recorder: React.FC<RecorderProps> = ({<ToolbarButton icon='clear-all' title='Clear' disabled={!source || !source.text} onClick={() => {window.dispatch({ event: 'clear' });}}></ToolbarButton>- <ToolbarButton icon='color-mode' title='Toggle color mode' toggled={false} onClick={() => toggleTheme()}></ToolbarButton>+ <ToolbarButton+ ref={settingsButtonRef}+ icon='settings-gear'+ title='Settings'+ onClick={() => setSettingsOpen(current => !current)}+ />+ <Dialog+ style={{ padding: '4px 8px' }}+ open={settingsOpen}+ width={200}+ verticalOffset={8}+ requestClose={() => setSettingsOpen(false)}+ anchor={settingsButtonRef}+ dataTestId='settings-dialog'+ >+ <div key='dark-mode-setting' className='setting'>+ <input type='checkbox' id='dark-mode-setting' checked={darkMode} onChange={() => setDarkMode(!darkMode)} />+ <label htmlFor='dark-mode-setting'>Dark mode</label>+ </div>+ <div key='auto-expect-setting' className='setting' title='Automatically generate assertions while recording'>+ <input type='checkbox' id='auto-expect-setting' checked={autoExpect} onChange={() => {+ window.dispatch({ event: 'setAutoExpect', params: { autoExpect: !autoExpect } });+ setAutoExpect(!autoExpect);+ }} />+ <label htmlFor='auto-expect-setting'>Generate assertions</label>+ </div>+ </Dialog></Toolbar><SplitViewsidebarSize={200}diff --git a/packages/trace-viewer/src/ui/settingsToolbarButton.tsx b/packages/trace-viewer/src/ui/settingsToolbarButton.tsxindex 647f593bf5..d447400776 100644--- a/packages/trace-viewer/src/ui/settingsToolbarButton.tsx+++ b/packages/trace-viewer/src/ui/settingsToolbarButton.tsx@@ -15,7 +15,7 @@*/import * as React from 'react';-import { Dialog } from './shared/dialog';+import { Dialog } from '@web/components/dialog';import { ToolbarButton } from '@web/components/toolbarButton';import { DefaultSettingsView } from './defaultSettingsView';diff --git a/packages/trace-viewer/src/ui/workbenchLoader.tsx b/packages/trace-viewer/src/ui/workbenchLoader.tsxindex 1b1d243591..747ffa4e3f 100644--- a/packages/trace-viewer/src/ui/workbenchLoader.tsx+++ b/packages/trace-viewer/src/ui/workbenchLoader.tsx@@ -21,7 +21,7 @@ import './workbenchLoader.css';import { Workbench } from './workbench';import { TestServerConnection, WebSocketTestServerTransport } from '@testIsomorphic/testServerConnection';import { SettingsToolbarButton } from './settingsToolbarButton';-import { Dialog } from './shared/dialog';+import { Dialog } from '@web/components/dialog';export const WorkbenchLoader: React.FunctionComponent<{}> = () => {diff --git a/packages/trace-viewer/src/ui/shared/dialog.tsx b/packages/web/src/components/dialog.tsxsimilarity index 100%rename from packages/trace-viewer/src/ui/shared/dialog.tsxrename to packages/web/src/components/dialog.tsxdiff --git a/tests/library/inspector/cli-codegen-2.spec.ts b/tests/library/inspector/cli-codegen-2.spec.tsindex dfc7c832d0..06061c4757 100644--- a/tests/library/inspector/cli-codegen-2.spec.ts+++ b/tests/library/inspector/cli-codegen-2.spec.ts@@ -538,6 +538,8 @@ await page.Locator("#textarea").FillAsync(\"Hello'\\"\`\\nWorld\");`);});</script>`);+ await recorder.recorderPage.getByRole('button', { name: 'Settings' }).click();+ await recorder.recorderPage.getByRole('checkbox', { name: 'Generate assertions' }).check();const locatorOne = await recorder.hoverOverElement('#one');expect(locatorOne).toBe(`getByRole('button', { name: 'one' })`);@@ -557,22 +559,27 @@ await page.Locator("#textarea").FillAsync(\"Hello'\\"\`\\nWorld\");`);expect.soft(sources.get('Playwright Test')!.text).toContain(`await expect(page.getByRole('heading', { name: 'new header' })).toBeVisible();+await page.getByRole('button', { name: 'two' }).click();`);expect.soft(sources.get('Python')!.text).toContain(`expect(page.get_by_role("heading", name="new header")).to_be_visible()+page.get_by_role("button", name="two").click()`);expect.soft(sources.get('Python Async')!.text).toContain(`await expect(page.get_by_role("heading", name="new header")).to_be_visible()+await page.get_by_role("button", name="two").click()`);expect.soft(sources.get('Java')!.text).toContain(`assertThat(page.getByRole(AriaRole.HEADING, new Page.GetByRoleOptions().setName("new header"))).isVisible();+page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("two")).click();`);expect.soft(sources.get('C#')!.text).toContain(`await Expect(page.GetByRole(AriaRole.Heading, new() { Name = "new header" })).ToBeVisibleAsync();+await page.GetByRole(AriaRole.Button, new() { Name = "two" }).ClickAsync();`);});});