Prevent Lottie from running in the background after navigating to other pages by QichenZhu · Pull Request #48444 · Expensify/App

QichenZhu · 2024-09-03T05:53:40Z

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

android-native.mp4

Android: mWeb Chrome

android-web.mp4

iOS: Native

ios-native.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

mac-web.mp4

MacOS: Desktop

mac-desktop.mov

…er pages

suneox · 2024-09-05T06:13:25Z

src/components/Lottie/index.tsx

+    // Prevent the animation from running in the background after navigating to other pages.
+    // See https://github.com/Expensify/App/issues/47273
+    useEffect(() => {
+        if (!navigationContainerRef || !navigator) {


We should check navigationRef.isReady() before access getState

github-actions · 2024-09-09T06:59:24Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

QichenZhu · 2024-09-09T09:21:55Z

@suneox It seems that the current approach has fixed the regression, so using isReady() might be redundant.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

suneox · 2024-09-09T15:07:58Z

@suneox It seems that the current approach has fixed the regression, so using isReady() might be redundant.

TY, I'll start checking now

suneox · 2024-09-09T16:03:30Z

src/components/Lottie/index.tsx

+        const unsubscribeNavigationBlur = navigator.addListener('blur', () => {
+            const state = navigationContainerRef.getRootState();
+            const targetRouteName = state?.routes?.[state?.index ?? 0]?.name;
+            if (targetRouteName !== NAVIGATORS.RIGHT_MODAL_NAVIGATOR) {


Suggested change

if (targetRouteName !== NAVIGATORS.RIGHT_MODAL_NAVIGATOR) {

if (![NAVIGATORS.RIGHT_MODAL_NAVIGATOR, NAVIGATORS.LEFT_MODAL_NAVIGATOR].includes(targetRouteName)) {

That will be better. Thanks for pointing it out!

suneox · 2024-09-09T16:05:25Z

src/components/Lottie/index.tsx

+    const navigator = useContext(NavigationContext);
+
+    useEffect(() => {
+        if (!browser || !navigationContainerRef || !navigator) {


Do we need to check browser?

Because the issue only occurs in browsers, it seems unnecessary to apply this fix to native platforms.

OK, let change the PR status

suneox · 2024-09-09T16:19:20Z

@QichenZhu The change looks good. We can update the status based on the suggestions above, and I have a question related to using the browser.

melvin-bot · 2024-09-10T14:04:29Z

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

QichenZhu · 2024-09-10T14:10:18Z

@dangrous Sorry, but I'm not sure why Melvin involved you here.

dangrous · 2024-09-10T16:08:42Z

No worries - looks like this should be reviewed by @aldo-expensify ?

suneox · 2024-09-10T17:39:28Z

Hi @dangrous I’ll be working on this PR

dangrous · 2024-09-10T17:41:09Z

ah @QichenZhu it looks like you just linked the PR like $ #47273 - next time be sure to put the full link in the markdown, like $ https://github.com/Expensify/App/issues/47273 - that will let the bot correctly assigned reviewers! (I updated it just now so it's fixed)

I'm removing myself for now, this should correctly assign @aldo-expensify when ready.

suneox · 2024-09-10T18:08:29Z

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-09-11.at.01.03.26.mp4

Android: mWeb Chrome

Screen.Recording.2024-09-11.at.00.57.57.mp4

iOS: Native

Screen.Recording.2024-09-11.at.00.59.29.mp4

iOS: mWeb Safari

Screen.Recording.2024-09-11.at.00.55.08.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-09-11.at.00.51.34.mp4

MacOS: Desktop

Screen.Recording.2024-09-11.at.00.52.48.mp4

suneox

LGTM. I’ve verified this issue along with the regression issue.

OSBotify · 2024-09-10T20:02:23Z

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

rayane-d · 2025-02-08T12:10:42Z

src/components/Lottie/index.tsx

+        const unsubscribeNavigationBlur = navigator.addListener('blur', () => {
+            const state = navigationContainerRef.getRootState();
+            const targetRouteName = state?.routes?.[state?.index ?? 0]?.name;
+            if (!isSideModalNavigator(targetRouteName)) {


The condition !isSideModalNavigator(targetRouteName) was introduced to exclude side modals on web/desktop platforms. However, the lack of an exception for small screens led to the issue here: #53208
Proposal: #53208 (comment)
PR: #55823

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

fd10e5b

…er pages

suneox reviewed Sep 5, 2024

View reviewed changes

QichenZhu added 3 commits September 9, 2024 14:34

Merge remote-tracking branch 'upstream/main' into fix/47273-2nd-try

b0d577f

Rename isHidden to hasNavigatedAway

fc9fa94

Check the platform

b79df74

Fix lint errors

3bc4b18

QichenZhu force-pushed the fix/47273-2nd-try branch from d0cd731 to 3bc4b18 Compare September 9, 2024 07:06

Add useEffect dependencies

7f5a158

suneox reviewed Sep 9, 2024

View reviewed changes

QichenZhu added 2 commits September 10, 2024 16:02

Merge remote-tracking branch 'upstream/main' into fix/47273-2nd-try

2e03f4b

Exclude left side modal

10af7f9

QichenZhu marked this pull request as ready for review September 10, 2024 14:03

QichenZhu requested a review from a team as a code owner September 10, 2024 14:03

melvin-bot bot requested review from dangrous and removed request for a team September 10, 2024 14:04

dangrous removed their request for review September 10, 2024 17:41

suneox approved these changes Sep 10, 2024

View reviewed changes

melvin-bot bot requested a review from aldo-expensify September 10, 2024 18:10

aldo-expensify approved these changes Sep 10, 2024

View reviewed changes

aldo-expensify merged commit bfe3b75 into Expensify:main Sep 10, 2024

github-actions bot mentioned this pull request Sep 11, 2024

Deploy Checklist: New Expensify 2024-09-11 #48954

Closed

58 tasks

hungvu193 mentioned this pull request Sep 27, 2024

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

Closed

6 tasks

linhvovan29546 mentioned this pull request Jan 25, 2025

[Due for payment 2025-02-13] [$250] mWeb - Workspace - Input is not auto-focused and keyboard doesn't open when creating a tag #53208

Closed

8 tasks

rayane-d reviewed Feb 8, 2025

View reviewed changes

	if (targetRouteName !== NAVIGATORS.RIGHT_MODAL_NAVIGATOR) {
	if (![NAVIGATORS.RIGHT_MODAL_NAVIGATOR, NAVIGATORS.LEFT_MODAL_NAVIGATOR].includes(targetRouteName)) {

Conversation

QichenZhu commented Sep 3, 2024 • edited by dangrous Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

suneox Sep 5, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QichenZhu commented Sep 9, 2024

Screenshots/Videos

Uh oh!

suneox commented Sep 9, 2024

Uh oh!

suneox Sep 9, 2024

Choose a reason for hiding this comment

Uh oh!

QichenZhu Sep 10, 2024

Choose a reason for hiding this comment

Uh oh!

suneox Sep 9, 2024

Choose a reason for hiding this comment

Uh oh!

QichenZhu Sep 10, 2024

Choose a reason for hiding this comment

Uh oh!

suneox Sep 10, 2024

Choose a reason for hiding this comment

Uh oh!

suneox commented Sep 9, 2024

Uh oh!

melvin-bot bot commented Sep 10, 2024

Uh oh!

QichenZhu commented Sep 10, 2024

Uh oh!

dangrous commented Sep 10, 2024

Uh oh!

suneox commented Sep 10, 2024

Uh oh!

dangrous commented Sep 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

suneox commented Sep 10, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

suneox left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Sep 10, 2024

Uh oh!

rayane-d Feb 8, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

QichenZhu commented Sep 3, 2024 •

edited by dangrous

Loading

github-actions bot commented Sep 9, 2024 •

edited

Loading

dangrous commented Sep 10, 2024 •

edited

Loading