[CS] Add WindowRootViewComponent to get access to the WindowRootView.
This pulls out the WindowRootView from CentralSurfacesComponent so that
we can finish removing CentralSurfacesComponent. The doc on
WindowRootViewComponent explains its existence and why we can't just
inject WindowRootView into NotificationShadeWindowController directly.
Bug: 277762009
Test: smoke test of the shade
Test: atest NotificationShadeWindowControllerImplTest
Change-Id: I8e67af46383a075688ac68c66fa641439e2079c5
diff --git a/packages/SystemUI/src/com/android/systemui/dagger/SystemUIModule.java b/packages/SystemUI/src/com/android/systemui/dagger/SystemUIModule.java
index 3bf9cc8..ade7684 100644
--- a/packages/SystemUI/src/com/android/systemui/dagger/SystemUIModule.java
+++ b/packages/SystemUI/src/com/android/systemui/dagger/SystemUIModule.java
@@ -77,6 +77,7 @@
import com.android.systemui.recents.Recents;
import com.android.systemui.retail.dagger.RetailModeModule;
import com.android.systemui.scene.SceneContainerFrameworkModule;
+import com.android.systemui.scene.ui.view.WindowRootViewComponent;
import com.android.systemui.screenrecord.ScreenRecordModule;
import com.android.systemui.screenshot.dagger.ScreenshotModule;
import com.android.systemui.security.data.repository.SecurityRepositoryModule;
@@ -225,7 +226,8 @@
DozeComponent.class,
ExpandableNotificationRowComponent.class,
KeyguardBouncerComponent.class,
- NotificationShelfComponent.class
+ NotificationShelfComponent.class,
+ WindowRootViewComponent.class,
})
public abstract class SystemUIModule {
diff --git a/packages/SystemUI/src/com/android/systemui/scene/ui/view/WindowRootViewComponent.kt b/packages/SystemUI/src/com/android/systemui/scene/ui/view/WindowRootViewComponent.kt
new file mode 100644
index 0000000..98c7d54
--- /dev/null
+++ b/packages/SystemUI/src/com/android/systemui/scene/ui/view/WindowRootViewComponent.kt
@@ -0,0 +1,46 @@
+/*
+ * Copyright (C) 2023 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.systemui.scene.ui.view
+
+import dagger.Subcomponent
+
+/**
+ * A component providing access to [WindowRootView].
+ *
+ * Injecting [WindowRootView] directly into controllers can lead to crash loops. This is because
+ * [WindowRootView] contains [NotificationStackScrollLayout] and that view accesses [Dependency.get]
+ * in its constructor. If [Dependency.get] is not set up when your controller is constructed (which
+ * is possible because there are no guarantees from Dagger about the order of construction), then
+ * trying to inflate [NotificationStackScrollLayout] will crash. This component provides a way to
+ * fetch [WindowRootView] after the full Dagger graph is set up, which ensures that the inflation
+ * won't fail.
+ *
+ * This component is intended to be *temporary* and *only used from [CentralSurfacesImpl]*. Once
+ * [Dependency.get] is removed from [NotificationStackScrollLayout], we should re-attempt injecting
+ * [WindowRootView] directly into its controller [NotificationShadeWindowController].
+ */
+@Subcomponent
+interface WindowRootViewComponent {
+
+ @Subcomponent.Factory
+ interface Factory {
+ fun create(): WindowRootViewComponent
+ }
+
+ /** Fetches the root view of the main SysUI window. */
+ fun getWindowRootView(): WindowRootView
+}
diff --git a/packages/SystemUI/src/com/android/systemui/shade/NotificationShadeWindowControllerImpl.java b/packages/SystemUI/src/com/android/systemui/shade/NotificationShadeWindowControllerImpl.java
index 6f726a2..ad9df72 100644
--- a/packages/SystemUI/src/com/android/systemui/shade/NotificationShadeWindowControllerImpl.java
+++ b/packages/SystemUI/src/com/android/systemui/shade/NotificationShadeWindowControllerImpl.java
@@ -57,6 +57,7 @@
import com.android.systemui.keyguard.KeyguardViewMediator;
import com.android.systemui.plugins.statusbar.StatusBarStateController;
import com.android.systemui.plugins.statusbar.StatusBarStateController.StateListener;
+import com.android.systemui.scene.ui.view.WindowRootViewComponent;
import com.android.systemui.statusbar.NotificationShadeWindowController;
import com.android.systemui.statusbar.StatusBarState;
import com.android.systemui.statusbar.SysuiStatusBarStateController;
@@ -91,6 +92,7 @@
private static final int MAX_STATE_CHANGES_BUFFER_SIZE = 100;
private final Context mContext;
+ private final WindowRootViewComponent.Factory mWindowRootViewComponentFactory;
private final WindowManager mWindowManager;
private final IActivityManager mActivityManager;
private final DozeParameters mDozeParameters;
@@ -129,8 +131,12 @@
new NotificationShadeWindowState.Buffer(MAX_STATE_CHANGES_BUFFER_SIZE);
@Inject
- public NotificationShadeWindowControllerImpl(Context context, WindowManager windowManager,
- IActivityManager activityManager, DozeParameters dozeParameters,
+ public NotificationShadeWindowControllerImpl(
+ Context context,
+ WindowRootViewComponent.Factory windowRootViewComponentFactory,
+ WindowManager windowManager,
+ IActivityManager activityManager,
+ DozeParameters dozeParameters,
StatusBarStateController statusBarStateController,
ConfigurationController configurationController,
KeyguardViewMediator keyguardViewMediator,
@@ -143,6 +149,7 @@
ShadeExpansionStateManager shadeExpansionStateManager,
ShadeWindowLogger logger) {
mContext = context;
+ mWindowRootViewComponentFactory = windowRootViewComponentFactory;
mWindowManager = windowManager;
mActivityManager = activityManager;
mDozeParameters = dozeParameters;
@@ -274,8 +281,9 @@
}
@Override
- public void setWindowRootView(ViewGroup view) {
- mWindowRootView = view;
+ public void fetchWindowRootView() {
+ WindowRootViewComponent component = mWindowRootViewComponentFactory.create();
+ mWindowRootView = component.getWindowRootView();
}
@Override
diff --git a/packages/SystemUI/src/com/android/systemui/statusbar/NotificationShadeWindowController.java b/packages/SystemUI/src/com/android/systemui/statusbar/NotificationShadeWindowController.java
index 5ac542b..e669556 100644
--- a/packages/SystemUI/src/com/android/systemui/statusbar/NotificationShadeWindowController.java
+++ b/packages/SystemUI/src/com/android/systemui/statusbar/NotificationShadeWindowController.java
@@ -59,8 +59,8 @@
*/
default void attach() {}
- /** Sets the notification shade view. */
- default void setWindowRootView(ViewGroup view) {}
+ /** Requests this class to fetch the notification shade view. */
+ default void fetchWindowRootView() {}
/** Gets the notification shade view. */
@Nullable
diff --git a/packages/SystemUI/src/com/android/systemui/statusbar/phone/CentralSurfacesImpl.java b/packages/SystemUI/src/com/android/systemui/statusbar/phone/CentralSurfacesImpl.java
index ccb87bf..42f570b 100644
--- a/packages/SystemUI/src/com/android/systemui/statusbar/phone/CentralSurfacesImpl.java
+++ b/packages/SystemUI/src/com/android/systemui/statusbar/phone/CentralSurfacesImpl.java
@@ -92,7 +92,6 @@
import android.view.MotionEvent;
import android.view.ThreadedRenderer;
import android.view.View;
-import android.view.ViewGroup;
import android.view.ViewRootImpl;
import android.view.WindowInsets;
import android.view.WindowInsetsController.Appearance;
@@ -1601,10 +1600,10 @@
CollapsedStatusBarFragment.class,
mCentralSurfacesComponent::createCollapsedStatusBarFragment);
- ViewGroup windowRootView = mCentralSurfacesComponent.getWindowRootView();
- // TODO(b/277762009): Inject [NotificationShadeWindowView] directly into the controller.
- // (Right now, there's a circular dependency.)
- mNotificationShadeWindowController.setWindowRootView(windowRootView);
+ // Ideally, NotificationShadeWindowController could automatically fetch the window root view
+ // in #attach or a CoreStartable.start method or something similar. But for now, to avoid
+ // regressions, we'll continue standing up the root view in CentralSurfaces.
+ mNotificationShadeWindowController.fetchWindowRootView();
getNotificationShadeWindowViewController().setupExpandedStatusBar();
mShadeController.setNotificationShadeWindowViewController(
getNotificationShadeWindowViewController());
diff --git a/packages/SystemUI/src/com/android/systemui/statusbar/phone/dagger/CentralSurfacesComponent.java b/packages/SystemUI/src/com/android/systemui/statusbar/phone/dagger/CentralSurfacesComponent.java
index bbbe16f..016c738 100644
--- a/packages/SystemUI/src/com/android/systemui/statusbar/phone/dagger/CentralSurfacesComponent.java
+++ b/packages/SystemUI/src/com/android/systemui/statusbar/phone/dagger/CentralSurfacesComponent.java
@@ -20,7 +20,6 @@
import static java.lang.annotation.RetentionPolicy.RUNTIME;
-import com.android.systemui.scene.ui.view.WindowRootView;
import com.android.systemui.shade.ShadeHeaderController;
import com.android.systemui.statusbar.notification.NotificationActivityStarter;
import com.android.systemui.statusbar.phone.CentralSurfacesCommandQueueCallbacks;
@@ -67,9 +66,6 @@
@Scope
@interface CentralSurfacesScope {}
- /** Creates the root view of the main SysUI window}. */
- WindowRootView getWindowRootView();
-
/**
* Creates a CentralSurfacesCommandQueueCallbacks.
*/
diff --git a/packages/SystemUI/tests/src/com/android/systemui/keyguard/KeyguardViewMediatorTest.java b/packages/SystemUI/tests/src/com/android/systemui/keyguard/KeyguardViewMediatorTest.java
index 4a79a21..377c5c7 100644
--- a/packages/SystemUI/tests/src/com/android/systemui/keyguard/KeyguardViewMediatorTest.java
+++ b/packages/SystemUI/tests/src/com/android/systemui/keyguard/KeyguardViewMediatorTest.java
@@ -97,6 +97,8 @@
import com.android.systemui.keyguard.ui.viewmodel.DreamingToLockscreenTransitionViewModel;
import com.android.systemui.log.SessionTracker;
import com.android.systemui.navigationbar.NavigationModeController;
+import com.android.systemui.scene.FakeWindowRootViewComponent;
+import com.android.systemui.scene.ui.view.WindowRootView;
import com.android.systemui.settings.UserTracker;
import com.android.systemui.shade.NotificationShadeWindowControllerImpl;
import com.android.systemui.shade.ShadeController;
@@ -229,11 +231,22 @@
.thenReturn(mock(Flow.class));
when(mDreamingToLockscreenTransitionViewModel.getTransitionEnded())
.thenReturn(mock(Flow.class));
- mNotificationShadeWindowController = new NotificationShadeWindowControllerImpl(mContext,
- mWindowManager, mActivityManager, mDozeParameters, mStatusBarStateController,
- mConfigurationController, mViewMediator, mKeyguardBypassController,
- mColorExtractor, mDumpManager, mKeyguardStateController,
- mScreenOffAnimationController, mAuthController, mShadeExpansionStateManager,
+ mNotificationShadeWindowController = new NotificationShadeWindowControllerImpl(
+ mContext,
+ new FakeWindowRootViewComponent.Factory(mock(WindowRootView.class)),
+ mWindowManager,
+ mActivityManager,
+ mDozeParameters,
+ mStatusBarStateController,
+ mConfigurationController,
+ mViewMediator,
+ mKeyguardBypassController,
+ mColorExtractor,
+ mDumpManager,
+ mKeyguardStateController,
+ mScreenOffAnimationController,
+ mAuthController,
+ mShadeExpansionStateManager,
mShadeWindowLogger);
mFeatureFlags = new FakeFeatureFlags();
mFeatureFlags.set(Flags.KEYGUARD_WM_STATE_REFACTOR, false);
diff --git a/packages/SystemUI/tests/src/com/android/systemui/scene/FakeWindowRootViewComponent.kt b/packages/SystemUI/tests/src/com/android/systemui/scene/FakeWindowRootViewComponent.kt
new file mode 100644
index 0000000..63a05d7
--- /dev/null
+++ b/packages/SystemUI/tests/src/com/android/systemui/scene/FakeWindowRootViewComponent.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2023 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.systemui.scene
+
+import com.android.systemui.scene.ui.view.WindowRootView
+import com.android.systemui.scene.ui.view.WindowRootViewComponent
+
+class FakeWindowRootViewComponent(private val view: WindowRootView) : WindowRootViewComponent {
+ override fun getWindowRootView(): WindowRootView {
+ return view
+ }
+
+ class Factory(private val view: WindowRootView) : WindowRootViewComponent.Factory {
+ override fun create(): WindowRootViewComponent = FakeWindowRootViewComponent(view)
+ }
+}
diff --git a/packages/SystemUI/tests/src/com/android/systemui/shade/NotificationShadeWindowControllerImplTest.java b/packages/SystemUI/tests/src/com/android/systemui/shade/NotificationShadeWindowControllerImplTest.java
index cde6ac0..1738b06 100644
--- a/packages/SystemUI/tests/src/com/android/systemui/shade/NotificationShadeWindowControllerImplTest.java
+++ b/packages/SystemUI/tests/src/com/android/systemui/shade/NotificationShadeWindowControllerImplTest.java
@@ -53,6 +53,7 @@
import com.android.systemui.dump.DumpManager;
import com.android.systemui.keyguard.KeyguardViewMediator;
import com.android.systemui.plugins.statusbar.StatusBarStateController;
+import com.android.systemui.scene.FakeWindowRootViewComponent;
import com.android.systemui.statusbar.StatusBarState;
import com.android.systemui.statusbar.SysuiStatusBarStateController;
import com.android.systemui.statusbar.phone.DozeParameters;
@@ -114,11 +115,22 @@
when(mDozeParameters.getAlwaysOn()).thenReturn(true);
when(mColorExtractor.getNeutralColors()).thenReturn(mGradientColors);
- mNotificationShadeWindowController = new NotificationShadeWindowControllerImpl(mContext,
- mWindowManager, mActivityManager, mDozeParameters, mStatusBarStateController,
- mConfigurationController, mKeyguardViewMediator, mKeyguardBypassController,
- mColorExtractor, mDumpManager, mKeyguardStateController,
- mScreenOffAnimationController, mAuthController, mShadeExpansionStateManager,
+ mNotificationShadeWindowController = new NotificationShadeWindowControllerImpl(
+ mContext,
+ new FakeWindowRootViewComponent.Factory(mNotificationShadeWindowView),
+ mWindowManager,
+ mActivityManager,
+ mDozeParameters,
+ mStatusBarStateController,
+ mConfigurationController,
+ mKeyguardViewMediator,
+ mKeyguardBypassController,
+ mColorExtractor,
+ mDumpManager,
+ mKeyguardStateController,
+ mScreenOffAnimationController,
+ mAuthController,
+ mShadeExpansionStateManager,
mShadeWindowLogger) {
@Override
protected boolean isDebuggable() {
@@ -126,7 +138,7 @@
}
};
mNotificationShadeWindowController.setScrimsVisibilityListener((visibility) -> {});
- mNotificationShadeWindowController.setWindowRootView(mNotificationShadeWindowView);
+ mNotificationShadeWindowController.fetchWindowRootView();
mNotificationShadeWindowController.attach();
verify(mWindowManager).addView(eq(mNotificationShadeWindowView), any());
diff --git a/packages/SystemUI/tests/src/com/android/systemui/wmshell/BubblesTest.java b/packages/SystemUI/tests/src/com/android/systemui/wmshell/BubblesTest.java
index e10a80c..7ebf6c8 100644
--- a/packages/SystemUI/tests/src/com/android/systemui/wmshell/BubblesTest.java
+++ b/packages/SystemUI/tests/src/com/android/systemui/wmshell/BubblesTest.java
@@ -96,6 +96,7 @@
import com.android.systemui.keyguard.KeyguardViewMediator;
import com.android.systemui.model.SysUiState;
import com.android.systemui.plugins.statusbar.StatusBarStateController;
+import com.android.systemui.scene.FakeWindowRootViewComponent;
import com.android.systemui.settings.FakeDisplayTracker;
import com.android.systemui.settings.UserTracker;
import com.android.systemui.shade.NotificationShadeWindowControllerImpl;
@@ -330,13 +331,24 @@
when(mNotificationShadeWindowView.getViewTreeObserver())
.thenReturn(mock(ViewTreeObserver.class));
- mNotificationShadeWindowController = new NotificationShadeWindowControllerImpl(mContext,
- mWindowManager, mActivityManager, mDozeParameters, mStatusBarStateController,
- mConfigurationController, mKeyguardViewMediator, mKeyguardBypassController,
- mColorExtractor, mDumpManager, mKeyguardStateController,
- mScreenOffAnimationController, mAuthController, mShadeExpansionStateManager,
+ mNotificationShadeWindowController = new NotificationShadeWindowControllerImpl(
+ mContext,
+ new FakeWindowRootViewComponent.Factory(mNotificationShadeWindowView),
+ mWindowManager,
+ mActivityManager,
+ mDozeParameters,
+ mStatusBarStateController,
+ mConfigurationController,
+ mKeyguardViewMediator,
+ mKeyguardBypassController,
+ mColorExtractor,
+ mDumpManager,
+ mKeyguardStateController,
+ mScreenOffAnimationController,
+ mAuthController,
+ mShadeExpansionStateManager,
mShadeWindowLogger);
- mNotificationShadeWindowController.setWindowRootView(mNotificationShadeWindowView);
+ mNotificationShadeWindowController.fetchWindowRootView();
mNotificationShadeWindowController.attach();
mAppBubbleIntent = new Intent(mContext, BubblesTestActivity.class);