/*
 * Copyright (C) 2018 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.server.wm;

import static android.app.WindowConfiguration.WINDOWING_MODE_FREEFORM;
import static android.app.WindowConfiguration.WINDOWING_MODE_MULTI_WINDOW;
import static android.app.WindowConfiguration.WINDOWING_MODE_PINNED;
import static android.view.InsetsSource.ID_IME;
import static android.view.WindowInsets.Type.ime;
import static android.view.WindowInsets.Type.navigationBars;
import static android.view.WindowInsets.Type.statusBars;
import static android.view.WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM;
import static android.view.WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE;
import static android.view.WindowManager.LayoutParams.LAST_APPLICATION_WINDOW;
import static android.view.WindowManager.LayoutParams.TYPE_APPLICATION;
import static android.view.WindowManager.LayoutParams.TYPE_INPUT_METHOD;

import static com.android.dx.mockito.inline.extended.ExtendedMockito.doReturn;
import static com.android.dx.mockito.inline.extended.ExtendedMockito.spyOn;
import static com.android.server.wm.WindowContainer.POSITION_TOP;
import static com.android.server.wm.WindowStateAnimator.HAS_DRAWN;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.Mockito.atLeastOnce;
import static org.mockito.Mockito.clearInvocations;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;

import android.graphics.Rect;
import android.platform.test.annotations.Presubmit;
import android.util.SparseArray;
import android.view.InsetsSource;
import android.view.InsetsSourceControl;
import android.view.InsetsState;
import android.view.WindowInsets.Type.InsetsType;

import androidx.test.filters.SmallTest;

import com.android.internal.util.function.TriFunction;

import org.junit.Test;
import org.junit.runner.RunWith;

@SmallTest
@Presubmit
@RunWith(WindowTestRunner.class)
public class InsetsStateControllerTest extends WindowTestsBase {

    private static final int ID_STATUS_BAR =
            InsetsSource.createId(null /* owner */, 0 /* index */, statusBars());
    private static final int ID_NAVIGATION_BAR =
            InsetsSource.createId(null /* owner */, 0 /* index */, navigationBars());
    private static final int ID_CLIMATE_BAR =
            InsetsSource.createId(null /* owner */, 1 /* index */, statusBars());
    private static final int ID_EXTRA_NAVIGATION_BAR =
            InsetsSource.createId(null /* owner */, 1 /* index */, navigationBars());

    @Test
    public void testStripForDispatch_navBar() {
        final WindowState navBar = newWindowBuilder("navBar", TYPE_APPLICATION).build();
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState ime = newWindowBuilder("ime", TYPE_APPLICATION).build();

        // IME cannot be the IME layering target.
        ime.mAttrs.flags |= FLAG_NOT_FOCUSABLE;

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(ime, null, null);

        assertNull(navBar.getInsetsState().peekSource(ID_IME));
        assertNull(navBar.getInsetsState().peekSource(ID_STATUS_BAR));
    }

    @Test
    public void testStripForDispatch_pip() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState navBar = newWindowBuilder("navBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);
        app.setWindowingMode(WINDOWING_MODE_PINNED);

        assertNull(app.getInsetsState().peekSource(ID_STATUS_BAR));
        assertNull(app.getInsetsState().peekSource(ID_NAVIGATION_BAR));
        assertNull(app.getInsetsState().peekSource(ID_IME));
    }

    @Test
    public void testStripForDispatch_freeform() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState navBar = newWindowBuilder("navBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);
        app.setWindowingMode(WINDOWING_MODE_FREEFORM);

        assertNull(app.getInsetsState().peekSource(ID_STATUS_BAR));
        assertNull(app.getInsetsState().peekSource(ID_NAVIGATION_BAR));
    }

    @Test
    public void testStripForDispatch_multiwindow_alwaysOnTop() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState navBar = newWindowBuilder("navBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);
        app.setWindowingMode(WINDOWING_MODE_MULTI_WINDOW);
        app.setAlwaysOnTop(true);

        assertNull(app.getInsetsState().peekSource(ID_STATUS_BAR));
        assertNull(app.getInsetsState().peekSource(ID_NAVIGATION_BAR));
    }

    @SetupWindows(addWindows = W_INPUT_METHOD)
    @Test
    public void testStripForDispatch_independentSources() {
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(mImeWindow, null, null);

        final WindowState app1 = newWindowBuilder("app1", TYPE_APPLICATION).build();
        final WindowState app2 = newWindowBuilder("app2", TYPE_APPLICATION).build();

        app1.mAboveInsetsState.addSource(getController().getRawInsetsState().peekSource(ID_IME));

        getController().getRawInsetsState().setSourceVisible(ID_IME, true);
        assertFalse(app2.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
        assertTrue(app1.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
    }

    @SetupWindows(addWindows = W_INPUT_METHOD)
    @Test
    public void testStripForDispatch_belowIme() {
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(mImeWindow, null, null);

        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        app.mAboveInsetsState.getOrCreateSource(ID_IME, ime())
                .setVisible(true)
                .setFrame(mImeWindow.getFrame());

        getController().getRawInsetsState().setSourceVisible(ID_IME, true);
        assertTrue(app.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
    }

    @SetupWindows(addWindows = W_INPUT_METHOD)
    @Test
    public void testStripForDispatch_aboveIme() {
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(mImeWindow, null, null);

        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();

        getController().getRawInsetsState().setSourceVisible(ID_IME, true);
        assertFalse(app.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
    }

    @SetupWindows(addWindows = W_INPUT_METHOD)
    @Test
    public void testStripForDispatch_imeOrderChanged() {
        // This can be the IME z-order target while app cannot be the IME z-order target.
        // This is also the only IME control target in this test, so IME won't be invisible caused
        // by the control-target change.
        final WindowState base = newWindowBuilder("base", TYPE_APPLICATION).build();
        mDisplayContent.updateImeInputAndControlTarget(base);

        // Make IME and stay visible during the test.
        mImeWindow.setHasSurface(true);
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(mImeWindow, null, null);
        getController().onImeControlTargetChanged(base);
        final @InsetsType int changedTypes = base.setRequestedVisibleTypes(ime(), ime());
        getController().onRequestedVisibleTypesChanged(base, changedTypes, null /* statsToken */);
        // to set the serverVisibility, the IME needs to be drawn and onPostLayout be called.
        mImeWindow.mWinAnimator.mDrawState = HAS_DRAWN;
        getController().onPostLayout();

        // Send our spy window (app) into the system so that we can detect the invocation.
        final WindowState win = newWindowBuilder("app", TYPE_APPLICATION).build();
        win.setHasSurface(true);
        final WindowToken parent = win.mToken;
        parent.removeChild(win);
        final WindowState app = spy(win);
        parent.addWindow(app);

        // Adding FLAG_NOT_FOCUSABLE makes app above IME.
        app.mAttrs.flags |= FLAG_NOT_FOCUSABLE;
        mDisplayContent.computeImeLayeringTarget(true /* update */);
        mDisplayContent.applySurfaceChangesTransaction();

        // app won't get visible IME insets while above IME even when IME is visible.
        assertTrue(getController().getRawInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
        assertFalse(app.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));

        // Reset invocation counter.
        clearInvocations(app);

        // Removing FLAG_NOT_FOCUSABLE makes app below IME.
        app.mAttrs.flags &= ~FLAG_NOT_FOCUSABLE;
        mDisplayContent.computeImeLayeringTarget(true /* update */);
        mDisplayContent.applySurfaceChangesTransaction();
        app.mAboveInsetsState.getOrCreateSource(ID_IME, ime())
                .setVisible(true)
                .setFrame(mImeWindow.getFrame());

        // Make sure app got notified.
        verify(app, atLeastOnce()).notifyInsetsChanged();

        // app will get visible IME insets while below IME.
        assertTrue(app.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
    }

    @SetupWindows(addWindows = W_INPUT_METHOD)
    @Test
    public void testStripForDispatch_childWindow_altFocusable() {
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(mImeWindow, null, null);

        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        final WindowState child = newWindowBuilder("child", TYPE_APPLICATION).setParent(
                app).build();
        app.mAboveInsetsState.set(getController().getRawInsetsState());
        child.mAboveInsetsState.set(getController().getRawInsetsState());
        child.mAttrs.flags |= FLAG_ALT_FOCUSABLE_IM;

        mDisplayContent.computeImeLayeringTarget(true /* update */);
        mDisplayContent.setLayoutNeeded();
        mDisplayContent.applySurfaceChangesTransaction();

        getController().getRawInsetsState().setSourceVisible(ID_IME, true);
        assertTrue(app.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
        assertFalse(child.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
    }

    @SetupWindows(addWindows = W_INPUT_METHOD)
    @Test
    public void testStripForDispatch_childWindow_splitScreen() {
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(mImeWindow, null, null);

        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        final WindowState child = newWindowBuilder("child", TYPE_APPLICATION).setParent(
                app).build();
        app.mAboveInsetsState.addSource(getController().getRawInsetsState().peekSource(ID_IME));
        child.mAttrs.flags |= FLAG_NOT_FOCUSABLE;
        child.setWindowingMode(WINDOWING_MODE_MULTI_WINDOW);

        mDisplayContent.computeImeLayeringTarget(true /* update */);
        mDisplayContent.setLayoutNeeded();
        mDisplayContent.applySurfaceChangesTransaction();

        getController().getRawInsetsState().setSourceVisible(ID_IME, true);
        assertTrue(app.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
        assertFalse(child.getInsetsState().isSourceOrDefaultVisible(ID_IME, ime()));
    }

    @Test
    public void testImeForDispatch() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState ime = newWindowBuilder("ime", TYPE_INPUT_METHOD).build();

        makeWindowVisible(statusBar);

        // IME cannot be the IME layering target.
        ime.mAttrs.flags |= FLAG_NOT_FOCUSABLE;

        InsetsSourceProvider statusBarProvider =
                getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars());
        final SparseArray<TriFunction<DisplayFrames, WindowState, Rect, Integer>>
                imeOverrideProviders = new SparseArray<>();
        imeOverrideProviders.put(TYPE_INPUT_METHOD, ((displayFrames, windowState, rect) -> {
            rect.set(0, 1, 2, 3);
            return 0;
        }));
        statusBarProvider.setWindow(statusBar, null, imeOverrideProviders);
        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(ime, null, null);
        statusBar.setControllableInsetProvider(statusBarProvider);
        statusBar.updateSourceFrame(statusBar.getFrame());

        statusBarProvider.onPostLayout();

        final InsetsState state = ime.getInsetsState();
        assertEquals(new Rect(0, 1, 2, 3), state.peekSource(ID_STATUS_BAR).getFrame());
    }

    @Test
    public void testBarControllingWinChanged() {
        final WindowState navBar = newWindowBuilder("navBar", TYPE_APPLICATION).build();
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState climateBar = newWindowBuilder("climateBar", TYPE_APPLICATION).build();
        final WindowState extraNavBar = newWindowBuilder("extraNavBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);
        getController().getOrCreateSourceProvider(ID_CLIMATE_BAR, statusBars())
                .setWindow(climateBar, null, null);
        getController().getOrCreateSourceProvider(ID_EXTRA_NAVIGATION_BAR, navigationBars())
                .setWindow(extraNavBar, null, null);
        getController().onBarControlTargetChanged(app, null, app, null);
        InsetsSourceControl[] controls = getController().getControlsForDispatch(app);
        assertEquals(4, controls.length);
    }

    @Test
    public void testControlRevoked() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().onBarControlTargetChanged(app, null, null, null);
        assertNotNull(getController().getControlsForDispatch(app));
        getController().onBarControlTargetChanged(null, null, null, null);
        assertNull(getController().getControlsForDispatch(app));
    }

    @Test
    public void testControlRevoked_animation() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().onBarControlTargetChanged(app, null, null, null);
        assertNotNull(getController().getControlsForDispatch(app));
        statusBar.cancelAnimation();
        assertNull(getController().getControlsForDispatch(app));
    }

    /**
     * Verifies that removing the IME window will notify the control target that it lost control
     * of the IME.
     */
    @Test
    public void testImeWindowRemoved_notifiesInsetsControlChanged() {
        final WindowState ime = newWindowBuilder("ime", TYPE_INPUT_METHOD).build();
        spyOn(ime);
        final WindowState app = createTestWindow("app");

        // Set app as IME control target
        final var imeInsetsProvider = getController().getOrCreateSourceProvider(ID_IME, ime());
        imeInsetsProvider.setWindow(ime, null, null);
        getController().onImeControlTargetChanged(app);
        assertTrue("App has IME as pending control, is at is being set",
                getController().hasPendingControls(app));

        var controls = getController().getControlsForDispatch(app);
        assertNotNull("controlsForDispatch should be not null", controls);
        InsetsSourceControl imeControl = null;
        for (var control : controls) {
            if (control.getType() == ime()) {
                imeControl = control;
                break;
            }
        }
        assertNotNull("imeControl should be found", imeControl);

        // Dispatch gaining IME control to app.
        performSurfacePlacementAndWaitForWindowAnimator();
        assertFalse("App has no pending controls as adding IME was dispatched",
                getController().hasPendingControls(app));
        verify(app).notifyInsetsControlChanged(mDisplayContent.mDisplayId);

        // Reset invocation counter.
        clearInvocations(app);

        // Remove IME window, which will cancelAnimation. This will clear the control target of the
        // imeInsetsProvider, remove it from the control map, and add it to the pending control map.
        ime.removeImmediately();
        verify(ime).cancelAnimation();
        assertTrue("App has IME as pending control, as it is being removed",
                getController().hasPendingControls(app));
        assertNull("controlsForDispatch should be null",
                getController().getControlsForDispatch(app));

        // Dispatch losing IME control to app.
        performSurfacePlacementAndWaitForWindowAnimator();
        assertFalse("App has no pending controls as removing IME was dispatched",
                getController().hasPendingControls(app));

        verify(app).notifyInsetsControlChanged(mDisplayContent.mDisplayId);
    }

    @Test
    public void testControlTargetChangedWhileProviderHasNoWindow() {
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        final InsetsSourceProvider provider = getController().getOrCreateSourceProvider(
                ID_STATUS_BAR, statusBars());
        getController().onBarControlTargetChanged(app, null, null, null);
        assertNull(getController().getControlsForDispatch(app));
        provider.setWindow(newWindowBuilder("statusBar", TYPE_APPLICATION).build(), null,
                null);
        assertNotNull(getController().getControlsForDispatch(app));
    }

    @Test
    public void testTransientVisibilityOfFixedRotationState() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        final InsetsSourceProvider provider = getController()
                .getOrCreateSourceProvider(ID_STATUS_BAR, statusBars());
        provider.setWindow(statusBar, null, null);

        final InsetsState rotatedState = new InsetsState(app.getInsetsState(),
                true /* copySources */);
        rotatedState.getOrCreateSource(ID_STATUS_BAR, statusBars());
        spyOn(app.mToken);
        doReturn(rotatedState).when(app.mToken).getFixedRotationTransformInsetsState();
        assertTrue(rotatedState.isSourceOrDefaultVisible(ID_STATUS_BAR, statusBars()));

        app.setRequestedVisibleTypes(0, statusBars());
        mDisplayContent.getDisplayPolicy().focusChangedLw(null /* lastFocus */, app);
        mDisplayContent.getInsetsPolicy().showTransient(statusBars(),
                true /* isGestureOnSystemBar */);
        mWm.mAnimator.ready();
        waitUntilWindowAnimatorIdle();

        assertTrue(mDisplayContent.getInsetsPolicy().isTransient(statusBars()));
        assertFalse(app.getInsetsState().isSourceOrDefaultVisible(ID_STATUS_BAR, statusBars()));
    }

    @Test
    public void testUpdateAboveInsetsState_provideInsets() {
        final WindowState app = createTestWindow("app");
        final WindowState statusBar = createTestWindow("statusBar");
        final WindowState navBar = createTestWindow("navBar");

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);

        assertNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNull(statusBar.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNull(navBar.mAboveInsetsState.peekSource(ID_STATUS_BAR));

        getController().updateAboveInsetsState(true /* notifyInsetsChange */);

        assertNotNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNull(statusBar.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNull(navBar.mAboveInsetsState.peekSource(ID_STATUS_BAR));

        verify(app, atLeastOnce()).notifyInsetsChanged();
    }

    @Test
    public void testUpdateAboveInsetsState_receiveInsets() {
        final WindowState app = createTestWindow("app");
        final WindowState statusBar = createTestWindow("statusBar");
        final WindowState navBar = createTestWindow("navBar");

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);

        assertNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNull(app.mAboveInsetsState.peekSource(ID_NAVIGATION_BAR));

        getController().updateAboveInsetsState(true /* notifyInsetsChange */);

        assertNotNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNotNull(app.mAboveInsetsState.peekSource(ID_NAVIGATION_BAR));

        verify(app, atLeastOnce()).notifyInsetsChanged();
    }

    @Test
    public void testUpdateAboveInsetsState_zOrderChanged() {
        final WindowState ime = createNonAppWindow("ime");
        final WindowState app = createNonAppWindow("app");
        final WindowState statusBar = createNonAppWindow("statusBar");
        final WindowState navBar = createNonAppWindow("navBar");

        final InsetsSourceProvider imeSourceProvider =
                getController().getOrCreateSourceProvider(ID_IME, ime());
        imeSourceProvider.setWindow(ime, null, null);
        imeSourceProvider.setServerVisible(true);

        waitUntilHandlersIdle();
        clearInvocations(mDisplayContent);
        imeSourceProvider.updateControlForTarget(app, false /* force */, null /* statsToken */);
        imeSourceProvider.setClientVisible(true);
        verify(mDisplayContent).assignWindowLayers(anyBoolean());
        waitUntilHandlersIdle();
        // The visibility change should trigger a traversal to notify the change.
        verify(mDisplayContent).notifyInsetsChanged(any());

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);

        getController().updateAboveInsetsState(false /* notifyInsetsChange */);

        // ime is below others.
        assertNull(app.mAboveInsetsState.peekSource(ID_IME));
        assertNull(statusBar.mAboveInsetsState.peekSource(ID_IME));
        assertNull(navBar.mAboveInsetsState.peekSource(ID_IME));
        assertNotNull(ime.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNotNull(ime.mAboveInsetsState.peekSource(ID_NAVIGATION_BAR));

        ime.getParent().positionChildAt(POSITION_TOP, ime, true /* includingParents */);
        getController().updateAboveInsetsState(true /* notifyInsetsChange */);

        // ime is above others.
        assertNotNull(app.mAboveInsetsState.peekSource(ID_IME));
        assertNotNull(statusBar.mAboveInsetsState.peekSource(ID_IME));
        assertNotNull(navBar.mAboveInsetsState.peekSource(ID_IME));
        assertNull(ime.mAboveInsetsState.peekSource(ID_STATUS_BAR));
        assertNull(ime.mAboveInsetsState.peekSource(ID_NAVIGATION_BAR));

        verify(ime, atLeastOnce()).notifyInsetsChanged();
        verify(app, atLeastOnce()).notifyInsetsChanged();
        verify(statusBar, atLeastOnce()).notifyInsetsChanged();
        verify(navBar, atLeastOnce()).notifyInsetsChanged();
    }

    /**
     * Verifies that moving the insets receiving window (app) to another display will stop the
     * window from receiving insets from the original display.
     */
    @UseTestDisplay
    @Test
    public void testUpdateAboveInsetsState_onDisplayChanged_app() {
        final WindowState app = createTestWindow("app");
        final WindowState statusBar = createTestWindow("statusBar");

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);

        assertNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));

        getController().updateAboveInsetsState(true /* notifyInsetsChange */);

        assertNotNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));

        app.getTask().reparent(mDefaultDisplay.getDefaultTaskDisplayArea(), true /* onTop */);

        assertNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));
    }

    /**
     * Verifies that moving the insets providing window (statusBar) to another display will stop the
     * window on the original display from receiving the insets.
     */
    @UseTestDisplay
    @Test
    public void testUpdateAboveInsetsState_onDisplayChanged_statusBar() {
        final WindowState app = createTestWindow("app");
        final WindowState statusBar = createTestWindow("statusBar");

        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);

        assertNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));

        getController().updateAboveInsetsState(true /* notifyInsetsChange */);

        assertNotNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));

        statusBar.getTask().reparent(mDefaultDisplay.getDefaultTaskDisplayArea(), true /* onTop */);

        assertNull(app.mAboveInsetsState.peekSource(ID_STATUS_BAR));
    }

    @Test
    public void testUpdateAboveInsetsState_imeTargetOnScreenBehavior() {
        final WindowToken imeToken = createTestWindowToken(TYPE_INPUT_METHOD, mDisplayContent);
        final WindowState ime = newWindowBuilder("ime", TYPE_INPUT_METHOD).setWindowToken(
                imeToken).build();
        final WindowState app = createTestWindow("app");

        getController().getOrCreateSourceProvider(ID_IME, ime())
                .setWindow(ime, null, null);
        ime.getControllableInsetProvider().setServerVisible(true);

        app.mActivityRecord.setVisibility(true);
        mDisplayContent.setImeLayeringTarget(app);
        mDisplayContent.updateImeInputAndControlTarget(app);

        final @InsetsType int changedTypes = app.setRequestedVisibleTypes(ime(), ime());
        getController().onRequestedVisibleTypesChanged(app, changedTypes, null /* statsToken */);
        assertTrue(ime.getControllableInsetProvider().getSource().isVisible());

        // The IME is only set to shown, after onPostLayout is called and all preconditions
        // (serverVisible, no givenInsetsPending, etc.) are fulfilled
        getController().getImeSourceProvider().onPostLayout();

        getController().updateAboveInsetsState(true /* notifyInsetsChange */);
        assertNotNull(app.getInsetsState().peekSource(ID_IME));
        verify(app, atLeastOnce()).notifyInsetsChanged();

        // Expect the app will still get IME insets even when the app was invisible.
        // (i.e. app invisible after locking the device)
        app.mActivityRecord.setVisible(false);
        app.setHasSurface(false);
        getController().updateAboveInsetsState(true /* notifyInsetsChange */);
        assertNotNull(app.getInsetsState().peekSource(ID_IME));
        verify(app, atLeastOnce()).notifyInsetsChanged();

        // Expect the app will get IME insets when the app is requesting visible.
        // (i.e. app is going to visible when unlocking the device)
        app.mActivityRecord.setVisibility(true);
        assertTrue(app.isVisibleRequested());
        getController().updateAboveInsetsState(true /* notifyInsetsChange */);
        assertNotNull(app.getInsetsState().peekSource(ID_IME));
        verify(app, atLeastOnce()).notifyInsetsChanged();
    }

    @Test
    public void testDispatchGlobalInsets() {
        final WindowState navBar = newWindowBuilder("navBar", TYPE_APPLICATION).build();
        getController().getOrCreateSourceProvider(ID_NAVIGATION_BAR, navigationBars())
                .setWindow(navBar, null, null);
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        assertNull(app.getInsetsState().peekSource(ID_NAVIGATION_BAR));
        app.mAttrs.receiveInsetsIgnoringZOrder = true;
        assertNotNull(app.getInsetsState().peekSource(ID_NAVIGATION_BAR));
    }

    @SetupWindows(addWindows = W_INPUT_METHOD)
    @Test
    public void testGetInsetsHintForNewControl() {
        final WindowState app1 = createTestWindow("app1");
        final WindowState app2 = createTestWindow("app2");

        makeWindowVisible(mImeWindow);
        final InsetsSourceProvider imeInsetsProvider =
                getController().getOrCreateSourceProvider(ID_IME, ime());
        imeInsetsProvider.setWindow(mImeWindow, null, null);
        imeInsetsProvider.updateSourceFrame(mImeWindow.getFrame());

        imeInsetsProvider.updateControlForTarget(app1, false, null /* statsToken */);
        imeInsetsProvider.onPostLayout();
        final InsetsSourceControl control1 = imeInsetsProvider.getControl(app1);
        assertNotNull(control1);
        assertEquals(imeInsetsProvider.getSource().getFrame().height(),
                control1.getInsetsHint().bottom);

        // Simulate the IME control target updated from app1 to app2 when IME insets was invisible.
        imeInsetsProvider.setServerVisible(false);
        imeInsetsProvider.updateControlForTarget(app2, false, null /* statsToken */);

        // Verify insetsHint of the new control is same as last IME source frame after the layout.
        imeInsetsProvider.onPostLayout();
        final InsetsSourceControl control2 = imeInsetsProvider.getControl(app2);
        assertNotNull(control2);
        assertEquals(imeInsetsProvider.getSource().getFrame().height(),
                control2.getInsetsHint().bottom);
    }

    @Test
    public void testHasPendingControls() {
        final WindowState statusBar = newWindowBuilder("statusBar", TYPE_APPLICATION).build();
        final WindowState app = newWindowBuilder("app", TYPE_APPLICATION).build();
        getController().getOrCreateSourceProvider(ID_STATUS_BAR, statusBars())
                .setWindow(statusBar, null, null);
        // No controls dispatched yet.
        assertFalse(getController().hasPendingControls(app));

        getController().onBarControlTargetChanged(app, null, null, null);
        // Controls pending to be dispatched.
        assertTrue(getController().hasPendingControls(app));

        performSurfacePlacementAndWaitForWindowAnimator();
        // Pending controls were dispatched.
        assertFalse(getController().hasPendingControls(app));
    }

    /** Creates a window which is associated with ActivityRecord. */
    private WindowState createTestWindow(String name) {
        final WindowState win = newWindowBuilder(name, TYPE_APPLICATION).build();
        win.setHasSurface(true);
        spyOn(win);
        return win;
    }

    /** Creates a non-activity window. */
    private WindowState createNonAppWindow(String name) {
        final WindowState win = newWindowBuilder(name, LAST_APPLICATION_WINDOW + 1).build();
        win.setHasSurface(true);
        spyOn(win);
        return win;
    }

    private InsetsStateController getController() {
        return mDisplayContent.getInsetsStateController();
    }
}