Merge "Allow saved Hearing Aid devices to be searched by names" into main

This commit is contained in:
Daniel Norman
2024-11-05 18:33:59 +00:00
committed by Android (Google) Code Review
3 changed files with 175 additions and 4 deletions

View File

@@ -17,17 +17,26 @@
package com.android.settings.accessibility;
import android.content.Context;
import android.util.Log;
import androidx.annotation.VisibleForTesting;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settings.bluetooth.BluetoothDeviceUpdater;
import com.android.settings.bluetooth.Utils;
import com.android.settings.connecteddevice.DevicePreferenceCallback;
import com.android.settings.dashboard.DashboardFragment;
import com.android.settingslib.bluetooth.CachedBluetoothDevice;
import com.android.settingslib.bluetooth.LocalBluetoothManager;
import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settingslib.core.lifecycle.events.OnResume;
import com.android.settingslib.core.lifecycle.events.OnStart;
import com.android.settingslib.core.lifecycle.events.OnStop;
import com.android.settingslib.search.SearchIndexableRaw;
import java.util.List;
/**
* Controller to update the {@link androidx.preference.PreferenceCategory} for all
@@ -39,11 +48,23 @@ public class SavedHearingDevicePreferenceController extends
BaseBluetoothDevicePreferenceController implements LifecycleObserver, OnStart, OnResume,
OnStop {
private static final String TAG = "SavedHearingDevicePreferenceController";
private static final String SEARCH_DATA_KEY_PREFIX = "a11y_saved_hearing_device";
private BluetoothDeviceUpdater mSavedHearingDeviceUpdater;
private final LocalBluetoothManager mLocalBluetoothManager;
public SavedHearingDevicePreferenceController(Context context,
String preferenceKey) {
super(context, preferenceKey);
mLocalBluetoothManager = Utils.getLocalBluetoothManager(context);
}
@VisibleForTesting
void init(SavedHearingDeviceUpdater savedHearingDeviceUpdater) {
if (mSavedHearingDeviceUpdater != null) {
throw new IllegalStateException("Should not call init() more than 1 time.");
}
mSavedHearingDeviceUpdater = savedHearingDeviceUpdater;
}
/**
@@ -86,4 +107,34 @@ public class SavedHearingDevicePreferenceController extends
mSavedHearingDeviceUpdater.forceUpdate();
}
}
@Override
public void updateDynamicRawDataToIndex(List<SearchIndexableRaw> rawData) {
if (Flags.fixA11ySettingsSearch()) {
if (mLocalBluetoothManager == null) {
Log.d(TAG, "Bluetooth is not supported");
return;
}
for (CachedBluetoothDevice cachedDevice :
mLocalBluetoothManager.getCachedDeviceManager().getCachedDevicesCopy()) {
if (!SavedHearingDeviceUpdater.isSavedHearingAidDevice(cachedDevice)) {
continue;
}
SearchIndexableRaw data = new SearchIndexableRaw(mContext);
// Include the identity address and add prefix to ensure the key is unique and
// distinguish from Bluetooth's connected devices.
data.key = SEARCH_DATA_KEY_PREFIX
+ cachedDevice.getName() + cachedDevice.getIdentityAddress();
data.title = cachedDevice.getName();
data.summaryOn = mContext.getString(R.string.accessibility_hearingaid_title);
data.screenTitle = mContext.getString(R.string.accessibility_hearingaid_title);
rawData.add(data);
}
} else {
super.updateDynamicRawDataToIndex(rawData);
}
}
}

View File

@@ -36,14 +36,16 @@ public class SavedHearingDeviceUpdater extends SavedBluetoothDeviceUpdater {
super(context, devicePreferenceCallback, /* showConnectedDevice= */ false, metricsCategory);
}
@Override
public boolean isFilterMatched(CachedBluetoothDevice cachedDevice) {
static boolean isSavedHearingAidDevice(CachedBluetoothDevice cachedDevice) {
final BluetoothDevice device = cachedDevice.getDevice();
final boolean isSavedHearingAidDevice = cachedDevice.isHearingAidDevice()
return cachedDevice.isHearingAidDevice()
&& device.getBondState() == BluetoothDevice.BOND_BONDED
&& !device.isConnected();
}
return isSavedHearingAidDevice && isDeviceInCachedDevicesList(cachedDevice);
@Override
public boolean isFilterMatched(CachedBluetoothDevice cachedDevice) {
return isSavedHearingAidDevice(cachedDevice) && isDeviceInCachedDevicesList(cachedDevice);
}
@Override

View File

@@ -0,0 +1,118 @@
/*
* Copyright (C) 2024 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.accessibility;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.when;
import android.bluetooth.BluetoothDevice;
import android.content.Context;
import android.platform.test.annotations.EnableFlags;
import android.platform.test.flag.junit.SetFlagsRule;
import androidx.test.core.app.ApplicationProvider;
import com.android.settings.bluetooth.Utils;
import com.android.settings.testutils.shadow.ShadowBluetoothUtils;
import com.android.settingslib.bluetooth.CachedBluetoothDevice;
import com.android.settingslib.bluetooth.CachedBluetoothDeviceManager;
import com.android.settingslib.bluetooth.LocalBluetoothManager;
import com.android.settingslib.search.SearchIndexableRaw;
import com.google.common.collect.ImmutableList;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.annotation.Config;
import java.util.ArrayList;
import java.util.List;
/** Tests for {@link SavedHearingDevicePreferenceController} */
@RunWith(RobolectricTestRunner.class)
@Config(shadows = {ShadowBluetoothUtils.class})
public class SavedHearingDevicePreferenceControllerTest {
@Rule
public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
private static final String PREFERENCE_KEY = "preference_key";
private static final String DEVICE_NAME = "device";
private Context mContext;
private SavedHearingDevicePreferenceController mSavedHearingDevicePreferenceController;
@Mock
private SavedHearingDeviceUpdater mSavedHearingDeviceUpdater;
@Mock
private CachedBluetoothDeviceManager mCachedDeviceManager;
@Mock
private LocalBluetoothManager mLocalBluetoothManager;
@Mock
private CachedBluetoothDevice mCachedDevice;
@Mock
private BluetoothDevice mDevice;
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
mContext = ApplicationProvider.getApplicationContext();
ShadowBluetoothUtils.sLocalBluetoothManager = mLocalBluetoothManager;
mLocalBluetoothManager = Utils.getLocalBtManager(mContext);
when(mLocalBluetoothManager.getCachedDeviceManager()).thenReturn(mCachedDeviceManager);
when(mCachedDevice.getDevice()).thenReturn(mDevice);
when(mCachedDevice.getName()).thenReturn(DEVICE_NAME);
when(mCachedDeviceManager.getCachedDevicesCopy()).thenReturn(
ImmutableList.of(mCachedDevice));
mSavedHearingDevicePreferenceController =
new SavedHearingDevicePreferenceController(mContext, PREFERENCE_KEY);
mSavedHearingDevicePreferenceController.init(mSavedHearingDeviceUpdater);
}
@Test
@EnableFlags(Flags.FLAG_FIX_A11Y_SETTINGS_SEARCH)
public void updateDynamicRawDataToIndex_isNotHearingAidDevice_deviceIsNotSearchable() {
when(mDevice.getBondState()).thenReturn(BluetoothDevice.BOND_BONDED);
when(mDevice.isConnected()).thenReturn(false);
when(mCachedDevice.isHearingAidDevice()).thenReturn(false);
List<SearchIndexableRaw> searchData = new ArrayList<>();
mSavedHearingDevicePreferenceController.updateDynamicRawDataToIndex(searchData);
assertThat(searchData).isEmpty();
}
@Test
@EnableFlags(Flags.FLAG_FIX_A11Y_SETTINGS_SEARCH)
public void updateDynamicRawDataToIndex_isHearingAidDevice_deviceIsSearchable() {
when(mDevice.getBondState()).thenReturn(BluetoothDevice.BOND_BONDED);
when(mDevice.isConnected()).thenReturn(false);
when(mCachedDevice.isHearingAidDevice()).thenReturn(true);
List<SearchIndexableRaw> searchData = new ArrayList<>();
mSavedHearingDevicePreferenceController.updateDynamicRawDataToIndex(searchData);
assertThat(searchData).isNotEmpty();
assertThat(searchData.get(0).key).contains(DEVICE_NAME);
}
}