Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Aug 28, 2024
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b74651
Prevent Lottie from running in the background after navigating to oth…
QichenZhu Aug 24, 2024
7c52b62
Fix lint errors
QichenZhu Aug 24, 2024
d8fb8c5
Fix lint errors
QichenZhu Aug 24, 2024
7899770
Rename unsubscription functions
QichenZhu Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion src/components/Lottie/index.tsx
View file
Open in desktop
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);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.​

}
});
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
Loading