Merge changes from topic "sb-flags-new" into tm-qpr-dev

* changes:
  [SB Refactor] Update the flags to be mobile-specific and wifi-specific.
  [SB Refactor] Migrate the isWifiDefault bit to the new pipeline.
This commit is contained in:
Caitlin Shkuratov
2022-10-21 17:14:37 +00:00
committed by Android (Google) Code Review
13 changed files with 240 additions and 36 deletions

View File

@@ -214,14 +214,30 @@ public class Flags {
public static final ReleasedFlag STATUS_BAR_LETTERBOX_APPEARANCE =
new ReleasedFlag(603, false);
// TODO(b/254512623): Tracking Bug
/**
* @deprecated replaced by mobile and wifi specific flags.
*
* TODO(b/254512623): Tracking Bug
*/
@Deprecated
public static final UnreleasedFlag NEW_STATUS_BAR_PIPELINE_BACKEND =
new UnreleasedFlag(604, false);
// TODO(b/254512660): Tracking Bug
/**
* @deprecated replaced by mobile and wifi specific flags.
*
* TODO(b/254512660): Tracking Bug
*/
@Deprecated
public static final UnreleasedFlag NEW_STATUS_BAR_PIPELINE_FRONTEND =
new UnreleasedFlag(605, false);
public static final UnreleasedFlag NEW_STATUS_BAR_MOBILE_ICONS =
new UnreleasedFlag(606, false);
public static final UnreleasedFlag NEW_STATUS_BAR_WIFI_ICON =
new UnreleasedFlag(607, false);
/***************************************/
// 700 - dialer/calls
// TODO(b/254512734): Tracking Bug

View File

@@ -372,7 +372,7 @@ public interface StatusBarIconController {
mIconSize = mContext.getResources().getDimensionPixelSize(
com.android.internal.R.dimen.status_bar_icon_size);
if (statusBarPipelineFlags.isNewPipelineFrontendEnabled()) {
if (statusBarPipelineFlags.useNewMobileIcons()) {
// This starts the flow for the new pipeline, and will notify us of changes
mMobileIconsViewModel = mobileUiAdapter.createMobileIconsViewModel();
MobileIconsBinder.bind(mGroup, mMobileIconsViewModel);
@@ -451,7 +451,7 @@ public interface StatusBarIconController {
@VisibleForTesting
protected StatusIconDisplayable addWifiIcon(int index, String slot, WifiIconState state) {
final BaseStatusBarFrameLayout view;
if (mStatusBarPipelineFlags.isNewPipelineFrontendEnabled()) {
if (mStatusBarPipelineFlags.useNewWifiIcon()) {
view = onCreateModernStatusBarWifiView(slot);
// When [ModernStatusBarWifiView] is created, it will automatically apply the
// correct view state so we don't need to call applyWifiState.
@@ -474,9 +474,9 @@ public interface StatusBarIconController {
String slot,
MobileIconState state
) {
if (mStatusBarPipelineFlags.isNewPipelineFrontendEnabled()) {
if (mStatusBarPipelineFlags.useNewMobileIcons()) {
throw new IllegalStateException("Attempting to add a mobile icon while the new "
+ "pipeline is enabled is not supported");
+ "icons are enabled is not supported");
}
// Use the `subId` field as a key to query for the correct context
@@ -497,7 +497,7 @@ public interface StatusBarIconController {
String slot,
int subId
) {
if (!mStatusBarPipelineFlags.isNewPipelineFrontendEnabled()) {
if (!mStatusBarPipelineFlags.useNewMobileIcons()) {
throw new IllegalStateException("Attempting to add a mobile icon using the new"
+ "pipeline, but the enabled flag is false.");
}

View File

@@ -224,9 +224,9 @@ public class StatusBarIconControllerImpl implements Tunable,
*/
@Override
public void setMobileIcons(String slot, List<MobileIconState> iconStates) {
if (mStatusBarPipelineFlags.isNewPipelineFrontendEnabled()) {
if (mStatusBarPipelineFlags.useNewMobileIcons()) {
Log.d(TAG, "ignoring old pipeline callbacks, because the new "
+ "pipeline frontend is enabled");
+ "icons are enabled");
return;
}
Slot mobileSlot = mStatusBarIconList.getSlot(slot);
@@ -249,9 +249,9 @@ public class StatusBarIconControllerImpl implements Tunable,
@Override
public void setNewMobileIconSubIds(List<Integer> subIds) {
if (!mStatusBarPipelineFlags.isNewPipelineFrontendEnabled()) {
if (!mStatusBarPipelineFlags.useNewMobileIcons()) {
Log.d(TAG, "ignoring new pipeline callback, "
+ "since the frontend is disabled");
+ "since the new icons are disabled");
return;
}
Slot mobileSlot = mStatusBarIconList.getSlot("mobile");

View File

@@ -24,29 +24,19 @@ import javax.inject.Inject
/** All flagging methods related to the new status bar pipeline (see b/238425913). */
@SysUISingleton
class StatusBarPipelineFlags @Inject constructor(private val featureFlags: FeatureFlags) {
/**
* Returns true if we should run the new pipeline backend.
*
* The new pipeline backend hooks up to all our external callbacks, logs those callback inputs,
* and logs the output state.
*/
fun isNewPipelineBackendEnabled(): Boolean =
featureFlags.isEnabled(Flags.NEW_STATUS_BAR_PIPELINE_BACKEND)
/** True if we should display the mobile icons using the new status bar data pipeline. */
fun useNewMobileIcons(): Boolean = featureFlags.isEnabled(Flags.NEW_STATUS_BAR_MOBILE_ICONS)
/** True if we should display the wifi icon using the new status bar data pipeline. */
fun useNewWifiIcon(): Boolean = featureFlags.isEnabled(Flags.NEW_STATUS_BAR_WIFI_ICON)
// TODO(b/238425913): Add flags to only run the mobile backend or wifi backend so we get the
// logging without getting the UI effects.
/**
* Returns true if we should run the new pipeline frontend *and* backend.
*
* The new pipeline frontend will use the outputted state from the new backend and will make the
* correct changes to the UI.
*/
fun isNewPipelineFrontendEnabled(): Boolean =
isNewPipelineBackendEnabled() &&
featureFlags.isEnabled(Flags.NEW_STATUS_BAR_PIPELINE_FRONTEND)
/**
* Returns true if we should apply some coloring to icons that were rendered with the new
* Returns true if we should apply some coloring to the wifi icon that was rendered with the new
* pipeline to help with debugging.
*/
// For now, just always apply the debug coloring if we've enabled frontend rendering.
fun useNewPipelineDebugColoring(): Boolean = isNewPipelineFrontendEnabled()
// For now, just always apply the debug coloring if we've enabled the new icon.
fun useWifiDebugColoring(): Boolean = useNewWifiIcon()
}

View File

@@ -39,7 +39,6 @@ import com.android.systemui.dagger.qualifiers.Main
import com.android.systemui.statusbar.pipeline.shared.ConnectivityPipelineLogger
import com.android.systemui.statusbar.pipeline.shared.ConnectivityPipelineLogger.Companion.SB_LOGGING_TAG
import com.android.systemui.statusbar.pipeline.shared.ConnectivityPipelineLogger.Companion.logInputChange
import com.android.systemui.statusbar.pipeline.shared.ConnectivityPipelineLogger.Companion.logOutputChange
import com.android.systemui.statusbar.pipeline.wifi.data.model.WifiNetworkModel
import com.android.systemui.statusbar.pipeline.wifi.shared.model.WifiActivityModel
import java.util.concurrent.Executor
@@ -64,6 +63,9 @@ interface WifiRepository {
/** Observable for the current wifi enabled status. */
val isWifiEnabled: StateFlow<Boolean>
/** Observable for the current wifi default status. */
val isWifiDefault: StateFlow<Boolean>
/** Observable for the current wifi network. */
val wifiNetwork: StateFlow<WifiNetworkModel>
@@ -103,7 +105,7 @@ class WifiRepositoryImpl @Inject constructor(
merge(wifiNetworkChangeEvents, wifiStateChangeEvents)
.mapLatest { wifiManager.isWifiEnabled }
.distinctUntilChanged()
.logOutputChange(logger, "enabled")
.logInputChange(logger, "enabled")
.stateIn(
scope = scope,
started = SharingStarted.WhileSubscribed(),
@@ -111,6 +113,39 @@ class WifiRepositoryImpl @Inject constructor(
)
}
override val isWifiDefault: StateFlow<Boolean> = conflatedCallbackFlow {
// Note: This callback doesn't do any logging because we already log every network change
// in the [wifiNetwork] callback.
val callback = object : ConnectivityManager.NetworkCallback(FLAG_INCLUDE_LOCATION_INFO) {
override fun onCapabilitiesChanged(
network: Network,
networkCapabilities: NetworkCapabilities
) {
// This method will always be called immediately after the network becomes the
// default, in addition to any time the capabilities change while the network is
// the default.
// If this network contains valid wifi info, then wifi is the default network.
val wifiInfo = networkCapabilitiesToWifiInfo(networkCapabilities)
trySend(wifiInfo != null)
}
override fun onLost(network: Network) {
// The system no longer has a default network, so wifi is definitely not default.
trySend(false)
}
}
connectivityManager.registerDefaultNetworkCallback(callback)
awaitClose { connectivityManager.unregisterNetworkCallback(callback) }
}
.distinctUntilChanged()
.logInputChange(logger, "isWifiDefault")
.stateIn(
scope,
started = SharingStarted.WhileSubscribed(),
initialValue = false
)
override val wifiNetwork: StateFlow<WifiNetworkModel> = conflatedCallbackFlow {
var currentWifi: WifiNetworkModel = WIFI_NETWORK_DEFAULT

View File

@@ -59,6 +59,9 @@ class WifiInteractor @Inject constructor(
/** Our current enabled status. */
val isEnabled: Flow<Boolean> = wifiRepository.isWifiEnabled
/** Our current default status. */
val isDefault: Flow<Boolean> = wifiRepository.isWifiDefault
/** Our current wifi network. See [WifiNetworkModel]. */
val wifiNetwork: Flow<WifiNetworkModel> = wifiRepository.wifiNetwork

View File

@@ -48,7 +48,7 @@ abstract class LocationBasedWifiViewModel(
/** The color that should be used to tint the icon. */
val tint: Flow<Int> =
flowOf(
if (statusBarPipelineFlags.useNewPipelineDebugColoring()) {
if (statusBarPipelineFlags.useWifiDebugColoring()) {
debugTint
} else {
DEFAULT_TINT

View File

@@ -124,9 +124,10 @@ constructor(
private val wifiIcon: StateFlow<Icon.Resource?> =
combine(
interactor.isEnabled,
interactor.isDefault,
interactor.isForceHidden,
interactor.wifiNetwork,
) { isEnabled, isForceHidden, wifiNetwork ->
) { isEnabled, isDefault, isForceHidden, wifiNetwork ->
if (!isEnabled || isForceHidden || wifiNetwork is WifiNetworkModel.CarrierMerged) {
return@combine null
}
@@ -135,6 +136,7 @@ constructor(
val icon = Icon.Resource(iconResId, wifiNetwork.contentDescription())
return@combine when {
isDefault -> icon
wifiConstants.alwaysShowIconIfEnabled -> icon
!connectivityConstants.hasDataCapabilities -> icon
wifiNetwork is WifiNetworkModel.Active && wifiNetwork.isValidated -> icon

View File

@@ -27,6 +27,9 @@ class FakeWifiRepository : WifiRepository {
private val _isWifiEnabled: MutableStateFlow<Boolean> = MutableStateFlow(false)
override val isWifiEnabled: StateFlow<Boolean> = _isWifiEnabled
private val _isWifiDefault: MutableStateFlow<Boolean> = MutableStateFlow(false)
override val isWifiDefault: StateFlow<Boolean> = _isWifiDefault
private val _wifiNetwork: MutableStateFlow<WifiNetworkModel> =
MutableStateFlow(WifiNetworkModel.Inactive)
override val wifiNetwork: StateFlow<WifiNetworkModel> = _wifiNetwork
@@ -38,6 +41,10 @@ class FakeWifiRepository : WifiRepository {
_isWifiEnabled.value = enabled
}
fun setIsWifiDefault(default: Boolean) {
_isWifiDefault.value = default
}
fun setWifiNetwork(wifiNetworkModel: WifiNetworkModel) {
_wifiNetwork.value = wifiNetworkModel
}

View File

@@ -221,6 +221,83 @@ class WifiRepositoryImplTest : SysuiTestCase() {
enabledJob.cancel()
}
@Test
fun isWifiDefault_initiallyGetsDefault() = runBlocking(IMMEDIATE) {
val job = underTest.isWifiDefault.launchIn(this)
assertThat(underTest.isWifiDefault.value).isFalse()
job.cancel()
}
@Test
fun isWifiDefault_wifiNetwork_isTrue() = runBlocking(IMMEDIATE) {
val job = underTest.isWifiDefault.launchIn(this)
val wifiInfo = mock<WifiInfo>().apply {
whenever(this.ssid).thenReturn(SSID)
}
getDefaultNetworkCallback().onCapabilitiesChanged(
NETWORK,
createWifiNetworkCapabilities(wifiInfo)
)
assertThat(underTest.isWifiDefault.value).isTrue()
job.cancel()
}
@Test
fun isWifiDefault_cellularVcnNetwork_isTrue() = runBlocking(IMMEDIATE) {
val job = underTest.isWifiDefault.launchIn(this)
val capabilities = mock<NetworkCapabilities>().apply {
whenever(this.hasTransport(TRANSPORT_CELLULAR)).thenReturn(true)
whenever(this.transportInfo).thenReturn(VcnTransportInfo(PRIMARY_WIFI_INFO))
}
getDefaultNetworkCallback().onCapabilitiesChanged(NETWORK, capabilities)
assertThat(underTest.isWifiDefault.value).isTrue()
job.cancel()
}
@Test
fun isWifiDefault_cellularNotVcnNetwork_isFalse() = runBlocking(IMMEDIATE) {
val job = underTest.isWifiDefault.launchIn(this)
val capabilities = mock<NetworkCapabilities>().apply {
whenever(this.hasTransport(TRANSPORT_CELLULAR)).thenReturn(true)
whenever(this.transportInfo).thenReturn(mock())
}
getDefaultNetworkCallback().onCapabilitiesChanged(NETWORK, capabilities)
assertThat(underTest.isWifiDefault.value).isFalse()
job.cancel()
}
@Test
fun isWifiDefault_wifiNetworkLost_isFalse() = runBlocking(IMMEDIATE) {
val job = underTest.isWifiDefault.launchIn(this)
// First, add a network
getDefaultNetworkCallback()
.onCapabilitiesChanged(NETWORK, createWifiNetworkCapabilities(PRIMARY_WIFI_INFO))
assertThat(underTest.isWifiDefault.value).isTrue()
// WHEN the network is lost
getDefaultNetworkCallback().onLost(NETWORK)
// THEN we update to false
assertThat(underTest.isWifiDefault.value).isFalse()
job.cancel()
}
@Test
fun wifiNetwork_initiallyGetsDefault() = runBlocking(IMMEDIATE) {
var latest: WifiNetworkModel? = null
@@ -745,6 +822,12 @@ class WifiRepositoryImplTest : SysuiTestCase() {
return callbackCaptor.value!!
}
private fun getDefaultNetworkCallback(): ConnectivityManager.NetworkCallback {
val callbackCaptor = argumentCaptor<ConnectivityManager.NetworkCallback>()
verify(connectivityManager).registerDefaultNetworkCallback(callbackCaptor.capture())
return callbackCaptor.value!!
}
private fun createWifiNetworkCapabilities(
wifiInfo: WifiInfo,
isValidated: Boolean = true,

View File

@@ -177,6 +177,29 @@ class WifiInteractorTest : SysuiTestCase() {
job.cancel()
}
@Test
fun isDefault_matchesRepoIsDefault() = runBlocking(IMMEDIATE) {
var latest: Boolean? = null
val job = underTest
.isDefault
.onEach { latest = it }
.launchIn(this)
wifiRepository.setIsWifiDefault(true)
yield()
assertThat(latest).isTrue()
wifiRepository.setIsWifiDefault(false)
yield()
assertThat(latest).isFalse()
wifiRepository.setIsWifiDefault(true)
yield()
assertThat(latest).isTrue()
job.cancel()
}
@Test
fun wifiNetwork_matchesRepoWifiNetwork() = runBlocking(IMMEDIATE) {
val wifiNetwork = WifiNetworkModel.Active(

View File

@@ -88,6 +88,7 @@ internal class WifiViewModelIconParameterizedTest(private val testCase: TestCase
fun wifiIcon() =
runBlocking(IMMEDIATE) {
wifiRepository.setIsWifiEnabled(testCase.enabled)
wifiRepository.setIsWifiDefault(testCase.isDefault)
connectivityRepository.setForceHiddenIcons(
if (testCase.forceHidden) {
setOf(ConnectivitySlot.WIFI)
@@ -152,6 +153,7 @@ internal class WifiViewModelIconParameterizedTest(private val testCase: TestCase
val forceHidden: Boolean = false,
val alwaysShowIconWhenEnabled: Boolean = false,
val hasDataCapabilities: Boolean = true,
val isDefault: Boolean = false,
val network: WifiNetworkModel,
/** The expected output. Null if we expect the output to be null. */
@@ -162,6 +164,7 @@ internal class WifiViewModelIconParameterizedTest(private val testCase: TestCase
"forceHidden=$forceHidden, " +
"showWhenEnabled=$alwaysShowIconWhenEnabled, " +
"hasDataCaps=$hasDataCapabilities, " +
"isDefault=$isDefault, " +
"network=$network) then " +
"EXPECTED($expected)"
}
@@ -296,6 +299,46 @@ internal class WifiViewModelIconParameterizedTest(private val testCase: TestCase
),
),
// isDefault = true => all Inactive and Active networks shown
TestCase(
isDefault = true,
network = WifiNetworkModel.Inactive,
expected =
Expected(
iconResource = WIFI_NO_NETWORK,
contentDescription = { context ->
"${context.getString(WIFI_NO_CONNECTION)}," +
context.getString(NO_INTERNET)
},
description = "No network icon",
),
),
TestCase(
isDefault = true,
network = WifiNetworkModel.Active(NETWORK_ID, isValidated = false, level = 3),
expected =
Expected(
iconResource = WIFI_NO_INTERNET_ICONS[3],
contentDescription = { context ->
"${context.getString(WIFI_CONNECTION_STRENGTH[3])}," +
context.getString(NO_INTERNET)
},
description = "No internet level 3 icon",
),
),
TestCase(
isDefault = true,
network = WifiNetworkModel.Active(NETWORK_ID, isValidated = true, level = 1),
expected =
Expected(
iconResource = WIFI_FULL_ICONS[1],
contentDescription = { context ->
context.getString(WIFI_CONNECTION_STRENGTH[1])
},
description = "Full internet level 1 icon",
),
),
// network = CarrierMerged => not shown
TestCase(
network = WifiNetworkModel.CarrierMerged,

View File

@@ -76,6 +76,8 @@ class WifiViewModelTest : SysuiTestCase() {
scope.cancel()
}
// See [WifiViewModelIconParameterizedTest] for additional view model tests.
// Note on testing: [WifiViewModel] exposes 3 different instances of
// [LocationBasedWifiViewModel]. In practice, these 3 different instances will get the exact
// same data for icon, activity, etc. flows. So, most of these tests will test just one of the