Replace global state usages of ExtensionLoader with DI

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

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

@@ -0,0 +1,40 @@
+/**
+ * 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 type { Injectable } from "@ogre-tools/injectable";
+import { lifecycleEnum } from "@ogre-tools/injectable";
+import extensionLoaderInjectable from "../../../extensions/extension-loader/extension-loader.injectable";
+import type { Dependencies } from "./lens-protocol-router-renderer";
+import { LensProtocolRouterRenderer } from "./lens-protocol-router-renderer";
+
+const lensProtocolRouterRendererInjectable: Injectable<
+  LensProtocolRouterRenderer,
+  Dependencies
+> = {
+  getDependencies: di => ({
+    extensionLoader: di.inject(extensionLoaderInjectable),
+  }),
+
+  instantiate: dependencies => new LensProtocolRouterRenderer(dependencies),
+
+  lifecycle: lifecycleEnum.singleton,
+};
+
+export default lensProtocolRouterRendererInjectable;

src/renderer/protocol-handler/lens-protocol-router-renderer/lens-protocol-router-renderer.tsx

@@ -0,0 +1,129 @@
+/**
+ * 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 React from "react";
+import { ipcRenderer } from "electron";
+import * as proto from "../../../common/protocol-handler";
+import Url from "url-parse";
+import { onCorrect } from "../../../common/ipc";
+import { foldAttemptResults, ProtocolHandlerInvalid, RouteAttempt } from "../../../common/protocol-handler";
+import { Notifications } from "../../components/notifications";
+import type { ExtensionLoader } from "../../../extensions/extension-loader";
+
+function verifyIpcArgs(args: unknown[]): args is [string, RouteAttempt] {
+  if (args.length !== 2) {
+    return false;
+  }
+
+  if (typeof args[0] !== "string") {
+    return false;
+  }
+
+  switch (args[1]) {
+    case RouteAttempt.MATCHED:
+    case RouteAttempt.MISSING:
+    case RouteAttempt.MISSING_EXTENSION:
+      return true;
+    default:
+      return false;
+  }
+}
+
+export interface Dependencies {
+  extensionLoader: ExtensionLoader
+}
+
+
+export class LensProtocolRouterRenderer extends proto.LensProtocolRouter {
+  constructor(protected dependencies: Dependencies) {
+    super(dependencies);
+  }
+
+  /**
+   * This function is needed to be called early on in the renderers lifetime.
+   */
+  public init(): void {
+    onCorrect({
+      channel: proto.ProtocolHandlerInternal,
+      source: ipcRenderer,
+      verifier: verifyIpcArgs,
+      listener: (event, rawUrl, mainAttemptResult) => {
+        const rendererAttempt = this._routeToInternal(new Url(rawUrl, true));
+
+        if (foldAttemptResults(mainAttemptResult, rendererAttempt) === RouteAttempt.MISSING) {
+          Notifications.shortInfo(
+            <p>
+              Unknown action <code>{rawUrl}</code>.{" "}
+              Are you on the latest version?
+            </p>,
+          );
+        }
+      },
+    });
+    onCorrect({
+      channel: proto.ProtocolHandlerExtension,
+      source: ipcRenderer,
+      verifier: verifyIpcArgs,
+      listener: async (event, rawUrl, mainAttemptResult) => {
+        const rendererAttempt = await this._routeToExtension(new Url(rawUrl, true));
+
+        switch (foldAttemptResults(mainAttemptResult, rendererAttempt)) {
+          case RouteAttempt.MISSING:
+            Notifications.shortInfo(
+              <p>
+                Unknown action <code>{rawUrl}</code>.{" "}
+                Are you on the latest version of the extension?
+              </p>,
+            );
+            break;
+          case RouteAttempt.MISSING_EXTENSION:
+            Notifications.shortInfo(
+              <p>
+                Missing extension for action <code>{rawUrl}</code>.{" "}
+                Not able to find extension in our known list.{" "}
+                Try installing it manually.
+              </p>,
+            );
+            break;
+        }
+      },
+    });
+    onCorrect({
+      channel: ProtocolHandlerInvalid,
+      source: ipcRenderer,
+      listener: (event, error, rawUrl) => {
+        Notifications.error((
+          <>
+            <p>
+              Failed to route <code>{rawUrl}</code>.
+            </p>
+            <p>
+              <b>Error:</b> {error}
+            </p>
+          </>
+        ));
+      },
+      verifier: (args): args is [string, string] => {
+        return args.length === 2 && typeof args[0] === "string";
+      },
+    });
+  }
+}