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
@@ -0,0 +1,81 @@
+/**
+ * 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 navigateToEntitySettingsInjectable from "../../common/front-end-routing/routes/entity-settings/navigate-to-entity-settings.injectable";
+import type { ListNamespaceForbiddenArgs } from "../../common/ipc/cluster";
+import { Notifications, notificationsStore } from "../components/notifications";
+import { ClusterStore } from "../../common/cluster-store/cluster-store";
+import { Button } from "../components/button";
+import type { IpcRendererEvent } from "electron";
+import React from "react";
+
+const listNamespacesForbiddenHandlerInjectable = getInjectable({
+  id: "list-namespaces-forbidden-handler",
+
+  instantiate: (di) => {
+    const navigateToEntitySettings = di.inject(navigateToEntitySettingsInjectable);
+
+    const notificationLastDisplayedAt = new Map<string, number>();
+    const intervalBetweenNotifications = 1000 * 60; // 60s
+
+    return (
+      event: IpcRendererEvent,
+      ...[clusterId]: ListNamespaceForbiddenArgs
+    ): void => {
+      const lastDisplayedAt = notificationLastDisplayedAt.get(clusterId);
+      const now = Date.now();
+
+      if (
+        !notificationLastDisplayedAt.has(clusterId) ||
+          now - lastDisplayedAt > intervalBetweenNotifications
+      ) {
+        notificationLastDisplayedAt.set(clusterId, now);
+      } else {
+        // don't bother the user too often
+        return;
+      }
+
+      const notificationId = `list-namespaces-forbidden:${clusterId}`;
+
+      if (notificationsStore.getById(notificationId)) {
+        // notification is still visible
+        return;
+      }
+
+      Notifications.info(
+        (
+          <div className="flex column gaps">
+            <b>Add Accessible Namespaces</b>
+            <p>
+          Cluster <b>{ClusterStore.getInstance().getById(clusterId).name}</b> does not have permissions to list namespaces.{" "}
+          Please add the namespaces you have access to.
+            </p>
+            <div className="flex gaps row align-left box grow">
+              <Button
+                active
+                outlined
+                label="Go to Accessible Namespaces Settings"
+                onClick={() => {
+                  navigateToEntitySettings(clusterId, "namespaces");
+                  notificationsStore.remove(notificationId);
+                }}
+              />
+            </div>
+          </div>
+        ),
+        {
+          id: notificationId,
+          /**
+       * Set the time when the notification is closed as well so that there is at
+       * least a minute between closing the notification as seeing it again
+       */
+          onClose: () => notificationLastDisplayedAt.set(clusterId, Date.now()),
+        },
+      );
+    };
+  },
+});
+
+export default listNamespacesForbiddenHandlerInjectable;
@@ -0,0 +1,17 @@
+/**
+ * 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 { registerIpcListeners } from "./register-listeners";
+import listNamespacesForbiddenHandlerInjectable from "./list-namespaces-forbidden-handler.injectable";
+
+const registerIpcListenersInjectable = getInjectable({
+  id: "register-ipc-listeners",
+
+  instantiate: (di) => registerIpcListeners({
+    listNamespacesForbiddenHandler: di.inject(listNamespacesForbiddenHandlerInjectable),
+  }),
+});
+
+export default registerIpcListenersInjectable;
@@ -9,9 +9,6 @@ import { areArgsUpdateAvailableFromMain, UpdateAvailableChannel, onCorrect, Upda
 import { Notifications, notificationsStore } from "../components/notifications";
 import { Button } from "../components/button";
 import { isMac } from "../../common/vars";
-import { ClusterStore } from "../../common/cluster-store/cluster-store";
-import { navigate } from "../navigation";
-import { entitySettingsURL } from "../../common/routes";
 import { defaultHotbarCells } from "../../common/hotbar-types";
 import { type ListNamespaceForbiddenArgs, clusterListNamespaceForbiddenChannel, isListNamespaceForbiddenArgs } from "../../common/ipc/cluster";
 import { hotbarTooManyItemsChannel } from "../../common/ipc/hotbar";
@@ -63,64 +60,18 @@ function UpdateAvailableHandler(event: IpcRendererEvent, ...[backchannel, update
  );
 }

-const notificationLastDisplayedAt = new Map<string, number>();
-const intervalBetweenNotifications = 1000 * 60; // 60s
-
-function ListNamespacesForbiddenHandler(event: IpcRendererEvent, ...[clusterId]: ListNamespaceForbiddenArgs): void {
-  const lastDisplayedAt = notificationLastDisplayedAt.get(clusterId);
-  const now = Date.now();
-
-  if (!notificationLastDisplayedAt.has(clusterId) || (now - lastDisplayedAt) > intervalBetweenNotifications) {
-    notificationLastDisplayedAt.set(clusterId, now);
-  } else {
-    // don't bother the user too often
-    return;
-  }
-
-  const notificationId = `list-namespaces-forbidden:${clusterId}`;
-
-  if (notificationsStore.getById(notificationId)) {
-    // notification is still visible
-    return;
-  }
-
-  Notifications.info(
-    (
-      <div className="flex column gaps">
-        <b>Add Accessible Namespaces</b>
-        <p>
-          Cluster <b>{ClusterStore.getInstance().getById(clusterId).name}</b> does not have permissions to list namespaces.{" "}
-          Please add the namespaces you have access to.
-        </p>
-        <div className="flex gaps row align-left box grow">
-          <Button
-            active
-            outlined
-            label="Go to Accessible Namespaces Settings"
-            onClick={() => {
-              navigate(entitySettingsURL({ params: { entityId: clusterId }, fragment: "namespaces" }));
-              notificationsStore.remove(notificationId);
-            }}
-          />
-        </div>
-      </div>
-    ),
-    {
-      id: notificationId,
-      /**
-       * Set the time when the notification is closed as well so that there is at
-       * least a minute between closing the notification as seeing it again
-       */
-      onClose: () => notificationLastDisplayedAt.set(clusterId, Date.now()),
-    },
-  );
-}
-
 function HotbarTooManyItemsHandler(): void {
  Notifications.error(`Cannot have more than ${defaultHotbarCells} items pinned to a hotbar`);
 }

-export function registerIpcListeners() {
+interface Dependencies {
+  listNamespacesForbiddenHandler: (
+    event: IpcRendererEvent,
+    ...[clusterId]: ListNamespaceForbiddenArgs
+  ) => void;
+}
+
+export const registerIpcListeners = ({ listNamespacesForbiddenHandler }: Dependencies) => () => {
  onCorrect({
    source: ipcRenderer,
    channel: UpdateAvailableChannel,
@@ -130,7 +81,7 @@ export function registerIpcListeners() {
  onCorrect({
    source: ipcRenderer,
    channel: clusterListNamespaceForbiddenChannel,
-    listener: ListNamespacesForbiddenHandler,
+    listener: listNamespacesForbiddenHandler,
    verifier: isListNamespaceForbiddenArgs,
  });
  onCorrect({
@@ -145,4 +96,4 @@ export function registerIpcListeners() {
  ipcRendererOn(AutoUpdateNoUpdateAvailable, () => {
    Notifications.shortInfo("No update is currently available");
  });
-}
+};