-
Notifications
You must be signed in to change notification settings - Fork 13.3k
fix(react): skip undefined props in attachProps #31345
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
Open
ptmkenny
wants to merge
5
commits into
ionic-team:main
Choose a base branch
from
ptmkenny:react-attach-props-undefined
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+156
−3
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bc47872
attachProps should drop undefined; assistance by opus
ptmkenny 2c2e1a2
Update packages/react/src/components/__tests__/utils.spec.ts
ptmkenny f777647
Update packages/react/src/components/react-component-lib/utils/attach…
ptmkenny 604d64e
handle null and improve tests
ptmkenny 421588b
rewrite for consistency
ptmkenny 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
53 changes: 53 additions & 0 deletions
53
packages/react/src/components/__tests__/createComponent.spec.tsx
This file contains hidden or 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,53 @@ | ||
| /** | ||
| * `createReactComponent` reaches nothing in `@ionic/core`, so the generated | ||
| * wrapper can be driven directly, with no module to mock. These cases only fail | ||
| * at the wrapper level: `render()` omits a nullish prop, so React emits no | ||
| * attribute, and `componentDidUpdate` then writes one back through | ||
| * `attachProps`. | ||
| */ | ||
| import { render } from '@testing-library/react'; | ||
|
|
||
| import { createReactComponent } from '../react-component-lib/createComponent'; | ||
|
|
||
| // Mirror how IonToggle is generated: a plain wrapper with no context or delegate. | ||
| const IonToggle = createReactComponent<any, any>('ion-toggle') as any; | ||
|
|
||
| const getToggle = () => document.querySelector('ion-toggle') as HTMLElement; | ||
|
|
||
| afterEach(() => { | ||
| document.body.innerHTML = ''; | ||
| }); | ||
|
|
||
| describe('createReactComponent: nullish props', () => { | ||
| it('should not render an attribute for a prop passed as undefined', () => { | ||
| render(<IonToggle id={undefined} title={undefined} />); | ||
|
|
||
| expect(getToggle().hasAttribute('id')).toEqual(false); | ||
| expect(getToggle().hasAttribute('title')).toEqual(false); | ||
| }); | ||
|
|
||
| it('should not render an attribute for a prop passed as null', () => { | ||
| render(<IonToggle id={null} title={null} />); | ||
|
|
||
| expect(getToggle().hasAttribute('id')).toEqual(false); | ||
| expect(getToggle().hasAttribute('title')).toEqual(false); | ||
| }); | ||
|
|
||
| it('should remove the attribute when a prop becomes undefined', () => { | ||
| const { rerender } = render(<IonToggle id="my-id" />); | ||
| expect(getToggle().getAttribute('id')).toEqual('my-id'); | ||
|
|
||
| rerender(<IonToggle id={undefined} />); | ||
|
|
||
| expect(getToggle().hasAttribute('id')).toEqual(false); | ||
| }); | ||
|
|
||
| it('should remove the attribute when a prop becomes null', () => { | ||
| const { rerender } = render(<IonToggle id="my-id" />); | ||
| expect(getToggle().getAttribute('id')).toEqual('my-id'); | ||
|
|
||
| rerender(<IonToggle id={null} />); | ||
|
|
||
| expect(getToggle().hasAttribute('id')).toEqual(false); | ||
| }); | ||
| }); |
This file contains hidden or 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 hidden or 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
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.
Could you add a component-level test alongside these? The bug is an interaction between the
render()filter, which omits undefined so React emits no attribute, andcomponentDidUpdate, which then writes it back, and a directattachPropscall can't see that. Onmaina wrapper mounted withid={undefined}still comes out as<ion-toggle id="undefined">, and these two tests wouldn't catch that coming back at the wrapper level.There's precedent in this directory:
createInlineOverlayComponent.spec.tsxalready drives a generated wrapper with@testing-library/react, andcreateComponentpulls nothing from@ionic/coreso there's no mocking needed.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.
I added another test. I'll also submit a version of this for v9 shortly.