Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(playwright-ct): fix issues and flake #8016

Merged
merged 6 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
"prettier": "@sanity/prettier-config",
"devDependencies": {
"@google-cloud/storage": "^7.11.0",
"@playwright/test": "1.44.1",
"@playwright/test": "1.49.1",
"@repo/dev-aliases": "workspace:*",
"@repo/package.config": "workspace:*",
"@repo/test-config": "workspace:*",
Expand Down
4 changes: 2 additions & 2 deletions packages/sanity/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@
"yargs": "^17.3.0"
},
"devDependencies": {
"@playwright/experimental-ct-react": "1.44.1",
"@playwright/test": "1.44.1",
"@playwright/experimental-ct-react": "1.49.1",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wonder when it will no longer be experimental 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha, yes

"@playwright/test": "1.49.1",
"@repo/dev-aliases": "workspace:*",
"@repo/package.config": "workspace:*",
"@repo/test-config": "workspace:*",
Expand Down
4 changes: 2 additions & 2 deletions packages/sanity/playwright-ct.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ export default defineConfig({
],

/* Maximum time one test can run for. */
timeout: 30 * 1000,
timeout: 60 * 1000,
expect: {
// Maximum time expect() should wait for the condition to be met.
timeout: 10 * 1000,
timeout: 40 * 1000,
},

/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,6 @@ test.describe('Portable Text Input', () => {
page,
browserName,
}) => {
// avoid flakiness to make sure the test has the best chance despite being slow
test.slow()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Increased timeouts will not combat the flake here.


// For now, only test in Chromium due to flakiness in Firefox and WebKit
test.skip(browserName !== 'chromium')

const {
getModifierKey,
getFocusedPortableTextEditor,
Expand All @@ -62,7 +56,7 @@ test.describe('Portable Text Input', () => {
await mount(<DecoratorsStory />)
const $portableTextInput = await getFocusedPortableTextInput('field-defaultDecorators')
const $pte = await getFocusedPortableTextEditor('field-defaultDecorators')
const modifierKey = getModifierKey()
const modifierKey = getModifierKey({browserName})

for (const decorator of DEFAULT_DECORATORS) {
if (decorator.hotkey) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ test.describe('Portable Text Input', () => {
})

// TODO - needs rewrite to avoid flakiness
test.skip('Opening block style', () => {
test.describe('Opening block style', () => {
test('on a simple editor', async ({mount, page}) => {
const {getFocusedPortableTextInput} = testHelpers({page})
await mount(<ToolbarStory />)
Expand Down
17 changes: 13 additions & 4 deletions packages/sanity/playwright-ct/tests/utils/testHelpers.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export function testHelpers({page}: {page: PlaywrightTestArgs['page']}) {
await $overlay.press('Space')
}

await expect($overlay).not.toBeVisible({timeout: 1500})
await expect($overlay).not.toBeVisible()
}
return {
/**
Expand Down Expand Up @@ -105,11 +105,20 @@ export function testHelpers({page}: {page: PlaywrightTestArgs['page']}) {
* Gets the appropriate modifier key for the current platform.
* @returns The modifier key name ('Meta' for macOS, 'Control' for other platforms).
*/
getModifierKey: () => {
if (process.platform === 'darwin') {
getModifierKey: (options?: {browserName?: string}) => {
// There's a bug with Firefox and Chromium on macOS where it use 'Control' instead of 'Meta' inside Playwright for some reason
if (
process.platform === 'darwin' &&
options?.browserName &&
['chromium', 'firefox'].includes(options.browserName)
) {
return 'Control'
}
// Webkit on Linux uses 'Meta' instead of 'Control' as the modifier key for some reason
if (process.platform === 'linux' && options?.browserName === 'webkit') {
return 'Meta'
}
return 'Control'
return 'ControlOrMeta'
},
/**
* Types text with a delay using `page.keyboard.type`. Default delay emulates a human typing.
Expand Down
2 changes: 1 addition & 1 deletion perf/tests/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"studio:dev": "cd perf/studio && SANITY_STUDIO_DATASET=dev pnpm dev"
},
"dependencies": {
"@playwright/test": "1.44.1",
"@playwright/test": "1.49.1",
"@sanity/client": "^6.24.1",
"@sanity/uuid": "^3.0.1",
"dotenv": "^16.0.3",
Expand Down
100 changes: 50 additions & 50 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading