fix: Room - Side panel does not close when clicking outside of panel. #38015

Krishna2323 · 2024-03-09T07:30:56Z

Details

Fixed Issues

$ #34394
PROPOSAL: #34394 (comment)

Tests

Click on FAB > Start chat > Room > Workspace
Click outside of the side panel
Verify sidebar is closed
Click on FAB > Start chat > Room > Who can post
Click outside of the side panel
Verify sidebar is closed
Click on FAB > Start chat > Room > Visibility
Click outside of the side panel
Verify sidebar is closed

Verify that no errors appear in the JS console

Offline tests

Click on FAB > Start chat > Room > Workspace
Click outside of the side panel
Verify sidebar is closed
Click on FAB > Start chat > Room > Who can post
Click outside of the side panel
Verify sidebar is closed
Click on FAB > Start chat > Room > Visibility
Click outside of the side panel
Verify sidebar is closed

QA Steps

Click on FAB > Start chat > Room > Workspace
Click outside of the side panel
Verify sidebar is closed
Click on FAB > Start chat > Room > Who can post
Click outside of the side panel
Verify sidebar is closed
Click on FAB > Start chat > Room > Visibility
Click outside of the side panel
Verify sidebar is closed

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_native.mp4

Android: mWeb Chrome

android_chrome.mp4

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

web_chrome.mp4

MacOS: Desktop

desktop_app.mp4

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

melvin-bot · 2024-03-09T07:31:00Z

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

hoangzinh · 2024-03-10T14:01:54Z

src/components/Modal/BaseModal.tsx

@@ -117,6 +118,9 @@ function BaseModal(
            return;
        }

+        if (onBackdropPress) {
+            onBackdropPress();
+        }
        onClose();


@Krishna2323 should it be?

if (onBackdropPress) { onBackdropPress(); } else { onClose(); }

Nope, onClose must be called but onBackdropPress is optional.

then it would be weird @Krishna2323. Let's say

<Modal onClose={do_on_close} onBackdropPress={do_on_bd_press) />

If you haven't read the implementation details of this Modal component, we might thought when backdrop press, it's only do_on_bd_press. We aren't aware it would call onClose as well.

I think we should give decisions to users, where they can decide if they want to call do_on_close when bd press as well

<Modal onClose={do_on_close} onBackdropPress={do_on_bd_press && do_on_close) />

or

<Modal onClose={do_on_close} onBackdropPress={do_on_close && do_on_bd_press) />

Yeah, it looks confusing, let me check again.

cc @Krishna2323 just in case you missed my comment

@hoangzinh, apologies for the delay. I believe we can proceed as you suggested without causing any regressions at this time. However, my main concern is regarding the difference between onClose and onBackdropPress callbacks.

In Scenario 1: If we update states when the onClose callback is triggered and we have specific actions for when the user clicks on the backdrop, solely calling onBackdropPress might not achieve the intended functionality.

In Scenario 2: If we update states when either onClose or onBackdropPress is called, it might be better to only utilize one of these to avoid potential regressions due to redundant function calls.

At the moment, I'm inclined towards only calling one of these callbacks as you suggested, but I'd like to confirm our decision once more. Please let me know your thoughts on how we should proceed.

I think:

In scenario 1: we can call onClose inside onBackdropPress

Let's simplify it, just go with only calling one of these callbacks, then we can update later on our way.

@hoangzinh, updated.

@hoangzinh friendly bump

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

hoangzinh · 2024-03-18T11:34:13Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

Screen.Recording.2024-03-18.at.18.35.28.android.mov

Android: mWeb Chrome

Screen.Recording.2024-03-18.at.18.30.47.android.chrome.mov

iOS: Native

Screen.Recording.2024-03-18.at.18.33.05.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-03-18.at.18.32.02.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-18.at.18.26.13.web.mov

MacOS: Desktop

Screen.Recording.2024-03-18.at.18.27.45.desktop.mov

hoangzinh

LGTM

danieldoglas · 2024-03-18T16:56:42Z

@Krishna2323 please fix the conflict so we can review and merge

Krishna2323 · 2024-03-18T18:38:55Z

@danieldoglas, conflict resolved.

OSBotify · 2024-03-19T22:07:02Z

✋ 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 · 2024-03-19T23:50:43Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.55-0 🚀

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

OSBotify · 2024-03-20T00:51:18Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.55-0 🚀

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

CortneyOfstad · 2024-03-20T14:58:19Z

@Krishna2323 @danieldoglas @hoangzinh — appears to be a bug in the fix per this GH 👍

OSBotify · 2024-03-22T16:10:04Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.55-3 🚀

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

fix: Room - Side panel does not close when clicking outside of panel.

904316b

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

Krishna2323 requested a review from a team as a code owner March 9, 2024 07:30

melvin-bot bot removed the request for review from a team March 9, 2024 07:30

melvin-bot bot requested a review from hoangzinh March 9, 2024 07:31

hoangzinh reviewed Mar 10, 2024

View reviewed changes

Krishna2323 added 2 commits March 15, 2024 21:02

Merge branch 'Expensify:main' into krishna2323/re/issue/34394

f080b78

add suggested changes.

cc63c22

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

hoangzinh approved these changes Mar 18, 2024

View reviewed changes

melvin-bot bot requested a review from danieldoglas March 18, 2024 11:39

Merge branch 'main' into krishna2323/re/issue/34394

a5af583

danieldoglas approved these changes Mar 19, 2024

View reviewed changes

danieldoglas merged commit 7d8cede into Expensify:main Mar 19, 2024
15 checks passed

github-actions bot mentioned this pull request Mar 19, 2024

Deploy Checklist: New Expensify 2024-03-19 #38651

Closed

66 tasks

allgandalf mentioned this pull request Mar 20, 2024

[$500] Room - Selection list RHP does not show sliding animation while being dismissed #38665

Closed

6 tasks

melvin-bot bot mentioned this pull request Mar 22, 2024

[Payment due][$1000] Room - Side panel does not close when clicking outside of panel #34394

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Room - Side panel does not close when clicking outside of panel. #38015

fix: Room - Side panel does not close when clicking outside of panel. #38015

Krishna2323 commented Mar 9, 2024 •

edited

Loading

melvin-bot bot commented Mar 9, 2024

hoangzinh Mar 10, 2024 •

edited

Loading

Krishna2323 Mar 11, 2024

hoangzinh Mar 11, 2024

hoangzinh Mar 11, 2024

Krishna2323 Mar 11, 2024

hoangzinh Mar 13, 2024

Krishna2323 Mar 13, 2024

hoangzinh Mar 14, 2024

Krishna2323 Mar 15, 2024

Krishna2323 Mar 18, 2024

hoangzinh commented Mar 18, 2024 •

edited

Loading

hoangzinh left a comment

danieldoglas commented Mar 18, 2024

Krishna2323 commented Mar 18, 2024

OSBotify commented Mar 19, 2024

OSBotify commented Mar 19, 2024

OSBotify commented Mar 20, 2024

CortneyOfstad commented Mar 20, 2024

OSBotify commented Mar 22, 2024

fix: Room - Side panel does not close when clicking outside of panel. #38015

fix: Room - Side panel does not close when clicking outside of panel. #38015

Conversation

Krishna2323 commented Mar 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 9, 2024

hoangzinh Mar 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoangzinh commented Mar 18, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh left a comment

Choose a reason for hiding this comment

danieldoglas commented Mar 18, 2024

Krishna2323 commented Mar 18, 2024

OSBotify commented Mar 19, 2024

OSBotify commented Mar 19, 2024

OSBotify commented Mar 20, 2024

CortneyOfstad commented Mar 20, 2024

OSBotify commented Mar 22, 2024

Krishna2323 commented Mar 9, 2024 •

edited

Loading

hoangzinh Mar 10, 2024 •

edited

Loading

hoangzinh commented Mar 18, 2024 •

edited

Loading