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,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import accessPathInjectable from "./access-path.injectable";
+
+export default getGlobalOverride(accessPathInjectable, () => async () => {
+  throw new Error("tried to verify path access without override");
+});
@@ -0,0 +1,27 @@
+/**
+ * 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 fsInjectable from "./fs.injectable";
+
+export type AccessPath = (path: string, mode?: number) => Promise<boolean>;
+
+const accessPathInjectable = getInjectable({
+  id: "access-path",
+  instantiate: (di): AccessPath => {
+    const { access } = di.inject(fsInjectable);
+
+    return async (path, mode) => {
+      try {
+        await access(path, mode);
+
+        return true;
+      } catch {
+        return false;
+      }
+    };
+  },
+});
+
+export default accessPathInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import copyInjectable from "./copy.injectable";
+
+export default getGlobalOverride(copyInjectable, () => async () => {
+  throw new Error("tried to copy filepaths without override");
+});
@@ -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 type { CopyOptions } from "fs-extra";
+import fsInjectable from "./fs.injectable";
+
+export type Copy = (src: string, dest: string, options?: CopyOptions | undefined) => Promise<void>;
+
+const copyInjectable = getInjectable({
+  id: "copy",
+  instantiate: (di): Copy => di.inject(fsInjectable).copy,
+});
+
+export default copyInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import deleteFileInjectable from "./delete-file.injectable";
+
+export default getGlobalOverride(deleteFileInjectable, () => async () => {
+  throw new Error("tried to delete file without override");
+});
@@ -0,0 +1,15 @@
+/**
+ * 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 fsInjectable from "./fs.injectable";
+
+export type DeleteFile = (filePath: string) => Promise<void>;
+
+const deleteFileInjectable = getInjectable({
+  id: "delete-file",
+  instantiate: (di): DeleteFile => di.inject(fsInjectable).unlink,
+});
+
+export default deleteFileInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import ensureDirInjectable from "./ensure-dir.injectable";
+
+export default getGlobalOverride(ensureDirInjectable, () => async () => {
+  throw new Error("tried to ensure directory without override");
+});
@@ -5,14 +5,14 @@
 import { getInjectable } from "@ogre-tools/injectable";
 import fsInjectable from "./fs.injectable";

+export type EnsureDirectory = (dirPath: string) => Promise<void>;
+
 const ensureDirInjectable = getInjectable({
  id: "ensure-dir",

  // TODO: Remove usages of ensureDir from business logic.
  // TODO: Read, Write, Watch etc. operations should do this internally.
-  instantiate: (di) => di.inject(fsInjectable).ensureDir,
-
-  causesSideEffects: true,
+  instantiate: (di): EnsureDirectory => di.inject(fsInjectable).ensureDir,
 });

 export default ensureDirInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import extractTarInjectable from "./extract-tar.injectable";
+
+export default getGlobalOverride(extractTarInjectable, () => async () => {
+  throw new Error("tried to extract a tar file without override");
+});
@@ -0,0 +1,26 @@
+/**
+ * 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 type { ExtractOptions } from "tar";
+import { extract } from "tar";
+import getDirnameOfPathInjectable from "../path/get-dirname.injectable";
+
+export type ExtractTar = (filePath: string, opts?: ExtractOptions) => Promise<void>;
+
+const extractTarInjectable = getInjectable({
+  id: "extract-tar",
+  instantiate: (di): ExtractTar => {
+    const getDirnameOfPath = di.inject(getDirnameOfPathInjectable);
+
+    return (filePath, opts = {}) => extract({
+      file: filePath,
+      cwd: getDirnameOfPath(filePath),
+      ...opts,
+    });
+  },
+  causesSideEffects: true,
+});
+
+export default extractTarInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import lstatInjectable from "./lstat.injectable";
+
+export default getGlobalOverride(lstatInjectable, () => async () => {
+  throw new Error("tried to lstat a filepath without override");
+});
@@ -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 type { Stats } from "fs";
+import fsInjectable from "./fs.injectable";
+
+export type LStat = (path: string) => Promise<Stats>;
+
+const lstatInjectable = getInjectable({
+  id: "lstat",
+  instantiate: (di): LStat => di.inject(fsInjectable).lstat,
+});
+
+export default lstatInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import moveInjectable from "./move.injectable";
+
+export default getGlobalOverride(moveInjectable, () => async () => {
+  throw new Error("tried to move without override");
+});
@@ -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 type { MoveOptions } from "fs-extra";
+import fsInjectable from "./fs.injectable";
+
+export type Move = (src: string, dest: string, options?: MoveOptions) => Promise<void>;
+
+const moveInjectable = getInjectable({
+  id: "move",
+  instantiate: (di): Move => di.inject(fsInjectable).move,
+});
+
+export default moveInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import pathExistsInjectable from "./path-exists.injectable";
+
+export default getGlobalOverride(pathExistsInjectable, () => async () => {
+  throw new Error("Tried to check if a path exists without override");
+});
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import readDirectoryInjectable from "./read-directory.injectable";
+
+export default getGlobalOverride(readDirectoryInjectable, () => async () => {
+  throw new Error("tried to read a directory's content without override");
+});
@@ -0,0 +1,37 @@
+/**
+ * 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 type { Dirent } from "fs";
+import fsInjectable from "./fs.injectable";
+
+export interface ReadDirectory {
+  (
+    path: string,
+    options: "buffer" | { encoding: "buffer"; withFileTypes?: false | undefined }
+  ): Promise<Buffer[]>;
+  (
+    path: string,
+    options?:
+      | { encoding: BufferEncoding | string | null; withFileTypes?: false | undefined }
+      | BufferEncoding
+      | string
+      | null,
+  ): Promise<string[]>;
+  (
+    path: string,
+    options?: { encoding?: BufferEncoding | string | null | undefined; withFileTypes?: false | undefined },
+  ): Promise<string[] | Buffer[]>;
+  (
+    path: string,
+    options: { encoding?: BufferEncoding | string | null | undefined; withFileTypes: true },
+  ): Promise<Dirent[]>;
+}
+
+const readDirectoryInjectable = getInjectable({
+  id: "read-directory",
+  instantiate: (di): ReadDirectory => di.inject(fsInjectable).readdir,
+});
+
+export default readDirectoryInjectable;
@@ -5,11 +5,16 @@
 import { getInjectable } from "@ogre-tools/injectable";
 import fsInjectable from "./fs.injectable";

+export type ReadFile = (filePath: string) => Promise<string>;
+
 const readFileInjectable = getInjectable({
  id: "read-file",

-  instantiate: (di) => (filePath: string) =>
-    di.inject(fsInjectable).readFile(filePath, "utf-8"),
+  instantiate: (di): ReadFile => {
+    const { readFile } = di.inject(fsInjectable);
+
+    return (filePath) => readFile(filePath, "utf-8");
+  },
 });

 export default readFileInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import removePathInjectable from "./remove-path.injectable";
+
+export default getGlobalOverride(removePathInjectable, () => async () => {
+  throw new Error("tried to remove a path without override");
+});
@@ -5,9 +5,11 @@
 import { getInjectable } from "@ogre-tools/injectable";
 import fsInjectable from "./fs.injectable";

-const readDirInjectable = getInjectable({
-  id: "read-dir",
-  instantiate: (di) => di.inject(fsInjectable).readdir,
+export type RemovePath = (path: string) => Promise<void>;
+
+const removePathInjectable = getInjectable({
+  id: "remove-path",
+  instantiate: (di): RemovePath => di.inject(fsInjectable).remove,
 });

-export default readDirInjectable;
+export default removePathInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import writeFileInjectable from "./write-file.injectable";
+
+export default getGlobalOverride(writeFileInjectable, () => async () => {
+  throw new Error("tried to write file without override");
+});
@@ -3,20 +3,28 @@
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
 import { getInjectable } from "@ogre-tools/injectable";
-import path from "path";
+import type { WriteFileOptions } from "fs-extra";
+import getDirnameOfPathInjectable from "../path/get-dirname.injectable";
 import fsInjectable from "./fs.injectable";

+export type WriteFile = (filePath: string, content: string | Buffer, opts?: WriteFileOptions) => Promise<void>;
+
 const writeFileInjectable = getInjectable({
  id: "write-file",

-  instantiate: (di) => {
+  instantiate: (di): WriteFile => {
    const { writeFile, ensureDir } = di.inject(fsInjectable);
+    const getDirnameOfPath = di.inject(getDirnameOfPathInjectable);

-    return async (filePath: string, content: string | Buffer) => {
-      await ensureDir(path.dirname(filePath), { mode: 0o755 });
+    return async (filePath, content, opts) => {
+      await ensureDir(getDirnameOfPath(filePath), {
+        mode: 0o755,
+        ...(opts ?? {}),
+      });

      await writeFile(filePath, content, {
        encoding: "utf-8",
+        ...(opts ?? {}),
      });
    };
  },
@@ -3,37 +3,27 @@
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
 import { getInjectable } from "@ogre-tools/injectable";
-import type { EnsureOptions, WriteOptions } from "fs-extra";
-import path from "path";
 import type { JsonValue } from "type-fest";
+import getDirnameOfPathInjectable from "../path/get-dirname.injectable";
 import fsInjectable from "./fs.injectable";

 export type WriteJson = (filePath: string, contents: JsonValue) => Promise<void>;

-interface Dependencies {
-  writeJson: (file: string, object: any, options?: WriteOptions | BufferEncoding | string) => Promise<void>;
-  ensureDir: (dir: string, options?: EnsureOptions | number) => Promise<void>;
-}
-
-const writeJsonFile = ({ writeJson, ensureDir }: Dependencies): WriteJson => async (filePath, content) => {
-  await ensureDir(path.dirname(filePath), { mode: 0o755 });
-
-  await writeJson(filePath, content, {
-    encoding: "utf-8",
-    spaces: 2,
-  });
-};
-
 const writeJsonFileInjectable = getInjectable({
  id: "write-json-file",

-  instantiate: (di) => {
+  instantiate: (di): WriteJson => {
    const { writeJson, ensureDir } = di.inject(fsInjectable);
+    const getDirnameOfPath = di.inject(getDirnameOfPathInjectable);

-    return writeJsonFile({
-      writeJson,
-      ensureDir,
-    });
+    return async (filePath, content) => {
+      await ensureDir(getDirnameOfPath(filePath), { mode: 0o755 });
+
+      await writeJson(filePath, content, {
+        encoding: "utf-8",
+        spaces: 2,
+      });
+    };
  },
 });