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

Commit 972646ff authored by Brian Isganitis's avatar Brian Isganitis Committed by Android Build Coastguard Worker
Browse files

Cache visibility for listener set and only notify for current user. 

Flag: EXEMPT BUGFIX
Bug: 420549166
Test: HomeTransitionObserverTest
Cherrypick-From: https://googleplex-android-review.googlesource.com/q/commit:3b2b03d4cf45537b94a206a370bc14b3458a71f2
Merged-In: I6ce225ec0663c799f5d256321f9b116dc69d4b47
Change-Id: I6ce225ec0663c799f5d256321f9b116dc69d4b47
parent 9a66753c

libs/WindowManager/Shell/shared/src/com/android/wm/shell/shared/IShellTransitions.aidl

+2 −2
Original line number Diff line number Diff line
@@ -46,9 +46,9 @@ interface IShellTransitions { 
    IBinder getShellApplyToken() = 3;



    /**

     * Set listener that will receive callbacks about transitions involving home activity.

     * Set listener that will receive callbacks about transitions involving a user's home activity.

     */

    oneway void setHomeTransitionListener(in IHomeTransitionListener listener) = 4;

    oneway void setHomeTransitionListener(in IHomeTransitionListener listener, int userId) = 4;



    /**

     * Returns a container surface for the home root task.

libs/WindowManager/Shell/src/com/android/wm/shell/transition/HomeTransitionObserver.java

+55 −19
Original line number Diff line number Diff line
@@ -17,6 +17,7 @@ 
package com.android.wm.shell.transition;



import static android.app.WindowConfiguration.ACTIVITY_TYPE_HOME;

import static android.os.UserHandle.USER_NULL;

import static android.view.Display.DEFAULT_DISPLAY;

import static android.window.DesktopModeFlags.ENABLE_DRAG_TO_DESKTOP_INCOMING_TRANSITIONS_BUGFIX;

import static android.window.TransitionInfo.FLAG_BACK_GESTURE_ANIMATED;
@@ -42,6 +43,9 @@ import com.android.wm.shell.shared.TransitionUtil; 
import com.android.wm.shell.shared.bubbles.BubbleAnythingFlagHelper;

import com.android.wm.shell.sysui.ShellInit;



import java.util.HashMap;

import java.util.Map;



/**

 * The {@link TransitionObserver} that observes for transitions involving the home

 * activity on the {@link android.view.Display#DEFAULT_DISPLAY} only.
@@ -56,7 +60,9 @@ public class HomeTransitionObserver implements TransitionObserver, 
    private @NonNull final ShellExecutor mMainExecutor;

    private @NonNull final DisplayInsetsController mDisplayInsetsController;

    private IBinder mPendingStartDragTransition;

    private Boolean mPendingHomeVisibilityUpdate;



    private int mListenerUserId = USER_NULL; // UserId associated with the registered listener.

    private final Map<Integer, Boolean> mIsHomeVisibleForUser = new HashMap<>();



    public HomeTransitionObserver(@NonNull Context context,

            @NonNull ShellExecutor mainExecutor,
@@ -85,42 +91,54 @@ public class HomeTransitionObserver implements TransitionObserver, 
            @NonNull TransitionInfo info,

            @NonNull SurfaceControl.Transaction startTransaction,

            @NonNull SurfaceControl.Transaction finishTransaction) {

        Boolean homeVisibilityUpdate = getHomeVisibilityUpdate(info);

        Boolean homeVisibilityUpdate = updateHomeVisibilityForUser(info);



        if (info.getType() == TRANSIT_DESKTOP_MODE_START_DRAG_TO_DESKTOP) {

        if (info.getType() == TRANSIT_DESKTOP_MODE_START_DRAG_TO_DESKTOP

                && homeVisibilityUpdate != null) {

            // Do not apply at the start of desktop drag as that updates launcher UI visibility.

            // Store the value and apply with a next transition or when cancelling the

            // desktop-drag transition.

            storePendingHomeVisibilityUpdate(transition, homeVisibilityUpdate);

            storePendingStartDragTransition(transition);

            return;

        }



        if (BubbleAnythingFlagHelper.enableBubbleToFullscreen()

                && info.getType() == TRANSIT_CONVERT_TO_BUBBLE

                && homeVisibilityUpdate == null) {

                && homeVisibilityUpdate == null

                && mPendingStartDragTransition != null) {

            // We are converting to bubble and we did not get a change to home visibility in this

            // transition. Apply the value from start of drag.

            homeVisibilityUpdate = mPendingHomeVisibilityUpdate;

            homeVisibilityUpdate = mIsHomeVisibleForUser.get(mListenerUserId);

        }



        if (homeVisibilityUpdate != null) {

            mPendingHomeVisibilityUpdate = null;

            mPendingStartDragTransition = null;

            notifyHomeVisibilityChanged(homeVisibilityUpdate);

        }

    }



    private void storePendingHomeVisibilityUpdate(

            IBinder transition, Boolean homeVisibilityUpdate) {

    private void storePendingStartDragTransition(IBinder transition) {

        if (!BubbleAnythingFlagHelper.enableBubbleToFullscreen()

                && !ENABLE_DRAG_TO_DESKTOP_INCOMING_TRANSITIONS_BUGFIX.isTrue()) {

            return;

        }

        mPendingHomeVisibilityUpdate = homeVisibilityUpdate;

        mPendingStartDragTransition = transition;

    }



    private Boolean getHomeVisibilityUpdate(TransitionInfo info) {

    /**

     * Determines if a given transition represents a change in home visibility for the current user.

     * <p>

     * Only returns the visibility for the current user if it is in the transition.

     * <p>

     * If a change is a visibility change for any user, it is cached in

     * {@link #mIsHomeVisibleForUser} for pending transitions or when registering a listener.

     *

     * @param info The information about the transition.

     * @return Considering the current user, {@code true} if its home activity is becoming visible,

     *         {@code false} if invisible, or {@code null} if this change does not involve its home

     *         visibility.

     */

    private Boolean updateHomeVisibilityForUser(TransitionInfo info) {

        Boolean homeVisibilityUpdate = null;

        for (TransitionInfo.Change change : info.getChanges()) {

            final ActivityManager.RunningTaskInfo taskInfo = change.getTaskInfo();
@@ -130,15 +148,27 @@ public class HomeTransitionObserver implements TransitionObserver, 
                    || !taskInfo.isRunning) {

                continue;

            }

            Boolean update = getHomeVisibilityUpdate(info, change, taskInfo);

            Boolean update = getHomeVisibilityUpdateForChange(info, change, taskInfo);

            if (update != null) {

                mIsHomeVisibleForUser.put(taskInfo.userId, update);

                if (taskInfo.userId == mListenerUserId) {

                    homeVisibilityUpdate = update;

                }

            }

        }

        return homeVisibilityUpdate;

    }



    private Boolean getHomeVisibilityUpdate(TransitionInfo info,

    /**

     * Determines if a given transition change for a task represents a change in home visibility.

     *

     * @param info The information about the transition.

     * @param change The specific change within the transition.

     * @param taskInfo The information about the task associated with the change.

     * @return {@code true} if the home activity is becoming visible, {@code false} if it's becoming

     *         invisible, or {@code null} if this change does not affect home visibility.

     */

    private Boolean getHomeVisibilityUpdateForChange(TransitionInfo info,

            TransitionInfo.Change change, ActivityManager.RunningTaskInfo taskInfo) {

        final int mode = change.getMode();

        final boolean isBackGesture = change.hasFlags(FLAG_BACK_GESTURE_ANIMATED);
@@ -174,9 +204,9 @@ public class HomeTransitionObserver implements TransitionObserver, 
        }

        mPendingStartDragTransition = null;



        if (mPendingHomeVisibilityUpdate != null) {

            notifyHomeVisibilityChanged(mPendingHomeVisibilityUpdate);

            mPendingHomeVisibilityUpdate = null;

        Boolean pendingVisibility = mIsHomeVisibleForUser.get(mListenerUserId);

        if (pendingVisibility != null) {

            notifyHomeVisibilityChanged(pendingVisibility);

        }

    }
@@ -184,8 +214,8 @@ public class HomeTransitionObserver implements TransitionObserver, 
     * Sets the home transition listener that receives any transitions resulting in a change of

     *

     */

    public void setHomeTransitionListener(Transitions transitions,

            IHomeTransitionListener listener) {

    public void setHomeTransitionListener(Transitions transitions, IHomeTransitionListener listener,

            int userId) {

        if (mListener == null) {

            mListener = new SingleInstanceRemoteListener<>(this,

                    c -> transitions.registerObserver(this),
@@ -193,9 +223,15 @@ public class HomeTransitionObserver implements TransitionObserver, 
        }



        if (listener != null) {

            mListenerUserId = userId;

            mListener.register(listener);

            Boolean isVisible = mIsHomeVisibleForUser.get(userId);

            if (isVisible != null) {

                notifyHomeVisibilityChanged(isVisible);

            }

        } else {

            mListener.unregister();

            mListenerUserId = USER_NULL;

        }

    }

libs/WindowManager/Shell/src/com/android/wm/shell/transition/Transitions.java

+2 −2
Original line number Diff line number Diff line
@@ -1773,11 +1773,11 @@ public class Transitions implements RemoteCallable<Transitions>, 
        }



        @Override

        public void setHomeTransitionListener(IHomeTransitionListener listener) {

        public void setHomeTransitionListener(IHomeTransitionListener listener, int userId) {

            executeRemoteCallWithTaskPermission(mTransitions, "setHomeTransitionListener",

                    (transitions) -> {

                        transitions.mHomeTransitionObserver.setHomeTransitionListener(transitions,

                                listener);

                                listener, userId);

                    });

        }

libs/WindowManager/Shell/tests/unittest/src/com/android/wm/shell/transition/HomeTransitionObserverTest.java

+79 −1
Original line number Diff line number Diff line
@@ -81,6 +81,9 @@ import java.util.List; 
@SmallTest

@RunWith(AndroidJUnit4.class)

public class HomeTransitionObserverTest extends ShellTestCase {

    private static final int TEST_USER = 0;

    private static final int TEST_USER_2 = 10;



    private final ShellTaskOrganizer mOrganizer = mock(ShellTaskOrganizer.class);

    private final TransactionPool mTransactionPool = mock(TransactionPool.class);

    private final Context mContext =
@@ -93,6 +96,7 @@ public class HomeTransitionObserverTest extends ShellTestCase { 
            mock(DisplayInsetsController.class);



    private IHomeTransitionListener mListener;

    private IHomeTransitionListener mListener2;

    private Transitions mTransition;

    private HomeTransitionObserver mHomeTransitionObserver;
@@ -100,6 +104,8 @@ public class HomeTransitionObserverTest extends ShellTestCase { 
    public void setUp() {

        mListener = mock(IHomeTransitionListener.class);

        when(mListener.asBinder()).thenReturn(mock(IBinder.class));

        mListener2 = mock(IHomeTransitionListener.class);

        when(mListener2.asBinder()).thenReturn(mock(IBinder.class));



        mHomeTransitionObserver = new HomeTransitionObserver(mContext, mMainExecutor,

                mDisplayInsetsController, mock(ShellInit.class));
@@ -107,7 +113,7 @@ public class HomeTransitionObserverTest extends ShellTestCase { 
                mOrganizer, mTransactionPool, mDisplayController, mDisplayInsetsController,

                mMainExecutor, mMainHandler, mAnimExecutor, mHomeTransitionObserver,

                mock(FocusTransitionObserver.class));

        mHomeTransitionObserver.setHomeTransitionListener(mTransition, mListener);

        mHomeTransitionObserver.setHomeTransitionListener(mTransition, mListener, TEST_USER);

    }



    @Test
@@ -146,6 +152,26 @@ public class HomeTransitionObserverTest extends ShellTestCase { 
        verify(mListener, times(1)).onHomeVisibilityChanged(false);

    }



    @Test

    public void testHomeActivity_differentUserTransition_doesNotTriggerCallbackForCurrentUser()

            throws RemoteException {

        TransitionInfo info = mock(TransitionInfo.class);

        TransitionInfo.Change change = mock(TransitionInfo.Change.class);

        ActivityManager.RunningTaskInfo taskInfo = mock(ActivityManager.RunningTaskInfo.class);

        when(change.getTaskInfo()).thenReturn(taskInfo);

        when(info.getChanges()).thenReturn(new ArrayList<>(List.of(change)));



        taskInfo.userId = TEST_USER_2;

        setupTransitionInfo(taskInfo, change, ACTIVITY_TYPE_HOME, TRANSIT_OPEN, true);



        mHomeTransitionObserver.onTransitionReady(mock(IBinder.class),

                info,

                mock(SurfaceControl.Transaction.class),

                mock(SurfaceControl.Transaction.class));



        verify(mListener, never()).onHomeVisibilityChanged(anyBoolean());

    }



    @Test

    public void testNonHomeActivityDoesNotTriggerCallback() throws RemoteException {

        TransitionInfo info = mock(TransitionInfo.class);
@@ -362,6 +388,58 @@ public class HomeTransitionObserverTest extends ShellTestCase { 
        verify(mListener, times(1)).onHomeVisibilityChanged(true);

    }



    @Test

    public void testSetListener_userSwitched_triggersWhenUserRegistersListener()

            throws RemoteException {

        TransitionInfo info = mock(TransitionInfo.class);

        TransitionInfo.Change change = mock(TransitionInfo.Change.class);

        ActivityManager.RunningTaskInfo taskInfo = mock(ActivityManager.RunningTaskInfo.class);

        when(change.getTaskInfo()).thenReturn(taskInfo);

        when(info.getChanges()).thenReturn(new ArrayList<>(List.of(change)));



        // Switch to user with visible home.

        taskInfo.userId = TEST_USER_2;

        setupTransitionInfo(taskInfo, change, ACTIVITY_TYPE_HOME, TRANSIT_OPEN, true);

        mHomeTransitionObserver.onTransitionReady(mock(IBinder.class),

                info,

                mock(SurfaceControl.Transaction.class),

                mock(SurfaceControl.Transaction.class));



        mHomeTransitionObserver.setHomeTransitionListener(mTransition, mListener2, TEST_USER_2);

        verify(mListener2, times(1)).onHomeVisibilityChanged(true);

    }



    @Test

    public void testSetListener_userSwitchedBack_triggersWithPreviousVisibility()

            throws RemoteException {

        TransitionInfo info = mock(TransitionInfo.class);

        TransitionInfo.Change change = mock(TransitionInfo.Change.class);

        ActivityManager.RunningTaskInfo taskInfo = mock(ActivityManager.RunningTaskInfo.class);

        when(change.getTaskInfo()).thenReturn(taskInfo);

        when(info.getChanges()).thenReturn(new ArrayList<>(List.of(change)));



        // Switch to user with visible home, and register its listener.

        taskInfo.userId = TEST_USER_2;

        setupTransitionInfo(taskInfo, change, ACTIVITY_TYPE_HOME, TRANSIT_OPEN, true);

        mHomeTransitionObserver.onTransitionReady(mock(IBinder.class),

                info,

                mock(SurfaceControl.Transaction.class),

                mock(SurfaceControl.Transaction.class));

        mHomeTransitionObserver.setHomeTransitionListener(mTransition, mListener2, TEST_USER_2);



        // Switch back to first user with invisible home, and register its listener.

        taskInfo.userId = TEST_USER;

        setupTransitionInfo(taskInfo, change, ACTIVITY_TYPE_HOME, TRANSIT_TO_BACK, true);

        mHomeTransitionObserver.onTransitionReady(mock(IBinder.class),

                info,

                mock(SurfaceControl.Transaction.class),

                mock(SurfaceControl.Transaction.class));



        verify(mListener, never()).onHomeVisibilityChanged(false); // Not invoked yet (not set).

        mHomeTransitionObserver.setHomeTransitionListener(mTransition, mListener, TEST_USER);

        verify(mListener, times(1)).onHomeVisibilityChanged(false);

    }



    /**

     * Helper class to initialize variables for the rest.

     */