[WIP] Replace jsdom with happy-dom testing environment to enable Modal tests (#461)
#545
+874
−1,224
There are no files selected for viewing
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
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
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
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 |
|---|---|---|
|
|
@@ -65,6 +65,7 @@ export const Modal = ({ | |
| autoFocus, | ||
| childrenWrapperRef, | ||
| primaryButtonRef, | ||
| closeButtonRef, | ||
| ); | ||
|
|
||
| useModalScrollPrevention(preventScrollUnderneath); | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -14,10 +14,7 @@ import { ModalContent } from '../ModalContent'; | |
| import { ModalFooter } from '../ModalFooter'; | ||
| import { ModalHeader } from '../ModalHeader'; | ||
|
|
||
| describe('rendering', () => { | ||
| it('renders with "portalId" props', () => { | ||
| document.body.innerHTML = '<div id="portal-id" />'; | ||
| render(( | ||
|
|
@@ -29,7 +26,7 @@ describe.skip('rendering', () => { | |
| </Modal> | ||
| )); | ||
|
|
||
| expect(screen.getByTestId('portal-id').firstChild).toHaveAttribute('id', 'id'); | ||
| document.body.innerHTML = ''; | ||
| }); | ||
|
|
||
|
|
@@ -40,31 +37,27 @@ describe.skip('rendering', () => { | |
| ], | ||
| [ | ||
| { position: 'top' }, | ||
| (rootElement) => expect(rootElement).toHaveClass('isRootPositionTop'), | ||
| ], | ||
| [ | ||
| { size: 'small' }, | ||
|
There was a problem hiding this comment. It could still be |
||
| (rootElement) => expect(rootElement).toHaveClass('isRootSizeSmall'), | ||
| ], | ||
| [ | ||
| { size: 'medium' }, | ||
| (rootElement) => expect(rootElement).toHaveClass('isRootSizeMedium'), | ||
| ], | ||
| [ | ||
| { size: 'large' }, | ||
| (rootElement) => expect(rootElement).toHaveClass('isRootSizeLarge'), | ||
| ], | ||
| [ | ||
| { size: 'fullscreen' }, | ||
| (rootElement) => expect(rootElement).toHaveClass('isRootSizeFullscreen'), | ||
| ], | ||
| [ | ||
| { size: 'auto' }, | ||
| (rootElement) => expect(rootElement).toHaveClass('isRootSizeAuto'), | ||
| ], | ||
| ])('renders with props: "%s"', (testedProps, assert) => { | ||
| const dom = render(( | ||
|
|
@@ -77,11 +70,8 @@ describe.skip('rendering', () => { | |
| }); | ||
| }); | ||
|
|
||
| describe('functionality', () => { | ||
| it('call close modal using `closeButtonRef` (%#)', async () => { | ||
| const spy = jest.fn(); | ||
| const ref = React.createRef(); | ||
| render(( | ||
|
|
@@ -100,14 +90,11 @@ describe.skip('functionality', () => { | |
| </Modal> | ||
| )); | ||
|
|
||
| await userEvent.keyboard('{Escape}'); | ||
| expect(spy).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('do not call close modal using `closeButtonRef` when button is disabled (%#)', async () => { | ||
| const spy = jest.fn(); | ||
| const ref = React.createRef(); | ||
| render(( | ||
|
|
@@ -127,14 +114,11 @@ describe.skip('functionality', () => { | |
| </Modal> | ||
| )); | ||
|
|
||
| await userEvent.keyboard('{Escape}'); | ||
| expect(spy).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('call close modal using `closeButtonRef` and `ModalCloseButton` (%#)', async () => { | ||
| const spy = jest.fn(); | ||
| const ref = React.createRef(); | ||
| render(( | ||
|
|
@@ -151,14 +135,11 @@ describe.skip('functionality', () => { | |
| </Modal> | ||
| )); | ||
|
|
||
| await userEvent.keyboard('{Escape}'); | ||
| expect(spy).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('do not call close modal using `closeButtonRef` and `ModalCloseButton` when button is disabled (%#)', async () => { | ||
| const spy = jest.fn(); | ||
| const ref = React.createRef(); | ||
| render(( | ||
|
|
@@ -176,7 +157,7 @@ describe.skip('functionality', () => { | |
| </Modal> | ||
| )); | ||
|
|
||
| await userEvent.keyboard('{Escape}'); | ||
| expect(spy).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
|
|
||
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 |
|---|---|---|
|
|
@@ -30,7 +30,7 @@ describe('rendering', () => { | |
| level: 1, | ||
| }, | ||
| (rootElement) => { | ||
| expect(rootElement.tagName).toEqual('H1'); | ||
| }, | ||
| ], | ||
| ])('renders with props: "%s"', (testedProps, assert) => { | ||
|
|
||
|
There was a problem hiding this comment. 
Could you check this please? |
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 |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ | |
| autoFocus, | ||
| childrenWrapperRef, | ||
| primaryButtonRef, | ||
| closeButtonRef, | ||
| ) => { | ||
| useEffect( | ||
| () => { | ||
|
|
@@ -52,6 +53,13 @@ | |
| }; | ||
|
|
||
| const keyPressHandler = (e) => { | ||
| // While <dialog> component uses built-in browser dialog functionality for closing the dialog, we preserve this | ||
| // functionality due to lack of support for <dialog> in jsdom and happy-dom testing environments. | ||
|
Comment on lines
+56
to
+57
There was a problem hiding this comment. Do we have any jsdom/happy-dom issues to link to so we can remove this in future? |
||
| if (e.key === 'Escape' && closeButtonRef?.current != null) { | ||
| closeButtonRef.current.click(); | ||
| return; | ||
| } | ||
|
|
||
| if ( | ||
| e.key === 'Enter' | ||
| && e.target.nodeName !== 'BUTTON' | ||
|
|
@@ -110,7 +118,7 @@ | |
|
|
||
| return () => window.document.removeEventListener('keydown', keyPressHandler, false); | ||
| }, | ||
| [ | ||
| autoFocus, | ||
| childrenWrapperRef, | ||
| primaryButtonRef, | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -78,8 +78,8 @@ describe('rendering', () => { | |
| [ | ||
| { options: mandatoryProps.options }, | ||
| (rootElement) => { | ||
| expect(within(rootElement).getByLabelText('option 1')).not.toBeChecked(); | ||
| expect(within(rootElement).getByLabelText('option 2')).not.toBeChecked(); | ||
| expect(within(rootElement).getByLabelText('option 2')).toBeDisabled(); | ||
| }, | ||
| ], | ||
|
|
@@ -91,14 +91,14 @@ describe('rendering', () => { | |
| onChange: () => {}, | ||
| value: 'option2', | ||
| }, | ||
| (rootElement) => expect(within(rootElement).getByLabelText('option 2')).toBeChecked(), | ||
| ], | ||
| [ | ||
| { | ||
| onChange: () => {}, | ||
| value: 1, | ||
| }, | ||
| (rootElement) => expect(within(rootElement).getByLabelText('option 1')).toBeChecked(), | ||
| ], | ||
| ])('renders with props: "%s"', (testedProps, assert) => { | ||
| const dom = render(( | ||
|
|
||
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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| export const tagPropTest = [ | ||
| [ | ||
| { tag: 'section' }, | ||
| (rootElement) => expect(rootElement.tagName).toEqual('SECTION'), | ||
| ], | ||
| ]; |
Oops, something went wrong.
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.
+1 for not forgetting to remove this 🙂.