Making apiBase injectable (#6022)

* Making apiBase injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all of Helm functions to be DI Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make PortForward's use of apiBase fully injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all metric requests to be injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace resource applier with injectables Signed-off-by: Sebastian Malton <sebastian@malton.name> * Switch KubeJsonApi.forCluster to be injectable but do not use Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert the rest of shell sessions to be DI-ed - This is a prerequesit for using the new createKubeJsonApiForClusterInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Use new createKubeJsonApiForClusterInjectable for openNodeShellSession Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make KubeconfigDialog injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove jest-fetch-mock and make fetch injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests with new global override Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add new injectable for create KubeJsonApi and JsonApi instances Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix showing-details-for-helm-release behavioural tests - Remove HelmChartStore in favour of all injectables - Create a model for UpgradeChartDockTab Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix show details and updating helm releases tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix residual typing issues related to metrics Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix crash on load due to circular dependency Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix create resource tab not working Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove legacy apiBase global Signed-off-by: Sebastian Malton <sebastian@malton.name> * Introduce and use isDebuggingInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Introduce and use windowLocationInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove global legacy apiKube Signed-off-by: Sebastian Malton <sebastian@malton.name> * Improve injectable filenames compared to the injectables inside Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove modifying input in requestActivePortForwardInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Introduce and use get(Milli)SecondsFromUnixEpochInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Switch to non-reactive way of gettting possible helm release versions Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix typo Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix bug in KubeApi constructor Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all KubeApi related tests to use asyncFn Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix unit tests after introducing new injectables that have side effects Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix bad rebase causing tests to fail Signed-off-by: Sebastian Malton <sebastian@malton.name> * Improve expects for multiple field values Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix crash will looking up api refs Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix breaking change on KubeApi.list Signed-off-by: Sebastian Malton <sebastian@malton.name> * Better fix for formatting urls Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove injectable for time since we should just use useMockTime Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add happy path behavioural tests for upgrade chart tab Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove debug message Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix showing-details-for-helm-release tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix installing-helm-chart-from-new-tab tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests relating to hosted cluster id Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots to recent changes in master Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Reupdated upgrade chart new tab test snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix flakiness in unit test when using <Animated> Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix flakiness and improve tests for DeleteClusterDialog Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix kubeconfig-sync tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix <Extensions> tests by removing mockFs and making everything injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix build issues Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix getElectronAppPathInjectable override not returning absolute paths - Also fixes the listing-active-helm-repos-in-prefs tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace all uses of getAbsolutePath with joinPaths as it is more correct and less confusing Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix opening application window tests by making override properly absolute Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots relating no longer using getAbsolutePath Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix and add behavioural tests for RenderDelay Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix extension discovery tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix test flakiness because of path side effects, propagate uses to as many places Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix extension-discovery tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add global override to fix some tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Rewrite and fix implementation of KubeconfigManager and its tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests by global override pathExists Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix unit tests failing on windows by using injectable verions of path functions Signed-off-by: Sebastian Malton <sebastian@malton.name> * Attempt to fix test timeout by using runInAction Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix setupIpcMainHandlers usage Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> Signed-off-by: Sebastian Malton <sebastian@malton.name> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> Co-authored-by: Iku-turso <mikko.aspiala@gmail.com>
2025-05-20 05:10:56 +00:00 · 2022-10-05 08:10:36 -04:00
1 parent ed073d6562
commit 76066c5ebf
@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import path from "path";
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import getAbsolutePathInjectable from "./get-absolute-path.injectable";
+
+export default getGlobalOverride(getAbsolutePathInjectable, () => path.posix.resolve);
@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import path from "path";
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import getBasenameOfPathInjectable from "./get-basename.injectable";
+
+export default getGlobalOverride(getBasenameOfPathInjectable, () => path.posix.basename);
@@ -0,0 +1,16 @@
+/**
+ * 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 path from "path";
+
+export type GetBasenameOfPath = (path: string) => string;
+
+const getBasenameOfPathInjectable = getInjectable({
+  id: "get-basename-of-path",
+  instantiate: (): GetBasenameOfPath => path.basename,
+  causesSideEffects: true,
+});
+
+export default getBasenameOfPathInjectable;
@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import path from "path";
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import getDirnameOfPathInjectable from "./get-dirname.injectable";
+
+export default getGlobalOverride(getDirnameOfPathInjectable, () => path.posix.dirname);
@@ -0,0 +1,16 @@
+/**
+ * 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 path from "path";
+
+export type GetDirnameOfPath = (path: string) => string;
+
+const getDirnameOfPathInjectable = getInjectable({
+  id: "get-dirname-of-path",
+  instantiate: (): GetDirnameOfPath => path.dirname,
+  causesSideEffects: true,
+});
+
+export default getDirnameOfPathInjectable;
@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import path from "path";
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import getRelativePathInjectable from "./get-relative-path.injectable";
+
+export default getGlobalOverride(getRelativePathInjectable, () => path.posix.relative);
@@ -0,0 +1,16 @@
+/**
+ * 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 path from "path";
+
+export type GetRelativePath = (from: string, to: string) => string;
+
+const getRelativePathInjectable = getInjectable({
+  id: "get-relative-path",
+  instantiate: (): GetRelativePath => path.relative,
+  causesSideEffects: true,
+});
+
+export default getRelativePathInjectable;
@@ -0,0 +1,51 @@
+/**
+ * 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 getAbsolutePathInjectable from "./get-absolute-path.injectable";
+import getDirnameOfPathInjectable from "./get-dirname.injectable";
+
+/**
+ * Checks if `testPath` represents a potential filesystem entry that would be
+ * logically "within" the `parentPath` directory.
+ *
+ * This function will return `true` in the above case, and `false` otherwise.
+ * It will return `false` if the two paths are the same (after resolving them).
+ *
+ * The function makes no FS calls and is platform dependant. Meaning that the
+ * results are only guaranteed to be correct for the platform you are running
+ * on.
+ * @param parentPath The known path of a directory
+ * @param testPath The path that is to be tested
+ */
+export type IsLogicalChildPath = (parentPath: string, testPath: string) => boolean;
+
+const isLogicalChildPathInjectable = getInjectable({
+  id: "is-logical-child-path",
+  instantiate: (di): IsLogicalChildPath => {
+    const getAbsolutePath = di.inject(getAbsolutePathInjectable);
+    const getDirnameOfPath = di.inject(getDirnameOfPathInjectable);
+
+    return (parentPath, testPath) => {
+      const resolvedParentPath = getAbsolutePath(parentPath);
+      let resolvedTestPath = getAbsolutePath(testPath);
+
+      if (resolvedParentPath === resolvedTestPath) {
+        return false;
+      }
+
+      while (resolvedTestPath.length >= resolvedParentPath.length) {
+        if (resolvedTestPath === resolvedParentPath) {
+          return true;
+        }
+
+        resolvedTestPath = getDirnameOfPath(resolvedTestPath);
+      }
+
+      return false;
+    };
+  },
+});
+
+export default isLogicalChildPathInjectable;
@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import path from "path";
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import joinPathsInjectable from "./join-paths.injectable";
+
+export default getGlobalOverride(joinPathsInjectable, () => path.posix.join);
@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import path from "path";
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import parsePathInjectable from "./parse.injectable";
+
+export default getGlobalOverride(parsePathInjectable, () => path.posix.parse);
@@ -0,0 +1,14 @@
+/**
+ * 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 path from "path";
+
+const parsePathInjectable = getInjectable({
+  id: "parse-path",
+  instantiate: () => path.parse,
+  causesSideEffects: true,
+});
+
+export default parsePathInjectable;
@@ -0,0 +1,21 @@
+/**
+ * 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 getAbsolutePathInjectable from "./get-absolute-path.injectable";
+import resolveTildeInjectable from "./resolve-tilde.injectable";
+
+export type ResolvePath = (path: string) => string;
+
+const resolvePathInjectable = getInjectable({
+  id: "resolve-path",
+  instantiate: (di): ResolvePath => {
+    const getAbsolutePath = di.inject(getAbsolutePathInjectable);
+    const resolveTilde = di.inject(resolveTildeInjectable);
+
+    return (filePath) => getAbsolutePath(resolveTilde(filePath));
+  },
+});
+
+export default resolvePathInjectable;
@@ -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 homeDirectoryPathInjectable from "../os/home-directory-path.injectable";
+import fileSystemSeparatorInjectable from "./separator.injectable";
+
+export type ResolveTilde = (path: string) => string;
+
+const resolveTildeInjectable = getInjectable({
+  id: "resolve-tilde",
+  instantiate: (di): ResolveTilde => {
+    const homeDirectoryPath = di.inject(homeDirectoryPathInjectable);
+    const fileSystemSeparator = di.inject(fileSystemSeparatorInjectable);
+
+    return (filePath) => {
+      if (filePath === "~") {
+        return homeDirectoryPath;
+      }
+
+      if (filePath === `~${fileSystemSeparator}`) {
+        return `${homeDirectoryPath}${filePath.slice(1)}`;
+      }
+
+      return filePath;
+    };
+  },
+});
+
+export default resolveTildeInjectable;
@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import path from "path";
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import fileSystemSeparatorInjectable from "./separator.injectable";
+
+export default getGlobalOverride(fileSystemSeparatorInjectable, () => path.posix.sep);
@@ -0,0 +1,14 @@
+/**
+ * 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 path from "path";
+
+const fileSystemSeparatorInjectable = getInjectable({
+  id: "file-system-separator",
+  instantiate: () => path.sep,
+  causesSideEffects: true,
+});
+
+export default fileSystemSeparatorInjectable;