-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
rewrite BaseModal to a functional component #25672
Conversation
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.
Left a few comments, besides LGTM.
@ Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
Reviewer Checklist
Screenshots/VideosWebbasemodal_web-compressed.movMobile Web - ChromeMobile Web - SafariDesktopbasemodal_desktop-compressed.moviOSbasemodal_ios-compressed.mp4Androidbasemodal_android-compressed.webm |
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.
Changes LGTM - there is a conflict.
Thanks for the quick work @JKobrynski 🙇 |
@marcaaron conflicts resolved 😄 |
Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks! |
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
useEffect(() => { | ||
Modal.willAlertModalBecomeVisible(isVisible); | ||
|
||
// To handle closing any modal already visible when this modal is mounted, i.e. PopoverReportActionContextMenu | ||
Modal.setCloseModal(isVisible ? onClose : null); | ||
|
||
return () => { | ||
// Only trigger onClose and setModalVisibility if the modal is unmounting while visible. | ||
if (isVisible) { | ||
hideModal(true); | ||
Modal.willAlertModalBecomeVisible(false); | ||
} | ||
|
||
// To prevent closing any modal already unmounted when this modal still remains as visible state | ||
Modal.setCloseModal(null); | ||
}; | ||
}, [hideModal, isVisible, onClose]); |
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.
Seems like we have a regression from this change, when onClose callback changes, it will also hide the modal due to the cleanup logic of this effect. #25998
I suggest to revert this PR. Many bad regressions are being reported in slack. |
I tried to point out the RCA here in case it gets considered and makes sense. |
Adding to @situchan's list, on iOS app while deleting the workspace, the confirmation modal never opens so we can't delete the workspace at all. |
🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.58-0 🚀
|
🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀
|
🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.59-0 🚀
|
🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀
|
// Only trigger onClose and setModalVisibility if the modal is unmounting while visible. | ||
if (isVisible) { | ||
hideModal(true); | ||
Modal.willAlertModalBecomeVisible(false); | ||
} |
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.
This will cause a regression. We should not use the isVisible state here as this will be evaluated at the time of render and not when the component unmounts i.e. if you initially render the modal as visible (true) then on unmount this condition will always be true even if the state value change by then.
What we should do instead is to use a ref
const isVisibleRef = useRef(isVisible);
useEffect(() => {
isVisibleRef.current = isVisible;
}, [isVisible]);
// To handle closing any modal already visible when this modal is mounted, i.e. PopoverReportActionContextMenu | ||
Modal.setCloseModal(isVisible ? onClose : null); |
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.
This caused a regression #27359. Previously on component mount Modal.setCloseModal was only called if the modal was rendered visible.
Details
Fixed Issues
$ #16175
PROPOSAL:
Tests
Offline tests
Same as testing steps above
QA Steps
Same as testing steps above
PR Author Checklist
### Fixed Issues
section aboveTests
sectionOffline steps
sectionQA steps
sectiontoggleReport
and notonIconClick
)myBool && <MyComponent />
.src/languages/*
files and using the translation methodWaiting for Copy
label for a copy review on the original GH to get the correct copy.STYLE.md
) were followedAvatar
, I verified the components usingAvatar
are working as expected)/** comment above it */
this
properly so there are no scoping issues (i.e. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor)this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
)Avatar
is modified, I verified thatAvatar
is working as expected in all cases)ScrollView
component to make it scrollable when more elements are added to the page.main
branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTest
steps.Screenshots/Videos
Web
basemodal_web-compressed.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop
basemodal_desktop-compressed.mov
iOS
basemodal_ios-compressed.mp4
Android
basemodal_android-compressed.webm