Stop using global shared state for ExtensionDiscovery and it's relatives

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>
Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

src/main/getDi.ts

@@ -20,13 +20,19 @@
  */
 
 import { createContainer } from "@ogre-tools/injectable";
+import { setLegacyGlobalDiForExtensionApi } from "../extensions/as-legacy-global-function-for-extension-api/legacy-global-di-for-extension-api";
 
-export const getDi = () =>
-  createContainer(
+export const getDi = () => {
+  const di = createContainer(
     getRequireContextForMainCode,
     getRequireContextForCommonExtensionCode,
   );
 
+  setLegacyGlobalDiForExtensionApi(di);
+
+  return di;
+};
+
 const getRequireContextForMainCode = () =>
   require.context("./", true, /\.injectable\.(ts|tsx)$/);
 

src/main/getDiForUnitTesting.ts

@@ -26,10 +26,13 @@ import {
   createContainer,
   ConfigurableDependencyInjectionContainer,
 } from "@ogre-tools/injectable";
+import { setLegacyGlobalDiForExtensionApi } from "../extensions/as-legacy-global-function-for-extension-api/legacy-global-di-for-extension-api";
 
 export const getDiForUnitTesting = () => {
   const di: ConfigurableDependencyInjectionContainer = createContainer();
 
+  setLegacyGlobalDiForExtensionApi(di);
+
   getInjectableFilePaths()
     .map(key => {
       // eslint-disable-next-line @typescript-eslint/no-var-requires

src/main/index.ts

@@ -36,7 +36,7 @@ import { mangleProxyEnv } from "./proxy-env";
 import { registerFileProtocol } from "../common/register-protocol";
 import logger from "./logger";
 import { appEventBus } from "../common/event-bus";
-import { InstalledExtension, ExtensionDiscovery } from "../extensions/extension-discovery";
+import type { InstalledExtension } from "../extensions/extension-discovery/extension-discovery";
 import type { LensExtensionId } from "../extensions/lens-extension";
 import { installDeveloperTools } from "./developer-tools";
 import { disposer, getAppVersion, getAppVersionFromProxyServer, storedKubeConfigFolder } from "../common/utils";
@@ -54,7 +54,6 @@ import { ClusterStore } from "../common/cluster-store";
 import { HotbarStore } from "../common/hotbar-store";
 import { UserStore } from "../common/user-store";
 import { WeblinkStore } from "../common/weblink-store";
-import { ExtensionsStore } from "../extensions/extensions-store";
 import { FilesystemProvisionerStore } from "./extension-filesystem";
 import { SentryInit } from "../common/sentry";
 import { ensureDir } from "fs-extra";
@@ -68,6 +67,8 @@ import { getDi } from "./getDi";
 import electronMenuItemsInjectable from "./menu/electron-menu-items.injectable";
 import extensionLoaderInjectable from "../extensions/extension-loader/extension-loader.injectable";
 import lensProtocolRouterMainInjectable from "./protocol-handler/lens-protocol-router-main/lens-protocol-router-main.injectable";
+import extensionDiscoveryInjectable
+  from "../extensions/extension-discovery/extension-discovery.injectable";
 
 const di = getDi();
 
@@ -169,7 +170,6 @@ app.on("ready", async () => {
   // HotbarStore depends on: ClusterStore
   HotbarStore.createInstance();
 
-  ExtensionsStore.createInstance();
   FilesystemProvisionerStore.createInstance();
   WeblinkStore.createInstance();
 
@@ -231,7 +231,7 @@ app.on("ready", async () => {
 
   extensionLoader.init();
 
-  const extensionDiscovery = ExtensionDiscovery.createInstance(extensionLoader);
+  const extensionDiscovery = di.inject(extensionDiscoveryInjectable);
 
   extensionDiscovery.init();
 

src/main/protocol-handler/__test__/router.test.ts

@@ -25,7 +25,7 @@ import { broadcastMessage } from "../../../common/ipc";
 import { ProtocolHandlerExtension, ProtocolHandlerInternal } from "../../../common/protocol-handler";
 import { delay, noop } from "../../../common/utils";
 import { LensExtension } from "../../../extensions/main-api";
-import { ExtensionsStore } from "../../../extensions/extensions-store";
+import { ExtensionsStore } from "../../../extensions/extensions-store/extensions-store";
 import type { LensProtocolRouterMain } from "../lens-protocol-router-main/lens-protocol-router-main";
 import mockFs from "mock-fs";
 import { AppPaths } from "../../../common/app-paths";
@@ -34,6 +34,8 @@ import extensionLoaderInjectable
   from "../../../extensions/extension-loader/extension-loader.injectable";
 import lensProtocolRouterMainInjectable
   from "../lens-protocol-router-main/lens-protocol-router-main.injectable";
+import extensionsStoreInjectable
+  from "../../../extensions/extensions-store/extensions-store.injectable";
 
 jest.mock("../../../common/ipc");
 
@@ -66,16 +68,17 @@ describe("protocol router tests", () => {
   // Unit tests are allowed to only public interfaces.
   let extensionLoader: any;
   let lpr: LensProtocolRouterMain;
+  let extensionsStore: ExtensionsStore;
 
   beforeEach(() => {
     const di = getDiForUnitTesting();
 
     extensionLoader = di.inject(extensionLoaderInjectable);
+    extensionsStore = di.inject(extensionsStoreInjectable);
 
     mockFs({
       "tmp": {},
     });
-    ExtensionsStore.createInstance();
 
     lpr = di.inject(lensProtocolRouterMainInjectable);
 
@@ -85,7 +88,9 @@ describe("protocol router tests", () => {
   afterEach(() => {
     jest.clearAllMocks();
 
+    // TODO: Remove Singleton from BaseStore to achieve independent unit testing
     ExtensionsStore.resetInstance();
+
     mockFs.restore();
   });
 
@@ -126,7 +131,7 @@ describe("protocol router tests", () => {
     });
 
     extensionLoader.instances.set(extId, ext);
-    (ExtensionsStore.getInstance() as any).state.set(extId, { enabled: true, name: "@mirantis/minikube" });
+    (extensionsStore as any).state.set(extId, { enabled: true, name: "@mirantis/minikube" });
 
     lpr.addInternalHandler("/", noop);
 
@@ -205,7 +210,7 @@ describe("protocol router tests", () => {
       });
 
     extensionLoader.instances.set(extId, ext);
-    (ExtensionsStore.getInstance() as any).state.set(extId, { enabled: true, name: "@foobar/icecream" });
+    (extensionsStore as any).state.set(extId, { enabled: true, name: "@foobar/icecream" });
 
     try {
       expect(await lpr.route("lens://extension/@foobar/icecream/page/foob")).toBeUndefined();
@@ -243,7 +248,7 @@ describe("protocol router tests", () => {
         });
 
       extensionLoader.instances.set(extId, ext);
-      (ExtensionsStore.getInstance() as any).state.set(extId, { enabled: true, name: "@foobar/icecream" });
+      (extensionsStore as any).state.set(extId, { enabled: true, name: "@foobar/icecream" });
     }
 
     {
@@ -268,11 +273,11 @@ describe("protocol router tests", () => {
         });
 
       extensionLoader.instances.set(extId, ext);
-      (ExtensionsStore.getInstance() as any).state.set(extId, { enabled: true, name: "icecream" });
+      (extensionsStore as any).state.set(extId, { enabled: true, name: "icecream" });
     }
 
-    (ExtensionsStore.getInstance() as any).state.set("@foobar/icecream", { enabled: true, name: "@foobar/icecream" });
-    (ExtensionsStore.getInstance() as any).state.set("icecream", { enabled: true, name: "icecream" });
+    (extensionsStore as any).state.set("@foobar/icecream", { enabled: true, name: "@foobar/icecream" });
+    (extensionsStore as any).state.set("icecream", { enabled: true, name: "icecream" });
 
     try {
       expect(await lpr.route("lens://extension/icecream/page")).toBeUndefined();

src/main/protocol-handler/lens-protocol-router-main/lens-protocol-router-main.injectable.ts

@@ -21,11 +21,13 @@
 import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
 import extensionLoaderInjectable from "../../../extensions/extension-loader/extension-loader.injectable";
 import { LensProtocolRouterMain } from "./lens-protocol-router-main";
+import extensionsStoreInjectable from "../../../extensions/extensions-store/extensions-store.injectable";
 
 const lensProtocolRouterMainInjectable = getInjectable({
   instantiate: (di) =>
     new LensProtocolRouterMain({
       extensionLoader: di.inject(extensionLoaderInjectable),
+      extensionsStore: di.inject(extensionsStoreInjectable),
     }),
 
   lifecycle: lifecycleEnum.singleton,

src/main/protocol-handler/lens-protocol-router-main/lens-protocol-router-main.ts

@@ -29,6 +29,7 @@ import { ProtocolHandlerInvalid, RouteAttempt } from "../../../common/protocol-h
 import { disposer, noop } from "../../../common/utils";
 import { WindowManager } from "../../window-manager";
 import type { ExtensionLoader } from "../../../extensions/extension-loader";
+import type { ExtensionsStore } from "../../../extensions/extensions-store/extensions-store";
 
 export interface FallbackHandler {
   (name: string): Promise<boolean>;
@@ -53,6 +54,7 @@ function checkHost<Query>(url: URLParse<Query>): boolean {
 
 interface Dependencies {
   extensionLoader: ExtensionLoader
+  extensionsStore: ExtensionsStore
 }
 
 export class LensProtocolRouterMain extends proto.LensProtocolRouter {