Skip to content

Commit

Permalink
Merge pull request #47960 from QichenZhu/fix/47273
Browse files Browse the repository at this point in the history
Prevent Lottie from running in the background after navigating to other pages
  • Loading branch information
aldo-expensify authored Aug 28, 2024
2 parents ac5ee2e + 7899770 commit 83a8501
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion src/components/Lottie/index.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import {useNavigation} from '@react-navigation/native';
import type {AnimationObject, LottieViewProps} from 'lottie-react-native';
import LottieView from 'lottie-react-native';
import type {ForwardedRef} from 'react';
Expand All @@ -8,6 +9,7 @@ import useAppState from '@hooks/useAppState';
import useNetwork from '@hooks/useNetwork';
import useSplashScreen from '@hooks/useSplashScreen';
import useThemeStyles from '@hooks/useThemeStyles';
import NAVIGATORS from '@src/NAVIGATORS';

type Props = {
source: DotLottieAnimation;
Expand All @@ -18,6 +20,8 @@ function Lottie({source, webStyle, ...props}: Props, ref: ForwardedRef<LottieVie
const {isSplashHidden} = useSplashScreen();
const styles = useThemeStyles();
const [isError, setIsError] = React.useState(false);
const [isHidden, setIsHidden] = React.useState(false);
const navigation = useNavigation();

useNetwork({onReconnect: () => setIsError(false)});

Expand All @@ -27,13 +31,33 @@ function Lottie({source, webStyle, ...props}: Props, ref: ForwardedRef<LottieVie
setAnimationFile(source.file);
}, [setAnimationFile, source.file]);

useEffect(() => {
const unsubscribeNavigationFocus = navigation.addListener('focus', () => {
setIsHidden(false);
});
return unsubscribeNavigationFocus;
}, [navigation]);

// Prevent the animation from running in the background after navigating to other pages.
// See https://github.com/Expensify/App/issues/47273
useEffect(() => {
const unsubscribeNavigationBlur = navigation.addListener('blur', () => {
const state = navigation.getState();
const targetRouteName = state?.routes?.[state?.index ?? 0]?.name;
if (targetRouteName !== NAVIGATORS.RIGHT_MODAL_NAVIGATOR) {
setIsHidden(true);
}
});
return unsubscribeNavigationBlur;
}, [navigation]);

const aspectRatioStyle = styles.aspectRatioLottie(source);

// If the image fails to load, app is in background state, animation file isn't ready, or the splash screen isn't hidden yet,
// we'll just render an empty view as the fallback to prevent
// 1. memory leak, see issue: https://github.com/Expensify/App/issues/36645
// 2. heavy rendering, see issue: https://github.com/Expensify/App/issues/34696
if (isError || appState.isBackground || !animationFile || !isSplashHidden) {
if (isError || isHidden || appState.isBackground || !animationFile || !isSplashHidden) {
return <View style={[aspectRatioStyle, props.style]} />;
}

Expand Down

0 comments on commit 83a8501

Please sign in to comment.