Remove Singleton from BaseStore to remove global shared state

Signed-off-by: Sebastian Malton <sebastian@malton.name>

src/common/__tests__/base-store.test.ts

@@ -82,8 +82,6 @@ describe("BaseStore", () => {
     mainDi.override(directoryForUserDataInjectable, () => "some-user-data-directory");
     mainDi.permitSideEffects(getConfigurationFileModelInjectable);
 
-    TestStore.resetInstance();
-
     const mockOpts = {
       "some-user-data-directory": {
         "test-store.json": JSON.stringify({}),
@@ -92,13 +90,12 @@ describe("BaseStore", () => {
 
     mockFs(mockOpts);
 
-    store = TestStore.createInstance();
+    store = new TestStore();
   });
 
   afterEach(() => {
     mockFs.restore();
     store.disableSync();
-    TestStore.resetInstance();
   });
 
   describe("persistence", () => {

src/common/base-store.ts

@@ -10,7 +10,7 @@ import { ipcMain, ipcRenderer } from "electron";
 import type { IEqualsComparer } from "mobx";
 import { makeObservable, reaction, runInAction } from "mobx";
 import type { Disposer } from "./utils";
-import { Singleton, toJS } from "./utils";
+import { toJS } from "./utils";
 import logger from "../main/logger";
 import { broadcastMessage, ipcMainOn, ipcRendererOn } from "./ipc";
 import isEqual from "lodash/isEqual";
@@ -31,14 +31,13 @@ export interface BaseStoreParams<T> extends ConfOptions<T> {
 /**
  * Note: T should only contain base JSON serializable types.
  */
-export abstract class BaseStore<T extends object> extends Singleton {
+export abstract class BaseStore<T extends object> {
   protected storeConfig?: Config<T>;
   protected syncDisposers: Disposer[] = [];
 
   readonly displayName: string = this.constructor.name;
 
   protected constructor(protected params: BaseStoreParams<T>) {
-    super();
     makeObservable(this);
 
     if (ipcRenderer) {

src/common/cluster-store/cluster-store.injectable.ts

@@ -11,15 +11,11 @@ import emitAppEventInjectable from "../app-event-bus/emit-event.injectable";
 const clusterStoreInjectable = getInjectable({
   id: "cluster-store",
 
-  instantiate: (di) => {
-    ClusterStore.resetInstance();
-
-    return ClusterStore.createInstance({
-      createCluster: di.inject(createClusterInjectionToken),
-      readClusterConfigSync: di.inject(readClusterConfigSyncInjectable),
-      emitAppEvent: di.inject(emitAppEventInjectable),
-    });
-  },
+  instantiate: (di) => new ClusterStore({
+    createCluster: di.inject(createClusterInjectionToken),
+    readClusterConfigSync: di.inject(readClusterConfigSyncInjectable),
+    emitAppEvent: di.inject(emitAppEventInjectable),
+  }),
 
   causesSideEffects: true,
 });

src/common/hotbars/store.injectable.ts

@@ -10,14 +10,10 @@ import loggerInjectable from "../logger.injectable";
 const hotbarStoreInjectable = getInjectable({
   id: "hotbar-store",
 
-  instantiate: (di) => {
-    HotbarStore.resetInstance();
-
-    return HotbarStore.createInstance({
-      catalogCatalogEntity: di.inject(catalogCatalogEntityInjectable),
-      logger: di.inject(loggerInjectable),
-    });
-  },
+  instantiate: (di) => new HotbarStore({
+    catalogCatalogEntity: di.inject(catalogCatalogEntityInjectable),
+    logger: di.inject(loggerInjectable),
+  }),
 
   causesSideEffects: true,
 });

src/common/user-store/user-store.injectable.ts

@@ -10,14 +10,10 @@ import emitAppEventInjectable from "../app-event-bus/emit-event.injectable";
 const userStoreInjectable = getInjectable({
   id: "user-store",
 
-  instantiate: (di) => {
-    UserStore.resetInstance();
-
-    return UserStore.createInstance({
-      selectedUpdateChannel: di.inject(selectedUpdateChannelInjectable),
-      emitAppEvent: di.inject(emitAppEventInjectable),
-    });
-  },
+  instantiate: (di) => new UserStore({
+    selectedUpdateChannel: di.inject(selectedUpdateChannelInjectable),
+    emitAppEvent: di.inject(emitAppEventInjectable),
+  }),
 
   causesSideEffects: true,
 });

src/common/utils/collection-functions.ts

@@ -52,7 +52,10 @@ export function getOrInsertSet<K, SK>(map: Map<K, Set<SK>>, key: K): Set<SK> {
  * Like `getOrInsert` but with delayed creation of the item. Which is useful
  * if it is very expensive to create the initial value.
  */
-export function getOrInsertWith<K, V>(map: Map<K, V>, key: K, builder: () => V): V {
+export function getOrInsertWith<K, V>(map: Map<K, V>, key: K, builder: () => V): V;
+export function getOrInsertWith<K extends object, V>(map: Map<K, V> | WeakMap<K, V>, key: K, builder: () => V): V;
+
+export function getOrInsertWith<K extends object, V>(map: Map<K, V> | WeakMap<K, V>, key: K, builder: () => V): V {
   if (!map.has(key)) {
     map.set(key, builder());
   }

src/common/utils/random-bytes.injectable.ts

@@ -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 { randomBytes } from "crypto";
+import { promisify } from "util";
+
+export type RandomBytes = (size: number) => Promise<Buffer>;
+
+const randomBytesInjectable = getInjectable({
+  id: "random-bytes",
+  instantiate: (): RandomBytes => promisify(randomBytes),
+});
+
+export default randomBytesInjectable;

src/common/utils/singleton.ts

@@ -3,10 +3,13 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 
-interface StaticThis<T, R extends any[]> { new(...args: R): T }
+export interface StaticThis<T, R extends any[]> { new(...args: R): T }
 
+/**
+ * @deprecated This is a form of global shared state
+ */
 export class Singleton {
-  private static instances = new WeakMap<object, Singleton>();
+  private static readonly instances = new WeakMap<object, Singleton>();
   private static creating = "";
 
   constructor() {

src/common/weblink-store.injectable.ts

@@ -7,12 +7,7 @@ import { WeblinkStore } from "./weblink-store";
 
 const weblinkStoreInjectable = getInjectable({
   id: "weblink-store",
-
-  instantiate: () => {
-    WeblinkStore.resetInstance();
-
-    return WeblinkStore.createInstance();
-  },
+  instantiate: () => new WeblinkStore(),
 });
 
 export default weblinkStoreInjectable;