Fix: RHN lag when close #45691

truph01 · 2024-07-18T16:02:50Z

Details

Fixed Issues

$ #43410
PROPOSAL: #43410 (comment)

Tests

Open New Expensify App
Sign into a valid account (HT account is better for reproduction)
Create a Task and then click on the IOU
Change the Assignee and notice the page closing.
User expects the page to close "clean" without delay/lag

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 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 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.

Screenshots/Videos

Android: Native

Screen.Recording.2024-07-18.at.23.30.49.mov

Android: mWeb Chrome

Screen.Recording.2024-07-18.at.23.28.23.mov

iOS: Native

Screen.Recording.2024-07-18.at.23.38.40.mov

iOS: mWeb Safari

Screen.Recording.2024-07-18.at.23.26.51.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-18.at.23.25.12.mov

MacOS: Desktop

Screen.Recording.2024-07-18.at.23.26.07.mov

melvin-bot · 2024-07-18T16:02:55Z

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

allgandalf · 2024-07-18T16:07:46Z

@truph01 can you please update videos on all platforms , our guidelines do state that, and also the video for desktop as well as safari are the same can you check once and upload platform specific please 🙏

I ran the tests on all platforms & verified they passed on:

truph01 · 2024-07-18T16:10:09Z

Sure. I am updating it. Just ping you once done

truph01 · 2024-07-18T16:56:52Z

@allgandalf I updated all the videos

allgandalf · 2024-07-22T14:55:42Z

waiting for comments to be addressed

allgandalf · 2024-07-31T05:41:01Z

Confirmed the issue is reproducible, reviewing now

allgandalf · 2024-07-31T05:41:07Z

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-08-19.at.11.55.13.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-08-19.at.11.53.20.AM.mov

iOS: Native

Screen.Recording.2024-08-19.at.12.02.55.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-08-19.at.11.40.59.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-19.at.11.34.21.AM.mov

MacOS: Desktop

Screen.Recording.2024-08-19.at.11.37.15.AM.mov

allgandalf · 2024-07-31T05:47:50Z

@truph01 , there is noticeble lag on desktop, can you please take a look:

Screen.Recording.2024-07-31.at.11.16.24.AM.mov

truph01 · 2024-07-31T09:35:25Z

there is noticeble lag on desktop, can you please take a look:

@allgandalf I think you are referring to the "delay" when closing modal, right? If so, It is because of this code:

App/src/pages/tasks/TaskAssigneeSelectorModal.tsx

Line 223 in 8d11d0b

shouldDebounceRowSelect

truph01 · 2024-08-02T07:49:28Z

@allgandalf Bump to review my comment above

allgandalf · 2024-08-04T06:43:18Z

I think you are referring to the "delay" when closing modal, right? If so, It is because of this code:

That shouldn't be the case right? the actual issue says that things should be smooth and no dealy/lag

truph01 · 2024-08-04T09:37:01Z

@allgandalf In my opinion, the shouldDebounceRowSelect causes the RHN to close with a delay, which is expected. The real issue here is that the transition animation is broken, as shown in the OP's video and my RCA analytics.

truph01 · 2024-08-05T08:51:18Z

@allgandalf I can reproduce the janky animation in desktop with the High Traffic Account. My solution to fix it is updating:

App/src/pages/tasks/TaskAssigneeSelectorModal.tsx

Lines 170 to 182 in 8d11d0b

    
           if (option.accountID !== report.managerID) { 
        
               const assigneeChatReport = TaskActions.setAssigneeValue( 
        
                   option?.login ?? '', 
        
                   option?.accountID ?? -1, 
        
                   report.reportID, 
        
                   null, // passing null as report because for editing task the report will be task details report page not the actual report where task was created 
        
                   OptionsListUtils.isCurrentUser({...option, accountID: option?.accountID ?? -1, login: option?.login ?? ''}), 
        
               ); 
        
               // Pass through the selected assignee 
        
               TaskActions.editTaskAssignee(report, session?.accountID ?? 0, option?.login ?? '', option?.accountID, assigneeChatReport); 
        
           } 
        
           Navigation.dismissModal(report.reportID);

to:

+              Navigation.dismissModal(report.reportID);
+              InteractionManager.runAfterInteractions(() => {
                    if (option.accountID === report.managerID) {
                        return;
                    }
                    const assigneeChatReport = TaskActions.setAssigneeValue(
                        option?.login ?? '',
                        option?.accountID ?? -1,
                        report.reportID,
                        undefined, // passing null as report because for editing task the report will be task details report page not the actual report where task was created
                        OptionsListUtils.isCurrentUser({...option, accountID: option?.accountID ?? -1, login: option?.login ?? ''}),
                    );

                    // Pass through the selected assignee
                    TaskActions.editTaskAssignee(report, session?.accountID ?? -1, option?.login ?? '', option?.accountID, assigneeChatReport);
+              });
-              Navigation.dismissModal(report.reportID);

I tested and it works well. What do you think?

allgandalf · 2024-08-07T08:58:09Z

@MonilBhavsar , what do you think? should we fix this, or is that expected?

truph01 · 2024-08-07T09:03:44Z

what do you think? should we fix #45691 (comment), or is that expected?

When choosing any option, the modal is closed with a delay time (200ms), it is our expected.

When the modal is closing, there is a janky/lag in transition animation, it is the main bug we need to fix in this PR.

MonilBhavsar · 2024-08-07T14:21:31Z

should we fix #45691 (comment), or is that expected?

Yes, i think we should fix it

truph01 · 2024-08-09T01:28:11Z

@allgandalf Any updates on it? Can you check my suggested solution ? Thanks

allgandalf · 2024-08-12T11:10:18Z

You can apply that @truph01 , lets see how that works

truph01 · 2024-08-13T08:05:35Z

@allgandalf I updated PR. Please help review it again

truph01 · 2024-08-14T12:36:39Z

@allgandalf Do you have any updates on this PR?

allgandalf · 2024-08-15T05:07:32Z

@truph01 , here is a regression coming here:

our PR:

Screen.Recording.2024-08-15.at.10.35.58.AM.mov

Staging:

Screen.Recording.2024-08-15.at.10.36.14.AM.mov

There is a delay of 1 second, the assignee doesn't change instantly, @MonilBhavsar we do count that as a regression right? @truph01 do you think you can fix that?

allgandalf · 2024-08-15T05:09:01Z

This fruit has been hanging for too long now, lets work together and get this PR to staging 🚀

truph01 · 2024-08-15T05:24:26Z

There is a delay of 1 second, the assignee doesn't change instantly
do you think you can fix that?

That delay is expected with the current changes in the PR.

In staging, we update Onyx first and then trigger the navigation action to close the RHN:

Advantage: The assignee displayed is up-to-date after the RHN is closed.
Disadvantage: There’s a noticeable lag when closing the modal, which is the main bug we're trying to fix.

In this PR, we close the RHN first and then update Onyx:

Advantage: The modal closes without any lag.
Disadvantage: The assignee may be outdated for a brief moment after the RHN is closed.

At the moment, I don't have a solution that combines the advantages of both approaches in staging and in this PR.
But let's wait for confirmation from @MonilBhavsar on whether we should consider the 'disadvantage' in the PR as a regression or not.

truph01 · 2024-08-16T03:36:36Z

@MonilBhavsar Please help check C+ comment and my comment when you have a chance. Thanks

MonilBhavsar · 2024-08-16T05:53:33Z

Yes, it does seem like a regression.

Back to the issue, the root cause was both processes happening at the same time and there was a lag. So can we change the order here - Onyx update first and navigation then

truph01 · 2024-08-16T07:51:32Z

@allgandalf I updated PR to make sure the onyx data is merged successfully before navigating. It is my alternative solution in proposal. Please help review PR again.

MonilBhavsar · 2024-08-16T09:15:19Z

@truph01 thanks!

allgandalf · 2024-08-16T11:05:56Z

src/pages/tasks/TaskAssigneeSelectorModal.tsx

                // If there's no report, we're creating a new task
            } else if (option.accountID) {
                TaskActions.setAssigneeValue(
                    option?.login ?? '',
-                    option.accountID,
+                    option.accountID ?? -1,


is account id a string or number ? if it is a number then we fallback to 0 for numbers, can you help me confirm @truph01 ?

@allgandalf the accountID is number. If it is number, I think we should fallback to -1 as we did in other logics.

is it, the other day i was reviewing a PR and they fallback to 0:
#46931 (comment)

I just refer to our contributor style docs:
https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#default-value-for-inexistent-ids

Yeah that is because in the example reportID is a string:

App/src/types/onyx/Report.ts

Lines 140 to 141 in 9940e99

/** ID of the report */

reportID: string;

and as you said:

@allgandalf the accountID is number.

Confirming on slack about the same

I think that the fallback -1 should be applied regardless the id is number or string since I just checked this PR, we are using -1 as number, for example https://github.com/Expensify/App/pull/42634/files#diff-ea38863732cfd28f820d12c5b3f2633a8799cb797929c39af675b6a11452e9ee

Confirmed on slack that 0 is a valid account id

If -1 is a valid account id, then we should fall back to 0, right?

sorry, it is the other way around

allgandalf

Lets get this shipped 🚀

OSBotify · 2024-08-19T16:13:59Z

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

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

OSBotify · 2024-08-19T17:10:40Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.22-1 🚀

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

OSBotify · 2024-08-20T22:43:39Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.22-9 🚀

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

Fix: RHN lag when close

511d05e

truph01 requested a review from a team as a code owner July 18, 2024 16:02

melvin-bot bot requested review from allgandalf and removed request for a team July 18, 2024 16:02

truph01 mentioned this pull request Jul 18, 2024

[$250] Assign Task - When changing Assignee, the page lags when closing modal #43410

Closed

6 tasks

truph01 added 3 commits July 18, 2024 23:22

Fix: Lint

03e3a42

Fix: Lint

96fc079

Fix: Remove unused change

a877075

merge main

38c12a9

truph01 added 3 commits August 13, 2024 14:30

merge main

7021034

use InteractionManager.runAfterInteractions

d40054c

remove redundant changes

db0279b

truph01 added 3 commits August 13, 2024 14:43

import issue

9e04862

fix import issue

d2973c2

fix type error

217bc06

truph01 added 3 commits August 16, 2024 14:26

merge main

6a3c5f7

navigate after onyx merge

6021ca4

fix lint

81276ac

allgandalf reviewed Aug 16, 2024

View reviewed changes

allgandalf approved these changes Aug 19, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar August 19, 2024 06:34

MonilBhavsar approved these changes Aug 19, 2024

View reviewed changes

MonilBhavsar merged commit 6992802 into Expensify:main Aug 19, 2024
16 of 26 checks passed

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

Deploy Checklist: New Expensify 2024-08-19 #47639

Closed

77 tasks

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

Investigate workflow job failing on main: e2ePerformanceTests / Run E2E tests in AWS device farm #47647

Closed

CyberAndrii mentioned this pull request Sep 3, 2024

Fix "Add custom segment or record" image appears briefly after adding first segment #48297

Merged

48 tasks

Fix: RHN lag when close #45691

Fix: RHN lag when close #45691

Conversation

truph01 commented Jul 18, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 18, 2024

allgandalf commented Jul 18, 2024

truph01 commented Jul 18, 2024

truph01 commented Jul 18, 2024

allgandalf commented Jul 22, 2024

allgandalf commented Jul 31, 2024

allgandalf commented Jul 31, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf commented Jul 31, 2024

truph01 commented Jul 31, 2024

truph01 commented Aug 2, 2024

allgandalf commented Aug 4, 2024

truph01 commented Aug 4, 2024

truph01 commented Aug 5, 2024

allgandalf commented Aug 7, 2024

truph01 commented Aug 7, 2024

MonilBhavsar commented Aug 7, 2024

truph01 commented Aug 9, 2024

allgandalf commented Aug 12, 2024

truph01 commented Aug 13, 2024

truph01 commented Aug 14, 2024

allgandalf commented Aug 15, 2024

allgandalf commented Aug 15, 2024

truph01 commented Aug 15, 2024

truph01 commented Aug 16, 2024

MonilBhavsar commented Aug 16, 2024

truph01 commented Aug 16, 2024

MonilBhavsar commented Aug 16, 2024

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

allgandalf Aug 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allgandalf left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 19, 2024

OSBotify commented Aug 19, 2024

OSBotify commented Aug 20, 2024

truph01 commented Jul 18, 2024 •

edited

Loading

allgandalf commented Jul 31, 2024 •

edited

Loading

allgandalf Aug 16, 2024 •

edited

Loading