1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Remove uses of legacy global logger from injectables (#6660)

- Clean up some of them to use more injectables

Signed-off-by: Sebastian Malton <sebastian@malton.name>

Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
Sebastian Malton 2022-11-29 05:56:09 -08:00 committed by GitHub
parent 9589175604
commit 005ed1c34e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 153 additions and 151 deletions

View File

@ -7,13 +7,13 @@ import { apiPrefix } from "../../../common/vars";
import { getRouteInjectable } from "../../router/router.injectable"; import { getRouteInjectable } from "../../router/router.injectable";
import type { ClusterPrometheusMetadata } from "../../../common/cluster-types"; import type { ClusterPrometheusMetadata } from "../../../common/cluster-types";
import { ClusterMetadataKey } from "../../../common/cluster-types"; import { ClusterMetadataKey } from "../../../common/cluster-types";
import logger from "../../logger";
import type { Cluster } from "../../../common/cluster/cluster"; import type { Cluster } from "../../../common/cluster/cluster";
import { clusterRoute } from "../../router/route"; import { clusterRoute } from "../../router/route";
import { isObject } from "lodash"; import { isObject } from "lodash";
import { isRequestError } from "../../../common/utils"; import { isRequestError, object } from "../../../common/utils";
import type { GetMetrics } from "../../get-metrics.injectable"; import type { GetMetrics } from "../../get-metrics.injectable";
import getMetricsInjectable from "../../get-metrics.injectable"; import getMetricsInjectable from "../../get-metrics.injectable";
import loggerInjectable from "../../../common/logger.injectable";
// This is used for backoff retry tracking. // This is used for backoff retry tracking.
const ATTEMPTS = [false, false, false, false, true]; const ATTEMPTS = [false, false, false, false, true];
@ -55,13 +55,15 @@ const loadMetricsFor = (getMetrics: GetMetrics) => async (promQueries: string[],
const addMetricsRouteInjectable = getRouteInjectable({ const addMetricsRouteInjectable = getRouteInjectable({
id: "add-metrics-route", id: "add-metrics-route",
instantiate: (di) => clusterRoute({ instantiate: (di) => {
const getMetrics = di.inject(getMetricsInjectable);
const loadMetrics = loadMetricsFor(getMetrics);
const logger = di.inject(loggerInjectable);
return clusterRoute({
method: "post", method: "post",
path: `${apiPrefix}/metrics`, path: `${apiPrefix}/metrics`,
})(async ({ cluster, payload, query }) => { })(async ({ cluster, payload, query }) => {
const getMetrics = di.inject(getMetricsInjectable);
const loadMetrics = loadMetricsFor(getMetrics);
const queryParams: Partial<Record<string, string>> = Object.fromEntries(query.entries()); const queryParams: Partial<Record<string, string>> = Object.fromEntries(query.entries());
const prometheusMetadata: ClusterPrometheusMetadata = {}; const prometheusMetadata: ClusterPrometheusMetadata = {};
@ -91,17 +93,18 @@ const addMetricsRouteInjectable = getRouteInjectable({
} }
if (isObject(payload)) { if (isObject(payload)) {
const queries = Object.entries(payload as Record<string, Record<string, string>>) const data = payload as Record<string, Record<string, string>>;
const queries = object.entries(data)
.map(([queryName, queryOpts]) => ( .map(([queryName, queryOpts]) => (
provider.getQuery(queryOpts, queryName) provider.getQuery(queryOpts, queryName)
)); ));
const result = await loadMetrics(queries, cluster, prometheusPath, queryParams); const result = await loadMetrics(queries, cluster, prometheusPath, queryParams);
const data = Object.fromEntries(Object.keys(payload).map((metricName, i) => [metricName, result[i]])); const response = object.fromEntries(object.keys(data).map((metricName, i) => [metricName, result[i]]));
prometheusMetadata.success = true; prometheusMetadata.success = true;
return { response: data }; return { response };
} }
return { response: {}}; return { response: {}};
@ -114,7 +117,8 @@ const addMetricsRouteInjectable = getRouteInjectable({
} finally { } finally {
cluster.metadata[ClusterMetadataKey.PROMETHEUS] = prometheusMetadata; cluster.metadata[ClusterMetadataKey.PROMETHEUS] = prometheusMetadata;
} }
}), });
},
}); });
export default addMetricsRouteInjectable; export default addMetricsRouteInjectable;

View File

@ -5,15 +5,16 @@
import { getRouteInjectable } from "../../router/router.injectable"; import { getRouteInjectable } from "../../router/router.injectable";
import { apiPrefix } from "../../../common/vars"; import { apiPrefix } from "../../../common/vars";
import { PortForward } from "./functionality/port-forward"; import { PortForward } from "./functionality/port-forward";
import logger from "../../logger";
import createPortForwardInjectable from "./functionality/create-port-forward.injectable"; import createPortForwardInjectable from "./functionality/create-port-forward.injectable";
import { clusterRoute } from "../../router/route"; import { clusterRoute } from "../../router/route";
import loggerInjectable from "../../../common/logger.injectable";
const startPortForwardRouteInjectable = getRouteInjectable({ const startPortForwardRouteInjectable = getRouteInjectable({
id: "start-current-port-forward-route", id: "start-current-port-forward-route",
instantiate: (di) => { instantiate: (di) => {
const createPortForward = di.inject(createPortForwardInjectable); const createPortForward = di.inject(createPortForwardInjectable);
const logger = di.inject(loggerInjectable);
return clusterRoute({ return clusterRoute({
method: "post", method: "post",

View File

@ -5,13 +5,16 @@
import { getRouteInjectable } from "../../router/router.injectable"; import { getRouteInjectable } from "../../router/router.injectable";
import { apiPrefix } from "../../../common/vars"; import { apiPrefix } from "../../../common/vars";
import { PortForward } from "./functionality/port-forward"; import { PortForward } from "./functionality/port-forward";
import logger from "../../logger";
import { clusterRoute } from "../../router/route"; import { clusterRoute } from "../../router/route";
import loggerInjectable from "../../../common/logger.injectable";
const stopCurrentPortForwardRouteInjectable = getRouteInjectable({ const stopCurrentPortForwardRouteInjectable = getRouteInjectable({
id: "stop-current-port-forward-route", id: "stop-current-port-forward-route",
instantiate: () => clusterRoute({ instantiate: (di) => {
const logger = di.inject(loggerInjectable);
return clusterRoute({
method: "delete", method: "delete",
path: `${apiPrefix}/pods/port-forward/{namespace}/{resourceType}/{resourceName}`, path: `${apiPrefix}/pods/port-forward/{namespace}/{resourceType}/{resourceName}`,
})(async ({ params, query, cluster }) => { })(async ({ params, query, cluster }) => {
@ -35,9 +38,9 @@ const stopCurrentPortForwardRouteInjectable = getRouteInjectable({
message: `error stopping a forward port ${port}`, message: `error stopping a forward port ${port}`,
}, },
}; };
} }
}), });
},
}); });
export default stopCurrentPortForwardRouteInjectable; export default stopCurrentPortForwardRouteInjectable;

View File

@ -5,16 +5,15 @@
import { getInjectable } from "@ogre-tools/injectable"; import { getInjectable } from "@ogre-tools/injectable";
import extensionDiscoveryInjectable from "../../../../extensions/extension-discovery/extension-discovery.injectable"; import extensionDiscoveryInjectable from "../../../../extensions/extension-discovery/extension-discovery.injectable";
import { validatePackage } from "./validate-package"; import { validatePackage } from "./validate-package";
import type { ExtensionDiscovery } from "../../../../extensions/extension-discovery/extension-discovery";
import { getMessageFromError } from "../get-message-from-error/get-message-from-error"; import { getMessageFromError } from "../get-message-from-error/get-message-from-error";
import logger from "../../../../main/logger";
import { Notifications } from "../../notifications";
import path from "path";
import fse from "fs-extra";
import React from "react"; import React from "react";
import os from "os";
import type { LensExtensionId, LensExtensionManifest } from "../../../../extensions/lens-extension"; import type { LensExtensionId, LensExtensionManifest } from "../../../../extensions/lens-extension";
import type { InstallRequest } from "./attempt-install.injectable"; import type { InstallRequest } from "./attempt-install.injectable";
import loggerInjectable from "../../../../common/logger.injectable";
import writeFileInjectable from "../../../../common/fs/write-file.injectable";
import joinPathsInjectable from "../../../../common/path/join-paths.injectable";
import tempDirectoryPathInjectable from "../../../../common/os/temp-directory-path.injectable";
import showErrorNotificationInjectable from "../../notifications/show-error-notification.injectable";
export interface InstallRequestValidated { export interface InstallRequestValidated {
fileName: string; fileName: string;
@ -24,26 +23,32 @@ export interface InstallRequestValidated {
tempFile: string; // temp system path to packed extension for unpacking tempFile: string; // temp system path to packed extension for unpacking
} }
interface Dependencies {
extensionDiscovery: ExtensionDiscovery;
}
export type CreateTempFilesAndValidate = (request: InstallRequest) => Promise<InstallRequestValidated | null>; export type CreateTempFilesAndValidate = (request: InstallRequest) => Promise<InstallRequestValidated | null>;
const createTempFilesAndValidate = ({ const createTempFilesAndValidateInjectable = getInjectable({
extensionDiscovery, id: "create-temp-files-and-validate",
}: Dependencies): CreateTempFilesAndValidate => ( instantiate: (di): CreateTempFilesAndValidate => {
async ({ fileName, data }) => { const extensionDiscovery = di.inject(extensionDiscoveryInjectable);
// copy files to temp const logger = di.inject(loggerInjectable);
await fse.ensureDir(getExtensionPackageTemp()); const writeFile = di.inject(writeFileInjectable);
const joinPaths = di.inject(joinPathsInjectable);
const showErrorNotification = di.inject(showErrorNotificationInjectable);
const tempDirectoryPath = di.inject(tempDirectoryPathInjectable);
const getTempExtensionPackagePath = (fileName: string) => joinPaths(
tempDirectoryPath,
"lens-extensions",
fileName,
);
return async ({ fileName, data }) => {
// validate packages // validate packages
const tempFile = getExtensionPackageTemp(fileName); const tempFile = getTempExtensionPackagePath(fileName);
try { try {
await fse.writeFile(tempFile, data); await writeFile(tempFile, data);
const manifest = await validatePackage(tempFile); const manifest = await validatePackage(tempFile);
const id = path.join( const id = joinPaths(
extensionDiscovery.nodeModulesPath, extensionDiscovery.nodeModulesPath,
manifest.name, manifest.name,
"package.json", "package.json",
@ -63,7 +68,7 @@ const createTempFilesAndValidate = ({
`[EXTENSION-INSTALLATION]: installing ${fileName} has failed: ${message}`, `[EXTENSION-INSTALLATION]: installing ${fileName} has failed: ${message}`,
{ error }, { error },
); );
Notifications.error(( showErrorNotification((
<div className="flex column gaps"> <div className="flex column gaps">
<p> <p>
{"Installing "} {"Installing "}
@ -79,19 +84,8 @@ const createTempFilesAndValidate = ({
} }
return null; return null;
} };
); },
function getExtensionPackageTemp(fileName = "") {
return path.join(os.tmpdir(), "lens-extensions", fileName);
}
const createTempFilesAndValidateInjectable = getInjectable({
id: "create-temp-files-and-validate",
instantiate: (di) => createTempFilesAndValidate({
extensionDiscovery: di.inject(extensionDiscoveryInjectable),
}),
}); });
export default createTempFilesAndValidateInjectable; export default createTempFilesAndValidateInjectable;