From cc57f88f71e6427498cdbaaea8496119dd9d5279 Mon Sep 17 00:00:00 2001 From: Janne Savolainen Date: Tue, 21 Feb 2023 14:41:52 +0200 Subject: [PATCH] Adapt to new version of ogre-tools Signed-off-by: Janne Savolainen --- .../common/__tests__/cluster-store.test.ts | 20 +++++++++-- .../src/common/__tests__/user-store.test.ts | 6 +++- .../k8s-api/__tests__/api-manager.test.ts | 4 +-- .../kube-api-version-detection.test.ts | 4 +-- .../common/k8s-api/__tests__/kube-api.test.ts | 6 ++-- .../src/common/utils/channel/channel.test.ts | 36 +++++++++++++------ .../with-orphan-promise.injectable.ts | 2 +- .../catalog/opening-entity-details.test.tsx | 20 ++++++----- ...-settings-for-correct-entity.test.tsx.snap | 35 +++++++++++++++++- ...owing-settings-for-correct-entity.test.tsx | 19 +++++----- .../core/src/main/register-injectables.ts | 3 +- .../kube-object-list-layout.test.tsx | 4 +-- .../core/src/renderer/getDiForUnitTesting.tsx | 2 ++ .../core/src/renderer/register-injectables.ts | 8 +++-- packages/open-lens/src/main/index.ts | 3 +- packages/open-lens/src/renderer/index.ts | 3 +- 16 files changed, 127 insertions(+), 48 deletions(-) diff --git a/packages/core/src/common/__tests__/cluster-store.test.ts b/packages/core/src/common/__tests__/cluster-store.test.ts index 9dd1a29a5b..bbb6457e43 100644 --- a/packages/core/src/common/__tests__/cluster-store.test.ts +++ b/packages/core/src/common/__tests__/cluster-store.test.ts @@ -74,8 +74,7 @@ describe("cluster-store", () => { di.override(kubectlBinaryNameInjectable, () => "kubectl"); di.override(kubectlDownloadingNormalizedArchInjectable, () => "amd64"); di.override(normalizedPlatformInjectable, () => "darwin"); - createCluster = di.inject(createClusterInjectionToken); - getCustomKubeConfigFilePath = di.inject(getCustomKubeConfigFilePathInjectable); + writeJsonSync = di.inject(writeJsonSyncInjectable); writeFileSync = di.inject(writeFileSyncInjectable); writeBufferSync = di.inject(writeBufferSyncInjectable); @@ -85,6 +84,9 @@ describe("cluster-store", () => { describe("empty config", () => { beforeEach(async () => { + createCluster = di.inject(createClusterInjectionToken); + getCustomKubeConfigFilePath = di.inject(getCustomKubeConfigFilePathInjectable); + writeJsonSync("/some-directory-for-user-data/lens-cluster-store.json", {}); clusterStore = di.inject(clusterStoreInjectable); clusterStore.load(); @@ -198,6 +200,10 @@ describe("cluster-store", () => { }, ], }); + + createCluster = di.inject(createClusterInjectionToken); + getCustomKubeConfigFilePath = di.inject(getCustomKubeConfigFilePathInjectable); + clusterStore = di.inject(clusterStoreInjectable); clusterStore.load(); }); @@ -249,6 +255,10 @@ describe("cluster-store", () => { }, ], }); + + createCluster = di.inject(createClusterInjectionToken); + getCustomKubeConfigFilePath = di.inject(getCustomKubeConfigFilePathInjectable); + clusterStore = di.inject(clusterStoreInjectable); clusterStore.load(); }); @@ -262,6 +272,11 @@ describe("cluster-store", () => { describe("pre 3.6.0-beta.1 config with an existing cluster", () => { beforeEach(() => { + di.override(storeMigrationVersionInjectable, () => "3.6.0"); + + createCluster = di.inject(createClusterInjectionToken); + getCustomKubeConfigFilePath = di.inject(getCustomKubeConfigFilePathInjectable); + writeJsonSync("/some-directory-for-user-data/lens-cluster-store.json", { __internal__: { migrations: { @@ -281,7 +296,6 @@ describe("cluster-store", () => { }); writeBufferSync("/some-directory-for-user-data/icon_path", testDataIcon); - di.override(storeMigrationVersionInjectable, () => "3.6.0"); clusterStore = di.inject(clusterStoreInjectable); clusterStore.load(); diff --git a/packages/core/src/common/__tests__/user-store.test.ts b/packages/core/src/common/__tests__/user-store.test.ts index 7071fc5c17..486bb31bef 100644 --- a/packages/core/src/common/__tests__/user-store.test.ts +++ b/packages/core/src/common/__tests__/user-store.test.ts @@ -30,9 +30,9 @@ describe("user store tests", () => { get: () => "latest" as const, init: async () => {}, })); + await di.inject(defaultUpdateChannelInjectable).init(); - userStore = di.inject(userStoreInjectable); }); describe("for an empty config", () => { @@ -42,6 +42,8 @@ describe("user store tests", () => { writeJsonSync("/some-directory-for-user-data/lens-user-store.json", {}); writeJsonSync("/some-directory-for-user-data/kube_config", {}); + userStore = di.inject(userStoreInjectable); + userStore.load(); }); @@ -90,6 +92,8 @@ describe("user store tests", () => { di.override(storeMigrationVersionInjectable, () => "10.0.0"); + userStore = di.inject(userStoreInjectable); + userStore.load(); }); diff --git a/packages/core/src/common/k8s-api/__tests__/api-manager.test.ts b/packages/core/src/common/k8s-api/__tests__/api-manager.test.ts index 2e7e545f76..bec3cff646 100644 --- a/packages/core/src/common/k8s-api/__tests__/api-manager.test.ts +++ b/packages/core/src/common/k8s-api/__tests__/api-manager.test.ts @@ -4,7 +4,6 @@ */ import type { DiContainer } from "@ogre-tools/injectable"; -import createClusterInjectable from "../../../main/create-cluster/create-cluster.injectable"; import clusterFrameContextForNamespacedResourcesInjectable from "../../../renderer/cluster-frame-context/for-namespaced-resources.injectable"; import hostedClusterInjectable from "../../../renderer/cluster-frame-context/hosted-cluster.injectable"; import { getDiForUnitTesting } from "../../../renderer/getDiForUnitTesting"; @@ -18,6 +17,7 @@ import { KubeApi } from "../kube-api"; import { KubeObject } from "../kube-object"; import { KubeObjectStore } from "../kube-object.store"; import maybeKubeApiInjectable from "../maybe-kube-api.injectable"; +import { createClusterInjectionToken } from "../../cluster/create-cluster-injection-token"; // eslint-disable-next-line no-restricted-imports import { KubeApi as ExternalKubeApi } from "../../../extensions/common-api/k8s-api"; @@ -43,7 +43,7 @@ describe("ApiManager", () => { di.override(directoryForKubeConfigsInjectable, () => "/some-kube-configs"); di.override(storesAndApisCanBeCreatedInjectable, () => true); - const createCluster = di.inject(createClusterInjectable); + const createCluster = di.inject(createClusterInjectionToken); di.override(hostedClusterInjectable, () => createCluster({ contextName: "some-context-name", diff --git a/packages/core/src/common/k8s-api/__tests__/kube-api-version-detection.test.ts b/packages/core/src/common/k8s-api/__tests__/kube-api-version-detection.test.ts index dd65f58762..16c2ae0e04 100644 --- a/packages/core/src/common/k8s-api/__tests__/kube-api-version-detection.test.ts +++ b/packages/core/src/common/k8s-api/__tests__/kube-api-version-detection.test.ts @@ -15,7 +15,6 @@ import setupAutoRegistrationInjectable from "../../../renderer/before-frame-star import { createMockResponseFromString } from "../../../test-utils/mock-responses"; import storesAndApisCanBeCreatedInjectable from "../../../renderer/stores-apis-can-be-created.injectable"; import directoryForUserDataInjectable from "../../app-paths/directory-for-user-data/directory-for-user-data.injectable"; -import createClusterInjectable from "../../../main/create-cluster/create-cluster.injectable"; import hostedClusterInjectable from "../../../renderer/cluster-frame-context/hosted-cluster.injectable"; import directoryForKubeConfigsInjectable from "../../app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable"; import apiManagerInjectable from "../api-manager/manager.injectable"; @@ -23,6 +22,7 @@ import type { DiContainer } from "@ogre-tools/injectable"; import ingressApiInjectable from "../endpoints/ingress.api.injectable"; import loggerInjectable from "../../logger.injectable"; import maybeKubeApiInjectable from "../maybe-kube-api.injectable"; +import { createClusterInjectionToken } from "../../cluster/create-cluster-injection-token"; describe("KubeApi", () => { let fetchMock: AsyncFnMock; @@ -39,7 +39,7 @@ describe("KubeApi", () => { di.override(directoryForKubeConfigsInjectable, () => "/some-kube-configs"); di.override(storesAndApisCanBeCreatedInjectable, () => true); - const createCluster = di.inject(createClusterInjectable); + const createCluster = di.inject(createClusterInjectionToken); di.override(hostedClusterInjectable, () => createCluster({ contextName: "some-context-name", diff --git a/packages/core/src/common/k8s-api/__tests__/kube-api.test.ts b/packages/core/src/common/k8s-api/__tests__/kube-api.test.ts index 7bce8a3b7c..c5b0364da9 100644 --- a/packages/core/src/common/k8s-api/__tests__/kube-api.test.ts +++ b/packages/core/src/common/k8s-api/__tests__/kube-api.test.ts @@ -24,7 +24,6 @@ import setupAutoRegistrationInjectable from "../../../renderer/before-frame-star import { createMockResponseFromStream, createMockResponseFromString } from "../../../test-utils/mock-responses"; import storesAndApisCanBeCreatedInjectable from "../../../renderer/stores-apis-can-be-created.injectable"; import directoryForUserDataInjectable from "../../app-paths/directory-for-user-data/directory-for-user-data.injectable"; -import createClusterInjectable from "../../../main/create-cluster/create-cluster.injectable"; import hostedClusterInjectable from "../../../renderer/cluster-frame-context/hosted-cluster.injectable"; import directoryForKubeConfigsInjectable from "../../app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable"; import apiKubeInjectable from "../../../renderer/k8s/api-kube.injectable"; @@ -36,6 +35,7 @@ import namespaceApiInjectable from "../endpoints/namespace.api.injectable"; // NOTE: this is fine because we are testing something that only exported // eslint-disable-next-line no-restricted-imports import { PodsApi } from "../../../extensions/common-api/k8s-api"; +import { createClusterInjectionToken } from "../../cluster/create-cluster-injection-token"; describe("createKubeApiForRemoteCluster", () => { let createKubeApiForRemoteCluster: CreateKubeApiForRemoteCluster; @@ -48,7 +48,7 @@ describe("createKubeApiForRemoteCluster", () => { di.override(directoryForKubeConfigsInjectable, () => "/some-kube-configs"); di.override(storesAndApisCanBeCreatedInjectable, () => true); - const createCluster = di.inject(createClusterInjectable); + const createCluster = di.inject(createClusterInjectionToken); di.override(hostedClusterInjectable, () => createCluster({ contextName: "some-context-name", @@ -154,7 +154,7 @@ describe("KubeApi", () => { fetchMock = asyncFn(); di.override(fetchInjectable, () => fetchMock); - const createCluster = di.inject(createClusterInjectable); + const createCluster = di.inject(createClusterInjectionToken); const createKubeJsonApi = di.inject(createKubeJsonApiInjectable); di.override(hostedClusterInjectable, () => createCluster({ diff --git a/packages/core/src/common/utils/channel/channel.test.ts b/packages/core/src/common/utils/channel/channel.test.ts index 9a361b6770..72204d4fb6 100644 --- a/packages/core/src/common/utils/channel/channel.test.ts +++ b/packages/core/src/common/utils/channel/channel.test.ts @@ -19,7 +19,10 @@ import asyncFn from "@async-fn/jest"; import { getPromiseStatus } from "../../test-utils/get-promise-status"; import { runInAction } from "mobx"; import type { RequestChannelHandler } from "../../../main/utils/channel/channel-listeners/listener-tokens"; -import { getRequestChannelListenerInjectable } from "../../../main/utils/channel/channel-listeners/listener-tokens"; +import { + getRequestChannelListenerInjectable, + requestChannelListenerInjectionToken, +} from "../../../main/utils/channel/channel-listeners/listener-tokens"; type TestMessageChannel = MessageChannel; type TestRequestChannel = RequestChannel; @@ -199,21 +202,32 @@ describe("channel", () => { it("when registering multiple handlers for the same channel, throws", async () => { const applicationBuilder = getApplicationBuilder(); - const testChannelListenerInMainInjectable = getRequestChannelListenerInjectable({ - channel: testRequestChannel, - handler: () => () => "some-value", - }); - const testChannelListenerInMain2Injectable = getRequestChannelListenerInjectable({ - channel: testRequestChannel, - handler: () => () => "some-other-value", + const someChannelListenerInjectable = getInjectable({ + id: "some-channel-listener", + + instantiate: () => ({ + channel: testRequestChannel, + handler: () => () => "irrelevant", + }), + + injectionToken: requestChannelListenerInjectionToken, }); - testChannelListenerInMain2Injectable.id += "2"; + const someOtherChannelListenerInjectable = getInjectable({ + id: "some-other-channel-listener", + + instantiate: () => ({ + channel: testRequestChannel, + handler: () => () => "irrelevant", + }), + + injectionToken: requestChannelListenerInjectionToken, + }); applicationBuilder.beforeApplicationStart((mainDi) => { runInAction(() => { - mainDi.register(testChannelListenerInMainInjectable); - mainDi.register(testChannelListenerInMain2Injectable); + mainDi.register(someChannelListenerInjectable); + mainDi.register(someOtherChannelListenerInjectable); }); }); diff --git a/packages/core/src/common/utils/with-orphan-promise/with-orphan-promise.injectable.ts b/packages/core/src/common/utils/with-orphan-promise/with-orphan-promise.injectable.ts index 42e6cb9a61..2a005001da 100644 --- a/packages/core/src/common/utils/with-orphan-promise/with-orphan-promise.injectable.ts +++ b/packages/core/src/common/utils/with-orphan-promise/with-orphan-promise.injectable.ts @@ -19,7 +19,7 @@ const withOrphanPromiseInjectable = getInjectable({ toBeDecorated, withErrorLoggingFor(() => "Orphan promise rejection encountered"), withErrorSuppression, - ); + ) as ((...args: any[]) => any); decorated(...args); }; diff --git a/packages/core/src/features/catalog/opening-entity-details.test.tsx b/packages/core/src/features/catalog/opening-entity-details.test.tsx index 8ae49ff548..cb36218dbb 100644 --- a/packages/core/src/features/catalog/opening-entity-details.test.tsx +++ b/packages/core/src/features/catalog/opening-entity-details.test.tsx @@ -25,6 +25,17 @@ describe("opening catalog entity details panel", () => { beforeEach(async () => { builder = getApplicationBuilder(); + builder.beforeWindowStart((windowDi) => { + // TODO: remove once ClusterStore can be used without overriding it + windowDi.override(getClusterByIdInjectable, () => (clusterId) => { + if (clusterId === cluster.id) { + return cluster; + } + + return undefined; + }); + }); + builder.afterWindowStart((windowDi) => { const createCluster = windowDi.inject(createClusterInjectable); @@ -78,15 +89,6 @@ describe("opening catalog entity details panel", () => { clusterServerUrl: "https://localhost:9999", }); - // TODO: remove once ClusterStore can be used without overriding it - windowDi.override(getClusterByIdInjectable, () => (clusterId) => { - if (clusterId === cluster.id) { - return cluster; - } - - return undefined; - }); - // TODO: replace with proper entity source once syncing entities between main and windows is injectable const catalogEntityRegistry = windowDi.inject(catalogEntityRegistryInjectable); diff --git a/packages/core/src/features/entity-settings/__snapshots__/showing-settings-for-correct-entity.test.tsx.snap b/packages/core/src/features/entity-settings/__snapshots__/showing-settings-for-correct-entity.test.tsx.snap index d176bb9f7d..bb30b0dc71 100644 --- a/packages/core/src/features/entity-settings/__snapshots__/showing-settings-for-correct-entity.test.tsx.snap +++ b/packages/core/src/features/entity-settings/__snapshots__/showing-settings-for-correct-entity.test.tsx.snap @@ -830,7 +830,40 @@ exports[`Showing correct entity settings when navigating to non-local cluster en > Proxy -
+
+
+
+ HTTP Proxy + +
+
+ +
+
+ + HTTP Proxy server. Used for communicating with Kubernetes API. + +
+
{ beforeEach(async () => { builder = getApplicationBuilder(); + builder.beforeWindowStart((windowDi) => { + // TODO: remove once ClusterStore can be used without overriding it + windowDi.override(getClusterByIdInjectable, () => (clusterId) => { + if (clusterId === cluster.id) { + return cluster; + } + + return undefined; + }); + }); + builder.afterWindowStart((windowDi) => { const createCluster = windowDi.inject(createClusterInjectable); @@ -78,14 +89,6 @@ describe("Showing correct entity settings", () => { clusterServerUrl: "https://localhost:9999", }); - // TODO: remove once ClusterStore can be used without overriding it - windowDi.override(getClusterByIdInjectable, () => (clusterId) => { - if (clusterId === cluster.id) { - return cluster; - } - - return undefined; - }); // TODO: replace with proper entity source once syncing entities between main and windows is injectable const catalogEntityRegistry = windowDi.inject(catalogEntityRegistryInjectable); diff --git a/packages/core/src/main/register-injectables.ts b/packages/core/src/main/register-injectables.ts index 6d0117c512..5ddcb640c1 100644 --- a/packages/core/src/main/register-injectables.ts +++ b/packages/core/src/main/register-injectables.ts @@ -16,7 +16,8 @@ export function registerInjectables(di: DiContainer) { autoRegister({ di, - requireContexts: [ + targetModule: module, + getRequireContexts: () => [ require.context("./", true, CONTEXT_MATCHER_FOR_NON_FEATURES), require.context("../extensions", true, CONTEXT_MATCHER_FOR_NON_FEATURES), require.context("../common", true, CONTEXT_MATCHER_FOR_NON_FEATURES), diff --git a/packages/core/src/renderer/components/kube-object-list-layout/kube-object-list-layout.test.tsx b/packages/core/src/renderer/components/kube-object-list-layout/kube-object-list-layout.test.tsx index d50d70c723..356b3ee34d 100644 --- a/packages/core/src/renderer/components/kube-object-list-layout/kube-object-list-layout.test.tsx +++ b/packages/core/src/renderer/components/kube-object-list-layout/kube-object-list-layout.test.tsx @@ -19,8 +19,8 @@ import storesAndApisCanBeCreatedInjectable from "../../stores-apis-can-be-create import directoryForUserDataInjectable from "../../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; import directoryForKubeConfigsInjectable from "../../../common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable"; import hostedClusterInjectable from "../../cluster-frame-context/hosted-cluster.injectable"; -import createClusterInjectable from "../../../main/create-cluster/create-cluster.injectable"; import type { PodStore } from "../+workloads-pods/store"; +import { createClusterInjectionToken } from "../../../common/cluster/create-cluster-injection-token"; describe("kube-object-list-layout", () => { let di: DiContainer; @@ -34,7 +34,7 @@ describe("kube-object-list-layout", () => { di.override(directoryForKubeConfigsInjectable, () => "/some-kube-configs"); di.override(storesAndApisCanBeCreatedInjectable, () => true); - const createCluster = di.inject(createClusterInjectable); + const createCluster = di.inject(createClusterInjectionToken); di.override(hostedClusterInjectable, () => createCluster({ contextName: "some-context-name", diff --git a/packages/core/src/renderer/getDiForUnitTesting.tsx b/packages/core/src/renderer/getDiForUnitTesting.tsx index 07cc70ef80..15ddef9804 100644 --- a/packages/core/src/renderer/getDiForUnitTesting.tsx +++ b/packages/core/src/renderer/getDiForUnitTesting.tsx @@ -20,6 +20,7 @@ import legacyOnChannelListenInjectable from "./ipc/legacy-channel-listen.injecta import type { GlobalOverride } from "../common/test-utils/get-global-override"; import nodeEnvInjectionToken from "../common/vars/node-env-injection-token"; import { applicationInformationFakeInjectable } from "../common/vars/application-information-fake-injectable"; +import { registerInjectableReact } from "@ogre-tools/injectable-react"; export const getDiForUnitTesting = ( opts: { doGeneralOverrides?: boolean } = {}, @@ -46,6 +47,7 @@ export const getDiForUnitTesting = ( ) as Injectable[]; registerMobX(di); + registerInjectableReact(di); runInAction(() => { di.register(applicationInformationFakeInjectable); diff --git a/packages/core/src/renderer/register-injectables.ts b/packages/core/src/renderer/register-injectables.ts index d801e04625..41724d9413 100644 --- a/packages/core/src/renderer/register-injectables.ts +++ b/packages/core/src/renderer/register-injectables.ts @@ -6,18 +6,22 @@ import type { DiContainer } from "@ogre-tools/injectable"; import { autoRegister } from "@ogre-tools/injectable-extension-for-auto-registration"; import { registerMobX } from "@ogre-tools/injectable-extension-for-mobx"; +import { registerInjectableReact } from "@ogre-tools/injectable-react"; import { runInAction } from "mobx"; import { Environments, setLegacyGlobalDiForExtensionApi } from "../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api"; export function registerInjectables(di: DiContainer) { setLegacyGlobalDiForExtensionApi(di, Environments.renderer); + registerMobX(di); + registerInjectableReact(di); + runInAction(() => { - registerMobX(di); autoRegister({ di, - requireContexts: [ + targetModule: module, + getRequireContexts: () => [ require.context("./", true, CONTEXT_MATCHER_FOR_NON_FEATURES), require.context("../common", true, CONTEXT_MATCHER_FOR_NON_FEATURES), require.context("../extensions", true, CONTEXT_MATCHER_FOR_NON_FEATURES), diff --git a/packages/open-lens/src/main/index.ts b/packages/open-lens/src/main/index.ts index d806e9fe49..aca3da2bb4 100644 --- a/packages/open-lens/src/main/index.ts +++ b/packages/open-lens/src/main/index.ts @@ -13,7 +13,8 @@ runInAction(() => { try { autoRegister({ di, - requireContexts: [ + targetModule: module, + getRequireContexts: () => [ require.context("./", true, CONTEXT_MATCHER_FOR_NON_FEATURES), require.context("../common", true, CONTEXT_MATCHER_FOR_NON_FEATURES), ], diff --git a/packages/open-lens/src/renderer/index.ts b/packages/open-lens/src/renderer/index.ts index c1ebf0f588..2774644e94 100644 --- a/packages/open-lens/src/renderer/index.ts +++ b/packages/open-lens/src/renderer/index.ts @@ -13,7 +13,8 @@ const app = createApp({ runInAction(() => { autoRegister({ di, - requireContexts: [ + targetModule: module, + getRequireContexts: () => [ require.context("./", true, CONTEXT_MATCHER_FOR_NON_FEATURES), require.context("../common", true, CONTEXT_MATCHER_FOR_NON_FEATURES), ],