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

Commit 2dded21b authored by Mady Mellor's avatar Mady Mellor
Browse files

Track locusId visibility in ShellTaskOrganizer 

- Keeps track of all visible locusIds
- New listener that clients can register to find out
  about locusId visibility changes

Bug: 170267239
Test: atest ShellTaskOrganizerTests
Change-Id: I544ed9ad173ed30320c5cc104f1c473f94b537d2
parent b7ab3a76

libs/WindowManager/Shell/src/com/android/wm/shell/ShellTaskOrganizer.java

+80 −0
Original line number Diff line number Diff line
@@ -28,10 +28,13 @@ import android.annotation.IntDef; 
import android.annotation.NonNull;

import android.annotation.Nullable;

import android.app.ActivityManager.RunningTaskInfo;

import android.app.TaskInfo;

import android.content.Context;

import android.content.LocusId;

import android.os.Binder;

import android.os.IBinder;

import android.util.ArrayMap;

import android.util.ArraySet;

import android.util.Log;

import android.util.SparseArray;

import android.view.SurfaceControl;
@@ -50,6 +53,7 @@ import java.io.PrintWriter; 
import java.util.ArrayList;

import java.util.Arrays;

import java.util.List;

import java.util.Objects;



/**

 * Unified task organizer for all components in the shell.
@@ -95,6 +99,17 @@ public class ShellTaskOrganizer extends TaskOrganizer { 
        default void dump(@NonNull PrintWriter pw, String prefix) {};

    }



    /**

     * Callbacks for events on a task with a locus id.

     */

    public interface LocusIdListener {

        /**

         * Notifies when a task with a locusId becomes visible, when a visible task's locusId

         * changes, or if a previously visible task with a locusId becomes invisible.

         */

        void onVisibilityChanged(int taskId, LocusId locus, boolean visible);

    }



    /**

     * Keys map from either a task id or {@link TaskListenerType}.

     * @see #addListenerForTaskId
@@ -109,6 +124,13 @@ public class ShellTaskOrganizer extends TaskOrganizer { 
    /** @see #setPendingLaunchCookieListener */

    private final ArrayMap<IBinder, TaskListener> mLaunchCookieToListener = new ArrayMap<>();



    // Keeps track of taskId's with visible locusIds. Used to notify any {@link LocusIdListener}s

    // that might be set.

    private final SparseArray<LocusId> mVisibleTasksWithLocusId = new SparseArray<>();



    /** @see #addLocusIdListener */

    private final ArraySet<LocusIdListener> mLocusIdListeners = new ArraySet<>();



    private final Object mLock = new Object();

    private final StartingSurfaceDrawer mStartingSurfaceDrawer;
@@ -252,6 +274,28 @@ public class ShellTaskOrganizer extends TaskOrganizer { 
        }

    }



    /**

     * Adds a listener to be notified for {@link LocusId} visibility changes.

     */

    public void addLocusIdListener(LocusIdListener listener) {

        synchronized (mLock) {

            mLocusIdListeners.add(listener);

            for (int i = 0; i < mVisibleTasksWithLocusId.size(); i++) {

                listener.onVisibilityChanged(mVisibleTasksWithLocusId.keyAt(i),

                        mVisibleTasksWithLocusId.valueAt(i), true /* visible */);

            }

        }

    }



    /**

     * Removes listener.

     */

    public void removeLocusIdListener(LocusIdListener listener) {

        synchronized (mLock) {

            mLocusIdListeners.remove(listener);

        }

    }



    @Override

    public void addStartingWindow(StartingWindowInfo info, IBinder appToken) {

        mStartingSurfaceDrawer.addStartingWindow(info, appToken);
@@ -283,6 +327,7 @@ public class ShellTaskOrganizer extends TaskOrganizer { 
        if (listener != null) {

            listener.onTaskAppeared(info.getTaskInfo(), info.getLeash());

        }

        notifyLocusVisibilityIfNeeded(info.getTaskInfo());

        notifySizeCompatUI(info.getTaskInfo(), listener);

    }
@@ -299,6 +344,7 @@ public class ShellTaskOrganizer extends TaskOrganizer { 
            if (!updated && newListener != null) {

                newListener.onTaskInfoChanged(taskInfo);

            }

            notifyLocusVisibilityIfNeeded(taskInfo);

            if (updated || !taskInfo.equalsForSizeCompat(data.getTaskInfo())) {

                // Notify the size compat UI if the listener or task info changed.

                notifySizeCompatUI(taskInfo, newListener);
@@ -327,6 +373,7 @@ public class ShellTaskOrganizer extends TaskOrganizer { 
            if (listener != null) {

                listener.onTaskVanished(taskInfo);

            }

            notifyLocusVisibilityIfNeeded(taskInfo);

            // Pass null for listener to remove the size compat UI on this task if there is any.

            notifySizeCompatUI(taskInfo, null /* taskListener */);

        }
@@ -355,6 +402,39 @@ public class ShellTaskOrganizer extends TaskOrganizer { 
        return true;

    }



    private void notifyLocusVisibilityIfNeeded(TaskInfo taskInfo) {

        final int taskId = taskInfo.taskId;

        final LocusId prevLocus = mVisibleTasksWithLocusId.get(taskId);

        final boolean sameLocus = Objects.equals(prevLocus, taskInfo.mTopActivityLocusId);

        if (prevLocus == null) {

            // New visible locus

            if (taskInfo.mTopActivityLocusId != null && taskInfo.isVisible) {

                mVisibleTasksWithLocusId.put(taskId, taskInfo.mTopActivityLocusId);

                notifyLocusIdChange(taskId, taskInfo.mTopActivityLocusId, true /* visible */);

            }

        } else if (sameLocus && !taskInfo.isVisible) {

            // Hidden locus

            mVisibleTasksWithLocusId.remove(taskId);

            notifyLocusIdChange(taskId, taskInfo.mTopActivityLocusId, false /* visible */);

        } else if (!sameLocus) {

            // Changed locus

            if (taskInfo.isVisible) {

                mVisibleTasksWithLocusId.put(taskId, taskInfo.mTopActivityLocusId);

                notifyLocusIdChange(taskId, prevLocus, false /* visible */);

                notifyLocusIdChange(taskId, taskInfo.mTopActivityLocusId, true /* visible */);

            } else {

                mVisibleTasksWithLocusId.remove(taskInfo.taskId);

                notifyLocusIdChange(taskId, prevLocus, false /* visible */);

            }

        }

    }



    private void notifyLocusIdChange(int taskId, LocusId locus, boolean visible) {

        for (int i = 0; i < mLocusIdListeners.size(); i++) {

            mLocusIdListeners.valueAt(i).onVisibilityChanged(taskId, locus, visible);

        }

    }



    /**

     * Notifies {@link SizeCompatUIController} about the size compat info changed on the give Task

     * to update the UI accordingly.

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

+134 −0
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ import static com.android.wm.shell.ShellTaskOrganizer.TASK_LISTENER_TYPE_FULLSCR 
import static com.android.wm.shell.ShellTaskOrganizer.TASK_LISTENER_TYPE_MULTI_WINDOW;

import static com.android.wm.shell.ShellTaskOrganizer.TASK_LISTENER_TYPE_PIP;



import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertFalse;

import static org.junit.Assert.assertTrue;

import static org.junit.Assert.fail;
@@ -37,10 +38,12 @@ import static org.mockito.Mockito.verify; 


import android.app.ActivityManager.RunningTaskInfo;

import android.content.Context;

import android.content.LocusId;

import android.content.pm.ParceledListSlice;

import android.os.Binder;

import android.os.IBinder;

import android.os.RemoteException;

import android.util.SparseArray;

import android.view.SurfaceControl;

import android.window.ITaskOrganizer;

import android.window.ITaskOrganizerController;
@@ -108,6 +111,20 @@ public class ShellTaskOrganizerTests { 
        }

    }



    private class TrackingLocusIdListener implements ShellTaskOrganizer.LocusIdListener {

        final SparseArray<LocusId> visibleLocusTasks = new SparseArray<>();

        final SparseArray<LocusId> invisibleLocusTasks = new SparseArray<>();

        @Override

        public void onVisibilityChanged(int taskId, LocusId locus, boolean visible) {

            if (visible) {

                visibleLocusTasks.put(taskId, locus);

            } else {

                invisibleLocusTasks.put(taskId, locus);

            }

        }

    }





    @Before

    public void setUp() {

        MockitoAnnotations.initMocks(this);
@@ -302,6 +319,123 @@ public class ShellTaskOrganizerTests { 
                null /* taskConfig */, null /* sizeCompatActivity*/, null /* taskListener */);

    }



    @Test

    public void testAddLocusListener() {

        RunningTaskInfo task1 = createTaskInfo(1, WINDOWING_MODE_MULTI_WINDOW);

        task1.isVisible = true;

        task1.mTopActivityLocusId = new LocusId("10");



        RunningTaskInfo task2 = createTaskInfo(2, WINDOWING_MODE_FULLSCREEN);

        task2.isVisible = true;

        task2.mTopActivityLocusId = new LocusId("20");



        RunningTaskInfo task3 = createTaskInfo(3, WINDOWING_MODE_FULLSCREEN);

        task3.isVisible = true;



        mOrganizer.onTaskAppeared(task1, null);

        mOrganizer.onTaskAppeared(task2, null);

        mOrganizer.onTaskAppeared(task3, null);



        TrackingLocusIdListener listener = new TrackingLocusIdListener();

        mOrganizer.addLocusIdListener(listener);



        // Listener should have the locus tasks even if added after the tasks appear

        assertEquals(listener.visibleLocusTasks.get(task1.taskId), task1.mTopActivityLocusId);

        assertEquals(listener.visibleLocusTasks.get(task2.taskId), task2.mTopActivityLocusId);

        assertFalse(listener.visibleLocusTasks.contains(task3.taskId));

    }



    @Test

    public void testLocusListener_appearVanish() {

        TrackingLocusIdListener listener = new TrackingLocusIdListener();

        mOrganizer.addLocusIdListener(listener);



        RunningTaskInfo task1 = createTaskInfo(1, WINDOWING_MODE_FULLSCREEN);

        task1.mTopActivityLocusId = new LocusId("10");



        task1.isVisible = true;

        mOrganizer.onTaskAppeared(task1, null);

        assertTrue(listener.visibleLocusTasks.contains(task1.taskId));

        assertEquals(listener.visibleLocusTasks.get(task1.taskId), task1.mTopActivityLocusId);



        task1.isVisible = false;

        mOrganizer.onTaskVanished(task1);

        assertTrue(listener.invisibleLocusTasks.contains(task1.taskId));

        assertEquals(listener.invisibleLocusTasks.get(task1.taskId), task1.mTopActivityLocusId);

    }



    @Test

    public void testLocusListener_infoChanged() {

        TrackingLocusIdListener listener = new TrackingLocusIdListener();

        mOrganizer.addLocusIdListener(listener);



        RunningTaskInfo task1 = createTaskInfo(1, WINDOWING_MODE_MULTI_WINDOW);

        task1.isVisible = true;

        mOrganizer.onTaskAppeared(task1, null);

        assertEquals(listener.visibleLocusTasks.size(), 0);



        task1.mTopActivityLocusId = new LocusId("10");

        mOrganizer.onTaskInfoChanged(task1);

        assertTrue(listener.visibleLocusTasks.contains(task1.taskId));

        assertEquals(listener.visibleLocusTasks.get(task1.taskId), task1.mTopActivityLocusId);



        LocusId prevLocus = task1.mTopActivityLocusId;

        task1.mTopActivityLocusId = new LocusId("20");

        mOrganizer.onTaskInfoChanged(task1);



        // New locus is in visible list

        assertTrue(listener.visibleLocusTasks.contains(task1.taskId));

        assertEquals(listener.visibleLocusTasks.get(task1.taskId), task1.mTopActivityLocusId);

        // Old locus in invisible list

        assertTrue(listener.invisibleLocusTasks.contains(task1.taskId));

        assertEquals(listener.invisibleLocusTasks.get(task1.taskId), prevLocus);

    }



    @Test

    public void testLocusListener_infoChanged_notVisible() {

        TrackingLocusIdListener listener = new TrackingLocusIdListener();

        mOrganizer.addLocusIdListener(listener);



        RunningTaskInfo task1 = createTaskInfo(1, WINDOWING_MODE_FULLSCREEN);

        task1.isVisible = true;

        mOrganizer.onTaskAppeared(task1, null);



        task1.mTopActivityLocusId = new LocusId("10");

        mOrganizer.onTaskInfoChanged(task1);

        assertTrue(listener.visibleLocusTasks.contains(task1.taskId));

        assertEquals(listener.visibleLocusTasks.get(task1.taskId), task1.mTopActivityLocusId);



        LocusId prevLocus = task1.mTopActivityLocusId;

        task1.mTopActivityLocusId = new LocusId("20");

        task1.isVisible = false;

        mOrganizer.onTaskInfoChanged(task1);



        // New locus for previously reported task in invisible list (since the task wasn't visible).

        assertTrue(listener.invisibleLocusTasks.contains(task1.taskId));

        assertEquals(listener.invisibleLocusTasks.get(task1.taskId), prevLocus);

    }



    @Test

    public void testLocusListener_noLocusNotNotified() {

        TrackingLocusIdListener listener = new TrackingLocusIdListener();

        mOrganizer.addLocusIdListener(listener);



        RunningTaskInfo task1 = createTaskInfo(1, WINDOWING_MODE_MULTI_WINDOW);

        task1.isVisible = true;

        mOrganizer.onTaskAppeared(task1, null);

        assertEquals(listener.visibleLocusTasks.size(), 0);

        assertEquals(listener.invisibleLocusTasks.size(), 0);



        mOrganizer.onTaskInfoChanged(task1);

        assertEquals(listener.visibleLocusTasks.size(), 0);

        assertEquals(listener.invisibleLocusTasks.size(), 0);



        task1.isVisible = false;

        mOrganizer.onTaskVanished(task1);

        assertEquals(listener.visibleLocusTasks.size(), 0);

        assertEquals(listener.invisibleLocusTasks.size(), 0);

    }



    private static RunningTaskInfo createTaskInfo(int taskId, int windowingMode) {

        RunningTaskInfo taskInfo = new RunningTaskInfo();

        taskInfo.taskId = taskId;