Fix: Composer does not refocus when click the same chat #24360

tienifr · 2023-08-10T11:30:59Z

Details

Composer does not refocus when click the same chat. Should not use currentReportID directly in SidebarLinks component to check for the active report as it may affect performance (context: #21022 (comment)). This PR gets rid of withCurrentReportID and lifts the check up to SidebarLinksData.

Fixed Issues

$ #23676
PROPOSAL: #23676 (comment)

Tests

Login with any account
Open any chat
Click again on the same chat in LHN
Verify that on Web & Desktop, composer is automatically focused

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Login with any account
Open any chat
Click again on the same chat in LHN
Verify that on Web & Desktop, composer is automatically focused

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-08-10.at.17.48.44.mov

Mobile Web - Chrome

Screen.Recording.2023-08-10.at.18.25.05.mov

Mobile Web - Safari

Screen.Recording.2023-08-10.at.18.16.49.mov

Desktop

Screen.Recording.2023-08-10.at.18.25.47.mov

iOS

Screen.Recording.2023-08-10.at.18.16.09.mov

Android

Screen.Recording.2023-08-10.at.18.10.27.mov

melvin-bot · 2023-08-10T11:34:36Z

@Santhosh-Sellavel 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]

tienifr · 2023-08-10T11:39:32Z

src/pages/home/sidebar/SidebarLinks.js

-        if (this.props.isCreateMenuOpen || this.props.currentReportID === option.reportID || (this.props.isSmallScreenWidth && Navigation.getTopmostReportId())) {
+        if (
+            this.props.isCreateMenuOpen ||
+            (!this.props.isSmallScreenWidth && this.props.isActiveReport(option.reportID)) ||


On small screen devices, when we navigate from report screen back to LHN, the currentReportID is set to undefined. But as prevCurrentReportID is saved in a ref, we cannot update the ref to undefined which leads to prevCurrentReportID unchanged and thus cannot navigate back to that same report again.

Also, the expected behavior only works on large screen devices so I added this check.

hannojg

There is one important issue with the code, please address

hannojg · 2023-08-11T09:09:39Z

src/pages/home/sidebar/SidebarLinksData.js

+    const prevCurrentReportID = usePrevious(currentReportID);
+    const isActiveReport = useCallback((reportID) => prevCurrentReportID === reportID, [prevCurrentReportID]);


Sorry, I know I proposed using usePrevious, but it's actually not a good idea here as it directly returns the value (ref.current). Plus its incorrect as it indeed returns the previous value.
This way the callback gets recreated for each currentReportID, which is something we want to avoid.

So instead you might want to consider the following code:

Suggested change

const prevCurrentReportID = usePrevious(currentReportID);

const isActiveReport = useCallback((reportID) => prevCurrentReportID === reportID, [prevCurrentReportID]);

const currentReportIDRef = useRef(currentReportID);

currentReportIDRef.current = currentReportID;

const isActiveReport = useCallback((reportID) => currentReportIDRef.current === reportID, []);

Thanks a lot! I agree.

…composer-refocus-when-click-the-same-chat

Santhosh-Sellavel · 2023-08-11T17:35:51Z

src/pages/home/sidebar/SidebarLinksData.js

@@ -15,6 +15,7 @@ import CONST from '../../../CONST';
 import useLocalize from '../../../hooks/useLocalize';
 import styles from '../../../styles/styles';
 import withNavigationFocus from '../../../components/withNavigationFocus';
+import usePrevious from '../../../hooks/usePrevious';


tienifr · 2023-08-14T10:00:15Z

There were some changes in #24204 that re-introduced the currentReportID prop inside SidebarLinks which is not recommended as it severely affects performance. And that goes against the purpose of this PR.

It's recommended that we should handle currentReportID in SidebarLinksData and move it out of SidebarLinks. Context: #21022 (comment); PR: #21406.

That's my fault. I was the author of the PR but not aware of that.

Proposal

We have 2 goals here:

The point of Fix: 23735 Web - App displays single report in LHN for some time on login with that report link #24204 was to show LHN skeleton when only the last accessed report was loaded while the others haven't yet
Move currentRepotID prop out of SidebarLinks

Solution

Remove the conditional render here:

App/src/pages/home/sidebar/SidebarLinks.js

Lines 231 to 243 in a03a21d

    
           {this.props.isLoading ? ( 
        
               <> 
        
                   {lodashGet(this.props.report, 'reportID') && ( 
        
                       <OptionRowLHNData 
        
                           reportID={this.props.currentReportID} 
        
                           viewMode={viewMode} 
        
                           shouldDisableFocusOptions={this.props.isSmallScreenWidth} 
        
                           onSelectRow={this.showReportPage} 
        
                       /> 
        
                   )} 
        
                   <OptionsListSkeletonView shouldAnimate /> 
        
               </> 
        
           ) : (

Instead we always show the LHNOptionsList.
Show skeleton below the list when report data is loading:

this.props.isLoading && <OptionsListSkeletonView shouldAnimate

cc @ArekChr as you were the C+ of #24204; @hannojg.

Santhosh-Sellavel · 2023-08-14T22:23:21Z

@ArekChr Can you do an initial review for the reverted changes of #24204

tienifr · 2023-08-16T08:19:35Z

Bump @ArekChr to take a look.

ArekChr · 2023-08-16T10:03:24Z

@tienifr Where exactly will OptionsListSkeletonView be rendered? Do you mean to cover the LHN component by skeleton view?

tienifr · 2023-08-16T11:42:08Z

@ArekChr @Santhosh-Sellavel #24204 has caused a regression and will be fixed in #24619, so we will continue the discussion in that PR. Its point is to remove the use of currentReportID in SidebarLinks so I think we should hold this one as well.

Santhosh-Sellavel · 2023-08-16T18:08:15Z

@tienifr Please add Hold to the PR title thanks!

tienifr · 2023-08-25T23:11:03Z

Update: PR has moved to #25159.

tienifr · 2023-08-29T19:24:49Z

@Santhosh-Sellavel As #25159 was merged, I think we're ready for review again!

ArekChr · 2023-08-30T09:22:40Z

src/pages/home/sidebar/SidebarLinksData.js

@@ -81,6 +81,10 @@ function SidebarLinksData({isFocused, allReportActions, betas, chatReports, curr
        return reportIDsRef.current || [];
    }, [allReportActions, betas, chatReports, currentReportID, policies, priorityMode, isLoading]);

+    const currentReportIDRef = useRef(currentReportID);
+    currentReportIDRef.current = currentReportID;


Is this value assignment needed? currentReportID is set on the line above as the initial value

Without that assignment, the ref would not be updated when currentReportID changes, I think.

tienifr · 2023-08-31T02:52:13Z

Bump @Santhosh-Sellavel

Santhosh-Sellavel · 2023-09-03T21:07:26Z

src/pages/home/sidebar/SidebarLinksData.js

+    const currentReportIDRef = useRef(currentReportID);
+    currentReportIDRef.current = currentReportID;
+    const isActiveReport = useCallback((reportID) => currentReportIDRef.current === reportID, []);


Can't we simplify the block like this?

const isActiveReport = useCallback((reportID) => currentReportID === reportID, [currentReportID]);

I have mentioned in my proposal:

For the callback, in order not to use currentReportID as a dependency of the callback, which leads to the callback re-render too often, we should save it in a ref instead.

Santhosh-Sellavel · 2023-09-03T21:10:02Z

@tienifr Also I checked the issue no longer exists on Main/Production/Staging.

Screen.Recording.2023-09-04.at.2.39.15.AM.mov

tienifr · 2023-09-04T12:25:54Z

Also I checked the issue no longer exists on Main/Production/Staging.

@Santhosh-Sellavel I think the main purpose of this PR is to completely get rid of withCurrentReportID from SidebarLinks for performance reason. Although #25159 was merged, the author might not notice it and the HOC was still there. That's why it worked.

Santhosh-Sellavel · 2023-09-04T16:54:43Z

@tienifr Then please update the PR description properly. Elaborate how performance was improved

tienifr · 2023-09-04T17:02:08Z

I've updated.

Santhosh-Sellavel · 2023-09-04T17:34:28Z

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 & Desktop

Screen.Recording.2023-09-04.at.2.31.24.AM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-09-04.at.10.56.26.PM.mov

iOS

Screen.Recording.2023-09-04.at.11.02.58.PM.mov

Android

Note: Some Issues with My Android, but that shouldn't be blocking this one, Thanks!

Santhosh-Sellavel

LGTM tests well!

Santhosh-Sellavel · 2023-09-04T17:39:00Z

@MonilBhavsar All yours, please test on Android if possible!

Santhosh-Sellavel · 2023-09-05T16:10:06Z

Bump @MonilBhavsar

MonilBhavsar

Works fine on android

Screen.Recording.2023-09-06.at.12.46.28.PM.mov

OSBotify · 2023-09-06T07:35:48Z

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

mountiny · 2023-09-06T18:35:09Z

Probabaly could have waited after the conferences, @Santhosh-Sellavel @tienifr please be available over next 24 hours for any potential deploy blockers, thanks!

Santhosh-Sellavel · 2023-09-06T18:56:10Z

Sorry My bad, forgot to mention about freeze to @MonilBhavsar

OSBotify · 2023-09-06T18:59:19Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.65-0 🚀

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

OSBotify · 2023-09-08T07:00:40Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.65-7 🚀

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

OSBotify · 2023-09-08T07:31:40Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.66-0 🚀

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

OSBotify · 2023-09-11T09:12:38Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.66-3 🚀

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

tienifr added 3 commits August 10, 2023 18:26

fix: composer does not refocus when click the same chat

2927390

prettier

adb010e

add comment

67e5169

tienifr marked this pull request as ready for review August 10, 2023 11:34

tienifr requested a review from a team as a code owner August 10, 2023 11:34

melvin-bot bot removed the request for review from a team August 10, 2023 11:34

melvin-bot bot requested a review from Santhosh-Sellavel August 10, 2023 11:34

tienifr mentioned this pull request Aug 10, 2023

[HOLD for c+ newdot payment][$1000] Compose box loses focus when reclicking same chat in LHN #23676

Closed

6 tasks

remove console log

fe9034b

tienifr commented Aug 10, 2023

View reviewed changes

hannojg suggested changes Aug 11, 2023

View reviewed changes

tienifr added 2 commits August 11, 2023 23:28

Merge branch 'main' of https://github.com/tienifr/App into fix/23676-…

923d512

…composer-refocus-when-click-the-same-chat

useRef instead of usePrevious

bc0b9df

Santhosh-Sellavel suggested changes Aug 11, 2023

View reviewed changes

tienifr added 3 commits August 12, 2023 00:41

fix lint

ac5f2dc

Merge branch 'main' into fix/23676

cbbc747

move all currentReportID out of SidebarLinks

cf5e3ca

tienifr changed the title ~~Fix: Composer does not refocus when click the same chat~~ [HOLD #24619] Fix: Composer does not refocus when click the same chat Aug 16, 2023

tienifr changed the title ~~[HOLD #24619] Fix: Composer does not refocus when click the same chat~~ [HOLD #25159] Fix: Composer does not refocus when click the same chat Aug 25, 2023

tienifr added 2 commits August 30, 2023 02:21

Merge branch 'main' into fix/23676

e8378ed

fix lint

cb03fc8

tienifr changed the title ~~[HOLD #25159] Fix: Composer does not refocus when click the same chat~~ Fix: Composer does not refocus when click the same chat Aug 29, 2023

tienifr added 2 commits August 30, 2023 02:40

stale commit

4a671f7

fix lint

d841942

ArekChr reviewed Aug 30, 2023

View reviewed changes

Santhosh-Sellavel reviewed Sep 3, 2023

View reviewed changes

Santhosh-Sellavel approved these changes Sep 4, 2023

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar September 4, 2023 17:36

MonilBhavsar approved these changes Sep 6, 2023

View reviewed changes

MonilBhavsar merged commit 1223e1e into Expensify:main Sep 6, 2023
5 of 7 checks passed

OSBotify mentioned this pull request Sep 6, 2023

Deploy Checklist: New Expensify 2023-09-06 #26894

Closed

35 tasks

OSBotify mentioned this pull request Sep 8, 2023

Deploy Checklist: New Expensify 2023-09-08 #27003

Closed

28 tasks

		const prevCurrentReportID = usePrevious(currentReportID);
		const isActiveReport = useCallback((reportID) => prevCurrentReportID === reportID, [prevCurrentReportID]);

Fix: Composer does not refocus when click the same chat #24360

Fix: Composer does not refocus when click the same chat #24360

Conversation

tienifr commented Aug 10, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 10, 2023

Choose a reason for hiding this comment

hannojg left a 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

tienifr commented Aug 14, 2023 • edited Loading

Proposal

Solution

Santhosh-Sellavel commented Aug 14, 2023

tienifr commented Aug 16, 2023

ArekChr commented Aug 16, 2023

tienifr commented Aug 16, 2023 • edited Loading

Santhosh-Sellavel commented Aug 16, 2023

tienifr commented Aug 25, 2023

tienifr commented Aug 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr commented Aug 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Sep 3, 2023

tienifr commented Sep 4, 2023

Santhosh-Sellavel commented Sep 4, 2023

tienifr commented Sep 4, 2023

Santhosh-Sellavel commented Sep 4, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Sep 4, 2023

Santhosh-Sellavel commented Sep 5, 2023

MonilBhavsar left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 6, 2023

mountiny commented Sep 6, 2023

Santhosh-Sellavel commented Sep 6, 2023

OSBotify commented Sep 6, 2023

OSBotify commented Sep 8, 2023

OSBotify commented Sep 8, 2023

OSBotify commented Sep 11, 2023

tienifr commented Aug 10, 2023 •

edited

Loading

tienifr commented Aug 14, 2023 •

edited

Loading

tienifr commented Aug 16, 2023 •

edited

Loading

tienifr commented Aug 31, 2023 •

edited

Loading

Santhosh-Sellavel commented Sep 4, 2023 •

edited

Loading