chore: loggerInjectionToken

Signed-off-by: Gabriel <gaccettola@mirantis.com>

packages/core/src/extensions/as-legacy-globals-for-extension-api/as-legacy-global-singleton-object-for-extension-api.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { Injectable } from "@ogre-tools/injectable";
+import { asLegacyGlobalForExtensionApi } from "./as-legacy-global-object-for-extension-api";
+import { getLegacyGlobalDiForExtensionApi } from "./legacy-global-di-for-extension-api";
+import { loggerInjectable } from "@k8slens/logger";
+
+export interface LegacySingleton<T> {
+  createInstance(): T;
+  getInstance(): T;
+  resetInstance(): void;
+}
+
+export function asLegacyGlobalSingletonForExtensionApi<Instance>(injectable: Injectable<Instance, unknown, void>): LegacySingleton<Instance>;
+export function asLegacyGlobalSingletonForExtensionApi<Instance, InstantiationParameter>(injectable: Injectable<Instance, unknown, InstantiationParameter>, param: InstantiationParameter): LegacySingleton<Instance>;
+
+export function asLegacyGlobalSingletonForExtensionApi<Instance, InstantiationParameter>(
+  injectable: Injectable<Instance, unknown, InstantiationParameter>,
+  instantiationParameter?: InstantiationParameter,
+): LegacySingleton<Instance> {
+  const instance = asLegacyGlobalForExtensionApi(
+    injectable as never,
+    instantiationParameter,
+  ) as Instance;
+
+  return {
+    createInstance: () => instance,
+
+    getInstance: () => instance,
+
+    resetInstance: () => {
+      const di = getLegacyGlobalDiForExtensionApi();
+      const logger = di.inject(loggerInjectable);
+
+      logger.warn(
+        `resetInstance() for a legacy global singleton of "${injectable.id}" does nothing.`,
+      );
+    },
+  };
+}

packages/core/src/extensions/common-api/index.ts

@@ -3,7 +3,7 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 import { asLegacyGlobalForExtensionApi } from "@k8slens/legacy-global-di";
 
 // APIs
@@ -20,4 +20,4 @@ export type { LensExtension } from "../lens-extension";
 export type { PackageJson } from "type-fest";
 export type { LensExtensionManifest, InstalledExtension } from "@k8slens/legacy-extensions";
 
-export const logger = asLegacyGlobalForExtensionApi(loggerInjectable);
+export const logger = asLegacyGlobalForExtensionApi(loggerInjectionToken);

packages/core/src/extensions/common-api/k8s-api.ts

@@ -21,7 +21,7 @@ import type { DerivedKubeApiOptions, KubeApiDependencies, KubeApiOptions } from
 import { KubeApi as InternalKubeApi } from "../../common/k8s-api/kube-api";
 import clusterFrameContextForNamespacedResourcesInjectable from "../../renderer/cluster-frame-context/for-namespaced-resources.injectable";
 import type { ClusterContext } from "../../renderer/cluster-frame-context/cluster-frame-context";
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 import maybeKubeApiInjectable from "../../common/k8s-api/maybe-kube-api.injectable";
 import { DeploymentApi as InternalDeploymentApi, IngressApi as InternalIngressApi, NodeApi, PersistentVolumeClaimApi, PodApi } from "../../common/k8s-api/endpoints";
 import { storesAndApisCanBeCreatedInjectionToken } from "../../common/k8s-api/stores-apis-can-be-created.token";
@@ -42,7 +42,7 @@ const getKubeApiDeps = (): KubeApiDependencies => {
   const di = getLegacyGlobalDiForExtensionApi();
 
   return {
-    logger: di.inject(loggerInjectable),
+    logger: di.inject(loggerInjectionToken),
     maybeKubeApi: di.inject(maybeKubeApiInjectable),
   };
 };
@@ -190,7 +190,7 @@ export abstract class KubeObjectStore<
     super(
       {
         context: di.inject(clusterFrameContextForNamespacedResourcesInjectable),
-        logger: di.inject(loggerInjectable),
+        logger: di.inject(loggerInjectionToken),
       },
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       api!,

packages/core/src/extensions/extension-discovery/extension-discovery.injectable.ts

@@ -10,7 +10,7 @@ import extensionInstallationStateStoreInjectable from "../extension-installation
 import installExtensionInjectable from "../install-extension/install-extension.injectable";
 import extensionPackageRootDirectoryInjectable from "../install-extension/extension-package-root-directory.injectable";
 import readJsonFileInjectable from "../../common/fs/read-json-file.injectable";
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 import pathExistsInjectable from "../../common/fs/path-exists.injectable";
 import watchInjectable from "../../common/fs/watch/watch.injectable";
 import accessPathInjectable from "../../common/fs/access-path.injectable";
@@ -43,7 +43,7 @@ const extensionDiscoveryInjectable = getInjectable({
     readJsonFile: di.inject(readJsonFileInjectable),
     pathExists: di.inject(pathExistsInjectable),
     watch: di.inject(watchInjectable),
-    logger: di.inject(loggerInjectable),
+    logger: di.inject(loggerInjectionToken),
     accessPath: di.inject(accessPathInjectable),
     copy: di.inject(copyInjectable),
     removePath: di.inject(removePathInjectable),

packages/core/src/extensions/extension-installation-state-store/extension-installation-state-store.injectable.ts

@@ -3,13 +3,13 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 import { ExtensionInstallationStateStore } from "./extension-installation-state-store";
 
 const extensionInstallationStateStoreInjectable = getInjectable({
   id: "extension-installation-state-store",
   instantiate: (di) => new ExtensionInstallationStateStore({
-    logger: di.inject(loggerInjectable),
+    logger: di.inject(loggerInjectionToken),
   }),
 });
 

packages/core/src/extensions/extension-loader/extension-loader.injectable.ts

@@ -6,7 +6,7 @@ import { getInjectable } from "@ogre-tools/injectable";
 import { ExtensionLoader } from "./extension-loader";
 import extensionInstancesInjectable from "./extension-instances.injectable";
 import extensionInjectable from "./extension/extension.injectable";
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 import joinPathsInjectable from "../../common/path/join-paths.injectable";
 import getDirnameOfPathInjectable from "../../common/path/get-dirname.injectable";
 import { bundledExtensionInjectionToken } from "@k8slens/legacy-extensions";
@@ -22,7 +22,7 @@ const extensionLoaderInjectable = getInjectable({
     getExtension: (instance) => di.inject(extensionInjectable, instance),
     bundledExtensions: di.injectMany(bundledExtensionInjectionToken),
     extensionEntryPointName: di.inject(extensionEntryPointNameInjectionToken),
-    logger: di.inject(loggerInjectable),
+    logger: di.inject(loggerInjectionToken),
     joinPaths: di.inject(joinPathsInjectable),
     getDirnameOfPath: di.inject(getDirnameOfPathInjectable),
   }),

packages/core/src/extensions/ipc/ipc-main.ts

@@ -11,7 +11,7 @@ import { once } from "lodash";
 import { ipcMainHandle } from "../../common/ipc";
 import type { Logger } from "@k8slens/logger";
 import { getEnvironmentSpecificLegacyGlobalDiForExtensionApi } from "@k8slens/legacy-global-di";
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 
 interface Dependencies {
   readonly logger: Logger;
@@ -26,7 +26,7 @@ export abstract class IpcMain extends IpcRegistrar {
     const di = getEnvironmentSpecificLegacyGlobalDiForExtensionApi("main");
 
     this.dependencies = {
-      logger: di.inject(loggerInjectable),
+      logger: di.inject(loggerInjectionToken),
     };
 
     // Call the static method on the bottom child class.

packages/core/src/extensions/lens-main-extension.ts

@@ -16,7 +16,7 @@ import type { InstalledExtension } from "./common-api";
 import type { CatalogEntityRegistry } from "../main/catalog";
 import type { NavigateForExtension } from "../main/start-main-application/lens-window/navigate-for-extension.injectable";
 import catalogEntityRegistryInjectable from "../main/catalog/entity-registry.injectable";
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 import navigateForExtensionInjectable from "../main/start-main-application/lens-window/navigate-for-extension.injectable";
 import ensureHashedDirectoryForExtensionInjectable from "./extension-loader/file-system-provisioner-store/ensure-hashed-directory-for-extension.injectable";
 
@@ -40,7 +40,7 @@ export class LensMainExtension extends LensExtension {
       ensureHashedDirectoryForExtension: di.inject(ensureHashedDirectoryForExtensionInjectable),
       navigate: di.inject(navigateForExtensionInjectable),
       entityRegistry: di.inject(catalogEntityRegistryInjectable),
-      logger: di.inject(loggerInjectable),
+      logger: di.inject(loggerInjectionToken),
     };
 
     super(deps, extension);

packages/core/src/extensions/lens-renderer-extension.ts

@@ -39,7 +39,7 @@ import type { InstalledExtension } from "./common-api";
 import { getEnvironmentSpecificLegacyGlobalDiForExtensionApi } from "@k8slens/legacy-global-di";
 import catalogCategoryRegistryInjectable from "../common/catalog/category-registry.injectable";
 import catalogEntityRegistryInjectable from "../renderer/api/catalog/entity/registry.injectable";
-import { loggerInjectable } from "@k8slens/logger";
+import { loggerInjectionToken } from "@k8slens/logger";
 import getExtensionPageParametersInjectable from "../renderer/routes/get-extension-page-parameters.injectable";
 import navigateToRouteInjectable from "../renderer/routes/navigate-to-route.injectable";
 import routesInjectable from "../renderer/routes/routes.injectable";
@@ -89,7 +89,7 @@ export class LensRendererExtension extends LensExtension {
       categoryRegistry: di.inject(catalogCategoryRegistryInjectable),
       entityRegistry: di.inject(catalogEntityRegistryInjectable),
       routes: di.inject(routesInjectable),
-      logger: di.inject(loggerInjectable),
+      logger: di.inject(loggerInjectionToken),
     };
 
     super(deps, extension);