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

Commit ae8b5952 authored by Ben Murdoch's avatar Ben Murdoch
Browse files

Update physical keyboard shortcut for taking bugreport. 

The shortcut moves from shift+MENU to META+CTRL+Backspace. Remove
the legacy handling of the shift+MENU combination as it doesn't
work anyway.

Fixes a test issue where using the flag checking rule would trigger an
assert from AccessibilityManager. The flag checker activates UI
Automation which in turn, activates the Accessibility Service. Prior
to this change, the tests relied on the fact that Accessibility was off
by default. To work around this, we disable AccessibilityManager
explicitly in TestPhoneWindowManager.

Bug: 335607520
Flag: com.android.server.flags.new_bugreport_keyboard_shortcut
Test: atest ModifierShortcutTests WmTests:com.android.server.policy.ShortcutLoggingTests
Change-Id: Icdcf49c6d20bded85a4376fa731799fbe3060d51
parent 81f6b5c6

services/core/java/com/android/server/policy/PhoneWindowManager.java

+18 −18
Original line number Original line Diff line number Diff line
@@ -76,6 +76,7 @@ import static android.view.WindowManagerGlobal.ADD_PERMISSION_DENIED; 
import static android.view.contentprotection.flags.Flags.createAccessibilityOverlayAppOpEnabled;

import static android.view.contentprotection.flags.Flags.createAccessibilityOverlayAppOpEnabled;





import static com.android.hardware.input.Flags.emojiAndScreenshotKeycodesAvailable;

import static com.android.hardware.input.Flags.emojiAndScreenshotKeycodesAvailable;

import static com.android.server.flags.Flags.newBugreportKeyboardShortcut;

import static com.android.internal.config.sysui.SystemUiDeviceConfigFlags.SCREENSHOT_KEYCHORD_DELAY;

import static com.android.internal.config.sysui.SystemUiDeviceConfigFlags.SCREENSHOT_KEYCHORD_DELAY;

import static com.android.server.policy.WindowManagerPolicy.WindowManagerFuncs.CAMERA_LENS_COVERED;

import static com.android.server.policy.WindowManagerPolicy.WindowManagerFuncs.CAMERA_LENS_COVERED;

import static com.android.server.policy.WindowManagerPolicy.WindowManagerFuncs.CAMERA_LENS_COVER_ABSENT;

import static com.android.server.policy.WindowManagerPolicy.WindowManagerFuncs.CAMERA_LENS_COVER_ABSENT;
@@ -466,8 +467,8 @@ public class PhoneWindowManager implements WindowManagerPolicy { 
    // Assigned on main thread, accessed on UI thread

    // Assigned on main thread, accessed on UI thread

    volatile VrManagerInternal mVrManagerInternal;

    volatile VrManagerInternal mVrManagerInternal;





    /** If true, hitting shift & menu will broadcast Intent.ACTION_BUG_REPORT */

    /** If true, can use a keyboard shortcut to trigger a bugreport. */

    boolean mEnableShiftMenuBugReports = false;

    boolean mEnableBugReportKeyboardShortcut = false;





    /** Controller that supports enabling an AccessibilityService by holding down the volume keys */

    /** Controller that supports enabling an AccessibilityService by holding down the volume keys */

    private AccessibilityShortcutController mAccessibilityShortcutController;

    private AccessibilityShortcutController mAccessibilityShortcutController;
@@ -2303,7 +2304,7 @@ public class PhoneWindowManager implements WindowManagerPolicy { 
                "PhoneWindowManager.mBroadcastWakeLock");

                "PhoneWindowManager.mBroadcastWakeLock");

        mPowerKeyWakeLock = mPowerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK,

        mPowerKeyWakeLock = mPowerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK,

                "PhoneWindowManager.mPowerKeyWakeLock");

                "PhoneWindowManager.mPowerKeyWakeLock");

        mEnableShiftMenuBugReports = "1".equals(SystemProperties.get("ro.debuggable"));

        mEnableBugReportKeyboardShortcut = "1".equals(SystemProperties.get("ro.debuggable"));

        mLidKeyboardAccessibility = mContext.getResources().getInteger(

        mLidKeyboardAccessibility = mContext.getResources().getInteger(

                com.android.internal.R.integer.config_lidKeyboardAccessibility);

                com.android.internal.R.integer.config_lidKeyboardAccessibility);

        mLidNavigationAccessibility = mContext.getResources().getInteger(

        mLidNavigationAccessibility = mContext.getResources().getInteger(
@@ -2360,8 +2361,7 @@ public class PhoneWindowManager implements WindowManagerPolicy { 




        mDisplayFoldController = DisplayFoldController.create(mContext, DEFAULT_DISPLAY);

        mDisplayFoldController = DisplayFoldController.create(mContext, DEFAULT_DISPLAY);





        mAccessibilityManager = (AccessibilityManager) mContext.getSystemService(

        mAccessibilityManager = mContext.getSystemService(AccessibilityManager.class);

                Context.ACCESSIBILITY_SERVICE);





        // register for dock events

        // register for dock events

        IntentFilter filter = new IntentFilter();

        IntentFilter filter = new IntentFilter();
@@ -3409,19 +3409,6 @@ public class PhoneWindowManager implements WindowManagerPolicy { 
        switch (keyCode) {

        switch (keyCode) {

            case KeyEvent.KEYCODE_HOME:

            case KeyEvent.KEYCODE_HOME:

                return handleHomeShortcuts(focusedToken, event);

                return handleHomeShortcuts(focusedToken, event);

            case KeyEvent.KEYCODE_MENU:

                // Hijack modified menu keys for debugging features

                final int chordBug = KeyEvent.META_SHIFT_ON;



                if (mEnableShiftMenuBugReports && firstDown

                        && (metaState & chordBug) == chordBug) {

                    Intent intent = new Intent(Intent.ACTION_BUG_REPORT);

                    mContext.sendOrderedBroadcastAsUser(intent, UserHandle.CURRENT,

                            null, null, null, 0, null, null);

                    logKeyboardSystemsEvent(event, KeyboardLogEvent.TRIGGER_BUG_REPORT);

                    return true;

                }

                break;

            case KeyEvent.KEYCODE_RECENT_APPS:

            case KeyEvent.KEYCODE_RECENT_APPS:

                if (firstDown) {

                if (firstDown) {

                    showRecentApps(false /* triggeredFromAltTab */);

                    showRecentApps(false /* triggeredFromAltTab */);
@@ -3487,6 +3474,19 @@ public class PhoneWindowManager implements WindowManagerPolicy { 
                }

                }

                break;

                break;

            case KeyEvent.KEYCODE_DEL:

            case KeyEvent.KEYCODE_DEL:

                if (newBugreportKeyboardShortcut()) {

                    if (mEnableBugReportKeyboardShortcut && firstDown

                            && event.isMetaPressed() && event.isCtrlPressed()) {

                        try {

                            mActivityManagerService.requestInteractiveBugReport();

                        } catch (RemoteException e) {

                            Slog.d(TAG, "Error taking bugreport", e);

                        }

                        logKeyboardSystemsEvent(event, KeyboardLogEvent.TRIGGER_BUG_REPORT);

                        return true;

                    }

                }

                // fall through

            case KeyEvent.KEYCODE_ESCAPE:

            case KeyEvent.KEYCODE_ESCAPE:

                if (firstDown && event.isMetaPressed()) {

                if (firstDown && event.isMetaPressed()) {

                    logKeyboardSystemsEvent(event, KeyboardLogEvent.BACK);

                    logKeyboardSystemsEvent(event, KeyboardLogEvent.BACK);

services/tests/wmtests/AndroidManifest.xml

+1 −0
Original line number Original line Diff line number Diff line
@@ -51,6 +51,7 @@ 
    <uses-permission android:name="android.permission.MONITOR_INPUT"/>

    <uses-permission android:name="android.permission.MONITOR_INPUT"/>

    <uses-permission android:name="android.permission.OBSERVE_ROLE_HOLDERS"/>

    <uses-permission android:name="android.permission.OBSERVE_ROLE_HOLDERS"/>

    <uses-permission android:name="android.permission.MANAGE_DEFAULT_APPLICATIONS"/>

    <uses-permission android:name="android.permission.MANAGE_DEFAULT_APPLICATIONS"/>

    <uses-permission android:name="android.permission.DUMP"/>





    <!-- TODO: Remove largeHeap hack when memory leak is fixed (b/123984854) -->

    <!-- TODO: Remove largeHeap hack when memory leak is fixed (b/123984854) -->

    <application android:debuggable="true"

    <application android:debuggable="true"

services/tests/wmtests/src/com/android/server/policy/ModifierShortcutTests.java

+31 −0
Original line number Original line Diff line number Diff line
@@ -21,6 +21,7 @@ import static android.view.KeyEvent.KEYCODE_B; 
import static android.view.KeyEvent.KEYCODE_BRIGHTNESS_DOWN;

import static android.view.KeyEvent.KEYCODE_BRIGHTNESS_DOWN;

import static android.view.KeyEvent.KEYCODE_C;

import static android.view.KeyEvent.KEYCODE_C;

import static android.view.KeyEvent.KEYCODE_CTRL_LEFT;

import static android.view.KeyEvent.KEYCODE_CTRL_LEFT;

import static android.view.KeyEvent.KEYCODE_DEL;

import static android.view.KeyEvent.KEYCODE_E;

import static android.view.KeyEvent.KEYCODE_E;

import static android.view.KeyEvent.KEYCODE_ENTER;

import static android.view.KeyEvent.KEYCODE_ENTER;

import static android.view.KeyEvent.KEYCODE_H;

import static android.view.KeyEvent.KEYCODE_H;
@@ -42,16 +43,25 @@ import android.app.role.RoleManager; 
import android.content.Intent;

import android.content.Intent;

import android.os.RemoteException;

import android.os.RemoteException;

import android.platform.test.annotations.Presubmit;

import android.platform.test.annotations.Presubmit;

import android.platform.test.annotations.RequiresFlagsDisabled;

import android.platform.test.annotations.RequiresFlagsEnabled;

import android.platform.test.flag.junit.CheckFlagsRule;

import android.platform.test.flag.junit.DeviceFlagsValueProvider;

import android.util.SparseArray;

import android.util.SparseArray;





import androidx.test.filters.SmallTest;

import androidx.test.filters.SmallTest;





import org.junit.Before;

import org.junit.Before;

import org.junit.Rule;

import org.junit.Test;

import org.junit.Test;





@Presubmit

@Presubmit

@SmallTest

@SmallTest

public class ModifierShortcutTests extends ShortcutKeyTestBase {

public class ModifierShortcutTests extends ShortcutKeyTestBase {



    @Rule

    public final CheckFlagsRule mCheckFlagsRule = DeviceFlagsValueProvider.createCheckFlagsRule();



    private static final SparseArray<String> INTENT_SHORTCUTS =  new SparseArray<>();

    private static final SparseArray<String> INTENT_SHORTCUTS =  new SparseArray<>();

    private static final SparseArray<String> ROLE_SHORTCUTS =  new SparseArray<>();

    private static final SparseArray<String> ROLE_SHORTCUTS =  new SparseArray<>();

    static {

    static {
@@ -228,4 +238,25 @@ public class ModifierShortcutTests extends ShortcutKeyTestBase { 
        sendKeyCombination(new int[]{KEYCODE_SCREENSHOT}, 0);

        sendKeyCombination(new int[]{KEYCODE_SCREENSHOT}, 0);

        mPhoneWindowManager.assertTakeScreenshotNotCalled();

        mPhoneWindowManager.assertTakeScreenshotNotCalled();

    }

    }



    /**

     * META+CTRL+BACKSPACE for taking a bugreport when the flag is enabled.

     */

    @Test

    @RequiresFlagsEnabled(com.android.server.flags.Flags.FLAG_NEW_BUGREPORT_KEYBOARD_SHORTCUT)

    public void testTakeBugReport_flagEnabled() throws RemoteException {

        sendKeyCombination(new int[]{KEYCODE_META_LEFT, KEYCODE_CTRL_LEFT, KEYCODE_DEL}, 0);

        mPhoneWindowManager.assertTakeBugreport(true);

    }



    /**

     * META+CTRL+BACKSPACE for taking a bugreport does nothing when the flag is disabledd.

     */

    @Test

    @RequiresFlagsDisabled(com.android.server.flags.Flags.FLAG_NEW_BUGREPORT_KEYBOARD_SHORTCUT)

    public void testTakeBugReport_flagDisabled() throws RemoteException {

        sendKeyCombination(new int[]{KEYCODE_META_LEFT, KEYCODE_CTRL_LEFT, KEYCODE_DEL}, 0);

        mPhoneWindowManager.assertTakeBugreport(false);

    }



}
 
}

services/tests/wmtests/src/com/android/server/policy/ShortcutLoggingTests.java

+17 −2
Original line number Original line Diff line number Diff line
@@ -23,6 +23,9 @@ import static com.android.server.policy.PhoneWindowManager.LONG_PRESS_HOME_NOTIF 
import static com.android.server.policy.PhoneWindowManager.SHORT_PRESS_SETTINGS_NOTIFICATION_PANEL;

import static com.android.server.policy.PhoneWindowManager.SHORT_PRESS_SETTINGS_NOTIFICATION_PANEL;





import android.platform.test.annotations.Presubmit;

import android.platform.test.annotations.Presubmit;

import android.platform.test.annotations.RequiresFlagsEnabled;

import android.platform.test.flag.junit.CheckFlagsRule;

import android.platform.test.flag.junit.DeviceFlagsValueProvider;

import android.view.KeyEvent;

import android.view.KeyEvent;





import androidx.test.filters.MediumTest;

import androidx.test.filters.MediumTest;
@@ -34,6 +37,7 @@ import junitparams.JUnitParamsRunner; 
import junitparams.Parameters;

import junitparams.Parameters;





import org.junit.Before;

import org.junit.Before;

import org.junit.Rule;

import org.junit.Test;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.junit.runner.RunWith;
@@ -42,6 +46,10 @@ import org.junit.runner.RunWith; 
@RunWith(JUnitParamsRunner.class)

@RunWith(JUnitParamsRunner.class)

public class ShortcutLoggingTests extends ShortcutKeyTestBase {

public class ShortcutLoggingTests extends ShortcutKeyTestBase {





    @Rule

    public final CheckFlagsRule mCheckFlagsRule =

            DeviceFlagsValueProvider.createCheckFlagsRule();



    private static final int VENDOR_ID = 0x123;

    private static final int VENDOR_ID = 0x123;

    private static final int PRODUCT_ID = 0x456;

    private static final int PRODUCT_ID = 0x456;

    private static final int DEVICE_BUS = 0x789;

    private static final int DEVICE_BUS = 0x789;
@@ -153,8 +161,6 @@ public class ShortcutLoggingTests extends ShortcutKeyTestBase { 
                        new int[]{META_KEY, CTRL_KEY, KeyEvent.KEYCODE_DPAD_RIGHT},

                        new int[]{META_KEY, CTRL_KEY, KeyEvent.KEYCODE_DPAD_RIGHT},

                        KeyboardLogEvent.SPLIT_SCREEN_NAVIGATION, KeyEvent.KEYCODE_DPAD_RIGHT,

                        KeyboardLogEvent.SPLIT_SCREEN_NAVIGATION, KeyEvent.KEYCODE_DPAD_RIGHT,

                        META_ON | CTRL_ON},

                        META_ON | CTRL_ON},

                {"Shift + Menu -> Trigger Bug Report", new int[]{SHIFT_KEY, KeyEvent.KEYCODE_MENU},

                        KeyboardLogEvent.TRIGGER_BUG_REPORT, KeyEvent.KEYCODE_MENU, SHIFT_ON},

                {"Meta + L -> Lock Homescreen", new int[]{META_KEY, KeyEvent.KEYCODE_L},

                {"Meta + L -> Lock Homescreen", new int[]{META_KEY, KeyEvent.KEYCODE_L},

                        KeyboardLogEvent.LOCK_SCREEN, KeyEvent.KEYCODE_L, META_ON},

                        KeyboardLogEvent.LOCK_SCREEN, KeyEvent.KEYCODE_L, META_ON},

                {"Meta + Ctrl + N -> Open Notes", new int[]{META_KEY, CTRL_KEY, KeyEvent.KEYCODE_N},

                {"Meta + Ctrl + N -> Open Notes", new int[]{META_KEY, CTRL_KEY, KeyEvent.KEYCODE_N},
@@ -353,4 +359,13 @@ public class ShortcutLoggingTests extends ShortcutKeyTestBase { 
                expectedKey, expectedModifierState, DEVICE_BUS,

                expectedKey, expectedModifierState, DEVICE_BUS,

                "Failed while executing " + testName);

                "Failed while executing " + testName);

    }

    }



    @Test

    @RequiresFlagsEnabled(com.android.server.flags.Flags.FLAG_NEW_BUGREPORT_KEYBOARD_SHORTCUT)

    public void testBugreportShortcutPress() {

        sendKeyCombination(new int[]{META_KEY, CTRL_KEY, KeyEvent.KEYCODE_DEL}, 0);

        mPhoneWindowManager.assertShortcutLogged(VENDOR_ID, PRODUCT_ID,

                KeyboardLogEvent.TRIGGER_BUG_REPORT, KeyEvent.KEYCODE_DEL, META_ON | CTRL_ON,

                DEVICE_BUS, "Failed to log bugreport shortcut.");

    }

}
 
}

services/tests/wmtests/src/com/android/server/policy/TestPhoneWindowManager.java

+13 −6
Original line number Original line Diff line number Diff line
@@ -88,6 +88,7 @@ import android.telecom.TelecomManager; 
import android.view.Display;

import android.view.Display;

import android.view.InputDevice;

import android.view.InputDevice;

import android.view.KeyEvent;

import android.view.KeyEvent;

import android.view.accessibility.AccessibilityManager;

import android.view.autofill.AutofillManagerInternal;

import android.view.autofill.AutofillManagerInternal;





import com.android.dx.mockito.inline.extended.StaticMockitoSession;

import com.android.dx.mockito.inline.extended.StaticMockitoSession;
@@ -155,6 +156,7 @@ class TestPhoneWindowManager { 
    @Mock private AudioManagerInternal mAudioManagerInternal;

    @Mock private AudioManagerInternal mAudioManagerInternal;

    @Mock private SearchManager mSearchManager;

    @Mock private SearchManager mSearchManager;

    @Mock private RoleManager mRoleManager;

    @Mock private RoleManager mRoleManager;

    @Mock private AccessibilityManager mAccessibilityManager;





    @Mock private Display mDisplay;

    @Mock private Display mDisplay;

    @Mock private DisplayRotation mDisplayRotation;

    @Mock private DisplayRotation mDisplayRotation;
@@ -305,6 +307,9 @@ class TestPhoneWindowManager { 
                eq(SensorPrivacyManager.class));

                eq(SensorPrivacyManager.class));

        doReturn(mSearchManager).when(mContext).getSystemService(eq(SearchManager.class));

        doReturn(mSearchManager).when(mContext).getSystemService(eq(SearchManager.class));

        doReturn(mRoleManager).when(mContext).getSystemService(eq(RoleManager.class));

        doReturn(mRoleManager).when(mContext).getSystemService(eq(RoleManager.class));

        doReturn(mAccessibilityManager).when(mContext).getSystemService(

                eq(AccessibilityManager.class));

        doReturn(false).when(mAccessibilityManager).isEnabled();

        doReturn(false).when(mPackageManager).hasSystemFeature(any());

        doReturn(false).when(mPackageManager).hasSystemFeature(any());

        try {

        try {

            doThrow(new PackageManager.NameNotFoundException("test")).when(mPackageManager)

            doThrow(new PackageManager.NameNotFoundException("test")).when(mPackageManager)
@@ -602,7 +607,7 @@ class TestPhoneWindowManager { 
    }

    }





    void overrideEnableBugReportTrigger(boolean enable) {

    void overrideEnableBugReportTrigger(boolean enable) {

        mPhoneWindowManager.mEnableShiftMenuBugReports = enable;

        mPhoneWindowManager.mEnableBugReportKeyboardShortcut = enable;

    }

    }





    void overrideStartActivity() {

    void overrideStartActivity() {
@@ -746,12 +751,14 @@ class TestPhoneWindowManager { 
                eq(displayId), eq(mImeTargetWindowToken));

                eq(displayId), eq(mImeTargetWindowToken));

    }

    }





    void assertTakeBugreport() {

    void assertTakeBugreport(boolean wasCalled) throws RemoteException {

        mTestLooper.dispatchAll();

        mTestLooper.dispatchAll();

        ArgumentCaptor<Intent> intentCaptor = ArgumentCaptor.forClass(Intent.class);

        if (wasCalled) {

        verify(mContext).sendOrderedBroadcastAsUser(intentCaptor.capture(), any(), any(), any(),

            verify(mActivityManagerService).requestInteractiveBugReport();

                any(), anyInt(), any(), any());

        } else {

        Assert.assertTrue(intentCaptor.getValue().getAction() == Intent.ACTION_BUG_REPORT);

            verify(mActivityManagerService, never()).requestInteractiveBugReport();

        }



    }

    }





    void assertTogglePanel() throws RemoteException {

    void assertTogglePanel() throws RemoteException {