Convert runMany and runManySync to use injectManyWithMeta + move to seperate package (#7244)

* Convert runMany and runManySync to use injectManyWithMeta Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup type errors due to new Runnable requirements Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add documentation for verifyRunnablesAreDAG Signed-off-by: Sebastian Malton <sebastian@malton.name> * Simplify convertToWithIdWith Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move all utility functions to separate package Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move testing utilities to separate package Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move run-many and run-many-sync to separate package Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace all internal uses of utilities with new packages Signed-off-by: Sebastian Malton <sebastian@malton.name> * Use new @k8slens/run-many package in core Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add dep to open-lens Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup uses of @k8slens/test-utils Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup getGlobalOverride Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move tests to new package too Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup uses of AsyncResult and autoBind Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup remaining import issues Signed-off-by: Sebastian Malton <sebastian@malton.name> * Finial fixups to fix build Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix lint Signed-off-by: Sebastian Malton <sebastian@malton.name> * Revert moving "testUsingFakeTime" to separate package - This fixes tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix integration tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix unit test failing due to spelling fix 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-10 10:07:28 +02:00
1 parent ad9bafe2a5
commit 2789bcebcb
@@ -7,7 +7,7 @@ import type { ExtensionLoader } from "../extension-loader";
 import extensionLoaderInjectable from "../extension-loader/extension-loader.injectable";
 import { runInAction } from "mobx";
 import updateExtensionsStateInjectable from "../extension-loader/update-extensions-state/update-extensions-state.injectable";
-import { delay } from "../../renderer/utils";
+import { delay } from "@k8slens/utilities";
 import { getDiForUnitTesting } from "../../renderer/getDiForUnitTesting";
 import ipcRendererInjectable from "../../renderer/utils/channel/ipc-renderer.injectable";
 import type { IpcRenderer } from "electron";
@@ -8,11 +8,49 @@ import buildVersionInjectable from "../../main/vars/build-version/build-version.
 import { asLegacyGlobalFunctionForExtensionApi } from "../as-legacy-globals-for-extension-api/as-legacy-global-function-for-extension-api";
 import { getLegacyGlobalDiForExtensionApi } from "../as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api";

-export { Singleton } from "../../common/utils";
-export { prevDefault, stopPropagation } from "../../renderer/utils/prevDefault";
+export { Singleton } from "../../common/utils/singleton";

-export type { IClassName, IgnoredClassNames } from "../../renderer/utils";
-export { cssNames } from "../../renderer/utils/cssNames";
+export {
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  prevDefault,
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  stopPropagation,
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  cssNames,
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  disposer,
+} from "@k8slens/utilities";
+
+export type {
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  IClassName,
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  IgnoredClassNames,
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  Disposer,
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  Disposable,
+  /**
+   * @deprecated Switch to using the `@k8slens/utilities` package
+   */
+  ExtendableDisposer,
+} from "@k8slens/utilities";

 export type { OpenLinkInBrowser } from "../../common/utils/open-link-in-browser.injectable";

@@ -24,6 +62,3 @@ export const getAppVersion = () => {

  return di.inject(buildVersionInjectable).get();
 };
-
-export { disposer } from "../../common/utils";
-export type { Disposer, Disposable, ExtendableDisposer } from "../../common/utils";
@@ -9,7 +9,7 @@ import extensionDiscoveryInjectable from "../extension-discovery/extension-disco
 import type { ExtensionDiscovery } from "../extension-discovery/extension-discovery";
 import installExtensionInjectable from "../install-extension/install-extension.injectable";
 import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
-import { delay } from "../../renderer/utils";
+import { delay } from "@k8slens/utilities";
 import { observable, runInAction, when } from "mobx";
 import readJsonFileInjectable from "../../common/fs/read-json-file.injectable";
 import pathExistsInjectable from "../../common/fs/path-exists.injectable";
@@ -7,7 +7,8 @@ import { ipcRenderer } from "electron";
 import { EventEmitter } from "events";
 import { makeObservable, observable, reaction, when } from "mobx";
 import { broadcastMessage, ipcMainHandle, ipcRendererOn } from "../../common/ipc";
-import { isErrnoException, toJS } from "../../common/utils";
+import { toJS } from "../../common/utils";
+import { isErrnoException } from "@k8slens/utilities";
 import type { ExtensionsStore } from "../extensions-store/extensions-store";
 import type { ExtensionLoader } from "../extension-loader";
 import type { LensExtensionId, LensExtensionManifest } from "../lens-extension";
@@ -4,8 +4,8 @@
 */

 import { action, computed, observable } from "mobx";
-import { disposer } from "../../renderer/utils";
-import type { ExtendableDisposer } from "../../renderer/utils";
+import { disposer } from "@k8slens/utilities";
+import type { ExtendableDisposer } from "@k8slens/utilities";
 import * as uuid from "uuid";
 import { broadcastMessage } from "../../common/ipc";
 import { ipcRenderer } from "electron";
@@ -6,9 +6,9 @@
 import { ipcMain, ipcRenderer } from "electron";
 import { isEqual } from "lodash";
 import type { ObservableMap } from "mobx";
-import { action, computed, makeObservable, observable, observe, reaction, when } from "mobx";
+import { action, computed, makeObservable, toJS, observable, observe, reaction, when } from "mobx";
 import { broadcastMessage, ipcMainOn, ipcRendererOn, ipcMainHandle } from "../../common/ipc";
-import { isDefined, toJS } from "../../common/utils";
+import { isDefined } from "@k8slens/utilities";
 import type { InstalledExtension } from "../extension-discovery/extension-discovery";
 import type { LensExtension, LensExtensionConstructor, LensExtensionId } from "../lens-extension";
 import type { LensExtensionState } from "../extensions-store/extensions-store";
@@ -6,7 +6,7 @@ import type { Injectable } from "@ogre-tools/injectable";
 import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
 import { difference, find, map } from "lodash";
 import { reaction, runInAction } from "mobx";
-import { disposer } from "../../../common/utils/disposer";
+import { disposer } from "@k8slens/utilities";
 import type { LensExtension } from "../../lens-extension";
 import { extensionRegistratorInjectionToken } from "../extension-registrator-injection-token";

@@ -43,7 +43,7 @@ const extensionInjectable = getInjectable({

              reactionDisposer.push(
                // injectables is either an array or a computed array, in which case
-                // we need to update the registered injectables with a reaction every time they change 
+                // we need to update the registered injectables with a reaction every time they change
                reaction(
                  () => Array.isArray(injectables) ? injectables : injectables.get(),
                  (currentInjectables, previousInjectables = []) => {
@@ -5,7 +5,7 @@

 import { getInjectable } from "@ogre-tools/injectable";

-import { getOrInsert } from "../../../common/utils";
+import { getOrInsert } from "@k8slens/utilities";
 import randomBytesInjectable from "../../../common/utils/random-bytes.injectable";
 import joinPathsInjectable from "../../../common/path/join-paths.injectable";
 import directoryForExtensionDataInjectable from "./directory-for-extension-data.injectable";
@@ -8,7 +8,6 @@ import { action, makeObservable } from "mobx";
 import type { BaseStoreDependencies } from "../../../common/base-store/base-store";
 import { BaseStore } from "../../../common/base-store/base-store";
 import type { LensExtensionId } from "../../lens-extension";
-import { toJS } from "../../../common/utils";
 import type { EnsureHashedDirectoryForExtension } from "./ensure-hashed-directory-for-extension.injectable";

 interface FSProvisionModel {
@@ -46,8 +45,8 @@ export class FileSystemProvisionerStore extends BaseStore<FSProvisionModel> {
  }

  toJSON(): FSProvisionModel {
-    return toJS({
-      extensions: Object.fromEntries(this.dependencies.registeredExtensions),
-    });
+    return {
+      extensions: Object.fromEntries(this.dependencies.registeredExtensions.toJSON()),
+    };
  }
 }
@@ -8,8 +8,8 @@ import { BaseStore } from "../common/base-store/base-store";
 import * as path from "path";
 import type { LensExtension } from "./lens-extension";
 import assert from "assert";
-import type { StaticThis } from "../common/utils";
-import { getOrInsertWith } from "../common/utils";
+import type { StaticThis } from "../common/utils/singleton";
+import { getOrInsertWith } from "@k8slens/utilities";
 import { getLegacyGlobalDiForExtensionApi } from "./as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api";
 import directoryForUserDataInjectable from "../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
 import getConfigurationFileModelInjectable from "../common/get-configuration-file-model/get-configuration-file-model.injectable";
@@ -5,7 +5,6 @@

 import type { LensExtensionId } from "../lens-extension";
 import { action, computed, makeObservable, observable } from "mobx";
-import { toJS } from "../../common/utils";
 import type { BaseStoreDependencies } from "../../common/base-store/base-store";
 import { BaseStore } from "../../common/base-store/base-store";

@@ -57,8 +56,8 @@ export class ExtensionsStore extends BaseStore<LensExtensionsStoreModel> {
  }

  toJSON(): LensExtensionsStoreModel {
-    return toJS({
-      extensions: Object.fromEntries(this.state),
-    });
+    return {
+      extensions: Object.fromEntries(this.state.toJSON()),
+    };
  }
 }
@@ -13,7 +13,7 @@ import joinPathsInjectable from "../../common/path/join-paths.injectable";
 import type { PackageJson } from "../common-api";
 import writeJsonFileInjectable from "../../common/fs/write-json-file.injectable";
 import { once } from "lodash";
-import { isErrnoException } from "../../common/utils";
+import { isErrnoException } from "@k8slens/utilities";

 const baseNpmInstallArgs = [
  "install",
@@ -6,7 +6,7 @@ import { ipcMain } from "electron";
 import { IpcPrefix, IpcRegistrar } from "./ipc-registrar";
 import { Disposers, lensExtensionDependencies } from "../lens-extension";
 import type { LensMainExtension } from "../lens-main-extension";
-import type { Disposer } from "../../common/utils";
+import type { Disposer } from "@k8slens/utilities";
 import { once } from "lodash";
 import { ipcMainHandle } from "../../common/ipc";

@@ -2,7 +2,7 @@
 * Copyright (c) OpenLens Authors. All rights reserved.
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
-import { Singleton } from "../../common/utils";
+import { Singleton } from "../../common/utils/singleton";
 import type { LensExtension } from "../lens-extension";
 import { createHash } from "crypto";
 import { broadcastMessage } from "../../common/ipc";
@@ -6,7 +6,7 @@ import { ipcRenderer } from "electron";
 import { IpcPrefix, IpcRegistrar } from "./ipc-registrar";
 import { Disposers } from "../lens-extension";
 import type { LensRendererExtension } from "../lens-renderer-extension";
-import type { Disposer } from "../../common/utils";
+import type { Disposer } from "@k8slens/utilities";
 import { once } from "lodash";

 export abstract class IpcRenderer extends IpcRegistrar {
@@ -6,7 +6,7 @@
 import type { InstalledExtension } from "./extension-discovery/extension-discovery";
 import { action, computed, makeObservable, observable } from "mobx";
 import type { PackageJson } from "type-fest";
-import { disposer } from "../common/utils";
+import { disposer } from "@k8slens/utilities";
 import type { LensExtensionDependencies } from "./lens-extension-set-dependencies";
 import type { ProtocolHandlerRegistration } from "../common/protocol-handler/registration";

@@ -5,7 +5,7 @@

 import { Disposers, LensExtension, lensExtensionDependencies } from "./lens-extension";
 import type { CatalogEntity, CategoryFilter } from "../common/catalog";
-import type { Disposer } from "../common/utils";
+import type { Disposer } from "@k8slens/utilities";
 import type { EntityFilter } from "../renderer/api/catalog/entity/registry";
 import type { TopBarRegistration } from "../renderer/components/layout/top-bar/top-bar-registration";
 import type { KubernetesCluster } from "../common/catalog-entities";
@@ -3,7 +3,7 @@
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
 import { powerMonitor } from "electron";
-import type { Disposer } from "../../common/utils/disposer";
+import type { Disposer } from "@k8slens/utilities";

 /**
 * Event listener for system power events
@@ -6,7 +6,7 @@

 import type { CatalogCategory, CatalogEntity } from "../../common/catalog";
 import type { CatalogEntityOnBeforeRun } from "../../renderer/api/catalog/entity/registry";
-import type { Disposer } from "../../common/utils";
+import type { Disposer } from "@k8slens/utilities";
 import catalogCategoryRegistryInjectable from "../../common/catalog/category-registry.injectable";
 import { asLegacyGlobalForExtensionApi } from "../as-legacy-globals-for-extension-api/as-legacy-global-object-for-extension-api";
 import catalogEntityRegistryInjectable from "../../renderer/api/catalog/entity/registry.injectable";
@@ -14,7 +14,7 @@ import navigateInjectable from "../../renderer/navigation/navigate.injectable";
 import { asLegacyGlobalFunctionForExtensionApi } from "../as-legacy-globals-for-extension-api/as-legacy-global-function-for-extension-api";

 export type { PageParamInit, PageParam } from "../../renderer/navigation/page-param";
-export type { URLParams } from "../../common/utils/buildUrl";
+export type { URLParams } from "@k8slens/utilities";

 export const getDetailsUrl = asLegacyGlobalFunctionForExtensionApi(getDetailsUrlInjectable);
 export const showDetails = asLegacyGlobalFunctionForExtensionApi(showDetailsInjectable);