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.

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

Fix sensor listener leak on Android #3900

Merged
merged 1 commit into from
Jan 5, 2023
Merged

Conversation

graszka22
Copy link
Member

Summary

Fixes #3896

In the scenario presented in the issue every time the component was mounted two ReanimatedSensor were created: one was just initialized and the second one added to the hashmap. Then, when unregistering, only the second one was unregistered, the first one was kept registered. After some time the max limit of registered listeners is hit.

Test plan

import * as React from 'react';
import { Text, View, StyleSheet } from 'react-native';
import Constants from 'expo-constants';
import { useAnimatedSensor, SensorType } from 'react-native-reanimated';

export function BasicLayoutAnimation() {
  return (
    <View style={styles.container}>
      <Parent />
    </View>
  );
}

const Parent = () => {
  const [state, setState] = React.useState(0);

  React.useEffect(() => {
    setInterval(() => setState((prevState) => ++prevState), 100);
  }, []);
  return (
    <View style={[styles.container, styles.parent]}>
      <Text>Parent</Text>
      <Child />
    </View>
  );
};

const Child = () => {
  useAnimatedSensor(SensorType.MAGNETIC_FIELD, {
    interval: 2000,
  });
  const count = React.useRef(0);
  React.useEffect(() => {
    console.log('render count: ', ++count.current);
  });
  return (
    <View style={styles.container}>
      <Text>Child render: {count.current}</Text>
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    paddingTop: Constants.statusBarHeight,
    backgroundColor: '#ecf0f1',
    padding: 20,
  },
  parent: {
    backgroundColor: 'red',
  },
});

@graszka22 graszka22 requested a review from piaskowyk January 2, 2023 16:14
@ashuvssut
Copy link

will this fix be available in v2.13.1? or which package ver should I install to get this fix?

@tomekzaw
Copy link
Member

tomekzaw commented Jan 3, 2023

@ashuvssut We will ship this fix in 2.14.0 and 3.0.0-rc.10 next week.

@piaskowyk piaskowyk merged commit 07747fd into main Jan 5, 2023
@piaskowyk piaskowyk deleted the graszka22/fix-sensor-leak branch January 5, 2023 11:25
piaskowyk pushed a commit that referenced this pull request Jan 10, 2023
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect. -->

## Summary

Fixes #3896

In the scenario presented in the issue every time the component was mounted two `ReanimatedSensor` were created: one was just initialized and the second one added to the hashmap. Then, when unregistering, only the second one was unregistered, the first one was kept registered. After some time the max limit of registered listeners is hit. 

## Test plan

```js
import * as React from 'react';
import { Text, View, StyleSheet } from 'react-native';
import Constants from 'expo-constants';
import { useAnimatedSensor, SensorType } from 'react-native-reanimated';

export function BasicLayoutAnimation() {
  return (
    <View style={styles.container}>
      <Parent />
    </View>
  );
}

const Parent = () => {
  const [state, setState] = React.useState(0);

  React.useEffect(() => {
    setInterval(() => setState((prevState) => ++prevState), 100);
  }, []);
  return (
    <View style={[styles.container, styles.parent]}>
      <Text>Parent</Text>
      <Child />
    </View>
  );
};

const Child = () => {
  useAnimatedSensor(SensorType.MAGNETIC_FIELD, {
    interval: 2000,
  });
  const count = React.useRef(0);
  React.useEffect(() => {
    console.log('render count: ', ++count.current);
  });
  return (
    <View style={styles.container}>
      <Text>Child render: {count.current}</Text>
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    paddingTop: Constants.statusBarHeight,
    backgroundColor: '#ecf0f1',
    padding: 20,
  },
  parent: {
    backgroundColor: 'red',
  },
});

```
fluiddot pushed a commit to wordpress-mobile/react-native-reanimated that referenced this pull request Jun 5, 2023
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect. -->

## Summary

Fixes software-mansion#3896

In the scenario presented in the issue every time the component was mounted two `ReanimatedSensor` were created: one was just initialized and the second one added to the hashmap. Then, when unregistering, only the second one was unregistered, the first one was kept registered. After some time the max limit of registered listeners is hit. 

## Test plan

```js
import * as React from 'react';
import { Text, View, StyleSheet } from 'react-native';
import Constants from 'expo-constants';
import { useAnimatedSensor, SensorType } from 'react-native-reanimated';

export function BasicLayoutAnimation() {
  return (
    <View style={styles.container}>
      <Parent />
    </View>
  );
}

const Parent = () => {
  const [state, setState] = React.useState(0);

  React.useEffect(() => {
    setInterval(() => setState((prevState) => ++prevState), 100);
  }, []);
  return (
    <View style={[styles.container, styles.parent]}>
      <Text>Parent</Text>
      <Child />
    </View>
  );
};

const Child = () => {
  useAnimatedSensor(SensorType.MAGNETIC_FIELD, {
    interval: 2000,
  });
  const count = React.useRef(0);
  React.useEffect(() => {
    console.log('render count: ', ++count.current);
  });
  return (
    <View style={styles.container}>
      <Text>Child render: {count.current}</Text>
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    paddingTop: Constants.statusBarHeight,
    backgroundColor: '#ecf0f1',
    padding: 20,
  },
  parent: {
    backgroundColor: 'red',
  },
});

```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants