-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Adding an e2e test verifying simple keyboard navigation through blocks #13455
Merged
gziolo
merged 2 commits into
WordPress:master
from
tjnicolaides:add/12392-add-e2e-test-keyboard-navigation-through-blocks
Mar 7, 2019
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
167 changes: 167 additions & 0 deletions
167
packages/e2e-tests/specs/keyboard-navigable-blocks.test.js
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { | ||
createNewPost, | ||
insertBlock, | ||
pressKeyWithModifier, | ||
} from '@wordpress/e2e-test-utils'; | ||
|
||
const navigateToContentEditorTop = async () => { | ||
// Use 'Ctrl+`' to return to the top of the editor | ||
await pressKeyWithModifier( 'ctrl', '`' ); | ||
await pressKeyWithModifier( 'ctrl', '`' ); | ||
|
||
// Tab into the Title block | ||
await page.keyboard.press( 'Tab' ); | ||
}; | ||
|
||
const tabThroughParagraphBlock = async ( paragraphText ) => { | ||
// Tab to the next paragraph block | ||
await page.keyboard.press( 'Tab' ); | ||
|
||
// The block external focusable wrapper has focus | ||
const isFocusedParagraphBlock = await page.evaluate( | ||
() => document.activeElement.dataset.type | ||
); | ||
await expect( isFocusedParagraphBlock ).toEqual( 'core/paragraph' ); | ||
|
||
// Tab causes 'add block' button to receive focus | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedParagraphInserterToggle = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'editor-inserter__toggle' ) | ||
); | ||
await expect( isFocusedParagraphInserterToggle ).toBe( true ); | ||
|
||
await tabThroughBlockMoverControl(); | ||
await tabThroughBlockToolbar(); | ||
|
||
// Tab causes the paragraph content to receive focus | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedParagraphContent = await page.evaluate( | ||
() => document.activeElement.contentEditable | ||
); | ||
// The value of 'contentEditable' should be the string 'true' | ||
await expect( isFocusedParagraphContent ).toBe( 'true' ); | ||
|
||
const paragraphEditableContent = await page.evaluate( | ||
() => document.activeElement.innerHTML | ||
); | ||
await expect( paragraphEditableContent ).toBe( paragraphText ); | ||
}; | ||
|
||
const tabThroughBlockMoverControl = async () => { | ||
// Tab to focus on the 'move up' control | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedMoveUpControl = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'editor-block-mover__control' ) | ||
); | ||
await expect( isFocusedMoveUpControl ).toBe( true ); | ||
|
||
// Tab to focus on the 'move down' control | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedMoveDownControl = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'editor-block-mover__control' ) | ||
); | ||
await expect( isFocusedMoveDownControl ).toBe( true ); | ||
}; | ||
|
||
const tabThroughBlockToolbar = async () => { | ||
// Tab to focus on the 'block switcher' control | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedBlockSwitcherControl = await page.evaluate( () => | ||
document.activeElement.classList.contains( | ||
'editor-block-switcher__toggle' | ||
) | ||
); | ||
await expect( isFocusedBlockSwitcherControl ).toBe( true ); | ||
|
||
// Tab to focus on the 'left paragraph alignment' dropdown control | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedLeftAlignmentControl = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'components-toolbar__control' ) | ||
); | ||
await expect( isFocusedLeftAlignmentControl ).toBe( true ); | ||
|
||
// Tab to focus on the 'center paragraph alignment' dropdown control | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedCenterAlignmentControl = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'components-toolbar__control' ) | ||
); | ||
await expect( isFocusedCenterAlignmentControl ).toBe( true ); | ||
|
||
// Tab to focus on the 'right paragraph alignment' dropdown control | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedRightAlignmentControl = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'components-toolbar__control' ) | ||
); | ||
await expect( isFocusedRightAlignmentControl ).toBe( true ); | ||
|
||
// Tab to focus on the 'Bold' formatting button | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedBoldFormattingButton = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'components-toolbar__control' ) | ||
); | ||
await expect( isFocusedBoldFormattingButton ).toBe( true ); | ||
|
||
// Tab to focus on the 'Italic' formatting button | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedItalicFormattingButton = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'components-toolbar__control' ) | ||
); | ||
await expect( isFocusedItalicFormattingButton ).toBe( true ); | ||
|
||
// Tab to focus on the 'Hyperlink' formatting button | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedHyperlinkFormattingButton = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'components-toolbar__control' ) | ||
); | ||
await expect( isFocusedHyperlinkFormattingButton ).toBe( true ); | ||
|
||
// Tab to focus on the 'Strikethrough' formatting button | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedStrikethroughFormattingButton = await page.evaluate( () => | ||
document.activeElement.classList.contains( 'components-toolbar__control' ) | ||
); | ||
await expect( isFocusedStrikethroughFormattingButton ).toBe( true ); | ||
|
||
// Tab to focus on the 'More formatting' dropdown toggle | ||
await page.keyboard.press( 'Tab' ); | ||
const isFocusedMoreFormattingDropdown = await page.evaluate( () => | ||
document.activeElement.classList.contains( | ||
'editor-block-settings-menu__toggle' | ||
) | ||
); | ||
await expect( isFocusedMoreFormattingDropdown ).toBe( true ); | ||
}; | ||
|
||
describe( 'Order of block keyboard navigation', () => { | ||
beforeEach( async () => { | ||
await createNewPost(); | ||
} ); | ||
|
||
it( 'permits tabbing through paragraph blocks in the expected order', async () => { | ||
const paragraphBlocks = [ 'Paragraph 0', 'Paragraph 1', 'Paragraph 2' ]; | ||
|
||
// create 3 paragraphs blocks with some content | ||
for ( const paragraphBlock of paragraphBlocks ) { | ||
await insertBlock( 'Paragraph' ); | ||
await page.keyboard.type( paragraphBlock ); | ||
await page.keyboard.press( 'Enter' ); | ||
} | ||
|
||
await navigateToContentEditorTop(); | ||
|
||
for ( const paragraphBlock of paragraphBlocks ) { | ||
await tabThroughParagraphBlock( paragraphBlock ); | ||
} | ||
|
||
// Repeat the same steps to ensure that there is no change introduced in how the focus is handled. | ||
// This prevents the previous regression explained in: https://github.com/WordPress/gutenberg/issues/11773. | ||
await navigateToContentEditorTop(); | ||
|
||
for ( const paragraphBlock of paragraphBlocks ) { | ||
await tabThroughParagraphBlock( paragraphBlock ); | ||
} | ||
} ); | ||
} ); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explain why does it navigates through those blocks twice? It feels like it should be fine to do it only once. Maybe it would be enough to navigate to content editor top and finish there. I don't see any technical reasons why it would work differently after this step.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure can. The regression we're testing for here is illustrated in this image:
And you can find more information about the bug and the patch for it here: #11773
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okey, we need to document it in the code and reference the bug we are guarding against. Something along those lines:
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gziolo would love your thoughts on this approach here. I could find only one other example of a function from
e2e-test-utils
that containedexpect
assertions like the ones I was using intabThroughBlockMoverControl
andtabThroughBlockToolbar
.tjnicolaides#1
Currently thinking about the block-agnostic test you mentioned living in
keyboard-navigable-blocks.test.js
and the paragraph order tests written in this PR living in a different fileThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So let's merge this PR as it's solid enough and do a follow-up with the work started in your fork. I didn't test it at all but I anticipate that we will only need to add some JSDoc tweaks to ensure that those new public methods get properly documented in the auto-generated docs :)