LHN list re-render #36927

perunt · 2024-02-20T17:13:56Z

here I'm trying to address the bug described: #36420 (comment)

discussion: https://expensify.slack.com/archives/C05LX9D6E07/p1708011570713419

Details

Fixed Issues

$ #36420 (comment)
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

NOTE: This issue occurs only once when you navigate to this screen for the first time.

Log out of the app.
Log back in.
Open the settings screen from the Left-Hand Navigation (LHN).
Check if there is no noticeable delay in the rendering of the settings screen.

Alternate method to reproduce the issue:

Open the chat tab on the LHN.
Restart the Metro bundler.
Switch to the settings screen.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-12.at.08.31.32.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-12.at.08.33.24.mp4

MacOS: Chrome / Safari

Untitled.mov

MacOS: Desktop

Untitled.mov

WoLewicki

I left some comments, please answer them 🎉

WoLewicki · 2024-02-21T09:29:26Z

src/pages/home/sidebar/SidebarScreen/index.js

    return (
-        <FreezeWrapper keepVisible={!isSmallScreenWidth}>
+        <FreezeWrapper>


Why did you remove this? Is the sidebar still clickable if you e.g. navigate to different reports twice? I think it was handling a case where you have the sidebar visible all the time and navigate deeper in the main stack, but maybe the navigation structure changed in a way that it is not necessary right now?

FYI I tested this fix locally and the list is still fully clickable on the web, and causes no issues on mobile. It seems plausible that the nav structure changed and this is no loner a case

keepVisible completely disables freezing for a 'big' screen. I believe the original idea of this chunk was to freeze it directly in such cases. I wonder why we used this approach before. It might be a leftover from the previous navigation structure

WoLewicki · 2024-02-21T09:34:42Z

src/libs/Navigation/FreezeWrapper.tsx

@@ -28,8 +27,8 @@ function FreezeWrapper({keepVisible = false, children}: FreezeWrapperProps) {
            // if the screen is more than 1 screen away from the current screen, freeze it,
            // we don't want to freeze the screen if it's the previous screen because the freeze placeholder
            // would be visible at the beginning of the back animation then
-            if (navigation.getState().index - (screenIndexRef.current ?? 0) > 1) {
-                InteractionManager.runAfterInteractions(() => setIsScreenBlurred(true));
+            if (navigation.getState().index - (screenIndexRef.current ?? 0) >= 1) {


Does the issue with beginning of animation not occur anymore? And did you try to run it in the new arch? I think the case with InteractionManager was needed there only and I think we will want to enable it on web ASAP too.

I can't pinpoint the any issues with the animations. I haven't tested with new arch though.

Animation of goBack works ok for me. I haven't tried it with a new arch yet, but it shouldn't be an issue

FYI I also gave it a spin and wasn't able to experience anything weird related to animations.

melvin-bot · 2024-02-23T15:09:05Z

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

hayata-suenaga · 2024-02-23T15:23:34Z

@perunt, is the purpose of this PR to ensure that the hidden screen freezes when there are two or more screens in the stack navigator?

perunt · 2024-02-23T15:31:16Z

I would say the purpose was to freeze the hidden screen once we have two or more screens in the stack. One reliable method to reproduce this issue is to log out and then log in again. It occurs when the stack has two screens. In all other cases, it works as intended.

hayata-suenaga · 2024-02-23T22:13:52Z

okay thank you for the confirmation

@situchan please review the PR when you have time 🙇

hurali97 · 2024-02-26T08:24:18Z

Hey @perunt 👋

Great work ! I was testing out your PR alongside with this PR and It works great. Only thing I want to flag is these two PR appears to go together. For example, only with your PR we still see the slowness between switch but there's no such hang observed. Now, to improve the slowness between switch, the linked PR is important.

I just wanted to flag the above and also below is how these two PRs look together.

Before

before.mp4

After

after.mp4

perunt · 2024-02-26T10:29:05Z

hey @hurali97
Just to make sure we're on the same page - are you referring to the initial switching? Could you also compare it with subsequent switchings as well?

If not, have you had a chance to test the switching on the main branch, where the issue with multiple renderItem calls doesn't seem to reproduce? Is the performance still an issue in that scenario?

The key concern here is that on the first switch, we encounter a page that completely freezes for 15-20 seconds, which we need to avoid. If there's an alternative solution, I'd be eager to explore it. The difference might be due to runAfterInteractions. I'll double-check to see if I can manage to execute it in the next frame without disrupting the freeze logic.

hurali97 · 2024-02-26T11:26:18Z

Just to make sure we're on the same page - are you referring to the initial switching? Could you also compare it with subsequent switchings as well?

I am referring to both the initial switch and the subsequent switches. If you notice in the After video, both the initial and subsequent switches are quick which happens because of the PR I linked.

What I am trying to say is your PR for sure fixes the multiple renderItem calls but we still have some slowness in screen rendering after the switch. The switch happens quickly but not the rendering. The PR I linked fixes that and now with both of these PRs we have quick switching, no extra renderItem calls and quick rendering as well.

If not, have you had a chance to test the switching on the main branch, where the issue with multiple renderItem calls doesn't seem to reproduce? Is the performance still an issue in that scenario?

Below you can see how main behaves with your PR changes only. We have no extra renderItem calls and quick switching but delayed rendering.

Main

main_.mp4

Both PRs combined

after.mp4

situchan · 2024-02-26T13:40:26Z

What I am trying to say is your PR for sure fixes the multiple renderItem calls but we still have some slowness in screen rendering after the switch.

@hurali97 at least this PR won't cause another performance regression right?

we still have some slowness in screen rendering after the switch

this is already existing bug on main right?

hurali97 · 2024-02-26T13:54:03Z

@hurali97 at least this PR won't cause another performance regression right?

From an overview, doesn't look like there will be a regression but we need to test here because in this PR we have some changes to the Freeze wrapper.

this is already existing bug on main right?

That's correct and this is what's addressed in this PR

perunt · 2024-02-26T16:03:37Z

Ahh, now I understand—I was concerned my PR might be causing some slowness. Great work on your part! The page loading appears much faster now. I'm confident users will definitely notice the improvemen

perunt · 2024-02-26T16:05:49Z

@hurali97 at least this PR won't cause another performance regression right?

Indeed, this PR should not lead to any further performance regression. At least, I haven't observed any such issues so far.

perunt · 2024-02-27T17:19:03Z

@situchan, can you please take a look at this?

situchan · 2024-02-27T17:22:32Z

yes reviewing today

situchan · 2024-02-28T22:24:08Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

situchan · 2024-02-28T22:25:00Z

@perunt can you please add platform screenshots?

situchan · 2024-03-03T23:49:31Z

And there's conflict

perunt · 2024-03-04T08:24:43Z

@perunt can you please add platform screenshots?

it was a web issue, i have screen records for it in MacOS: Chrome / Safari section

…into perunt/perf-lhn-list

…erf-lhn-list

situchan · 2024-03-08T13:50:29Z

This also happens on main so out of scope. But is this bug already reported or being fixed elsewhere?

After switching to wrench tab and back, not found page shows

Screen.Recording.2024-03-08.at.7.49.04.PM.mov

situchan · 2024-03-08T13:54:51Z

src/libs/Navigation/FreezeWrapper.tsx

-            if ((navigation.getState()?.index ?? 0) - (screenIndexRef.current ?? 0) > 1) {
-                InteractionManager.runAfterInteractions(() => setIsScreenBlurred(true));
+
+            if ((navigation.getState()?.index ?? 0) - (screenIndexRef.current ?? 0) >= 1) {


I see that you changed to >= 1 from > 1. Isn't this opposed to this comment?

// we don't want to freeze the screen if it's the previous screen because the freeze placeholder // would be visible at the beginning of the back animation then

I see that we no longer use the placeholder component. I guess this comment was not changed after the placeholder was removed. I will do it now

@perunt this actually caused regression.
As this affects all platforms, please test and add remaining platforms, not only web.

this branch:

Screen.Recording.2024-03-11.at.10.54.20.PM.mov

main:

Screen.Recording.2024-03-11.at.10.54.42.PM.mov

@situchan, thanks for pointing it out.
I retested it, and it looks like a freshly added nullish coalescing operator can let me remove this check, so I assume we can't receive navigation immediately in some cases. I'm adding the rest of the recordings.

src/libs/Navigation/FreezeWrapper.tsx

situchan · 2024-03-08T14:07:18Z

It doesn't make sense to link #35602 in Fixed Issues as this PR isn't supposed to that.

perunt · 2024-03-11T14:56:42Z

It doesn't make sense to link #35602 in Fixed Issues as this PR isn't supposed to that.

switched to the correct one #36420 (comment)

@situchan, can I somehow speed up merging this PR?

situchan · 2024-03-11T14:58:35Z

@situchan, can I somehow speed up merging this PR?

I am just waiting for #36927 (comment) from @getusha to confirm that it's safe.
Otherwise looks good.

…erf-lhn-list

situchan · 2024-03-11T16:37:49Z

There's performance lag a bit when opening Search page on both main and this branch. I don't find any difference.
So I'd say this is not regression.

Screen.Recording.2024-03-11.at.10.36.53.PM.mov

hayata-suenaga

code looks good to me

are there blocking issues or conversations to be resolved before we merge this PR?

perunt · 2024-03-11T19:45:53Z

I don't know about such issues, so it's clean from my side

situchan · 2024-03-11T19:47:22Z

code looks good to me

are there blocking issues or conversations to be resolved before we merge this PR?

#36927 (comment)

hayata-suenaga

@perunt please check the regression described in this comment.

perunt · 2024-03-12T09:05:30Z

@hayata-suenaga I'm resolving this, thanks!

hayata-suenaga · 2024-03-12T19:33:35Z

@situchan could you retest when you have time? 🙇

situchan · 2024-03-12T19:34:32Z

testing

melvin-bot · 2024-03-12T19:44:19Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #38170.

situchan · 2024-03-12T19:46:21Z

The code is now simplified and affects only web platform.
Tests well but still be on the lookout for any regressions we might have missed.

hayata-suenaga

thank you so much for your work @perunt 😄

OSBotify · 2024-03-12T20:36:31Z

✋ 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-13T19:59:09Z

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

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

OSBotify · 2024-03-15T10:15:30Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.52-6 🚀

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

perunt added 4 commits February 19, 2024 11:31

Merge branch 'main' of https://github.com/Expensify/App

ac3f125

Merge branch 'main' of https://github.com/Expensify/App

a247662

remove delay in freeze

77df1e4

remove keepVisible

fc2b642

WoLewicki reviewed Feb 21, 2024

View reviewed changes

jbroma mentioned this pull request Feb 22, 2024

perf: make switch between chat list and workspaces smoother #36420

Merged

50 tasks

hayata-suenaga self-requested a review February 22, 2024 17:11

perunt marked this pull request as ready for review February 23, 2024 15:09

perunt requested a review from a team as a code owner February 23, 2024 15:09

melvin-bot bot requested review from situchan and removed request for a team February 23, 2024 15:09

perunt added 2 commits March 4, 2024 09:27

Merge branch 'main' of https://github.com/margelo/expensify-app-fork …

51e05c3

…into perunt/perf-lhn-list

Merge branch 'main' of https://github.com/Expensify/App into perunt/p…

ad7bc16

…erf-lhn-list

situchan reviewed Mar 8, 2024

View reviewed changes

src/libs/Navigation/FreezeWrapper.tsx Show resolved Hide resolved

clean comment

8ebf567

Merge branch 'main' of https://github.com/Expensify/App into perunt/p…

0438c8a

…erf-lhn-list

hayata-suenaga approved these changes Mar 11, 2024

View reviewed changes

hayata-suenaga self-requested a review March 11, 2024 19:54

hayata-suenaga suggested changes Mar 11, 2024

View reviewed changes

mountiny assigned perunt Mar 11, 2024

bring back freezing on 1 screen away

462e200

situchan approved these changes Mar 12, 2024

View reviewed changes

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

[HOLD for payment 2024-03-22] Payment issue for E/App PR#36927 #38170

Closed

hayata-suenaga approved these changes Mar 12, 2024

View reviewed changes

hayata-suenaga merged commit 9ad7ca0 into Expensify:main Mar 12, 2024
16 checks passed

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

Deploy Checklist: New Expensify 2024-03-13 #38257

Closed

74 tasks

Delgee mentioned this pull request May 4, 2024

[Hold for 40548] [$500] iOS - Chat - Send button is not responding after viewing avatar in full screen #40797

Closed

6 tasks

LHN list re-render #36927

LHN list re-render #36927

Conversation

perunt commented Feb 20, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

WoLewicki 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

Choose a reason for hiding this comment

jbroma Feb 22, 2024 • edited Loading

Choose a reason for hiding this comment

perunt Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented Feb 23, 2024

hayata-suenaga commented Feb 23, 2024

perunt commented Feb 23, 2024

hayata-suenaga commented Feb 23, 2024

hurali97 commented Feb 26, 2024

perunt commented Feb 26, 2024

hurali97 commented Feb 26, 2024

situchan commented Feb 26, 2024

hurali97 commented Feb 26, 2024 • edited Loading

perunt commented Feb 26, 2024

perunt commented Feb 26, 2024

perunt commented Feb 27, 2024

situchan commented Feb 27, 2024

situchan commented Feb 28, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

situchan commented Feb 28, 2024

situchan commented Mar 3, 2024

perunt commented Mar 4, 2024

situchan commented Mar 8, 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

situchan commented Mar 8, 2024

perunt commented Mar 11, 2024

situchan commented Mar 11, 2024

situchan commented Mar 11, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

perunt commented Mar 11, 2024

situchan commented Mar 11, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

perunt commented Mar 12, 2024

hayata-suenaga commented Mar 12, 2024

situchan commented Mar 12, 2024

melvin-bot bot commented Mar 12, 2024

situchan commented Mar 12, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 12, 2024

OSBotify commented Mar 13, 2024

OSBotify commented Mar 15, 2024

perunt commented Feb 20, 2024 •

edited

Loading

jbroma Feb 22, 2024 •

edited

Loading

perunt Feb 23, 2024 •

edited

Loading

hurali97 commented Feb 26, 2024 •

edited

Loading

situchan commented Feb 28, 2024 •

edited

Loading