Merge "Make ZenIconLoader injectable (in SystemUI)" into main

This commit is contained in:
Treehugger Robot
2024-08-29 22:59:49 +00:00
committed by Android (Google) Code Review
10 changed files with 59 additions and 30 deletions

View File

@@ -43,15 +43,18 @@ import java.util.function.Function;
abstract class AbstractZenModeHeaderController extends AbstractZenModePreferenceController { abstract class AbstractZenModeHeaderController extends AbstractZenModePreferenceController {
private final DashboardFragment mFragment; private final DashboardFragment mFragment;
private final ZenIconLoader mIconLoader;
private EntityHeaderController mHeaderController; private EntityHeaderController mHeaderController;
@Nullable private ZenIcon.Key mCurrentIconKey; @Nullable private ZenIcon.Key mCurrentIconKey;
AbstractZenModeHeaderController( AbstractZenModeHeaderController(
@NonNull Context context, @NonNull Context context,
@NonNull ZenIconLoader iconLoader,
@NonNull String key, @NonNull String key,
@NonNull DashboardFragment fragment) { @NonNull DashboardFragment fragment) {
super(context, key); super(context, key);
mFragment = fragment; mFragment = fragment;
mIconLoader = iconLoader;
} }
@Override @Override
@@ -90,7 +93,7 @@ abstract class AbstractZenModeHeaderController extends AbstractZenModePreference
if (!Objects.equal(mCurrentIconKey, zenMode.getIconKey())) { if (!Objects.equal(mCurrentIconKey, zenMode.getIconKey())) {
mCurrentIconKey = zenMode.getIconKey(); mCurrentIconKey = zenMode.getIconKey();
FutureUtil.whenDone( FutureUtil.whenDone(
ZenIconLoader.getInstance().getIcon(mContext, zenMode), mIconLoader.getIcon(mContext, zenMode),
icon -> { icon -> {
checkNotNull(mHeaderController) checkNotNull(mHeaderController)
.setIcon(iconStylist.apply(icon.drawable())) .setIcon(iconStylist.apply(icon.drawable()))

View File

@@ -30,6 +30,7 @@ import androidx.annotation.VisibleForTesting;
import com.android.settings.R; import com.android.settings.R;
import com.android.settings.dashboard.DashboardFragment; import com.android.settings.dashboard.DashboardFragment;
import com.android.settingslib.core.AbstractPreferenceController; import com.android.settingslib.core.AbstractPreferenceController;
import com.android.settingslib.notification.modes.ZenIconLoader;
import com.android.settingslib.notification.modes.ZenMode; import com.android.settingslib.notification.modes.ZenMode;
import com.android.settingslib.notification.modes.ZenModesBackend; import com.android.settingslib.notification.modes.ZenModesBackend;
@@ -102,7 +103,8 @@ public abstract class ZenModeEditNameIconFragmentBase extends DashboardFragment
protected final List<AbstractPreferenceController> createPreferenceControllers( protected final List<AbstractPreferenceController> createPreferenceControllers(
Context context) { Context context) {
return ImmutableList.of( return ImmutableList.of(
new ZenModeIconPickerIconPreferenceController(context, "chosen_icon", this), new ZenModeIconPickerIconPreferenceController(context, ZenIconLoader.getInstance(),
"chosen_icon", this),
new ZenModeEditNamePreferenceController(context, "name", this::setModeName), new ZenModeEditNamePreferenceController(context, "name", this::setModeName),
new ZenModeIconPickerListPreferenceController(context, "icon_list", new ZenModeIconPickerListPreferenceController(context, "icon_list",
this::setModeIcon), this::setModeIcon),

View File

@@ -32,6 +32,7 @@ import androidx.core.view.MenuProvider;
import com.android.settings.R; import com.android.settings.R;
import com.android.settingslib.core.AbstractPreferenceController; import com.android.settingslib.core.AbstractPreferenceController;
import com.android.settingslib.notification.modes.ZenIconLoader;
import com.android.settingslib.notification.modes.ZenMode; import com.android.settingslib.notification.modes.ZenMode;
import java.util.ArrayList; import java.util.ArrayList;
@@ -54,7 +55,8 @@ public class ZenModeFragment extends ZenModeFragmentBase {
@Override @Override
protected List<AbstractPreferenceController> createPreferenceControllers(Context context) { protected List<AbstractPreferenceController> createPreferenceControllers(Context context) {
List<AbstractPreferenceController> prefControllers = new ArrayList<>(); List<AbstractPreferenceController> prefControllers = new ArrayList<>();
prefControllers.add(new ZenModeHeaderController(context, "header", this)); prefControllers.add(
new ZenModeHeaderController(context, ZenIconLoader.getInstance(), "header", this));
prefControllers.add(new ZenModeBlurbPreferenceController(context, "mode_blurb")); prefControllers.add(new ZenModeBlurbPreferenceController(context, "mode_blurb"));
prefControllers.add( prefControllers.add(
new ZenModeButtonPreferenceController(context, "activate", this, mBackend)); new ZenModeButtonPreferenceController(context, "activate", this, mBackend));

View File

@@ -23,15 +23,14 @@ import androidx.preference.PreferenceScreen;
import com.android.settings.R; import com.android.settings.R;
import com.android.settings.dashboard.DashboardFragment; import com.android.settings.dashboard.DashboardFragment;
import com.android.settingslib.notification.modes.ZenIconLoader;
import com.android.settingslib.notification.modes.ZenMode; import com.android.settingslib.notification.modes.ZenMode;
class ZenModeHeaderController extends AbstractZenModeHeaderController { class ZenModeHeaderController extends AbstractZenModeHeaderController {
ZenModeHeaderController( ZenModeHeaderController(@NonNull Context context, @NonNull ZenIconLoader iconLoader,
@NonNull Context context, @NonNull String key, @NonNull DashboardFragment fragment) {
@NonNull String key, super(context, iconLoader, key, fragment);
@NonNull DashboardFragment fragment) {
super(context, key, fragment);
} }
@Override @Override

View File

@@ -24,14 +24,16 @@ import androidx.preference.PreferenceScreen;
import com.android.settings.R; import com.android.settings.R;
import com.android.settings.dashboard.DashboardFragment; import com.android.settings.dashboard.DashboardFragment;
import com.android.settingslib.notification.modes.ZenIconLoader;
import com.android.settingslib.notification.modes.ZenMode; import com.android.settingslib.notification.modes.ZenMode;
/** Controller used for displaying the currently-chosen icon at the top of the icon picker. */ /** Controller used for displaying the currently-chosen icon at the top of the icon picker. */
class ZenModeIconPickerIconPreferenceController extends AbstractZenModeHeaderController { class ZenModeIconPickerIconPreferenceController extends AbstractZenModeHeaderController {
ZenModeIconPickerIconPreferenceController(@NonNull Context context, @NonNull String key, ZenModeIconPickerIconPreferenceController(@NonNull Context context,
@NonNull ZenIconLoader iconLoader, @NonNull String key,
@NonNull DashboardFragment fragment) { @NonNull DashboardFragment fragment) {
super(context, key, fragment); super(context, iconLoader, key, fragment);
} }
@Override @Override

View File

@@ -31,6 +31,7 @@ import com.android.settings.notification.modes.ZenModesListAddModePreferenceCont
import com.android.settings.notification.modes.ZenModesListAddModePreferenceController.OnAddModeListener; import com.android.settings.notification.modes.ZenModesListAddModePreferenceController.OnAddModeListener;
import com.android.settings.search.BaseSearchIndexProvider; import com.android.settings.search.BaseSearchIndexProvider;
import com.android.settingslib.core.AbstractPreferenceController; import com.android.settingslib.core.AbstractPreferenceController;
import com.android.settingslib.notification.modes.ZenIconLoader;
import com.android.settingslib.notification.modes.ZenMode; import com.android.settingslib.notification.modes.ZenMode;
import com.android.settingslib.notification.modes.ZenModesBackend; import com.android.settingslib.notification.modes.ZenModesBackend;
import com.android.settingslib.search.SearchIndexable; import com.android.settingslib.search.SearchIndexable;
@@ -56,7 +57,7 @@ public class ZenModesListFragment extends ZenModesFragmentBase {
private static List<AbstractPreferenceController> buildPreferenceControllers(Context context, private static List<AbstractPreferenceController> buildPreferenceControllers(Context context,
ZenModesBackend backend, OnAddModeListener onAddModeListener) { ZenModesBackend backend, OnAddModeListener onAddModeListener) {
return ImmutableList.of( return ImmutableList.of(
new ZenModesListPreferenceController(context, backend), new ZenModesListPreferenceController(context, backend, ZenIconLoader.getInstance()),
new ZenModesListAddModePreferenceController(context, onAddModeListener) new ZenModesListAddModePreferenceController(context, onAddModeListener)
); );
} }

View File

@@ -31,6 +31,8 @@ import com.android.settingslib.notification.modes.ZenMode;
import com.google.common.base.Strings; import com.google.common.base.Strings;
import java.util.concurrent.Executor;
/** /**
* Preference representing a single mode item on the modes aggregator page. Clicking on this * Preference representing a single mode item on the modes aggregator page. Clicking on this
* preference leads to an individual mode's configuration page. * preference leads to an individual mode's configuration page.
@@ -38,18 +40,29 @@ import com.google.common.base.Strings;
class ZenModesListItemPreference extends RestrictedPreference { class ZenModesListItemPreference extends RestrictedPreference {
private final Context mContext; private final Context mContext;
private final ZenIconLoader mIconLoader;
private final Executor mUiExecutor;
private ZenMode mZenMode; private ZenMode mZenMode;
private TextView mTitleView; private TextView mTitleView;
private TextView mSummaryView; private TextView mSummaryView;
ZenModesListItemPreference(Context context, ZenMode zenMode) { ZenModesListItemPreference(Context context, ZenIconLoader iconLoader, ZenMode zenMode) {
this(context, iconLoader, context.getMainExecutor(), zenMode);
}
@VisibleForTesting
ZenModesListItemPreference(Context context, ZenIconLoader iconLoader, Executor uiExecutor,
ZenMode zenMode) {
super(context); super(context);
mContext = context; mContext = context;
mIconLoader = iconLoader;
mUiExecutor = uiExecutor;
setZenMode(zenMode); setZenMode(zenMode);
setKey(zenMode.getId()); setKey(zenMode.getId());
} }
@Override @Override
public void onBindViewHolder(PreferenceViewHolder holder) { public void onBindViewHolder(PreferenceViewHolder holder) {
super.onBindViewHolder(holder); super.onBindViewHolder(holder);
@@ -93,12 +106,12 @@ class ZenModesListItemPreference extends RestrictedPreference {
setIconSize(ICON_SIZE_SMALL); setIconSize(ICON_SIZE_SMALL);
FutureUtil.whenDone( FutureUtil.whenDone(
ZenIconLoader.getInstance().getIcon(mContext, mZenMode), mIconLoader.getIcon(mContext, mZenMode),
icon -> setIcon( icon -> setIcon(
zenMode.isActive() zenMode.isActive()
? IconUtil.applyAccentTint(mContext, icon.drawable()) ? IconUtil.applyAccentTint(mContext, icon.drawable())
: IconUtil.applyNormalTint(mContext, icon.drawable())), : IconUtil.applyNormalTint(mContext, icon.drawable())),
mContext.getMainExecutor()); mUiExecutor);
updateTextColor(zenMode); updateTextColor(zenMode);
} }

View File

@@ -25,6 +25,7 @@ import androidx.preference.PreferenceCategory;
import com.android.settings.R; import com.android.settings.R;
import com.android.settings.core.BasePreferenceController; import com.android.settings.core.BasePreferenceController;
import com.android.settingslib.notification.modes.ZenIconLoader;
import com.android.settingslib.notification.modes.ZenMode; import com.android.settingslib.notification.modes.ZenMode;
import com.android.settingslib.notification.modes.ZenModesBackend; import com.android.settingslib.notification.modes.ZenModesBackend;
import com.android.settingslib.search.SearchIndexableRaw; import com.android.settingslib.search.SearchIndexableRaw;
@@ -42,11 +43,14 @@ class ZenModesListPreferenceController extends BasePreferenceController
implements BasePreferenceController.UiBlocker { implements BasePreferenceController.UiBlocker {
protected static final String KEY = "zen_modes_list"; protected static final String KEY = "zen_modes_list";
protected ZenModesBackend mBackend; private final ZenModesBackend mBackend;
private final ZenIconLoader mIconLoader;
ZenModesListPreferenceController(Context context, @NonNull ZenModesBackend backend) { ZenModesListPreferenceController(Context context, @NonNull ZenModesBackend backend, @NonNull
ZenIconLoader iconLoader) {
super(context, KEY); super(context, KEY);
mBackend = backend; mBackend = backend;
mIconLoader = iconLoader;
} }
@Override @Override
@@ -82,7 +86,7 @@ class ZenModesListPreferenceController extends BasePreferenceController
modePreference.setZenMode(mode); modePreference.setZenMode(mode);
} else { } else {
// new rule; create a new ZenRulePreference & add it to the preference category // new rule; create a new ZenRulePreference & add it to the preference category
modePreference = new ZenModesListItemPreference(mContext, mode); modePreference = new ZenModesListItemPreference(mContext, mIconLoader, mode);
category.addPreference(modePreference); category.addPreference(modePreference);
} }
modePreference.setOrder(modes.indexOf(mode)); modePreference.setOrder(modes.indexOf(mode));

View File

@@ -36,7 +36,6 @@ import org.junit.runner.RunWith;
import org.mockito.MockitoAnnotations; import org.mockito.MockitoAnnotations;
import org.robolectric.RobolectricTestRunner; import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment; import org.robolectric.RuntimeEnvironment;
import org.robolectric.shadows.ShadowLooper;
@RunWith(RobolectricTestRunner.class) @RunWith(RobolectricTestRunner.class)
@EnableFlags(Flags.FLAG_MODES_UI) @EnableFlags(Flags.FLAG_MODES_UI)
@@ -45,18 +44,18 @@ public class ZenModesListItemPreferenceTest {
public final SetFlagsRule mSetFlagsRule = new SetFlagsRule(); public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
private Context mContext; private Context mContext;
private final ZenIconLoader mIconLoader = new ZenIconLoader(
MoreExecutors.newDirectExecutorService());
@Before @Before
public void setup() { public void setup() {
MockitoAnnotations.initMocks(this); MockitoAnnotations.initMocks(this);
mContext = RuntimeEnvironment.application; mContext = RuntimeEnvironment.application;
ZenIconLoader.setInstance(new ZenIconLoader(MoreExecutors.newDirectExecutorService()));
} }
@Test @Test
public void constructor_setsMode() { public void constructor_setsMode() {
ZenModesListItemPreference preference = new ZenModesListItemPreference(mContext, ZenModesListItemPreference preference = newPreference(TestModeBuilder.EXAMPLE);
TestModeBuilder.EXAMPLE);
assertThat(preference.getKey()).isEqualTo(TestModeBuilder.EXAMPLE.getId()); assertThat(preference.getKey()).isEqualTo(TestModeBuilder.EXAMPLE.getId());
assertThat(preference.getZenMode()).isEqualTo(TestModeBuilder.EXAMPLE); assertThat(preference.getZenMode()).isEqualTo(TestModeBuilder.EXAMPLE);
@@ -70,8 +69,7 @@ public class ZenModesListItemPreferenceTest {
.setEnabled(true) .setEnabled(true)
.build(); .build();
ZenModesListItemPreference preference = new ZenModesListItemPreference(mContext, mode); ZenModesListItemPreference preference = newPreference(mode);
ShadowLooper.idleMainLooper(); // To load icon.
assertThat(preference.getTitle()).isEqualTo("Enabled mode"); assertThat(preference.getTitle()).isEqualTo("Enabled mode");
assertThat(preference.getSummary()).isEqualTo("When the thrush knocks"); assertThat(preference.getSummary()).isEqualTo("When the thrush knocks");
@@ -87,8 +85,7 @@ public class ZenModesListItemPreferenceTest {
.setActive(true) .setActive(true)
.build(); .build();
ZenModesListItemPreference preference = new ZenModesListItemPreference(mContext, mode); ZenModesListItemPreference preference = newPreference(mode);
ShadowLooper.idleMainLooper();
assertThat(preference.getTitle()).isEqualTo("Active mode"); assertThat(preference.getTitle()).isEqualTo("Active mode");
assertThat(preference.getSummary()).isEqualTo("ON • When Birnam forest comes to Dunsinane"); assertThat(preference.getSummary()).isEqualTo("ON • When Birnam forest comes to Dunsinane");
@@ -103,8 +100,7 @@ public class ZenModesListItemPreferenceTest {
.setEnabled(false, /* byUser= */ false) .setEnabled(false, /* byUser= */ false)
.build(); .build();
ZenModesListItemPreference preference = new ZenModesListItemPreference(mContext, mode); ZenModesListItemPreference preference = newPreference(mode);
ShadowLooper.idleMainLooper();
assertThat(preference.getTitle()).isEqualTo("Mode disabled by app"); assertThat(preference.getTitle()).isEqualTo("Mode disabled by app");
assertThat(preference.getSummary()).isEqualTo("Not set"); assertThat(preference.getSummary()).isEqualTo("Not set");
@@ -119,11 +115,15 @@ public class ZenModesListItemPreferenceTest {
.setEnabled(false, /* byUser= */ true) .setEnabled(false, /* byUser= */ true)
.build(); .build();
ZenModesListItemPreference preference = new ZenModesListItemPreference(mContext, mode); ZenModesListItemPreference preference = newPreference(mode);
ShadowLooper.idleMainLooper();
assertThat(preference.getTitle()).isEqualTo("Mode disabled by user"); assertThat(preference.getTitle()).isEqualTo("Mode disabled by user");
assertThat(preference.getSummary()).isEqualTo("Disabled"); assertThat(preference.getSummary()).isEqualTo("Disabled");
assertThat(preference.getIcon()).isNotNull(); assertThat(preference.getIcon()).isNotNull();
} }
private ZenModesListItemPreference newPreference(ZenMode zenMode) {
return new ZenModesListItemPreference(mContext, mIconLoader, MoreExecutors.directExecutor(),
zenMode);
}
} }

View File

@@ -40,11 +40,13 @@ import androidx.preference.PreferenceManager;
import androidx.preference.PreferenceScreen; import androidx.preference.PreferenceScreen;
import com.android.settingslib.notification.modes.TestModeBuilder; import com.android.settingslib.notification.modes.TestModeBuilder;
import com.android.settingslib.notification.modes.ZenIconLoader;
import com.android.settingslib.notification.modes.ZenMode; import com.android.settingslib.notification.modes.ZenMode;
import com.android.settingslib.notification.modes.ZenModesBackend; import com.android.settingslib.notification.modes.ZenModesBackend;
import com.android.settingslib.search.SearchIndexableRaw; import com.android.settingslib.search.SearchIndexableRaw;
import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.MoreExecutors;
import org.junit.Before; import org.junit.Before;
import org.junit.Rule; import org.junit.Rule;
@@ -95,7 +97,8 @@ public class ZenModesListPreferenceControllerTest {
PreferenceScreen preferenceScreen = preferenceManager.createPreferenceScreen(mContext); PreferenceScreen preferenceScreen = preferenceManager.createPreferenceScreen(mContext);
preferenceScreen.addPreference(mPreference); preferenceScreen.addPreference(mPreference);
mPrefController = new ZenModesListPreferenceController(mContext, mBackend); mPrefController = new ZenModesListPreferenceController(mContext, mBackend,
new ZenIconLoader(MoreExecutors.newDirectExecutorService()));
} }
@Test @Test