Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 141984df authored by Fan Zhang's avatar Fan Zhang Committed by Android (Google) Code Review
Browse files

Merge "Force the adapter to rebind cards with a toggle." into qt-dev

parents cd07aa1c acb50f2c
Loading
Loading
Loading
Loading
+14 −0
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ public class ContextualCard {
    @LayoutRes
    private final int mViewType;
    private final boolean mIsPendingDismiss;
    private final boolean mHasInlineAction;

    public String getName() {
        return mName;
@@ -161,6 +162,10 @@ public class ContextualCard {
        return mIsPendingDismiss;
    }

    public boolean hasInlineAction() {
        return mHasInlineAction;
    }

    public Builder mutate() {
        return mBuilder;
    }
@@ -187,6 +192,7 @@ public class ContextualCard {
        mIsLargeCard = builder.mIsLargeCard;
        mViewType = builder.mViewType;
        mIsPendingDismiss = builder.mIsPendingDismiss;
        mHasInlineAction = builder.mHasInlineAction;
    }

    ContextualCard(Cursor c) {
@@ -234,6 +240,8 @@ public class ContextualCard {
        mBuilder.setViewType(mViewType);
        mIsPendingDismiss = false;
        mBuilder.setIsPendingDismiss(mIsPendingDismiss);
        mHasInlineAction = false;
        mBuilder.setHasInlineAction(mHasInlineAction);
    }

    @Override
@@ -286,6 +294,7 @@ public class ContextualCard {
        @LayoutRes
        private int mViewType;
        private boolean mIsPendingDismiss;
        private boolean mHasInlineAction;

        public Builder setName(String name) {
            mName = name;
@@ -387,6 +396,11 @@ public class ContextualCard {
            return this;
        }

        public Builder setHasInlineAction(boolean hasInlineAction) {
            mHasInlineAction = hasInlineAction;
            return this;
        }

        public ContextualCard build() {
            return new ContextualCard(this);
        }
+5 −1
Original line number Diff line number Diff line
@@ -20,7 +20,6 @@ import androidx.recyclerview.widget.DiffUtil;

import java.util.List;

//TODO(b/117816826): add test cases for DiffUtil.
/**
 * A DiffCallback to calculate the difference between old and new {@link ContextualCard} List.
 */
@@ -53,6 +52,11 @@ public class ContextualCardsDiffCallback extends DiffUtil.Callback {

    @Override
    public boolean areContentsTheSame(int oldCardPosition, int newCardPosition) {
        // Slices with toggles needs to be updated continuously, which means their contents may
        // change. So here we assume the content will always be different to force view rebinding.
        if (mNewCards.get(newCardPosition).hasInlineAction()) {
            return false;
        }
        return mOldCards.get(oldCardPosition).equals(mNewCards.get(newCardPosition));
    }
}
 No newline at end of file
+19 −1
Original line number Diff line number Diff line
@@ -26,11 +26,14 @@ import android.util.Log;

import androidx.annotation.VisibleForTesting;
import androidx.slice.Slice;
import androidx.slice.SliceMetadata;
import androidx.slice.SliceViewManager;
import androidx.slice.core.SliceAction;

import com.android.settings.overlay.FeatureFactory;
import com.android.settingslib.core.instrumentation.MetricsFeatureProvider;

import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
@@ -41,7 +44,9 @@ public class EligibleCardChecker implements Callable<ContextualCard> {
    private static final long LATCH_TIMEOUT_MS = 200;

    private final Context mContext;
    private final ContextualCard mCard;

    @VisibleForTesting
    ContextualCard mCard;

    EligibleCardChecker(Context context, ContextualCard card) {
        mContext = context;
@@ -93,6 +98,11 @@ public class EligibleCardChecker implements Callable<ContextualCard> {
        }

        final Slice slice = bindSlice(uri);

        if (isSliceToggleable(slice)) {
            mCard = card.mutate().setHasInlineAction(true).build();
        }

        if (slice == null || slice.hasHint(HINT_ERROR)) {
            Log.w(TAG, "Failed to bind slice, not eligible for display " + uri);
            return false;
@@ -133,4 +143,12 @@ public class EligibleCardChecker implements Callable<ContextualCard> {
        }
        return returnSlice[0];
    }

    @VisibleForTesting
    boolean isSliceToggleable(Slice slice) {
        final SliceMetadata metadata = SliceMetadata.from(mContext, slice);
        final List<SliceAction> toggles = metadata.getToggles();

        return !toggles.isEmpty();
    }
}
+95 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.homepage.contextualcards;

import static com.google.common.truth.Truth.assertThat;

import android.net.Uri;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;

import java.util.ArrayList;
import java.util.List;

@RunWith(RobolectricTestRunner.class)
public class ContextualCardsDiffCallbackTest {

    private static final Uri TEST_SLICE_URI = Uri.parse("content://test/test");

    private ContextualCardsDiffCallback mDiffCallback;
    private List<ContextualCard> mOldCards;
    private List<ContextualCard> mNewCards;

    @Before
    public void setUp() {
        mOldCards = new ArrayList<>();
        mNewCards = new ArrayList<>();
        mOldCards.add(getContextualCard("test1"));
        mNewCards.add(getContextualCard("test1"));
        mNewCards.add(getContextualCard("test2"));
        mDiffCallback = new ContextualCardsDiffCallback(mOldCards, mNewCards);
    }

    @Test
    public void getOldListSize_oneCard_returnOne() {
        assertThat(mDiffCallback.getOldListSize()).isEqualTo(1);
    }

    @Test
    public void getNewListSize_twoCards_returnTwo() {
        assertThat(mDiffCallback.getNewListSize()).isEqualTo(2);
    }

    @Test
    public void areItemsTheSame_sameItems_returnTrue() {
        assertThat(mDiffCallback.areItemsTheSame(0, 0)).isTrue();
    }

    @Test
    public void areItemsTheSame_differentItems_returnFalse() {
        mOldCards.add(getContextualCard("test3"));

        assertThat(mDiffCallback.areItemsTheSame(1, 1)).isFalse();
    }

    @Test
    public void areContentsTheSame_sameContents_returnTrue() {
        assertThat(mDiffCallback.areContentsTheSame(0, 0)).isTrue();
    }

    @Test
    public void areContentsTheSame_sliceWithToggle_returnFalse() {
        final ContextualCard card = getContextualCard("test1").mutate()
                .setHasInlineAction(true).build();
        mNewCards.add(0, card);

        assertThat(mDiffCallback.areContentsTheSame(0, 0)).isFalse();
    }

    private ContextualCard getContextualCard(String name) {
        return new ContextualCard.Builder()
                .setName(name)
                .setRankingScore(0.5)
                .setCardType(ContextualCard.CardType.SLICE)
                .setSliceUri(TEST_SLICE_URI)
                .build();
    }
}
+103 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.homepage.contextualcards;

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 android.content.Context;
import android.net.Uri;

import androidx.slice.Slice;
import androidx.slice.SliceProvider;
import androidx.slice.widget.SliceLiveData;

import com.android.settings.homepage.contextualcards.deviceinfo.EmergencyInfoSlice;
import com.android.settings.wifi.slice.ContextualWifiSlice;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;

@RunWith(RobolectricTestRunner.class)
public class EligibleCardCheckerTest {

    private static final Uri TEST_SLICE_URI = Uri.parse("content://test/test");

    private Context mContext;
    private EligibleCardChecker mEligibleCardChecker;

    @Before
    public void setUp() {
        mContext = RuntimeEnvironment.application;
        mEligibleCardChecker =
                spy(new EligibleCardChecker(mContext, getContextualCard(TEST_SLICE_URI)));
        SliceProvider.setSpecs(SliceLiveData.SUPPORTED_SPECS);
    }

    @Test
    public void isSliceToggleable_cardWithToggle_returnTrue() {
        final ContextualWifiSlice wifiSlice = new ContextualWifiSlice(mContext);
        final Slice slice = wifiSlice.getSlice();

        assertThat(mEligibleCardChecker.isSliceToggleable(slice)).isTrue();
    }

    @Test
    public void isSliceToggleable_cardWithoutToggle_returnFalse() {
        final EmergencyInfoSlice emergencyInfoSlice = new EmergencyInfoSlice(mContext);
        final Slice slice = emergencyInfoSlice.getSlice();

        assertThat(mEligibleCardChecker.isSliceToggleable(slice)).isFalse();
    }

    @Test
    public void isCardEligibleToDisplay_toggleSlice_hasInlineActionShouldBeTrue() {
        final ContextualWifiSlice wifiSlice = new ContextualWifiSlice(mContext);
        final Slice slice = wifiSlice.getSlice();
        doReturn(slice).when(mEligibleCardChecker).bindSlice(any(Uri.class));

        mEligibleCardChecker.isCardEligibleToDisplay(getContextualCard(TEST_SLICE_URI));

        assertThat(mEligibleCardChecker.mCard.hasInlineAction()).isTrue();
    }

    @Test
    public void isCardEligibleToDisplay_notToggleSlice_hasInlineActionShouldBeFalse() {
        final EmergencyInfoSlice emergencyInfoSlice = new EmergencyInfoSlice(mContext);
        final Slice slice = emergencyInfoSlice.getSlice();
        doReturn(slice).when(mEligibleCardChecker).bindSlice(any(Uri.class));

        mEligibleCardChecker.isCardEligibleToDisplay(getContextualCard(TEST_SLICE_URI));

        assertThat(mEligibleCardChecker.mCard.hasInlineAction()).isFalse();
    }

    private ContextualCard getContextualCard(Uri sliceUri) {
        return new ContextualCard.Builder()
                .setName("test_card")
                .setRankingScore(0.5)
                .setCardType(ContextualCard.CardType.SLICE)
                .setSliceUri(sliceUri)
                .build();
    }
}