Fix bug in global modal state management during unmounting #19744

kidroca · 2023-05-29T15:10:12Z

Details

The problem originates from a specific issue regarding the management of modal visibility state within our application. When a thumbnail image in the chat screen, which also renders an AttachmentModal, gets removed, it leads to an unintended chain of events:

Every thumbnail image component on the chat screen also renders an AttachmentModal.
When a thumbnail gets removed, the app mistakenly interprets this as if its corresponding modal has closed, regardless of whether the modal was open or not.
As per our application's design, when a modal closes, the focus automatically shifts to the Compose box.
However, when the attachment carousel is still open, the focus gets restored to the carousel, as opposed to staying in the Compose box. (The concept is called Modal Focus Trap)
In react-native-web, this restoration of focus is achieved by focusing the first available element.
If this element is inside a scroll view, it gets scrolled into view. Consequently, if the user was viewing a different image in the carousel, the view suddenly switches to the first image, creating a confusing and disruptive user experience.

For more in-depth details, please refer to the linked issue and comment

Fixed Issues

$ #18150
PROPOSAL: #18150 (comment)

Tests

Test 1: Bug Fix Verification

Objective: Confirm the previously reported bug is resolved

Note: The following steps provide the most reliable way to reproduce the original bug, though it could also occur under other conditions, such as virtualization removing a comment with an attachment from the virtual window.

Procedure:

Initiate a chat with User A and User B, ensuring that User B has sent multiple attachments.
With User A, open an attachment originating from the middle of the conversation.
With User B, delete the latest uploaded attachment by removing the associated comment.

Expected Outcome:

After User B deletes the latest attachment, there should be no disruption to User A's view of the Carousel. Specifically, User A's view should not automatically switch to a different attachment.

Notes:

The original bug was primarily detected on mobile web using Safari, where it is easiest to reproduce.
A similar but separate bug, where User B deletes a comment that User A used to open the Carousel, is not covered by this test but is addressed separately. Details can be found here:
- [HOLD for payment 2023-07-17] [HOLD for payment 2023-07-12] [$1000] Attachment Carousel closes on its own when a specific image is deleted #18451

Offline tests

N/A

QA Steps

Test 1: Bug Fix Verification

Objective: Confirm the previously reported bug is resolved

Note: The following steps provide the most reliable way to reproduce the original bug, though it could also occur under other conditions, such as virtualization removing a comment with an attachment from the virtual window.

Procedure:

Initiate a chat with User A and User B, ensuring that User B has sent multiple attachments.
With User A, open an attachment originating from the middle of the conversation.
With User B, delete the latest uploaded attachment by removing the associated comment.

Expected Outcome:

After User B deletes the latest attachment, there should be no disruption to User A's view of the Carousel. Specifically, User A's view should not automatically switch to a different attachment.

Notes:

The original bug was primarily detected on mobile web using Safari, where it is easiest to reproduce.
A similar but separate bug, where User B deletes a comment that User A used to open the Carousel, is not covered by this test but is addressed separately. Details can be found here:
- [HOLD for payment 2023-07-17] [HOLD for payment 2023-07-12] [$1000] Attachment Carousel closes on its own when a specific image is deleted #18451

PR Author Checklist

Screenshots/Videos

Web

iOS.Web.mov

Mobile Web - Chrome

Android.Emulator.-.Pixel_4_API_31_5554.2023-05-30.12-22-33.mp4

Mobile Web - Safari

mobile.Safari.Web.mov

Desktop

Desktop.iOS.mov

iOS

iOS.Web.mov

Android

Android.Emulator.-.Pixel_4_API_31_5554.2023-05-30.12-21-11.mp4

melvin-bot · 2023-05-29T15:12:11Z

@hayata-suenaga @eVoloshchak One of you needs to 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]

eVoloshchak · 2023-05-30T13:41:37Z

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 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-05-31.at.14.27.33.mov

Mobile Web - Chrome

Screen.Recording.2023-05-31.at.13.41.34.mov

Mobile Web - Safari

Screen.Recording.2023-05-31.at.13.34.16.mov

Desktop

Screen.Recording.2023-05-31.at.14.30.30.mov

iOS

Screen.Recording.2023-05-31.at.13.36.26.mov

Android

Screen.Recording.2023-05-31.at.13.39.15.mov

eVoloshchak

@kidroca, this tests well and the bug is resolved, but the carousel for User A ends up still containing the attachment after you delete it from User B's account

Screen.Recording.2023-05-30.at.16.47.41.mov

Is this in the scope of this PR?

kidroca · 2023-05-30T18:00:35Z

@kidroca, this tests well and the bug is resolved, but the carousel for User A ends up still containing the attachment after you delete it from User B's account

This is the expected behavior. The attachment will disappear the next time the carousel is opened

[HOLD for payment 2023-07-17] [HOLD for payment 2023-07-12] [$1000] Attachment Carousel closes on its own when a specific image is deleted #18451

Expected result:

... They continue to see that attachment until they close the window

eVoloshchak

Tests well

src/components/Modal/BaseModal.js

Previously, unmounting any modal, even if it was not visible, would trigger a change in the global modal visibility state. This could lead to situations where the global state inaccurately reflected that no modals were visible, even when one was. This commit fixes this issue by changing the unmounting logic: now, the global state is only updated if the modal being unmounted was visible. This ensures an accurate global modal visibility state at all times.

situchan · 2023-05-31T12:17:08Z

src/components/Modal/BaseModal.js

    componentWillUnmount() {
-        // we don't want to call the onModalHide on unmount
-        this.hideModal(this.props.isVisible);
-
+        // Only trigger onClose and setModalVisibility if the modal is unmounting while visible.
        if (this.props.isVisible) {
+            this.hideModal(true);


There's concern about this solution.
cc: @parasharrajat

Concern resolved.

hayata-suenaga

LGTM

OSBotify · 2023-06-06T13:29:32Z

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

OSBotify · 2023-06-06T19:50:12Z

🚀 Cherry-picked to staging by https://github.com/hayata-suenaga in version: 1.3.24-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-07T03:27:22Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

OSBotify · 2023-06-07T13:19:01Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

kidroca marked this pull request as ready for review May 29, 2023 15:12

kidroca requested a review from a team as a code owner May 29, 2023 15:12

melvin-bot bot requested review from eVoloshchak and hayata-suenaga and removed request for a team May 29, 2023 15:12

This comment was marked as outdated.

Sign in to view

kidroca mentioned this pull request May 29, 2023

[HOLD for payment 2023-06-13] [HOLD for payment 2023-06-08] [$1000] Clicking on an attachment opens wrong image #18150

Closed

6 tasks

eVoloshchak reviewed May 30, 2023

View reviewed changes

eVoloshchak previously approved these changes May 31, 2023

View reviewed changes

eVoloshchak reviewed May 31, 2023

View reviewed changes

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

kidroca dismissed eVoloshchak’s stale review via c3bd044 May 31, 2023 12:08

kidroca force-pushed the kidroca/fix/base-modal-oversight branch from c3bd044 to 1e99974 Compare May 31, 2023 12:11

situchan mentioned this pull request May 31, 2023

[$2000] Composer is focused while RHN is open, when user opens RHN before page finishes loading #18182

Closed

6 tasks

situchan reviewed May 31, 2023

View reviewed changes

eVoloshchak approved these changes Jun 6, 2023

View reviewed changes

hayata-suenaga approved these changes Jun 6, 2023

View reviewed changes

hayata-suenaga merged commit 08b1bf6 into Expensify:main Jun 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix bug in global modal state management during unmounting #19744

Fix bug in global modal state management during unmounting #19744

kidroca commented May 29, 2023 •

edited

Loading

melvin-bot bot commented May 29, 2023

This comment was marked as outdated.

eVoloshchak commented May 30, 2023 •

edited

Loading

eVoloshchak left a comment

kidroca commented May 30, 2023

Expected result:

eVoloshchak left a comment

situchan May 31, 2023

parasharrajat Jun 6, 2023

hayata-suenaga left a comment

OSBotify commented Jun 6, 2023

OSBotify commented Jun 6, 2023

OSBotify commented Jun 7, 2023

OSBotify commented Jun 7, 2023

Fix bug in global modal state management during unmounting #19744

Fix bug in global modal state management during unmounting #19744

Conversation

kidroca commented May 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Test 1: Bug Fix Verification

Offline tests

QA Steps

Test 1: Bug Fix Verification

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 29, 2023

This comment was marked as outdated.

eVoloshchak commented May 30, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

kidroca commented May 30, 2023

Expected result:

eVoloshchak left a comment

Choose a reason for hiding this comment

situchan May 31, 2023

Choose a reason for hiding this comment

parasharrajat Jun 6, 2023

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 6, 2023

OSBotify commented Jun 6, 2023

OSBotify commented Jun 7, 2023

OSBotify commented Jun 7, 2023

kidroca commented May 29, 2023 •

edited

Loading

eVoloshchak commented May 30, 2023 •

edited

Loading