Fix IntentReceiver leaked on Sound & vibration

The root cause is that PreferenceController migrated to Catalyst will be
removed by DashboardFragment and VolumeSeekBarPreferenceController
onPause() is not invoked.

NO_IFTTT=Controller only

Fix: 386162594
Flag: EXEMPT bugfix
Test: atest&manual
Change-Id: I13f8588c8259ed4ddb9895ffc60e209c99c05269
This commit is contained in:
Jacky Wang
2025-01-24 15:24:23 +08:00
parent a7fa6efe8f
commit 402e5bb38b
8 changed files with 62 additions and 106 deletions

View File

@@ -28,17 +28,18 @@ import android.os.Message;
import android.service.notification.NotificationListenerService;
import android.view.View;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.annotation.NonNull;
import androidx.lifecycle.DefaultLifecycleObserver;
import androidx.lifecycle.LifecycleOwner;
import androidx.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settingslib.core.lifecycle.Lifecycle;
/**
* Update notification volume icon in Settings in response to user adjusting volume.
*/
public class NotificationVolumePreferenceController extends
RingerModeAffectedVolumePreferenceController {
RingerModeAffectedVolumePreferenceController implements DefaultLifecycleObserver {
private static final String KEY_NOTIFICATION_VOLUME = "notification_volume";
private static final String TAG = "NotificationVolumePreferenceController";
@@ -80,17 +81,13 @@ public class NotificationVolumePreferenceController extends
updateEnabledState();
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
@Override
public void onResume() {
super.onResume();
public void onResume(@NonNull LifecycleOwner owner) {
mReceiver.register(true);
}
@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
@Override
public void onPause() {
super.onPause();
public void onPause(@NonNull LifecycleOwner owner) {
mReceiver.register(false);
}

View File

@@ -49,8 +49,7 @@ public class RemoteVolumeSeekBarPreference extends VolumeSeekBarPreference {
}
@Override
protected void init() {
if (mSeekBar == null) return;
protected void onBindViewHolder() {
setContinuousUpdates(true);
updateIconView();
updateSuppressionText();

View File

@@ -27,16 +27,17 @@ import android.os.Looper;
import android.os.Message;
import android.service.notification.NotificationListenerService;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.annotation.NonNull;
import androidx.lifecycle.DefaultLifecycleObserver;
import androidx.lifecycle.LifecycleOwner;
import com.android.settings.R;
import com.android.settingslib.core.lifecycle.Lifecycle;
/**
* This slider represents both ring and notification
*/
public class RingVolumePreferenceController extends
RingerModeAffectedVolumePreferenceController {
RingerModeAffectedVolumePreferenceController implements DefaultLifecycleObserver {
private static final String KEY_RING_VOLUME = "ring_volume";
private static final String TAG = "RingVolumePreferenceController";
@@ -58,10 +59,8 @@ public class RingVolumePreferenceController extends
updateRingerMode();
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
@Override
public void onResume() {
super.onResume();
public void onResume(@NonNull LifecycleOwner owner) {
mReceiver.register(true);
updateEffectsSuppressor();
selectPreferenceIconState();
@@ -71,10 +70,8 @@ public class RingVolumePreferenceController extends
}
}
@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
@Override
public void onPause() {
super.onPause();
public void onPause(@NonNull LifecycleOwner owner) {
mReceiver.register(false);
}

View File

@@ -27,17 +27,18 @@ import android.os.Looper;
import android.os.Message;
import android.service.notification.NotificationListenerService;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.annotation.NonNull;
import androidx.lifecycle.DefaultLifecycleObserver;
import androidx.lifecycle.LifecycleOwner;
import com.android.settings.R;
import com.android.settingslib.core.lifecycle.Lifecycle;
/**
* This slider is used to represent ring volume when ring is separated from notification
*/
// LINT.IfChange
public class SeparateRingVolumePreferenceController extends
RingerModeAffectedVolumePreferenceController {
RingerModeAffectedVolumePreferenceController implements DefaultLifecycleObserver {
private static final String KEY_SEPARATE_RING_VOLUME = "separate_ring_volume";
private static final String TAG = "SeparateRingVolumePreferenceController";
@@ -59,10 +60,8 @@ public class SeparateRingVolumePreferenceController extends
updateRingerMode();
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
@Override
public void onResume() {
super.onResume();
public void onResume(@NonNull LifecycleOwner owner) {
mReceiver.register(true);
updateEffectsSuppressor();
selectPreferenceIconState();
@@ -73,10 +72,8 @@ public class SeparateRingVolumePreferenceController extends
}
}
@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
@Override
public void onPause() {
super.onPause();
public void onPause(@NonNull LifecycleOwner owner) {
mReceiver.register(false);
}

View File

@@ -62,7 +62,6 @@ public class VolumeSeekBarPreference extends SeekBarPreference {
private boolean mZenMuted;
private int mIconResId;
private int mMuteIconResId;
private boolean mStopped;
@VisibleForTesting
AudioManager mAudioManager;
private Locale mLocale;
@@ -114,18 +113,13 @@ public class VolumeSeekBarPreference extends SeekBarPreference {
mListener = listener;
}
public void onActivityResume() {
if (mStopped) {
init();
}
}
public void onActivityPause() {
mStopped = true;
@Override
public void onDetached() {
if (mVolumizer != null) {
mVolumizer.stop();
mVolumizer = null;
}
super.onDetached();
}
@Override
@@ -135,16 +129,25 @@ public class VolumeSeekBarPreference extends SeekBarPreference {
mIconView = (ImageView) view.findViewById(com.android.internal.R.id.icon);
mSuppressionTextView = (TextView) view.findViewById(R.id.suppression_text);
mTitle = (TextView) view.findViewById(com.android.internal.R.id.title);
init();
onBindViewHolder();
}
protected void init() {
if (mSeekBar == null) return;
// It's unnecessary to set up relevant volumizer configuration if preference is disabled.
if (!isEnabled()) {
mSeekBar.setEnabled(false);
return;
protected void onBindViewHolder() {
boolean isEnabled = isEnabled();
mSeekBar.setEnabled(isEnabled);
if (mVolumizer == null) {
createSeekBarVolumizer();
}
mVolumizer.setSeekBar(mSeekBar);
updateIconView();
updateSuppressionText();
if (isEnabled && mListener != null) {
mListener.onUpdateMuteState();
}
}
@SuppressWarnings("NullAway")
protected void createSeekBarVolumizer() {
final SeekBarVolumizer.Callback sbvc = new SeekBarVolumizer.Callback() {
@Override
public void onSampleStarting(SeekBarVolumizer sbv) {
@@ -184,16 +187,8 @@ public class VolumeSeekBarPreference extends SeekBarPreference {
}
};
final Uri sampleUri = mStream == AudioManager.STREAM_MUSIC ? getMediaVolumeUri() : null;
if (mVolumizer == null) {
mVolumizer = mSeekBarVolumizerFactory.create(mStream, sampleUri, sbvc);
}
mVolumizer = mSeekBarVolumizerFactory.create(mStream, sampleUri, sbvc);
mVolumizer.start();
mVolumizer.setSeekBar(mSeekBar);
updateIconView();
updateSuppressionText();
if (mListener != null) {
mListener.onUpdateMuteState();
}
}
protected void updateIconView() {

View File

@@ -19,18 +19,15 @@ package com.android.settings.notification;
import android.content.Context;
import androidx.annotation.VisibleForTesting;
import androidx.lifecycle.LifecycleObserver;
import androidx.lifecycle.OnLifecycleEvent;
import androidx.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settingslib.core.lifecycle.Lifecycle;
/**
* Base class for preference controller that handles VolumeSeekBarPreference
*/
public abstract class VolumeSeekBarPreferenceController extends
AdjustVolumeRestrictedPreferenceController implements LifecycleObserver {
AdjustVolumeRestrictedPreferenceController {
protected VolumeSeekBarPreference mPreference;
protected AudioHelper mHelper;
@@ -61,20 +58,6 @@ public abstract class VolumeSeekBarPreferenceController extends
mPreference.setMuteIcon(getMuteIcon());
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
public void onResume() {
if (mPreference != null) {
mPreference.onActivityResume();
}
}
@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
public void onPause() {
if (mPreference != null) {
mPreference.onActivityPause();
}
}
@Override
public int getSliceHighlightMenuRes() {
return R.string.menu_key_sound;

View File

@@ -88,24 +88,6 @@ public class VolumeSeekBarPreferenceControllerTest {
verify(mPreference, never()).setListener(mListener);
}
@Test
public void onResume_shouldResumePreference() {
mController.displayPreference(mScreen);
mController.onResume();
verify(mPreference).onActivityResume();
}
@Test
public void onPause_shouldPausePreference() {
mController.displayPreference(mScreen);
mController.onPause();
verify(mPreference).onActivityPause();
}
@Test
public void sliderMethods_handleNullPreference() {
when(mHelper.getStreamVolume(mController.getAudioStream())).thenReturn(4);

View File

@@ -32,12 +32,14 @@ import android.preference.SeekBarVolumizer;
import android.widget.SeekBar;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.robolectric.RobolectricTestRunner;
import java.util.Locale;
@@ -47,6 +49,10 @@ public class VolumeSeekBarPreferenceTest {
private static final CharSequence CONTENT_DESCRIPTION = "TEST";
private static final int STREAM = 5;
@Rule
public final MockitoRule mMockitoRule = MockitoJUnit.rule();
@Mock
private AudioManager mAudioManager;
@Mock
@@ -70,10 +76,10 @@ public class VolumeSeekBarPreferenceTest {
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
when(mContext.getSystemService(Context.AUDIO_SERVICE)).thenReturn(mAudioManager);
when(mSeekBarVolumizerFactory.create(eq(STREAM), eq(null), mSbvc.capture()))
.thenReturn(mVolumizer);
doCallRealMethod().when(mPreference).createSeekBarVolumizer();
doCallRealMethod().when(mPreference).setStream(anyInt());
doCallRealMethod().when(mPreference).updateContentDescription(CONTENT_DESCRIPTION);
mPreference.mSeekBar = mSeekBar;
@@ -99,50 +105,50 @@ public class VolumeSeekBarPreferenceTest {
}
@Test
public void init_listenerIsCalled() {
public void onBindViewHolder_listenerIsCalled() {
when(mPreference.isEnabled()).thenReturn(true);
doCallRealMethod().when(mPreference).setListener(mListener);
doCallRealMethod().when(mPreference).init();
doCallRealMethod().when(mPreference).onBindViewHolder();
mPreference.setStream(STREAM);
mPreference.setListener(mListener);
mPreference.init();
mPreference.onBindViewHolder();
verify(mPreference).updateContentDescription(CONTENT_DESCRIPTION);
}
@Test
public void init_listenerNotSet_noException() {
public void onBindViewHolder_listenerNotSet_noException() {
when(mPreference.isEnabled()).thenReturn(true);
doCallRealMethod().when(mPreference).init();
doCallRealMethod().when(mPreference).onBindViewHolder();
mPreference.setStream(STREAM);
mPreference.init();
mPreference.onBindViewHolder();
verify(mPreference, never()).updateContentDescription(CONTENT_DESCRIPTION);
}
@Test
public void init_preferenceIsDisabled_shouldNotInvokeListener() {
public void onBindViewHolder_preferenceIsDisabled_shouldNotInvokeListener() {
when(mPreference.isEnabled()).thenReturn(false);
doCallRealMethod().when(mPreference).setListener(mListener);
doCallRealMethod().when(mPreference).init();
doCallRealMethod().when(mPreference).onBindViewHolder();
mPreference.setStream(STREAM);
mPreference.init();
mPreference.onBindViewHolder();
verify(mPreference, never()).updateContentDescription(CONTENT_DESCRIPTION);
}
@Test
public void init_changeProgress_overrideStateDescriptionCalled() {
public void onBindViewHolder_changeProgress_overrideStateDescriptionCalled() {
final int progress = 4;
when(mPreference.isEnabled()).thenReturn(true);
when(mPreference.formatStateDescription(progress)).thenReturn(CONTENT_DESCRIPTION);
doCallRealMethod().when(mPreference).init();
doCallRealMethod().when(mPreference).onBindViewHolder();
mPreference.setStream(STREAM);
mPreference.init();
mPreference.onBindViewHolder();
verify(mSeekBarVolumizerFactory).create(eq(STREAM), eq(null), mSbvc.capture());
@@ -166,10 +172,10 @@ public class VolumeSeekBarPreferenceTest {
when(mContext.getResources()).thenReturn(mRes);
when(mRes.getConfiguration()).thenReturn(mConfig);
when(mConfig.getLocales()).thenReturn(new LocaleList(Locale.US));
doCallRealMethod().when(mPreference).init();
doCallRealMethod().when(mPreference).onBindViewHolder();
mPreference.setStream(STREAM);
mPreference.init();
mPreference.onBindViewHolder();
verify(mSeekBarVolumizerFactory).create(eq(STREAM), eq(null), mSbvc.capture());