fix: Book travel - Book travel animation becomes blank while RHP is dismissed #50199

layacat · 2024-10-04T02:52:09Z

Details

Fixed Issues

$ #49744
PROPOSAL: #49744 (comment)

Tests

Go to staging.new.expensify.com
Open FAB
Click Book travel
Dismiss the RHP
Verify book travel animation will not become blank while RHP is dismissed

Verify that no errors appear in the JS console

Offline tests

Same with Tests

QA Steps

Same with Tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.native.mov

Android: mWeb Chrome

android.web.mov

iOS: Native

iphone.native.mov

iOS: mWeb Safari

iphone.web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-10-04T04:52:18Z

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

suneox · 2024-10-04T07:13:13Z

src/components/Lottie/index.tsx


+    // If user is being navigated away, let pause the animation to prevent memory leak.
+    useEffect(() => {
+        if (!animationRef || !hasNavigatedAway) {


animationRef always an object

Suggested change

if (!animationRef || !hasNavigatedAway) {

if (!animationRef.current || !hasNavigatedAway) {

thanks, I fixed it

suneox · 2024-10-04T08:38:52Z

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-10-04.at.15.13.22.mp4

Android: mWeb Chrome

Screen.Recording.2024-10-04.at.15.15.38.mp4

iOS: Native

Screen.Recording.2024-10-04.at.14.39.34.mp4

iOS: mWeb Safari

Screen.Recording.2024-10-04.at.14.44.58.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-10-04.at.14.33.01.mp4

MacOS: Desktop

Screen.Recording.2024-10-04.at.14.34.21.mp4

suneox · 2024-10-06T06:47:43Z

@layacat We need to retain the current forwardedRef. I’ve provided the necessary implementation code, so you can proceed with updating the changes accordingly. Please provide feedback if you encounter any issues during the update.

layacat · 2024-10-07T04:25:28Z

@layacat We need to retain the current forwardedRef. I’ve provided the necessary implementation code, so you can proceed with updating the changes accordingly. Please provide feedback if you encounter any issues during the update.

I didn't find any usages of the forwardRef, do we need to keep it?

suneox · 2024-10-07T05:15:07Z

I didn't find any usages of the forwardRef, do we need to keep it?

@layacat Currently we have many issues being implement, which maybe involve using ref, so we don’t have the context to remove the forwardRef and keep forwardRef doesn't break the functionality

layacat · 2024-10-07T07:00:34Z

If we add forwardRef back, we also need to pass the ref everywhere we used Lottie (or maybe where we faced the issue aka the BookTravel - RHP). What do you think?

suneox · 2024-10-07T07:19:36Z

If we add forwardRef back, we also need to pass the ref everywhere we used Lottie (or maybe where we faced the issue aka the BookTravel - RHP). What do you think?

@layacat We have two refs in this case: one is the forwardRef, and the other is an internal ref called animationRef.

            ref={(ref) => {
                if (typeof forwardedRef === 'function') {
                    forwardedRef(ref);
                } else if (forwardedRef && 'current' in forwardedRef) {
                    forwardedRef.current = ref; // this is an external ref
                }
                animationRef.current = ref; // this is an internal ref will handle pause animation
            }}

layacat · 2024-10-07T07:32:35Z

I see. Thanks for the advice. Let me update the PR.

…ismissed

layacat · 2024-10-07T08:25:48Z

updated @suneox

suneox · 2024-10-07T14:33:39Z

@layacat next time please avoid force-pushing. Make sure to follow the rule 15.

Please never force push when a PR review has already started

src/components/Lottie/index.tsx

suneox · 2024-10-04T07:21:27Z

src/components/Lottie/index.tsx

            {...props}
            source={animationFile}
-            ref={ref}
+            ref={animationRef}


Please keep current forward ref

Suggested change

ref={animationRef}

ref={(ref) => {

if (typeof forwardedRef === 'function') {

forwardedRef(ref);

} else if (forwardedRef && 'current' in forwardedRef) {

// eslint-disable-next-line no-param-reassign

forwardedRef.current = ref;

}

animationRef.current = ref;

}}

suneox · 2024-10-04T07:23:00Z

src/components/Lottie/index.tsx


-function Lottie({source, webStyle, shouldLoadAfterInteractions, ...props}: Props, ref: ForwardedRef<LottieView>) {
+function Lottie({source, webStyle, shouldLoadAfterInteractions, ...props}: Props) {
+    const animationRef = useRef<LottieView>(null);


Allow nullable for reassign ref

Suggested change

const animationRef = useRef<LottieView>(null);

const animationRef = useRef<LottieView | null>(null);

MonilBhavsar · 2024-10-07T18:23:09Z

@layacat any specific reason to force push the commits? It is not really preferred as it removes commit history and makes reviewing (following conversation and code changes) bit challenging

src/components/Lottie/index.tsx

layacat · 2024-10-08T01:46:14Z

@layacat any specific reason to force push the commits? It is not really preferred as it removes commit history and makes reviewing (following conversation and code changes) bit challenging

Sorry, I'm familiar with rebase flow (my company used it as the mandatory rule) so I did it as a habit. I will try to do merge flow from now then.

src/components/Lottie/index.tsx

MonilBhavsar

Thanks!

OSBotify · 2024-10-08T07:11:42Z

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

github-actions · 2024-10-09T20:47:41Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.47-1 🚀

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

github-actions · 2024-10-10T23:02:52Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.47-4 🚀

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

rojiphil · 2025-04-14T18:55:40Z

src/components/Lottie/index.tsx

+        if (!animationRef.current || !hasNavigatedAway) {
+            return;
+        }
+        animationRef?.current?.pause();


When the browser back button is used to navigate back to a page containing lottie animation, the paused animation does not animate again as a rerender was needed. We addressed this issue here at #59325

layacat marked this pull request as ready for review October 4, 2024 04:52

layacat requested a review from a team as a code owner October 4, 2024 04:52

melvin-bot bot requested a review from suneox October 4, 2024 04:52

melvin-bot bot removed the request for review from a team October 4, 2024 04:52

layacat mentioned this pull request Oct 4, 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 4, 2024

View reviewed changes

layacat force-pushed the fix-49744 branch from 8e763e9 to a800c89 Compare October 4, 2024 07:19

fix: Book travel - Book travel animation becomes blank while RHP is d…

bd70f71

…ismissed

layacat force-pushed the fix-49744 branch from a800c89 to bd70f71 Compare October 7, 2024 07:42

suneox approved these changes Oct 7, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar October 7, 2024 14:37

MonilBhavsar reviewed Oct 7, 2024

View reviewed changes

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

Remove memory leak comment

622b892

MonilBhavsar reviewed Oct 8, 2024

View reviewed changes

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

Add issue link for memory leak issue

c2ebaad

MonilBhavsar approved these changes Oct 8, 2024

View reviewed changes

MonilBhavsar merged commit 41c0b9d into Expensify:main Oct 8, 2024

github-actions bot mentioned this pull request Oct 9, 2024

Deploy Checklist: New Expensify 2024-10-09 #50518

Closed

58 tasks

rojiphil reviewed Apr 14, 2025

View reviewed changes

	if (!animationRef \|\| !hasNavigatedAway) {
	if (!animationRef.current \|\| !hasNavigatedAway) {

	const animationRef = useRef<LottieView>(null);
	const animationRef = useRef<LottieView \| null>(null);

fix: Book travel - Book travel animation becomes blank while RHP is dismissed #50199

fix: Book travel - Book travel animation becomes blank while RHP is dismissed #50199

Uh oh!

Conversation

layacat commented Oct 4, 2024 • edited 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!

melvin-bot bot commented Oct 4, 2024

Uh oh!

suneox Oct 4, 2024

Choose a reason for hiding this comment

Uh oh!

layacat Oct 4, 2024

Choose a reason for hiding this comment

Uh oh!

suneox commented Oct 4, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

suneox commented Oct 6, 2024

Uh oh!

layacat commented Oct 7, 2024

Uh oh!

suneox commented Oct 7, 2024

Uh oh!

layacat commented Oct 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

suneox commented Oct 7, 2024

Uh oh!

layacat commented Oct 7, 2024

Uh oh!

layacat commented Oct 7, 2024

Uh oh!

suneox commented Oct 7, 2024

Uh oh!

Uh oh!

suneox Oct 4, 2024

Choose a reason for hiding this comment

Uh oh!

suneox Oct 4, 2024

Choose a reason for hiding this comment

Uh oh!

MonilBhavsar commented Oct 7, 2024

Uh oh!

Uh oh!

layacat commented Oct 8, 2024

Uh oh!

Uh oh!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 8, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 10, 2024

Uh oh!

rojiphil Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

layacat commented Oct 4, 2024 •

edited

Loading

layacat commented Oct 7, 2024 •

edited

Loading