Cleanup listener reference in SmartAutoRotate

This will fix a memory leak caused by dangling SensorPrivacy listeners.

Test: opened/closed display and auto-rotate fragment and verified no
leaks in android studio profiler
Bug: 244382423

Change-Id: Ie2d070e796fa473e8f2794c9934c62edc4f7092c
This commit is contained in:
Abel Tesfaye
2022-09-01 02:35:07 +00:00
parent fd39906d62
commit febccc4990
4 changed files with 66 additions and 23 deletions

View File

@@ -16,6 +16,9 @@
package com.android.settings.display; package com.android.settings.display;
import static androidx.lifecycle.Lifecycle.Event.ON_START;
import static androidx.lifecycle.Lifecycle.Event.ON_STOP;
import static com.android.settings.display.SmartAutoRotateController.isRotationResolverServiceAvailable; import static com.android.settings.display.SmartAutoRotateController.isRotationResolverServiceAvailable;
import android.content.BroadcastReceiver; import android.content.BroadcastReceiver;
@@ -25,14 +28,13 @@ import android.content.IntentFilter;
import android.os.PowerManager; import android.os.PowerManager;
import androidx.annotation.VisibleForTesting; import androidx.annotation.VisibleForTesting;
import androidx.lifecycle.LifecycleObserver;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.preference.Preference; import androidx.preference.Preference;
import androidx.preference.PreferenceScreen; import androidx.preference.PreferenceScreen;
import com.android.settings.R; import com.android.settings.R;
import com.android.settings.core.BasePreferenceController; import com.android.settings.core.BasePreferenceController;
import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settingslib.core.lifecycle.events.OnStart;
import com.android.settingslib.core.lifecycle.events.OnStop;
import com.android.settingslib.widget.BannerMessagePreference; import com.android.settingslib.widget.BannerMessagePreference;
/** /**
@@ -40,7 +42,7 @@ import com.android.settingslib.widget.BannerMessagePreference;
* when battery saver mode is enabled. * when battery saver mode is enabled.
*/ */
public class SmartAutoRotateBatterySaverController extends BasePreferenceController implements public class SmartAutoRotateBatterySaverController extends BasePreferenceController implements
LifecycleObserver, OnStart, OnStop { LifecycleObserver {
private Preference mPreference; private Preference mPreference;
private final PowerManager mPowerManager; private final PowerManager mPowerManager;
@@ -76,13 +78,13 @@ public class SmartAutoRotateBatterySaverController extends BasePreferenceControl
}); });
} }
@Override @OnLifecycleEvent(ON_START)
public void onStart() { public void onStart() {
mContext.registerReceiver(mReceiver, mContext.registerReceiver(mReceiver,
new IntentFilter(PowerManager.ACTION_POWER_SAVE_MODE_CHANGED)); new IntentFilter(PowerManager.ACTION_POWER_SAVE_MODE_CHANGED));
} }
@Override @OnLifecycleEvent(ON_STOP)
public void onStop() { public void onStop() {
mContext.unregisterReceiver(mReceiver); mContext.unregisterReceiver(mReceiver);
} }

View File

@@ -19,11 +19,16 @@ package com.android.settings.display;
import static android.hardware.SensorPrivacyManager.Sensors.CAMERA; import static android.hardware.SensorPrivacyManager.Sensors.CAMERA;
import static android.hardware.SensorPrivacyManager.Sources.DIALOG; import static android.hardware.SensorPrivacyManager.Sources.DIALOG;
import static androidx.lifecycle.Lifecycle.Event.ON_START;
import static androidx.lifecycle.Lifecycle.Event.ON_STOP;
import static com.android.settings.display.SmartAutoRotateController.isRotationResolverServiceAvailable; import static com.android.settings.display.SmartAutoRotateController.isRotationResolverServiceAvailable;
import android.content.Context; import android.content.Context;
import android.hardware.SensorPrivacyManager; import android.hardware.SensorPrivacyManager;
import androidx.lifecycle.LifecycleObserver;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.preference.Preference; import androidx.preference.Preference;
import androidx.preference.PreferenceScreen; import androidx.preference.PreferenceScreen;
@@ -36,20 +41,37 @@ import com.android.settingslib.widget.BannerMessagePreference;
* The controller of camera based rotate privacy sensor warning preference. The preference appears * The controller of camera based rotate privacy sensor warning preference. The preference appears
* when the privacy sensor service disables camera functionality completely. * when the privacy sensor service disables camera functionality completely.
*/ */
public class SmartAutoRotateCameraStateController extends BasePreferenceController { public class SmartAutoRotateCameraStateController extends BasePreferenceController implements
LifecycleObserver {
private final SensorPrivacyManager mPrivacyManager; private final SensorPrivacyManager mPrivacyManager;
private Preference mPreference; private Preference mPreference;
private final SensorPrivacyManager.OnSensorPrivacyChangedListener mPrivacyChangedListener =
new SensorPrivacyManager.OnSensorPrivacyChangedListener() {
@Override
public void onSensorPrivacyChanged(int sensor, boolean enabled) {
if (mPreference != null) {
mPreference.setVisible(isAvailable());
}
updateState(mPreference);
}
};
public SmartAutoRotateCameraStateController(Context context, String key) { public SmartAutoRotateCameraStateController(Context context, String key) {
super(context, key); super(context, key);
mPrivacyManager = SensorPrivacyManager.getInstance(context); mPrivacyManager = SensorPrivacyManager.getInstance(context);
mPrivacyManager.addSensorPrivacyListener(CAMERA, (sensor, enabled) -> { }
if (mPreference != null) {
mPreference.setVisible(isAvailable()); @OnLifecycleEvent(ON_START)
} public void onStart() {
updateState(mPreference); mPrivacyManager.addSensorPrivacyListener(CAMERA, mPrivacyChangedListener);
});
}
@OnLifecycleEvent(ON_STOP)
public void onStop() {
mPrivacyManager.removeSensorPrivacyListener(CAMERA, mPrivacyChangedListener);
} }
@VisibleForTesting @VisibleForTesting

View File

@@ -65,6 +65,15 @@ public class SmartAutoRotateController extends TogglePreferenceController implem
updateState(mPreference); updateState(mPreference);
} }
}; };
private final SensorPrivacyManager.OnSensorPrivacyChangedListener mPrivacyChangedListener =
new SensorPrivacyManager.OnSensorPrivacyChangedListener() {
@Override
public void onSensorPrivacyChanged(int sensor, boolean enabled) {
updateState(mPreference);
}
};
private final DeviceStateRotationLockSettingsManager mDeviceStateAutoRotateSettingsManager; private final DeviceStateRotationLockSettingsManager mDeviceStateAutoRotateSettingsManager;
private final DeviceStateRotationLockSettingsManager.DeviceStateRotationLockSettingsListener private final DeviceStateRotationLockSettingsManager.DeviceStateRotationLockSettingsListener
mDeviceStateRotationLockSettingsListener = () -> updateState(mPreference); mDeviceStateRotationLockSettingsListener = () -> updateState(mPreference);
@@ -74,8 +83,6 @@ public class SmartAutoRotateController extends TogglePreferenceController implem
super(context, preferenceKey); super(context, preferenceKey);
mMetricsFeatureProvider = FeatureFactory.getFactory(context).getMetricsFeatureProvider(); mMetricsFeatureProvider = FeatureFactory.getFactory(context).getMetricsFeatureProvider();
mPrivacyManager = SensorPrivacyManager.getInstance(context); mPrivacyManager = SensorPrivacyManager.getInstance(context);
mPrivacyManager
.addSensorPrivacyListener(CAMERA, (sensor, enabled) -> updateState(mPreference));
mPowerManager = context.getSystemService(PowerManager.class); mPowerManager = context.getSystemService(PowerManager.class);
mDeviceStateAutoRotateSettingsManager = DeviceStateRotationLockSettingsManager.getInstance( mDeviceStateAutoRotateSettingsManager = DeviceStateRotationLockSettingsManager.getInstance(
context); context);
@@ -134,6 +141,7 @@ public class SmartAutoRotateController extends TogglePreferenceController implem
RotationPolicy.registerRotationPolicyListener(mContext, mRotationPolicyListener); RotationPolicy.registerRotationPolicyListener(mContext, mRotationPolicyListener);
mDeviceStateAutoRotateSettingsManager.registerListener( mDeviceStateAutoRotateSettingsManager.registerListener(
mDeviceStateRotationLockSettingsListener); mDeviceStateRotationLockSettingsListener);
mPrivacyManager.addSensorPrivacyListener(CAMERA, mPrivacyChangedListener);
} }
@OnLifecycleEvent(ON_STOP) @OnLifecycleEvent(ON_STOP)
@@ -145,6 +153,7 @@ public class SmartAutoRotateController extends TogglePreferenceController implem
} }
mDeviceStateAutoRotateSettingsManager.unregisterListener( mDeviceStateAutoRotateSettingsManager.unregisterListener(
mDeviceStateRotationLockSettingsListener); mDeviceStateRotationLockSettingsListener);
mPrivacyManager.removeSensorPrivacyListener(CAMERA, mPrivacyChangedListener);
} }
@Override @Override

View File

@@ -19,6 +19,9 @@ package com.android.settings.display;
import static android.hardware.SensorPrivacyManager.Sensors.CAMERA; import static android.hardware.SensorPrivacyManager.Sensors.CAMERA;
import static android.provider.Settings.Secure.CAMERA_AUTOROTATE; import static android.provider.Settings.Secure.CAMERA_AUTOROTATE;
import static androidx.lifecycle.Lifecycle.Event.ON_START;
import static androidx.lifecycle.Lifecycle.Event.ON_STOP;
import static com.android.settings.display.SmartAutoRotateController.hasSufficientPermission; import static com.android.settings.display.SmartAutoRotateController.hasSufficientPermission;
import static com.android.settings.display.SmartAutoRotateController.isRotationResolverServiceAvailable; import static com.android.settings.display.SmartAutoRotateController.isRotationResolverServiceAvailable;
@@ -33,6 +36,8 @@ import android.os.UserHandle;
import android.provider.Settings; import android.provider.Settings;
import android.text.TextUtils; import android.text.TextUtils;
import androidx.lifecycle.LifecycleObserver;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.preference.Preference; import androidx.preference.Preference;
import androidx.preference.PreferenceScreen; import androidx.preference.PreferenceScreen;
@@ -42,15 +47,12 @@ import com.android.settings.R;
import com.android.settings.core.TogglePreferenceController; import com.android.settings.core.TogglePreferenceController;
import com.android.settings.overlay.FeatureFactory; import com.android.settings.overlay.FeatureFactory;
import com.android.settingslib.core.instrumentation.MetricsFeatureProvider; import com.android.settingslib.core.instrumentation.MetricsFeatureProvider;
import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settingslib.core.lifecycle.events.OnStart;
import com.android.settingslib.core.lifecycle.events.OnStop;
/** /**
* SmartAutoRotatePreferenceController provides auto rotate summary in display settings * SmartAutoRotatePreferenceController provides auto rotate summary in display settings
*/ */
public class SmartAutoRotatePreferenceController extends TogglePreferenceController public class SmartAutoRotatePreferenceController extends TogglePreferenceController
implements LifecycleObserver, OnStart, OnStop { implements LifecycleObserver {
private final MetricsFeatureProvider mMetricsFeatureProvider; private final MetricsFeatureProvider mMetricsFeatureProvider;
private final SensorPrivacyManager mPrivacyManager; private final SensorPrivacyManager mPrivacyManager;
@@ -62,14 +64,20 @@ public class SmartAutoRotatePreferenceController extends TogglePreferenceControl
} }
}; };
private final SensorPrivacyManager.OnSensorPrivacyChangedListener mPrivacyChangedListener =
new SensorPrivacyManager.OnSensorPrivacyChangedListener() {
@Override
public void onSensorPrivacyChanged(int sensor, boolean enabled) {
refreshSummary(mPreference);
}
};
private RotationPolicy.RotationPolicyListener mRotationPolicyListener; private RotationPolicy.RotationPolicyListener mRotationPolicyListener;
private Preference mPreference; private Preference mPreference;
public SmartAutoRotatePreferenceController(Context context, String preferenceKey) { public SmartAutoRotatePreferenceController(Context context, String preferenceKey) {
super(context, preferenceKey); super(context, preferenceKey);
mPrivacyManager = SensorPrivacyManager.getInstance(context); mPrivacyManager = SensorPrivacyManager.getInstance(context);
mPrivacyManager
.addSensorPrivacyListener(CAMERA, (sensor, enabled) -> refreshSummary(mPreference));
mPowerManager = context.getSystemService(PowerManager.class); mPowerManager = context.getSystemService(PowerManager.class);
mMetricsFeatureProvider = FeatureFactory.getFactory(context).getMetricsFeatureProvider(); mMetricsFeatureProvider = FeatureFactory.getFactory(context).getMetricsFeatureProvider();
} }
@@ -108,7 +116,7 @@ public class SmartAutoRotatePreferenceController extends TogglePreferenceControl
refreshSummary(mPreference); refreshSummary(mPreference);
} }
@Override @OnLifecycleEvent(ON_START)
public void onStart() { public void onStart() {
mContext.registerReceiver(mReceiver, mContext.registerReceiver(mReceiver,
new IntentFilter(PowerManager.ACTION_POWER_SAVE_MODE_CHANGED)); new IntentFilter(PowerManager.ACTION_POWER_SAVE_MODE_CHANGED));
@@ -124,15 +132,17 @@ public class SmartAutoRotatePreferenceController extends TogglePreferenceControl
} }
RotationPolicy.registerRotationPolicyListener(mContext, RotationPolicy.registerRotationPolicyListener(mContext,
mRotationPolicyListener); mRotationPolicyListener);
mPrivacyManager.addSensorPrivacyListener(CAMERA, mPrivacyChangedListener);
} }
@Override @OnLifecycleEvent(ON_STOP)
public void onStop() { public void onStop() {
mContext.unregisterReceiver(mReceiver); mContext.unregisterReceiver(mReceiver);
if (mRotationPolicyListener != null) { if (mRotationPolicyListener != null) {
RotationPolicy.unregisterRotationPolicyListener(mContext, RotationPolicy.unregisterRotationPolicyListener(mContext,
mRotationPolicyListener); mRotationPolicyListener);
} }
mPrivacyManager.removeSensorPrivacyListener(CAMERA, mPrivacyChangedListener);
} }
/** /**