[ui] Pass 'Universe' to 'loadView' functions of view registrations

[email protected]

Bug: 451502260
Change-Id: I1f867ba59689d0a7830d9bdcfb76f36eb626da60
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/7207149
Auto-Submit: Simon Zünd <[email protected]>
Commit-Queue: Danil Somsikov <[email protected]>
Reviewed-by: Danil Somsikov <[email protected]>

Author: szuend

front_end/entrypoints/main/MainImpl.ts

@@ -132,6 +132,7 @@ let loadedPanelCommonModule: typeof PanelCommon|undefined;
 export class MainImpl {
   #readyForTestPromise = Promise.withResolvers<void>();
   #veStartPromise!: Promise<void>;
+  #universe!: Foundation.Universe.Universe;
 
   constructor() {
     MainImpl.instanceForTest = this;
@@ -175,8 +176,8 @@ export class MainImpl {
         runSettingsMigration: !Host.InspectorFrontendHost.isUnderTest(),
       },
     };
-    const universe = new Foundation.Universe.Universe(creationOptions);
-    Root.DevToolsContext.setGlobalInstance(universe.context);
+    this.#universe = new Foundation.Universe.Universe(creationOptions);
+    Root.DevToolsContext.setGlobalInstance(this.#universe.context);
 
     await this.requestAndRegisterLocaleData();
 
@@ -425,6 +426,7 @@ export class MainImpl {
         {forceNew: true, win: window, frontendHost: Host.InspectorFrontendHost.InspectorFrontendHostInstance});
     UI.ContextMenu.ContextMenu.initialize();
     UI.ContextMenu.ContextMenu.installHandler(document);
+    UI.ViewManager.ViewManager.instance({forceNew: true, universe: this.#universe});
 
     // These instances need to be created early so they don't miss any events about requests/issues/etc.
     Logs.NetworkLog.NetworkLog.instance();

front_end/ui/legacy/BUILD.gn

@@ -108,6 +108,7 @@ devtools_ui_module("ui") {
     "../../core/platform:bundle",
     "../../core/root:bundle",
     "../../core/sdk:bundle",
+    "../../foundation:bundle",
     "../../models/geometry:bundle",
     "../../models/text_utils:bundle",
     "../../ui/legacy/theme_support:bundle",

front_end/ui/legacy/ViewManager.test.ts

@@ -5,6 +5,7 @@
 import * as Common from '../../core/common/common.js';
 import type {EventTargetEvent} from '../../core/common/EventTarget.js';
 import * as i18n from '../../core/i18n/i18n.js';
+import * as Root from '../../core/root/root.js';
 import {describeWithEnvironment} from '../../testing/EnvironmentHelpers.js';
 
 import * as UI from './legacy.js';
@@ -94,7 +95,8 @@ describeWithEnvironment('ViewManager', () => {
       });
     }
 
-    viewManager = UI.ViewManager.ViewManager.instance({forceNew: true});
+    viewManager = UI.ViewManager.ViewManager.instance(
+        {forceNew: true, universe: {context: new Root.DevToolsContext.DevToolsContext()}});
     locationResolver.createLocation(UI.ViewManager.ViewLocationValues.PANEL, true, 'view-1');
     locationResolver.createLocation(UI.ViewManager.ViewLocationValues.DRAWER_VIEW, false, undefined);
   });

front_end/ui/legacy/ViewManager.ts

@@ -10,6 +10,7 @@ import * as Host from '../../core/host/host.js';
 import * as i18n from '../../core/i18n/i18n.js';
 import * as Platform from '../../core/platform/platform.js';
 import * as Root from '../../core/root/root.js';
+import type * as Foundation from '../../foundation/foundation.js';
 import * as IconButton from '../components/icon_button/icon_button.js';
 import * as VisualLogging from '../visual_logging/visual_logging.js';
 
@@ -52,10 +53,12 @@ export const defaultOptionsForTabs = {
 
 export class PreRegisteredView implements View {
   private readonly viewRegistration: ViewRegistration;
+  private readonly universe?: Foundation.Universe.Universe;
   private widgetPromise: Promise<Widget>|null;
 
-  constructor(viewRegistration: ViewRegistration) {
+  constructor(viewRegistration: ViewRegistration, universe?: Foundation.Universe.Universe) {
     this.viewRegistration = viewRegistration;
+    this.universe = universe;
     this.widgetPromise = null;
   }
 
@@ -124,7 +127,10 @@ export class PreRegisteredView implements View {
 
   widget(): Promise<Widget> {
     if (this.widgetPromise === null) {
-      this.widgetPromise = this.viewRegistration.loadView();
+      if (!this.universe) {
+        throw new Error('Creating views via ViewManager requires a Foundation.Universe');
+      }
+      this.widgetPromise = this.viewRegistration.loadView(this.universe);
     }
     return this.widgetPromise;
   }
@@ -170,7 +176,9 @@ export class ViewManager extends Common.ObjectWrapper.ObjectWrapper<EventTypes>
 
   private readonly preRegisteredViews: PreRegisteredView[] = [];
 
-  private constructor() {
+  // TODO(crbug.com/458180550): Pass the universe unconditionally once tests no longer rely
+  //   on `instance()` to create ViewManagers lazily in after/afterEach blocks.
+  private constructor(universe?: Foundation.Universe.Universe) {
     super();
 
     // Read override setting for location
@@ -184,7 +192,7 @@ export class ViewManager extends Common.ObjectWrapper.ObjectWrapper<EventTypes>
     for (const view of getRegisteredViewExtensions()) {
       const location = view.location || 'none';
       const views = viewsByLocation.get(location) || [];
-      views.push(new PreRegisteredView(view));
+      views.push(new PreRegisteredView(view, universe));
       viewsByLocation.set(location, views);
     }
 
@@ -220,10 +228,11 @@ export class ViewManager extends Common.ObjectWrapper.ObjectWrapper<EventTypes>
 
   static instance(opts: {
     forceNew: boolean|null,
+    universe?: Foundation.Universe.Universe,
   } = {forceNew: null}): ViewManager {
-    const {forceNew} = opts;
+    const {forceNew, universe} = opts;
     if (!viewManagerInstance || forceNew) {
-      viewManagerInstance = new ViewManager();
+      viewManagerInstance = new ViewManager(universe);
     }
 
     return viewManagerInstance;

front_end/ui/legacy/ViewRegistration.test.ts

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 import * as i18n from '../../core/i18n/i18n.js';
+import * as Root from '../../core/root/root.js';
 import {describeWithEnvironment} from '../../testing/EnvironmentHelpers.js';
 
 import * as QuickOpen from './components/quick_open/quick_open.js';
@@ -41,6 +42,8 @@ describeWithEnvironment('ViewRegistration', () => {
         return new MockView();
       },
     });
+    UI.ViewManager.ViewManager.instance(
+        {forceNew: true, universe: {context: new Root.DevToolsContext.DevToolsContext()}});
   });
 
   it('retrieves a registered view', async () => {

front_end/ui/legacy/ViewRegistration.ts

@@ -5,6 +5,7 @@
 import * as i18n from '../../core/i18n/i18n.js';
 import type * as Platform from '../../core/platform/platform.js';
 import * as Root from '../../core/root/root.js';
+import type * as Foundation from '../../foundation/foundation.js';
 
 import type {ViewLocationResolver} from './View.js';
 import type {Widget} from './Widget.js';
@@ -112,7 +113,11 @@ export interface ViewRegistration {
   /**
    * Returns an instance of the class that wraps the view.
    * The common pattern for implementing this function is loading the module with the wrapping 'Widget'
-   * lazily loaded. As an example:
+   * lazily loaded.
+   * The DevTools universe is passed along, allowing `loadView` to retrieve necessary dependencies.
+   * Prefer passing individual dependencies one by one instead of forwarding the full universe. This
+   * makes testing easier.
+   * As an example:
    *
    * ```js
    * let loadedElementsModule;
@@ -126,15 +131,16 @@ export interface ViewRegistration {
    * }
    * UI.ViewManager.registerViewExtension({
    *   <...>
-   *   async loadView() {
+   *   async loadView(universe) {
    *      const Elements = await loadElementsModule();
-   *      return Elements.ElementsPanel.ElementsPanel.instance();
+   *      const pageResourceLoader = universe.context.get(SDK.PageResourceLoader.PageResourceLoader);
+   *      return new Elements.ElementsPanel.ElementsPanel(pageResourceLoader);
    *   },
    *   <...>
    * });
    * ```
    */
-  loadView: () => Promise<Widget>;
+  loadView: (universe: Foundation.Universe.Universe) => Promise<Widget>;
   /**
    * Used to sort the views that appear in a shared location.
    */