PawletOS/app_Settings
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Settings] Rollback group UUID merging in SIM settings

Browse Source 
Within origin design, subscriptions with same group UUID
are not merged together.

This is a fix which changing grouping by UUID part into a configurable
option which allows to be enabled in some other conditions.

Bug: 191228344
Test: local
Change-Id: I0101f4a51ec2342f059762f0e7d38bb4e93554cf
This commit is contained in:
Bonian Chen
2021-07-07 23:30:40 +08:00
parent d488fa4147
commit 0726f263a8
5 changed files with 281 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
src/com/android/settings/network/helper/SelectableSubscriptions.java
View File

@@ -16,7 +16,6 @@
package com.android.settings.network.helper;
import android.content.Context;
import android.os.ParcelUuid;
import android.telephony.SubscriptionInfo;
import android.telephony.SubscriptionManager;
import android.telephony.TelephonyManager;
@@ -29,29 +28,38 @@ import com.android.settings.network.helper.SubscriptionAnnotation;
import com.android.settingslib.utils.ThreadUtils;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicIntegerArray;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.function.UnaryOperator;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
/**
* This is a Callable class to query user selectable subscription list.
*
* Here's example of creating a Callable for retrieving a list of SubscriptionAnnotation
* for active Subscriptions:
*
* List<SubscriptionAnnotation> result = (new SelectableSubscriptions(context, false)).call();
*
* Another example for retrieving a list of SubscriptionAnnotation for all subscriptions
* accessible in another thread.
*
* List<SubscriptionAnnotation> result = ExecutorService.submit(
* new SelectableSubscriptions(context, true)).get()
*/
public class SelectableSubscriptions implements Callable<List<SubscriptionAnnotation>> {
private static final String TAG = "SelectableSubscriptions";
private static final ParcelUuid mEmptyUuid = ParcelUuid.fromString("0-0-0-0-0");
private Context mContext;
private Supplier<List<SubscriptionInfo>> mSubscriptions;
private Predicate<SubscriptionAnnotation> mFilter;
private Function<List<SubscriptionAnnotation>, List<SubscriptionAnnotation>> mFinisher;
/**
* Constructor of class
@@ -65,6 +73,17 @@ public class SelectableSubscriptions implements Callable<List<SubscriptionAnnota
(() -> getActiveSubInfoList(context));
mFilter = disabledSlotsIncluded ? (subAnno -> subAnno.isExisted()) :
(subAnno -> subAnno.isActive());
mFinisher = annoList -> annoList;
}
/**
* Add UnaryOperator to be applied to the final result.
* @param finisher a function to be applied to the final result.
*/
public SelectableSubscriptions addFinisher(
UnaryOperator<List<SubscriptionAnnotation>> finisher) {
mFinisher = mFinisher.andThen(finisher);
return this;
}
/**
@@ -96,60 +115,20 @@ public class SelectableSubscriptions implements Callable<List<SubscriptionAnnota
List<Integer> simSlotIndexList = atomicToList(simSlotIndex.get());
List<Integer> activeSimSlotIndexList = atomicToList(activeSimSlotIndex.get());
// group by GUID
Map<ParcelUuid, List<SubscriptionAnnotation>> groupedSubInfoList =
IntStream.range(0, subInfoList.size())
// build a list of SubscriptionAnnotation
return IntStream.range(0, subInfoList.size())
.mapToObj(subInfoIndex ->
new SubscriptionAnnotation.Builder(subInfoList, subInfoIndex))
.map(annoBdr -> annoBdr.build(mContext,
eSimCardIdList, simSlotIndexList, activeSimSlotIndexList))
.filter(mFilter)
.collect(Collectors.groupingBy(subAnno -> getGroupUuid(subAnno)));
// select best one from subscription(s) within the same group
groupedSubInfoList.replaceAll((uuid, annoList) -> {
if ((uuid == mEmptyUuid) || (annoList.size() <= 1)) {
return annoList;
}
return Collections.singletonList(selectBestFromList(annoList));
});
// build a list of subscriptions (based on the order of slot index)
return groupedSubInfoList.values().stream().flatMap(List::stream)
.sorted(Comparator.comparingInt(anno -> anno.getSubInfo().getSimSlotIndex()))
.collect(Collectors.toList());
.collect(Collectors.collectingAndThen(Collectors.toList(), mFinisher));
} catch (Exception exception) {
Log.w(TAG, "Fail to request subIdList", exception);
}
return Collections.emptyList();
}
protected ParcelUuid getGroupUuid(SubscriptionAnnotation subAnno) {
ParcelUuid groupUuid = subAnno.getSubInfo().getGroupUuid();
return (groupUuid == null) ? mEmptyUuid : groupUuid;
}
protected SubscriptionAnnotation selectBestFromList(List<SubscriptionAnnotation> annoList) {
Comparator<SubscriptionAnnotation> annoSelector = (anno1, anno2) -> {
if (anno1.isDisplayAllowed() != anno2.isDisplayAllowed()) {
return anno1.isDisplayAllowed() ? -1 : 1;
}
if (anno1.isActive() != anno2.isActive()) {
return anno1.isActive() ? -1 : 1;
}
if (anno1.isExisted() != anno2.isExisted()) {
return anno1.isExisted() ? -1 : 1;
}
return 0;
};
annoSelector = annoSelector
// eSIM in front of pSIM
.thenComparingInt(anno -> -anno.getType())
// subscription ID in reverse order
.thenComparingInt(anno -> -anno.getSubscriptionId());
return annoList.stream().sorted(annoSelector).findFirst().orElse(null);
}
protected List<SubscriptionInfo> getSubInfoList(Context context,
Function<SubscriptionManager, List<SubscriptionInfo>> convertor) {
SubscriptionManager subManager = getSubscriptionManager(context);

22
src/com/android/settings/network/helper/SubscriptionAnnotation.java
View File

@@ -16,9 +16,12 @@
package com.android.settings.network.helper;
import android.content.Context;
import android.os.ParcelUuid;
import android.telephony.SubscriptionInfo;
import android.telephony.SubscriptionManager;
import android.telephony.TelephonyManager;
import androidx.annotation.Keep;
import androidx.annotation.VisibleForTesting;
import com.android.settings.network.SubscriptionUtil;
@@ -38,6 +41,8 @@ public class SubscriptionAnnotation {
private boolean mIsActive;
private boolean mIsAllowToDisplay;
public static final ParcelUuid EMPTY_UUID = ParcelUuid.fromString("0-0-0-0-0");
public static final int TYPE_UNKNOWN = 0x0;
public static final int TYPE_PSIM = 0x1;
public static final int TYPE_ESIM = 0x2;
@@ -70,6 +75,8 @@ public class SubscriptionAnnotation {
/**
* Constructor of class
*/
@Keep
@VisibleForTesting
protected SubscriptionAnnotation(List<SubscriptionInfo> subInfoList, int subInfoIndex,
Context context, List<Integer> eSimCardId,
List<Integer> simSlotIndex, List<Integer> activeSimSlotIndexList) {
@@ -101,37 +108,50 @@ public class SubscriptionAnnotation {
}
// the index provided during construction of Builder
@Keep
public int getOrderingInList() {
return mOrderWithinList;
}
// type of subscription
@Keep
public int getType() {
return mType;
}
// if a subscription is existed within device
@Keep
public boolean isExisted() {
return mIsExisted;
}
// if a subscription is currently ON
@Keep
public boolean isActive() {
return mIsActive;
}
// if display of subscription is allowed
@Keep
public boolean isDisplayAllowed() {
return mIsAllowToDisplay;
}
// the subscription ID
@Keep
public int getSubscriptionId() {
return (mSubInfo == null) ? SubscriptionManager.INVALID_SUBSCRIPTION_ID :
mSubInfo.getSubscriptionId();
}
// the grouping UUID
@Keep
public ParcelUuid getGroupUuid() {
return (mSubInfo == null) ? null : mSubInfo.getGroupUuid();
}
// the SubscriptionInfo
@Keep
public SubscriptionInfo getSubInfo() {
return mSubInfo;
}

96
src/com/android/settings/network/helper/SubscriptionGrouping.java Normal file
View File

@@ -0,0 +1,96 @@
/*
* Copyright (C) 2021 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.network.helper;
import android.os.ParcelUuid;
import androidx.annotation.Keep;
import androidx.annotation.VisibleForTesting;
import com.android.settings.network.helper.SubscriptionAnnotation;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.UnaryOperator;
import java.util.stream.Collectors;
/**
* A UnaryOperator for converting a list of SubscriptionAnnotation into
* another list of SubscriptionAnnotation based on group UUID.
* Only one SubscriptionAnnotation with entries with same (valid) group UUID would be kept.
*
* Here's an example when applying this operation as a finisher of SelectableSubscriptions:
*
* Callable<SubscriptionAnnotation> callable = (new SelectableSubscriptions(context, true))
* .addFinisher(new SubscriptionGrouping());
*
* List<SubscriptionAnnotation> result = ExecutorService.submit(callable).get()
*/
public class SubscriptionGrouping
implements UnaryOperator<List<SubscriptionAnnotation>> {
// implementation of UnaryOperator
public List<SubscriptionAnnotation> apply(List<SubscriptionAnnotation> listOfSubscriptions) {
// group by GUID
Map<ParcelUuid, List<SubscriptionAnnotation>> groupedSubInfoList =
listOfSubscriptions.stream()
.filter(Objects::nonNull)
.collect(Collectors.groupingBy(subAnno -> getGroupUuid(subAnno)));
// select best one from subscription(s) within the same group
groupedSubInfoList.replaceAll((uuid, annoList) -> {
if ((uuid == SubscriptionAnnotation.EMPTY_UUID) || (annoList.size() <= 1)) {
return annoList;
}
return Collections.singletonList(selectBestFromList(annoList));
});
// build a stream of subscriptions
return groupedSubInfoList.values()
.stream().flatMap(List::stream).collect(Collectors.toList());
}
@Keep
@VisibleForTesting
protected ParcelUuid getGroupUuid(SubscriptionAnnotation subAnno) {
ParcelUuid groupUuid = subAnno.getGroupUuid();
return (groupUuid == null) ? SubscriptionAnnotation.EMPTY_UUID : groupUuid;
}
protected SubscriptionAnnotation selectBestFromList(List<SubscriptionAnnotation> annoList) {
Comparator<SubscriptionAnnotation> annoSelector = (anno1, anno2) -> {
if (anno1.isDisplayAllowed() != anno2.isDisplayAllowed()) {
return anno1.isDisplayAllowed() ? -1 : 1;
}
if (anno1.isActive() != anno2.isActive()) {
return anno1.isActive() ? -1 : 1;
}
if (anno1.isExisted() != anno2.isExisted()) {
return anno1.isExisted() ? -1 : 1;
}
return 0;
};
annoSelector = annoSelector
// eSIM in front of pSIM
.thenComparingInt(anno -> -anno.getType())
// subscription ID in reverse order
.thenComparingInt(anno -> -anno.getSubscriptionId());
return annoList.stream().sorted(annoSelector).findFirst().orElse(null);
}
}

1
tests/unit/src/com/android/settings/network/helper/SelectableSubscriptionsTest.java
View File

@@ -33,7 +33,6 @@ public class SelectableSubscriptionsTest {
public void setUp() {
}
@Test
public void atomicToList_nullInput_getNoneNullEmptyList() {
List<Integer> result = SelectableSubscriptions.atomicToList(null);

137
tests/unit/src/com/android/settings/network/helper/SubscriptionGroupingTest.java Normal file
View File

@@ -0,0 +1,137 @@
/*
* Copyright (C) 2021 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.network.helper;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.when;
import android.content.Context;
import android.os.ParcelUuid;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.android.settings.network.helper.SubscriptionAnnotation;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.MockitoAnnotations;
import java.util.Arrays;
import java.util.List;
@RunWith(AndroidJUnit4.class)
public class SubscriptionGroupingTest {
private ParcelUuid mMockUuid;
private Context mContext;
private SubscriptionGrouping mTarget;
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
mContext = spy(ApplicationProvider.getApplicationContext());
mMockUuid = ParcelUuid.fromString("1-1-1-1-1");
mTarget = spy(new SubscriptionGrouping());
}
@Test
public void apply_multipleEntriesWithSameGroupUuid_onlyOneLeft() {
SubscriptionAnnotation subAnno1 = new TestSubAnnotation(1,
SubscriptionAnnotation.TYPE_ESIM, true, true, mMockUuid);
SubscriptionAnnotation subAnno2 = new TestSubAnnotation(2,
SubscriptionAnnotation.TYPE_PSIM, true, true, mMockUuid);
SubscriptionAnnotation subAnno3 = new TestSubAnnotation(3,
SubscriptionAnnotation.TYPE_ESIM, true, true, mMockUuid);
doReturn(mMockUuid).when(mTarget).getGroupUuid(any());
List<SubscriptionAnnotation> result = mTarget
.apply(Arrays.asList(subAnno2, subAnno1, subAnno3));
assertThat(result.size()).isEqualTo(1);
assertThat(result.get(0)).isEqualTo(subAnno3);
}
@Test
public void apply_multipleEntriesWithSameGroupUuid_disabledOneIsAvoided() {
SubscriptionAnnotation subAnno1 = new TestSubAnnotation(1,
SubscriptionAnnotation.TYPE_ESIM, true, true, mMockUuid);
SubscriptionAnnotation subAnno2 = new TestSubAnnotation(2,
SubscriptionAnnotation.TYPE_PSIM, true, true, mMockUuid);
SubscriptionAnnotation subAnno3 = new TestSubAnnotation(3,
SubscriptionAnnotation.TYPE_ESIM, false, false, mMockUuid);
doReturn(mMockUuid).when(mTarget).getGroupUuid(any());
List<SubscriptionAnnotation> result = mTarget
.apply(Arrays.asList(subAnno2, subAnno1, subAnno3));
assertThat(result.size()).isEqualTo(1);
assertThat(result.get(0)).isEqualTo(subAnno1);
}
private class TestSubAnnotation extends SubscriptionAnnotation {
private int mSubId;
private int mSimType;
private boolean mIsActive;
private boolean mIsDisplayAllowed;
private ParcelUuid mUuid;
private TestSubAnnotation(int subId, int simType,
boolean isActive, boolean isDisplayAllowed, ParcelUuid guuid) {
super(null, -1, null, null, null, null);
mSubId = subId;
mSimType = simType;
mIsActive = isActive;
mIsDisplayAllowed = isDisplayAllowed;
mUuid = guuid;
}
@Override
public int getSubscriptionId() {
return mSubId;
}
@Override
public int getType() {
return mSimType;
}
@Override
public boolean isExisted() {
return true;
}
@Override
public boolean isActive() {
return mIsActive;
}
@Override
public boolean isDisplayAllowed() {
return mIsDisplayAllowed;
}
@Override
public ParcelUuid getGroupUuid() {
return mUuid;
}
}
}