Making apiBase injectable (#6022)

* Making apiBase injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all of Helm functions to be DI Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make PortForward's use of apiBase fully injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all metric requests to be injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace resource applier with injectables Signed-off-by: Sebastian Malton <sebastian@malton.name> * Switch KubeJsonApi.forCluster to be injectable but do not use Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert the rest of shell sessions to be DI-ed - This is a prerequesit for using the new createKubeJsonApiForClusterInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Use new createKubeJsonApiForClusterInjectable for openNodeShellSession Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make KubeconfigDialog injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove jest-fetch-mock and make fetch injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests with new global override Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add new injectable for create KubeJsonApi and JsonApi instances Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix showing-details-for-helm-release behavioural tests - Remove HelmChartStore in favour of all injectables - Create a model for UpgradeChartDockTab Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix show details and updating helm releases tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix residual typing issues related to metrics Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix crash on load due to circular dependency Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix create resource tab not working Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove legacy apiBase global Signed-off-by: Sebastian Malton <sebastian@malton.name> * Introduce and use isDebuggingInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Introduce and use windowLocationInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove global legacy apiKube Signed-off-by: Sebastian Malton <sebastian@malton.name> * Improve injectable filenames compared to the injectables inside Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove modifying input in requestActivePortForwardInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Introduce and use get(Milli)SecondsFromUnixEpochInjectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Switch to non-reactive way of gettting possible helm release versions Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix typo Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix bug in KubeApi constructor Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all KubeApi related tests to use asyncFn Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix unit tests after introducing new injectables that have side effects Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix bad rebase causing tests to fail Signed-off-by: Sebastian Malton <sebastian@malton.name> * Improve expects for multiple field values Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix crash will looking up api refs Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix breaking change on KubeApi.list Signed-off-by: Sebastian Malton <sebastian@malton.name> * Better fix for formatting urls Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove injectable for time since we should just use useMockTime Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add happy path behavioural tests for upgrade chart tab Signed-off-by: Sebastian Malton <sebastian@malton.name> * Remove debug message Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix showing-details-for-helm-release tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix installing-helm-chart-from-new-tab tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests relating to hosted cluster id Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots to recent changes in master Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> * Reupdated upgrade chart new tab test snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix flakiness in unit test when using <Animated> Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix flakiness and improve tests for DeleteClusterDialog Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix kubeconfig-sync tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix <Extensions> tests by removing mockFs and making everything injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix build issues Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix getElectronAppPathInjectable override not returning absolute paths - Also fixes the listing-active-helm-repos-in-prefs tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace all uses of getAbsolutePath with joinPaths as it is more correct and less confusing Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix opening application window tests by making override properly absolute Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots relating no longer using getAbsolutePath Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix and add behavioural tests for RenderDelay Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix extension discovery tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix test flakiness because of path side effects, propagate uses to as many places Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix extension-discovery tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add global override to fix some tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Rewrite and fix implementation of KubeconfigManager and its tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests by global override pathExists Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix unit tests failing on windows by using injectable verions of path functions Signed-off-by: Sebastian Malton <sebastian@malton.name> * Attempt to fix test timeout by using runInAction Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix setupIpcMainHandlers usage Signed-off-by: Sebastian Malton <sebastian@malton.name> * Update snapshots Signed-off-by: Sebastian Malton <sebastian@malton.name> Signed-off-by: Sebastian Malton <sebastian@malton.name> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com> Co-authored-by: Iku-turso <mikko.aspiala@gmail.com>
2025-05-20 05:10:56 +00:00 · 2022-10-05 08:10:36 -04:00
1 parent ed073d6562
commit 76066c5ebf
@@ -7,6 +7,8 @@ import { PortForwardStore } from "./port-forward-store";
 import type { ForwardedPort } from "../port-forward-item";
 import createStorageInjectable from "../../utils/create-storage/create-storage.injectable";
 import notifyErrorPortForwardingInjectable from "../notify-error-port-forwarding.injectable";
+import { apiBaseInjectionToken } from "../../../common/k8s-api/api-base";
+import requestActivePortForwardInjectable from "./request-active-port-forward.injectable";

 const portForwardStoreInjectable = getInjectable({
  id: "port-forward-store",
@@ -14,14 +16,14 @@ const portForwardStoreInjectable = getInjectable({
  instantiate: (di) => {
    const createStorage = di.inject(createStorageInjectable);

-    const storage = createStorage<ForwardedPort[] | undefined>(
-      "port_forwards",
-      undefined,
-    );
-
    return new PortForwardStore({
-      storage,
+      storage: createStorage<ForwardedPort[] | undefined>(
+        "port_forwards",
+        undefined,
+      ),
      notifyErrorPortForwarding: di.inject(notifyErrorPortForwardingInjectable),
+      apiBase: di.inject(apiBaseInjectionToken),
+      requestActivePortForward: di.inject(requestActivePortForwardInjectable),
    });
  },
 });
@@ -9,19 +9,22 @@ import type { StorageLayer } from "../../utils";
 import { autoBind, disposer } from "../../utils";
 import type { ForwardedPort } from "../port-forward-item";
 import { PortForwardItem } from "../port-forward-item";
-import { apiBase } from "../../api";
 import { waitUntilFree } from "tcp-port-used";
 import logger from "../../../common/logger";
+import type { JsonApi } from "../../../common/k8s-api/json-api";
+import type { RequestActivePortForward } from "./request-active-port-forward.injectable";

 interface Dependencies {
-  storage: StorageLayer<ForwardedPort[] | undefined>;
+  readonly storage: StorageLayer<ForwardedPort[] | undefined>;
  notifyErrorPortForwarding: (message: string) => void;
+  readonly apiBase: JsonApi; // TODO: replace with individual dependencies
+  requestActivePortForward: RequestActivePortForward;
 }

 export class PortForwardStore extends ItemStore<PortForwardItem> {
  @observable portForwards: PortForwardItem[] = [];

-  constructor(private dependencies: Dependencies) {
+  constructor(protected readonly dependencies: Dependencies) {
    super();
    makeObservable(this);
    autoBind(this);
@@ -222,7 +225,7 @@ export class PortForwardStore extends ItemStore<PortForwardItem> {
    const { port, forwardPort } = portForward;

    try {
-      await apiBase.del(
+      await this.dependencies.apiBase.del(
        `/pods/port-forward/${portForward.namespace}/${portForward.kind}/${portForward.name}`,
        { query: { port, forwardPort }},
      );
@@ -272,10 +275,10 @@ export class PortForwardStore extends ItemStore<PortForwardItem> {
    }

    const { port, forwardPort } = pf;
-    let response: PortForwardResult;
+    let response: { port: number };

    try {
-      response = await apiBase.post<PortForwardResult>(
+      response = await this.dependencies.apiBase.post(
        `/pods/port-forward/${pf.namespace}/${pf.kind}/${pf.name}`,
        { query: { port, forwardPort }},
      );
@@ -322,7 +325,7 @@ export class PortForwardStore extends ItemStore<PortForwardItem> {

    try {
      // check if the port-forward is active, and if so check if it has the same local port
-      const pf = await getActivePortForward(portForward);
+      const pf = await this.dependencies.requestActivePortForward(portForward);

      if (pf?.forwardPort && pf.forwardPort !== portForward.forwardPort) {
        logger.warn(
@@ -338,10 +341,6 @@ export class PortForwardStore extends ItemStore<PortForwardItem> {
  };
 }

-interface PortForwardResult {
-  port: number;
-}
-
 function portForwardsEqual(portForward: ForwardedPort) {
  return (pf: ForwardedPort) => (
    pf.kind == portForward.kind &&
@@ -350,21 +349,3 @@ function portForwardsEqual(portForward: ForwardedPort) {
    pf.port == portForward.port
  );
 }
-
-async function getActivePortForward(portForward: ForwardedPort): Promise<ForwardedPort | undefined> {
-  const { port, forwardPort } = portForward;
-  let response: PortForwardResult;
-
-  try {
-    response = await apiBase.get<PortForwardResult>(`/pods/port-forward/${portForward.namespace}/${portForward.kind}/${portForward.name}`, { query: { port, forwardPort }});
-  } catch (error) {
-    logger.warn(`[PORT-FORWARD-STORE] Error getting active port-forward: ${error}`, portForward);
-
-    return undefined;
-  }
-
-  portForward.status = response?.port ? "Active" : "Disabled";
-  portForward.forwardPort = response?.port;
-
-  return portForward;
-}
@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getInjectable } from "@ogre-tools/injectable";
+import { apiBaseInjectionToken } from "../../../common/k8s-api/api-base";
+import loggerInjectable from "../../../common/logger.injectable";
+import { urlBuilderFor } from "../../../common/utils/buildUrl";
+import type { ForwardedPort } from "../port-forward-item";
+
+export type RequestActivePortForward = (portForward: ForwardedPort) => Promise<ForwardedPort | undefined>;
+
+const requestActiveEndpoint = urlBuilderFor("/pods/port-forward/:namespace/:kind/:name");
+
+const requestActivePortForwardInjectable = getInjectable({
+  id: "request-active-port-forward",
+  instantiate: (di): RequestActivePortForward => {
+    const apiBase = di.inject(apiBaseInjectionToken);
+    const logger = di.inject(loggerInjectable);
+
+    return async ({ port, forwardPort, namespace, kind, name, ...rest }) => {
+      try {
+        const response: { port: number } = await apiBase.get(requestActiveEndpoint.compile({ namespace, kind, name }), { query: { port, forwardPort }});
+
+        return {
+          status: response.port ? "Active" : "Disabled",
+          forwardPort: response.port,
+          port,
+          namespace,
+          kind,
+          name,
+          ...rest,
+        };
+      } catch (error) {
+        logger.warn(`[PORT-FORWARD-STORE] Error getting active port-forward: ${error}`, { namespace, kind, name });
+
+        return undefined;
+      }
+    };
+  },
+});
+
+export default requestActivePortForwardInjectable;