Remove BaseStore<T> and replace with composition of dependencies (#7002)

* Rename ExtensionStore -> BaseExtensionStore - The name was too close to ExtensionsStore Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move ExtensionsStore to new format Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move ClusterStore to new format Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move UserStore to new format Signed-off-by: Sebastian Malton <sebastian@malton.name> * Cleanup types to remove multiple cast locations Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move HotbarStore to new format Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move WeblinkStore to new format Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move FileSystemProvisionerStore to new format Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Clean up impl and rename to better describe intent Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix remaining type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fully split apart the enabled extensions storage Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fully split apart the clusters storage Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fully split apart the hotbar storage Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fully split apart the weblinks storage Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fully split apart the user preferences storage Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix crashing Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests and snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix integration test failures Signed-off-by: Sebastian Malton <sebastian@malton.name> * Improve typing to prevent errors in the future. Signed-off-by: Sebastian Malton <sebastian@malton.name> * Cleanup @k8slens/messaging and friends - To fix type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix lint issue Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix global override not being complete enough causing tests to fail Signed-off-by: Sebastian Malton <sebastian@malton.name> * Bump memory for unit tests on CI Signed-off-by: Sebastian Malton <sebastian@malton.name> * Attempt to fix memory issue on CI again Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup test because of new injectables Signed-off-by: Sebastian Malton <sebastian@malton.name> * Upgrade Jest Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix unit tests falling over Signed-off-by: Sebastian Malton <sebastian@malton.name> * Back out jest config change Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove console log Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshot Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests by matching equality instead of snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests by forcing specific snapshot style - Ubuntu CI seems to format arrays in snapshots differently than macOS locally Signed-off-by: Sebastian Malton <sebastian@malton.name> --------- Signed-off-by: Sebastian Malton <sebastian@malton.name>
2025-05-20 05:10:56 +00:00 · 2023-03-28 17:54:25 +03:00
1 parent ba4a283af9
commit 49f0a1af9c
@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { iter } from "@k8slens/utilities";
+import { getInjectable } from "@ogre-tools/injectable";
+import { computed } from "mobx";
+import enabledExtensionsStateInjectable from "./state.injectable";
+
+const enabledExtensionsInjectable = getInjectable({
+  id: "enabled-extensions",
+  instantiate: (di) => {
+    const state = di.inject(enabledExtensionsStateInjectable);
+
+    return computed(() => (
+      iter.chain(state.values())
+        .filter(({ enabled }) => enabled)
+        .map(({ name }) => name)
+        .toArray()
+    ));
+  },
+});
+
+export default enabledExtensionsInjectable;
@@ -0,0 +1,24 @@
+/**
+ * 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 enabledExtensionsStateInjectable from "./state.injectable";
+
+export interface IsEnabledExtensionDescriptor {
+  readonly id: string;
+  readonly isBundled: boolean;
+}
+
+export type IsExtensionEnabled = (desc: IsEnabledExtensionDescriptor) => boolean;
+
+const isExtensionEnabledInjectable = getInjectable({
+  id: "is-extension-enabled",
+  instantiate: (di): IsExtensionEnabled => {
+    const state = di.inject(enabledExtensionsStateInjectable);
+
+    return ({ id, isBundled }) => isBundled || (state.get(id)?.enabled ?? false);
+  },
+});
+
+export default isExtensionEnabledInjectable;
@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getInjectionToken } from "@ogre-tools/injectable";
+import type { MigrationDeclaration } from "../../../../common/persistent-storage/migrations.injectable";
+
+export const enabledExtensionsMigrationDeclarationInjectionToken = getInjectionToken<MigrationDeclaration>({
+  id: "enabled-extensions-migration-declaration",
+});
@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { LensExtensionId } from "@k8slens/legacy-extensions";
+import { getInjectable } from "@ogre-tools/injectable";
+import { observable } from "mobx";
+
+export interface LensExtensionState {
+  enabled?: boolean;
+  name: string;
+}
+
+const enabledExtensionsStateInjectable = getInjectable({
+  id: "enabled-extensions-state",
+  instantiate: () => observable.map<LensExtensionId, LensExtensionState>(),
+});
+
+export default enabledExtensionsStateInjectable;
@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { LensExtensionId } from "@k8slens/legacy-extensions";
+import { getInjectable } from "@ogre-tools/injectable";
+import { action, toJS } from "mobx";
+import createPersistentStorageInjectable from "../../../../common/persistent-storage/create.injectable";
+import persistentStorageMigrationsInjectable from "../../../../common/persistent-storage/migrations.injectable";
+import storageMigrationVersionInjectable from "../../../../common/persistent-storage/storage-migration-version.injectable";
+import { enabledExtensionsMigrationDeclarationInjectionToken } from "./migrations";
+import type { LensExtensionState } from "./state.injectable";
+import enabledExtensionsStateInjectable from "./state.injectable";
+
+interface EnabledExtensionsStorageModal {
+  extensions: [LensExtensionId, LensExtensionState][];
+}
+
+const enabledExtensionsPersistentStorageInjectable = getInjectable({
+  id: "enabled-extensions-persistent-storage",
+  instantiate: (di) => {
+    const createPersistentStorage = di.inject(createPersistentStorageInjectable);
+    const state = di.inject(enabledExtensionsStateInjectable);
+
+    return createPersistentStorage<EnabledExtensionsStorageModal>({
+      configName: "lens-extensions",
+      fromStore: action(({ extensions = [] }) => {
+        state.replace(extensions);
+      }),
+      toJSON: () => ({
+        extensions: [...toJS(state)],
+      }),
+      projectVersion: di.inject(storageMigrationVersionInjectable, enabledExtensionsMigrationDeclarationInjectionToken),
+      migrations: di.inject(persistentStorageMigrationsInjectable, enabledExtensionsMigrationDeclarationInjectionToken),
+    });
+  },
+});
+
+export default enabledExtensionsPersistentStorageInjectable;
@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { LensExtensionId } from "@k8slens/legacy-extensions";
+import { getInjectable } from "@ogre-tools/injectable";
+import type { IObservableMapInitialValues } from "mobx";
+import { action } from "mobx";
+import type { LensExtensionState } from "./state.injectable";
+import enabledExtensionsStateInjectable from "./state.injectable";
+
+export type UpdateExtensionsState = (state: IObservableMapInitialValues<LensExtensionId, LensExtensionState>) => void;
+
+const updateExtensionsStateInjectable = getInjectable({
+  id: "update-extensions-state",
+  instantiate: (di): UpdateExtensionsState => {
+    const state = di.inject(enabledExtensionsStateInjectable);
+
+    return action((newState) => state.merge(newState));
+  },
+});
+
+export default updateExtensionsStateInjectable;
@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { beforeApplicationIsLoadingInjectionToken } from "@k8slens/application";
+import { getInjectable } from "@ogre-tools/injectable";
+import enabledExtensionsPersistentStorageInjectable from "../common/storage.injectable";
+
+const loadEnabledExtensionsStorageInjectable = getInjectable({
+  id: "load-enabled-extensions-storage",
+  instantiate: (di) => ({
+    run: () => {
+      const storage = di.inject(enabledExtensionsPersistentStorageInjectable);
+
+      storage.loadAndStartSyncing();
+    },
+  }),
+  injectionToken: beforeApplicationIsLoadingInjectionToken,
+});
+
+export default loadEnabledExtensionsStorageInjectable;
@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { isObject } from "@k8slens/utilities";
+import { getInjectable } from "@ogre-tools/injectable";
+import { enabledExtensionsMigrationDeclarationInjectionToken } from "../common/migrations";
+
+const enabledExtensionsMigrationV650Injectable = getInjectable({
+  id: "enabled-extensions-migration-v650",
+  instantiate: () => ({
+    version: "6.5.0",
+    run: (store) => {
+      const extensions = store.get("extensions");
+
+      if (!isObject(extensions)) {
+        store.delete("extensions");
+      } else {
+        store.set("extensions", Object.entries(extensions));
+      }
+    },
+  }),
+  injectionToken: enabledExtensionsMigrationDeclarationInjectionToken,
+});
+
+export default enabledExtensionsMigrationV650Injectable;
@@ -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 { beforeFrameStartsSecondInjectionToken } from "../../../../renderer/before-frame-starts/tokens";
+import enabledExtensionsPersistentStorageInjectable from "../common/storage.injectable";
+
+const loadEnabledExtensionsStorageInjectable = getInjectable({
+  id: "load-enabled-extensions-storage",
+  instantiate: (di) => ({
+    run: () => {
+      const storage = di.inject(enabledExtensionsPersistentStorageInjectable);
+
+      storage.loadAndStartSyncing();
+    },
+  }),
+  injectionToken: beforeFrameStartsSecondInjectionToken,
+});
+
+export default loadEnabledExtensionsStorageInjectable;