Technical requirements for behavioural unit tests (#5084)

* Implement a lot of technical requirements for behavioural unit tests Note: the crux of this was to make routing env-agnostic, and not based on URLs as magic strings, but instead something type-enforced. Note: extension-based routes comply to same exact interface by "late-registering" their routes when installed. Routes are just injectables. Note: another chunk of global shared state is no more. Note: a lot of explicit side effects have been cornered to injectables. Note: a lot of stuff has become reactive as part if this. Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make a directory commonly available Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Require id for <Select /> to prevent non-deterministic renders This was caused by global state in a 3rd party lib: "react-select". Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Specify id for all <Select /> to satisfy previous commit Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Prevent explicit side effect in component by using existing dependency instead Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Extract instantiation of "conf" as injectables for causing side effects Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Introduce a legacy-helper to make gradual refactoring of inheritors of Singleton easier Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Make legacy unit tests for hotbar green and more simple by using the new legacy helper Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Temporarily kludge all unit tests green with a disclaimer about allowing side-effects Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Remove kludge in previous commit by explicitly permitting specific side effects where old unit tests require it Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Prevent old unit test with side effects from accessing file system Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Migrate to actual typing for di.permitSideEffects Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Prevent unit tests from failing because of non-standard method of HTML-element not present in js-dom Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Adapt integration tests to recent changes Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Fix code style Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Fix artifact from bad rebase Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Add a deprecation from a review comment Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Remove change that is not required Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove redundant comment Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix code style Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove redundant file Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix bad merge Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Improve variable name Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Tweak logger interface to be more descriptive Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make injecting legacy singleton always provide new instance Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove conditional typing when not needed Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Improve naming of variable Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove unnecessary code style changes Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove flag for causing side effects from too broad scope Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Override side-effects in unit test using injectable instead of monkey patching Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Flag some side-effects and add general overrides Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Fix unit tests in CI by removing explicit side-effect Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Remove explicit side-effect from getting default shell Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Introduce abstraction for getting absolute paths Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using abstraction for getting absolute path to control explicit side effect Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Introduce abstraction for joining paths Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using abstraction for joining paths to control explicit side effect Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix fake implementation for join paths Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix test after removing explicit side effect Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove explicit side effects from kubeconfig-syncs Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix arguments after removing explicit side effect Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make registrators not async for not being needed anymore Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make generalCatalogEntities non-observable, as there is no requirement Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Remove redundant code Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Simplify logic for registering general catalog entity sources Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add TODO Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Replace function for getting application menu items with reactive solution Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix typo in interface name Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove global shared state usages of hot bar store Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove redundant enum Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>
2025-05-20 05:10:56 +00:00 · 2022-03-31 16:57:05 +03:00
1 parent ab2cd27a27
commit a277cfcf02
@@ -5,9 +5,11 @@

 import { ipcRenderer } from "electron";
 import { reaction } from "mobx";
-import { getMatchedClusterId, navigate } from "./helpers";
 import { broadcastMessage, ipcRendererOn } from "../../common/ipc";
-import logger from "../../main/logger";
+import {
+  getLegacyGlobalDiForExtensionApi,
+} from "../../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api";
+import matchedClusterIdInjectable from "./matched-cluster-id.injectable";

 export const enum IpcRendererNavigationEvents {
  RELOAD_PAGE = "renderer:page-reload",
@@ -24,8 +26,6 @@ export function bindEvents() {

  if (process.isMainFrame) {
    bindClusterManagerRouteEvents();
-  } else {
-    bindClusterFrameRouteEvents();
  }

  // Reload dashboard window
@@ -36,25 +36,14 @@ export function bindEvents() {

 // Handle events only in main window renderer process (see also: cluster-manager.tsx)
 function bindClusterManagerRouteEvents() {
+  const di = getLegacyGlobalDiForExtensionApi();
+
+  const matchedClusterId = di.inject(matchedClusterIdInjectable);
+
  // Keep track of active cluster-id for handling IPC/menus/etc.
-  reaction(() => getMatchedClusterId(), clusterId => {
+  reaction(() => matchedClusterId.get(), clusterId => {
    broadcastMessage(IpcRendererNavigationEvents.CLUSTER_VIEW_CURRENT_ID, clusterId);
  }, {
    fireImmediately: true,
  });
-
-  // Handle navigation via IPC
-  ipcRendererOn(IpcRendererNavigationEvents.NAVIGATE_IN_APP, (event, url: string) => {
-    logger.info(`[IPC]: navigate to ${url}`, { currentLocation: location.href });
-    navigate(url);
-    window.focus(); // make sure that the main frame is focused
-  });
-}
-
-// Handle cluster-view renderer process events within iframes
-function bindClusterFrameRouteEvents() {
-  ipcRendererOn(IpcRendererNavigationEvents.NAVIGATE_IN_CLUSTER, (event, url: string) => {
-    logger.info(`[IPC]: navigate to ${url}`, { currentLocation: location.href });
-    navigate(url);
-  });
 }
@@ -7,7 +7,6 @@ import type { LocationDescriptor } from "history";
 import { createPath } from "history";
 import { matchPath, RouteProps } from "react-router";
 import { navigation } from "./history";
-import { ClusterViewRouteParams, clusterViewRoute } from "../../common/routes";
 import { PageParam, PageParamInit } from "./page-param";

 export function navigate(location: LocationDescriptor) {
@@ -22,10 +21,6 @@ export function navigate(location: LocationDescriptor) {
  }
 }

-export function navigateWithoutHistoryChange(location: Partial<Location>) {
-  navigation.merge(location, true);
-}
-
 export function createPageParam<V = string>(init: PageParamInit<V>) {
  return new PageParam<V>(init, navigation);
 }
@@ -37,12 +32,3 @@ export function matchRoute<P>(route: string | string[] | RouteProps) {
 export function isActiveRoute(route: string | string[] | RouteProps): boolean {
  return !!matchRoute(route);
 }
-
-export function getMatchedClusterId(): string | undefined {
-  const matched = matchPath<ClusterViewRouteParams>(navigation.location.pathname, {
-    exact: true,
-    path: clusterViewRoute.path,
-  });
-
-  return matched?.params.clusterId;
-}
@@ -5,10 +5,6 @@

 // Navigation (renderer)

-import { bindEvents } from "./events";
-
 export * from "./history";
 export * from "./helpers";
 export * from "./page-param";
-
-bindEvents();
@@ -0,0 +1,18 @@
+/**
+ * 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 clusterViewRouteParametersInjectable from "../components/cluster-manager/cluster-view-route-parameters.injectable";
+
+const matchedClusterIdInjectable = getInjectable({
+  id: "matched-cluster-id",
+
+  instantiate: (di) => {
+    const routeParameters = di.inject(clusterViewRouteParametersInjectable);
+
+    return routeParameters.clusterId;
+  },
+});
+
+export default matchedClusterIdInjectable;
@@ -8,6 +8,7 @@ import { navigation as observableHistory } from "./history";

 const observableHistoryInjectable = getInjectable({
  id: "observable-history",
+  causesSideEffects: true,
  instantiate: () => observableHistory,
 });

@@ -10,7 +10,6 @@ import type { ObservableHistory } from "mobx-observable-history";
 export interface PageParamInit<V = any> {
  name: string;
  defaultValue?: V; // multi-values param must be defined with array-value, e.g. []
-  prefix?: string; // name prefix, for extensions it's `${extension.id}:`
  parse?(value: string | string[]): V; // from URL
  stringify?(value: V): string | string[]; // to URL
 }
@@ -22,9 +21,9 @@ export class PageParam<V = any> {

  constructor(private init: PageParamInit<V>, private history: ObservableHistory) {
    makeObservable(this);
-    const { prefix, name, defaultValue } = init;
+    const { name, defaultValue } = init;

-    this.name = `${prefix ?? ""}${name}`; // actual prefixed URL-name
+    this.name = name;
    this.isMulti = Array.isArray(defaultValue); // multi-values param
  }

@@ -97,7 +96,7 @@ export class PageParam<V = any> {
    this.history.searchParams.delete(this.name);
  }

-  toString({ withPrefix = true, mergeGlobals = true, value = this.get() } = {}): string {
+  toString({ mergeGlobals = true, value = this.get() } = {}): string {
    let searchParams = new URLSearchParams();

    if (mergeGlobals) {
@@ -109,6 +108,6 @@ export class PageParam<V = any> {
      searchParams.append(this.name, value);
    });

-    return `${withPrefix ? "?" : ""}${searchParams}`;
+    return searchParams.toString();
  }
 }