Prevent Lottie from running in the background after navigating to other pages #47960

QichenZhu · 2024-08-24T11:07:27Z

Details

Fixed Issues

$ #47273
PROPOSAL: #47273 (comment)

Tests

Go to Settings - Preferences.
Navigate to Chat.
Navigate back to the Settings tab.
Click on Priority Mode, Language, or Theme.

Expected result: The animation in the Settings tab should work, and the right-side modal should open.

Verify that no errors appear in the JS console

Offline tests

Go to Settings - Preferences.
Navigate to Chat.
Navigate back to the Settings tab.
Click on Priority Mode, Language, or Theme.

Expected result: The animation in the Settings tab should work, and the right-side modal should open.

QA Steps

Go to Settings - Preferences.
Navigate to Chat.
Navigate back to the Settings tab.
Click on Priority Mode, Language, or Theme.

Expected result: The animation in the Settings tab should work, and the right-side modal should open.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

1000016986-2024-08-26.15_27_41.500.mp4

Android: mWeb Chrome

1000016984-2024-08-26.15_27_59.290.mp4

iOS: Native

ios-native.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

mac-chrome.mov

MacOS: Desktop

mac-desktop.mov

…er pages

melvin-bot · 2024-08-26T15:45:14Z

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

src/components/Lottie/index.tsx

suneox · 2024-08-26T16:16: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 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-26.at.23.24.57.mp4

Android: mWeb Chrome

Screen.Recording.2024-08-26.at.23.23.21.mp4

iOS: Native

Screen.Recording.2024-08-26.at.23.24.11.mp4

iOS: mWeb Safari

Screen.Recording.2024-08-26.at.23.22.09.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-08-26.at.23.17.35.mp4

MacOS: Desktop

Screen.Recording.2024-08-26.at.23.21.04.mp4

src/components/Lottie/index.tsx

Co-authored-by: Cong Pham <ptcong411@gmail.com>

suneox

LGTM

QichenZhu · 2024-08-26T17:23:13Z

@suneox @aldo-expensify Could we pause the review for now? RN was upgraded to 0.75 less than an hour ago, which is a major change. I need to retest on all platforms tomorrow to be safe.

QichenZhu · 2024-08-27T09:52:12Z

@suneox @aldo-expensify Retested and found no major differences after merging the main branch, so it’s ready for review.

Screenshots/Videos

Android: Native

android-native.mp4

Android: mWeb Chrome

android-web.mp4

iOS: Native

ios-native.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

mac-chrome.mov

MacOS: Desktop

mac-desktop.mov

OSBotify · 2024-08-28T12:42:35Z

✋ 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-08-28T21:45:49Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 9.0.26-1 🚀

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

MonilBhavsar · 2024-08-29T18:16:18Z

We reverted this PR because it caused a deploy blocker that caused an App crash #48283

suneox · 2024-08-30T06:21:25Z

@QichenZhu Could you please investigate the blocker issue?

QichenZhu · 2024-08-30T11:09:49Z

@suneox Oops, my bad. Didn't realize useNavigation() could throw an error if the component is ouside of NavigationContainer.

OSBotify · 2024-08-30T18:34:16Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.26-6 🚀

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

suneox · 2024-09-02T10:08:03Z

@QichenZhu Can you reproduce #48262 on latest main with current solution?
I just double-check and it can not reproduce

QichenZhu · 2024-09-02T14:18:57Z

@suneox Yes, I can still reproduce it.

suneox · 2024-10-18T08:12:53Z

src/components/Lottie/index.tsx

+            const state = navigation.getState();
+            const targetRouteName = state?.routes?.[state?.index ?? 0]?.name;
+            if (targetRouteName !== NAVIGATORS.RIGHT_MODAL_NAVIGATOR) {
+                setIsHidden(true);


This change causes an issue where assets are hidden during the screen transition, and in some cases, if the transition is slow, users may briefly see a blank view.

QichenZhu added 3 commits August 24, 2024 23:05

Prevent Lottie from running in the background after navigating to oth…

8b74651

…er pages

Fix lint errors

7c52b62

Fix lint errors

d8fb8c5

QichenZhu marked this pull request as ready for review August 26, 2024 15:45

QichenZhu requested a review from a team as a code owner August 26, 2024 15:45

melvin-bot bot requested review from suneox and removed request for a team August 26, 2024 15:45

suneox reviewed Aug 26, 2024

View reviewed changes

src/components/Lottie/index.tsx Outdated Show resolved Hide resolved

suneox reviewed Aug 26, 2024

View reviewed changes

src/components/Lottie/index.tsx Outdated Show resolved Hide resolved

QichenZhu commented Aug 26, 2024

View reviewed changes

src/components/Lottie/index.tsx Outdated Show resolved Hide resolved

src/components/Lottie/index.tsx Outdated Show resolved Hide resolved

Rename unsubscription functions

7899770

Co-authored-by: Cong Pham <ptcong411@gmail.com>

suneox approved these changes Aug 26, 2024

View reviewed changes

melvin-bot bot requested a review from aldo-expensify August 26, 2024 16:46

QichenZhu marked this pull request as draft August 26, 2024 17:26

QichenZhu marked this pull request as ready for review August 27, 2024 09:52

aldo-expensify approved these changes Aug 28, 2024

View reviewed changes

aldo-expensify merged commit 83a8501 into Expensify:main Aug 28, 2024
16 checks passed

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

Deploy Checklist: New Expensify 2024-08-28 #48221

Closed

93 tasks

hungvu193 mentioned this pull request Aug 29, 2024

fix: Update Wallet and Generic Folder empty state to use lottie animations. #48040

Merged

50 tasks

MonilBhavsar mentioned this pull request Aug 29, 2024

[CP Staging] Revert "Prevent Lottie from running in the background after navigating to other pages" #48283

Merged

48 tasks

suneox mentioned this pull request Sep 28, 2024

[HOLD for payment 2024-10-17] [$250] Book travel - Book travel animation becomes blank while RHP is dismissed #49744

Closed

6 tasks

suneox reviewed Oct 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevent Lottie from running in the background after navigating to other pages #47960

Prevent Lottie from running in the background after navigating to other pages #47960

QichenZhu commented Aug 24, 2024 •

edited

Loading

melvin-bot bot commented Aug 26, 2024

suneox commented Aug 26, 2024 •

edited

Loading

suneox left a comment

QichenZhu commented Aug 26, 2024

QichenZhu commented Aug 27, 2024

OSBotify commented Aug 28, 2024

OSBotify commented Aug 28, 2024

MonilBhavsar commented Aug 29, 2024

suneox commented Aug 30, 2024

QichenZhu commented Aug 30, 2024

OSBotify commented Aug 30, 2024

suneox commented Sep 2, 2024

QichenZhu commented Sep 2, 2024

suneox Oct 18, 2024

Prevent Lottie from running in the background after navigating to other pages #47960

Prevent Lottie from running in the background after navigating to other pages #47960

Conversation

QichenZhu commented Aug 24, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 26, 2024

suneox commented Aug 26, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

suneox left a comment

Choose a reason for hiding this comment

QichenZhu commented Aug 26, 2024

QichenZhu commented Aug 27, 2024

Screenshots/Videos

OSBotify commented Aug 28, 2024

OSBotify commented Aug 28, 2024

MonilBhavsar commented Aug 29, 2024

suneox commented Aug 30, 2024

QichenZhu commented Aug 30, 2024

OSBotify commented Aug 30, 2024

suneox commented Sep 2, 2024

QichenZhu commented Sep 2, 2024

suneox Oct 18, 2024

Choose a reason for hiding this comment

QichenZhu commented Aug 24, 2024 •

edited

Loading

suneox commented Aug 26, 2024 •

edited

Loading