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
@@ -5,22 +5,22 @@
 import { getRouteInjectable } from "../../../router/router.injectable";
 import { apiPrefix } from "../../../../common/vars";
 import { route } from "../../../router/route";
-import getHelmChartInjectable from "../../../helm/helm-service/get-helm-chart.injectable";
+import getHelmChartReadmeInjectable from "../../../helm/helm-service/get-helm-chart-readme.injectable";

-const getChartRouteInjectable = getRouteInjectable({
-  id: "get-chart-route",
+const getHelmChartReadmeRouteInjectable = getRouteInjectable({
+  id: "get-helm-chart-readme-route",

  instantiate: (di) => {
-    const getHelmChart = di.inject(getHelmChartInjectable);
+    const getHelmChartReadme = di.inject(getHelmChartReadmeInjectable);

    return route({
      method: "get",
-      path: `${apiPrefix}/v2/charts/{repo}/{chart}`,
+      path: `${apiPrefix}/v2/charts/{repo}/{chart}/readme`,
    })(async ({ params, query }) => {
      const { repo, chart } = params;

      return {
-        response: await getHelmChart(
+        response: await getHelmChartReadme(
          repo,
          chart,
          query.get("version") ?? undefined,
@@ -30,4 +30,4 @@ const getChartRouteInjectable = getRouteInjectable({
  },
 });

-export default getChartRouteInjectable;
+export default getHelmChartReadmeRouteInjectable;
@@ -7,8 +7,8 @@ import { apiPrefix } from "../../../../common/vars";
 import { route } from "../../../router/route";
 import getHelmChartValuesInjectable from "../../../helm/helm-service/get-helm-chart-values.injectable";

-const getChartRouteValuesInjectable = getRouteInjectable({
-  id: "get-chart-route-values",
+const getHelmChartRouteValuesInjectable = getRouteInjectable({
+  id: "get-helm-chart-values-route",

  instantiate: (di) => {
    const getHelmChartValues = di.inject(getHelmChartValuesInjectable);
@@ -26,4 +26,4 @@ const getChartRouteValuesInjectable = getRouteInjectable({
  },
 });

-export default getChartRouteValuesInjectable;
+export default getHelmChartRouteValuesInjectable;
@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getRouteInjectable } from "../../../router/router.injectable";
+import { apiPrefix } from "../../../../common/vars";
+import { route } from "../../../router/route";
+import getHelmChartVersionsInjectable from "../../../helm/helm-service/get-helm-chart-versions.injectable";
+
+const getHelmChartVersionsRouteInjectable = getRouteInjectable({
+  id: "get-helm-chart-versions-route",
+
+  instantiate: (di) => {
+    const getHelmChartVersions = di.inject(getHelmChartVersionsInjectable);
+
+    return route({
+      method: "get",
+      path: `${apiPrefix}/v2/charts/{repo}/{chart}/versions`,
+    })(async ({ params: { repo, chart }}) => ({
+      response: await getHelmChartVersions(repo, chart),
+    }));
+  },
+});
+
+export default getHelmChartVersionsRouteInjectable;
@@ -7,8 +7,8 @@ import { apiPrefix } from "../../../../common/vars";
 import { route } from "../../../router/route";
 import listHelmChartsInjectable from "../../../helm/helm-service/list-helm-charts.injectable";

-const listChartsRouteInjectable = getRouteInjectable({
-  id: "list-charts-route",
+const listHelmChartsRouteInjectable = getRouteInjectable({
+  id: "list-helm-charts-route",

  instantiate: (di) => {
    const listHelmCharts = di.inject(listHelmChartsInjectable);
@@ -22,4 +22,4 @@ const listChartsRouteInjectable = getRouteInjectable({
  },
 });

-export default listChartsRouteInjectable;
+export default listHelmChartsRouteInjectable;
@@ -9,6 +9,7 @@ import type { Cluster } from "../../../common/cluster/cluster";
 import type { V1Secret } from "@kubernetes/client-node";
 import { CoreV1Api } from "@kubernetes/client-node";
 import { clusterRoute } from "../../router/route";
+import { dump } from "js-yaml";

 const getServiceAccountRouteInjectable = getRouteInjectable({
  id: "get-service-account-route",
@@ -50,43 +51,15 @@ const getServiceAccountRouteInjectable = getRouteInjectable({

 export default getServiceAccountRouteInjectable;

-interface ServiceAccountKubeConfig {
-  apiVersion: string;
-  kind: string;
-  clusters: {
-    name: string;
-    cluster: {
-      server: string;
-      "certificate-authority-data": string;
-    };
-  }[];
-  users: {
-    name: string;
-    user: {
-      token: string;
-    };
-  }[];
-  contexts: {
-    name: string;
-    context: {
-      user: string;
-      cluster: string;
-      namespace: string | undefined;
-    };
-  }[];
-  "current-context": string;
-}
-
-function generateKubeConfig(username: string, secret: V1Secret, cluster: Cluster): ServiceAccountKubeConfig | undefined {
+function generateKubeConfig(username: string, secret: V1Secret, cluster: Cluster): string | undefined {
  if (!secret.data || !secret.metadata) {
    return undefined;
  }

  const { token, "ca.crt": caCrt } = secret.data;
-
  const tokenData = Buffer.from(token, "base64");

-  return {
+  return dump({
    "apiVersion": "v1",
    "kind": "Config",
    "clusters": [
@@ -117,5 +90,5 @@ function generateKubeConfig(username: string, secret: V1Secret, cluster: Cluster
      },
    ],
    "current-context": cluster.contextName,
-  };
+  });
 }
@@ -18,7 +18,7 @@ import getMetricsInjectable from "../../get-metrics.injectable";
 // This is used for backoff retry tracking.
 const ATTEMPTS = [false, false, false, false, true];

-const loadMetricsFor = (getMetrics: GetMetrics) => async (promQueries: string[], cluster: Cluster, prometheusPath: string, queryParams: Record<string, string>): Promise<any[]> => {
+const loadMetricsFor = (getMetrics: GetMetrics) => async (promQueries: string[], cluster: Cluster, prometheusPath: string, queryParams: Partial<Record<string, string>>): Promise<any[]> => {
  const queries = promQueries.map(p => p.trim());
  const loaders = new Map<string, Promise<any>>();

@@ -59,7 +59,7 @@ const addMetricsRouteInjectable = getRouteInjectable({
    const getMetrics = di.inject(getMetricsInjectable);
    const loadMetrics = loadMetricsFor(getMetrics);

-    const queryParams = Object.fromEntries(query.entries());
+    const queryParams: Partial<Record<string, string>> = Object.fromEntries(query.entries());
    const prometheusMetadata: ClusterPrometheusMetadata = {};

    try {
@@ -5,17 +5,19 @@
 import { getRouteInjectable } from "../../router/router.injectable";
 import { apiPrefix } from "../../../common/vars";
 import { ResourceApplier } from "../../resource-applier";
-import { clusterRoute } from "../../router/route";
+import { payloadValidatedClusterRoute } from "../../router/route";
+import Joi from "joi";

-const applyResourceRouteInjectable = getRouteInjectable({
-  id: "apply-resource-route",
+const createResourceRouteInjectable = getRouteInjectable({
+  id: "create-resource-route",

-  instantiate: () => clusterRoute({
+  instantiate: () => payloadValidatedClusterRoute({
    method: "post",
    path: `${apiPrefix}/stack`,
+    payloadValidator: Joi.string(),
  })(async ({ cluster, payload }) => ({
-    response: await new ResourceApplier(cluster).apply(payload),
+    response: await new ResourceApplier(cluster).create(payload),
  })),
 });

-export default applyResourceRouteInjectable;
+export default createResourceRouteInjectable;
@@ -11,8 +11,6 @@ import path from "path";
 import isDevelopmentInjectable from "../../common/vars/is-development.injectable";
 import httpProxy from "http-proxy";
 import readFileBufferInjectable from "../../common/fs/read-file-buffer.injectable";
-import type { GetAbsolutePath } from "../../common/path/get-absolute-path.injectable";
-import getAbsolutePathInjectable from "../../common/path/get-absolute-path.injectable";
 import type { JoinPaths } from "../../common/path/join-paths.injectable";
 import joinPathsInjectable from "../../common/path/join-paths.injectable";
 import { webpackDevServerPort } from "../../../webpack/vars";
@@ -20,11 +18,13 @@ import type { LensApiRequest, RouteResponse } from "../router/route";
 import { route } from "../router/route";
 import staticFilesDirectoryInjectable from "../../common/vars/static-files-directory.injectable";
 import appNameInjectable from "../../common/vars/app-name.injectable";
+import type { GetAbsolutePath } from "../../common/path/get-absolute-path.injectable";
+import getAbsolutePathInjectable from "../../common/path/get-absolute-path.injectable";

 interface ProductionDependencies {
  readFileBuffer: (path: string) => Promise<Buffer>;
-  getAbsolutePath: GetAbsolutePath;
  joinPaths: JoinPaths;
+  getAbsolutePath: GetAbsolutePath;
  staticFilesDirectory: string;
  appName: string;
 }
@@ -98,8 +98,8 @@ const staticFileRouteInjectable = getRouteInjectable({
  instantiate: (di) => {
    const isDevelopment = di.inject(isDevelopmentInjectable);
    const readFileBuffer = di.inject(readFileBufferInjectable);
-    const getAbsolutePath = di.inject(getAbsolutePathInjectable);
    const joinPaths = di.inject(joinPathsInjectable);
+    const getAbsolutePath = di.inject(getAbsolutePathInjectable);
    const staticFilesDirectory = di.inject(staticFilesDirectoryInjectable);
    const appName = di.inject(appNameInjectable);

@@ -114,10 +114,10 @@ const staticFileRouteInjectable = getRouteInjectable({
        })
        : handleStaticFileInProduction({
          readFileBuffer,
-          getAbsolutePath,
          joinPaths,
          staticFilesDirectory,
          appName,
+          getAbsolutePath,
        }),
    );
  },