[CP Staging] Add freezeScreenWithLazyLoading function #44544

WojtekBoman · 2024-06-27T13:24:04Z

Details

This PR fixes the issue with flickering central pane screens.

This issue was caused by invoking withPrepareCentralPaneScreen HOC multiple times in CENTRAL_PANE_SCREENS.tsx.

Previously, each screen in CENTRAL_PANE_SCREENS was stored as an arrow function that returns a lazily loaded component wrapped by a HOC, causing that HOC to be called multiple times. This HOC has now been refactored
to a higher order function that takes an arrow function as a parameter, this logic prevents unnecessary re-rendering screens.

Fixed Issues

$ #44419
$ #44498
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Launch New Expensify app.
Go to any chat with a submitted expense.
Click on the expense preview.
Click on the back button.
Verify if the page is rendered without flickering.

Open the app
Log in with a new Gmail account
Tap on FAB - Start chat
Enter a Gmail address that doesn't have an account yet
Tap on the account
Tap on the "+" button next to the composer

Offline tests

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

RPReplay_Final1719502379.mp4

Android: Native

Screen.Recording.2024-06-27.at.16.04.47.mov

Android: mWeb Chrome

Screen.Recording.2024-06-27.at.16.12.18.mov

iOS: Native

Screen.Recording.2024-06-27.at.16.23.05.mov

iOS: mWeb Safari

Screen.Recording.2024-06-27.at.16.14.11.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-27.at.16.07.17.mov

MacOS: Desktop

Screen.Recording.2024-06-27.at.16.04.09.mov

Kicu

Suggested some renames

src/components/withPrepareCentralPaneScreen/index.native.tsx

src/libs/freezeScreenWithLazyLoading.tsx

src/components/withPrepareCentralPaneScreen/index.native.tsx

…reezeScreenWithLazyLoading

melvin-bot · 2024-06-27T14:27:03Z

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

github-actions · 2024-06-27T14:58:26Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/44544/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/44544/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/44544/NewExpensify.dmg	https://44544.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

mountiny · 2024-06-27T15:25:36Z

RPReplay_Final1719501628.mp4

tested and ios worked

ZhenjaHorbach · 2024-06-27T15:29: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

android-1.mov

android-2.mov

Android: mWeb Chrome

android-web-1.mov

android-web-2.mov

iOS: Native

ios-1.mov

ios-2.mov

iOS: mWeb Safari

ios-web-1.mov

ios-web-2.mov

MacOS: Chrome / Safari

web-1.mov

web-2.mov

MacOS: Desktop

desktop-2.mov

desktop-1.mov

mountiny

Changes look fine to me, but its not immediately obvious to me why not using the lazy component causes this issue. @WojtekBoman Can you provide more details in the PR description please?

mountiny · 2024-06-27T15:37:07Z

The issue with the popover is also fixed https://github.com/Expensify/App/assets/36083550/e59ebbb1-0338-458b-a4d6-335915c83e01

ZhenjaHorbach · 2024-06-27T16:07:21Z

I checked all platforms
No more flickering bug

The only thing I noticed
So this is the animation of opening reports
But I'm not sure if this is related to this PR
But I'll check now

Update : This bug is also in main

android-web-1.mov

ZhenjaHorbach · 2024-06-27T16:16:45Z

Changes look fine to me, but its not immediately obvious to me why not using the lazy component causes this issue. @WojtekBoman Can you provide more details in the PR description please?

Same question
But the changes work well and the code looks good too
LGTM

mountiny · 2024-06-27T16:21:34Z

Thanks! I am going to CP this to staging as its really annoying bug :D

@ZhenjaHorbach what exactly is wrong in the video/ which second?

OSBotify · 2024-06-27T16:29:11Z

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

ZhenjaHorbach · 2024-06-27T16:30:37Z

Thanks! I am going to CP this to staging as its really annoying bug :D

@ZhenjaHorbach what exactly is wrong in the video/ which second?

Maybe I'm wrong and it's always been like this and that's normal

But when we open report
Then choose any expense
The opening animation will be from the right side
Then I press on user email
The closing animation will be from the right side
But when we open any expense and press back button
The closing animation will be from the left side (It's good)

Flickering in the video is normal (I'm on the main 😅)

2024-06-27.18.27.51.mov

…n-with-lazy-loading [CP Staging] Add freezeScreenWithLazyLoading function (cherry picked from commit 9d88c63)

mountiny · 2024-06-27T16:44:07Z

Yeah I think we are tracking the orientation of the animations elsewhere. Its a bit tricky

OSBotify · 2024-06-27T17:04:01Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.2-4 🚀

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 · 2024-07-03T19:42:48Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

OSBotify · 2024-07-10T11:03:32Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

allgandalf · 2024-07-18T09:21:09Z

src/libs/freezeScreenWithLazyLoading.tsx

+export default function freezeScreenWithLazyLoading(lazyComponent: () => React.ComponentType) {
+    return () => {
+        const Component = lazyComponent();
+        return FrozenScreen(Component);
+    };
+}


This additional loading state caused #45152.

Since this function handles screen-level entities -> we'll re-mount entire screen. keyboard appear -> we re-mount screen -> we destroy composer -> we loose focus -> keyboard hides. When screen is mounted -> we retrieve input focus and we get infinite loop .

(Read the PR description for more details #45335)

Add freezeScreenWithLazyLoading function

af3fa5b

Kicu reviewed Jun 27, 2024

View reviewed changes

src/components/withPrepareCentralPaneScreen/index.native.tsx Outdated Show resolved Hide resolved

src/libs/freezeScreenWithLazyLoading.tsx Outdated Show resolved Hide resolved

src/libs/freezeScreenWithLazyLoading.tsx Outdated Show resolved Hide resolved

Kicu reviewed Jun 27, 2024

View reviewed changes

src/components/withPrepareCentralPaneScreen/index.native.tsx Outdated Show resolved Hide resolved

WojtekBoman added 2 commits June 27, 2024 15:49

Rename functions and parameters in withPrepareCentralPaneScreen and f…

9e7c21f

…reezeScreenWithLazyLoading

Rename function in freezeScreenWithLazyLoading

96be87d

WojtekBoman marked this pull request as ready for review June 27, 2024 14:26

WojtekBoman requested a review from a team as a code owner June 27, 2024 14:26

melvin-bot bot removed the request for review from a team June 27, 2024 14:27

melvin-bot bot requested a review from akinwale June 27, 2024 14:27

arosiclair added the Ready To Build label Jun 27, 2024

arosiclair mentioned this pull request Jun 27, 2024

[HOLD for payment 2024-07-10] [$250] Chat - 1:1 DM refreshes itself, composer + action menu closes #44498

Closed

6 tasks

mountiny assigned WojtekBoman Jun 27, 2024

mountiny changed the title ~~Add freezeScreenWithLazyLoading function~~ [CP Staging] Add freezeScreenWithLazyLoading function Jun 27, 2024

mountiny approved these changes Jun 27, 2024

View reviewed changes

mountiny requested review from ZhenjaHorbach and removed request for akinwale June 27, 2024 15:34

mountiny mentioned this pull request Jun 27, 2024

[HOLD for payment 2024-07-10] [PAY 07-04] [$250] iOS - Expense - App flickers when opening submit flow and transitioning between expense report #44419

Closed

6 tasks

ZhenjaHorbach approved these changes Jun 27, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham June 27, 2024 16:17

mountiny merged commit 9d88c63 into Expensify:main Jun 27, 2024
18 of 24 checks passed

OSBotify pushed a commit that referenced this pull request Jun 27, 2024

Merge pull request #44544 from software-mansion-labs/fix/freeze-scree…

f58d10c

…n-with-lazy-loading [CP Staging] Add freezeScreenWithLazyLoading function (cherry picked from commit 9d88c63)

github-actions bot mentioned this pull request Jun 27, 2024

Deploy Checklist: New Expensify 2024-06-25 #44406

Closed

92 tasks

ZhenjaHorbach mentioned this pull request Jul 10, 2024

Simplify the RootNavigator structure #42582

Merged

51 tasks

allgandalf reviewed Jul 18, 2024

View reviewed changes

allgandalf mentioned this pull request Jul 18, 2024

[HOLD for payment 2024-07-22] [$500] Android & iOS-Chat - Report flickers, keyboard is dismissed when focus on composer on Android #45152

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Add freezeScreenWithLazyLoading function #44544

[CP Staging] Add freezeScreenWithLazyLoading function #44544

WojtekBoman commented Jun 27, 2024 •

edited

Loading

Kicu left a comment

melvin-bot bot commented Jun 27, 2024

github-actions bot commented Jun 27, 2024

mountiny commented Jun 27, 2024

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading

mountiny left a comment

mountiny commented Jun 27, 2024

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading

ZhenjaHorbach commented Jun 27, 2024

mountiny commented Jun 27, 2024

OSBotify commented Jun 27, 2024

ZhenjaHorbach commented Jun 27, 2024

mountiny commented Jun 27, 2024

OSBotify commented Jun 27, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 10, 2024

allgandalf Jul 18, 2024

[CP Staging] Add freezeScreenWithLazyLoading function #44544

[CP Staging] Add freezeScreenWithLazyLoading function #44544

Conversation

WojtekBoman commented Jun 27, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 27, 2024

github-actions bot commented Jun 27, 2024

mountiny commented Jun 27, 2024

ZhenjaHorbach commented Jun 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Jun 27, 2024

ZhenjaHorbach commented Jun 27, 2024 • edited Loading

ZhenjaHorbach commented Jun 27, 2024

mountiny commented Jun 27, 2024

OSBotify commented Jun 27, 2024

ZhenjaHorbach commented Jun 27, 2024

mountiny commented Jun 27, 2024

OSBotify commented Jun 27, 2024

OSBotify commented Jul 3, 2024

OSBotify commented Jul 10, 2024

allgandalf Jul 18, 2024

Choose a reason for hiding this comment

WojtekBoman commented Jun 27, 2024 •

edited

Loading

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading

ZhenjaHorbach commented Jun 27, 2024 •

edited

Loading