Make base store non Singleton (#6690)

* Remove Singleton from BaseStore to remove global shared state Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove more usages of Singleton Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace use of legacy global execHelm with injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove last use of legacy global execHelm Signed-off-by: Sebastian Malton <sebastian@malton.name> * Extract BaseStore deps into constructor argument Signed-off-by: Sebastian Malton <sebastian@malton.name> * Introduce method to make store migrations injectable - Use it for ClusterStore Signed-off-by: Sebastian Malton <sebastian@malton.name> * Switch HotbarStore to injectable migrations Signed-off-by: Sebastian Malton <sebastian@malton.name> * Switch UserStore to injectable migrations Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move migration utils into common/utils/ Signed-off-by: Sebastian Malton <sebastian@malton.name> * Switch WeblinkStore to injectable migrations Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove dead code Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type error in base-store tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove tests that reference lastSeenVersion - That value is not used anywhere in code Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove usage of legacy global .getInstance Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove usage of legacy global ClusterStore.getInstance Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add simple migrations dependency for stores without any preexisting migrations Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix messed up import Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add typing to transient injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Cleanup formatting Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix typing in tests to satisfy requirement to have cacheFile Signed-off-by: Sebastian Malton <sebastian@malton.name> * More consistent use of BaseStore.displayName Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add catching of error while starting main application Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move initializing sentry to runnable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove unneeded appPathsInjectionToken - Only had once impl, which was in common anyway Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add support for multiple "runAfter" runnables - Needed so that several dependencies can be declared Signed-off-by: Sebastian Malton <sebastian@malton.name> * Use multiple runAfter support to fix crash on renderer Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove traces Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add global override to fix tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix base store tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix runManyFor tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix hotbar store tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix user store tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add global override for getConfigurationFileModel to fix tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove overrides for configuration stores - Now that there is an override for getConfiguration Signed-off-by: Sebastian Malton <sebastian@malton.name> * Overhaul FS fakes with full in-memory filesystem - This increases our confidence in fs related logic Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove use of global shared Electron.App Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add fake access support Signed-off-by: Sebastian Malton <sebastian@malton.name> * Handle copy as part of fake FS Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add ensureDir/Sync support to fake FS Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type error Signed-off-by: Sebastian Malton <sebastian@malton.name> * Use pathExistsSync instead of fsInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add createReadStream to fake FS Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add stat to fake FS Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove dead code Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix test failures due to incomplete overrides Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fully injectable-ize BaseStore so that ApplicationBuilder tests work Signed-off-by: Sebastian Malton <sebastian@malton.name> * Consolidate more bootstrapping into startFrame Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move initializing CatalogCategories to runnable in bootstrap Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert contextMenuOpen initializers into runnables Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert navigateForExtension init to runnable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make cluster state sync fully injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move init hotbar store into runnables Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make LensTheme fully injectable and runnable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Cleanup old code from missed from previous commit Signed-off-by: Sebastian Malton <sebastian@malton.name> * Manually split out terminal color names and fully type LensTheme Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix old imports Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove unnecessart awaits Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove dead code Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fully cherry pick injectablizing custom monaco themes Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix duplicate mock warning Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix incorrectly fully cherry picking new runnable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Complete cherry-pick of current cluster injcetablization Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix override file name Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix injecting before app paths are set up Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix injecting before app paths are set up Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix ordering of runnable and order of injection Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all renderer runnables to late-inject style - To help fix issues around injection time Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix react-beautiful-dnd mocks Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update and fix WriteJson(Sync) to fix error in tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix HotbarStore.load being called twice is being buggy Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update listing-active-helm-repositories-in-preferences snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix sidebar-and-tab-navigation-tests - Move enabling extensions in tests to a proper location - Fix flushing promises Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove props from dnd mock to make snapshot diffs smaller Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix import Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests by overriding things that are no longer overriden by default - NOTE: They are overridden when using ApplicationBuilder Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix hotbar store tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix cluster store tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix extension-loader tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix extension-discovery tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix cluster-role-dialog tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix user store tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix kubeconfig sync tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix sidebar and tab tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove unused code Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix pick paths import type error and simplify signature Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type error in legacy ipc registration Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove another use of legacy requestOpenPathPicker Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace use of legacy global PathPicker.Pick Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix usage in light of changed prop names Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix catalog tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix more type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix test flakiness by removing side effects from userStore preferences Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix loading Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type error Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix crash Signed-off-by: Sebastian Malton <sebastian@malton.name> * Cherry pick updated startFrameInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add tests to verify runMany behaviour in new possible incorrect configuration Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix init ordering during start frame Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix cluster state sync Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots after removing side-effects Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add override for technical test Signed-off-by: Sebastian Malton <sebastian@malton.name> * Correctly mark currentlyInClusterFrame as causedSideEffects Signed-off-by: Sebastian Malton <sebastian@malton.name> * Better formatting Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix behaviour regression Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add better logging Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix BaseStore sync Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update last snapshot Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add global override for randomBytes Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make startMainApplication not an injection time side effect Signed-off-by: Sebastian Malton <sebastian@malton.name> * Choose better names for start-frame runnable tokens Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove duplication of code in RunManyFor Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add unit tests and fix handling empty runAfter array Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace use of mobx from runManyFor with custom barrier Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add missing test Signed-off-by: Sebastian Malton <sebastian@malton.name> Signed-off-by: Sebastian Malton <sebastian@malton.name>
2025-05-20 05:10:56 +00:00 · 2022-12-15 17:07:19 +02:00
1 parent 7c5faaaf1d
commit 25f37ac1d1
@@ -1,11 +0,0 @@
-/**
- * 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,9 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverrideForFunction } from "../test-utils/get-global-override-for-function";
+import execFileInjectable from "./exec-file.injectable";
+
+export default getGlobalOverrideForFunction(execFileInjectable);
@@ -3,11 +3,61 @@
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
 import { getInjectable } from "@ogre-tools/injectable";
+import type { ReadOptions } from "fs-extra";
 import fse from "fs-extra";

+/**
+ * NOTE: Add corrisponding a corrisponding override of this injecable in `src/test-utils/override-fs-with-fakes.ts`
+ */
 const fsInjectable = getInjectable({
  id: "fs",
-  instantiate: () => fse,
+  instantiate: () => {
+    const {
+      promises: {
+        readFile,
+        writeFile,
+        readdir,
+        lstat,
+        rm,
+        access,
+        stat,
+      },
+      ensureDir,
+      ensureDirSync,
+      readFileSync,
+      readJson,
+      writeJson,
+      readJsonSync,
+      writeFileSync,
+      writeJsonSync,
+      pathExistsSync,
+      pathExists,
+      copy,
+      createReadStream,
+    } = fse;
+
+    return {
+      readFile,
+      readJson: readJson as (file: string, options?: ReadOptions | BufferEncoding) => Promise<any>,
+      writeFile,
+      writeJson,
+      pathExists,
+      readdir,
+      readFileSync,
+      readJsonSync,
+      writeFileSync,
+      writeJsonSync,
+      pathExistsSync,
+      lstat,
+      rm,
+      access,
+      copy: copy as (src: string, dest: string, options?: fse.CopyOptions) => Promise<void>,
+      ensureDir: ensureDir as (path: string, options?: number | fse.EnsureOptions ) => Promise<void>,
+      ensureDirSync,
+      createReadStream,
+      stat,
+    };
+  },
  causesSideEffects: true,
 });

@@ -1,11 +0,0 @@
-/**
- * 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");
-});
@@ -1,16 +0,0 @@
-/**
- * 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;
@@ -5,11 +5,9 @@
 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,
+const pathExistsSyncInjectable = getInjectable({
+  id: "path-exists-sync",
+  instantiate: (di) => di.inject(fsInjectable).pathExistsSync,
 });

-export default deleteFileInjectable;
+export default pathExistsSyncInjectable;
@@ -1,11 +0,0 @@
-/**
- * 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");
-});
@@ -14,18 +14,16 @@ export interface ReadDirectory {
  (
    path: string,
    options?:
-      | { encoding: BufferEncoding | string | null; withFileTypes?: false | undefined }
+      | { encoding: BufferEncoding; withFileTypes?: false | undefined }
      | BufferEncoding
-      | string
-      | null,
  ): Promise<string[]>;
  (
    path: string,
-    options?: { encoding?: BufferEncoding | string | null | undefined; withFileTypes?: false | undefined },
+    options?: { encoding?: BufferEncoding; withFileTypes?: false | undefined },
  ): Promise<string[] | Buffer[]>;
  (
    path: string,
-    options: { encoding?: BufferEncoding | string | null | undefined; withFileTypes: true },
+    options: { encoding?: BufferEncoding; withFileTypes: true },
  ): Promise<Dirent[]>;
 }

@@ -0,0 +1,19 @@
+/**
+ * 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 ReadFileBufferSync = (filePath: string) => Buffer;
+
+const readFileBufferSyncInjectable = getInjectable({
+  id: "read-file-buffer-sync",
+  instantiate: (di): ReadFileBufferSync => {
+    const { readFileSync } = di.inject(fsInjectable);
+
+    return (filePath) => readFileSync(filePath);
+  },
+});
+
+export default readFileBufferSyncInjectable;
@@ -0,0 +1,13 @@
+/**
+ * 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";
+
+const readJsonSyncInjectable = getInjectable({
+  id: "read-json-sync",
+  instantiate: (di) => di.inject(fsInjectable).readJsonSync,
+});
+
+export default readJsonSyncInjectable;
@@ -4,8 +4,8 @@
 */

 import { getGlobalOverride } from "../test-utils/get-global-override";
-import removePathInjectable from "./remove-path.injectable";
+import removePathInjectable from "./remove.injectable";

 export default getGlobalOverride(removePathInjectable, () => async () => {
-  throw new Error("tried to remove a path without override");
+  throw new Error("tried to remove path without override");
 });
@@ -5,11 +5,15 @@
 import { getInjectable } from "@ogre-tools/injectable";
 import fsInjectable from "./fs.injectable";

-export type RemovePath = (path: string) => Promise<void>;
+export type RemovePath = (filePath: string) => Promise<void>;

 const removePathInjectable = getInjectable({
  id: "remove-path",
-  instantiate: (di): RemovePath => di.inject(fsInjectable).remove,
+  instantiate: (di): RemovePath => {
+    const { rm } = di.inject(fsInjectable);
+
+    return (filePath) => rm(filePath, { force: true });
+  },
 });

 export default removePathInjectable;
@@ -4,7 +4,7 @@
 */
 import { getInjectable } from "@ogre-tools/injectable";
 import type { Stats } from "fs";
-import fsInjectable from "../fs.injectable";
+import fsInjectable from "./fs.injectable";

 export type Stat = (path: string) => Promise<Stats>;

@@ -1,10 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import statInjectable from "./stat.injectable";
-import { getGlobalOverride } from "../../test-utils/get-global-override";
-
-export default getGlobalOverride(statInjectable, () => () => {
-  throw new Error("Tried to call stat without explicit override");
-});
@@ -7,7 +7,7 @@ import type { AsyncResult } from "../utils/async-result";
 import { isErrnoException } from "../utils";
 import type { Stats } from "fs-extra";
 import { lowerFirst } from "lodash/fp";
-import statInjectable from "./stat/stat.injectable";
+import statInjectable from "./stat.injectable";

 export type ValidateDirectory = (path: string) => Promise<AsyncResult<undefined>>;

@@ -0,0 +1,29 @@
+/**
+ * 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 getDirnameOfPathInjectable from "../path/get-dirname.injectable";
+import fsInjectable from "./fs.injectable";
+
+export type WriteFileSync = (filePath: string, contents: string) => void;
+
+const writeFileSyncInjectable = getInjectable({
+  id: "write-file-sync",
+  instantiate: (di): WriteFileSync => {
+    const {
+      writeFileSync,
+      ensureDirSync,
+    } = di.inject(fsInjectable);
+    const getDirnameOfPath = di.inject(getDirnameOfPathInjectable);
+
+    return (filePath, contents) => {
+      ensureDirSync(getDirnameOfPath(filePath), {
+        mode: 0o755,
+      });
+      writeFileSync(filePath, contents);
+    };
+  },
+});
+
+export default writeFileSyncInjectable;
@@ -16,15 +16,17 @@ const writeFileInjectable = getInjectable({
    const { writeFile, ensureDir } = di.inject(fsInjectable);
    const getDirnameOfPath = di.inject(getDirnameOfPathInjectable);

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

+      const { encoding = "utf-8", ...options } = opts;
+
      await writeFile(filePath, content, {
-        encoding: "utf-8",
-        ...(opts ?? {}),
+        encoding: encoding as BufferEncoding,
+        ...options,
      });
    };
  },
@@ -3,11 +3,10 @@
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
 import { getInjectable } from "@ogre-tools/injectable";
-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>;
+export type WriteJson = (filePath: string, contents: unknown) => Promise<void>;

 const writeJsonFileInjectable = getInjectable({
  id: "write-json-file",
@@ -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 getDirnameOfPathInjectable from "../path/get-dirname.injectable";
+import fsInjectable from "./fs.injectable";
+
+export type WriteJsonSync = (filePath: string, contents: unknown) => void;
+
+const writeJsonSyncInjectable = getInjectable({
+  id: "write-json-sync",
+  instantiate: (di): WriteJsonSync => {
+    const {
+      writeJsonSync,
+      ensureDirSync,
+    } = di.inject(fsInjectable);
+    const getDirnameOfPath = di.inject(getDirnameOfPathInjectable);
+
+    return (filePath, content) => {
+      ensureDirSync(getDirnameOfPath(filePath), { mode: 0o755 });
+
+      writeJsonSync(filePath, content, {
+        encoding: "utf-8",
+        spaces: 2,
+      });
+    };
+  },
+});
+
+export default writeJsonSyncInjectable;