From cc749159dffd5d3c3388ba25cb1041526e5ed9c6 Mon Sep 17 00:00:00 2001 From: danielwbhuang Date: Fri, 24 Mar 2023 19:11:53 +0800 Subject: [PATCH] Open the settings page for a specific physical keyboard 1. Check open from a notification 2. Check open from Bluetooth entry 3. If the inputDeviceIdentifier is not null, open the next page directly. 4. Add extra to record the class of sender for the future metrics. Demo: http://screencast/cast/NDU4MTYxOTIzMTg4MzI2NHxiYTQ0ODE5Ny02YQ Bug: 269212353 Test: manual, atest [Pass] atest KeyboardSettingsPreferenceControllerTest [Pass] atest PhysicalKeyboardPreferenceControllerTest Change-Id: Ie874003260896bbb949806623913e70486e4731d --- res/xml/keyboard_settings.xml | 3 +- .../BluetoothDeviceDetailsFragment.java | 2 +- .../KeyboardSettingsPreferenceController.java | 36 ++++++++++------- ...wKeyboardLayoutEnabledLocalesFragment.java | 14 ++++++- .../NewKeyboardLayoutPickerContent.java | 1 + .../inputmethod/NewKeyboardSettingsUtils.java | 7 +++- .../inputmethod/PhysicalKeyboardFragment.java | 23 ++++++----- .../PhysicalKeyboardPreferenceController.java | 15 +++++++ ...boardSettingsPreferenceControllerTest.java | 40 +++++++++++++------ 9 files changed, 99 insertions(+), 42 deletions(-) diff --git a/res/xml/keyboard_settings.xml b/res/xml/keyboard_settings.xml index 9a3ac1a969c..bb1c3dad3dd 100644 --- a/res/xml/keyboard_settings.xml +++ b/res/xml/keyboard_settings.xml @@ -30,8 +30,7 @@ + android:summary="@string/summary_placeholder"/> newHardKeyboards = getHardKeyboardList(); + for (HardKeyboardDeviceInfo hardKeyboardDeviceInfo : newHardKeyboards) { + if (mCachedDevice.getAddress().equals(hardKeyboardDeviceInfo.mBluetoothAddress)) { + Intent intent = new Intent(Settings.ACTION_HARD_KEYBOARD_SETTINGS); + intent.putExtra( + NewKeyboardSettingsUtils.EXTRA_INTENT_FROM, + "com.android.settings.inputmethod.KeyboardSettingsPreferenceController"); + intent.putExtra( + Settings.EXTRA_INPUT_DEVICE_IDENTIFIER, + hardKeyboardDeviceInfo.mDeviceIdentifier); + mContext.startActivity(intent); + break; + } + } return true; } @Override public int getAvailabilityStatus() { - final List newHardKeyboards = - PhysicalKeyboardFragment.getHardKeyboards(mContext); + List newHardKeyboards = getHardKeyboardList(); if (FeatureFlagUtils.isEnabled(mContext, FeatureFlagUtils.SETTINGS_NEW_KEYBOARD_UI) && !newHardKeyboards.isEmpty()) { for (HardKeyboardDeviceInfo hardKeyboardDeviceInfo : newHardKeyboards) { @@ -78,4 +81,9 @@ public class KeyboardSettingsPreferenceController extends BasePreferenceControll } return CONDITIONALLY_UNAVAILABLE; } + + @VisibleForTesting + List getHardKeyboardList() { + return PhysicalKeyboardFragment.getHardKeyboards(mContext); + } } diff --git a/src/com/android/settings/inputmethod/NewKeyboardLayoutEnabledLocalesFragment.java b/src/com/android/settings/inputmethod/NewKeyboardLayoutEnabledLocalesFragment.java index 0f49ee18bc4..3344f4e99d0 100644 --- a/src/com/android/settings/inputmethod/NewKeyboardLayoutEnabledLocalesFragment.java +++ b/src/com/android/settings/inputmethod/NewKeyboardLayoutEnabledLocalesFragment.java @@ -23,6 +23,7 @@ import android.hardware.input.InputManager; import android.hardware.input.KeyboardLayout; import android.os.Bundle; import android.os.UserHandle; +import android.util.Log; import android.view.InputDevice; import android.view.inputmethod.InputMethodInfo; import android.view.inputmethod.InputMethodManager; @@ -59,10 +60,19 @@ public class NewKeyboardLayoutEnabledLocalesFragment extends DashboardFragment public void onActivityCreated(final Bundle icicle) { super.onActivityCreated(icicle); Bundle arguments = getArguments(); - final String title = - arguments.getString(NewKeyboardSettingsUtils.EXTRA_KEYBOARD_DEVICE_NAME); mInputDeviceIdentifier = arguments.getParcelable(NewKeyboardSettingsUtils.EXTRA_INPUT_DEVICE_IDENTIFIER); + if (mInputDeviceIdentifier == null) { + Log.e(TAG, "The inputDeviceIdentifier should not be null"); + return; + } + InputDevice inputDevice = + NewKeyboardSettingsUtils.getInputDevice(mIm, mInputDeviceIdentifier); + if (inputDevice == null) { + Log.e(TAG, "inputDevice is null"); + return; + } + final String title = inputDevice.getName(); getActivity().setTitle(title); updateCheckedState(); } diff --git a/src/com/android/settings/inputmethod/NewKeyboardLayoutPickerContent.java b/src/com/android/settings/inputmethod/NewKeyboardLayoutPickerContent.java index 761e95e17c5..110147a4a68 100644 --- a/src/com/android/settings/inputmethod/NewKeyboardLayoutPickerContent.java +++ b/src/com/android/settings/inputmethod/NewKeyboardLayoutPickerContent.java @@ -47,6 +47,7 @@ public class NewKeyboardLayoutPickerContent extends DashboardFragment { arguments.getParcelable(NewKeyboardSettingsUtils.EXTRA_INPUT_METHOD_SUBTYPE); if (identifier == null || NewKeyboardSettingsUtils.getInputDevice(inputManager, identifier) == null) { + getActivity().finish(); return; } getActivity().setTitle(title); diff --git a/src/com/android/settings/inputmethod/NewKeyboardSettingsUtils.java b/src/com/android/settings/inputmethod/NewKeyboardSettingsUtils.java index 506d1e77710..fe0c9d4f977 100644 --- a/src/com/android/settings/inputmethod/NewKeyboardSettingsUtils.java +++ b/src/com/android/settings/inputmethod/NewKeyboardSettingsUtils.java @@ -32,7 +32,12 @@ import java.util.List; */ public class NewKeyboardSettingsUtils { - static final String EXTRA_KEYBOARD_DEVICE_NAME = "extra_keyboard_device_name"; + /** + * Record the class name of the intent sender for metrics. + */ + public static final String EXTRA_INTENT_FROM = + "com.android.settings.inputmethod.EXTRA_INTENT_FROM"; + static final String EXTRA_TITLE = "keyboard_layout_picker_title"; static final String EXTRA_KEYBOARD_LAYOUT = "keyboard_layout"; static final String EXTRA_USER_ID = "user_id"; diff --git a/src/com/android/settings/inputmethod/PhysicalKeyboardFragment.java b/src/com/android/settings/inputmethod/PhysicalKeyboardFragment.java index e9dba57a90e..22f5b65306e 100644 --- a/src/com/android/settings/inputmethod/PhysicalKeyboardFragment.java +++ b/src/com/android/settings/inputmethod/PhysicalKeyboardFragment.java @@ -87,7 +87,6 @@ public final class PhysicalKeyboardFragment extends SettingsPreferenceFragment @Override public void onCreatePreferences(Bundle bundle, String s) { Activity activity = Preconditions.checkNotNull(getActivity()); - mBluetoothAddress = activity.getIntent().getStringExtra(EXTRA_BT_ADDRESS); addPreferencesFromResource(R.xml.physical_keyboard_settings); mIm = Preconditions.checkNotNull(activity.getSystemService(InputManager.class)); mImm = Preconditions.checkNotNull(activity.getSystemService(InputMethodManager.class)); @@ -104,6 +103,19 @@ public final class PhysicalKeyboardFragment extends SettingsPreferenceFragment if (!isModifierKeySettingsEnabled) { mKeyboardAssistanceCategory.removePreference(findPreference(MODIFIER_KEYS_SETTINGS)); } + InputDeviceIdentifier inputDeviceIdentifier = activity.getIntent().getParcelableExtra( + KeyboardLayoutPickerFragment.EXTRA_INPUT_DEVICE_IDENTIFIER); + // TODO (b/271391879): The EXTRA_INTENT_FROM is used for the future metrics. + if (inputDeviceIdentifier != null) { + Bundle arguments = new Bundle(); + arguments.putParcelable(NewKeyboardSettingsUtils.EXTRA_INPUT_DEVICE_IDENTIFIER, + inputDeviceIdentifier); + new SubSettingLauncher(getContext()) + .setSourceMetricsCategory(getMetricsCategory()) + .setDestination(NewKeyboardLayoutEnabledLocalesFragment.class.getName()) + .setArguments(arguments) + .launch(); + } } @Override @@ -187,14 +199,6 @@ public final class PhysicalKeyboardFragment extends SettingsPreferenceFragment preferenceScreen.addPreference(category); for (HardKeyboardDeviceInfo hardKeyboardDeviceInfo : newHardKeyboards) { - - // if user go into this page from Connected devices entry, we should distinguish the - // user-selected keyboard from all enabled keyboards. - if (mBluetoothAddress != null - && !mBluetoothAddress.equals(hardKeyboardDeviceInfo.mBluetoothAddress)) { - continue; - } - // TODO(yukawa): Consider using com.android.settings.widget.GearPreference final Preference pref = new Preference(getPrefContext()); pref.setTitle(hardKeyboardDeviceInfo.mDeviceName); @@ -247,7 +251,6 @@ public final class PhysicalKeyboardFragment extends SettingsPreferenceFragment Bundle arguments = new Bundle(); arguments.putParcelable(NewKeyboardSettingsUtils.EXTRA_INPUT_DEVICE_IDENTIFIER, inputDeviceIdentifier); - arguments.putString(NewKeyboardSettingsUtils.EXTRA_KEYBOARD_DEVICE_NAME, keyboardName); new SubSettingLauncher(getContext()) .setSourceMetricsCategory(getMetricsCategory()) .setDestination(NewKeyboardLayoutEnabledLocalesFragment.class.getName()) diff --git a/src/com/android/settings/inputmethod/PhysicalKeyboardPreferenceController.java b/src/com/android/settings/inputmethod/PhysicalKeyboardPreferenceController.java index 3dcae09081c..1f01b98b982 100644 --- a/src/com/android/settings/inputmethod/PhysicalKeyboardPreferenceController.java +++ b/src/com/android/settings/inputmethod/PhysicalKeyboardPreferenceController.java @@ -17,8 +17,10 @@ package com.android.settings.inputmethod; import android.content.Context; +import android.content.Intent; import android.hardware.input.InputManager; import android.icu.text.ListFormatter; +import android.provider.Settings; import androidx.preference.Preference; @@ -58,6 +60,19 @@ public class PhysicalKeyboardPreferenceController extends AbstractPreferenceCont && mContext.getResources().getBoolean(R.bool.config_show_physical_keyboard_pref); } + @Override + public boolean handlePreferenceTreeClick(Preference preference) { + if (!getPreferenceKey().equals(preference.getKey())) { + return false; + } + Intent intent = new Intent(Settings.ACTION_HARD_KEYBOARD_SETTINGS); + intent.putExtra( + NewKeyboardSettingsUtils.EXTRA_INTENT_FROM, + "com.android.settings.inputmethod.PhysicalKeyboardPreferenceController"); + mContext.startActivity(intent); + return true; + } + @Override public void updateState(Preference preference) { mPreference = preference; diff --git a/tests/robotests/src/com/android/settings/inputmethod/KeyboardSettingsPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/inputmethod/KeyboardSettingsPreferenceControllerTest.java index d1c21a40a99..1bf61a4c773 100644 --- a/tests/robotests/src/com/android/settings/inputmethod/KeyboardSettingsPreferenceControllerTest.java +++ b/tests/robotests/src/com/android/settings/inputmethod/KeyboardSettingsPreferenceControllerTest.java @@ -18,18 +18,21 @@ package com.android.settings.inputmethod; import static com.google.common.truth.Truth.assertThat; -import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doNothing; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; -import android.app.Activity; import android.content.Context; import android.content.Intent; +import android.hardware.input.InputDeviceIdentifier; import android.provider.Settings; import androidx.preference.Preference; import androidx.test.core.app.ApplicationProvider; +import com.android.settings.inputmethod.PhysicalKeyboardFragment.HardKeyboardDeviceInfo; import com.android.settingslib.bluetooth.CachedBluetoothDevice; import org.junit.Before; @@ -37,12 +40,14 @@ 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.junit.MockitoJUnit; import org.mockito.junit.MockitoRule; import org.robolectric.RobolectricTestRunner; +import java.util.ArrayList; +import java.util.List; + /** Tests for {@link KeyboardSettingsPreferenceController} */ @RunWith(RobolectricTestRunner.class) public class KeyboardSettingsPreferenceControllerTest { @@ -52,32 +57,43 @@ public class KeyboardSettingsPreferenceControllerTest { private static final String PREFERENCE_KEY = "keyboard_settings"; - @Mock - private Activity mActivity; @Mock private CachedBluetoothDevice mCachedBluetoothDevice; - @Captor - private ArgumentCaptor mIntentArgumentCaptor; + @Mock + private InputDeviceIdentifier mInputDeviceIdentifier; + private Context mContext; private KeyboardSettingsPreferenceController mController; @Before public void setUp() { mContext = spy(ApplicationProvider.getApplicationContext()); - mController = new KeyboardSettingsPreferenceController(mContext, PREFERENCE_KEY); - mController.init(mCachedBluetoothDevice, mActivity); + doNothing().when(mContext).startActivity(any()); + mController = spy(new KeyboardSettingsPreferenceController(mContext, PREFERENCE_KEY)); + mController.init(mCachedBluetoothDevice); } @Test public void handlePreferenceTreeClick_expected() { Preference mKeyboardPreference = new Preference(mContext); mKeyboardPreference.setKey(PREFERENCE_KEY); + final ArgumentCaptor captor = ArgumentCaptor.forClass(Intent.class); + String address = "BT_ADDRESS"; + HardKeyboardDeviceInfo deviceInfo = + new HardKeyboardDeviceInfo( + "TEST_DEVICE", + mInputDeviceIdentifier, + "TEST_DEVICE_LABEL", + address); + List keyboards = new ArrayList<>(); + keyboards.add(deviceInfo); + when(mController.getHardKeyboardList()).thenReturn(keyboards); + when(mCachedBluetoothDevice.getAddress()).thenReturn(address); mController.handlePreferenceTreeClick(mKeyboardPreference); - verify(mActivity).startActivityForResult(mIntentArgumentCaptor.capture(), eq(0)); - Intent expectedIntent = mIntentArgumentCaptor.getValue(); - assertThat(expectedIntent.getAction()).isEqualTo(Settings.ACTION_HARD_KEYBOARD_SETTINGS); + verify(mContext).startActivity(captor.capture()); + assertThat(captor.getValue().getAction()).isEqualTo(Settings.ACTION_HARD_KEYBOARD_SETTINGS); } @Test