Replace global state usages of ExtensionLoader with DI

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

src/extensions/__tests__/extension-discovery.test.ts

@@ -27,6 +27,9 @@ import { ExtensionDiscovery } from "../extension-discovery";
 import os from "os";
 import { Console } from "console";
 import { AppPaths } from "../../common/app-paths";
+import type { ExtensionLoader } from "../extension-loader";
+import extensionLoaderInjectable from "../extension-loader/extension-loader.injectable";
+import { getDiForUnitTesting } from "../getDiForUnitTesting";
 
 jest.setTimeout(60_000);
 
@@ -62,10 +65,16 @@ console = new Console(process.stdout, process.stderr); // fix mockFS
 const mockedWatch = watch as jest.MockedFunction<typeof watch>;
 
 describe("ExtensionDiscovery", () => {
+  let extensionLoader: ExtensionLoader;
+
   beforeEach(() => {
     ExtensionDiscovery.resetInstance();
     ExtensionsStore.resetInstance();
     ExtensionsStore.createInstance();
+
+    const di = getDiForUnitTesting();
+
+    extensionLoader = di.inject(extensionLoaderInjectable);
   });
 
   describe("with mockFs", () => {
@@ -98,7 +107,9 @@ describe("ExtensionDiscovery", () => {
         (mockWatchInstance) as any,
       );
 
-      const extensionDiscovery = ExtensionDiscovery.createInstance();
+      const extensionDiscovery = ExtensionDiscovery.createInstance(
+        extensionLoader,
+      );
 
       // Need to force isLoaded to be true so that the file watching is started
       extensionDiscovery.isLoaded = true;
@@ -140,7 +151,9 @@ describe("ExtensionDiscovery", () => {
     mockedWatch.mockImplementationOnce(() =>
       (mockWatchInstance) as any,
     );
-    const extensionDiscovery = ExtensionDiscovery.createInstance();
+    const extensionDiscovery = ExtensionDiscovery.createInstance(
+      extensionLoader,
+    );
 
     // Need to force isLoaded to be true so that the file watching is started
     extensionDiscovery.isLoaded = true;

src/extensions/__tests__/extension-loader.test.ts

@@ -19,11 +19,13 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import { ExtensionLoader } from "../extension-loader";
+import type { ExtensionLoader } from "../extension-loader";
 import { ipcRenderer } from "electron";
 import { ExtensionsStore } from "../extensions-store";
 import { Console } from "console";
 import { stdout, stderr } from "process";
+import { getDiForUnitTesting } from "../getDiForUnitTesting";
+import extensionLoaderInjectable from "../extension-loader/extension-loader.injectable";
 
 console = new Console(stdout, stderr);
 
@@ -128,13 +130,15 @@ jest.mock(
 );
 
 describe("ExtensionLoader", () => {
+  let extensionLoader: ExtensionLoader;
+
   beforeEach(() => {
-    ExtensionLoader.resetInstance();
+    const di = getDiForUnitTesting();
+
+    extensionLoader = di.inject(extensionLoaderInjectable);
   });
 
-  it.only("renderer updates extension after ipc broadcast", async (done) => {
-    const extensionLoader = ExtensionLoader.createInstance();
-
+  it.only("renderer updates extension after ipc broadcast", async done => {
     expect(extensionLoader.userExtensions).toMatchInlineSnapshot(`Map {}`);
 
     await extensionLoader.init();
@@ -178,8 +182,6 @@ describe("ExtensionLoader", () => {
     // Disable sending events in this test
     (ipcRenderer.on as any).mockImplementation();
 
-    const extensionLoader = ExtensionLoader.createInstance();
-
     await extensionLoader.init();
 
     expect(ExtensionsStore.getInstance().mergeState).not.toHaveBeenCalled();
@@ -194,6 +196,7 @@ describe("ExtensionLoader", () => {
       "manifest/path2": {
         enabled: true,
         name: "TestExtension2",
-      }});
+      },
+    });
   });
 });

src/extensions/extension-discovery.ts

@@ -32,7 +32,7 @@ import logger from "../main/logger";
 import { ExtensionInstallationStateStore } from "../renderer/components/+extensions/extension-install.store";
 import { extensionInstaller } from "./extension-installer";
 import { ExtensionsStore } from "./extensions-store";
-import { ExtensionLoader } from "./extension-loader";
+import type { ExtensionLoader } from "./extension-loader";
 import type { LensExtensionId, LensExtensionManifest } from "./lens-extension";
 import { isProduction } from "../common/vars";
 import { isCompatibleBundledExtension, isCompatibleExtension } from "./extension-compatibility";
@@ -99,7 +99,7 @@ export class ExtensionDiscovery extends Singleton {
 
   public events = new EventEmitter();
 
-  constructor() {
+  constructor(protected extensionLoader: ExtensionLoader) {
     super();
 
     makeObservable(this);
@@ -277,7 +277,7 @@ export class ExtensionDiscovery extends Singleton {
    * @param extensionId The ID of the extension to uninstall.
    */
   async uninstallExtension(extensionId: LensExtensionId): Promise<void> {
-    const { manifest, absolutePath } = this.extensions.get(extensionId) ?? ExtensionLoader.getInstance().getExtension(extensionId);
+    const { manifest, absolutePath } = this.extensions.get(extensionId) ?? this.extensionLoader.getExtension(extensionId);
 
     logger.info(`${logModule} Uninstalling ${manifest.name}`);
 

src/extensions/extension-loader/index.ts

@@ -18,12 +18,5 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-import { getLegacySingleton } from "../../common/di-kludge/get-legacy-singleton/get-legacy-singleton";
-import extensionLoaderInjectable from "./extension-loader.injectable";
 
 export * from "./extension-loader";
-
-/**
- * @deprecated Switch to using di.inject(extensionLoaderInjectable)
- */
-export const ExtensionLoader = getLegacySingleton(extensionLoaderInjectable);

src/extensions/extensions.injectable.ts

@@ -21,15 +21,15 @@
 import { Injectable, lifecycleEnum } from "@ogre-tools/injectable";
 import { computed, IComputedValue } from "mobx";
 import type { LensExtension } from "./lens-extension";
-import { ExtensionLoader } from "./extension-loader";
-import type { ExtensionLoader as ExtensionLoaderType } from "./extension-loader/extension-loader";
+import type { ExtensionLoader } from "./extension-loader";
+import extensionLoaderInjectable from "./extension-loader/extension-loader.injectable";
 
 const extensionsInjectable: Injectable<
   IComputedValue<LensExtension[]>,
-  { extensionLoader: ExtensionLoaderType }
+  { extensionLoader: ExtensionLoader }
 > = {
-  getDependencies: () => ({
-    extensionLoader: ExtensionLoader.getInstance(),
+  getDependencies: di => ({
+    extensionLoader: di.inject(extensionLoaderInjectable),
   }),
 
   lifecycle: lifecycleEnum.singleton,

src/extensions/getDiForUnitTesting.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import glob from "glob";
+import { memoize } from "lodash/fp";
+
+import {
+  createContainer,
+  ConfigurableDependencyInjectionContainer,
+} from "@ogre-tools/injectable";
+import { setDiKludge } from "../common/di-kludge/di-kludge";
+
+export const getDiForUnitTesting = () => {
+  const di: ConfigurableDependencyInjectionContainer = createContainer();
+
+  setDiKludge(di);
+
+  getInjectableFilePaths()
+    .map(key => {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const injectable = require(key).default;
+
+      return {
+        id: key,
+        ...injectable,
+        aliases: [injectable, ...(injectable.aliases || [])],
+      };
+    })
+
+    .forEach(injectable => di.register(injectable));
+
+  di.preventSideEffects();
+
+  return di;
+};
+
+const getInjectableFilePaths = memoize(() => [
+  ...glob.sync("./**/*.injectable.{ts,tsx}", { cwd: __dirname }),
+]);