Fix lottie interactions by roryabraham · Pull Request #23145 · Expensify/App

roryabraham · 2023-07-18T23:44:54Z

Details

The root cause of this bug was strange:

InteractionsManager.runAfterInteractions intentionally won't call the callback if an animation is running. You can override this with an undocumented isInteraction animation config in React Native.
However, Lottie doesn't really use React Native's Animation lib, certainly not on web.
In react-native-web InteractionsManager.runAfterInteractions uses requestIdleCallback under the hood
react-native-web-lottie sometimes wasn't correctly cleaning up any running animations on unmount, so the animation would keep running invisibly in the background forever. Therefore requestIdleCallback was never called, and PressableWithFeedback components would get stuck in the isExecuting=true state and be permanently disabled.

To fix this, I basically re-wrote the simple react-native-web-lottie dependency using a modern functional style + w/ useEffect and it worked as expected. Something about the old component (maybe componentWillUnmount or UNSAFE_componentWillReceiveProps) was not playing nice with our react code and the cleanup that needed to happen was not happening.

In the re-write, I did drop some features we don't use for simplicity. The new version of the component is as follows:

import React, { useRef, useEffect, } from 'react';
import ReactDOM from 'react-dom';
import { View } from 'react-native';
import lottie from 'lottie-web';

function Animation({
   source,
   renderer = 'svg',
   loop = false,
   autoPlay = false,
   rendererSettings = {},
   style = {},
 }) {
  const {nm} = source;

  const anim = useRef(null);
  const animationDOMNode = useRef(null);

  useEffect(() => {
    anim.current?.destroy();
    anim.current = lottie.loadAnimation({
      container: animationDOMNode.current,
      animationData: source,
      renderer: renderer,
      loop,
      autoPlay,
      rendererSettings,
    });

    return () => {
      anim.current?.destroy();
    };
  }, [nm]);

  return (
      <View style={style} ref={r => animationDOMNode.current = ReactDOM.findDOMNode(r)}></View>
  );
}

export default React.memo(Animation);

Fixed Issues

$ #23052

Tests / QA Steps

Click back and forth out of the Preferences page as fast as you can about a million times and make sure that you don't see the Preferences menu item disabled.

Verify that no errors appear in the JS console

Offline tests

None

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

androidWeb.mov

Mobile Web - Safari

iOSWeb.mov

Desktop

desktop.mov

iOS

web/desktop change only

Android

web/desktop change only

melvin-bot · 2023-07-18T23:44:59Z

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

jasperhuangg

nice!! thanks for persevering with a fix :)

jasperhuangg · 2023-07-19T01:38:26Z

@thesahindia unassigning you and completing this review internally in the interest of urgency since this fixes a deploy blocker

jasperhuangg · 2023-07-19T02:00:27Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

web.mov

Mobile Web - Chrome

Android emulator not working.. but confident that it works on Android and need to fix this deploy blocker

Mobile Web - Safari

mweb_safari.mp4

Desktop

desktop.mov

iOS

N/A

Android

N/A

OSBotify · 2023-07-19T02:05:06Z

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

Fix lottie interactions (cherry picked from commit a7624bb)

OSBotify · 2023-07-19T02:41:21Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.3.42-25 🚀

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

OSBotify · 2023-07-19T17:58:02Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

OSBotify · 2023-07-21T18:52:30Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.3.44-0 🚀

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

OSBotify · 2023-07-25T01:26:27Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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

Fix lottie interactions

b3e363b

roryabraham requested a review from a team as a code owner July 18, 2023 23:44

roryabraham self-assigned this Jul 18, 2023

melvin-bot bot removed the request for review from a team July 18, 2023 23:44

melvin-bot bot requested a review from thesahindia July 18, 2023 23:44

This was referenced Jul 18, 2023

[HOLD for payment 2023-07-28] [HOLD for payment 2023-07-26] [$1000] Settings - Menu items are blocked after clicking on them and returning back #23052

Closed

Settings - Crash when trying to navigate to settings/preferences #23073

Closed

francoisl approved these changes Jul 19, 2023

View reviewed changes

jasperhuangg approved these changes Jul 19, 2023

View reviewed changes

jasperhuangg removed the request for review from thesahindia July 19, 2023 01:38

jasperhuangg merged commit a7624bb into main Jul 19, 2023

jasperhuangg deleted the Rory-FixLottieInteractions branch July 19, 2023 02:01

OSBotify pushed a commit that referenced this pull request Jul 19, 2023

Merge pull request #23145 from Expensify/Rory-FixLottieInteractions

0ce8a41

Fix lottie interactions (cherry picked from commit a7624bb)

jasperhuangg mentioned this pull request Jul 19, 2023

Deploy Checklist: New Expensify 2023-07-17 #23033

Closed

roryabraham mentioned this pull request Jul 19, 2023

Implement animated WorkspacesListPage and LoungeAccessPage #23061

Merged

57 tasks

OSBotify mentioned this pull request Jul 21, 2023

Deploy Checklist: New Expensify 2023-07-21 #23362

Closed

roryabraham mentioned this pull request Sep 6, 2023

[HOLD for payment 2023-11-21] Implement web support in lottie-react-native #26871

Closed

ShogunFire mentioned this pull request Sep 20, 2023

[$2000] Toggle switch fails to toggle back when tapped again on preferences page #25880

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix lottie interactions#23145

Fix lottie interactions#23145
jasperhuangg merged 1 commit intomainfrom
Rory-FixLottieInteractions

roryabraham commented Jul 18, 2023 •

edited

Loading

Uh oh!

melvin-bot bot commented Jul 18, 2023

Uh oh!

jasperhuangg left a comment

Uh oh!

jasperhuangg commented Jul 19, 2023

Uh oh!

jasperhuangg commented Jul 19, 2023

Uh oh!

OSBotify commented Jul 19, 2023

Uh oh!

OSBotify commented Jul 19, 2023

Uh oh!

OSBotify commented Jul 19, 2023

Uh oh!

OSBotify commented Jul 21, 2023

Uh oh!

OSBotify commented Jul 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

roryabraham commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests / QA Steps

Offline tests

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jul 18, 2023

Uh oh!

jasperhuangg left a comment

Choose a reason for hiding this comment

Uh oh!

jasperhuangg commented Jul 19, 2023

Uh oh!

jasperhuangg commented Jul 19, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Jul 19, 2023

Uh oh!

OSBotify commented Jul 19, 2023

Uh oh!

OSBotify commented Jul 19, 2023

Uh oh!

OSBotify commented Jul 21, 2023

Uh oh!

OSBotify commented Jul 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

roryabraham commented Jul 18, 2023 •

edited

Loading