Fix BaseModal by hayata-suenaga · Pull Request #26045 · Expensify/App

hayata-suenaga · 2023-08-27T21:38:09Z

Details

Fixed Issues

$ #25998
PROPOSAL: #25998 (comment)

PR that causes this regression: #25672 (comment)

Tests

Open any component that has in its' implementation BaseModals
Make sure it works

QA Steps

Test 1

Open the app on the web
Open App ->Settings -> Workspace -> bank Account -> Connect manually
Enter test routing number and account number and proceed to step 2.
Click State -> type state name
Make sure that the right hand side panel doesn't close while you're tying

Test 2

Open the app on iOS
Go to settings > Workspace. Select any workspace.
Click on three dots icon in top right.
Click on delete workspace.
Confirm that the confirmation modal opens up asking the user to confirm if they want to delete the workspace.

Test 3

Open the app on iOS
Click on FAB
Click on Request Money
Check the request money page shows up

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-27T21:38:13Z

@thesahindia 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]

allroundexperts · 2023-08-27T21:46:29Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-08-28.at.3.53.52.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-08-28.at.4.08.44.AM.mov

Mobile Web - Safari

Screen.Recording.2023-08-28.at.4.03.44.AM.mov

Desktop

Screen.Recording.2023-08-28.at.3.57.54.AM.mov

iOS

Screen.Recording.2023-08-28.at.4.02.12.AM.mov

Android

Screen.Recording.2023-08-28.at.4.11.48.AM.mov

allroundexperts · 2023-08-27T21:55:40Z

@hayata-suenaga This still needs to be fixed.

Screen.Recording.2023-08-28.at.2.55.08.AM.mov

hayata-suenaga · 2023-08-27T21:56:30Z

Yea I'm still seeing the issue

Screen.Recording.2023-08-27.at.2.54.51.PM.mov

hayata-suenaga · 2023-08-27T21:58:00Z

@allroundexperts do you have an idea what might be an issue?

Pujan92 · 2023-08-27T22:04:48Z

If you are referencing my proposal then I have proposed below 2 changes

Need to add dependency onModalHide for the function hideModal

App/src/components/Modal/BaseModal.js

Line 75 in c029dc5

[shouldSetModalVisibility],
Create new useEffect without any dependency for unmounting logic and remove the cleanup from the existing useEffect.

useEffect(() => {
        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);
        };
    }, []);

allroundexperts · 2023-08-27T22:04:52Z

@hayata-suenaga Have you tried using this?

hayata-suenaga · 2023-08-27T22:17:24Z

I made suggestions made by @Pujan92

Although for new chat and new room, the transition is very slow, for other items, the issue seems to be fixed

Screen.Recording.2023-08-27.at.3.15.28.PM.mov

hayata-suenaga · 2023-08-27T22:19:29Z

@Pujan92

I see this comment

I assume this won't be a much issue?

hayata-suenaga · 2023-08-27T22:20:54Z

By the way, I have no idea how the modal system works in NewDot...

hayata-suenaga · 2023-08-27T22:21:21Z

I like clicking wrong buttons 😭

Pujan92 · 2023-08-27T22:22:19Z

I see this comment

Oh, I just read but as per the current situation I think we do need to add onModalHide bcoz we are not using prop shouldSetModalVisibility for all modals.

Pujan92 · 2023-08-27T22:26:34Z

Although for new chat and new room, the transition is very slow, for other items, the issue seems to be fixed

Somehow I am not seeing slow transition compare to your video

Simulator.Screen.Recording.-.iPhone.11.-.2023-08-28.at.03.55.18.mp4

allroundexperts · 2023-08-27T22:30:02Z

The transition seems fine for me as well.

Screen.Recording.2023-08-28.at.3.29.21.AM.mov

hayata-suenaga · 2023-08-27T22:59:19Z

@allroundexperts by the way, if you try the bank account flow (from the original issue), are you experiencing these flickering (hope this is not from my PR...)

Screen.Recording.2023-08-27.at.3.53.10.PM.mov

allroundexperts · 2023-08-27T23:01:25Z

@allroundexperts by the way, if you try the bank account flow (from the original issue), are you experiencing these flickering (hope this is not from my PR...)

Screen.Recording.2023-08-27.at.3.53.10.PM.mov

Here's what I see @hayata-suenaga

Screen.Recording.2023-08-28.at.4.00.39.AM.mov

hayata-suenaga · 2023-08-27T23:04:24Z

@allroundexperts by the way, if you try the bank account flow (from the original issue), are you experiencing these flickering (hope this is not from my PR...)

okay nice this is probably something to do with my development setup then 😞 anyway, I gonna rely on you for the screenshots/recordings 🙇

allroundexperts · 2023-08-27T23:07:44Z

@Pujan92 Just for a double confirmation, can you please also post the screen recordings for all the platforms?

For record, this PR is meant to solve:
Dev - Unable to select a state
[mWeb] - Delete workspace - Confirmation modal doesn't open the first time
Money Request not opening for first time from FAB
Composer add menu not working properly

Pujan92 · 2023-08-27T23:09:02Z

Sure @allroundexperts

hayata-suenaga · 2023-08-27T23:15:34Z

will be back in 45min 🙇

src/components/Modal/BaseModal.js

allroundexperts

Waiting for @Pujan92 to upload the screenshots and a minor NAB comment. Looks good otherwise 🚀 🚀 🚀

melvin-bot · 2023-08-27T23:18:34Z

@Julesssss 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]

Pujan92 · 2023-08-27T23:25:52Z

Screenshots/Videos

Web

Screen.Recording.2023-08-28.at.04.40.29.mp4

Mobile Web - Safari

Simulator.Screen.Recording.-.iPhone.11.-.2023-08-28.at.04.50.56.mp4

Mobile Web - Chrome

androp.mp4

androiddel.webm

Desktop

Screen.Recording.2023-08-28.at.04.53.38.mp4

iOS

Simulator.Screen.Recording.-.iPhone.11.-.2023-08-28.at.04.44.08.mp4

Simulator.Screen.Recording.-.iPhone.11.-.2023-08-28.at.04.45.57.mp4

Android

andra.mp4

Done and seems fine.

hayata-suenaga · 2023-08-28T00:11:57Z

@Pujan92 thank you so much for your help and testing

I requested an internal review (which is needed for PR merge) thank you for quick review @allroundexperts

OSBotify · 2023-08-28T01:10:10Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

hayata-suenaga · 2023-08-28T02:18:43Z

Updated the QA test steps to account for all reported cases.

OSBotify · 2023-08-28T18:48:17Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.58-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-08-30T01:17:20Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-08-30T01:55:39Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.59-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-08-31T01:55:57Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

dukenv0307 · 2025-04-01T17:43:57Z

src/components/Modal/BaseModal.js

-    }, [hideModal, isVisible, onClose]);
+        },
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+        [],


Ref: #58885, we should use hideModalRef instead of hideModal

fix issues with popover

9a789a8

hayata-suenaga requested a review from a team as a code owner August 27, 2023 21:38

melvin-bot bot removed the request for review from a team August 27, 2023 21:38

melvin-bot bot requested a review from thesahindia August 27, 2023 21:38

hayata-suenaga requested review from parasharrajat and removed request for thesahindia August 27, 2023 21:38

hayata-suenaga changed the title ~~fix issues with popover~~ Bix BaseModal Aug 27, 2023

hayata-suenaga changed the title ~~Bix BaseModal~~ Fix BaseModal Aug 27, 2023

hayata-suenaga requested review from allroundexperts and removed request for parasharrajat August 27, 2023 21:43

hayata-suenaga closed this Aug 27, 2023

hayata-suenaga deleted the hayata-fix-base-modal branch August 27, 2023 22:20

hayata-suenaga restored the hayata-fix-base-modal branch August 27, 2023 22:20

hayata-suenaga deleted the hayata-fix-base-modal branch August 27, 2023 22:21

hayata-suenaga restored the hayata-fix-base-modal branch August 27, 2023 22:21

hayata-suenaga reopened this Aug 27, 2023

hayata-suenaga requested a review from Pujan92 August 27, 2023 23:04

allroundexperts reviewed Aug 27, 2023

View reviewed changes

src/components/Modal/BaseModal.js Outdated Show resolved Hide resolved

allroundexperts approved these changes Aug 27, 2023

View reviewed changes

melvin-bot bot removed the request for review from Pujan92 August 27, 2023 23:18

melvin-bot bot requested a review from Julesssss August 27, 2023 23:18

fix: remove comment

3744439

robertjchen approved these changes Aug 28, 2023

View reviewed changes

hayata-suenaga merged commit d09a1b6 into main Aug 28, 2023

hayata-suenaga deleted the hayata-fix-base-modal branch August 28, 2023 01:04

luacmartins mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-24 #25813

Closed

73 tasks

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

luacmartins mentioned this pull request Aug 29, 2023

[HOLD for payment 2023-10-02] [HOLD for payment 2023-09-29] [$500] [mWeb] - Chat - Context menu doesn't close after user goes to the previous page #26178

Closed

6 tasks

OSBotify mentioned this pull request Aug 30, 2023

Deploy Checklist: New Expensify 2023-08-30 #26268

Closed

melvin-bot bot mentioned this pull request Aug 30, 2023

[$500] [HOLD for payment 2023-09-06] Dev - Unable to select a state #25998

Closed

6 tasks

dukenv0307 reviewed Apr 1, 2025

View reviewed changes

Conversation

hayata-suenaga commented Aug 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

QA Steps

Test 1

Test 2

Test 3

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Aug 27, 2023

Uh oh!

allroundexperts commented Aug 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allroundexperts commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

Pujan92 commented Aug 27, 2023

Uh oh!

allroundexperts commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

Pujan92 commented Aug 27, 2023

Uh oh!

Pujan92 commented Aug 27, 2023

Uh oh!

allroundexperts commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

allroundexperts commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

allroundexperts commented Aug 27, 2023

Uh oh!

Pujan92 commented Aug 27, 2023

Uh oh!

hayata-suenaga commented Aug 27, 2023

Uh oh!

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Aug 27, 2023

Uh oh!

Pujan92 commented Aug 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Screenshots/Videos

Uh oh!

hayata-suenaga commented Aug 28, 2023

Uh oh!

OSBotify commented Aug 28, 2023

Uh oh!

hayata-suenaga commented Aug 28, 2023

Uh oh!

OSBotify commented Aug 28, 2023

Uh oh!

OSBotify commented Aug 30, 2023

Uh oh!

OSBotify commented Aug 30, 2023

Uh oh!

OSBotify commented Aug 31, 2023

hayata-suenaga commented Aug 27, 2023 •

edited

Loading

allroundexperts commented Aug 27, 2023 •

edited

Loading

hayata-suenaga commented Aug 27, 2023 •

edited

Loading

Pujan92 commented Aug 27, 2023 •

edited

Loading