Helper to resolve proxy from URL in any environment, or using extension-API (#5690)

* Permit modular directory structures for behaviours in spirit of "Screaming Architecture" Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Implement env-agnostic helper to resolve proxy from URL Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Implement way to resolve a proxy, that is not reliant on existing windows Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Restore reliancy on existing windows for resolving proxy for fears of Electron events misbehaving because of a temp-window used in case no windows are open Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Make resolving a proxy throw if no browser window is available Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Extract minimal abstraction for specifically logging error instead of also warn, info, etc. Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Make decorator for error logging not create orphan promise for easier controllability Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Add error logging to resolving of proxy Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Expose resolving of proxy in extension-API Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Add missing general override Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Add test to add documentation Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Disperse implementation of resolve-proxy back to conventional directory structure instead of an experimental one Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Revert "Permit modular directory structures for behaviours in spirit of "Screaming Architecture"" This reverts commit 75e1231b0e61b74d030d12365352226e7f1ce500. Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Rename a helper for less ambiguity Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Add tsdoc for "resolveSystemProxy" exposed in Extension-API Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>
2025-05-20 05:10:56 +00:00 · 2022-06-22 16:09:24 +03:00
1 parent fa23b5cd3f
commit 71427da02d
@@ -0,0 +1,85 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { AsyncFnMock } from "@async-fn/jest";
+import asyncFn from "@async-fn/jest";
+import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
+import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
+import type { ResolveSystemProxy } from "../../common/utils/resolve-system-proxy/resolve-system-proxy-injection-token";
+import { resolveSystemProxyInjectionToken } from "../../common/utils/resolve-system-proxy/resolve-system-proxy-injection-token";
+import resolveSystemProxyFromElectronInjectable from "../../main/utils/resolve-system-proxy/resolve-system-proxy-from-electron.injectable";
+import { getPromiseStatus } from "../../common/test-utils/get-promise-status";
+
+describe("resolve-system-proxy", () => {
+  let applicationBuilder: ApplicationBuilder;
+  let actualPromise: Promise<string>;
+  let resolveSystemProxyFromElectronMock: AsyncFnMock<ResolveSystemProxy>;
+
+  beforeEach(async () => {
+    applicationBuilder = getApplicationBuilder();
+
+    resolveSystemProxyFromElectronMock = asyncFn();
+
+    applicationBuilder.beforeApplicationStart(({ mainDi }) => {
+      mainDi.override(
+        resolveSystemProxyFromElectronInjectable,
+        () => resolveSystemProxyFromElectronMock,
+      );
+    });
+
+    await applicationBuilder.render();
+  });
+
+  describe("given in main, when called with URL", () => {
+    beforeEach(async () => {
+      const resolveSystemProxyInMain = applicationBuilder.dis.mainDi.inject(
+        resolveSystemProxyInjectionToken,
+      );
+
+      actualPromise = resolveSystemProxyInMain("some-url");
+    });
+
+    it("calls for proxy of the URL from Electron", () => {
+      expect(resolveSystemProxyFromElectronMock).toHaveBeenCalledWith("some-url");
+    });
+
+    it("does not resolve yet", async () => {
+      const promiseStatus = await getPromiseStatus(actualPromise);
+
+      expect(promiseStatus.fulfilled).toBe(false);
+    });
+
+    it("when the call for proxy resolves, resolves with the proxy", async () => {
+      resolveSystemProxyFromElectronMock.resolve("some-proxy");
+
+      expect(await actualPromise).toBe("some-proxy");
+    });
+  });
+
+  describe("given in renderer, when called with URL", () => {
+    beforeEach(async () => {
+      const resolveSystemProxyInRenderer = applicationBuilder.dis.rendererDi.inject(
+        resolveSystemProxyInjectionToken,
+      );
+
+      actualPromise = resolveSystemProxyInRenderer("some-url");
+    });
+
+    it("calls for proxy of the URL from Electron", () => {
+      expect(resolveSystemProxyFromElectronMock).toHaveBeenCalledWith("some-url");
+    });
+
+    it("does not resolve yet", async () => {
+      const promiseStatus = await getPromiseStatus(actualPromise);
+
+      expect(promiseStatus.fulfilled).toBe(false);
+    });
+
+    it("when the call for proxy resolves, resolves with the proxy", async () => {
+      resolveSystemProxyFromElectronMock.resolve("some-proxy");
+
+      expect(await actualPromise).toBe("some-proxy");
+    });
+  });
+});