FIX: Performance and heat issues on the 'Troubleshoot' page by ikevin127 · Pull Request #38093 · Expensify/App

ikevin127 · 2024-03-11T21:10:10Z

Details

Because of the way our navigation stack pages implementation (transparentModal), when app goes into the background then back to the foreground on pages with Lottie animations it causes UI performance / device heating issues -> this PR addresses the issue by un-mounting the Lottie animation component when the app goes into the background and re-mounting when app comes back to the foreground.

Fixed Issues

$ #36645
PROPOSAL: #36645 (comment)

Tests

Navigate to Account Settings - About - Troubleshoot page.
Put the app into the background (not just app switcher) -> (app unusable, user can interact with other apps).
Put the app back into the foreground via phone's app switcher - (app is usable again).
Scroll up and down while on the Troubleshoot page.
Notice there are no UI performance / heating issues anymore.

Verify that no errors appear in the JS console

Offline tests

TLDR: same as Tests.

Navigate to Account Settings - About - Troubleshoot page.
Put the app into the background (not just app switcher) -> (app unusable, user can interact with other apps).
Put the app back into the foreground via phone's app switcher - (app is usable again).
Scroll up and down while on the Troubleshoot page.
Notice there are no UI performance / heating issues anymore.

QA Steps

TLDR: same as Tests.

Navigate to Account Settings - About - Troubleshoot page.
Put the app into the background (not just app switcher) -> (app unusable, user can interact with other apps).
Put the app back into the foreground via phone's app switcher - (app is usable again).
Scroll up and down while on the Troubleshoot page.
Notice there are no UI performance / heating issues anymore.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.MP4

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-03-11T21:10:15Z

@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-12T14:00:25Z

src/components/Lottie/index.tsx

+    // If the image fails to load or app is in background state, we'll just render an empty view
+    // using the fallback in case of a Lottie error or (isFocused || isBackground) to prevent
+    // memory leaks, see issue: https://github.com/Expensify/App/issues/36645
+    if (isError || !isFocused || appState.isBackground) {


Sorry @ikevin127 I think we need to remove isFocus. Otherwise, in Web the Lottie animation of About page is hidden when we open Troubleshoot page

@hoangzinh Good catch, removed it.

From my tests I could not see any difference in performance with the additional !isFocused, so removing it does not affect the performance of the proposed fix any way 👍

hoangzinh · 2024-03-12T14:01:18Z

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

XRecorder_12032024_210458.mp4

Android: mWeb Chrome

Screen.Recording.2024-03-12.at.20.54.25.android.chrome.mov

iOS: Native

RPReplay_Final1710254000.mp4

iOS: mWeb Safari

Screen.Recording.2024-03-12.at.20.57.14.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-12.at.21.00.46.web.mov

MacOS: Desktop

Screen.Recording.2024-03-12.at.21.02.17.desktop.mov

ikevin127 · 2024-03-12T14:57:26Z

🚨 Typecheck fail caused by PR #37956, confirmed in #37956 (comment).

♻ Will merge w/ main again when fixed.

hoangzinh

LGTM

hayata-suenaga

please create types.ts file to define the shared interface between native and web implementations of useAppState 🙇

ikevin127 · 2024-03-12T20:24:36Z

@hayata-suenaga Sorry, missed that one. All good now! 🚀

hayata-suenaga · 2024-03-12T20:37:22Z

@ikevin127 nice thank you! next, could you use the type you defined in the web implementation of useAppState to make sure that the function returns the object that conforms to the type?

ikevin127 · 2024-03-12T20:44:02Z

next, could you use the type you defined in the web implementation of useAppState to make sure that the function returns the object that conforms to the type?

@hayata-suenaga ✅

hayata-suenaga

thank you for the quick fix 🙇

OSBotify · 2024-03-12T23:25:16Z

✋ 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:51Z

🚀 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:16:12Z

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

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

Performance and heat issues on the 'Troubleshoot' option

1cb4eaa

ikevin127 requested a review from a team as a code owner March 11, 2024 21:10

melvin-bot bot requested review from hoangzinh and removed request for a team March 11, 2024 21:10

ikevin127 changed the title ~~FIX: Performance and heat issues on the 'Troubleshoot' option~~ FIX: Performance and heat issues on the 'Troubleshoot' page Mar 11, 2024

hoangzinh reviewed Mar 12, 2024

View reviewed changes

ikevin127 added 2 commits March 12, 2024 16:43

removed isFocused

365903d

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

7227b01

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

fa6db6b

hoangzinh approved these changes Mar 12, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga March 12, 2024 15:31

hayata-suenaga suggested changes Mar 12, 2024

View reviewed changes

added types.ts file

f690971

added return AppStateType to useAppState web implementation

c512812

hayata-suenaga approved these changes Mar 12, 2024

View reviewed changes

hayata-suenaga merged commit 84ce225 into Expensify:main Mar 12, 2024

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

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

Closed

74 tasks

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

[HOLD for payment 2024-03-22] [$1000] Settings - Performance and heat issues on the "Troubleshoot" option #36645

Closed

6 tasks

ikevin127 mentioned this pull request Mar 25, 2024

[Awaiting checklist and C+ payment][$500] Android - Sign-in page flickers after using autofill #38347

Closed

6 tasks

TMisiukiewicz mentioned this pull request Mar 26, 2024

feat: access client side logging from Test Tools Modal #38803

Merged

50 tasks

QichenZhu mentioned this pull request Aug 17, 2024

[PAID] [$250] The preference setting doesn’t work when navigating between chat and settings. #47273

Closed

6 tasks

Conversation

ikevin127 commented Mar 11, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 11, 2024

Uh oh!

hoangzinh Mar 12, 2024

Choose a reason for hiding this comment

Uh oh!

ikevin127 Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoangzinh commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ikevin127 commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hoangzinh left a comment

Choose a reason for hiding this comment

Uh oh!

hayata-suenaga left a comment

Choose a reason for hiding this comment

Uh oh!

ikevin127 commented Mar 12, 2024

Uh oh!

hayata-suenaga commented Mar 12, 2024

Uh oh!

ikevin127 commented Mar 12, 2024

Uh oh!

hayata-suenaga left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Mar 12, 2024

Uh oh!

OSBotify commented Mar 13, 2024

Uh oh!

OSBotify commented Mar 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ikevin127 Mar 12, 2024 •

edited

Loading

hoangzinh commented Mar 12, 2024 •

edited

Loading

ikevin127 commented Mar 12, 2024 •

edited

Loading