Extract React Application as a Feature (#7441)

* Fix webpack config for react Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Introduce package for discovering html elements in unit tests Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using discovery of html elements from package Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Introduce competition for starting react application inside the Feature Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Move stuff in application start to earlier timeslot having no real need to be done so late Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using react application root feature being more friendly to extending Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using more familiar pattern of higher order components for wrapping react application Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Adapt to more familiar pattern for higher order components Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Rename feature for clarity Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> --------- Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>
2025-05-20 05:10:56 +00:00 · 2023-03-31 11:57:20 +03:00
1 parent 5827fc9d9a
commit b5e564271e
@@ -7,8 +7,8 @@ import type { IObservableValue } from "mobx";
 import { runInAction, computed, observable } from "mobx";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";
 import React from "react";

 describe("preferences: extension adding preference tabs", () => {
@@ -10,8 +10,8 @@ import { runInAction } from "mobx";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { preferenceItemInjectionToken } from "./renderer/preference-items/preference-item-injection-token";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("preferences - hiding-of-empty-branches, given in preferences page", () => {
  let builder: ApplicationBuilder;
@@ -7,8 +7,8 @@ import type { RenderResult } from "@testing-library/react";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import navigateToProxyPreferencesInjectable from "./common/navigate-to-proxy-preferences.injectable";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";
 import type { FakeExtensionOptions } from "../../renderer/components/test-utils/get-extension-fake";

 describe("preferences - navigation to application preferences", () => {
@@ -5,8 +5,8 @@
 import type { RenderResult } from "@testing-library/react";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("preferences - navigation to editor preferences", () => {
  let applicationBuilder: ApplicationBuilder;
@@ -8,8 +8,8 @@ import { getApplicationBuilder } from "../../renderer/components/test-utils/get-
 import React from "react";
 import "@testing-library/jest-dom/extend-expect";
 import type { FakeExtensionOptions } from "../../renderer/components/test-utils/get-extension-fake";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";
 import logErrorInjectable from "../../common/log-error.injectable";

 describe("preferences - navigation to extension specific preferences", () => {
@@ -7,8 +7,8 @@ import type { ApplicationBuilder } from "../../renderer/components/test-utils/ge
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import requestPublicHelmRepositoriesInjectable from "../helm-charts/child-features/preferences/renderer/adding-of-public-helm-repository/public-helm-repositories/request-public-helm-repositories.injectable";
 import getActiveHelmRepositoriesInjectable from "../../main/helm/repositories/get-active-helm-repositories/get-active-helm-repositories.injectable";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("preferences - navigation to kubernetes preferences", () => {
  let builder: ApplicationBuilder;
@@ -5,8 +5,8 @@
 import type { RenderResult } from "@testing-library/react";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("preferences - navigation to proxy preferences", () => {
  let applicationBuilder: ApplicationBuilder;
@@ -9,8 +9,8 @@ import { getApplicationBuilder } from "../../renderer/components/test-utils/get-
 import navigateToTelemetryPreferencesInjectable from "./common/navigate-to-telemetry-preferences.injectable";
 import sentryDataSourceNameInjectable from "../../common/vars/sentry-dsn-url.injectable";
 import type { FakeExtensionOptions } from "../../renderer/components/test-utils/get-extension-fake";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("preferences - navigation to telemetry preferences", () => {
  let builder: ApplicationBuilder;
@@ -5,8 +5,8 @@
 import type { RenderResult } from "@testing-library/react";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("preferences - navigation to terminal preferences", () => {
  let applicationBuilder: ApplicationBuilder;
@@ -6,8 +6,8 @@
 import type { RenderResult } from "@testing-library/react";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("preferences - navigation using application menu", () => {
  let applicationBuilder: ApplicationBuilder;
@@ -5,8 +5,8 @@
 import type { RenderResult } from "@testing-library/react";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";

 describe("show-about-using-tray", () => {
  let applicationBuilder: ApplicationBuilder;
@@ -5,8 +5,8 @@
 import type { RenderResult } from "@testing-library/react";
 import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
-import type { Discover } from "../../renderer/components/test-utils/discovery-of-html-elements";
-import { discoverFor } from "../../renderer/components/test-utils/discovery-of-html-elements";
+import type { Discover } from "@k8slens/react-testing-library-discovery";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";
 import React from "react";
 import type { Navigate } from "../../renderer/navigation/navigate.injectable";
 import navigateInjectable from "../../renderer/navigation/navigate.injectable";
@@ -3,9 +3,7 @@
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
 import { getInjectable } from "@ogre-tools/injectable";
-import {
-  afterApplicationIsLoadedInjectionToken,
-} from "@k8slens/application";
+import { onLoadOfApplicationInjectionToken } from "@k8slens/application";
 import { bootstrap } from "./bootstrap";
 import startFrameInjectable from "./start-frame/start-frame.injectable";

@@ -22,7 +20,7 @@ const bootstrapInjectable = getInjectable({

  causesSideEffects: true,

-  injectionToken: afterApplicationIsLoadedInjectionToken,
+  injectionToken: onLoadOfApplicationInjectionToken,
 });

 export default bootstrapInjectable;
@@ -5,10 +5,7 @@

 import "./components/app.scss";

-import React from "react";
-import { render, unmountComponentAtNode } from "react-dom";
-import { DefaultProps } from "./mui-base-theme";
-import { DiContextProvider } from "@ogre-tools/injectable-react";
+import { unmountComponentAtNode } from "react-dom";
 import type {
  DiContainerForInjection,
 } from "@ogre-tools/injectable";
@@ -17,8 +14,6 @@ import extensionDiscoveryInjectable from "../extensions/extension-discovery/exte
 import extensionInstallationStateStoreInjectable from "../extensions/extension-installation-state-store/extension-installation-state-store.injectable";
 import initRootFrameInjectable from "./frames/root-frame/init-root-frame.injectable";
 import initClusterFrameInjectable from "./frames/cluster-frame/init-cluster-frame/init-cluster-frame.injectable";
-import { Router } from "react-router";
-import historyInjectable from "./navigation/history.injectable";
 import assert from "assert";

 export async function bootstrap(di: DiContainerForInjection) {
@@ -30,16 +25,13 @@ export async function bootstrap(di: DiContainerForInjection) {
  await di.inject(extensionDiscoveryInjectable).init();
  di.inject(extensionInstallationStateStoreInjectable).bindIpcListeners();

-  let App;
  let initializeApp;

  // TODO: Introduce proper architectural boundaries between root and cluster iframes
  if (process.isMainFrame) {
    initializeApp = di.inject(initRootFrameInjectable);
-    App = (await import("./frames/root-frame/root-frame")).RootFrame;
  } else {
    initializeApp = di.inject(initClusterFrameInjectable);
-    App = (await import("./frames/cluster-frame/cluster-frame")).ClusterFrame;
  }

  try {
@@ -50,15 +42,4 @@ export async function bootstrap(di: DiContainerForInjection) {
      isTopFrameView: process.isMainFrame,
    });
  }
-
-  const history = di.inject(historyInjectable);
-
-  render(
-    <DiContextProvider value={{ di }}>
-      <Router history={history}>
-        {DefaultProps(App)}
-      </Router>
-    </DiContextProvider>,
-    rootElem,
-  );
 }
@@ -1,115 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import type { RenderResult } from "@testing-library/react";
-
-type DiscoverySourceTypes = RenderResult | Element;
-
-export type QuerySingleElement = (
-  attributeName: string,
-  attributeValue?: string
-) => { discovered: Element | null } & Discover;
-
-export type GetSingleElement = (
-  attributeName: string,
-  attributeValue?: string
-) => { discovered: Element } & Discover;
-
-export type QueryAllElements = (attributeName: string) => {
-  discovered: Element[];
-  attributeValues: (string | null)[];
-};
-
-export interface Discover {
-  querySingleElement: QuerySingleElement;
-  queryAllElements: QueryAllElements;
-  getSingleElement: GetSingleElement;
-}
-
-export const discoverFor = (getSource: () => DiscoverySourceTypes): Discover => ({
-  querySingleElement: querySingleElement(getSource),
-  queryAllElements: queryAllElements(getSource),
-  getSingleElement: getSingleElement(getSource),
-});
-
-export const querySingleElement =
-  (getSource: () => DiscoverySourceTypes): QuerySingleElement =>
-    (attributeName, attributeValue) => {
-      const source = getSource();
-
-      const dataAttribute = `data-${attributeName}-test`;
-
-      const selector = attributeValue
-        ? `[${dataAttribute}="${attributeValue}"]`
-        : `[${dataAttribute}]`;
-
-      const discovered = getBaseElement(source).querySelector(selector);
-
-      const nestedDiscover = discoverFor(() => {
-        if (!discovered) {
-          throw new Error("Tried to do nested discover using source that does not exist");
-        }
-
-        return discovered;
-      });
-
-      return {
-        discovered,
-
-        ...nestedDiscover,
-      };
-    };
-
-export const queryAllElements =
-  (getSource: () => DiscoverySourceTypes): QueryAllElements =>
-    (attributeName) => {
-      const source = getSource();
-
-      const dataAttribute = `data-${attributeName}-test`;
-
-      const results = [
-        ...getBaseElement(source).querySelectorAll(`[${dataAttribute}]`),
-      ];
-
-      return {
-        discovered: results,
-
-        attributeValues: results.map((result) =>
-          result.getAttribute(dataAttribute),
-        ),
-      };
-    };
-
-export const getSingleElement =
-  (getSource: () => DiscoverySourceTypes): GetSingleElement =>
-    (attributeName, attributeValue) => {
-      const dataAttribute = `data-${attributeName}-test`;
-
-      const { discovered, ...nestedDiscover } = querySingleElement(getSource)(
-        attributeName,
-        attributeValue,
-      );
-
-      if (!discovered) {
-        const validValues =
-        queryAllElements(getSource)(attributeName).attributeValues;
-
-        if (attributeValue) {
-          throw new Error(
-            `Couldn't find HTML-element with attribute "${dataAttribute}" with value "${attributeValue}". Present values are:\n\n"${validValues.join(
-              '",\n"',
-            )}"`,
-          );
-        }
-
-        throw new Error(
-          `Couldn't find HTML-element with attribute "${dataAttribute}"`,
-        );
-      }
-
-      return { discovered, ...nestedDiscover };
-    };
-
-const getBaseElement = (source: DiscoverySourceTypes) =>
-  "baseElement" in source ? source.baseElement : source;
@@ -59,7 +59,7 @@ import { Namespace } from "../../../common/k8s-api/endpoints";
 import { getOverrideFsWithFakes } from "../../../test-utils/override-fs-with-fakes";
 import applicationMenuItemCompositeInjectable from "../../../features/application-menu/main/application-menu-item-composite.injectable";
 import { getCompositePaths } from "../../../common/utils/composite/get-composite-paths/get-composite-paths";
-import { discoverFor } from "./discovery-of-html-elements";
+import { discoverFor } from "@k8slens/react-testing-library-discovery";
 import { findComposite } from "../../../common/utils/composite/find-composite/find-composite";
 import shouldStartHiddenInjectable from "../../../main/electron-app/features/should-start-hidden.injectable";
 import fsInjectable from "../../../common/fs/fs.injectable";
@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import {
+  reactApplicationChildrenInjectionToken,
+} from "@k8slens/react-application";
+import { computed } from "mobx";
+
+const frameApplicationRootInjectable = getInjectable({
+  id: "frame-application-root",
+
+  instantiate: () => {
+    const Frame = process.isMainFrame
+      ? require("./root-frame/root-frame").RootFrame
+      : require("./cluster-frame/cluster-frame").ClusterFrame;
+
+    return {
+      id: "frame-application-root",
+      Component: Frame,
+      enabled: computed(() => true),
+    };
+  },
+
+  causesSideEffects: true,
+
+  injectionToken: reactApplicationChildrenInjectionToken,
+});
+
+export default frameApplicationRootInjectable;
@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import { Router } from "react-router";
+import historyInjectable from "../navigation/history.injectable";
+import React from "react";
+
+import {
+  reactApplicationHigherOrderComponentInjectionToken,
+} from "@k8slens/react-application";
+
+const routingReactApplicationHocInjectable = getInjectable({
+  id: "routing-react-application-hoc",
+
+  instantiate: (di) => {
+    const history = di.inject(historyInjectable);
+
+    return ({ children }) =>
+      (
+        <Router history={history}>
+          {children}
+        </Router>
+      );
+  },
+
+  injectionToken: reactApplicationHigherOrderComponentInjectionToken,
+});
+
+export default routingReactApplicationHocInjectable;
@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import React from "react";
+import { reactApplicationHigherOrderComponentInjectionToken } from "@k8slens/react-application";
+import { ThemeProvider } from "@material-ui/core";
+import { defaultMuiBaseTheme } from "../mui-base-theme";
+
+const themeProviderReactApplicationHocInjectable = getInjectable({
+  id: "theme-provider-react-application-hoc",
+
+  instantiate:
+    () =>
+      ({ children }) =>
+        <ThemeProvider theme={defaultMuiBaseTheme}>{children}</ThemeProvider>,
+
+  injectionToken: reactApplicationHigherOrderComponentInjectionToken,
+});
+
+export default themeProviderReactApplicationHocInjectable;
@@ -6,7 +6,7 @@
 import React from "react";
 import { createTheme, ThemeProvider } from "@material-ui/core";

-const defaultTheme = createTheme({
+export const defaultMuiBaseTheme = createTheme({
  props: {
    MuiIconButton: {
      color: "inherit",
@@ -32,7 +32,7 @@ const defaultTheme = createTheme({

 export function DefaultProps(App: React.ComponentType | React.FunctionComponent) {
  return (
-    <ThemeProvider theme= { defaultTheme } >
+    <ThemeProvider theme= { defaultMuiBaseTheme } >
      <App />
    </ThemeProvider>
  );
@@ -6,9 +6,7 @@ import { getInjectable } from "@ogre-tools/injectable";
 import { runManyFor } from "@k8slens/run-many";
 import * as tokens from "../before-frame-starts/tokens";
 import currentlyInClusterFrameInjectable from "../routes/currently-in-cluster-frame.injectable";
-import {
-  afterApplicationIsLoadedInjectionToken,
-} from "@k8slens/application";
+import { onLoadOfApplicationInjectionToken } from "@k8slens/application";

 const startFrameInjectable = getInjectable({
  id: "start-frame",
@@ -44,7 +42,7 @@ const startFrameInjectable = getInjectable({
    };
  },

-  injectionToken: afterApplicationIsLoadedInjectionToken,
+  injectionToken: onLoadOfApplicationInjectionToken,
 });

 export default startFrameInjectable;