Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit dddcae9a authored by Dave Mankoff's avatar Dave Mankoff
Browse files

Prevent recursive calls to proximity sensor. 

This CL contains two main changes:

1) If a caller asks an instance of ProximitySensor to alert its
listeners recursively, the call will be ignored.

2) The DozeSensors and DozeTriggers both use the same instance of
a ProximitySensor so that they can share each other's prox calls.

Also, a DelayableExecutor is now passed into ProximityCheck where
once we used a Handler in order to make testing easier.

Fixes: 152821688
Test: atest SystemUITests
Change-Id: I8be62222c4e2b586218696b1d8b6ac158ebeffb5
Merged-In: I8be62222c4e2b586218696b1d8b6ac158ebeffb5
parent ec4e1edb

packages/SystemUI/src/com/android/systemui/doze/DozeFactory.java

+9 −5
Original line number Original line Diff line number Diff line
@@ -34,6 +34,7 @@ import com.android.systemui.plugins.FalsingManager; 
import com.android.systemui.statusbar.phone.BiometricUnlockController;

import com.android.systemui.statusbar.phone.BiometricUnlockController;

import com.android.systemui.statusbar.phone.DozeParameters;

import com.android.systemui.statusbar.phone.DozeParameters;

import com.android.systemui.statusbar.policy.BatteryController;

import com.android.systemui.statusbar.policy.BatteryController;

import com.android.systemui.util.concurrency.DelayableExecutor;

import com.android.systemui.util.sensors.AsyncSensorManager;

import com.android.systemui.util.sensors.AsyncSensorManager;

import com.android.systemui.util.sensors.ProximitySensor;

import com.android.systemui.util.sensors.ProximitySensor;

import com.android.systemui.util.wakelock.DelayedWakeLock;

import com.android.systemui.util.wakelock.DelayedWakeLock;
@@ -56,6 +57,7 @@ public class DozeFactory { 
    private final ProximitySensor mProximitySensor;

    private final ProximitySensor mProximitySensor;

    private final DelayedWakeLock.Builder mDelayedWakeLockBuilder;

    private final DelayedWakeLock.Builder mDelayedWakeLockBuilder;

    private final Handler mHandler;

    private final Handler mHandler;

    private final DelayableExecutor mDelayableExecutor;

    private final BiometricUnlockController mBiometricUnlockController;

    private final BiometricUnlockController mBiometricUnlockController;

    private final BroadcastDispatcher mBroadcastDispatcher;

    private final BroadcastDispatcher mBroadcastDispatcher;

    private final DozeHost mDozeHost;

    private final DozeHost mDozeHost;
@@ -68,6 +70,7 @@ public class DozeFactory { 
            DockManager dockManager, @Nullable IWallpaperManager wallpaperManager,

            DockManager dockManager, @Nullable IWallpaperManager wallpaperManager,

            ProximitySensor proximitySensor,

            ProximitySensor proximitySensor,

            DelayedWakeLock.Builder delayedWakeLockBuilder, Handler handler,

            DelayedWakeLock.Builder delayedWakeLockBuilder, Handler handler,

            DelayableExecutor delayableExecutor,

            BiometricUnlockController biometricUnlockController,

            BiometricUnlockController biometricUnlockController,

            BroadcastDispatcher broadcastDispatcher, DozeHost dozeHost) {

            BroadcastDispatcher broadcastDispatcher, DozeHost dozeHost) {

        mFalsingManager = falsingManager;

        mFalsingManager = falsingManager;
@@ -83,6 +86,7 @@ public class DozeFactory { 
        mProximitySensor = proximitySensor;

        mProximitySensor = proximitySensor;

        mDelayedWakeLockBuilder = delayedWakeLockBuilder;

        mDelayedWakeLockBuilder = delayedWakeLockBuilder;

        mHandler = handler;

        mHandler = handler;

        mDelayableExecutor = delayableExecutor;

        mBiometricUnlockController = biometricUnlockController;

        mBiometricUnlockController = biometricUnlockController;

        mBroadcastDispatcher = broadcastDispatcher;

        mBroadcastDispatcher = broadcastDispatcher;

        mDozeHost = dozeHost;

        mDozeHost = dozeHost;
@@ -107,8 +111,8 @@ public class DozeFactory { 
                new DozePauser(mHandler, machine, mAlarmManager, mDozeParameters.getPolicy()),

                new DozePauser(mHandler, machine, mAlarmManager, mDozeParameters.getPolicy()),

                new DozeFalsingManagerAdapter(mFalsingManager),

                new DozeFalsingManagerAdapter(mFalsingManager),

                createDozeTriggers(dozeService, mAsyncSensorManager, mDozeHost,

                createDozeTriggers(dozeService, mAsyncSensorManager, mDozeHost,

                        mAlarmManager, config, mDozeParameters, mHandler, wakeLock, machine,

                        mAlarmManager, config, mDozeParameters, mDelayableExecutor, wakeLock,

                        mDockManager, mDozeLog),

                        machine, mDockManager, mDozeLog),

                createDozeUi(dozeService, mDozeHost, wakeLock, machine, mHandler,

                createDozeUi(dozeService, mDozeHost, wakeLock, machine, mHandler,

                        mAlarmManager, mDozeParameters, mDozeLog),

                        mAlarmManager, mDozeParameters, mDozeLog),

                new DozeScreenState(wrappedService, mHandler, mDozeHost, mDozeParameters,

                new DozeScreenState(wrappedService, mHandler, mDozeHost, mDozeParameters,
@@ -135,11 +139,11 @@ public class DozeFactory { 




    private DozeTriggers createDozeTriggers(Context context, AsyncSensorManager sensorManager,

    private DozeTriggers createDozeTriggers(Context context, AsyncSensorManager sensorManager,

            DozeHost host, AlarmManager alarmManager, AmbientDisplayConfiguration config,

            DozeHost host, AlarmManager alarmManager, AmbientDisplayConfiguration config,

            DozeParameters params, Handler handler, WakeLock wakeLock, DozeMachine machine,

            DozeParameters params, DelayableExecutor delayableExecutor, WakeLock wakeLock,

            DockManager dockManager, DozeLog dozeLog) {

            DozeMachine machine, DockManager dockManager, DozeLog dozeLog) {

        boolean allowPulseTriggers = true;

        boolean allowPulseTriggers = true;

        return new DozeTriggers(context, machine, host, alarmManager, config, params,

        return new DozeTriggers(context, machine, host, alarmManager, config, params,

                sensorManager, handler, wakeLock, allowPulseTriggers, dockManager,

                sensorManager, delayableExecutor, wakeLock, allowPulseTriggers, dockManager,

                mProximitySensor, dozeLog, mBroadcastDispatcher);

                mProximitySensor, dozeLog, mBroadcastDispatcher);





    }

    }

packages/SystemUI/src/com/android/systemui/doze/DozeSensors.java

+3 −2
Original line number Original line Diff line number Diff line
@@ -101,7 +101,8 @@ public class DozeSensors { 




    public DozeSensors(Context context, AlarmManager alarmManager, AsyncSensorManager sensorManager,

    public DozeSensors(Context context, AlarmManager alarmManager, AsyncSensorManager sensorManager,

            DozeParameters dozeParameters, AmbientDisplayConfiguration config, WakeLock wakeLock,

            DozeParameters dozeParameters, AmbientDisplayConfiguration config, WakeLock wakeLock,

            Callback callback, Consumer<Boolean> proxCallback, DozeLog dozeLog) {

            Callback callback, Consumer<Boolean> proxCallback, DozeLog dozeLog,

            ProximitySensor proximitySensor) {

        mContext = context;

        mContext = context;

        mAlarmManager = alarmManager;

        mAlarmManager = alarmManager;

        mSensorManager = sensorManager;

        mSensorManager = sensorManager;
@@ -111,6 +112,7 @@ public class DozeSensors { 
        mProxCallback = proxCallback;

        mProxCallback = proxCallback;

        mResolver = mContext.getContentResolver();

        mResolver = mContext.getContentResolver();

        mCallback = callback;

        mCallback = callback;

        mProximitySensor = proximitySensor;





        boolean alwaysOn = mConfig.alwaysOnEnabled(UserHandle.USER_CURRENT);

        boolean alwaysOn = mConfig.alwaysOnEnabled(UserHandle.USER_CURRENT);

        mSensors = new TriggerSensor[] {

        mSensors = new TriggerSensor[] {
@@ -173,7 +175,6 @@ public class DozeSensors { 
                        dozeLog),

                        dozeLog),

        };

        };





        mProximitySensor = new ProximitySensor(context.getResources(), sensorManager);

        setProxListening(false);  // Don't immediately start listening when we register.

        setProxListening(false);  // Don't immediately start listening when we register.

        mProximitySensor.register(

        mProximitySensor.register(

                proximityEvent -> {

                proximityEvent -> {

packages/SystemUI/src/com/android/systemui/doze/DozeTriggers.java

+6 −6
Original line number Original line Diff line number Diff line
@@ -26,7 +26,6 @@ import android.content.IntentFilter; 
import android.content.res.Configuration;

import android.content.res.Configuration;

import android.hardware.display.AmbientDisplayConfiguration;

import android.hardware.display.AmbientDisplayConfiguration;

import android.metrics.LogMaker;

import android.metrics.LogMaker;

import android.os.Handler;

import android.os.SystemClock;

import android.os.SystemClock;

import android.os.UserHandle;

import android.os.UserHandle;

import android.text.format.Formatter;

import android.text.format.Formatter;
@@ -43,6 +42,7 @@ import com.android.systemui.broadcast.BroadcastDispatcher; 
import com.android.systemui.dock.DockManager;

import com.android.systemui.dock.DockManager;

import com.android.systemui.statusbar.phone.DozeParameters;

import com.android.systemui.statusbar.phone.DozeParameters;

import com.android.systemui.util.Assert;

import com.android.systemui.util.Assert;

import com.android.systemui.util.concurrency.DelayableExecutor;

import com.android.systemui.util.sensors.AsyncSensorManager;

import com.android.systemui.util.sensors.AsyncSensorManager;

import com.android.systemui.util.sensors.ProximitySensor;

import com.android.systemui.util.sensors.ProximitySensor;

import com.android.systemui.util.wakelock.WakeLock;

import com.android.systemui.util.wakelock.WakeLock;
@@ -152,9 +152,9 @@ public class DozeTriggers implements DozeMachine.Part { 




    public DozeTriggers(Context context, DozeMachine machine, DozeHost dozeHost,

    public DozeTriggers(Context context, DozeMachine machine, DozeHost dozeHost,

            AlarmManager alarmManager, AmbientDisplayConfiguration config,

            AlarmManager alarmManager, AmbientDisplayConfiguration config,

            DozeParameters dozeParameters, AsyncSensorManager sensorManager, Handler handler,

            DozeParameters dozeParameters, AsyncSensorManager sensorManager,

            WakeLock wakeLock, boolean allowPulseTriggers, DockManager dockManager,

            DelayableExecutor delayableExecutor, WakeLock wakeLock, boolean allowPulseTriggers,

            ProximitySensor proximitySensor,

            DockManager dockManager, ProximitySensor proximitySensor,

            DozeLog dozeLog, BroadcastDispatcher broadcastDispatcher) {

            DozeLog dozeLog, BroadcastDispatcher broadcastDispatcher) {

        mContext = context;

        mContext = context;

        mMachine = machine;

        mMachine = machine;
@@ -165,10 +165,10 @@ public class DozeTriggers implements DozeMachine.Part { 
        mWakeLock = wakeLock;

        mWakeLock = wakeLock;

        mAllowPulseTriggers = allowPulseTriggers;

        mAllowPulseTriggers = allowPulseTriggers;

        mDozeSensors = new DozeSensors(context, alarmManager, mSensorManager, dozeParameters,

        mDozeSensors = new DozeSensors(context, alarmManager, mSensorManager, dozeParameters,

                config, wakeLock, this::onSensor, this::onProximityFar, dozeLog);

                config, wakeLock, this::onSensor, this::onProximityFar, dozeLog, proximitySensor);

        mUiModeManager = mContext.getSystemService(UiModeManager.class);

        mUiModeManager = mContext.getSystemService(UiModeManager.class);

        mDockManager = dockManager;

        mDockManager = dockManager;

        mProxCheck = new ProximitySensor.ProximityCheck(proximitySensor, handler);

        mProxCheck = new ProximitySensor.ProximityCheck(proximitySensor, delayableExecutor);

        mDozeLog = dozeLog;

        mDozeLog = dozeLog;

        mBroadcastDispatcher = broadcastDispatcher;

        mBroadcastDispatcher = broadcastDispatcher;

    }

    }

packages/SystemUI/src/com/android/systemui/util/sensors/ProximitySensor.java

+12 −6
Original line number Original line Diff line number Diff line
@@ -21,16 +21,17 @@ import android.hardware.Sensor; 
import android.hardware.SensorEvent;

import android.hardware.SensorEvent;

import android.hardware.SensorEventListener;

import android.hardware.SensorEventListener;

import android.hardware.SensorManager;

import android.hardware.SensorManager;

import android.os.Handler;

import android.util.Log;

import android.util.Log;





import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.annotations.VisibleForTesting;

import com.android.systemui.R;

import com.android.systemui.R;

import com.android.systemui.dagger.qualifiers.Main;

import com.android.systemui.dagger.qualifiers.Main;

import com.android.systemui.util.concurrency.DelayableExecutor;





import java.util.ArrayList;

import java.util.ArrayList;

import java.util.List;

import java.util.List;

import java.util.Locale;

import java.util.Locale;

import java.util.concurrent.atomic.AtomicBoolean;

import java.util.function.Consumer;

import java.util.function.Consumer;





import javax.inject.Inject;

import javax.inject.Inject;
@@ -49,8 +50,9 @@ public class ProximitySensor { 
    private String mTag = null;

    private String mTag = null;

    @VisibleForTesting ProximityEvent mLastEvent;

    @VisibleForTesting ProximityEvent mLastEvent;

    private int mSensorDelay = SensorManager.SENSOR_DELAY_NORMAL;

    private int mSensorDelay = SensorManager.SENSOR_DELAY_NORMAL;

    private boolean mPaused;

    @VisibleForTesting protected boolean mPaused;

    private boolean mRegistered;

    private boolean mRegistered;

    private final AtomicBoolean mAlerting = new AtomicBoolean();





    private SensorEventListener mSensorEventListener = new SensorEventListener() {

    private SensorEventListener mSensorEventListener = new SensorEventListener() {

        @Override

        @Override
@@ -217,8 +219,12 @@ public class ProximitySensor { 




    /** Update all listeners with the last value this class received from the sensor. */

    /** Update all listeners with the last value this class received from the sensor. */

    public void alertListeners() {

    public void alertListeners() {

        if (mAlerting.getAndSet(true)) {

            return;

        }

        mListeners.forEach(proximitySensorListener ->

        mListeners.forEach(proximitySensorListener ->

                proximitySensorListener.onSensorEvent(mLastEvent));

                proximitySensorListener.onSensorEvent(mLastEvent));

        mAlerting.set(false);

    }

    }





    private void onSensorEvent(SensorEvent event) {

    private void onSensorEvent(SensorEvent event) {
@@ -239,14 +245,14 @@ public class ProximitySensor { 
    public static class ProximityCheck implements Runnable {

    public static class ProximityCheck implements Runnable {





        private final ProximitySensor mSensor;

        private final ProximitySensor mSensor;

        private final Handler mHandler;

        private final DelayableExecutor mDelayableExecutor;

        private List<Consumer<Boolean>> mCallbacks = new ArrayList<>();

        private List<Consumer<Boolean>> mCallbacks = new ArrayList<>();





        @Inject

        @Inject

        public ProximityCheck(ProximitySensor sensor, Handler handler) {

        public ProximityCheck(ProximitySensor sensor, DelayableExecutor delayableExecutor) {

            mSensor = sensor;

            mSensor = sensor;

            mSensor.setTag("prox_check");

            mSensor.setTag("prox_check");

            mHandler = handler;

            mDelayableExecutor = delayableExecutor;

            mSensor.pause();

            mSensor.pause();

            ProximitySensorListener listener = proximityEvent -> {

            ProximitySensorListener listener = proximityEvent -> {

                mCallbacks.forEach(

                mCallbacks.forEach(
@@ -280,7 +286,7 @@ public class ProximitySensor { 
            mCallbacks.add(callback);

            mCallbacks.add(callback);

            if (!mSensor.isRegistered()) {

            if (!mSensor.isRegistered()) {

                mSensor.resume();

                mSensor.resume();

                mHandler.postDelayed(this, timeoutMs);

                mDelayableExecutor.executeDelayed(this, timeoutMs);

            }

            }

        }

        }

    }

    }

packages/SystemUI/tests/src/com/android/systemui/doze/DozeSensorsTest.java

+7 −6
Original line number Original line Diff line number Diff line
@@ -18,6 +18,7 @@ package com.android.systemui.doze; 




import static com.android.systemui.plugins.SensorManagerPlugin.Sensor.TYPE_WAKE_LOCK_SCREEN;

import static com.android.systemui.plugins.SensorManagerPlugin.Sensor.TYPE_WAKE_LOCK_SCREEN;





import static org.junit.Assert.assertFalse;

import static org.mockito.ArgumentMatchers.any;

import static org.mockito.ArgumentMatchers.any;

import static org.mockito.ArgumentMatchers.anyFloat;

import static org.mockito.ArgumentMatchers.anyFloat;

import static org.mockito.ArgumentMatchers.anyInt;

import static org.mockito.ArgumentMatchers.anyInt;
@@ -46,6 +47,7 @@ import com.android.systemui.doze.DozeSensors.TriggerSensor; 
import com.android.systemui.plugins.SensorManagerPlugin;

import com.android.systemui.plugins.SensorManagerPlugin;

import com.android.systemui.statusbar.phone.DozeParameters;

import com.android.systemui.statusbar.phone.DozeParameters;

import com.android.systemui.util.sensors.AsyncSensorManager;

import com.android.systemui.util.sensors.AsyncSensorManager;

import com.android.systemui.util.sensors.ProximitySensor;

import com.android.systemui.util.wakelock.WakeLock;

import com.android.systemui.util.wakelock.WakeLock;





import org.junit.Before;

import org.junit.Before;
@@ -82,7 +84,7 @@ public class DozeSensorsTest extends SysuiTestCase { 
    @Mock

    @Mock

    private DozeLog mDozeLog;

    private DozeLog mDozeLog;

    @Mock

    @Mock

    private Sensor mProximitySensor;

    private ProximitySensor mProximitySensor;

    private SensorManagerPlugin.SensorEventListener mWakeLockScreenListener;

    private SensorManagerPlugin.SensorEventListener mWakeLockScreenListener;

    private TestableLooper mTestableLooper;

    private TestableLooper mTestableLooper;

    private DozeSensors mDozeSensors;

    private DozeSensors mDozeSensors;
@@ -93,7 +95,6 @@ public class DozeSensorsTest extends SysuiTestCase { 
        mTestableLooper = TestableLooper.get(this);

        mTestableLooper = TestableLooper.get(this);

        when(mAmbientDisplayConfiguration.getWakeLockScreenDebounce()).thenReturn(5000L);

        when(mAmbientDisplayConfiguration.getWakeLockScreenDebounce()).thenReturn(5000L);

        when(mAmbientDisplayConfiguration.alwaysOnEnabled(anyInt())).thenReturn(true);

        when(mAmbientDisplayConfiguration.alwaysOnEnabled(anyInt())).thenReturn(true);

        when(mSensorManager.getDefaultSensor(Sensor.TYPE_PROXIMITY)).thenReturn(mProximitySensor);

        doAnswer(invocation -> {

        doAnswer(invocation -> {

            ((Runnable) invocation.getArgument(0)).run();

            ((Runnable) invocation.getArgument(0)).run();

            return null;

            return null;
@@ -103,10 +104,9 @@ public class DozeSensorsTest extends SysuiTestCase { 




    @Test

    @Test

    public void testRegisterProx() {

    public void testRegisterProx() {

        // We should not register with the sensor manager initially.

        assertFalse(mProximitySensor.isRegistered());

        verify(mSensorManager, never()).registerListener(any(), any(Sensor.class), anyInt());

        mDozeSensors.setProxListening(true);

        mDozeSensors.setProxListening(true);

        verify(mSensorManager).registerListener(any(), any(Sensor.class), anyInt());

        verify(mProximitySensor).resume();

    }

    }





    @Test

    @Test
@@ -169,7 +169,8 @@ public class DozeSensorsTest extends SysuiTestCase { 




        TestableDozeSensors() {

        TestableDozeSensors() {

            super(getContext(), mAlarmManager, mSensorManager, mDozeParameters,

            super(getContext(), mAlarmManager, mSensorManager, mDozeParameters,

                    mAmbientDisplayConfiguration, mWakeLock, mCallback, mProxCallback, mDozeLog);

                    mAmbientDisplayConfiguration, mWakeLock, mCallback, mProxCallback, mDozeLog,

                    mProximitySensor);

            for (TriggerSensor sensor : mSensors) {

            for (TriggerSensor sensor : mSensors) {

                if (sensor instanceof PluginSensor

                if (sensor instanceof PluginSensor

                        && ((PluginSensor) sensor).mPluginSensor.getType()

                        && ((PluginSensor) sensor).mPluginSensor.getType()