Migrate RichText e2e tests to Playwright #53493
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ellatrix
added
[Feature] Rich Text
ellatrix
requested review from
kevin940726,
Mamaduka,
ntwb,
nerrad and
ajitbohra
as code owners
|
Size Change: 0 B Total Size: 1.51 MB ℹ️ View Unchanged
|
ellatrix
force-pushed
the
migrate/rich-text-e2e-playwright
branch
from
99103eb
to
88f5d1d
Compare
stokesman
approved these changes
Aug 22, 2023
| ] ); | ||
| } ); | ||
|
|
||
| test( 'should apply multiple formats when selection is collapse', async ( { |
There was a problem hiding this comment.
Suggested change
| test( 'should apply multiple formats when selection is collapse', async ( { | |
| test( 'should apply multiple formats when selection is collapsed', async ( { |
I was finding by titles to jump back and forth and compare old tests to new and so didn’t find this one right away.
| ] ); | ||
| } ); | ||
|
|
||
| test( 'should undo backtick transform with backspace', async ( { |
There was a problem hiding this comment.
Total parity in the migration so ✅. On a side note, it happens that I was curious about this one because I didn't know about it. So I tried in Chrome/macOS and ended up with an empty paragraph. I could only get it to undo the transform if the `a` had content before it.
There was a problem hiding this comment.
Hm, it's working correctly for me. Need to press backspace immediately after typing it, you do anything else it will fail
ellatrix
force-pushed
the
migrate/rich-text-e2e-playwright
branch
from
88f5d1d
to
1c6d586
Compare
|
Flaky tests detected in f812f59. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6037609713
|
ellatrix
force-pushed
the
migrate/rich-text-e2e-playwright
branch
from
1c6d586
to
f812f59
Compare
This was referenced Sep 1, 2023
kevin940726
reviewed
Sep 1, 2023
There was a problem hiding this comment.
Is this file (and the other one below) supposed to be committed to the repo? c.c. @WunderBart
There was a problem hiding this comment.
Whoops, how did this happen?
There was a problem hiding this comment.
It definitely shouldn't! 😄 It looks like a custom WP_ARTIFACTS_PATH env variable was used because those files are by default saved to /artifacts path, unless specified otherwise by that var. Otherwise, maybe it was just copied/moved by accident? 🤷
There was a problem hiding this comment.
I've just learned this can happen when running tests via the Playwright VSCode extension. The WP_ARTIFACTS_PATH is not being set in that scenario, so the artifacts folder is created inside the cwd, which is the running test file location.
| } ) => { | ||
| await editor.canvas.click( 'role=button[name="Add default block"i]' ); | ||
| await page.keyboard.type( '`a`' ); | ||
| await page.evaluate( () => new Promise( window.requestIdleCallback ) ); |
There was a problem hiding this comment.
I've said this before elsewhere but repeating it in case you missed it: I don't think e2e tests should rely on implementation details like this. I understand if this is just a 1-to-1 migration though! Flagging this again so that we can find another way to solve this in the future. c.c. @Mamaduka any idea?
There was a problem hiding this comment.
I welcome solutions. We have to specifically wait this amount of time, otherwise the test could be running too fast and we'd get flaky tests. There's code that's waiting for an idle callback.
There was a problem hiding this comment.
I think we can make this test a bit more explicit, which might allow us to drop the requestIdleCallback. For example:
test( 'should not undo backtick transform with backspace after selection change', async ( {
page,
pageUtils,
editor,
} ) => {
await editor.canvas
.getByRole( 'button', { name: 'Add default block' } )
.click();
await page.keyboard.type( '`test`' );
const inlineCode = editor.canvas
.getByRole( 'document', {
name: 'Paragraph block',
} )
.locator( 'code' );
await expect( inlineCode ).toHaveText( 'test' ); // Here we make sure the inline code exists before moving inside the format boundary.
// Move inside format boundary.
await pageUtils.pressKeys( 'ArrowLeft', { times: 2 } );
await pageUtils.pressKeys( 'ArrowRight' );
// Empty the inline code content.
await pageUtils.pressKeys( 'Backspace', { times: 4 } );
await expect( inlineCode ).not.toBeAttached();
// Ensure the backtick transform was not undone.
await page.keyboard.type( 'test' );
await expect( inlineCode ).toHaveText( 'test' );
} );
WunderBart
reviewed
Sep 1, 2023
| await page.keyboard.press( 'ArrowRight' ); | ||
| await page.keyboard.press( 'Backspace' ); | ||
|
|
||
| expect( await editor.getBlocks() ).toMatchObject( [] ); |
There was a problem hiding this comment.
I might be missing something here, but how does this ensure the backtick transform was not undone?
There was a problem hiding this comment.
Because it's removed a and didn't restore `a`?
There was a problem hiding this comment.
So the test is for ensuring backspace works as expected inside the inline code boundary? Was there a regression where hitting backspace inside that boundary restored the string as well?
There was a problem hiding this comment.
No, this test is making sure that the transform is not undone after a selection change. Instead of undoing the transform, it should remove the character (default behaviour).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Migrate RichText e2e tests to Playwright, remove snapshots.
Why?
Paves the way for some of these tests to be run in Webkit and Firefox, perhaps also reorganising some of these.
How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast