From 76066c5ebfaabbfd95631c3aed41ed6ea6a1da34 Mon Sep 17 00:00:00 2001 From: Sebastian Malton Date: Wed, 5 Oct 2022 08:10:36 -0400 Subject: [PATCH] Making apiBase injectable (#6022) * Making apiBase injectable Signed-off-by: Sebastian Malton * Convert all of Helm functions to be DI Signed-off-by: Sebastian Malton * Make PortForward's use of apiBase fully injectable Signed-off-by: Sebastian Malton * Convert all metric requests to be injectable Signed-off-by: Sebastian Malton * Replace resource applier with injectables Signed-off-by: Sebastian Malton * Switch KubeJsonApi.forCluster to be injectable but do not use Signed-off-by: Sebastian Malton * Convert the rest of shell sessions to be DI-ed - This is a prerequesit for using the new createKubeJsonApiForClusterInjectable Signed-off-by: Sebastian Malton * Use new createKubeJsonApiForClusterInjectable for openNodeShellSession Signed-off-by: Sebastian Malton * Make KubeconfigDialog injectable Signed-off-by: Sebastian Malton * Remove jest-fetch-mock and make fetch injectable Signed-off-by: Sebastian Malton * Fix tests with new global override Signed-off-by: Sebastian Malton * Add new injectable for create KubeJsonApi and JsonApi instances Signed-off-by: Sebastian Malton * 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 * Fix show details and updating helm releases tests Signed-off-by: Sebastian Malton * Fix residual typing issues related to metrics Signed-off-by: Sebastian Malton * Fix crash on load due to circular dependency Signed-off-by: Sebastian Malton * Fix create resource tab not working Signed-off-by: Sebastian Malton * Remove legacy apiBase global Signed-off-by: Sebastian Malton * Introduce and use isDebuggingInjectable Signed-off-by: Sebastian Malton * Introduce and use windowLocationInjectable Signed-off-by: Sebastian Malton * Remove global legacy apiKube Signed-off-by: Sebastian Malton * Improve injectable filenames compared to the injectables inside Signed-off-by: Sebastian Malton * Remove modifying input in requestActivePortForwardInjectable Signed-off-by: Sebastian Malton * Introduce and use get(Milli)SecondsFromUnixEpochInjectable Signed-off-by: Sebastian Malton * Switch to non-reactive way of gettting possible helm release versions Signed-off-by: Sebastian Malton * Fix typo Signed-off-by: Sebastian Malton * Fix bug in KubeApi constructor Signed-off-by: Sebastian Malton * Convert all KubeApi related tests to use asyncFn Signed-off-by: Sebastian Malton * Fix unit tests after introducing new injectables that have side effects Signed-off-by: Sebastian Malton * Fix bad rebase causing tests to fail Signed-off-by: Sebastian Malton * Improve expects for multiple field values Signed-off-by: Sebastian Malton * Fix crash will looking up api refs Signed-off-by: Sebastian Malton * Fix breaking change on KubeApi.list Signed-off-by: Sebastian Malton * Better fix for formatting urls Signed-off-by: Sebastian Malton * Remove injectable for time since we should just use useMockTime Signed-off-by: Sebastian Malton * Add happy path behavioural tests for upgrade chart tab Signed-off-by: Sebastian Malton * Remove debug message Signed-off-by: Sebastian Malton * Update snapshots Signed-off-by: Sebastian Malton * fix showing-details-for-helm-release tests Signed-off-by: Sebastian Malton * Fix installing-helm-chart-from-new-tab tests Signed-off-by: Sebastian Malton * Fix tests relating to hosted cluster id Signed-off-by: Sebastian Malton * Update snapshots to recent changes in master Co-authored-by: Janne Savolainen Signed-off-by: Iku-turso * Reupdated upgrade chart new tab test snapshots Signed-off-by: Sebastian Malton * Fix flakiness in unit test when using Signed-off-by: Sebastian Malton * Fix flakiness and improve tests for DeleteClusterDialog Signed-off-by: Sebastian Malton * Fix kubeconfig-sync tests Signed-off-by: Sebastian Malton * Fix tests by removing mockFs and making everything injectable Signed-off-by: Sebastian Malton * Fix build issues Signed-off-by: Sebastian Malton * Fix getElectronAppPathInjectable override not returning absolute paths - Also fixes the listing-active-helm-repos-in-prefs tests Signed-off-by: Sebastian Malton * Replace all uses of getAbsolutePath with joinPaths as it is more correct and less confusing Signed-off-by: Sebastian Malton * Fix opening application window tests by making override properly absolute Signed-off-by: Sebastian Malton * Update snapshots relating no longer using getAbsolutePath Signed-off-by: Sebastian Malton * Fix and add behavioural tests for RenderDelay Signed-off-by: Sebastian Malton * Fix extension discovery tests Signed-off-by: Sebastian Malton * Fix test flakiness because of path side effects, propagate uses to as many places Signed-off-by: Sebastian Malton * Fix extension-discovery tests Signed-off-by: Sebastian Malton * Add global override to fix some tests Signed-off-by: Sebastian Malton * Rewrite and fix implementation of KubeconfigManager and its tests Signed-off-by: Sebastian Malton * Fix tests by global override pathExists Signed-off-by: Sebastian Malton * Fix unit tests failing on windows by using injectable verions of path functions Signed-off-by: Sebastian Malton * Attempt to fix test timeout by using runInAction Signed-off-by: Sebastian Malton * Update snapshots after rebase Signed-off-by: Sebastian Malton * Update snapshots after rebase Signed-off-by: Sebastian Malton * Fix tests after rebase Signed-off-by: Sebastian Malton * Fix setupIpcMainHandlers usage Signed-off-by: Sebastian Malton * Update snapshots Signed-off-by: Sebastian Malton Signed-off-by: Sebastian Malton Signed-off-by: Iku-turso Co-authored-by: Iku-turso --- __mocks__/windowMock.ts | 19 - package.json | 3 +- .../directory-for-binaries.injectable.ts | 6 +- .../directory-for-kube-configs.injectable.ts | 9 +- ...rectory-for-kubectl-binaries.injectable.ts | 7 +- ...custom-kube-config-directory.injectable.ts | 7 +- .../catalog/filtered-categories.injectable.ts | 18 + src/common/cluster/cluster.ts | 7 +- ...ctory-for-lens-local-storage.injectable.ts | 6 +- .../fetch.global-override-for-injectable.ts | 11 + src/common/fetch/fetch.injectable.ts | 17 + ...ess-path.global-override-for-injectable.ts | 11 + src/common/fs/access-path.injectable.ts | 27 + .../fs/copy.global-override-for-injectable.ts | 11 + src/common/fs/copy.injectable.ts | 16 + ...ete-file.global-override-for-injectable.ts | 11 + src/common/fs/delete-file.injectable.ts | 15 + ...sure-dir.global-override-for-injectable.ts | 11 + src/common/fs/ensure-dir.injectable.ts | 6 +- ...ract-tar.global-override-for-injectable.ts | 11 + src/common/fs/extract-tar.injectable.ts | 26 + .../lstat.global-override-for-injectable.ts | 11 + src/common/fs/lstat.injectable.ts | 16 + .../fs/move.global-override-for-injectable.ts | 11 + src/common/fs/move.injectable.ts | 16 + ...h-exists.global-override-for-injectable.ts | 11 + ...irectory.global-override-for-injectable.ts | 11 + src/common/fs/read-directory.injectable.ts | 37 + src/common/fs/read-file.injectable.ts | 9 +- ...ove-path.global-override-for-injectable.ts | 11 + ...njectable.ts => remove-path.injectable.ts} | 10 +- ...ite-file.global-override-for-injectable.ts | 11 + src/common/fs/write-file.injectable.ts | 16 +- src/common/fs/write-json-file.injectable.ts | 32 +- src/common/ipc/cluster.ts | 3 - src/common/k8s-api/__tests__/kube-api.test.ts | 1906 ++++-- src/common/k8s-api/api-base.ts | 39 +- src/common/k8s-api/api-kube.ts | 3 - .../k8s-api/create-json-api.injectable.ts | 26 + .../create-kube-api-for-cluster.injectable.ts | 63 + ...-kube-api-for-remote-cluster.injectable.ts | 104 + ...te-kube-json-api-for-cluster.injectable.ts | 36 + .../create-kube-json-api.injectable.ts | 26 + src/common/k8s-api/endpoints/cluster.api.ts | 41 - .../k8s-api/endpoints/daemon-set.api.ts | 19 - .../k8s-api/endpoints/deployment.api.ts | 20 +- .../k8s-api/endpoints/helm-charts.api.ts | 65 +- .../request-charts.injectable.ts | 34 + .../request-readme.injectable.ts | 24 + .../request-values.injectable.ts | 24 + .../request-versions.injectable.ts | 31 + .../k8s-api/endpoints/helm-releases.api.ts | 53 +- ...guration.global-override-for-injectable.ts | 11 + .../request-configuration.injectable.ts | 29 + .../request-create.injectable.ts | 42 + .../request-delete.injectable.ts | 22 + .../request-details.injectable.ts | 41 + .../request-history.injectable.ts | 31 + .../request-releases.injectable.ts | 24 + .../request-rollback.injectable.ts | 27 + .../request-update.injectable.ts | 49 + .../request-values.injectable.ts | 22 + src/common/k8s-api/endpoints/ingress.api.ts | 22 - src/common/k8s-api/endpoints/job.api.ts | 20 +- src/common/k8s-api/endpoints/metrics.api.ts | 91 +- ...luster-metrics-by-node-names.injectable.ts | 63 + .../request-ingress-metrics.injectable.ts | 38 + ...equest-metrics-for-all-nodes.injectable.ts | 44 + .../metrics.api/request-metrics.injectable.ts | 73 + ...sistent-volume-claim-metrics.injectable.ts | 35 + ...-pod-metrics-for-daemon-sets.injectable.ts | 46 + ...-pod-metrics-for-deployments.injectable.ts | 46 + ...request-pod-metrics-for-jobs.injectable.ts | 46 + ...pod-metrics-for-replica-sets.injectable.ts | 46 + ...od-metrics-for-stateful-sets.injectable.ts | 47 + ...est-pod-metrics-in-namespace.injectable.ts | 44 + .../request-pod-metrics.injectable.ts | 54 + .../request-providers.injectable.ts | 26 + src/common/k8s-api/endpoints/namespace.api.ts | 18 - src/common/k8s-api/endpoints/node.api.ts | 28 - .../endpoints/persistent-volume-claim.api.ts | 18 - src/common/k8s-api/endpoints/pod.api.ts | 37 - .../k8s-api/endpoints/replica-set.api.ts | 19 - .../k8s-api/endpoints/resource-applier.api.ts | 38 - .../request-patch.injectable.ts | 30 + .../request-update.injectable.ts | 20 + .../k8s-api/endpoints/stateful-set.api.ts | 19 - src/common/k8s-api/index.ts | 7 - src/common/k8s-api/json-api.ts | 17 +- src/common/k8s-api/kube-api.ts | 249 +- src/common/k8s-api/kube-json-api.ts | 16 - src/common/k8s-api/kube-object.ts | 34 +- ...location.global-override-for-injectable.ts | 12 + .../k8s-api/window-location.injectable.ts | 17 + src/common/kube-helpers.ts | 19 +- .../load-config-from-file.injectable.ts | 23 + ...ory-path.global-override-for-injectable.ts | 9 + .../os/home-directory-path.injectable.ts | 14 + ...ory-path.global-override-for-injectable.ts | 9 + .../os/temp-directory-path.injectable.ts | 14 + ...ute-path.global-override-for-injectable.ts | 10 + ...basename.global-override-for-injectable.ts | 10 + src/common/path/get-basename.injectable.ts | 16 + ...-dirname.global-override-for-injectable.ts | 10 + src/common/path/get-dirname.injectable.ts | 16 + ...ive-path.global-override-for-injectable.ts | 10 + .../path/get-relative-path.injectable.ts | 16 + .../path/is-logical-child-path.injectable.ts | 51 + ...in-paths.global-override-for-injectable.ts | 10 + .../parse.global-override-for-injectable.ts | 10 + src/common/path/parse.injectable.ts | 14 + src/common/path/resolve-path.injectable.ts | 21 + src/common/path/resolve-tilde.injectable.ts | 31 + ...eparator.global-override-for-injectable.ts | 10 + src/common/path/separator.injectable.ts | 14 + .../test-utils/get-absolute-path-fake.ts | 17 - src/common/test-utils/join-paths-fake.ts | 7 - .../file-name-migration.injectable.ts | 7 +- src/common/user-store/user-store.ts | 7 - src/common/utils/__tests__/paths.test.ts | 33 +- src/common/utils/buildUrl.ts | 21 + .../request-from-channel-injection-token.ts | 2 +- .../utils/date/get-current-date-time.ts | 4 + src/common/utils/index.ts | 1 - src/common/utils/paths.ts | 55 - src/common/utils/sort-compare.ts | 79 +- src/common/utils/tar.ts | 12 +- src/common/vars.ts | 3 + .../base-bundled-binaries-dir.injectable.ts | 6 +- .../vars/bundled-resources-dir.injectable.ts | 6 +- ...ebugging.global-override-for-injectable.ts | 9 + src/common/vars/is-debugging.injectable.ts | 13 + .../vars/static-files-directory.injectable.ts | 6 +- src/extensions/common-api/k8s-api.ts | 26 +- .../extension-discovery.injectable.ts | 26 + .../extension-discovery.test.ts | 37 +- .../extension-discovery.ts | 143 +- .../extension-loader.injectable.ts | 6 + .../extension-loader/extension-loader.ts | 28 +- ...directory-for-extension-data.injectable.ts | 6 +- .../order-of-sidebar-items.test.tsx.snap | 10 +- ...-and-tab-navigation-for-core.test.tsx.snap | 35 +- ...ab-navigation-for-extensions.test.tsx.snap | 40 +- .../visibility-of-sidebar-items.test.tsx.snap | 10 +- .../workload-overview.test.tsx.snap | 5 +- .../delete-cluster-dialog.test.tsx.snap | 2192 +++++++ .../clear-as-deleting-channel.injectable.ts | 20 + .../common/delete-channel.injectable.ts | 20 + .../set-as-deleting-channel.injectable.ts | 20 + .../delete-cluster-dialog.test.tsx | 284 + ...as-deleteing-channel-handler.injectable.ts | 23 + .../main/delete-channel-handler.injectable.ts | 56 + ...as-deleteing-channel-handler.injectable.ts | 23 + .../request-clear-as-deleting.injectable.ts | 22 + .../renderer/request-delete.injectable.ts | 22 + .../request-set-as-deleting.injectable.ts | 22 + ...when-cluster-is-not-relevant.test.tsx.snap | 15 +- ...when-cluster-is-not-relevant.test.tsx.snap | 15 +- ...when-cluster-is-not-relevant.test.tsx.snap | 15 +- ...when-cluster-is-not-relevant.test.tsx.snap | 15 +- ...how-status-for-a-kube-object.test.tsx.snap | 30 +- ...when-cluster-is-not-relevant.test.tsx.snap | 15 +- .../edit-namespace-from-new-tab.test.tsx.snap | 80 +- ...e-from-previously-opened-tab.test.tsx.snap | 10 +- ...debar-and-tab-navigation-for-core.test.tsx | 6 +- ...and-tab-navigation-for-extensions.test.tsx | 12 +- ...when-cluster-is-not-relevant.test.tsx.snap | 15 +- ...elm-repository-in-preferences.test.ts.snap | 52 +- ...tory-from-list-in-preferences.test.ts.snap | 40 +- ...m-repositories-in-preferences.test.ts.snap | 40 +- ...ive-repository-in-preferences.test.ts.snap | 16 +- ...tom-helm-repository-in-preferences.test.ts | 3 + ...lling-helm-chart-from-new-tab.test.ts.snap | 100 +- ...rt-from-previously-opened-tab.test.ts.snap | 10 +- ...tab-for-installing-helm-chart.test.ts.snap | 15 +- ...installing-helm-chart-from-new-tab.test.ts | 193 +- ...m-chart-from-previously-opened-tab.test.ts | 57 +- ...dock-tab-for-installing-helm-chart.test.ts | 91 +- ...e-helm-repositories-in-preferences.test.ts | 4 +- .../upgrade-chart-new-tab.test.ts.snap | 5785 +++++++++++++++++ .../upgrade-chart-new-tab.test.ts | 268 + ...wing-details-for-helm-release.test.ts.snap | 203 +- .../showing-details-for-helm-release.test.ts | 415 +- .../__snapshots__/download-logs.test.tsx.snap | 10 +- ...ion-to-kubernetes-preferences.test.ts.snap | 4 +- ...ning-application-window-using-tray.test.ts | 4 +- src/jest.setup.ts | 4 - src/main/__test__/kubeconfig-manager.test.ts | 293 +- .../get-electron-app-path.test.ts | 3 - .../create-cluster.injectable.ts | 2 + .../setup-ipc-main-handlers.injectable.ts | 13 - .../setup-ipc-main-handlers.ts | 46 +- src/main/get-metrics.injectable.ts | 4 +- src/main/getDiForUnitTesting.ts | 12 +- src/main/helm/__tests__/helm-service.test.ts | 14 +- src/main/helm/helm-binary-path.injectable.ts | 6 +- src/main/helm/helm-chart-manager.ts | 6 +- ...t-readme.global-override-for-injectable.ts | 11 + ...ts => get-helm-chart-readme.injectable.ts} | 13 +- .../get-helm-chart-versions.injectable.ts | 31 + src/main/k8s/api-base.injectable.ts | 33 + .../create-kube-auth-proxy.injectable.ts | 5 +- .../create-kubeconfig-manager.injectable.ts | 10 + .../kubeconfig-manager/kubeconfig-manager.ts | 36 +- .../kubectl/bundled-binary-path.injectable.ts | 14 +- src/main/kubectl/create-kubectl.injectable.ts | 6 + src/main/kubectl/kubectl.ts | 23 +- .../shell-api-request.injectable.ts | 4 +- .../shell-api-request/shell-api-request.ts | 20 +- src/main/resource-applier.ts | 21 +- ...able.ts => get-readme-route.injectable.ts} | 14 +- ...able.ts => get-values-route.injectable.ts} | 6 +- .../charts/get-versions-route.injectable.ts | 25 + ...injectable.ts => list-route.injectable.ts} | 6 +- .../get-service-account-route.injectable.ts | 35 +- .../metrics/add-metrics-route.injectable.ts | 4 +- ...ts => create-resource-route.injectable.ts} | 14 +- .../routes/static-file-route.injectable.ts | 10 +- .../create-shell-session.injectable.ts | 31 +- .../local-shell-session.injectable.ts | 33 - .../local-shell-session.ts | 44 +- .../local-shell-session/open.injectable.ts | 55 + .../node-shell-session.injectable.ts | 32 - .../node-shell-session/node-shell-session.ts | 36 +- .../node-shell-session/open.injectable.ts | 42 + .../modify-terminal-shell-env.injectable.ts | 49 + .../terminal-shell-env-modifiers.ts | 42 - .../terminal-shell-env-modify.injectable.ts | 21 - src/main/shell-session/shell-session.ts | 50 +- .../splash-window/splash-window.injectable.ts | 6 +- .../get-tray-icon-path.injectable.ts | 15 +- src/migrations/cluster-store/3.6.0-beta.1.ts | 11 +- src/migrations/cluster-store/5.0.0-beta.10.ts | 5 +- src/migrations/cluster-store/5.0.0-beta.13.ts | 35 +- src/migrations/hotbar-store/5.0.0-beta.10.ts | 7 +- src/migrations/user-store/5.0.3-beta.1.ts | 23 +- src/renderer/api/index.ts | 6 - src/renderer/api/on-api-error.ts | 17 - .../api/setup-on-api-errors.injectable.ts | 24 - .../components/+add-cluster/add-cluster.tsx | 12 +- .../components/+catalog/catalog-menu.tsx | 86 +- .../+cluster/cluster-metric-switchers.tsx | 2 +- .../components/+cluster/cluster-metrics.tsx | 4 +- .../cluster-overview-store.injectable.ts | 2 + .../cluster-overview-store.ts | 28 +- .../+cluster/cluster-pie-charts.tsx | 39 +- .../+extensions/__tests__/extensions.test.tsx | 37 +- .../attempt-install-by-info.injectable.tsx | 197 +- .../attempt-install/attempt-install.tsx | 36 +- ...ate-temp-files-and-validate.injectable.tsx | 96 +- .../create-temp-files-and-validate.tsx | 94 - .../get-extension-dest-folder.injectable.ts | 15 +- .../get-extension-dest-folder.ts | 16 - .../unpack-extension.injectable.tsx | 128 +- .../unpack-extension/unpack-extension.tsx | 106 - .../attempt-installs.injectable.ts | 23 +- .../attempt-installs/attempt-installs.ts | 28 - .../components/+extensions/extensions.tsx | 10 +- ...nstall-extension-from-input.injectable.tsx | 82 + .../install-from-input.injectable.ts | 23 - .../install-from-input/install-from-input.tsx | 77 - .../read-file-notify.injectable.ts | 38 + .../read-file-notify/read-file-notify.ts | 23 - ...eadme-of-selected-helm-chart.injectable.ts | 6 +- .../call-for-helm-chart-readme.injectable.ts | 29 - ...sions-of-selected-helm-chart.injectable.ts | 6 +- ...call-for-helm-chart-versions.injectable.ts | 28 - .../get-char-details.injectable.ts | 17 - .../helm-chart-store.injectable.ts | 13 - .../+helm-charts/helm-chart.store.ts | 108 - .../components/+helm-charts/helm-charts.tsx | 42 +- .../call-for-helm-charts.injectable.ts | 17 - .../helm-charts/helm-charts.injectable.ts | 6 +- ...ersions-of-chart-for-release.injectable.ts | 36 + .../request-versions.injectable.ts | 28 + .../helm-charts/versions.injectable.ts | 29 + .../+helm-charts/helm-charts/versions.ts | 12 + ...releases.global-override-for-injectable.ts | 15 - .../call-for-helm-releases.injectable.ts | 24 - ...call-for-create-helm-release.injectable.ts | 44 - .../create-release.injectable.ts | 8 +- .../delete-release.injectable.ts | 10 +- .../+helm-releases/dialog/dialog.tsx | 28 +- ...guration.global-override-for-injectable.ts | 15 - ...r-helm-release-configuration.injectable.ts | 29 - ...-details.global-override-for-injectable.ts | 15 - ...all-for-helm-release-details.injectable.ts | 45 - .../call-for-helm-release.injectable.ts | 51 - .../release-details-model.injectable.tsx | 60 +- ...equest-detailed-helm-release.injectable.ts | 51 + .../+helm-releases/release-menu.tsx | 9 +- .../+helm-releases/releases.injectable.ts | 97 +- .../rollback-release.injectable.ts | 11 +- .../to-helm-release.injectable.ts | 90 + ...e-update.global-override-for-injectable.ts | 15 - ...call-for-helm-release-update.injectable.ts | 50 - .../update-release.injectable.ts | 8 +- .../+namespaces/namespace-details.tsx | 10 +- .../+network-ingresses/ingress-details.tsx | 24 +- src/renderer/components/+nodes/details.tsx | 13 +- src/renderer/components/+nodes/route.tsx | 50 +- .../volume-claim-details.tsx | 41 +- .../service-account-menu.tsx | 23 +- .../daemonset-details.tsx | 12 +- .../deployment-details.tsx | 13 +- .../+workloads-jobs/job-details.tsx | 12 +- .../+workloads-pods/pod-details-container.tsx | 2 +- .../+workloads-pods/pod-details.tsx | 43 +- .../replicaset-details.tsx | 13 +- .../statefulset-details.tsx | 13 +- src/renderer/components/animate/animate.tsx | 171 +- .../default-enter-duration.injectable.ts | 12 + .../default-leave-duration.injectable.ts | 12 + .../request-animation-frame.injectable.ts | 5 +- .../cluster-local-terminal-settings.tsx | 31 +- .../components/cluster-prometheus-setting.tsx | 9 +- .../__tests__/delete-cluster-dialog.test.tsx | 275 - ...luster-frame-child-component.injectable.ts | 2 - .../delete-cluster-dialog/save-config.ts | 21 - ...beconfig.global-override-for-injectable.ts | 11 + .../save-kubeconfig.injectable.ts | 35 + .../components/delete-cluster-dialog/view.tsx | 54 +- src/renderer/components/dialog/dialog.tsx | 6 +- .../lens-templates.injectable.ts | 54 +- .../user-templates.injectable.ts | 181 +- .../components/dock/create-resource/view.tsx | 11 +- src/renderer/components/dock/dock-tab.tsx | 1 + .../call-for-helm-chart-values.injectable.ts | 20 - .../install-chart-model.injectable.tsx | 41 +- .../create-upgrade-chart-tab.injectable.ts | 10 +- .../dock/upgrade-chart/store.injectable.ts | 12 +- .../components/dock/upgrade-chart/store.ts | 55 - .../dock/upgrade-chart/tab-data.injectable.ts | 21 + .../upgrade-chart-model.injectable.ts | 129 + .../components/dock/upgrade-chart/view.tsx | 205 +- .../kubeconfig-dialog/kubeconfig-dialog.tsx | 148 +- ...e-account-kube-config-dialog.injectable.ts | 31 + .../kubeconfig-dialog/open.injectable.ts | 40 + .../kubeconfig-dialog/state.injectable.ts | 14 + src/renderer/components/menu/menu.tsx | 23 +- .../__snapshots__/render-delay.test.tsx.snap | 37 + .../__tests__/render-delay.test.tsx | 105 +- ...callback.global-override-for-injectable.ts | 9 + .../cancel-idle-callback.injectable.ts | 15 + .../idle-callback-timeout.injectable.ts | 12 + .../components/render-delay/render-delay.tsx | 78 +- ...callback.global-override-for-injectable.ts | 13 + .../request-idle-callback.injectable.ts | 15 + .../resource-metrics-text.tsx | 18 +- .../resource-metrics/resource-metrics.tsx | 7 +- .../test-utils/get-application-builder.tsx | 81 +- .../create-cluster.injectable.ts | 2 + .../__snapshots__/cluster-frame.test.tsx.snap | 15 +- .../cluster-frame/cluster-frame.test.tsx | 3 + src/renderer/getDiForUnitTesting.tsx | 14 +- src/renderer/ipc/index.ts | 14 +- ...amespaces-forbidden-handler.injectable.tsx | 6 +- src/renderer/k8s/api-base.injectable.ts | 36 + src/renderer/k8s/api-kube.injectable.ts | 27 +- .../port-forward-store.injectable.ts | 14 +- .../port-forward-store/port-forward-store.ts | 39 +- .../request-active-port-forward.injectable.ts | 44 + .../create-storage.injectable.ts | 4 +- .../utils/create-storage/create-storage.ts | 14 +- src/test-utils/override-fs-with-fakes.ts | 8 +- types/dom.d.ts | 5 - yarn.lock | 46 +- 367 files changed, 16701 insertions(+), 5302 deletions(-) delete mode 100644 __mocks__/windowMock.ts create mode 100644 src/common/catalog/filtered-categories.injectable.ts create mode 100644 src/common/fetch/fetch.global-override-for-injectable.ts create mode 100644 src/common/fetch/fetch.injectable.ts create mode 100644 src/common/fs/access-path.global-override-for-injectable.ts create mode 100644 src/common/fs/access-path.injectable.ts create mode 100644 src/common/fs/copy.global-override-for-injectable.ts create mode 100644 src/common/fs/copy.injectable.ts create mode 100644 src/common/fs/delete-file.global-override-for-injectable.ts create mode 100644 src/common/fs/delete-file.injectable.ts create mode 100644 src/common/fs/ensure-dir.global-override-for-injectable.ts create mode 100644 src/common/fs/extract-tar.global-override-for-injectable.ts create mode 100644 src/common/fs/extract-tar.injectable.ts create mode 100644 src/common/fs/lstat.global-override-for-injectable.ts create mode 100644 src/common/fs/lstat.injectable.ts create mode 100644 src/common/fs/move.global-override-for-injectable.ts create mode 100644 src/common/fs/move.injectable.ts create mode 100644 src/common/fs/path-exists.global-override-for-injectable.ts create mode 100644 src/common/fs/read-directory.global-override-for-injectable.ts create mode 100644 src/common/fs/read-directory.injectable.ts create mode 100644 src/common/fs/remove-path.global-override-for-injectable.ts rename src/common/fs/{read-dir.injectable.ts => remove-path.injectable.ts} (52%) create mode 100644 src/common/fs/write-file.global-override-for-injectable.ts create mode 100644 src/common/k8s-api/create-json-api.injectable.ts create mode 100644 src/common/k8s-api/create-kube-api-for-cluster.injectable.ts create mode 100644 src/common/k8s-api/create-kube-api-for-remote-cluster.injectable.ts create mode 100644 src/common/k8s-api/create-kube-json-api-for-cluster.injectable.ts create mode 100644 src/common/k8s-api/create-kube-json-api.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-charts.api/request-charts.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-charts.api/request-readme.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-charts.api/request-values.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-charts.api/request-versions.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-configuration.global-override-for-injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-create.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-delete.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-details.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-history.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-releases.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-rollback.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-update.injectable.ts create mode 100644 src/common/k8s-api/endpoints/helm-releases.api/request-values.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-ingress-metrics.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-metrics-for-all-nodes.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-metrics.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-persistent-volume-claim-metrics.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-daemon-sets.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-deployments.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-jobs.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-replica-sets.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-stateful-sets.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-in-namespace.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-pod-metrics.injectable.ts create mode 100644 src/common/k8s-api/endpoints/metrics.api/request-providers.injectable.ts delete mode 100644 src/common/k8s-api/endpoints/resource-applier.api.ts create mode 100644 src/common/k8s-api/endpoints/resource-applier.api/request-patch.injectable.ts create mode 100644 src/common/k8s-api/endpoints/resource-applier.api/request-update.injectable.ts delete mode 100644 src/common/k8s-api/index.ts create mode 100644 src/common/k8s-api/window-location.global-override-for-injectable.ts create mode 100644 src/common/k8s-api/window-location.injectable.ts create mode 100644 src/common/kube-helpers/load-config-from-file.injectable.ts create mode 100644 src/common/os/home-directory-path.global-override-for-injectable.ts create mode 100644 src/common/os/home-directory-path.injectable.ts create mode 100644 src/common/os/temp-directory-path.global-override-for-injectable.ts create mode 100644 src/common/os/temp-directory-path.injectable.ts create mode 100644 src/common/path/get-absolute-path.global-override-for-injectable.ts create mode 100644 src/common/path/get-basename.global-override-for-injectable.ts create mode 100644 src/common/path/get-basename.injectable.ts create mode 100644 src/common/path/get-dirname.global-override-for-injectable.ts create mode 100644 src/common/path/get-dirname.injectable.ts create mode 100644 src/common/path/get-relative-path.global-override-for-injectable.ts create mode 100644 src/common/path/get-relative-path.injectable.ts create mode 100644 src/common/path/is-logical-child-path.injectable.ts create mode 100644 src/common/path/join-paths.global-override-for-injectable.ts create mode 100644 src/common/path/parse.global-override-for-injectable.ts create mode 100644 src/common/path/parse.injectable.ts create mode 100644 src/common/path/resolve-path.injectable.ts create mode 100644 src/common/path/resolve-tilde.injectable.ts create mode 100644 src/common/path/separator.global-override-for-injectable.ts create mode 100644 src/common/path/separator.injectable.ts delete mode 100644 src/common/test-utils/get-absolute-path-fake.ts delete mode 100644 src/common/test-utils/join-paths-fake.ts delete mode 100644 src/common/utils/paths.ts create mode 100644 src/common/vars/is-debugging.global-override-for-injectable.ts create mode 100644 src/common/vars/is-debugging.injectable.ts create mode 100644 src/features/cluster/delete-dialog/__snapshots__/delete-cluster-dialog.test.tsx.snap create mode 100644 src/features/cluster/delete-dialog/common/clear-as-deleting-channel.injectable.ts create mode 100644 src/features/cluster/delete-dialog/common/delete-channel.injectable.ts create mode 100644 src/features/cluster/delete-dialog/common/set-as-deleting-channel.injectable.ts create mode 100644 src/features/cluster/delete-dialog/delete-cluster-dialog.test.tsx create mode 100644 src/features/cluster/delete-dialog/main/clear-as-deleteing-channel-handler.injectable.ts create mode 100644 src/features/cluster/delete-dialog/main/delete-channel-handler.injectable.ts create mode 100644 src/features/cluster/delete-dialog/main/set-as-deleteing-channel-handler.injectable.ts create mode 100644 src/features/cluster/delete-dialog/renderer/request-clear-as-deleting.injectable.ts create mode 100644 src/features/cluster/delete-dialog/renderer/request-delete.injectable.ts create mode 100644 src/features/cluster/delete-dialog/renderer/request-set-as-deleting.injectable.ts create mode 100644 src/features/helm-charts/upgrade-chart/__snapshots__/upgrade-chart-new-tab.test.ts.snap create mode 100644 src/features/helm-charts/upgrade-chart/upgrade-chart-new-tab.test.ts create mode 100644 src/main/helm/helm-service/get-helm-chart-readme.global-override-for-injectable.ts rename src/main/helm/helm-service/{get-helm-chart.injectable.ts => get-helm-chart-readme.injectable.ts} (73%) create mode 100644 src/main/helm/helm-service/get-helm-chart-versions.injectable.ts create mode 100644 src/main/k8s/api-base.injectable.ts rename src/main/routes/helm/charts/{get-chart-route.injectable.ts => get-readme-route.injectable.ts} (58%) rename src/main/routes/helm/charts/{get-chart-values-route.injectable.ts => get-values-route.injectable.ts} (84%) create mode 100644 src/main/routes/helm/charts/get-versions-route.injectable.ts rename src/main/routes/helm/charts/{list-charts-route.injectable.ts => list-route.injectable.ts} (82%) rename src/main/routes/resource-applier/{apply-resource-route.injectable.ts => create-resource-route.injectable.ts} (53%) delete mode 100644 src/main/shell-session/local-shell-session/local-shell-session.injectable.ts create mode 100644 src/main/shell-session/local-shell-session/open.injectable.ts delete mode 100644 src/main/shell-session/node-shell-session/node-shell-session.injectable.ts create mode 100644 src/main/shell-session/node-shell-session/open.injectable.ts create mode 100644 src/main/shell-session/shell-env-modifier/modify-terminal-shell-env.injectable.ts delete mode 100644 src/main/shell-session/shell-env-modifier/terminal-shell-env-modifiers.ts delete mode 100644 src/main/shell-session/shell-env-modifier/terminal-shell-env-modify.injectable.ts delete mode 100644 src/renderer/api/index.ts delete mode 100644 src/renderer/api/on-api-error.ts delete mode 100644 src/renderer/api/setup-on-api-errors.injectable.ts delete mode 100644 src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.tsx delete mode 100644 src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.ts delete mode 100644 src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.tsx delete mode 100644 src/renderer/components/+extensions/attempt-installs/attempt-installs.ts create mode 100644 src/renderer/components/+extensions/install-extension-from-input.injectable.tsx delete mode 100644 src/renderer/components/+extensions/install-from-input/install-from-input.injectable.ts delete mode 100644 src/renderer/components/+extensions/install-from-input/install-from-input.tsx create mode 100644 src/renderer/components/+extensions/read-file-notify/read-file-notify.injectable.ts delete mode 100644 src/renderer/components/+extensions/read-file-notify/read-file-notify.ts delete mode 100644 src/renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable.ts delete mode 100644 src/renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable.ts delete mode 100644 src/renderer/components/+helm-charts/get-char-details.injectable.ts delete mode 100644 src/renderer/components/+helm-charts/helm-chart-store.injectable.ts delete mode 100644 src/renderer/components/+helm-charts/helm-chart.store.ts delete mode 100644 src/renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable.ts create mode 100644 src/renderer/components/+helm-charts/helm-charts/request-versions-of-chart-for-release.injectable.ts create mode 100644 src/renderer/components/+helm-charts/helm-charts/request-versions.injectable.ts create mode 100644 src/renderer/components/+helm-charts/helm-charts/versions.injectable.ts create mode 100644 src/renderer/components/+helm-charts/helm-charts/versions.ts delete mode 100644 src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.global-override-for-injectable.ts delete mode 100644 src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.injectable.ts delete mode 100644 src/renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable.ts delete mode 100644 src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.global-override-for-injectable.ts delete mode 100644 src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.injectable.ts delete mode 100644 src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.global-override-for-injectable.ts delete mode 100644 src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.injectable.ts delete mode 100644 src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release.injectable.ts create mode 100644 src/renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable.ts create mode 100644 src/renderer/components/+helm-releases/to-helm-release.injectable.ts delete mode 100644 src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.global-override-for-injectable.ts delete mode 100644 src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.injectable.ts create mode 100644 src/renderer/components/animate/default-enter-duration.injectable.ts create mode 100644 src/renderer/components/animate/default-leave-duration.injectable.ts delete mode 100644 src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx delete mode 100644 src/renderer/components/delete-cluster-dialog/save-config.ts create mode 100644 src/renderer/components/delete-cluster-dialog/save-kubeconfig.global-override-for-injectable.ts create mode 100644 src/renderer/components/delete-cluster-dialog/save-kubeconfig.injectable.ts delete mode 100644 src/renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable.ts delete mode 100644 src/renderer/components/dock/upgrade-chart/store.ts create mode 100644 src/renderer/components/dock/upgrade-chart/tab-data.injectable.ts create mode 100644 src/renderer/components/dock/upgrade-chart/upgrade-chart-model.injectable.ts create mode 100644 src/renderer/components/kubeconfig-dialog/open-service-account-kube-config-dialog.injectable.ts create mode 100644 src/renderer/components/kubeconfig-dialog/open.injectable.ts create mode 100644 src/renderer/components/kubeconfig-dialog/state.injectable.ts create mode 100644 src/renderer/components/render-delay/__tests__/__snapshots__/render-delay.test.tsx.snap create mode 100644 src/renderer/components/render-delay/cancel-idle-callback.global-override-for-injectable.ts create mode 100644 src/renderer/components/render-delay/cancel-idle-callback.injectable.ts create mode 100644 src/renderer/components/render-delay/idle-callback-timeout.injectable.ts create mode 100644 src/renderer/components/render-delay/request-idle-callback.global-override-for-injectable.ts create mode 100644 src/renderer/components/render-delay/request-idle-callback.injectable.ts create mode 100644 src/renderer/k8s/api-base.injectable.ts create mode 100644 src/renderer/port-forward/port-forward-store/request-active-port-forward.injectable.ts diff --git a/__mocks__/windowMock.ts b/__mocks__/windowMock.ts deleted file mode 100644 index bcc3da05a6..0000000000 --- a/__mocks__/windowMock.ts +++ /dev/null @@ -1,19 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -/** - * Mock the global window variable - */ -export function mockWindow() { - Object.defineProperty(window, "requestIdleCallback", { - writable: true, - value: jest.fn().mockImplementation(callback => callback()), - }); - - Object.defineProperty(window, "cancelIdleCallback", { - writable: true, - value: jest.fn(), - }); -} diff --git a/package.json b/package.json index 49fa584d7c..26ba378293 100644 --- a/package.json +++ b/package.json @@ -351,7 +351,7 @@ "@types/semver": "^7.3.12", "@types/sharp": "^0.31.0", "@types/spdy": "^3.4.5", - "@types/tar": "^4.0.5", + "@types/tar": "^6.1.2", "@types/tar-stream": "^2.2.2", "@types/tcp-port-used": "^1.0.1", "@types/tempy": "^0.3.0", @@ -396,7 +396,6 @@ "jest": "^28.1.3", "jest-canvas-mock": "^2.3.1", "jest-environment-jsdom": "^28.1.3", - "jest-fetch-mock": "^3.0.3", "jest-mock-extended": "^2.0.9", "make-plural": "^6.2.2", "mini-css-extract-plugin": "^2.6.1", diff --git a/src/common/app-paths/directory-for-binaries/directory-for-binaries.injectable.ts b/src/common/app-paths/directory-for-binaries/directory-for-binaries.injectable.ts index 5f6b14f5ba..f8a55b041c 100644 --- a/src/common/app-paths/directory-for-binaries/directory-for-binaries.injectable.ts +++ b/src/common/app-paths/directory-for-binaries/directory-for-binaries.injectable.ts @@ -4,16 +4,16 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import directoryForUserDataInjectable from "../directory-for-user-data/directory-for-user-data.injectable"; -import getAbsolutePathInjectable from "../../path/get-absolute-path.injectable"; +import joinPathsInjectable from "../../path/join-paths.injectable"; const directoryForBinariesInjectable = getInjectable({ id: "directory-for-binaries", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const directoryForUserData = di.inject(directoryForUserDataInjectable); - return getAbsolutePath(directoryForUserData, "binaries"); + return joinPaths(directoryForUserData, "binaries"); }, }); diff --git a/src/common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable.ts b/src/common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable.ts index f371860f18..d49029572e 100644 --- a/src/common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable.ts +++ b/src/common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable.ts @@ -4,19 +4,16 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import directoryForUserDataInjectable from "../directory-for-user-data/directory-for-user-data.injectable"; -import getAbsolutePathInjectable from "../../path/get-absolute-path.injectable"; +import joinPathsInjectable from "../../path/join-paths.injectable"; const directoryForKubeConfigsInjectable = getInjectable({ id: "directory-for-kube-configs", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const directoryForUserData = di.inject(directoryForUserDataInjectable); - return getAbsolutePath( - directoryForUserData, - "kubeconfigs", - ); + return joinPaths(directoryForUserData, "kubeconfigs"); }, }); diff --git a/src/common/app-paths/directory-for-kubectl-binaries/directory-for-kubectl-binaries.injectable.ts b/src/common/app-paths/directory-for-kubectl-binaries/directory-for-kubectl-binaries.injectable.ts index 4b6ce56601..c1ef1b23f5 100644 --- a/src/common/app-paths/directory-for-kubectl-binaries/directory-for-kubectl-binaries.injectable.ts +++ b/src/common/app-paths/directory-for-kubectl-binaries/directory-for-kubectl-binaries.injectable.ts @@ -4,17 +4,16 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import directoryForBinariesInjectable from "../directory-for-binaries/directory-for-binaries.injectable"; -import getAbsolutePathInjectable from "../../path/get-absolute-path.injectable"; +import joinPathsInjectable from "../../path/join-paths.injectable"; const directoryForKubectlBinariesInjectable = getInjectable({ id: "directory-for-kubectl-binaries", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const directoryForBinaries = di.inject(directoryForBinariesInjectable); - - return getAbsolutePath(directoryForBinaries, "kubectl"); + return joinPaths(directoryForBinaries, "kubectl"); }, }); diff --git a/src/common/app-paths/get-custom-kube-config-directory/get-custom-kube-config-directory.injectable.ts b/src/common/app-paths/get-custom-kube-config-directory/get-custom-kube-config-directory.injectable.ts index 6f22aa32f2..5d53e506bd 100644 --- a/src/common/app-paths/get-custom-kube-config-directory/get-custom-kube-config-directory.injectable.ts +++ b/src/common/app-paths/get-custom-kube-config-directory/get-custom-kube-config-directory.injectable.ts @@ -4,17 +4,16 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import directoryForKubeConfigsInjectable from "../directory-for-kube-configs/directory-for-kube-configs.injectable"; -import getAbsolutePathInjectable from "../../path/get-absolute-path.injectable"; +import joinPathsInjectable from "../../path/join-paths.injectable"; const getCustomKubeConfigDirectoryInjectable = getInjectable({ id: "get-custom-kube-config-directory", instantiate: (di) => { const directoryForKubeConfigs = di.inject(directoryForKubeConfigsInjectable); - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); - return (directoryName: string) => - getAbsolutePath(directoryForKubeConfigs, directoryName); + return (directoryName: string) => joinPaths(directoryForKubeConfigs, directoryName); }, }); diff --git a/src/common/catalog/filtered-categories.injectable.ts b/src/common/catalog/filtered-categories.injectable.ts new file mode 100644 index 0000000000..c84d527ff2 --- /dev/null +++ b/src/common/catalog/filtered-categories.injectable.ts @@ -0,0 +1,18 @@ +/** + * 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 { computed } from "mobx"; +import catalogCategoryRegistryInjectable from "./category-registry.injectable"; + +const filteredCategoriesInjectable = getInjectable({ + id: "filtered-categories", + instantiate: (di) => { + const registry = di.inject(catalogCategoryRegistryInjectable); + + return computed(() => [...registry.filteredItems]); + }, +}); + +export default filteredCategoriesInjectable; diff --git a/src/common/cluster/cluster.ts b/src/common/cluster/cluster.ts index 9b0eed76aa..b0d7fbfbc3 100644 --- a/src/common/cluster/cluster.ts +++ b/src/common/cluster/cluster.ts @@ -9,7 +9,6 @@ import type { KubeConfig } from "@kubernetes/client-node"; import { HttpError } from "@kubernetes/client-node"; import type { Kubectl } from "../../main/kubectl/kubectl"; import type { KubeconfigManager } from "../../main/kubeconfig-manager/kubeconfig-manager"; -import { loadConfigFromFile } from "../kube-helpers"; import type { KubeApiResource, KubeResource } from "../rbac"; import { apiResourceRecord, apiResources } from "../rbac"; import type { VersionDetector } from "../../main/cluster-detectors/version-detector"; @@ -25,6 +24,7 @@ import type { ListNamespaces } from "./list-namespaces.injectable"; import assert from "assert"; import type { Logger } from "../logger"; import type { BroadcastMessage } from "../ipc/broadcast-message.injectable"; +import type { LoadConfigfromFile } from "../kube-helpers/load-config-from-file.injectable"; export interface ClusterDependencies { readonly directoryForKubeConfigs: string; @@ -37,6 +37,7 @@ export interface ClusterDependencies { createListNamespaces: (config: KubeConfig) => ListNamespaces; createVersionDetector: (cluster: Cluster) => VersionDetector; broadcastMessage: BroadcastMessage; + loadConfigfromFile: LoadConfigfromFile; } /** @@ -500,7 +501,7 @@ export class Cluster implements ClusterModel, ClusterState { } async getKubeconfig(): Promise { - const { config } = await loadConfigFromFile(this.kubeConfigPath); + const { config } = await this.dependencies.loadConfigfromFile(this.kubeConfigPath); return config; } @@ -510,7 +511,7 @@ export class Cluster implements ClusterModel, ClusterState { */ async getProxyKubeconfig(): Promise { const proxyKCPath = await this.getProxyKubeconfigPath(); - const { config } = await loadConfigFromFile(proxyKCPath); + const { config } = await this.dependencies.loadConfigfromFile(proxyKCPath); return config; } diff --git a/src/common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable.ts b/src/common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable.ts index 4bb5cb2495..11a8f3f7de 100644 --- a/src/common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable.ts +++ b/src/common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable.ts @@ -4,16 +4,16 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import directoryForUserDataInjectable from "../app-paths/directory-for-user-data/directory-for-user-data.injectable"; -import getAbsolutePathInjectable from "../path/get-absolute-path.injectable"; +import joinPathsInjectable from "../path/join-paths.injectable"; const directoryForLensLocalStorageInjectable = getInjectable({ id: "directory-for-lens-local-storage", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const directoryForUserData = di.inject(directoryForUserDataInjectable); - return getAbsolutePath( + return joinPaths( directoryForUserData, "lens-local-storage", ); diff --git a/src/common/fetch/fetch.global-override-for-injectable.ts b/src/common/fetch/fetch.global-override-for-injectable.ts new file mode 100644 index 0000000000..cd6160641c --- /dev/null +++ b/src/common/fetch/fetch.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import fetchInjectable from "./fetch.injectable"; + +export default getGlobalOverride(fetchInjectable, () => () => { + throw new Error("tried to fetch a resource without override in test"); +}); diff --git a/src/common/fetch/fetch.injectable.ts b/src/common/fetch/fetch.injectable.ts new file mode 100644 index 0000000000..c6d2a7e1af --- /dev/null +++ b/src/common/fetch/fetch.injectable.ts @@ -0,0 +1,17 @@ +/** + * 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 type { RequestInfo, RequestInit, Response } from "node-fetch"; +import fetch from "node-fetch"; + +export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise; + +const fetchInjectable = getInjectable({ + id: "fetch", + instantiate: (): Fetch => fetch, + causesSideEffects: true, +}); + +export default fetchInjectable; diff --git a/src/common/fs/access-path.global-override-for-injectable.ts b/src/common/fs/access-path.global-override-for-injectable.ts new file mode 100644 index 0000000000..747d839682 --- /dev/null +++ b/src/common/fs/access-path.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import accessPathInjectable from "./access-path.injectable"; + +export default getGlobalOverride(accessPathInjectable, () => async () => { + throw new Error("tried to verify path access without override"); +}); diff --git a/src/common/fs/access-path.injectable.ts b/src/common/fs/access-path.injectable.ts new file mode 100644 index 0000000000..0504de9d6f --- /dev/null +++ b/src/common/fs/access-path.injectable.ts @@ -0,0 +1,27 @@ +/** + * 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 fsInjectable from "./fs.injectable"; + +export type AccessPath = (path: string, mode?: number) => Promise; + +const accessPathInjectable = getInjectable({ + id: "access-path", + instantiate: (di): AccessPath => { + const { access } = di.inject(fsInjectable); + + return async (path, mode) => { + try { + await access(path, mode); + + return true; + } catch { + return false; + } + }; + }, +}); + +export default accessPathInjectable; diff --git a/src/common/fs/copy.global-override-for-injectable.ts b/src/common/fs/copy.global-override-for-injectable.ts new file mode 100644 index 0000000000..b6d899d2c4 --- /dev/null +++ b/src/common/fs/copy.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import copyInjectable from "./copy.injectable"; + +export default getGlobalOverride(copyInjectable, () => async () => { + throw new Error("tried to copy filepaths without override"); +}); diff --git a/src/common/fs/copy.injectable.ts b/src/common/fs/copy.injectable.ts new file mode 100644 index 0000000000..6a64ee3751 --- /dev/null +++ b/src/common/fs/copy.injectable.ts @@ -0,0 +1,16 @@ +/** + * 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 type { CopyOptions } from "fs-extra"; +import fsInjectable from "./fs.injectable"; + +export type Copy = (src: string, dest: string, options?: CopyOptions | undefined) => Promise; + +const copyInjectable = getInjectable({ + id: "copy", + instantiate: (di): Copy => di.inject(fsInjectable).copy, +}); + +export default copyInjectable; diff --git a/src/common/fs/delete-file.global-override-for-injectable.ts b/src/common/fs/delete-file.global-override-for-injectable.ts new file mode 100644 index 0000000000..c03dca88dc --- /dev/null +++ b/src/common/fs/delete-file.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import deleteFileInjectable from "./delete-file.injectable"; + +export default getGlobalOverride(deleteFileInjectable, () => async () => { + throw new Error("tried to delete file without override"); +}); diff --git a/src/common/fs/delete-file.injectable.ts b/src/common/fs/delete-file.injectable.ts new file mode 100644 index 0000000000..57aba5b379 --- /dev/null +++ b/src/common/fs/delete-file.injectable.ts @@ -0,0 +1,15 @@ +/** + * 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 fsInjectable from "./fs.injectable"; + +export type DeleteFile = (filePath: string) => Promise; + +const deleteFileInjectable = getInjectable({ + id: "delete-file", + instantiate: (di): DeleteFile => di.inject(fsInjectable).unlink, +}); + +export default deleteFileInjectable; diff --git a/src/common/fs/ensure-dir.global-override-for-injectable.ts b/src/common/fs/ensure-dir.global-override-for-injectable.ts new file mode 100644 index 0000000000..4dd098b163 --- /dev/null +++ b/src/common/fs/ensure-dir.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import ensureDirInjectable from "./ensure-dir.injectable"; + +export default getGlobalOverride(ensureDirInjectable, () => async () => { + throw new Error("tried to ensure directory without override"); +}); diff --git a/src/common/fs/ensure-dir.injectable.ts b/src/common/fs/ensure-dir.injectable.ts index 88410ceee2..78ec4d91dc 100644 --- a/src/common/fs/ensure-dir.injectable.ts +++ b/src/common/fs/ensure-dir.injectable.ts @@ -5,14 +5,14 @@ import { getInjectable } from "@ogre-tools/injectable"; import fsInjectable from "./fs.injectable"; +export type EnsureDirectory = (dirPath: string) => Promise; + const ensureDirInjectable = getInjectable({ id: "ensure-dir", // TODO: Remove usages of ensureDir from business logic. // TODO: Read, Write, Watch etc. operations should do this internally. - instantiate: (di) => di.inject(fsInjectable).ensureDir, - - causesSideEffects: true, + instantiate: (di): EnsureDirectory => di.inject(fsInjectable).ensureDir, }); export default ensureDirInjectable; diff --git a/src/common/fs/extract-tar.global-override-for-injectable.ts b/src/common/fs/extract-tar.global-override-for-injectable.ts new file mode 100644 index 0000000000..02a46c1d6b --- /dev/null +++ b/src/common/fs/extract-tar.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import extractTarInjectable from "./extract-tar.injectable"; + +export default getGlobalOverride(extractTarInjectable, () => async () => { + throw new Error("tried to extract a tar file without override"); +}); diff --git a/src/common/fs/extract-tar.injectable.ts b/src/common/fs/extract-tar.injectable.ts new file mode 100644 index 0000000000..410512139e --- /dev/null +++ b/src/common/fs/extract-tar.injectable.ts @@ -0,0 +1,26 @@ +/** + * 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 type { ExtractOptions } from "tar"; +import { extract } from "tar"; +import getDirnameOfPathInjectable from "../path/get-dirname.injectable"; + +export type ExtractTar = (filePath: string, opts?: ExtractOptions) => Promise; + +const extractTarInjectable = getInjectable({ + id: "extract-tar", + instantiate: (di): ExtractTar => { + const getDirnameOfPath = di.inject(getDirnameOfPathInjectable); + + return (filePath, opts = {}) => extract({ + file: filePath, + cwd: getDirnameOfPath(filePath), + ...opts, + }); + }, + causesSideEffects: true, +}); + +export default extractTarInjectable; diff --git a/src/common/fs/lstat.global-override-for-injectable.ts b/src/common/fs/lstat.global-override-for-injectable.ts new file mode 100644 index 0000000000..9c9f3d4933 --- /dev/null +++ b/src/common/fs/lstat.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import lstatInjectable from "./lstat.injectable"; + +export default getGlobalOverride(lstatInjectable, () => async () => { + throw new Error("tried to lstat a filepath without override"); +}); diff --git a/src/common/fs/lstat.injectable.ts b/src/common/fs/lstat.injectable.ts new file mode 100644 index 0000000000..50c1d4ad12 --- /dev/null +++ b/src/common/fs/lstat.injectable.ts @@ -0,0 +1,16 @@ +/** + * 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 type { Stats } from "fs"; +import fsInjectable from "./fs.injectable"; + +export type LStat = (path: string) => Promise; + +const lstatInjectable = getInjectable({ + id: "lstat", + instantiate: (di): LStat => di.inject(fsInjectable).lstat, +}); + +export default lstatInjectable; diff --git a/src/common/fs/move.global-override-for-injectable.ts b/src/common/fs/move.global-override-for-injectable.ts new file mode 100644 index 0000000000..c39907ee6e --- /dev/null +++ b/src/common/fs/move.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import moveInjectable from "./move.injectable"; + +export default getGlobalOverride(moveInjectable, () => async () => { + throw new Error("tried to move without override"); +}); diff --git a/src/common/fs/move.injectable.ts b/src/common/fs/move.injectable.ts new file mode 100644 index 0000000000..ff11120d80 --- /dev/null +++ b/src/common/fs/move.injectable.ts @@ -0,0 +1,16 @@ +/** + * 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 type { MoveOptions } from "fs-extra"; +import fsInjectable from "./fs.injectable"; + +export type Move = (src: string, dest: string, options?: MoveOptions) => Promise; + +const moveInjectable = getInjectable({ + id: "move", + instantiate: (di): Move => di.inject(fsInjectable).move, +}); + +export default moveInjectable; diff --git a/src/common/fs/path-exists.global-override-for-injectable.ts b/src/common/fs/path-exists.global-override-for-injectable.ts new file mode 100644 index 0000000000..1b9b96c8dd --- /dev/null +++ b/src/common/fs/path-exists.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import pathExistsInjectable from "./path-exists.injectable"; + +export default getGlobalOverride(pathExistsInjectable, () => async () => { + throw new Error("Tried to check if a path exists without override"); +}); diff --git a/src/common/fs/read-directory.global-override-for-injectable.ts b/src/common/fs/read-directory.global-override-for-injectable.ts new file mode 100644 index 0000000000..57c83ceffb --- /dev/null +++ b/src/common/fs/read-directory.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import readDirectoryInjectable from "./read-directory.injectable"; + +export default getGlobalOverride(readDirectoryInjectable, () => async () => { + throw new Error("tried to read a directory's content without override"); +}); diff --git a/src/common/fs/read-directory.injectable.ts b/src/common/fs/read-directory.injectable.ts new file mode 100644 index 0000000000..57632bd4d7 --- /dev/null +++ b/src/common/fs/read-directory.injectable.ts @@ -0,0 +1,37 @@ +/** + * 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 type { Dirent } from "fs"; +import fsInjectable from "./fs.injectable"; + +export interface ReadDirectory { + ( + path: string, + options: "buffer" | { encoding: "buffer"; withFileTypes?: false | undefined } + ): Promise; + ( + path: string, + options?: + | { encoding: BufferEncoding | string | null; withFileTypes?: false | undefined } + | BufferEncoding + | string + | null, + ): Promise; + ( + path: string, + options?: { encoding?: BufferEncoding | string | null | undefined; withFileTypes?: false | undefined }, + ): Promise; + ( + path: string, + options: { encoding?: BufferEncoding | string | null | undefined; withFileTypes: true }, + ): Promise; +} + +const readDirectoryInjectable = getInjectable({ + id: "read-directory", + instantiate: (di): ReadDirectory => di.inject(fsInjectable).readdir, +}); + +export default readDirectoryInjectable; diff --git a/src/common/fs/read-file.injectable.ts b/src/common/fs/read-file.injectable.ts index b0a2b7233e..0dc539e1b1 100644 --- a/src/common/fs/read-file.injectable.ts +++ b/src/common/fs/read-file.injectable.ts @@ -5,11 +5,16 @@ import { getInjectable } from "@ogre-tools/injectable"; import fsInjectable from "./fs.injectable"; +export type ReadFile = (filePath: string) => Promise; + const readFileInjectable = getInjectable({ id: "read-file", - instantiate: (di) => (filePath: string) => - di.inject(fsInjectable).readFile(filePath, "utf-8"), + instantiate: (di): ReadFile => { + const { readFile } = di.inject(fsInjectable); + + return (filePath) => readFile(filePath, "utf-8"); + }, }); export default readFileInjectable; diff --git a/src/common/fs/remove-path.global-override-for-injectable.ts b/src/common/fs/remove-path.global-override-for-injectable.ts new file mode 100644 index 0000000000..5b9720a837 --- /dev/null +++ b/src/common/fs/remove-path.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import removePathInjectable from "./remove-path.injectable"; + +export default getGlobalOverride(removePathInjectable, () => async () => { + throw new Error("tried to remove a path without override"); +}); diff --git a/src/common/fs/read-dir.injectable.ts b/src/common/fs/remove-path.injectable.ts similarity index 52% rename from src/common/fs/read-dir.injectable.ts rename to src/common/fs/remove-path.injectable.ts index 2c7b59d9b2..02c8da0e1e 100644 --- a/src/common/fs/read-dir.injectable.ts +++ b/src/common/fs/remove-path.injectable.ts @@ -5,9 +5,11 @@ import { getInjectable } from "@ogre-tools/injectable"; import fsInjectable from "./fs.injectable"; -const readDirInjectable = getInjectable({ - id: "read-dir", - instantiate: (di) => di.inject(fsInjectable).readdir, +export type RemovePath = (path: string) => Promise; + +const removePathInjectable = getInjectable({ + id: "remove-path", + instantiate: (di): RemovePath => di.inject(fsInjectable).remove, }); -export default readDirInjectable; +export default removePathInjectable; diff --git a/src/common/fs/write-file.global-override-for-injectable.ts b/src/common/fs/write-file.global-override-for-injectable.ts new file mode 100644 index 0000000000..c8b7ef8e45 --- /dev/null +++ b/src/common/fs/write-file.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import writeFileInjectable from "./write-file.injectable"; + +export default getGlobalOverride(writeFileInjectable, () => async () => { + throw new Error("tried to write file without override"); +}); diff --git a/src/common/fs/write-file.injectable.ts b/src/common/fs/write-file.injectable.ts index 70dcb76373..faa5285ca1 100644 --- a/src/common/fs/write-file.injectable.ts +++ b/src/common/fs/write-file.injectable.ts @@ -3,20 +3,28 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import path from "path"; +import type { WriteFileOptions } from "fs-extra"; +import getDirnameOfPathInjectable from "../path/get-dirname.injectable"; import fsInjectable from "./fs.injectable"; +export type WriteFile = (filePath: string, content: string | Buffer, opts?: WriteFileOptions) => Promise; + const writeFileInjectable = getInjectable({ id: "write-file", - instantiate: (di) => { + instantiate: (di): WriteFile => { const { writeFile, ensureDir } = di.inject(fsInjectable); + const getDirnameOfPath = di.inject(getDirnameOfPathInjectable); - return async (filePath: string, content: string | Buffer) => { - await ensureDir(path.dirname(filePath), { mode: 0o755 }); + return async (filePath, content, opts) => { + await ensureDir(getDirnameOfPath(filePath), { + mode: 0o755, + ...(opts ?? {}), + }); await writeFile(filePath, content, { encoding: "utf-8", + ...(opts ?? {}), }); }; }, diff --git a/src/common/fs/write-json-file.injectable.ts b/src/common/fs/write-json-file.injectable.ts index 6d05e01a7c..a7079d7f84 100644 --- a/src/common/fs/write-json-file.injectable.ts +++ b/src/common/fs/write-json-file.injectable.ts @@ -3,37 +3,27 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import type { EnsureOptions, WriteOptions } from "fs-extra"; -import path from "path"; import type { JsonValue } from "type-fest"; +import getDirnameOfPathInjectable from "../path/get-dirname.injectable"; import fsInjectable from "./fs.injectable"; export type WriteJson = (filePath: string, contents: JsonValue) => Promise; -interface Dependencies { - writeJson: (file: string, object: any, options?: WriteOptions | BufferEncoding | string) => Promise; - ensureDir: (dir: string, options?: EnsureOptions | number) => Promise; -} - -const writeJsonFile = ({ writeJson, ensureDir }: Dependencies): WriteJson => async (filePath, content) => { - await ensureDir(path.dirname(filePath), { mode: 0o755 }); - - await writeJson(filePath, content, { - encoding: "utf-8", - spaces: 2, - }); -}; - const writeJsonFileInjectable = getInjectable({ id: "write-json-file", - instantiate: (di) => { + instantiate: (di): WriteJson => { const { writeJson, ensureDir } = di.inject(fsInjectable); + const getDirnameOfPath = di.inject(getDirnameOfPathInjectable); - return writeJsonFile({ - writeJson, - ensureDir, - }); + return async (filePath, content) => { + await ensureDir(getDirnameOfPath(filePath), { mode: 0o755 }); + + await writeJson(filePath, content, { + encoding: "utf-8", + spaces: 2, + }); + }; }, }); diff --git a/src/common/ipc/cluster.ts b/src/common/ipc/cluster.ts index 9f69ff42d5..c5bec1f59f 100644 --- a/src/common/ipc/cluster.ts +++ b/src/common/ipc/cluster.ts @@ -8,9 +8,6 @@ export const clusterSetFrameIdHandler = "cluster:set-frame-id"; export const clusterVisibilityHandler = "cluster:visibility"; export const clusterRefreshHandler = "cluster:refresh"; export const clusterDisconnectHandler = "cluster:disconnect"; -export const clusterDeleteHandler = "cluster:delete"; -export const clusterSetDeletingHandler = "cluster:deleting:set"; -export const clusterClearDeletingHandler = "cluster:deleting:clear"; export const clusterKubectlApplyAllHandler = "cluster:kubectl-apply-all"; export const clusterKubectlDeleteAllHandler = "cluster:kubectl-delete-all"; export const clusterStates = "cluster:states"; diff --git a/src/common/k8s-api/__tests__/kube-api.test.ts b/src/common/k8s-api/__tests__/kube-api.test.ts index 05da1f89d5..d76518be00 100644 --- a/src/common/k8s-api/__tests__/kube-api.test.ts +++ b/src/common/k8s-api/__tests__/kube-api.test.ts @@ -2,37 +2,43 @@ * Copyright (c) OpenLens Authors. All rights reserved. * Licensed under MIT License. See LICENSE in root directory for more information. */ - -import { forRemoteCluster, KubeApi } from "../kube-api"; -import { KubeJsonApi } from "../kube-json-api"; -import { KubeObject } from "../kube-object"; -import { delay } from "../../utils/delay"; +import type { KubeApiWatchCallback } from "../kube-api"; +import { KubeApi } from "../kube-api"; +import type { KubeJsonApi, KubeJsonApiData } from "../kube-json-api"; import { PassThrough } from "stream"; -import { ApiManager } from "../api-manager"; -import type { FetchMock } from "jest-fetch-mock/types"; -import { DeploymentApi, Ingress, IngressApi, Pod, PodApi } from "../endpoints"; +import type { ApiManager } from "../api-manager"; +import { Deployment, DeploymentApi, Ingress, IngressApi, NamespaceApi, Pod, PodApi } from "../endpoints"; import { getDiForUnitTesting } from "../../../renderer/getDiForUnitTesting"; import apiManagerInjectable from "../api-manager/manager.injectable"; import autoRegistrationInjectable from "../api-manager/auto-registration.injectable"; +import type { Fetch } from "../../fetch/fetch.injectable"; +import fetchInjectable from "../../fetch/fetch.injectable"; +import type { CreateKubeApiForRemoteCluster } from "../create-kube-api-for-remote-cluster.injectable"; +import createKubeApiForRemoteClusterInjectable from "../create-kube-api-for-remote-cluster.injectable"; +import { Response } from "node-fetch"; +import type { AsyncFnMock } from "@async-fn/jest"; +import asyncFn from "@async-fn/jest"; +import { flushPromises } from "../../test-utils/flush-promises"; +import createKubeJsonApiInjectable from "../create-kube-json-api.injectable"; +import type { IKubeWatchEvent } from "../kube-watch-event"; +import type { KubeJsonApiDataFor } from "../kube-object"; import AbortController from "abort-controller"; -jest.mock("../api-manager"); - -const mockFetch = fetch as FetchMock; - -describe("forRemoteCluster", () => { - let apiManager: jest.Mocked; +describe("createKubeApiForRemoteCluster", () => { + let createKubeApiForRemoteCluster: CreateKubeApiForRemoteCluster; + let fetchMock: AsyncFnMock; beforeEach(() => { const di = getDiForUnitTesting({ doGeneralOverrides: true }); - apiManager = new ApiManager() as jest.Mocked; + fetchMock = asyncFn(); + di.override(fetchInjectable, () => fetchMock); - di.override(apiManagerInjectable, () => apiManager); + createKubeApiForRemoteCluster = di.inject(createKubeApiForRemoteClusterInjectable); }); it("builds api client for KubeObject", async () => { - const api = forRemoteCluster({ + const api = createKubeApiForRemoteCluster({ cluster: { server: "https://127.0.0.1:6443", }, @@ -44,232 +50,523 @@ describe("forRemoteCluster", () => { expect(api).toBeInstanceOf(KubeApi); }); - it("builds api client for given KubeApi", async () => { - const api = forRemoteCluster({ - cluster: { - server: "https://127.0.0.1:6443", - }, - user: { - token: "daa", - }, - }, Pod, PodApi); + describe("when building for remote cluster with specific constructor", () => { + let api: PodApi; - expect(api).toBeInstanceOf(PodApi); - }); - - it("calls right api endpoint", async () => { - const api = forRemoteCluster({ - cluster: { - server: "https://127.0.0.1:6443", - }, - user: { - token: "daa", - }, - }, Pod); - - mockFetch.mockResponse(async (request: any) => { - expect(request.url).toEqual("https://127.0.0.1:6443/api/v1/pods"); - - return { - body: "hello", - }; + beforeEach(() => { + api = createKubeApiForRemoteCluster({ + cluster: { + server: "https://127.0.0.1:6443", + }, + user: { + token: "daa", + }, + }, Pod, PodApi); }); - expect.hasAssertions(); + it("uses the constructor", () => { + expect(api).toBeInstanceOf(PodApi); + }); - await api.list(); + describe("when calling list without namespace", () => { + let listRequest: Promise; + + beforeEach(async () => { + listRequest = api.list(); + + // This is required because of how JS promises work + await flushPromises(); + }); + + it("should request pods from default namespace", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "https://127.0.0.1:6443/api/v1/pods", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when request resolves with data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["https://127.0.0.1:6443/api/v1/pods"], + new Response(JSON.stringify({ + kind: "PodList", + apiVersion: "v1", + metadata:{ + resourceVersion: "452899", + }, + items: [], + })), + ); + }); + + it("resolves the list call", async () => { + expect(await listRequest).toEqual([]); + }); + }); + }); }); }); describe("KubeApi", () => { let request: KubeJsonApi; - let apiManager: jest.Mocked; + let registerApiSpy: jest.SpiedFunction; + let fetchMock: AsyncFnMock; beforeEach(() => { const di = getDiForUnitTesting({ doGeneralOverrides: true }); - request = new KubeJsonApi({ + fetchMock = asyncFn(); + di.override(fetchInjectable, () => fetchMock); + + const createKubeJsonApi = di.inject(createKubeJsonApiInjectable); + + request = createKubeJsonApi({ serverAddress: `http://127.0.0.1:9999`, apiBase: "/api-kube", }); - apiManager = new ApiManager() as jest.Mocked; + registerApiSpy = jest.spyOn(di.inject(apiManagerInjectable), "registerApi"); - di.override(apiManagerInjectable, () => apiManager); di.inject(autoRegistrationInjectable); }); - it("uses url from apiBase if apiBase contains the resource", async () => { - mockFetch.mockResponse(async (request: any) => { - if (request.url === "http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1") { - return { - body: JSON.stringify({ - resources: [{ - name: "ingresses", - }], - }), - }; - } else if (request.url === "http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1") { - // Even if the old API contains ingresses, KubeApi should prefer the apiBase url - return { - body: JSON.stringify({ - resources: [{ - name: "ingresses", - }], - }), - }; - } else { - return { - body: JSON.stringify({ - resources: [], - }), - }; - } - }); + describe("on first call to IngressApi.get()", () => { + let ingressApi: IngressApi; + let getCall: Promise; - const apiBase = "/apis/networking.k8s.io/v1/ingresses"; - const fallbackApiBase = "/apis/extensions/v1beta1/ingresses"; - const kubeApi = new IngressApi({ - request, - objectConstructor: Ingress, - apiBase, - fallbackApiBases: [fallbackApiBase], - checkPreferredVersion: true, - }); - - await kubeApi.get({ - name: "foo", - namespace: "default", - }); - expect(kubeApi.apiPrefix).toEqual("/apis"); - expect(kubeApi.apiGroup).toEqual("networking.k8s.io"); - }); - - it("uses url from fallbackApiBases if apiBase lacks the resource", async () => { - mockFetch.mockResponse(async (request: any) => { - if (request.url === "http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1") { - return { - body: JSON.stringify({ - resources: [], - }), - }; - } else if (request.url === "http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1") { - return { - body: JSON.stringify({ - resources: [{ - name: "ingresses", - }], - }), - }; - } else { - return { - body: JSON.stringify({ - resources: [], - }), - }; - } - }); - - const apiBase = "apis/networking.k8s.io/v1/ingresses"; - const fallbackApiBase = "/apis/extensions/v1beta1/ingresses"; - const kubeApi = new IngressApi({ - request, - objectConstructor: Object.assign(KubeObject, { apiBase }), - kind: "Ingress", - fallbackApiBases: [fallbackApiBase], - checkPreferredVersion: true, - }); - - await kubeApi.get({ - name: "foo", - namespace: "default", - }); - expect(kubeApi.apiPrefix).toEqual("/apis"); - expect(kubeApi.apiGroup).toEqual("extensions"); - }); - - describe("checkPreferredVersion", () => { - it("registers with apiManager if checkPreferredVersion changes apiVersionPreferred", async () => { - expect.hasAssertions(); - - const api = new IngressApi({ + beforeEach(async () => { + ingressApi = new IngressApi({ + request, objectConstructor: Ingress, - checkPreferredVersion: true, + apiBase: "/apis/networking.k8s.io/v1/ingresses", fallbackApiBases: ["/apis/extensions/v1beta1/ingresses"], - request: { - get: jest.fn() - .mockImplementation((path: string) => { - switch (path) { - case "/apis/networking.k8s.io/v1": - throw new Error("no"); - case "/apis/extensions/v1beta1": - return { - resources: [ - { - name: "ingresses", - }, - ], - }; - case "/apis/extensions": - return { - preferredVersion: { - version: "v1beta1", - }, - }; - default: - throw new Error("unknown path"); - } - }), - } as Partial as KubeJsonApi, + checkPreferredVersion: true, + }); + getCall = ingressApi.get({ + name: "foo", + namespace: "default", }); - await (api as any).checkPreferredVersion(); - - expect(api.apiVersionPreferred).toBe("v1beta1"); - expect(apiManager.registerApi).toBeCalledWith(api); + // This is needed because of how JS promises work + await flushPromises(); }); - it("registers with apiManager if checkPreferredVersion changes apiVersionPreferred with non-grouped apis", async () => { - expect.hasAssertions(); + it("requests resources from the versioned api group from the initial apiBase", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); - const api = new PodApi({ - objectConstructor: Pod, - checkPreferredVersion: true, - fallbackApiBases: ["/api/v1beta1/pods"], - request: { - get: jest.fn() - .mockImplementation((path: string) => { - switch (path) { - case "/api/v1": - throw new Error("no"); - case "/api/v1beta1": - return { - resources: [ - { - name: "pods", - }, - ], - }; - case "/api": - return { - preferredVersion: { - version: "v1beta1", - }, - }; - default: - throw new Error("unknown path"); - } - }), - } as Partial as KubeJsonApi, + describe("when resource request fufills with a resource", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1"], + new Response(JSON.stringify({ + resources: [{ + name: "ingresses", + }], + })), + ); }); - await (api as any).checkPreferredVersion(); + it("requests the perferred version of that api group", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/networking.k8s.io", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); - expect(api.apiVersionPreferred).toBe("v1beta1"); - expect(apiManager.registerApi).toBeCalledWith(api); + describe("when the preferred version resolves with v1", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/networking.k8s.io"], + new Response(JSON.stringify({ + preferredVersion: { + version: "v1", + }, + })), + ); + }); + + it("makes the request to get the resource", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1/namespaces/default/ingresses/foo", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + it("sets fields in the api instance", () => { + expect(ingressApi).toEqual(expect.objectContaining({ + apiVersionPreferred: "v1", + apiPrefix: "/apis", + apiGroup: "networking.k8s.io", + })); + }); + + it("registers the api with the changes info", () => { + expect(registerApiSpy).toBeCalledWith(ingressApi); + }); + + describe("when the request resolves with no data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1/namespaces/default/ingresses/foo"], + new Response(JSON.stringify({})), + ); + result = await getCall; + }); + + it("results in the get call resolving to null", () => { + expect(result).toBeNull(); + }); + + describe("on the second call to IngressApi.get()", () => { + let getCall: Promise; + + beforeEach(async () => { + getCall = ingressApi.get({ + name: "foo1", + namespace: "default", + }); + + // This is needed because of how JS promises work + await flushPromises(); + }); + + it("makes the request to get the resource", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1/namespaces/default/ingresses/foo1", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with no data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1/namespaces/default/ingresses/foo1"], + new Response(JSON.stringify({})), + ); + result = await getCall; + }); + + it("results in the get call resolving to null", () => { + expect(result).toBeNull(); + }); + }); + }); + }); + + describe("when the request resolves with data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1/namespaces/default/ingresses/foo"], + new Response(JSON.stringify({ + apiVersion: "v1", + kind: "Ingress", + metadata: { + name: "foo", + namespace: "default", + resourceVersion: "1", + uid: "12345", + }, + })), + ); + result = await getCall; + }); + + it("results in the get call resolving to an instance", () => { + expect(result).toBeInstanceOf(Ingress); + }); + + describe("on the second call to IngressApi.get()", () => { + let getCall: Promise; + + beforeEach(async () => { + getCall = ingressApi.get({ + name: "foo1", + namespace: "default", + }); + + // This is needed because of how JS promises work + await flushPromises(); + }); + + it("makes the request to get the resource", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1/namespaces/default/ingresses/foo1", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with no data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1/namespaces/default/ingresses/foo1"], + new Response(JSON.stringify({})), + ); + result = await getCall; + }); + + it("results in the get call resolving to null", () => { + expect(result).toBeNull(); + }); + }); + }); + }); + }); + }); + + describe("when resource request fufills with no resource", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/networking.k8s.io/v1"], + new Response(JSON.stringify({ + resources: [], + })), + ); + }); + + it("requests the resources from the base api url from the fallback api", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when resource request fufills with a resource", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1"], + new Response(JSON.stringify({ + resources: [{ + name: "ingresses", + }], + })), + ); + }); + + it("requests the preferred version for that api group", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/extensions", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the preferred version request resolves to v1beta1", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/extensions"], + new Response(JSON.stringify({ + preferredVersion: { + version: "v1beta1", + }, + })), + ); + }); + + it("makes the request to get the resource", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1/namespaces/default/ingresses/foo", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + it("sets fields in the api instance", () => { + expect(ingressApi).toEqual(expect.objectContaining({ + apiVersionPreferred: "v1beta1", + apiPrefix: "/apis", + apiGroup: "extensions", + })); + }); + + it("registers the api with the changes info", () => { + expect(registerApiSpy).toBeCalledWith(ingressApi); + }); + + describe("when the request resolves with no data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1/namespaces/default/ingresses/foo"], + new Response(JSON.stringify({})), + ); + result = await getCall; + }); + + it("results in the get call resolving to null", () => { + expect(result).toBeNull(); + }); + + describe("on the second call to IngressApi.get()", () => { + let getCall: Promise; + + beforeEach(async () => { + getCall = ingressApi.get({ + name: "foo1", + namespace: "default", + }); + + // This is needed because of how JS promises work + await flushPromises(); + }); + + it("makes the request to get the resource", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1/namespaces/default/ingresses/foo1", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with no data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1/namespaces/default/ingresses/foo1"], + new Response(JSON.stringify({})), + ); + result = await getCall; + }); + + it("results in the get call resolving to null", () => { + expect(result).toBeNull(); + }); + }); + }); + }); + + describe("when the request resolves with data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1/namespaces/default/ingresses/foo"], + new Response(JSON.stringify({ + apiVersion: "v1beta1", + kind: "Ingress", + metadata: { + name: "foo", + namespace: "default", + resourceVersion: "1", + uid: "12345", + }, + })), + ); + result = await getCall; + }); + + it("results in the get call resolving to an instance", () => { + expect(result).toBeInstanceOf(Ingress); + }); + + describe("on the second call to IngressApi.get()", () => { + let getCall: Promise; + + beforeEach(async () => { + getCall = ingressApi.get({ + name: "foo1", + namespace: "default", + }); + + // This is needed because of how JS promises work + await flushPromises(); + }); + + it("makes the request to get the resource", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1/namespaces/default/ingresses/foo1", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with no data", () => { + let result: Ingress | null; + + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/extensions/v1beta1/namespaces/default/ingresses/foo1"], + new Response(JSON.stringify({})), + ); + result = await getCall; + }); + + it("results in the get call resolving to null", () => { + expect(result).toBeNull(); + }); + }); + }); + }); + }); + }); }); }); - describe("patch", () => { + describe("patching deployments", () => { let api: DeploymentApi; beforeEach(() => { @@ -278,140 +575,377 @@ describe("KubeApi", () => { }); }); - it("sends strategic patch by default", async () => { - expect.hasAssertions(); + describe("when patching a resource without providing a strategy", () => { + let patchRequest: Promise; - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("PATCH"); - expect(request.headers.get("content-type")).toMatch("strategic-merge-patch"); - expect(request.body?.toString()).toEqual(JSON.stringify({ spec: { replicas: 2 }})); + beforeEach(async () => { + patchRequest = api.patch({ name: "test", namespace: "default" }, { + spec: { replicas: 2 }, + }); - return {}; + // This is needed because of how JS promises work + await flushPromises(); }); - await api.patch({ name: "test", namespace: "default" }, { - spec: { replicas: 2 }, + it("requests a patch using strategic merge", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/apps/v1/namespaces/default/deployments/test", + { + headers: { + "content-type": "application/strategic-merge-patch+json", + }, + method: "patch", + body: JSON.stringify({ spec: { replicas: 2 }}), + }, + ]); + }); + + describe("when the patch request resolves with data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/apps/v1/namespaces/default/deployments/test"], + new Response(JSON.stringify({ + apiVersion: "v1", + kind: "Deployment", + metadata: { + name: "test", + namespace: "default", + resourceVersion: "1", + uid: "12345", + }, + spec: { + replicas: 2, + }, + })), + ); + }); + + it("resolves the patch call", async () => { + expect(await patchRequest).toBeInstanceOf(Deployment); + }); }); }); - it("allows to use merge patch", async () => { - expect.hasAssertions(); + describe("when patching a resource using json patch", () => { + let patchRequest: Promise; - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("PATCH"); - expect(request.headers.get("content-type")).toMatch("merge-patch"); - expect(request.body?.toString()).toEqual(JSON.stringify({ spec: { replicas: 2 }})); + beforeEach(async () => { + patchRequest = api.patch({ name: "test", namespace: "default" }, [ + { op: "replace", path: "/spec/replicas", value: 2 }, + ], "json"); - return {}; + // This is needed because of how JS promises work + await flushPromises(); }); - await api.patch({ name: "test", namespace: "default" }, { - spec: { replicas: 2 }, - }, "merge"); + it("requests a patch using json merge", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/apps/v1/namespaces/default/deployments/test", + { + headers: { + "content-type": "application/json-patch+json", + }, + method: "patch", + body: JSON.stringify([ + { op: "replace", path: "/spec/replicas", value: 2 }, + ]), + }, + ]); + }); + + describe("when the patch request resolves with data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/apps/v1/namespaces/default/deployments/test"], + new Response(JSON.stringify({ + apiVersion: "v1", + kind: "Deployment", + metadata: { + name: "test", + namespace: "default", + resourceVersion: "1", + uid: "12345", + }, + spec: { + replicas: 2, + }, + })), + ); + }); + + it("resolves the patch call", async () => { + expect(await patchRequest).toBeInstanceOf(Deployment); + }); + }); }); - it("allows to use json patch", async () => { - expect.hasAssertions(); + describe("when patching a resource using merge patch", () => { + let patchRequest: Promise; - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("PATCH"); - expect(request.headers.get("content-type")).toMatch("json-patch"); - expect(request.body?.toString()).toEqual(JSON.stringify([{ op: "replace", path: "/spec/replicas", value: 2 }])); + beforeEach(async () => { + patchRequest = api.patch( + { name: "test", namespace: "default" }, + { metadata: { annotations: { provisioned: "True" }}}, + "merge", + ); - return {}; + // This is needed because of how JS promises work + await flushPromises(); }); - await api.patch({ name: "test", namespace: "default" }, [ - { op: "replace", path: "/spec/replicas", value: 2 }, - ], "json"); - }); - - it("allows deep partial patch", async () => { - expect.hasAssertions(); - - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("PATCH"); - expect(request.headers.get("content-type")).toMatch("merge-patch"); - expect(request.body?.toString()).toEqual(JSON.stringify({ metadata: { annotations: { provisioned: "true" }}})); - - return {}; + it("requests a patch using json merge", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/apis/apps/v1/namespaces/default/deployments/test", + { + headers: { + "content-type": "application/merge-patch+json", + }, + method: "patch", + body: JSON.stringify({ metadata: { annotations: { provisioned: "True" }}}), + }, + ]); }); - await api.patch( - { name: "test", namespace: "default" }, - { metadata: { annotations: { provisioned: "true" }}}, - "merge", - ); + describe("when the patch request resolves with data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/apis/apps/v1/namespaces/default/deployments/test"], + new Response(JSON.stringify({ + apiVersion: "v1", + kind: "Deployment", + metadata: { + name: "test", + namespace: "default", + resourceVersion: "1", + uid: "12345", + annotations: { + provisioned: "True", + }, + }, + })), + ); + }); + + it("resolves the patch call", async () => { + expect(await patchRequest).toBeInstanceOf(Deployment); + }); + }); }); }); - describe("delete", () => { + describe("deleting pods (namespace scoped resource)", () => { let api: PodApi; beforeEach(() => { api = new PodApi({ request, - objectConstructor: Pod, }); }); - it("sends correct request with empty namespace", async () => { - expect.hasAssertions(); - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("DELETE"); - expect(request.url).toEqual("http://127.0.0.1:9999/api-kube/api/v1/pods/foo?propagationPolicy=Background"); + describe("when deleting by just name", () => { + let deleteRequest: Promise; - return {}; + beforeEach(async () => { + deleteRequest = api.delete({ name: "foo" }); + + // This is required for how JS promises work + await flushPromises(); }); - await api.delete({ name: "foo", namespace: "" }); + it("requests deleting pod in default namespace", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods/foo?propagationPolicy=Background", + { + headers: { + "content-type": "application/json", + }, + method: "delete", + }, + ]); + }); + + describe("when request resolves", () => { + beforeEach(async () => { + fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods/foo?propagationPolicy=Background"], + new Response("{}"), + ); + }); + + it("resolves the call", async () => { + expect(await deleteRequest).toBeDefined(); + }); + }); }); - it("sends correct request without namespace", async () => { - expect.hasAssertions(); - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("DELETE"); - expect(request.url).toEqual("http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods/foo?propagationPolicy=Background"); + describe("when deleting by name and empty namespace", () => { + let deleteRequest: Promise; - return {}; + beforeEach(async () => { + deleteRequest = api.delete({ name: "foo", namespace: "" }); + + // This is required for how JS promises work + await flushPromises(); }); - await api.delete({ name: "foo" }); + it("requests deleting pod in default namespace", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods/foo?propagationPolicy=Background", + { + headers: { + "content-type": "application/json", + }, + method: "delete", + }, + ]); + }); + + describe("when request resolves", () => { + beforeEach(async () => { + fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods/foo?propagationPolicy=Background"], + new Response("{}"), + ); + }); + + it("resolves the call", async () => { + expect(await deleteRequest).toBeDefined(); + }); + }); }); - it("sends correct request with namespace", async () => { - expect.hasAssertions(); - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("DELETE"); - expect(request.url).toEqual("http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods/foo?propagationPolicy=Background"); + describe("when deleting by name and namespace", () => { + let deleteRequest: Promise; - return {}; + beforeEach(async () => { + deleteRequest = api.delete({ name: "foo", namespace: "test" }); + + // This is required for how JS promises work + await flushPromises(); }); - await api.delete({ name: "foo", namespace: "kube-system" }); - }); - - it("allows to change propagationPolicy", async () => { - expect.hasAssertions(); - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("DELETE"); - expect(request.url).toMatch("propagationPolicy=Orphan"); - - return {}; + it("requests deleting pod in given namespace", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/test/pods/foo?propagationPolicy=Background", + { + headers: { + "content-type": "application/json", + }, + method: "delete", + }, + ]); }); - await api.delete({ name: "foo", namespace: "default", propagationPolicy: "Orphan" }); + describe("when request resolves", () => { + beforeEach(async () => { + fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/test/pods/foo?propagationPolicy=Background"], + new Response("{}"), + ); + }); + + it("resolves the call", async () => { + expect(await deleteRequest).toBeDefined(); + }); + }); }); }); - describe("watch", () => { + describe("deleting namespaces (cluser scoped resource)", () => { + let api: NamespaceApi; + + beforeEach(() => { + api = new NamespaceApi({ + request, + }); + }); + + describe("when deleting by just name", () => { + let deleteRequest: Promise; + + beforeEach(async () => { + deleteRequest = api.delete({ name: "foo" }); + + // This is required for how JS promises work + await flushPromises(); + }); + + it("requests deleting Namespace without namespace", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/foo?propagationPolicy=Background", + { + headers: { + "content-type": "application/json", + }, + method: "delete", + }, + ]); + }); + + describe("when request resolves", () => { + beforeEach(async () => { + fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/foo?propagationPolicy=Background"], + new Response("{}"), + ); + }); + + it("resolves the call", async () => { + expect(await deleteRequest).toBeDefined(); + }); + }); + }); + + describe("when deleting by name and empty namespace", () => { + let deleteRequest: Promise; + + beforeEach(async () => { + deleteRequest = api.delete({ name: "foo", namespace: "" }); + + // This is required for how JS promises work + await flushPromises(); + }); + + it("requests deleting Namespace without namespace", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/foo?propagationPolicy=Background", + { + headers: { + "content-type": "application/json", + }, + method: "delete", + }, + ]); + }); + + describe("when request resolves", () => { + beforeEach(async () => { + fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/foo?propagationPolicy=Background"], + new Response("{}"), + ); + }); + + it("resolves the call", async () => { + expect(await deleteRequest).toBeDefined(); + }); + }); + }); + + describe("when deleting by name and namespace", () => { + it("rejects request", () => { + expect(api.delete({ name: "foo", namespace: "test" })).rejects.toBeDefined(); + }); + }); + }); + + describe("watching pods", () => { let api: PodApi; let stream: PassThrough; beforeEach(() => { api = new PodApi({ request, - objectConstructor: Pod, }); stream = new PassThrough(); }); @@ -421,184 +955,341 @@ describe("KubeApi", () => { stream.destroy(); }); - it("sends a valid watch request", () => { - const spy = jest.spyOn(request, "getResponse"); + describe("when watching in a namespace", () => { + let stopWatch: () => void; + let callback: jest.MockedFunction; - mockFetch.mockResponse(async () => { - return { - // needed for https://github.com/jefflau/jest-fetch-mock/issues/218 - body: stream as unknown as string, - }; + beforeEach(async () => { + callback = jest.fn(); + stopWatch = api.watch({ + namespace: "kube-system", + callback, + }); + + await flushPromises(); }); - api.watch({ namespace: "kube-system" }); - expect(spy).toHaveBeenCalledWith("/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=", expect.anything(), expect.anything()); + it("requests the watch", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with a stream", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ([url, init]) => { + const isMatch = url === "http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion="; + + if (isMatch) { + init?.signal?.addEventListener("abort", () => { + stream.destroy(); + }); + } + + return isMatch; + }, + new Response(stream), + ); + }); + + describe("when some data comes back on the stream", () => { + beforeEach(() => { + stream.emit("data", `${JSON.stringify({ + type: "ADDED", + object: { + apiVersion: "v1", + kind: "Pod", + metadata: { + name: "foobar", + namespace: "kube-system", + resourceVersion: "1", + uid: "123456", + }, + }, + } as IKubeWatchEvent>)}\n`); + }); + + it("calls the callback with the data", () => { + expect(callback).toBeCalledWith( + { + type: "ADDED", + object: { + apiVersion: "v1", + kind: "Pod", + metadata: { + name: "foobar", + namespace: "kube-system", + resourceVersion: "1", + selfLink: "/api/v1/namespaces/kube-system/pods/foobar", + uid: "123456", + }, + }, + }, + null, + ); + }); + + describe("when stopping the watch", () => { + beforeEach(() => { + stopWatch(); + }); + + it("closes the stream", () => { + expect(stream.destroyed).toBe(true); + }); + }); + }); + }); }); - it("sends timeout as a query parameter", async () => { - const spy = jest.spyOn(request, "getResponse"); + describe("when watching in a namespace with an abort controller provided", () => { + let callback: jest.MockedFunction; + let abortController: AbortController; - mockFetch.mockResponse(async () => { - return { - // needed for https://github.com/jefflau/jest-fetch-mock/issues/218 - body: stream as unknown as string, - }; + beforeEach(async () => { + callback = jest.fn(); + abortController = new AbortController(); + api.watch({ + namespace: "kube-system", + callback, + abortController, + }); + + await flushPromises(); }); - api.watch({ namespace: "kube-system", timeout: 60 }); - expect(spy).toHaveBeenCalledWith("/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=", { query: { timeoutSeconds: 60 }}, expect.anything()); + it("requests the watch", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with a stream", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ([url, init]) => { + const isMatch = url === "http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion="; + + if (isMatch) { + init?.signal?.addEventListener("abort", () => { + stream.destroy(); + }); + } + + return isMatch; + }, + new Response(stream), + ); + }); + + describe("when some data comes back on the stream", () => { + beforeEach(() => { + stream.emit("data", `${JSON.stringify({ + type: "ADDED", + object: { + apiVersion: "v1", + kind: "Pod", + metadata: { + name: "foobar", + namespace: "kube-system", + resourceVersion: "1", + uid: "123456", + }, + }, + } as IKubeWatchEvent>)}\n`); + }); + + it("calls the callback with the data", () => { + expect(callback).toBeCalledWith( + { + type: "ADDED", + object: { + apiVersion: "v1", + kind: "Pod", + metadata: { + name: "foobar", + namespace: "kube-system", + resourceVersion: "1", + selfLink: "/api/v1/namespaces/kube-system/pods/foobar", + uid: "123456", + }, + }, + }, + null, + ); + }); + + describe("when stopping the watch via the controller", () => { + beforeEach(() => { + abortController.abort(); + }); + + it("closes the stream", () => { + expect(stream.destroyed).toBe(true); + }); + }); + }); + }); }); - it("aborts watch using abortController", (done) => { - const spy = jest.spyOn(request, "getResponse"); + describe("when watching in a namespace with a timeout", () => { + let stopWatch: () => void; + let callback: jest.MockedFunction; - mockFetch.mockResponse(async request => { - request.signal.addEventListener("abort", () => { - done(); - }); - - return { - // needed for https://github.com/jefflau/jest-fetch-mock/issues/218 - body: stream as unknown as string, - }; - }); - - const abortController = new AbortController(); - - api.watch({ - namespace: "kube-system", - timeout: 60, - abortController, - }); - - expect(spy).toHaveBeenCalledWith("/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=", { query: { timeoutSeconds: 60 }}, expect.anything()); - delay(100).then(() => abortController.abort()); - }); - - describe("retries", () => { - it("if request ended", (done) => { - const spy = jest.spyOn(request, "getResponse"); - - jest.spyOn(stream, "on").mockImplementation((event: string | symbol, callback: Function) => { - // End the request in 100ms. - if (event === "end") { - setTimeout(() => { - callback(); - }, 100); - } - - return stream; - }); - - // we need to mock using jest as jest-fetch-mock doesn't support mocking the body completely - jest.spyOn(global, "fetch").mockImplementation(async () => { - return { - ok: true, - body: stream as never, - } as Partial as Response; - }); - - api.watch({ + beforeEach(async () => { + callback = jest.fn(); + stopWatch = api.watch({ namespace: "kube-system", + callback, + timeout: 60, }); - expect(spy).toHaveBeenCalledTimes(1); - - setTimeout(() => { - expect(spy).toHaveBeenCalledTimes(2); - done(); - }, 2000); + await flushPromises(); }); - it("if request not closed after timeout", (done) => { - const spy = jest.spyOn(request, "getResponse"); - - mockFetch.mockResponse(async () => { - return { - // needed for https://github.com/jefflau/jest-fetch-mock/issues/218 - body: stream as unknown as string, - }; - }); - - const timeoutSeconds = 1; - - api.watch({ - namespace: "kube-system", - timeout: timeoutSeconds, - }); - - expect(spy).toHaveBeenCalledTimes(1); - - setTimeout(() => { - expect(spy).toHaveBeenCalledTimes(2); - done(); - }, timeoutSeconds * 1000 * 1.2); + it("requests the watch", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=&timeoutSeconds=60", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); }); - it("retries only once if request ends and timeout is set", (done) => { - const spy = jest.spyOn(request, "getResponse"); + describe("when the request resolves with a stream", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ([url, init]) => { + const isMatch = url === "http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=&timeoutSeconds=60"; - jest.spyOn(stream, "on").mockImplementation((event: string | symbol, callback: Function) => { - // End the request in 100ms. - if (event === "end") { - setTimeout(() => { - callback(); - }, 100); - } + if (isMatch) { + init?.signal?.addEventListener("abort", () => { + stream.destroy(); + }); + } - return stream; + return isMatch; + }, + new Response(stream), + ); }); - // we need to mock using jest as jest-fetch-mock doesn't support mocking the body completely - jest.spyOn(global, "fetch").mockImplementation(async () => { - return { - ok: true, - body: stream as never, - } as Partial as Response; + describe("when some data comes back on the stream", () => { + beforeEach(() => { + stream.emit("data", `${JSON.stringify({ + type: "ADDED", + object: { + apiVersion: "v1", + kind: "Pod", + metadata: { + name: "foobar", + namespace: "kube-system", + resourceVersion: "1", + uid: "123456", + }, + }, + } as IKubeWatchEvent>)}\n`); + }); + + it("calls the callback with the data", () => { + expect(callback).toBeCalledWith( + { + type: "ADDED", + object: { + apiVersion: "v1", + kind: "Pod", + metadata: { + name: "foobar", + namespace: "kube-system", + resourceVersion: "1", + selfLink: "/api/v1/namespaces/kube-system/pods/foobar", + uid: "123456", + }, + }, + }, + null, + ); + }); + + describe("when stopping the watch", () => { + beforeEach(() => { + stopWatch(); + }); + + it("closes the stream", () => { + expect(stream.destroyed).toBe(true); + }); + }); + + describe("when the watch ends", () => { + beforeEach(() => { + stream.end(); + }); + + it("requests a new watch", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/kube-system/pods?watch=1&resourceVersion=&timeoutSeconds=60", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when stopping the watch", () => { + beforeEach(() => { + stopWatch(); + }); + + it("closes the stream", () => { + expect(stream.destroyed).toBe(true); + }); + }); + }); }); - - const timeoutSeconds = 0.5; - - api.watch({ - namespace: "kube-system", - timeout: timeoutSeconds, - }); - - expect(spy).toHaveBeenCalledTimes(1); - - setTimeout(() => { - expect(spy).toHaveBeenCalledTimes(2); - done(); - }, 2000); - }); - - afterEach(() => { - jest.clearAllMocks(); }); }); }); - describe("create", () => { + describe("creating pods", () => { let api: PodApi; beforeEach(() => { api = new PodApi({ request, - objectConstructor: Pod, }); }); - it("should add kind and apiVersion", async () => { - expect.hasAssertions(); + describe("when creating a pod", () => { + let createRequest: Promise; - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("POST"); - expect(JSON.parse(String(request.body))).toEqual({ - kind: "Pod", - apiVersion: "v1", + beforeEach(async () => { + createRequest = api.create({ + name: "foobar", + namespace: "default", + }, { metadata: { - name: "foobar", - namespace: "default", + labels: { + foo: "bar", + }, }, spec: { containers: [ @@ -617,101 +1308,324 @@ describe("KubeApi", () => { }, }); - return {}; + // This is required because of how JS promises work + await flushPromises(); }); - await api.create({ - name: "foobar", - namespace: "default", - }, { - spec: { - containers: [ - { - name: "web", - image: "nginx", - ports: [ - { - name: "web", - containerPort: 80, - protocol: "TCP", + it("should request to create a pod with full descriptor", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods", + { + headers: { + "content-type": "application/json", + }, + method: "post", + body: JSON.stringify({ + metadata: { + labels: { + foo: "bar", }, - ], - }, - ], - }, - }); - }); - - it("doesn't override metadata.labels", async () => { - expect.hasAssertions(); - - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("POST"); - expect(JSON.parse(String(request.body))).toEqual({ - kind: "Pod", - apiVersion: "v1", - metadata: { - name: "foobar", - namespace: "default", - labels: { - foo: "bar", - }, + name: "foobar", + namespace: "default", + }, + spec: { + containers: [{ + name: "web", + image: "nginx", + ports: [{ + name: "web", + containerPort: 80, + protocol: "TCP", + }], + }], + }, + kind: "Pod", + apiVersion: "v1", + }), }, + ]); + }); + + describe("when request resolves with data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods"], + new Response(JSON.stringify({ + kind: "Pod", + apiVersion: "v1", + metadata: { + name: "foobar", + namespace: "default", + labels: { + foo: "bar", + }, + resourceVersion: "1", + uid: "123456798", + }, + spec: { + containers: [{ + name: "web", + image: "nginx", + ports: [{ + name: "web", + containerPort: 80, + protocol: "TCP", + }], + }], + }, + })), + ); }); - return {}; - }); - - await api.create({ - name: "foobar", - namespace: "default", - }, { - metadata: { - labels: { - foo: "bar", - }, - }, + it("call should resolve in a Pod instance", async () => { + expect(await createRequest).toBeInstanceOf(Pod); + }); }); }); }); - describe("update", () => { + describe("updating pods", () => { let api: PodApi; beforeEach(() => { api = new PodApi({ request, - objectConstructor: Pod, }); }); - it("doesn't override metadata.labels", async () => { - expect.hasAssertions(); + describe("when updating a pod", () => { + let updateRequest: Promise; - mockFetch.mockResponse(async request => { - expect(request.method).toEqual("PUT"); - expect(JSON.parse(String(request.body))).toEqual({ + beforeEach(async () => { + updateRequest = api.update({ + name: "foobar", + namespace: "default", + }, { + kind: "Pod", + apiVersion: "v1", metadata: { - name: "foobar", - namespace: "default", labels: { foo: "bar", }, }, + spec: { + containers: [{ + name: "web", + image: "nginx", + ports: [{ + name: "web", + containerPort: 80, + protocol: "TCP", + }], + }], + }, }); - return {}; + await flushPromises(); }); - await api.update({ - name: "foobar", - namespace: "default", - }, { - metadata: { - labels: { - foo: "bar", + it("should request that the pod is updated", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods/foobar", + { + headers: { + "content-type": "application/json", + }, + method: "put", + body: JSON.stringify({ + kind: "Pod", + apiVersion: "v1", + metadata: { + labels: { + foo: "bar", + }, + name: "foobar", + namespace: "default", + }, + spec: { + containers: [{ + name: "web", + image: "nginx", + ports: [{ + name: "web", + containerPort: 80, + protocol: "TCP", + }], + }], + }, + }), }, - }, + ]); + }); + + describe("when the request resolves with data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods/foobar"], + new Response(JSON.stringify({ + kind: "Pod", + apiVersion: "v1", + metadata: { + name: "foobar", + namespace: "default", + labels: { + foo: "bar", + }, + resourceVersion: "1", + uid: "123456798", + }, + spec: { + containers: [{ + name: "web", + image: "nginx", + ports: [{ + name: "web", + containerPort: 80, + protocol: "TCP", + }], + }], + }, + })), + ); + }); + + it("the call should resolve to a Pod", async () => { + expect(await updateRequest).toBeInstanceOf(Pod); + }); + }); + }); + }); + + describe("listing pods", () => { + let api: PodApi; + + beforeEach(() => { + api = new PodApi({ + request, + }); + }); + + describe("when listing pods with no descriptor", () => { + let listRequest: Promise; + + beforeEach(async () => { + listRequest = api.list(); + + await flushPromises(); + }); + + it("should request that the pods from all namespaces", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/pods", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with empty data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/pods"], + new Response(JSON.stringify({ + kind: "PodList", + apiVersion: "v1", + metadata: {}, + items: [], + })), + ); + }); + + it("the call should resolve to an empty list", async () => { + expect(await listRequest).toEqual([]); + }); + }); + }); + + describe("when listing pods with descriptor with namespace=''", () => { + let listRequest: Promise; + + beforeEach(async () => { + listRequest = api.list({ + namespace: "", + }); + + await flushPromises(); + }); + + it("should request that the pods from all namespaces", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/pods", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with empty data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/pods"], + new Response(JSON.stringify({ + kind: "PodList", + apiVersion: "v1", + metadata: {}, + items: [], + })), + ); + }); + + it("the call should resolve to an empty list", async () => { + expect(await listRequest).toEqual([]); + }); + }); + }); + + describe("when listing pods with descriptor with namespace='default'", () => { + let listRequest: Promise; + + beforeEach(async () => { + listRequest = api.list({ + namespace: "default", + }); + + await flushPromises(); + }); + + it("should request that the pods from just the default namespace", () => { + expect(fetchMock.mock.lastCall).toMatchObject([ + "http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods", + { + headers: { + "content-type": "application/json", + }, + method: "get", + }, + ]); + }); + + describe("when the request resolves with empty data", () => { + beforeEach(async () => { + await fetchMock.resolveSpecific( + ["http://127.0.0.1:9999/api-kube/api/v1/namespaces/default/pods"], + new Response(JSON.stringify({ + kind: "PodList", + apiVersion: "v1", + metadata: {}, + items: [], + })), + ); + }); + + it("the call should resolve to an empty list", async () => { + expect(await listRequest).toEqual([]); + }); }); }); }); diff --git a/src/common/k8s-api/api-base.ts b/src/common/k8s-api/api-base.ts index e511dd8454..9544e4f60c 100644 --- a/src/common/k8s-api/api-base.ts +++ b/src/common/k8s-api/api-base.ts @@ -3,38 +3,9 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import { JsonApi } from "./json-api"; -import { apiPrefix, isDebugging, isDevelopment } from "../vars"; -import { appEventBus } from "../app-event-bus/event-bus"; +import type { JsonApi } from "./json-api"; +import { getInjectionToken } from "@ogre-tools/injectable"; -export let apiBase: JsonApi; - -if (typeof window === "undefined") { - appEventBus.addListener((event) => { - if (event.name !== "lens-proxy" && event.action !== "listen") return; - - const params = event.params as { port?: number }; - - if (!params.port) return; - - apiBase = new JsonApi({ - serverAddress: `http://127.0.0.1:${params.port}`, - apiBase: apiPrefix, - debug: isDevelopment || isDebugging, - }, { - headers: { - "Host": `localhost:${params.port}`, - }, - }); - }); -} else { - apiBase = new JsonApi({ - serverAddress: `http://127.0.0.1:${window.location.port}`, - apiBase: apiPrefix, - debug: isDevelopment || isDebugging, - }, { - headers: { - "Host": window.location.host, - }, - }); -} +export const apiBaseInjectionToken = getInjectionToken({ + id: "api-base-token", +}); diff --git a/src/common/k8s-api/api-kube.ts b/src/common/k8s-api/api-kube.ts index 4154ec2f00..58aa95208a 100644 --- a/src/common/k8s-api/api-kube.ts +++ b/src/common/k8s-api/api-kube.ts @@ -4,11 +4,8 @@ */ import { getInjectionToken } from "@ogre-tools/injectable"; -import { asLegacyGlobalForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/as-legacy-global-object-for-extension-api"; import type { KubeJsonApi } from "./kube-json-api"; export const apiKubeInjectionToken = getInjectionToken({ id: "api-kube-injection-token", }); - -export const apiKube = asLegacyGlobalForExtensionApi(apiKubeInjectionToken); diff --git a/src/common/k8s-api/create-json-api.injectable.ts b/src/common/k8s-api/create-json-api.injectable.ts new file mode 100644 index 0000000000..aa05a5c157 --- /dev/null +++ b/src/common/k8s-api/create-json-api.injectable.ts @@ -0,0 +1,26 @@ +/** + * 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 type { RequestInit } from "node-fetch"; +import fetchInjectable from "../fetch/fetch.injectable"; +import loggerInjectable from "../logger.injectable"; +import type { JsonApiConfig, JsonApiData, JsonApiDependencies, JsonApiParams } from "./json-api"; +import { JsonApi } from "./json-api"; + +export type CreateJsonApi = = JsonApiParams>(config: JsonApiConfig, reqInit?: RequestInit) => JsonApi; + +const createJsonApiInjectable = getInjectable({ + id: "create-json-api", + instantiate: (di): CreateJsonApi => { + const deps: JsonApiDependencies = { + fetch: di.inject(fetchInjectable), + logger: di.inject(loggerInjectable), + }; + + return (config, reqInit) => new JsonApi(deps, config, reqInit); + }, +}); + +export default createJsonApiInjectable; diff --git a/src/common/k8s-api/create-kube-api-for-cluster.injectable.ts b/src/common/k8s-api/create-kube-api-for-cluster.injectable.ts new file mode 100644 index 0000000000..e7509dcbc7 --- /dev/null +++ b/src/common/k8s-api/create-kube-api-for-cluster.injectable.ts @@ -0,0 +1,63 @@ +/** + * 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 { apiKubePrefix } from "../vars"; +import isDevelopmentInjectable from "../vars/is-development.injectable"; +import { apiBaseInjectionToken } from "./api-base"; +import createKubeJsonApiInjectable from "./create-kube-json-api.injectable"; +import type { KubeApiOptions } from "./kube-api"; +import { KubeApi } from "./kube-api"; +import type { KubeJsonApiDataFor, KubeObject, KubeObjectConstructor } from "./kube-object"; + +export interface CreateKubeApiForLocalClusterConfig { + metadata: { + uid: string; + }; +} + +export interface CreateKubeApiForCluster { + , Data extends KubeJsonApiDataFor>( + cluster: CreateKubeApiForLocalClusterConfig, + kubeClass: KubeObjectConstructor, + apiClass: new (apiOpts: KubeApiOptions) => Api + ): Api; + >( + cluster: CreateKubeApiForLocalClusterConfig, + kubeClass: KubeObjectConstructor, + apiClass?: new (apiOpts: KubeApiOptions) => KubeApi + ): KubeApi; +} + +const createKubeApiForClusterInjectable = getInjectable({ + id: "create-kube-api-for-cluster", + instantiate: (di): CreateKubeApiForCluster => { + const apiBase = di.inject(apiBaseInjectionToken); + const isDevelopment = di.inject(isDevelopmentInjectable); + const createKubeJsonApi = di.inject(createKubeJsonApiInjectable); + + return ( + cluster: CreateKubeApiForLocalClusterConfig, + kubeClass: KubeObjectConstructor>, + apiClass = KubeApi, + ) => ( + new apiClass({ + objectConstructor: kubeClass, + request: createKubeJsonApi( + { + serverAddress: apiBase.config.serverAddress, + apiBase: apiKubePrefix, + debug: isDevelopment, + }, { + headers: { + "Host": `${cluster.metadata.uid}.localhost:${new URL(apiBase.config.serverAddress).port}`, + }, + }, + ), + }) + ); + }, +}); + +export default createKubeApiForClusterInjectable; diff --git a/src/common/k8s-api/create-kube-api-for-remote-cluster.injectable.ts b/src/common/k8s-api/create-kube-api-for-remote-cluster.injectable.ts new file mode 100644 index 0000000000..d11b7ae34b --- /dev/null +++ b/src/common/k8s-api/create-kube-api-for-remote-cluster.injectable.ts @@ -0,0 +1,104 @@ +/** + * 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 type { AgentOptions } from "https"; +import { Agent } from "https"; +import type { RequestInit } from "node-fetch"; +import isDevelopmentInjectable from "../vars/is-development.injectable"; +import createKubeJsonApiInjectable from "./create-kube-json-api.injectable"; +import type { KubeApiOptions } from "./kube-api"; +import { KubeApi } from "./kube-api"; +import type { KubeJsonApiDataFor, KubeObject, KubeObjectConstructor } from "./kube-object"; + +export interface CreateKubeApiForRemoteClusterConfig { + cluster: { + server: string; + caData?: string; + skipTLSVerify?: boolean; + }; + user: { + token?: string | (() => Promise); + clientCertificateData?: string; + clientKeyData?: string; + }; + /** + * Custom instance of https.agent to use for the requests + * + * @remarks the custom agent replaced default agent, options skipTLSVerify, + * clientCertificateData, clientKeyData and caData are ignored. + */ + agent?: Agent; +} + +export interface CreateKubeApiForRemoteCluster { + , Data extends KubeJsonApiDataFor>( + config: CreateKubeApiForRemoteClusterConfig, + kubeClass: KubeObjectConstructor, + apiClass: new (apiOpts: KubeApiOptions) => Api, + ): Api; + >( + config: CreateKubeApiForRemoteClusterConfig, + kubeClass: KubeObjectConstructor, + apiClass?: new (apiOpts: KubeApiOptions) => KubeApi, + ): KubeApi; +} + +const createKubeApiForRemoteClusterInjectable = getInjectable({ + id: "create-kube-api-for-remote-cluster", + instantiate: (di): CreateKubeApiForRemoteCluster => { + const isDevelopment = di.inject(isDevelopmentInjectable); + const createKubeJsonApi = di.inject(createKubeJsonApiInjectable); + + return (config: CreateKubeApiForRemoteClusterConfig, kubeClass: KubeObjectConstructor>, apiClass = KubeApi) => { + const reqInit: RequestInit = {}; + const agentOptions: AgentOptions = {}; + + if (config.cluster.skipTLSVerify === true) { + agentOptions.rejectUnauthorized = false; + } + + if (config.user.clientCertificateData) { + agentOptions.cert = config.user.clientCertificateData; + } + + if (config.user.clientKeyData) { + agentOptions.key = config.user.clientKeyData; + } + + if (config.cluster.caData) { + agentOptions.ca = config.cluster.caData; + } + + if (Object.keys(agentOptions).length > 0) { + reqInit.agent = new Agent(agentOptions); + } + + if (config.agent) { + reqInit.agent = config.agent; + } + + const token = config.user.token; + const request = createKubeJsonApi({ + serverAddress: config.cluster.server, + apiBase: "", + debug: isDevelopment, + ...(token ? { + getRequestOptions: async () => ({ + headers: { + "Authorization": `Bearer ${typeof token === "function" ? await token() : token}`, + }, + }), + } : {}), + }, reqInit); + + return new apiClass({ + objectConstructor: kubeClass, + request, + }); + }; + }, +}); + +export default createKubeApiForRemoteClusterInjectable; diff --git a/src/common/k8s-api/create-kube-json-api-for-cluster.injectable.ts b/src/common/k8s-api/create-kube-json-api-for-cluster.injectable.ts new file mode 100644 index 0000000000..9901731c94 --- /dev/null +++ b/src/common/k8s-api/create-kube-json-api-for-cluster.injectable.ts @@ -0,0 +1,36 @@ +/** + * 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 { apiKubePrefix } from "../vars"; +import isDebuggingInjectable from "../vars/is-debugging.injectable"; +import { apiBaseInjectionToken } from "./api-base"; +import createKubeJsonApiInjectable from "./create-kube-json-api.injectable"; +import type { KubeJsonApi } from "./kube-json-api"; + +export type CreateKubeJsonApiForCluster = (clusterId: string) => KubeJsonApi; + +const createKubeJsonApiForClusterInjectable = getInjectable({ + id: "create-kube-json-api-for-cluster", + instantiate: (di): CreateKubeJsonApiForCluster => { + const apiBase = di.inject(apiBaseInjectionToken); + const createKubeJsonApi = di.inject(createKubeJsonApiInjectable); + const isDebugging = di.inject(isDebuggingInjectable); + + return (clusterId) => createKubeJsonApi( + { + serverAddress: apiBase.config.serverAddress, + apiBase: apiKubePrefix, + debug: isDebugging, + }, + { + headers: { + "Host": `${clusterId}.localhost:${new URL(apiBase.config.serverAddress).port}`, + }, + }, + ); + }, +}); + +export default createKubeJsonApiForClusterInjectable; diff --git a/src/common/k8s-api/create-kube-json-api.injectable.ts b/src/common/k8s-api/create-kube-json-api.injectable.ts new file mode 100644 index 0000000000..93de5a0d21 --- /dev/null +++ b/src/common/k8s-api/create-kube-json-api.injectable.ts @@ -0,0 +1,26 @@ +/** + * 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 type { RequestInit } from "node-fetch"; +import fetchInjectable from "../fetch/fetch.injectable"; +import loggerInjectable from "../logger.injectable"; +import type { JsonApiConfig, JsonApiDependencies } from "./json-api"; +import { KubeJsonApi } from "./kube-json-api"; + +export type CreateKubeJsonApi = (config: JsonApiConfig, reqInit?: RequestInit) => KubeJsonApi; + +const createKubeJsonApiInjectable = getInjectable({ + id: "create-kube-json-api", + instantiate: (di): CreateKubeJsonApi => { + const dependencies: JsonApiDependencies = { + fetch: di.inject(fetchInjectable), + logger: di.inject(loggerInjectable), + }; + + return (config, reqInit) => new KubeJsonApi(dependencies, config, reqInit); + }, +}); + +export default createKubeJsonApiInjectable; diff --git a/src/common/k8s-api/endpoints/cluster.api.ts b/src/common/k8s-api/endpoints/cluster.api.ts index 082f0adb09..aae4c239ad 100644 --- a/src/common/k8s-api/endpoints/cluster.api.ts +++ b/src/common/k8s-api/endpoints/cluster.api.ts @@ -3,8 +3,6 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import type { MetricData, IMetricsReqParams } from "./metrics.api"; -import { metricsApi } from "./metrics.api"; import { KubeObject } from "../kube-object"; import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; @@ -28,30 +26,6 @@ export class ClusterApi extends KubeApi { } } -export function getMetricsByNodeNames(nodeNames: string[], params?: IMetricsReqParams): Promise { - const nodes = nodeNames.join("|"); - const opts = { category: "cluster", nodes }; - - return metricsApi.getMetrics({ - memoryUsage: opts, - workloadMemoryUsage: opts, - memoryRequests: opts, - memoryLimits: opts, - memoryCapacity: opts, - memoryAllocatableCapacity: opts, - cpuUsage: opts, - cpuRequests: opts, - cpuLimits: opts, - cpuCapacity: opts, - cpuAllocatableCapacity: opts, - podUsage: opts, - podCapacity: opts, - podAllocatableCapacity: opts, - fsSize: opts, - fsUsage: opts, - }, params); -} - export enum ClusterStatus { ACTIVE = "Active", CREATING = "Creating", @@ -59,21 +33,6 @@ export enum ClusterStatus { ERROR = "Error", } -export interface ClusterMetricData extends Partial> { - memoryUsage: MetricData; - memoryRequests: MetricData; - memoryLimits: MetricData; - memoryCapacity: MetricData; - cpuUsage: MetricData; - cpuRequests: MetricData; - cpuLimits: MetricData; - cpuCapacity: MetricData; - podUsage: MetricData; - podCapacity: MetricData; - fsSize: MetricData; - fsUsage: MetricData; -} - export interface Cluster { spec: { clusterNetwork?: { diff --git a/src/common/k8s-api/endpoints/daemon-set.api.ts b/src/common/k8s-api/endpoints/daemon-set.api.ts index f023652306..49719b04f9 100644 --- a/src/common/k8s-api/endpoints/daemon-set.api.ts +++ b/src/common/k8s-api/endpoints/daemon-set.api.ts @@ -5,8 +5,6 @@ import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; -import { metricsApi } from "./metrics.api"; -import type { PodMetricData } from "./pod.api"; import type { KubeObjectStatus, LabelSelector, NamespaceScopedMetadata } from "../kube-object"; import { KubeObject } from "../kube-object"; import type { PodTemplateSpec } from "./types/pod-template-spec"; @@ -90,20 +88,3 @@ export class DaemonSetApi extends KubeApi { }); } } - -export function getMetricsForDaemonSets(daemonsets: DaemonSet[], namespace: string, selector = ""): Promise { - const podSelector = daemonsets.map(daemonset => `${daemonset.getName()}-[[:alnum:]]{5}`).join("|"); - const opts = { category: "pods", pods: podSelector, namespace, selector }; - - return metricsApi.getMetrics({ - cpuUsage: opts, - memoryUsage: opts, - fsUsage: opts, - fsWrites: opts, - fsReads: opts, - networkReceive: opts, - networkTransmit: opts, - }, { - namespace, - }); -} diff --git a/src/common/k8s-api/endpoints/deployment.api.ts b/src/common/k8s-api/endpoints/deployment.api.ts index f67f26f70f..318ea8563f 100644 --- a/src/common/k8s-api/endpoints/deployment.api.ts +++ b/src/common/k8s-api/endpoints/deployment.api.ts @@ -7,8 +7,7 @@ import moment from "moment"; import type { DerivedKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; -import { metricsApi } from "./metrics.api"; -import type { PodMetricData, PodSpec } from "./pod.api"; +import type { PodSpec } from "./pod.api"; import type { KubeObjectStatus, LabelSelector, NamespaceScopedMetadata } from "../kube-object"; import { KubeObject } from "../kube-object"; import { hasTypedProperty, isNumber, isObject } from "../../utils"; @@ -70,23 +69,6 @@ export class DeploymentApi extends KubeApi { } } -export function getMetricsForDeployments(deployments: Deployment[], namespace: string, selector = ""): Promise { - const podSelector = deployments.map(deployment => `${deployment.getName()}-[[:alnum:]]{9,}-[[:alnum:]]{5}`).join("|"); - const opts = { category: "pods", pods: podSelector, namespace, selector }; - - return metricsApi.getMetrics({ - cpuUsage: opts, - memoryUsage: opts, - fsUsage: opts, - fsWrites: opts, - fsReads: opts, - networkReceive: opts, - networkTransmit: opts, - }, { - namespace, - }); -} - export interface DeploymentSpec { replicas: number; selector: LabelSelector; diff --git a/src/common/k8s-api/endpoints/helm-charts.api.ts b/src/common/k8s-api/endpoints/helm-charts.api.ts index f4ba0cf45f..26da740830 100644 --- a/src/common/k8s-api/endpoints/helm-charts.api.ts +++ b/src/common/k8s-api/endpoints/helm-charts.api.ts @@ -3,72 +3,9 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import { compile } from "path-to-regexp"; -import { apiBase } from "../index"; -import { stringify } from "querystring"; -import type { RequestInit } from "node-fetch"; -import { autoBind, bifurcateArray, isDefined } from "../../utils"; +import { autoBind, bifurcateArray } from "../../utils"; import Joi from "joi"; -export type RepoHelmChartList = Record; - -export interface IHelmChartDetails { - readme: string; - versions: HelmChart[]; -} - -const endpoint = compile(`/v2/charts/:repo?/:name?`) as (params?: { - repo?: string; - name?: string; -}) => string; - -/** - * Get a list of all helm charts from all saved helm repos - */ -export async function listCharts(): Promise { - const data = await apiBase.get>(endpoint()); - - return Object - .values(data) - .reduce((allCharts, repoCharts) => allCharts.concat(Object.values(repoCharts)), new Array()) - .map(([chart]) => HelmChart.create(chart, { onError: "log" })) - .filter(isDefined); -} - -export interface GetChartDetailsOptions { - version?: string; - reqInit?: RequestInit; -} - -/** - * Get the readme and all versions of a chart - * @param repo The repo to get from - * @param name The name of the chart to request the data of - * @param options.version The version of the chart's readme to get, default latest - * @param options.reqInit A way for passing in an abort controller or other browser request options - */ -export async function getChartDetails(repo: string, name: string, { version, reqInit }: GetChartDetailsOptions = {}): Promise { - const path = endpoint({ repo, name }); - - const { readme, ...data } = await apiBase.get(`${path}?${stringify({ version })}`, undefined, reqInit); - const versions = data.versions.map(version => HelmChart.create(version, { onError: "log" })).filter(isDefined); - - return { - readme, - versions, - }; -} - -/** - * Get chart values related to a specific repos' version of a chart - * @param repo The repo to get from - * @param name The name of the chart to request the data of - * @param version The version to get the values from - */ -export async function getChartValues(repo: string, name: string, version: string): Promise { - return apiBase.get(`/v2/charts/${repo}/${name}/values?${stringify({ version })}`); -} - export interface RawHelmChart { apiVersion: string; name: string; diff --git a/src/common/k8s-api/endpoints/helm-charts.api/request-charts.injectable.ts b/src/common/k8s-api/endpoints/helm-charts.api/request-charts.injectable.ts new file mode 100644 index 0000000000..89de5f9d17 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-charts.api/request-charts.injectable.ts @@ -0,0 +1,34 @@ +/** + * 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 "../../api-base"; +import type { RawHelmChart } from "../helm-charts.api"; +import { HelmChart } from "../helm-charts.api"; +import { isDefined } from "../../../utils"; + +export type RequestHelmCharts = () => Promise; +export type RepoHelmChartList = Record; + +/** + * Get a list of all helm charts from all saved helm repos + */ +const requestHelmChartsInjectable = getInjectable({ + id: "request-helm-charts", + instantiate: (di) => { + const apiBase = di.inject(apiBaseInjectionToken); + + return async () => { + const data = await apiBase.get>("/v2/charts"); + + return Object + .values(data) + .reduce((allCharts, repoCharts) => allCharts.concat(Object.values(repoCharts)), new Array()) + .map(([chart]) => HelmChart.create(chart, { onError: "log" })) + .filter(isDefined); + }; + }, +}); + +export default requestHelmChartsInjectable; diff --git a/src/common/k8s-api/endpoints/helm-charts.api/request-readme.injectable.ts b/src/common/k8s-api/endpoints/helm-charts.api/request-readme.injectable.ts new file mode 100644 index 0000000000..c6815c4b93 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-charts.api/request-readme.injectable.ts @@ -0,0 +1,24 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; + +const requestReadmeEndpoint = urlBuilderFor("/v2/charts/:repo/:name/readme"); + +export type RequestHelmChartReadme = (repo: string, name: string, version?: string) => Promise; + +const requestHelmChartReadmeInjectable = getInjectable({ + id: "request-helm-chart-readme", + instantiate: (di): RequestHelmChartReadme => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (repo, name, version) => ( + apiBase.get(requestReadmeEndpoint.compile({ name, repo }, { version })) + ); + }, +}); + +export default requestHelmChartReadmeInjectable; diff --git a/src/common/k8s-api/endpoints/helm-charts.api/request-values.injectable.ts b/src/common/k8s-api/endpoints/helm-charts.api/request-values.injectable.ts new file mode 100644 index 0000000000..ec927fc37a --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-charts.api/request-values.injectable.ts @@ -0,0 +1,24 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; + +const requestValuesEndpoint = urlBuilderFor("/v2/charts/:repo/:name/values"); + +export type RequestHelmChartValues = (repo: string, name: string, version: string) => Promise; + +const requestHelmChartValuesInjectable = getInjectable({ + id: "request-helm-chart-values", + instantiate: (di): RequestHelmChartValues => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (repo, name, version) => ( + apiBase.get(requestValuesEndpoint.compile({ repo, name }, { version })) + ); + }, +}); + +export default requestHelmChartValuesInjectable; diff --git a/src/common/k8s-api/endpoints/helm-charts.api/request-versions.injectable.ts b/src/common/k8s-api/endpoints/helm-charts.api/request-versions.injectable.ts new file mode 100644 index 0000000000..410d8ea596 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-charts.api/request-versions.injectable.ts @@ -0,0 +1,31 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; +import { HelmChart } from "../helm-charts.api"; +import type { RawHelmChart } from "../helm-charts.api"; +import { isDefined } from "../../../utils"; + +const requestVersionsEndpoint = urlBuilderFor("/v2/charts/:repo/:name/versions"); + +export type RequestHelmChartVersions = (repo: string, chartName: string) => Promise; + +const requestHelmChartVersionsInjectable = getInjectable({ + id: "request-helm-chart-versions", + instantiate: (di): RequestHelmChartVersions => { + const apiBase = di.inject(apiBaseInjectionToken); + + return async (repo, name) => { + const rawVersions = await apiBase.get(requestVersionsEndpoint.compile({ name, repo })) as RawHelmChart[]; + + return rawVersions + .map(version => HelmChart.create(version, { onError: "log" })) + .filter(isDefined); + }; + }, +}); + +export default requestHelmChartVersionsInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api.ts b/src/common/k8s-api/endpoints/helm-releases.api.ts index f9e11073c0..3460378e59 100644 --- a/src/common/k8s-api/endpoints/helm-releases.api.ts +++ b/src/common/k8s-api/endpoints/helm-releases.api.ts @@ -3,65 +3,14 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import { apiBase } from "../index"; import type { ItemObject } from "../../item.store"; -import type { JsonApiData } from "../json-api"; -import { buildURLPositional } from "../../utils/buildUrl"; -import type { HelmReleaseDetails } from "../../../renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.injectable"; +import type { HelmReleaseDetails } from "./helm-releases.api/request-details.injectable"; export interface HelmReleaseUpdateDetails { log: string; release: HelmReleaseDetails; } -export interface HelmReleaseRevision { - revision: number; - updated: string; - status: string; - chart: string; - app_version: string; - description: string; -} - -type EndpointParams = {} - | { namespace: string } - | { namespace: string; name: string } - | { namespace: string; name: string; route: string }; - -interface EndpointQuery { - all?: boolean; -} - -export const endpoint = buildURLPositional("/v2/releases/:namespace?/:name?/:route?"); - -export async function deleteRelease(name: string, namespace: string): Promise { - const path = endpoint({ name, namespace }); - - return apiBase.del(path); -} - -export async function getReleaseValues(name: string, namespace: string, all?: boolean): Promise { - const route = "values"; - const path = endpoint({ name, namespace, route }, { all }); - - return apiBase.get(path); -} - -export async function getReleaseHistory(name: string, namespace: string): Promise { - const route = "history"; - const path = endpoint({ name, namespace, route }); - - return apiBase.get(path); -} - -export async function rollbackRelease(name: string, namespace: string, revision: number): Promise { - const route = "rollback"; - const path = endpoint({ name, namespace, route }); - const data = { revision }; - - return apiBase.put(path, { data }); -} - export interface HelmReleaseDto { appVersion: string; name: string; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-configuration.global-override-for-injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-configuration.global-override-for-injectable.ts new file mode 100644 index 0000000000..18b3bd0ec0 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-configuration.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../../../test-utils/get-global-override"; +import requestHelmReleaseConfigurationInjectable from "./request-configuration.injectable"; + +export default getGlobalOverride(requestHelmReleaseConfigurationInjectable, () => () => { + throw new Error("Tried to call requestHelmReleaseConfiguration with no override"); +}); diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable.ts new file mode 100644 index 0000000000..1bfe168b11 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable.ts @@ -0,0 +1,29 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; + +export type RequestHelmReleaseConfiguration = ( + name: string, + namespace: string, + all: boolean +) => Promise; + +const requestConfigurationEnpoint = urlBuilderFor("/v2/releases/:namespace/:name/values"); + +const requestHelmReleaseConfigurationInjectable = getInjectable({ + id: "request-helm-release-configuration", + + instantiate: (di): RequestHelmReleaseConfiguration => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (name, namespace, all: boolean) => ( + apiBase.get(requestConfigurationEnpoint.compile({ name, namespace }, { all })) + ); + }, +}); + +export default requestHelmReleaseConfigurationInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-create.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-create.injectable.ts new file mode 100644 index 0000000000..bad802d3cc --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-create.injectable.ts @@ -0,0 +1,42 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import yaml from "js-yaml"; +import { getInjectable } from "@ogre-tools/injectable"; +import type { HelmReleaseUpdateDetails } from "../helm-releases.api"; +import { apiBaseInjectionToken } from "../../api-base"; +import { urlBuilderFor } from "../../../utils/buildUrl"; + +interface HelmReleaseCreatePayload { + name?: string; + repo: string; + chart: string; + namespace: string; + version: string; + values: string; +} + +export type RequestCreateHelmRelease = (payload: HelmReleaseCreatePayload) => Promise; + +const requestCreateEndpoint = urlBuilderFor("/v2/releases"); + +const requestCreateHelmReleaseInjectable = getInjectable({ + id: "request-create-helm-release", + + instantiate: (di): RequestCreateHelmRelease => { + const apiBase = di.inject(apiBaseInjectionToken); + + return ({ repo, chart, values, ...data }) => { + return apiBase.post(requestCreateEndpoint.compile({}), { + data: { + chart: `${repo}/${chart}`, + values: yaml.load(values), + ...data, + }, + }); + }; + }, +}); + +export default requestCreateHelmReleaseInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-delete.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-delete.injectable.ts new file mode 100644 index 0000000000..66b2013770 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-delete.injectable.ts @@ -0,0 +1,22 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; + +export type RequestDeleteHelmRelease = (name: string, namespace: string) => Promise; + +const requestDeleteEndpoint = urlBuilderFor("/v2/releases/:namespace/:name"); + +const requestDeleteHelmReleaseInjectable = getInjectable({ + id: "request-delete-helm-release", + instantiate: (di): RequestDeleteHelmRelease => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (name, namespace) => apiBase.del(requestDeleteEndpoint.compile({ name, namespace })); + }, +}); + +export default requestDeleteHelmReleaseInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-details.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-details.injectable.ts new file mode 100644 index 0000000000..0b712cd78e --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-details.injectable.ts @@ -0,0 +1,41 @@ +/** + * 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 type { KubeJsonApiData } from "../../kube-json-api"; +import { apiBaseInjectionToken } from "../../api-base"; +import { urlBuilderFor } from "../../../utils/buildUrl"; + +export interface HelmReleaseDetails { + resources: KubeJsonApiData[]; + name: string; + namespace: string; + version: string; + config: string; // release values + manifest: string; + info: { + deleted: string; + description: string; + first_deployed: string; + last_deployed: string; + notes: string; + status: string; + }; +} + +export type CallForHelmReleaseDetails = (name: string, namespace: string) => Promise; + +const requestDetailsEnpoint = urlBuilderFor("/v2/releases/:namespace/:name"); + +const requestHelmReleaseDetailsInjectable = getInjectable({ + id: "call-for-helm-release-details", + + instantiate: (di): CallForHelmReleaseDetails => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (name, namespace) => apiBase.get(requestDetailsEnpoint.compile({ name, namespace })); + }, +}); + +export default requestHelmReleaseDetailsInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-history.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-history.injectable.ts new file mode 100644 index 0000000000..b6e9794fe7 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-history.injectable.ts @@ -0,0 +1,31 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; + +export interface HelmReleaseRevision { + revision: number; + updated: string; + status: string; + chart: string; + app_version: string; + description: string; +} + +export type RequestHelmReleaseHistory = (name: string, namespace: string) => Promise; + +const requestHistoryEnpoint = urlBuilderFor("/v2/releases/:namespace/:name/history"); + +const requestHelmReleaseHistoryInjectable = getInjectable({ + id: "request-helm-release-history", + instantiate: (di): RequestHelmReleaseHistory => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (name, namespace) => apiBase.get(requestHistoryEnpoint.compile({ name, namespace })); + }, +}); + +export default requestHelmReleaseHistoryInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-releases.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-releases.injectable.ts new file mode 100644 index 0000000000..2619e289c6 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-releases.injectable.ts @@ -0,0 +1,24 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; +import type { HelmReleaseDto } from "../helm-releases.api"; + +export type RequestHelmReleases = (namespace?: string) => Promise; + +const requestHelmReleasesEndpoint = urlBuilderFor("/v2/releases/:namespace?"); + +const requestHelmReleasesInjectable = getInjectable({ + id: "request-helm-releases", + + instantiate: (di): RequestHelmReleases => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (namespace) => apiBase.get(requestHelmReleasesEndpoint.compile({ namespace })); + }, +}); + +export default requestHelmReleasesInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-rollback.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-rollback.injectable.ts new file mode 100644 index 0000000000..1a9229b73a --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-rollback.injectable.ts @@ -0,0 +1,27 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; + +export type RequestHelmReleaseRollback = (name: string, namespace: string, revision: number) => Promise; + +const requestRollbackEndpoint = urlBuilderFor("/v2/releases/:namespace/:name"); + +const requestHelmReleaseRollbackInjectable = getInjectable({ + id: "request-helm-release-rollback", + instantiate: (di): RequestHelmReleaseRollback => { + const apiBase = di.inject(apiBaseInjectionToken); + + return async (name, namespace, revision) => { + await apiBase.put( + requestRollbackEndpoint.compile({ name, namespace }), + { data: { revision }}, + ); + }; + }, +}); + +export default requestHelmReleaseRollbackInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-update.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-update.injectable.ts new file mode 100644 index 0000000000..2703ea2c56 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-update.injectable.ts @@ -0,0 +1,49 @@ +/** + * 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 yaml from "js-yaml"; +import { apiBaseInjectionToken } from "../../api-base"; +import { urlBuilderFor } from "../../../utils/buildUrl"; + +interface HelmReleaseUpdatePayload { + repo: string; + chart: string; + version: string; + values: string; +} + +export type RequestHelmReleaseUpdate = ( + name: string, + namespace: string, + payload: HelmReleaseUpdatePayload +) => Promise<{ updateWasSuccessful: true } | { updateWasSuccessful: false; error: unknown }>; + +const requestUpdateEndpoint = urlBuilderFor("/v2/releases/:namespace/:name"); + +const requestHelmReleaseUpdateInjectable = getInjectable({ + id: "request-helm-release-update", + + instantiate: (di): RequestHelmReleaseUpdate => { + const apiBase = di.inject(apiBaseInjectionToken); + + return async (name, namespace, { repo, chart, values, ...data }) => { + try { + await apiBase.put(requestUpdateEndpoint.compile({ name, namespace }), { + data: { + chart: `${repo}/${chart}`, + values: yaml.load(values), + ...data, + }, + }); + } catch (e) { + return { updateWasSuccessful: false, error: e }; + } + + return { updateWasSuccessful: true }; + }; + }, +}); + +export default requestHelmReleaseUpdateInjectable; diff --git a/src/common/k8s-api/endpoints/helm-releases.api/request-values.injectable.ts b/src/common/k8s-api/endpoints/helm-releases.api/request-values.injectable.ts new file mode 100644 index 0000000000..d30f9973c4 --- /dev/null +++ b/src/common/k8s-api/endpoints/helm-releases.api/request-values.injectable.ts @@ -0,0 +1,22 @@ +/** + * 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 { urlBuilderFor } from "../../../utils/buildUrl"; +import { apiBaseInjectionToken } from "../../api-base"; + +export type RequestHelmReleaseValues = (name: string, namespace: string, all?: boolean) => Promise; + +const requestValuesEndpoint = urlBuilderFor("/v2/release/:namespace/:name/values"); + +const requestHelmReleaseValuesInjectable = getInjectable({ + id: "request-helm-release-values", + instantiate: (di): RequestHelmReleaseValues => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (name, namespace, all) => apiBase.get(requestValuesEndpoint.compile({ name, namespace }, { all })); + }, +}); + +export default requestHelmReleaseValuesInjectable; diff --git a/src/common/k8s-api/endpoints/ingress.api.ts b/src/common/k8s-api/endpoints/ingress.api.ts index 84910d2783..d223530013 100644 --- a/src/common/k8s-api/endpoints/ingress.api.ts +++ b/src/common/k8s-api/endpoints/ingress.api.ts @@ -6,8 +6,6 @@ import type { NamespaceScopedMetadata, TypedLocalObjectReference } from "../kube-object"; import { KubeObject } from "../kube-object"; import { hasTypedProperty, isString, iter } from "../../utils"; -import type { MetricData } from "./metrics.api"; -import { metricsApi } from "./metrics.api"; import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; import type { RequireExactlyOne } from "type-fest"; @@ -24,26 +22,6 @@ export class IngressApi extends KubeApi { } } -export function getMetricsForIngress(ingress: string, namespace: string): Promise { - const opts = { category: "ingress", ingress, namespace }; - - return metricsApi.getMetrics({ - bytesSentSuccess: opts, - bytesSentFailure: opts, - requestDurationSeconds: opts, - responseDurationSeconds: opts, - }, { - namespace, - }); -} - -export interface IngressMetricData extends Partial> { - bytesSentSuccess: MetricData; - bytesSentFailure: MetricData; - requestDurationSeconds: MetricData; - responseDurationSeconds: MetricData; -} - export interface ILoadBalancerIngress { hostname?: string; ip?: string; diff --git a/src/common/k8s-api/endpoints/job.api.ts b/src/common/k8s-api/endpoints/job.api.ts index 84e166ecc4..66f4ef3768 100644 --- a/src/common/k8s-api/endpoints/job.api.ts +++ b/src/common/k8s-api/endpoints/job.api.ts @@ -5,8 +5,7 @@ import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; -import { metricsApi } from "./metrics.api"; -import type { PodMetricData, PodSpec } from "./pod.api"; +import type { PodSpec } from "./pod.api"; import type { Container } from "./types/container"; import type { KubeObjectStatus, LabelSelector, NamespaceScopedMetadata } from "../kube-object"; import { KubeObject } from "../kube-object"; @@ -103,20 +102,3 @@ export class JobApi extends KubeApi { }); } } - -export function getMetricsForJobs(jobs: Job[], namespace: string, selector = ""): Promise { - const podSelector = jobs.map(job => `${job.getName()}-[[:alnum:]]{5}`).join("|"); - const opts = { category: "pods", pods: podSelector, namespace, selector }; - - return metricsApi.getMetrics({ - cpuUsage: opts, - memoryUsage: opts, - fsUsage: opts, - fsWrites: opts, - fsReads: opts, - networkReceive: opts, - networkTransmit: opts, - }, { - namespace, - }); -} diff --git a/src/common/k8s-api/endpoints/metrics.api.ts b/src/common/k8s-api/endpoints/metrics.api.ts index b5469e8a24..406ab1d0b2 100644 --- a/src/common/k8s-api/endpoints/metrics.api.ts +++ b/src/common/k8s-api/endpoints/metrics.api.ts @@ -6,7 +6,7 @@ // Metrics api import moment from "moment"; -import { apiBase } from "../index"; +import { isDefined, object } from "../../utils"; export interface MetricData { status: string; @@ -29,63 +29,6 @@ export interface MetricResult { values: [number, string][]; } -export interface MetricProviderInfo { - name: string; - id: string; - isConfigurable: boolean; -} - -export interface IMetricsReqParams { - start?: number | string; // timestamp in seconds or valid date-string - end?: number | string; - step?: number; // step in seconds (default: 60s = each point 1m) - range?: number; // time-range in seconds for data aggregation (default: 3600s = last 1h) - namespace?: string; // rbac-proxy validation param -} - -export interface IResourceMetrics { - [metric: string]: T; - cpuUsage: T; - memoryUsage: T; - fsUsage: T; - fsWrites: T; - fsReads: T; - networkReceive: T; - networkTransmit: T; -} - -async function getMetrics(query: string, reqParams?: IMetricsReqParams): Promise; -async function getMetrics(query: string[], reqParams?: IMetricsReqParams): Promise; -async function getMetrics(query: Record>>, reqParams?: IMetricsReqParams): Promise>; - -async function getMetrics(query: string | string[] | Partial>>>, reqParams: IMetricsReqParams = {}): Promise>> { - const { range = 3600, step = 60, namespace } = reqParams; - let { start, end } = reqParams; - - if (!start && !end) { - const timeNow = Date.now() / 1000; - const now = moment.unix(timeNow).startOf("minute").unix(); // round date to minutes - - start = now - range; - end = now; - } - - return apiBase.post("/metrics", { - data: query, - query: { - start, end, step, - "kubernetes_namespace": namespace, - }, - }); -} - -export const metricsApi = { - getMetrics, - async getMetricProviders(): Promise { - return apiBase.get("/metrics/providers"); - }, -}; - export function normalizeMetrics(metrics: MetricData | undefined | null, frames = 60): MetricData { if (!metrics?.data?.result) { return { @@ -145,7 +88,7 @@ export function isMetricsEmpty(metrics: Partial>) { return Object.values(metrics).every(metric => !metric?.data?.result?.length); } -export function getItemMetrics(metrics: Partial> | null | undefined, itemName: string): Partial> | undefined { +export function getItemMetrics(metrics: Partial> | null | undefined, itemName: string): Partial> | undefined { if (!metrics) { return undefined; } @@ -166,22 +109,16 @@ export function getItemMetrics(metrics: Partial> | nu return itemMetrics; } -export function getMetricLastPoints>>(metrics: T): Record { - const result: Partial<{ [metric: string]: number }> = {}; - - Object.keys(metrics).forEach(metricName => { - try { - const metric = metrics[metricName]; - - if (metric?.data.result.length) { - result[metricName] = +metric.data.result[0].values.slice(-1)[0][1]; - } - } catch { - // ignore error - } - - return result; - }, {}); - - return result as Record; +export function getMetricLastPoints(metrics: Partial>): Partial> { + return object.fromEntries( + object.entries(metrics) + .map(([metricName, metric]) => { + try { + return [metricName, +metric.data.result[0].values.slice(-1)[0][1]] as const; + } catch { + return undefined; + } + }) + .filter(isDefined), + ); } diff --git a/src/common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable.ts new file mode 100644 index 0000000000..84268e3f6a --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable.ts @@ -0,0 +1,63 @@ +/** + * 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 type { MetricData } from "../metrics.api"; +import type { RequestMetricsParams } from "./request-metrics.injectable"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface ClusterMetricData { + memoryUsage: MetricData; + memoryRequests: MetricData; + memoryLimits: MetricData; + memoryCapacity: MetricData; + memoryAllocatableCapacity: MetricData; + cpuUsage: MetricData; + cpuRequests: MetricData; + cpuLimits: MetricData; + cpuCapacity: MetricData; + cpuAllocatableCapacity: MetricData; + podUsage: MetricData; + podCapacity: MetricData; + podAllocatableCapacity: MetricData; + fsSize: MetricData; + fsUsage: MetricData; +} + +export type RequestClusterMetricsByNodeNames = (nodeNames: string[], params?: RequestMetricsParams) => Promise; + +const requestClusterMetricsByNodeNamesInjectable = getInjectable({ + id: "get-cluster-metrics-by-node-names", + instantiate: (di): RequestClusterMetricsByNodeNames => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (nodeNames, params) => { + const opts = { + category: "cluster", + nodes: nodeNames.join("|"), + }; + + return requestMetrics({ + memoryUsage: opts, + workloadMemoryUsage: opts, + memoryRequests: opts, + memoryLimits: opts, + memoryCapacity: opts, + memoryAllocatableCapacity: opts, + cpuUsage: opts, + cpuRequests: opts, + cpuLimits: opts, + cpuCapacity: opts, + cpuAllocatableCapacity: opts, + podUsage: opts, + podCapacity: opts, + podAllocatableCapacity: opts, + fsSize: opts, + fsUsage: opts, + }, params); + }; + }, +}); + +export default requestClusterMetricsByNodeNamesInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-ingress-metrics.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-ingress-metrics.injectable.ts new file mode 100644 index 0000000000..8167a6bef4 --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-ingress-metrics.injectable.ts @@ -0,0 +1,38 @@ +/** + * 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 type { MetricData } from "../metrics.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface IngressMetricData { + bytesSentSuccess: MetricData; + bytesSentFailure: MetricData; + requestDurationSeconds: MetricData; + responseDurationSeconds: MetricData; +} + +export type RequestIngressMetrics = (ingress: string, namespace: string) => Promise; + +const requestIngressMetricsInjectable = getInjectable({ + id: "request-ingress-metrics", + instantiate: (di): RequestIngressMetrics => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (ingress, namespace) => { + const opts = { category: "ingress", ingress, namespace }; + + return requestMetrics({ + bytesSentSuccess: opts, + bytesSentFailure: opts, + requestDurationSeconds: opts, + responseDurationSeconds: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestIngressMetricsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-metrics-for-all-nodes.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-metrics-for-all-nodes.injectable.ts new file mode 100644 index 0000000000..6789d6debc --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-metrics-for-all-nodes.injectable.ts @@ -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 type { MetricData } from "../metrics.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface NodeMetricData { + memoryUsage: MetricData; + workloadMemoryUsage: MetricData; + memoryCapacity: MetricData; + memoryAllocatableCapacity: MetricData; + cpuUsage: MetricData; + cpuCapacity: MetricData; + fsUsage: MetricData; + fsSize: MetricData; +} + +export type RequestAllNodeMetrics = () => Promise; + +const requestAllNodeMetricsInjectable = getInjectable({ + id: "request-all-node-metrics", + instantiate: (di): RequestAllNodeMetrics => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return () => { + const opts = { category: "nodes" }; + + return requestMetrics({ + memoryUsage: opts, + workloadMemoryUsage: opts, + memoryCapacity: opts, + memoryAllocatableCapacity: opts, + cpuUsage: opts, + cpuCapacity: opts, + fsSize: opts, + fsUsage: opts, + }); + }; + }, +}); + +export default requestAllNodeMetricsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-metrics.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-metrics.injectable.ts new file mode 100644 index 0000000000..0da0bc95ec --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-metrics.injectable.ts @@ -0,0 +1,73 @@ +/** + * 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 { getSecondsFromUnixEpoch } from "../../../utils/date/get-current-date-time"; +import { apiBaseInjectionToken } from "../../api-base"; +import type { MetricData } from "../metrics.api"; + + +export interface RequestMetricsParams { + /** + * timestamp in seconds or valid date-string + */ + start?: number | string; + + /** + * timestamp in seconds or valid date-string + */ + end?: number | string; + + /** + * step in seconds + * @default 60 (1 minute) + */ + step?: number; + + /** + * time-range in seconds for data aggregation + * @default 3600 (1 hour) + */ + range?: number; + + /** + * rbac-proxy validation param + */ + namespace?: string; +} + +export interface RequestMetrics { + (query: string, params?: RequestMetricsParams): Promise; + (query: string[], params?: RequestMetricsParams): Promise; + (query: Record>>, params?: RequestMetricsParams): Promise>; +} + +const requestMetricsInjectable = getInjectable({ + id: "request-metrics", + instantiate: (di) => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (async (query: object, params: RequestMetricsParams = {}) => { + const { range = 3600, step = 60, namespace } = params; + let { start, end } = params; + + if (!start && !end) { + const now = getSecondsFromUnixEpoch(); + + start = now - range; + end = now; + } + + return apiBase.post("/metrics", { + data: query, + query: { + start, end, step, + "kubernetes_namespace": namespace, + }, + }); + }) as RequestMetrics; + }, +}); + +export default requestMetricsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-persistent-volume-claim-metrics.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-persistent-volume-claim-metrics.injectable.ts new file mode 100644 index 0000000000..5cafb5ade0 --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-persistent-volume-claim-metrics.injectable.ts @@ -0,0 +1,35 @@ +/** + * 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 type { MetricData } from "../metrics.api"; +import type { PersistentVolumeClaim } from "../persistent-volume-claim.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface PersistentVolumeClaimMetricData { + diskUsage: MetricData; + diskCapacity: MetricData; +} + +export type RequestPersistentVolumeClaimMetrics = (claim: PersistentVolumeClaim) => Promise; + +const requestPersistentVolumeClaimMetricsInjectable = getInjectable({ + id: "request-persistent-volume-claim-metrics", + instantiate: (di): RequestPersistentVolumeClaimMetrics => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (claim) => { + const opts = { category: "pvc", pvc: claim.getName(), namespace: claim.getNs() }; + + return requestMetrics({ + diskUsage: opts, + diskCapacity: opts, + }, { + namespace: opts.namespace, + }); + }; + }, +}); + +export default requestPersistentVolumeClaimMetricsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-daemon-sets.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-daemon-sets.injectable.ts new file mode 100644 index 0000000000..d5653574ff --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-daemon-sets.injectable.ts @@ -0,0 +1,46 @@ +/** + * 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 type { DaemonSet } from "../daemon-set.api"; +import type { MetricData } from "../metrics.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface DaemonSetPodMetricData { + cpuUsage: MetricData; + memoryUsage: MetricData; + fsUsage: MetricData; + fsWrites: MetricData; + fsReads: MetricData; + networkReceive: MetricData; + networkTransmit: MetricData; +} + +export type RequestPodMetricsForDaemonSets = (daemonsets: DaemonSet[], namespace: string, selector?: string) => Promise; + +const requestPodMetricsForDaemonSetsInjectable = getInjectable({ + id: "request-pod-metrics-for-daemon-sets", + instantiate: (di): RequestPodMetricsForDaemonSets => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (daemonSets, namespace, selector = "") => { + const podSelector = daemonSets.map(daemonSet => `${daemonSet.getName()}-[[:alnum:]]{5}`).join("|"); + const opts = { category: "pods", pods: podSelector, namespace, selector }; + + return requestMetrics({ + cpuUsage: opts, + memoryUsage: opts, + fsUsage: opts, + fsWrites: opts, + fsReads: opts, + networkReceive: opts, + networkTransmit: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestPodMetricsForDaemonSetsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-deployments.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-deployments.injectable.ts new file mode 100644 index 0000000000..ced8ccd7fe --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-deployments.injectable.ts @@ -0,0 +1,46 @@ +/** + * 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 type { Deployment } from "../deployment.api"; +import type { MetricData } from "../metrics.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface DeploymentPodMetricData { + cpuUsage: MetricData; + memoryUsage: MetricData; + fsUsage: MetricData; + fsWrites: MetricData; + fsReads: MetricData; + networkReceive: MetricData; + networkTransmit: MetricData; +} + +export type RequestPodMetricsForDeployments = (deployments: Deployment[], namespace: string, selector?: string) => Promise; + +const requestPodMetricsForDeploymentsInjectable = getInjectable({ + id: "request-pod-metrics-for-deployments", + instantiate: (di): RequestPodMetricsForDeployments => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (deployments, namespace, selector = "") => { + const podSelector = deployments.map(deployment => `${deployment.getName()}-[[:alnum:]]{9,}-[[:alnum:]]{5}`).join("|"); + const opts = { category: "pods", pods: podSelector, namespace, selector }; + + return requestMetrics({ + cpuUsage: opts, + memoryUsage: opts, + fsUsage: opts, + fsWrites: opts, + fsReads: opts, + networkReceive: opts, + networkTransmit: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestPodMetricsForDeploymentsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-jobs.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-jobs.injectable.ts new file mode 100644 index 0000000000..a812fae59c --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-jobs.injectable.ts @@ -0,0 +1,46 @@ +/** + * 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 type { Job } from "../job.api"; +import type { MetricData } from "../metrics.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface JobPodMetricData { + cpuUsage: MetricData; + memoryUsage: MetricData; + fsUsage: MetricData; + fsWrites: MetricData; + fsReads: MetricData; + networkReceive: MetricData; + networkTransmit: MetricData; +} + +export type RequestPodMetricsForJobs = (jobs: Job[], namespace: string, selector?: string) => Promise; + +const requestPodMetricsForJobsInjectable = getInjectable({ + id: "request-pod-metrics-for-jobs", + instantiate: (di): RequestPodMetricsForJobs => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (jobs, namespace, selector) => { + const podSelector = jobs.map(job => `${job.getName()}-[[:alnum:]]{5}`).join("|"); + const opts = { category: "pods", pods: podSelector, namespace, selector }; + + return requestMetrics({ + cpuUsage: opts, + memoryUsage: opts, + fsUsage: opts, + fsWrites: opts, + fsReads: opts, + networkReceive: opts, + networkTransmit: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestPodMetricsForJobsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-replica-sets.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-replica-sets.injectable.ts new file mode 100644 index 0000000000..4186cba7b4 --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-replica-sets.injectable.ts @@ -0,0 +1,46 @@ +/** + * 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 type { MetricData } from "../metrics.api"; +import type { ReplicaSet } from "../replica-set.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface ReplicaSetPodMetricData { + cpuUsage: MetricData; + memoryUsage: MetricData; + fsUsage: MetricData; + fsWrites: MetricData; + fsReads: MetricData; + networkReceive: MetricData; + networkTransmit: MetricData; +} + +export type RequestPodMetricsForReplicaSets = (replicaSets: ReplicaSet[], namespace: string, selector?: string) => Promise; + +const requestPodMetricsForReplicaSetsInjectable = getInjectable({ + id: "request-pod-metrics-for-replica-sets", + instantiate: (di): RequestPodMetricsForReplicaSets => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (replicaSets, namespace, selector = "") => { + const podSelector = replicaSets.map(replicaSet => `${replicaSet.getName()}-[[:alnum:]]{5}`).join("|"); + const opts = { category: "pods", pods: podSelector, namespace, selector }; + + return requestMetrics({ + cpuUsage: opts, + memoryUsage: opts, + fsUsage: opts, + fsWrites: opts, + fsReads: opts, + networkReceive: opts, + networkTransmit: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestPodMetricsForReplicaSetsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-stateful-sets.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-stateful-sets.injectable.ts new file mode 100644 index 0000000000..227961bc02 --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-stateful-sets.injectable.ts @@ -0,0 +1,47 @@ +/** + * 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 type { MetricData } from "../metrics.api"; +import type { StatefulSet } from "../stateful-set.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface StatefulSetPodMetricData { + cpuUsage: MetricData; + memoryUsage: MetricData; + fsUsage: MetricData; + fsWrites: MetricData; + fsReads: MetricData; + networkReceive: MetricData; + networkTransmit: MetricData; +} + +export type RequestPodMetricsForStatefulSets = (statefulSets: StatefulSet[], namespace: string, selector?: string) => Promise; + +const requestPodMetricsForStatefulSetsInjectable = getInjectable({ + id: "request-pod-metrics-for-stateful-sets", + instantiate: (di): RequestPodMetricsForStatefulSets => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (statefulSets, namespace, selector = "") => { + const podSelector = statefulSets.map(statefulset => `${statefulset.getName()}-[[:digit:]]+`).join("|"); + const opts = { category: "pods", pods: podSelector, namespace, selector }; + + return requestMetrics({ + cpuUsage: opts, + memoryUsage: opts, + fsUsage: opts, + fsWrites: opts, + fsReads: opts, + networkReceive: opts, + networkTransmit: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestPodMetricsForStatefulSetsInjectable; + diff --git a/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-in-namespace.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-in-namespace.injectable.ts new file mode 100644 index 0000000000..872ffd740e --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics-in-namespace.injectable.ts @@ -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 type { MetricData } from "../metrics.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface PodMetricInNamespaceData { + cpuUsage: MetricData; + memoryUsage: MetricData; + fsUsage: MetricData; + fsWrites: MetricData; + fsReads: MetricData; + networkReceive: MetricData; + networkTransmit: MetricData; +} + +export type RequestPodMetricsInNamespace = (namespace: string, selector?: string) => Promise; + +const requestPodMetricsInNamespaceInjectable = getInjectable({ + id: "request-pod-metrics-in-namespace", + instantiate: (di): RequestPodMetricsInNamespace => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (namespace, selector) => { + const opts = { category: "pods", pods: ".*", namespace, selector }; + + return requestMetrics({ + cpuUsage: opts, + memoryUsage: opts, + fsUsage: opts, + fsWrites: opts, + fsReads: opts, + networkReceive: opts, + networkTransmit: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestPodMetricsInNamespaceInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics.injectable.ts new file mode 100644 index 0000000000..e14e5dc293 --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-pod-metrics.injectable.ts @@ -0,0 +1,54 @@ +/** + * 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 type { MetricData } from "../metrics.api"; +import type { Pod } from "../pod.api"; +import requestMetricsInjectable from "./request-metrics.injectable"; + +export interface PodMetricData { + cpuUsage: MetricData; + memoryUsage: MetricData; + fsUsage: MetricData; + fsWrites: MetricData; + fsReads: MetricData; + networkReceive: MetricData; + networkTransmit: MetricData; + cpuRequests: MetricData; + cpuLimits: MetricData; + memoryRequests: MetricData; + memoryLimits: MetricData; +} + +export type RequestPodMetrics = (pods: Pod[], namespace: string, selector?: string) => Promise; + +const requestPodMetricsInjectable = getInjectable({ + id: "request-pod-metrics", + instantiate: (di): RequestPodMetrics => { + const requestMetrics = di.inject(requestMetricsInjectable); + + return (pods, namespace, selector = "pod, namespace") => { + const podSelector = pods.map(pod => pod.getName()).join("|"); + const opts = { category: "pods", pods: podSelector, namespace, selector }; + + return requestMetrics({ + cpuUsage: opts, + cpuRequests: opts, + cpuLimits: opts, + memoryUsage: opts, + memoryRequests: opts, + memoryLimits: opts, + fsUsage: opts, + fsWrites: opts, + fsReads: opts, + networkReceive: opts, + networkTransmit: opts, + }, { + namespace, + }); + }; + }, +}); + +export default requestPodMetricsInjectable; diff --git a/src/common/k8s-api/endpoints/metrics.api/request-providers.injectable.ts b/src/common/k8s-api/endpoints/metrics.api/request-providers.injectable.ts new file mode 100644 index 0000000000..4711333ca6 --- /dev/null +++ b/src/common/k8s-api/endpoints/metrics.api/request-providers.injectable.ts @@ -0,0 +1,26 @@ +/** + * 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 "../../api-base"; + +export interface MetricProviderInfo { + name: string; + id: string; + isConfigurable: boolean; +} + +export type RequestMetricsProviders = () => Promise; + +const requestMetricsProvidersInjectable = getInjectable({ + id: "request-metrics-providers", + instantiate: (di): RequestMetricsProviders => { + const apiBase = di.inject(apiBaseInjectionToken); + + return () => apiBase.get("/metrics/providers"); + }, +}); + +export default requestMetricsProvidersInjectable; diff --git a/src/common/k8s-api/endpoints/namespace.api.ts b/src/common/k8s-api/endpoints/namespace.api.ts index 6a2c7e2a95..774d91cf61 100644 --- a/src/common/k8s-api/endpoints/namespace.api.ts +++ b/src/common/k8s-api/endpoints/namespace.api.ts @@ -7,8 +7,6 @@ import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; import type { ClusterScopedMetadata, KubeObjectStatus } from "../kube-object"; import { KubeObject } from "../kube-object"; -import { metricsApi } from "./metrics.api"; -import type { PodMetricData } from "./pod.api"; export enum NamespaceStatusKind { ACTIVE = "Active", @@ -45,19 +43,3 @@ export class NamespaceApi extends KubeApi { }); } } - -export function getMetricsForNamespace(namespace: string, selector = ""): Promise { - const opts = { category: "pods", pods: ".*", namespace, selector }; - - return metricsApi.getMetrics({ - cpuUsage: opts, - memoryUsage: opts, - fsUsage: opts, - fsWrites: opts, - fsReads: opts, - networkReceive: opts, - networkTransmit: opts, - }, { - namespace, - }); -} diff --git a/src/common/k8s-api/endpoints/node.api.ts b/src/common/k8s-api/endpoints/node.api.ts index 15da73311b..e1d726bed1 100644 --- a/src/common/k8s-api/endpoints/node.api.ts +++ b/src/common/k8s-api/endpoints/node.api.ts @@ -6,8 +6,6 @@ import type { BaseKubeObjectCondition, ClusterScopedMetadata } from "../kube-object"; import { KubeObject } from "../kube-object"; import { cpuUnitsToNumber, unitsToBytes, isObject } from "../../../renderer/utils"; -import type { MetricData } from "./metrics.api"; -import { metricsApi } from "./metrics.api"; import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; import { TypedRegEx } from "typed-regex"; @@ -21,32 +19,6 @@ export class NodeApi extends KubeApi { } } -export function getMetricsForAllNodes(): Promise { - const opts = { category: "nodes" }; - - return metricsApi.getMetrics({ - memoryUsage: opts, - workloadMemoryUsage: opts, - memoryCapacity: opts, - memoryAllocatableCapacity: opts, - cpuUsage: opts, - cpuCapacity: opts, - fsSize: opts, - fsUsage: opts, - }); -} - -export interface NodeMetricData extends Partial> { - memoryUsage: MetricData; - workloadMemoryUsage: MetricData; - memoryCapacity: MetricData; - memoryAllocatableCapacity: MetricData; - cpuUsage: MetricData; - cpuCapacity: MetricData; - fsUsage: MetricData; - fsSize: MetricData; -} - export interface NodeTaint { key: string; value?: string; diff --git a/src/common/k8s-api/endpoints/persistent-volume-claim.api.ts b/src/common/k8s-api/endpoints/persistent-volume-claim.api.ts index 733a9768c5..4c3c575699 100644 --- a/src/common/k8s-api/endpoints/persistent-volume-claim.api.ts +++ b/src/common/k8s-api/endpoints/persistent-volume-claim.api.ts @@ -5,8 +5,6 @@ import type { LabelSelector, NamespaceScopedMetadata, TypedLocalObjectReference } from "../kube-object"; import { KubeObject } from "../kube-object"; -import type { MetricData } from "./metrics.api"; -import { metricsApi } from "./metrics.api"; import type { Pod } from "./pod.api"; import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; @@ -22,22 +20,6 @@ export class PersistentVolumeClaimApi extends KubeApi { } } -export function getMetricsForPvc(pvc: PersistentVolumeClaim): Promise { - const opts = { category: "pvc", pvc: pvc.getName(), namespace: pvc.getNs() }; - - return metricsApi.getMetrics({ - diskUsage: opts, - diskCapacity: opts, - }, { - namespace: opts.namespace, - }); -} - -export interface PersistentVolumeClaimMetricData extends Partial> { - diskUsage: MetricData; - diskCapacity: MetricData; -} - export interface PersistentVolumeClaimSpec { accessModes?: string[]; dataSource?: TypedLocalObjectReference; diff --git a/src/common/k8s-api/endpoints/pod.api.ts b/src/common/k8s-api/endpoints/pod.api.ts index 5822c0c5ef..95dd694c1e 100644 --- a/src/common/k8s-api/endpoints/pod.api.ts +++ b/src/common/k8s-api/endpoints/pod.api.ts @@ -3,8 +3,6 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import type { MetricData } from "./metrics.api"; -import { metricsApi } from "./metrics.api"; import type { DerivedKubeApiOptions, IgnoredKubeApiOptions, ResourceDescriptor } from "../kube-api"; import { KubeApi } from "../kube-api"; import type { RequireExactlyOne } from "type-fest"; @@ -33,41 +31,6 @@ export class PodApi extends KubeApi { } } -export function getMetricsForPods(pods: Pod[], namespace: string, selector = "pod, namespace"): Promise { - const podSelector = pods.map(pod => pod.getName()).join("|"); - const opts = { category: "pods", pods: podSelector, namespace, selector }; - - return metricsApi.getMetrics({ - cpuUsage: opts, - cpuRequests: opts, - cpuLimits: opts, - memoryUsage: opts, - memoryRequests: opts, - memoryLimits: opts, - fsUsage: opts, - fsWrites: opts, - fsReads: opts, - networkReceive: opts, - networkTransmit: opts, - }, { - namespace, - }); -} - -export interface PodMetricData extends Partial> { - cpuUsage: MetricData; - memoryUsage: MetricData; - fsUsage: MetricData; - fsWrites: MetricData; - fsReads: MetricData; - networkReceive: MetricData; - networkTransmit: MetricData; - cpuRequests?: MetricData; - cpuLimits?: MetricData; - memoryRequests?: MetricData; - memoryLimits?: MetricData; -} - // Reference: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#read-log-pod-v1-core export interface PodLogsQuery { container?: string; diff --git a/src/common/k8s-api/endpoints/replica-set.api.ts b/src/common/k8s-api/endpoints/replica-set.api.ts index ea3cdc25b9..401ba6cf05 100644 --- a/src/common/k8s-api/endpoints/replica-set.api.ts +++ b/src/common/k8s-api/endpoints/replica-set.api.ts @@ -5,8 +5,6 @@ import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; -import { metricsApi } from "./metrics.api"; -import type { PodMetricData } from "./pod.api"; import type { KubeObjectStatus, LabelSelector, NamespaceScopedMetadata } from "../kube-object"; import { KubeObject } from "../kube-object"; import type { PodTemplateSpec } from "./types/pod-template-spec"; @@ -41,23 +39,6 @@ export class ReplicaSetApi extends KubeApi { } } -export function getMetricsForReplicaSets(replicasets: ReplicaSet[], namespace: string, selector = ""): Promise { - const podSelector = replicasets.map(replicaset => `${replicaset.getName()}-[[:alnum:]]{5}`).join("|"); - const opts = { category: "pods", pods: podSelector, namespace, selector }; - - return metricsApi.getMetrics({ - cpuUsage: opts, - memoryUsage: opts, - fsUsage: opts, - fsWrites: opts, - fsReads: opts, - networkReceive: opts, - networkTransmit: opts, - }, { - namespace, - }); -} - export interface ReplicaSetSpec { replicas?: number; selector: LabelSelector; diff --git a/src/common/k8s-api/endpoints/resource-applier.api.ts b/src/common/k8s-api/endpoints/resource-applier.api.ts deleted file mode 100644 index 9f0c3bb6cd..0000000000 --- a/src/common/k8s-api/endpoints/resource-applier.api.ts +++ /dev/null @@ -1,38 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import yaml from "js-yaml"; -import type { KubeJsonApiData } from "../kube-json-api"; -import { apiBase } from "../index"; -import type { Patch } from "rfc6902"; - -export const annotations = [ - "kubectl.kubernetes.io/last-applied-configuration", -]; - -export async function update(resource: object | string): Promise { - if (typeof resource === "string") { - const parsed = yaml.load(resource); - - if (!parsed || typeof parsed !== "object") { - throw new Error("Cannot update resource to string or number"); - } - - resource = parsed; - } - - return apiBase.post("/stack", { data: resource }); -} - -export async function patch(name: string, kind: string, ns: string | undefined, patch: Patch): Promise { - return apiBase.patch("/stack", { - data: { - name, - kind, - ns, - patch, - }, - }); -} diff --git a/src/common/k8s-api/endpoints/resource-applier.api/request-patch.injectable.ts b/src/common/k8s-api/endpoints/resource-applier.api/request-patch.injectable.ts new file mode 100644 index 0000000000..c8ad3435fd --- /dev/null +++ b/src/common/k8s-api/endpoints/resource-applier.api/request-patch.injectable.ts @@ -0,0 +1,30 @@ +/** + * 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 type { Patch } from "rfc6902"; +import { apiBaseInjectionToken } from "../../api-base"; +import type { KubeJsonApiData } from "../../kube-json-api"; + +export type RequestKubeObjectPatch = (name: string, kind: string, ns: string | undefined, patch: Patch) => Promise; + +const requestKubeObjectPatchInjectable = getInjectable({ + id: "request-kube-object-patch", + instantiate: (di): RequestKubeObjectPatch => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (name, kind, ns, patch) => ( + apiBase.patch("/stack", { + data: { + name, + kind, + ns, + patch, + }, + }) + ); + }, +}); + +export default requestKubeObjectPatchInjectable; diff --git a/src/common/k8s-api/endpoints/resource-applier.api/request-update.injectable.ts b/src/common/k8s-api/endpoints/resource-applier.api/request-update.injectable.ts new file mode 100644 index 0000000000..52824cd86c --- /dev/null +++ b/src/common/k8s-api/endpoints/resource-applier.api/request-update.injectable.ts @@ -0,0 +1,20 @@ +/** + * 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 "../../api-base"; +import type { KubeJsonApiData } from "../../kube-json-api"; + +export type RequestKubeObjectCreation = (resourceDescriptor: string) => Promise; + +const requestKubeObjectCreationInjectable = getInjectable({ + id: "request-kube-object-creation", + instantiate: (di): RequestKubeObjectCreation => { + const apiBase = di.inject(apiBaseInjectionToken); + + return (data) => apiBase.post("/stack", { data }); + }, +}); + +export default requestKubeObjectCreationInjectable; diff --git a/src/common/k8s-api/endpoints/stateful-set.api.ts b/src/common/k8s-api/endpoints/stateful-set.api.ts index f6e36c36fb..1d6895f934 100644 --- a/src/common/k8s-api/endpoints/stateful-set.api.ts +++ b/src/common/k8s-api/endpoints/stateful-set.api.ts @@ -5,8 +5,6 @@ import type { DerivedKubeApiOptions, IgnoredKubeApiOptions } from "../kube-api"; import { KubeApi } from "../kube-api"; -import { metricsApi } from "./metrics.api"; -import type { PodMetricData } from "./pod.api"; import type { LabelSelector, NamespaceScopedMetadata } from "../kube-object"; import { KubeObject } from "../kube-object"; import type { PodTemplateSpec } from "./types/pod-template-spec"; @@ -46,23 +44,6 @@ export class StatefulSetApi extends KubeApi { } } -export function getMetricsForStatefulSets(statefulSets: StatefulSet[], namespace: string, selector = ""): Promise { - const podSelector = statefulSets.map(statefulset => `${statefulset.getName()}-[[:digit:]]+`).join("|"); - const opts = { category: "pods", pods: podSelector, namespace, selector }; - - return metricsApi.getMetrics({ - cpuUsage: opts, - memoryUsage: opts, - fsUsage: opts, - fsWrites: opts, - fsReads: opts, - networkReceive: opts, - networkTransmit: opts, - }, { - namespace, - }); -} - export interface StatefulSetSpec { serviceName: string; replicas: number; diff --git a/src/common/k8s-api/index.ts b/src/common/k8s-api/index.ts deleted file mode 100644 index 0d47a643f3..0000000000 --- a/src/common/k8s-api/index.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -export { apiBase } from "./api-base"; -export { apiKube } from "./api-kube"; diff --git a/src/common/k8s-api/json-api.ts b/src/common/k8s-api/json-api.ts index 36b4fdd9f5..c3e07bfa94 100644 --- a/src/common/k8s-api/json-api.ts +++ b/src/common/k8s-api/json-api.ts @@ -9,12 +9,12 @@ import { Agent as HttpAgent } from "http"; import { Agent as HttpsAgent } from "https"; import { merge } from "lodash"; import type { Response, RequestInit } from "node-fetch"; -import fetch from "node-fetch"; import { stringify } from "querystring"; import type { Patch } from "rfc6902"; import type { PartialDeep, ValueOf } from "type-fest"; import { EventEmitter } from "../../common/event-emitter"; -import logger from "../../common/logger"; +import type { Logger } from "../../common/logger"; +import type { Fetch } from "../fetch/fetch.injectable"; import type { Defaulted } from "../utils"; import { json } from "../utils"; @@ -59,6 +59,11 @@ export type ParamsAndQuery = ( : Params & { query?: undefined } ); +export interface JsonApiDependencies { + fetch: Fetch; + readonly logger: Logger; +} + export class JsonApi = JsonApiParams> { static readonly reqInitDefault = { headers: { @@ -71,7 +76,7 @@ export class JsonApi = Js debug: false, }; - constructor(public readonly config: JsonApiConfig, reqInit?: RequestInit) { + constructor(protected readonly dependencies: JsonApiDependencies, public readonly config: JsonApiConfig, reqInit?: RequestInit) { this.config = Object.assign({}, JsonApi.configDefault, config); this.reqInit = merge({}, JsonApi.reqInitDefault, reqInit); this.parseResponse = this.parseResponse.bind(this); @@ -105,7 +110,7 @@ export class JsonApi = Js reqUrl += (reqUrl.includes("?") ? "&" : "?") + queryString; } - return fetch(reqUrl, reqInit); + return this.dependencies.fetch(reqUrl, reqInit); } get( @@ -177,7 +182,7 @@ export class JsonApi = Js reqInit, }; - const res = await fetch(reqUrl, reqInit); + const res = await this.dependencies.fetch(reqUrl, reqInit); return this.parseResponse(res, infoLog); } @@ -233,7 +238,7 @@ export class JsonApi = Js protected writeLog(log: JsonApiLog) { const { method, reqUrl, ...params } = log; - logger.debug(`[JSON-API] request ${method} ${reqUrl}`, params); + this.dependencies.logger.debug(`[JSON-API] request ${method} ${reqUrl}`, params); } } diff --git a/src/common/k8s-api/kube-api.ts b/src/common/k8s-api/kube-api.ts index ddc2456668..73d6ab1a82 100644 --- a/src/common/k8s-api/kube-api.ts +++ b/src/common/k8s-api/kube-api.ts @@ -5,28 +5,25 @@ // Base class for building all kubernetes apis -import { isFunction, merge } from "lodash"; +import { merge } from "lodash"; import { stringify } from "querystring"; -import { apiKubePrefix, isDevelopment } from "../../common/vars"; -import { apiBase, apiKube } from "./index"; import { createKubeApiURL, parseKubeApi } from "./kube-api-parse"; import type { KubeObjectConstructor, KubeJsonApiDataFor, KubeObjectMetadata } from "./kube-object"; import { KubeObject, KubeStatus, isKubeStatusData } from "./kube-object"; import byline from "byline"; import type { IKubeWatchEvent } from "./kube-watch-event"; -import type { KubeJsonApiData } from "./kube-json-api"; -import { KubeJsonApi } from "./kube-json-api"; +import type { KubeJsonApiData, KubeJsonApi } from "./kube-json-api"; import type { Disposer } from "../utils"; import { isDefined, noop, WrappedAbortController } from "../utils"; -import type { RequestInit } from "node-fetch"; -import type { AgentOptions } from "https"; -import { Agent } from "https"; +import type { RequestInit, Response } from "node-fetch"; import type { Patch } from "rfc6902"; import assert from "assert"; import type { PartialDeep } from "type-fest"; import logger from "../logger"; import { Environments, getEnvironmentSpecificLegacyGlobalDiForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api"; import autoRegistrationEmitterInjectable from "./api-manager/auto-registration-emitter.injectable"; +import { asLegacyGlobalForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/as-legacy-global-object-for-extension-api"; +import { apiKubeInjectionToken } from "./api-kube"; import type AbortController from "abort-controller"; /** @@ -145,146 +142,39 @@ export interface KubeApiResourceList { resources: KubeApiResource[]; } -export interface ILocalKubeApiConfig { - metadata: { - uid: string; - }; -} - export type PropagationPolicy = undefined | "Orphan" | "Foreground" | "Background"; -/** - * @deprecated - */ -export interface IKubeApiCluster extends ILocalKubeApiConfig { } - -export interface IRemoteKubeApiConfig { - cluster: { - server: string; - caData?: string; - skipTLSVerify?: boolean; - }; - user: { - token?: string | (() => Promise); - clientCertificateData?: string; - clientKeyData?: string; - }; - /** - * Custom instance of https.agent to use for the requests - * - * @remarks the custom agent replaced default agent, options skipTLSVerify, - * clientCertificateData, clientKeyData and caData are ignored. - */ - agent?: Agent; -} - -export function forCluster< - Object extends KubeObject, - Api extends KubeApi, - Data extends KubeJsonApiDataFor, ->(cluster: ILocalKubeApiConfig, kubeClass: KubeObjectConstructor, apiClass: new (apiOpts: KubeApiOptions) => Api): Api; -export function forCluster< - Object extends KubeObject, - Data extends KubeJsonApiDataFor, ->(cluster: ILocalKubeApiConfig, kubeClass: KubeObjectConstructor, apiClass?: new (apiOpts: KubeApiOptions) => KubeApi): KubeApi; - -export function forCluster< - Object extends KubeObject, - Data extends KubeJsonApiDataFor, ->(cluster: ILocalKubeApiConfig, kubeClass: KubeObjectConstructor, apiClass: (new (apiOpts: KubeApiOptions) => KubeApi) = KubeApi): KubeApi { - const url = new URL(apiBase.config.serverAddress); - const request = new KubeJsonApi({ - serverAddress: apiBase.config.serverAddress, - apiBase: apiKubePrefix, - debug: isDevelopment, - }, { - headers: { - "Host": `${cluster.metadata.uid}.localhost:${url.port}`, - }, - }); - - return new apiClass({ - objectConstructor: kubeClass as KubeObjectConstructor>, - request, - }); -} - -export function forRemoteCluster< - Object extends KubeObject, - Api extends KubeApi, - Data extends KubeJsonApiDataFor, ->(config: IRemoteKubeApiConfig, kubeClass: KubeObjectConstructor, apiClass: new (apiOpts: KubeApiOptions) => Api): Api; -export function forRemoteCluster< - Object extends KubeObject, - Data extends KubeJsonApiDataFor, ->(config: IRemoteKubeApiConfig, kubeClass: KubeObjectConstructor, apiClass?: new (apiOpts: KubeApiOptions) => KubeApi): KubeApi; - -export function forRemoteCluster< - Object extends KubeObject, - Api extends KubeApi, - Data extends KubeJsonApiDataFor, ->(config: IRemoteKubeApiConfig, kubeClass: KubeObjectConstructor, apiClass: new (apiOpts: KubeApiOptions) => KubeApi = KubeApi): KubeApi { - const reqInit: RequestInit = {}; - const agentOptions: AgentOptions = {}; - - if (config.cluster.skipTLSVerify === true) { - agentOptions.rejectUnauthorized = false; - } - - if (config.user.clientCertificateData) { - agentOptions.cert = config.user.clientCertificateData; - } - - if (config.user.clientKeyData) { - agentOptions.key = config.user.clientKeyData; - } - - if (config.cluster.caData) { - agentOptions.ca = config.cluster.caData; - } - - if (Object.keys(agentOptions).length > 0) { - reqInit.agent = new Agent(agentOptions); - } - - if (config.agent) { - reqInit.agent = config.agent; - } - - const token = config.user.token; - const request = new KubeJsonApi({ - serverAddress: config.cluster.server, - apiBase: "", - debug: isDevelopment, - ...(token ? { - getRequestOptions: async () => ({ - headers: { - "Authorization": `Bearer ${isFunction(token) ? await token() : token}`, - }, - }), - } : {}), - }, reqInit); - - if (!apiClass) { - apiClass = KubeApi as new (apiOpts: KubeApiOptions) => Api; - } - - return new apiClass({ - objectConstructor: kubeClass as KubeObjectConstructor>, - request, - }); -} - -export type KubeApiWatchCallback = (data: IKubeWatchEvent, error: any) => void; +export type KubeApiWatchCallback = (data: IKubeWatchEvent | null, error: KubeStatus | Response | null | any) => void; export interface KubeApiWatchOptions> { - namespace: string; + /** + * If the resource is namespaced then the default is `"default"` + */ + namespace?: string; + + /** + * This will be called when either an error occurs or some data is received + */ callback?: KubeApiWatchCallback; + + /** + * This is a way of aborting the request + */ abortController?: AbortController; + + /** + * The ID used for tracking within logs + */ watchId?: string; + + /** + * @default false + */ retry?: boolean; - // timeout in seconds + /** + * timeout in seconds + */ timeout?: number; } @@ -368,7 +258,7 @@ export class KubeApi< constructor(opts: KubeApiOptions) { const { objectConstructor, - request = apiKube, + request = asLegacyGlobalForExtensionApi(apiKubeInjectionToken), kind = objectConstructor.kind, isNamespaced, apiBase: fullApiPathname = objectConstructor.apiBase, @@ -411,13 +301,14 @@ export class KubeApi< */ private async getLatestApiPrefixGroup() { // Note that this.fullApiPathname is the "full" url, whereas this.apiBase is parsed - const apiBases = [this.fullApiPathname, this.objectConstructor.apiBase, ...this.fallbackApiBases ?? []]; + const rawApiBases = [ + this.fullApiPathname, + this.objectConstructor.apiBase, + ...this.fallbackApiBases ?? [], + ].filter(isDefined); + const apiBases = new Set(rawApiBases); for (const apiUrl of apiBases) { - if (!apiUrl) { - continue; - } - try { // Split e.g. "/apis/extensions/v1beta1/ingresses" to parts const { apiPrefix, apiGroup, apiVersionWithGroup, resource } = parseKubeApi(apiUrl); @@ -502,18 +393,47 @@ export class KubeApi< }); } - getUrl({ name, namespace }: Partial = {}, query?: Partial) { + /** + * This method differs from {@link formatUrlForNotListing} because this treats `""` as "all namespaces" + * @param namespace The namespace to list in or `""` for all namespaces + */ + formatUrlForListing(namespace: string) { + return createKubeApiURL({ + apiPrefix: this.apiPrefix, + apiVersion: this.apiVersionWithGroup, + resource: this.apiResource, + namespace: this.isNamespaced + ? namespace ?? "default" + : undefined, + }); + } + + /** + * Format a URL pathname and query for acting upon a specific resource. + */ + formatUrlForNotListing(resource?: Partial, query?: Partial): string; + + formatUrlForNotListing({ name, namespace }: Partial = {}, query?: Partial) { const resourcePath = createKubeApiURL({ apiPrefix: this.apiPrefix, apiVersion: this.apiVersionWithGroup, resource: this.apiResource, - namespace: this.isNamespaced ? namespace ?? "default" : undefined, + namespace: this.isNamespaced + ? namespace || "default" + : undefined, name, }); return resourcePath + (query ? `?${stringify(this.normalizeQuery(query))}` : ""); } + /** + * @deprecated use {@link formatUrlForNotListing} instead + */ + getUrl(resource?: Partial, query?: Partial) { + return this.formatUrlForNotListing(resource, query); + } + protected normalizeQuery(query: Partial = {}) { if (query.labelSelector) { query.labelSelector = [query.labelSelector].flat().join(","); @@ -591,7 +511,7 @@ export class KubeApi< async list({ namespace = "", reqInit }: KubeApiListOptions = {}, query?: KubeApiQueryParams): Promise { await this.checkPreferredVersion(); - const url = this.getUrl({ namespace }); + const url = this.formatUrlForListing(namespace); const res = await this.request.get(url, { query }, reqInit); const parsed = this.parseResponse(res, namespace); @@ -609,7 +529,7 @@ export class KubeApi< async get(desc: ResourceDescriptor, query?: KubeApiQueryParams): Promise { await this.checkPreferredVersion(); - const url = this.getUrl(desc); + const url = this.formatUrlForNotListing(desc); const res = await this.request.get(url, { query }); const parsed = this.parseResponse(res); @@ -623,7 +543,7 @@ export class KubeApi< async create({ name, namespace }: Partial, partialData?: PartialDeep): Promise { await this.checkPreferredVersion(); - const apiUrl = this.getUrl({ namespace }); + const apiUrl = this.formatUrlForNotListing({ namespace }); const data = merge(partialData, { kind: this.kind, apiVersion: this.apiVersionWithGroup, @@ -644,7 +564,7 @@ export class KubeApi< async update({ name, namespace }: ResourceDescriptor, data: PartialDeep): Promise { await this.checkPreferredVersion(); - const apiUrl = this.getUrl({ namespace, name }); + const apiUrl = this.formatUrlForNotListing({ namespace, name }); const res = await this.request.put(apiUrl, { data: merge(data, { @@ -663,9 +583,13 @@ export class KubeApi< return parsed; } + async patch(desc: ResourceDescriptor, data: PartialDeep): Promise; + async patch(desc: ResourceDescriptor, data: PartialDeep, strategy: "strategic" | "merge"): Promise; + async patch(desc: ResourceDescriptor, data: Patch, strategy: "json"): Promise; + async patch(desc: ResourceDescriptor, data: PartialDeep | Patch, strategy: KubeApiPatchType): Promise; async patch(desc: ResourceDescriptor, data: PartialDeep | Patch, strategy: KubeApiPatchType = "strategic"): Promise { await this.checkPreferredVersion(); - const apiUrl = this.getUrl(desc); + const apiUrl = this.formatUrlForNotListing(desc); const res = await this.request.patch(apiUrl, { data }, { headers: { @@ -683,7 +607,7 @@ export class KubeApi< async delete({ propagationPolicy = "Background", ...desc }: DeleteResourceDescriptor) { await this.checkPreferredVersion(); - const apiUrl = this.getUrl(desc); + const apiUrl = this.formatUrlForNotListing(desc); return this.request.del(apiUrl, { query: { @@ -692,22 +616,27 @@ export class KubeApi< }); } - getWatchUrl(namespace = "", query: KubeApiQueryParams = {}) { - return this.getUrl({ namespace }, { + getWatchUrl(namespace?: string, query: KubeApiQueryParams = {}) { + return this.formatUrlForNotListing({ namespace }, { watch: 1, resourceVersion: this.getResourceVersion(namespace), ...query, }); } - watch(opts: KubeApiWatchOptions = { namespace: "", retry: false }): () => void { + watch(opts?: KubeApiWatchOptions): () => void { let errorReceived = false; let timedRetry: NodeJS.Timeout; - const { namespace, callback = noop, retry, timeout } = opts; - const { watchId = `${this.kind.toLowerCase()}-${this.watchId++}` } = opts; + const { + namespace, + callback = noop as KubeApiWatchCallback, + retry = false, + timeout, + watchId = `${this.kind.toLowerCase()}-${this.watchId++}`, + } = opts ?? {}; // Create AbortController for this request - const abortController = new WrappedAbortController(opts.abortController); + const abortController = new WrappedAbortController(opts?.abortController); abortController.signal.addEventListener("abort", () => { logger.info(`[KUBE-API] watch (${watchId}) aborted ${watchUrl}`); @@ -778,7 +707,7 @@ export class KubeApi< byline(response.body).on("data", (line) => { try { - const event = JSON.parse(line) as IKubeWatchEvent>; + const event = JSON.parse(line) as IKubeWatchEvent; if (event.type === "ERROR" && isKubeStatusData(event.object)) { errorReceived = true; diff --git a/src/common/k8s-api/kube-json-api.ts b/src/common/k8s-api/kube-json-api.ts index 2624f030c8..16ca5cda70 100644 --- a/src/common/k8s-api/kube-json-api.ts +++ b/src/common/k8s-api/kube-json-api.ts @@ -6,8 +6,6 @@ import type { JsonApiData, JsonApiError } from "./json-api"; import { JsonApi } from "./json-api"; import type { Response } from "node-fetch"; -import { apiKubePrefix, isDebugging } from "../vars"; -import { apiBase } from "./api-base"; import type { KubeJsonApiObjectMetadata } from "./kube-object"; export interface KubeJsonApiListMetadata { @@ -47,20 +45,6 @@ export interface KubeJsonApiError extends JsonApiError { } export class KubeJsonApi extends JsonApi { - static forCluster(clusterId: string): KubeJsonApi { - const url = new URL(apiBase.config.serverAddress); - - return new this({ - serverAddress: apiBase.config.serverAddress, - apiBase: apiKubePrefix, - debug: isDebugging, - }, { - headers: { - "Host": `${clusterId}.localhost:${url.port}`, - }, - }); - } - protected parseError(error: KubeJsonApiError | string, res: Response): string[] { if (typeof error === "string") { return [error]; diff --git a/src/common/k8s-api/kube-object.ts b/src/common/k8s-api/kube-object.ts index 0851729bc7..24e34eff4b 100644 --- a/src/common/k8s-api/kube-object.ts +++ b/src/common/k8s-api/kube-object.ts @@ -9,11 +9,15 @@ import moment from "moment"; import type { KubeJsonApiData, KubeJsonApiDataList, KubeJsonApiListMetadata } from "./kube-json-api"; import { autoBind, formatDuration, hasOptionalTypedProperty, hasTypedProperty, isObject, isString, isNumber, bindPredicate, isTypedArray, isRecord, json } from "../utils"; import type { ItemObject } from "../item.store"; -import { apiKube } from "./index"; -import * as resourceApplierApi from "./endpoints/resource-applier.api"; import type { Patch } from "rfc6902"; import assert from "assert"; import type { JsonObject } from "type-fest"; +import { asLegacyGlobalFunctionForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/as-legacy-global-function-for-extension-api"; +import requestKubeObjectPatchInjectable from "./endpoints/resource-applier.api/request-patch.injectable"; +import { asLegacyGlobalForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/as-legacy-global-object-for-extension-api"; +import { apiKubeInjectionToken } from "./api-kube"; +import requestKubeObjectCreationInjectable from "./endpoints/resource-applier.api/request-update.injectable"; +import { dump } from "js-yaml"; export type KubeJsonApiDataFor = K extends KubeObject ? KubeJsonApiData @@ -375,6 +379,12 @@ export type ScopedNamespace = ( : string | undefined ); +const resourceApplierAnnotationsForFiltering = [ + "kubectl.kubernetes.io/last-applied-configuration", +]; + +const filterOutResourceApplierAnnotations = (label: string) => !resourceApplierAnnotationsForFiltering.some(key => label.startsWith(key)); + export class KubeObject< Metadata extends KubeObjectMetadata = KubeObjectMetadata, Status = unknown, @@ -588,11 +598,11 @@ export class KubeObject< getAnnotations(filter = false): string[] { const labels = KubeObject.stringifyLabels(this.metadata.annotations); - return filter ? labels.filter(label => { - const skip = resourceApplierApi.annotations.some(key => label.startsWith(key)); + if (!filter) { + return labels; + } - return !skip; - }) : labels; + return labels.filter(filterOutResourceApplierAnnotations); } getOwnerRefs() { @@ -634,7 +644,9 @@ export class KubeObject< } } - return resourceApplierApi.patch(this.getName(), this.kind, this.getNs(), patch); + const requestKubeObjectPatch = asLegacyGlobalFunctionForExtensionApi(requestKubeObjectPatchInjectable); + + return requestKubeObjectPatch(this.getName(), this.kind, this.getNs(), patch); } /** @@ -647,11 +659,13 @@ export class KubeObject< * @deprecated use KubeApi.update instead */ async update(data: Partial): Promise { - // use unified resource-applier api for updating all k8s objects - return resourceApplierApi.update({ + const requestKubeObjectCreation = asLegacyGlobalFunctionForExtensionApi(requestKubeObjectCreationInjectable); + const descriptor = dump({ ...this.toPlainObject(), ...data, }); + + return requestKubeObjectCreation(descriptor); } /** @@ -660,6 +674,8 @@ export class KubeObject< delete(params?: object) { assert(this.selfLink, "selfLink must be present to delete self"); + const apiKube = asLegacyGlobalForExtensionApi(apiKubeInjectionToken); + return apiKube.del(this.selfLink, params); } } diff --git a/src/common/k8s-api/window-location.global-override-for-injectable.ts b/src/common/k8s-api/window-location.global-override-for-injectable.ts new file mode 100644 index 0000000000..616e110c88 --- /dev/null +++ b/src/common/k8s-api/window-location.global-override-for-injectable.ts @@ -0,0 +1,12 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import windowLocationInjectable from "./window-location.injectable"; + +export default getGlobalOverride(windowLocationInjectable, () => ({ + host: "localhost", + port: "12345", +})); diff --git a/src/common/k8s-api/window-location.injectable.ts b/src/common/k8s-api/window-location.injectable.ts new file mode 100644 index 0000000000..80bcd44be6 --- /dev/null +++ b/src/common/k8s-api/window-location.injectable.ts @@ -0,0 +1,17 @@ +/** + * 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"; + +const windowLocationInjectable = getInjectable({ + id: "window-location", + instantiate: () => { + const { host, port } = window.location; + + return { host, port }; + }, + causesSideEffects: true, +}); + +export default windowLocationInjectable; diff --git a/src/common/kube-helpers.ts b/src/common/kube-helpers.ts index f24d4dbe2d..dc388efbc8 100644 --- a/src/common/kube-helpers.ts +++ b/src/common/kube-helpers.ts @@ -4,31 +4,14 @@ */ import { KubeConfig } from "@kubernetes/client-node"; -import fse from "fs-extra"; -import path from "path"; -import os from "os"; import yaml from "js-yaml"; import logger from "../main/logger"; import type { Cluster, Context, User } from "@kubernetes/client-node/dist/config_types"; import { newClusters, newContexts, newUsers } from "@kubernetes/client-node/dist/config_types"; -import { isDefined, resolvePath } from "./utils"; +import { isDefined } from "./utils"; import Joi from "joi"; import type { PartialDeep } from "type-fest"; -export const kubeConfigDefaultPath = path.join(os.homedir(), ".kube", "config"); - -export function loadConfigFromFileSync(filePath: string): ConfigResult { - const content = fse.readFileSync(resolvePath(filePath), "utf-8"); - - return loadConfigFromString(content); -} - -export async function loadConfigFromFile(filePath: string): Promise { - const content = await fse.readFile(resolvePath(filePath), "utf-8"); - - return loadConfigFromString(content); -} - const clusterSchema = Joi.object({ name: Joi .string() diff --git a/src/common/kube-helpers/load-config-from-file.injectable.ts b/src/common/kube-helpers/load-config-from-file.injectable.ts new file mode 100644 index 0000000000..afa9d3c070 --- /dev/null +++ b/src/common/kube-helpers/load-config-from-file.injectable.ts @@ -0,0 +1,23 @@ +/** + * 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 readFileInjectable from "../fs/read-file.injectable"; +import type { ConfigResult } from "../kube-helpers"; +import { loadConfigFromString } from "../kube-helpers"; +import resolveTildeInjectable from "../path/resolve-tilde.injectable"; + +export type LoadConfigfromFile = (filePath: string) => Promise; + +const loadConfigfromFileInjectable = getInjectable({ + id: "load-configfrom-file", + instantiate: (di): LoadConfigfromFile => { + const readFile = di.inject(readFileInjectable); + const resolveTilde = di.inject(resolveTildeInjectable); + + return async (filePath) => loadConfigFromString(await readFile(resolveTilde(filePath))); + }, +}); + +export default loadConfigfromFileInjectable; diff --git a/src/common/os/home-directory-path.global-override-for-injectable.ts b/src/common/os/home-directory-path.global-override-for-injectable.ts new file mode 100644 index 0000000000..f5869831a6 --- /dev/null +++ b/src/common/os/home-directory-path.global-override-for-injectable.ts @@ -0,0 +1,9 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import homeDirectoryPathInjectable from "./home-directory-path.injectable"; + +export default getGlobalOverride(homeDirectoryPathInjectable, () => "/some-home-directory"); diff --git a/src/common/os/home-directory-path.injectable.ts b/src/common/os/home-directory-path.injectable.ts new file mode 100644 index 0000000000..b6ba1dfee0 --- /dev/null +++ b/src/common/os/home-directory-path.injectable.ts @@ -0,0 +1,14 @@ +/** + * 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 { homedir } from "os"; + +const homeDirectoryPathInjectable = getInjectable({ + id: "home-directory-path", + instantiate: () => homedir(), + causesSideEffects: true, +}); + +export default homeDirectoryPathInjectable; diff --git a/src/common/os/temp-directory-path.global-override-for-injectable.ts b/src/common/os/temp-directory-path.global-override-for-injectable.ts new file mode 100644 index 0000000000..05615644f9 --- /dev/null +++ b/src/common/os/temp-directory-path.global-override-for-injectable.ts @@ -0,0 +1,9 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import tempDirectoryPathInjectable from "./temp-directory-path.injectable"; + +export default getGlobalOverride(tempDirectoryPathInjectable, () => "/some-temp-directory"); diff --git a/src/common/os/temp-directory-path.injectable.ts b/src/common/os/temp-directory-path.injectable.ts new file mode 100644 index 0000000000..46fc5db67d --- /dev/null +++ b/src/common/os/temp-directory-path.injectable.ts @@ -0,0 +1,14 @@ +/** + * 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 { tmpdir } from "os"; + +const tempDirectoryPathInjectable = getInjectable({ + id: "temp-directory-path", + instantiate: () => tmpdir(), + causesSideEffects: true, +}); + +export default tempDirectoryPathInjectable; diff --git a/src/common/path/get-absolute-path.global-override-for-injectable.ts b/src/common/path/get-absolute-path.global-override-for-injectable.ts new file mode 100644 index 0000000000..15f377cb2c --- /dev/null +++ b/src/common/path/get-absolute-path.global-override-for-injectable.ts @@ -0,0 +1,10 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import path from "path"; +import { getGlobalOverride } from "../test-utils/get-global-override"; +import getAbsolutePathInjectable from "./get-absolute-path.injectable"; + +export default getGlobalOverride(getAbsolutePathInjectable, () => path.posix.resolve); diff --git a/src/common/path/get-basename.global-override-for-injectable.ts b/src/common/path/get-basename.global-override-for-injectable.ts new file mode 100644 index 0000000000..913ec9c5c2 --- /dev/null +++ b/src/common/path/get-basename.global-override-for-injectable.ts @@ -0,0 +1,10 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import path from "path"; +import { getGlobalOverride } from "../test-utils/get-global-override"; +import getBasenameOfPathInjectable from "./get-basename.injectable"; + +export default getGlobalOverride(getBasenameOfPathInjectable, () => path.posix.basename); diff --git a/src/common/path/get-basename.injectable.ts b/src/common/path/get-basename.injectable.ts new file mode 100644 index 0000000000..be92bde7f5 --- /dev/null +++ b/src/common/path/get-basename.injectable.ts @@ -0,0 +1,16 @@ +/** + * 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 path from "path"; + +export type GetBasenameOfPath = (path: string) => string; + +const getBasenameOfPathInjectable = getInjectable({ + id: "get-basename-of-path", + instantiate: (): GetBasenameOfPath => path.basename, + causesSideEffects: true, +}); + +export default getBasenameOfPathInjectable; diff --git a/src/common/path/get-dirname.global-override-for-injectable.ts b/src/common/path/get-dirname.global-override-for-injectable.ts new file mode 100644 index 0000000000..ed694de182 --- /dev/null +++ b/src/common/path/get-dirname.global-override-for-injectable.ts @@ -0,0 +1,10 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import path from "path"; +import { getGlobalOverride } from "../test-utils/get-global-override"; +import getDirnameOfPathInjectable from "./get-dirname.injectable"; + +export default getGlobalOverride(getDirnameOfPathInjectable, () => path.posix.dirname); diff --git a/src/common/path/get-dirname.injectable.ts b/src/common/path/get-dirname.injectable.ts new file mode 100644 index 0000000000..93b4496767 --- /dev/null +++ b/src/common/path/get-dirname.injectable.ts @@ -0,0 +1,16 @@ +/** + * 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 path from "path"; + +export type GetDirnameOfPath = (path: string) => string; + +const getDirnameOfPathInjectable = getInjectable({ + id: "get-dirname-of-path", + instantiate: (): GetDirnameOfPath => path.dirname, + causesSideEffects: true, +}); + +export default getDirnameOfPathInjectable; diff --git a/src/common/path/get-relative-path.global-override-for-injectable.ts b/src/common/path/get-relative-path.global-override-for-injectable.ts new file mode 100644 index 0000000000..9e96b70301 --- /dev/null +++ b/src/common/path/get-relative-path.global-override-for-injectable.ts @@ -0,0 +1,10 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import path from "path"; +import { getGlobalOverride } from "../test-utils/get-global-override"; +import getRelativePathInjectable from "./get-relative-path.injectable"; + +export default getGlobalOverride(getRelativePathInjectable, () => path.posix.relative); diff --git a/src/common/path/get-relative-path.injectable.ts b/src/common/path/get-relative-path.injectable.ts new file mode 100644 index 0000000000..18b5d832de --- /dev/null +++ b/src/common/path/get-relative-path.injectable.ts @@ -0,0 +1,16 @@ +/** + * 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 path from "path"; + +export type GetRelativePath = (from: string, to: string) => string; + +const getRelativePathInjectable = getInjectable({ + id: "get-relative-path", + instantiate: (): GetRelativePath => path.relative, + causesSideEffects: true, +}); + +export default getRelativePathInjectable; diff --git a/src/common/path/is-logical-child-path.injectable.ts b/src/common/path/is-logical-child-path.injectable.ts new file mode 100644 index 0000000000..1a52b66c0f --- /dev/null +++ b/src/common/path/is-logical-child-path.injectable.ts @@ -0,0 +1,51 @@ +/** + * 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 getAbsolutePathInjectable from "./get-absolute-path.injectable"; +import getDirnameOfPathInjectable from "./get-dirname.injectable"; + +/** + * Checks if `testPath` represents a potential filesystem entry that would be + * logically "within" the `parentPath` directory. + * + * This function will return `true` in the above case, and `false` otherwise. + * It will return `false` if the two paths are the same (after resolving them). + * + * The function makes no FS calls and is platform dependant. Meaning that the + * results are only guaranteed to be correct for the platform you are running + * on. + * @param parentPath The known path of a directory + * @param testPath The path that is to be tested + */ +export type IsLogicalChildPath = (parentPath: string, testPath: string) => boolean; + +const isLogicalChildPathInjectable = getInjectable({ + id: "is-logical-child-path", + instantiate: (di): IsLogicalChildPath => { + const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const getDirnameOfPath = di.inject(getDirnameOfPathInjectable); + + return (parentPath, testPath) => { + const resolvedParentPath = getAbsolutePath(parentPath); + let resolvedTestPath = getAbsolutePath(testPath); + + if (resolvedParentPath === resolvedTestPath) { + return false; + } + + while (resolvedTestPath.length >= resolvedParentPath.length) { + if (resolvedTestPath === resolvedParentPath) { + return true; + } + + resolvedTestPath = getDirnameOfPath(resolvedTestPath); + } + + return false; + }; + }, +}); + +export default isLogicalChildPathInjectable; diff --git a/src/common/path/join-paths.global-override-for-injectable.ts b/src/common/path/join-paths.global-override-for-injectable.ts new file mode 100644 index 0000000000..d3e9d5e4c2 --- /dev/null +++ b/src/common/path/join-paths.global-override-for-injectable.ts @@ -0,0 +1,10 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import path from "path"; +import { getGlobalOverride } from "../test-utils/get-global-override"; +import joinPathsInjectable from "./join-paths.injectable"; + +export default getGlobalOverride(joinPathsInjectable, () => path.posix.join); diff --git a/src/common/path/parse.global-override-for-injectable.ts b/src/common/path/parse.global-override-for-injectable.ts new file mode 100644 index 0000000000..fad97db696 --- /dev/null +++ b/src/common/path/parse.global-override-for-injectable.ts @@ -0,0 +1,10 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import path from "path"; +import { getGlobalOverride } from "../test-utils/get-global-override"; +import parsePathInjectable from "./parse.injectable"; + +export default getGlobalOverride(parsePathInjectable, () => path.posix.parse); diff --git a/src/common/path/parse.injectable.ts b/src/common/path/parse.injectable.ts new file mode 100644 index 0000000000..a32dfb3fa5 --- /dev/null +++ b/src/common/path/parse.injectable.ts @@ -0,0 +1,14 @@ +/** + * 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 path from "path"; + +const parsePathInjectable = getInjectable({ + id: "parse-path", + instantiate: () => path.parse, + causesSideEffects: true, +}); + +export default parsePathInjectable; diff --git a/src/common/path/resolve-path.injectable.ts b/src/common/path/resolve-path.injectable.ts new file mode 100644 index 0000000000..75a1e98c59 --- /dev/null +++ b/src/common/path/resolve-path.injectable.ts @@ -0,0 +1,21 @@ +/** + * 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 getAbsolutePathInjectable from "./get-absolute-path.injectable"; +import resolveTildeInjectable from "./resolve-tilde.injectable"; + +export type ResolvePath = (path: string) => string; + +const resolvePathInjectable = getInjectable({ + id: "resolve-path", + instantiate: (di): ResolvePath => { + const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const resolveTilde = di.inject(resolveTildeInjectable); + + return (filePath) => getAbsolutePath(resolveTilde(filePath)); + }, +}); + +export default resolvePathInjectable; diff --git a/src/common/path/resolve-tilde.injectable.ts b/src/common/path/resolve-tilde.injectable.ts new file mode 100644 index 0000000000..86d267aa4f --- /dev/null +++ b/src/common/path/resolve-tilde.injectable.ts @@ -0,0 +1,31 @@ +/** + * 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 homeDirectoryPathInjectable from "../os/home-directory-path.injectable"; +import fileSystemSeparatorInjectable from "./separator.injectable"; + +export type ResolveTilde = (path: string) => string; + +const resolveTildeInjectable = getInjectable({ + id: "resolve-tilde", + instantiate: (di): ResolveTilde => { + const homeDirectoryPath = di.inject(homeDirectoryPathInjectable); + const fileSystemSeparator = di.inject(fileSystemSeparatorInjectable); + + return (filePath) => { + if (filePath === "~") { + return homeDirectoryPath; + } + + if (filePath === `~${fileSystemSeparator}`) { + return `${homeDirectoryPath}${filePath.slice(1)}`; + } + + return filePath; + }; + }, +}); + +export default resolveTildeInjectable; diff --git a/src/common/path/separator.global-override-for-injectable.ts b/src/common/path/separator.global-override-for-injectable.ts new file mode 100644 index 0000000000..655f8908b0 --- /dev/null +++ b/src/common/path/separator.global-override-for-injectable.ts @@ -0,0 +1,10 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import path from "path"; +import { getGlobalOverride } from "../test-utils/get-global-override"; +import fileSystemSeparatorInjectable from "./separator.injectable"; + +export default getGlobalOverride(fileSystemSeparatorInjectable, () => path.posix.sep); diff --git a/src/common/path/separator.injectable.ts b/src/common/path/separator.injectable.ts new file mode 100644 index 0000000000..5b0413b56f --- /dev/null +++ b/src/common/path/separator.injectable.ts @@ -0,0 +1,14 @@ +/** + * 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 path from "path"; + +const fileSystemSeparatorInjectable = getInjectable({ + id: "file-system-separator", + instantiate: () => path.sep, + causesSideEffects: true, +}); + +export default fileSystemSeparatorInjectable; diff --git a/src/common/test-utils/get-absolute-path-fake.ts b/src/common/test-utils/get-absolute-path-fake.ts deleted file mode 100644 index 89b5faa446..0000000000 --- a/src/common/test-utils/get-absolute-path-fake.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import type { GetAbsolutePath } from "../path/get-absolute-path.injectable"; - -export const getAbsolutePathFake: GetAbsolutePath = (...args) => { - const maybeAbsolutePath = args.join("/"); - - if (isAbsolutePath(maybeAbsolutePath)) { - return maybeAbsolutePath; - } - - return `/some-absolute-root-directory/${maybeAbsolutePath}`; -}; - -const isAbsolutePath = (path: string) => path.startsWith("/"); diff --git a/src/common/test-utils/join-paths-fake.ts b/src/common/test-utils/join-paths-fake.ts deleted file mode 100644 index 2796423d3c..0000000000 --- a/src/common/test-utils/join-paths-fake.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import type { JoinPaths } from "../path/join-paths.injectable"; - -export const joinPathsFake: JoinPaths = (...args) => args.join("/"); diff --git a/src/common/user-store/file-name-migration.injectable.ts b/src/common/user-store/file-name-migration.injectable.ts index caf94dc491..106f559ef0 100644 --- a/src/common/user-store/file-name-migration.injectable.ts +++ b/src/common/user-store/file-name-migration.injectable.ts @@ -4,10 +4,10 @@ */ import fse from "fs-extra"; -import path from "path"; import directoryForUserDataInjectable from "../app-paths/directory-for-user-data/directory-for-user-data.injectable"; import { isErrnoException } from "../utils"; import { getInjectable } from "@ogre-tools/injectable"; +import joinPathsInjectable from "../path/join-paths.injectable"; export type UserStoreFileNameMigration = () => Promise; @@ -15,8 +15,9 @@ const userStoreFileNameMigrationInjectable = getInjectable({ id: "user-store-file-name-migration", instantiate: (di): UserStoreFileNameMigration => { const userDataPath = di.inject(directoryForUserDataInjectable); - const configJsonPath = path.join(userDataPath, "config.json"); - const lensUserStoreJsonPath = path.join(userDataPath, "lens-user-store.json"); + const joinPaths = di.inject(joinPathsInjectable); + const configJsonPath = joinPaths(userDataPath, "config.json"); + const lensUserStoreJsonPath = joinPaths(userDataPath, "lens-user-store.json"); return async () => { try { diff --git a/src/common/user-store/user-store.ts b/src/common/user-store/user-store.ts index 6c995996bf..8a8ff6735c 100644 --- a/src/common/user-store/user-store.ts +++ b/src/common/user-store/user-store.ts @@ -7,7 +7,6 @@ import { app } from "electron"; import { action, computed, observable, reaction, makeObservable, isObservableArray, isObservableSet, isObservableMap } from "mobx"; import { BaseStore } from "../base-store"; import migrations from "../../migrations/user-store"; -import { kubeConfigDefaultPath } from "../kube-helpers"; import { getOrInsertSet, toggle, toJS, object } from "../../renderer/utils"; import { DESCRIPTORS } from "./preferences-helpers"; import type { UserPreferencesModel, StoreType } from "./preferences-helpers"; @@ -38,12 +37,6 @@ export class UserStore extends BaseStore /* implements UserStore @observable lastSeenAppVersion = "0.0.0"; - /** - * used in add-cluster page for providing context - * @deprecated No longer used - */ - @observable kubeConfigPath = kubeConfigDefaultPath; - /** * @deprecated No longer used */ diff --git a/src/common/utils/__tests__/paths.test.ts b/src/common/utils/__tests__/paths.test.ts index f5e8a7ccf5..5a52843432 100644 --- a/src/common/utils/__tests__/paths.test.ts +++ b/src/common/utils/__tests__/paths.test.ts @@ -3,12 +3,29 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import { describeIf } from "../../../../integration/helpers/utils"; -import { isWindows } from "../../vars"; -import { isLogicalChildPath } from "../paths"; +import type { DiContainer } from "@ogre-tools/injectable"; +import path from "path"; +import { getDiForUnitTesting } from "../../../main/getDiForUnitTesting"; +import getAbsolutePathInjectable from "../../path/get-absolute-path.injectable"; +import getDirnameOfPathInjectable from "../../path/get-dirname.injectable"; +import type { IsLogicalChildPath } from "../../path/is-logical-child-path.injectable"; +import isLogicalChildPathInjectable from "../../path/is-logical-child-path.injectable"; describe("isLogicalChildPath", () => { - describeIf(isWindows)("windows tests", () => { + let di: DiContainer; + let isLogicalChildPath: IsLogicalChildPath; + + beforeEach(() => { + di = getDiForUnitTesting(); + }); + + describe("when using win32 paths", () => { + beforeEach(() => { + di.override(getAbsolutePathInjectable, () => path.win32.resolve); + di.override(getDirnameOfPathInjectable, () => path.win32.dirname); + isLogicalChildPath = di.inject(isLogicalChildPathInjectable); + }); + it.each([ { parentPath: "C:\\Foo", @@ -40,7 +57,13 @@ describe("isLogicalChildPath", () => { }); }); - describeIf(!isWindows)("posix tests", () => { + describe("when using posix paths", () => { + beforeEach(() => { + di.override(getAbsolutePathInjectable, () => path.posix.resolve); + di.override(getDirnameOfPathInjectable, () => path.posix.dirname); + isLogicalChildPath = di.inject(isLogicalChildPathInjectable); + }); + it.each([ { parentPath: "/foo", diff --git a/src/common/utils/buildUrl.ts b/src/common/utils/buildUrl.ts index 61639cea4d..82d114cd08 100644 --- a/src/common/utils/buildUrl.ts +++ b/src/common/utils/buildUrl.ts @@ -35,3 +35,24 @@ export function buildURLPositional

return buildURL(path, { params, query, fragment }); }; } + +export type UrlParamsFor = + Pathname extends `${string}/:${infer A}?/${infer Tail}` + ? Partial> & UrlParamsFor<`/${Tail}`> + : Pathname extends `${string}/:${infer A}/${infer Tail}` + ? Record & UrlParamsFor<`/${Tail}`> + : Pathname extends `${string}/:${infer A}?` + ? Partial> + : Pathname extends `${string}/:${infer A}` + ? Record + : {}; + +export interface UrlBuilder { + compile(params: UrlParamsFor, query?: object, fragment?: string): string; +} + +export function urlBuilderFor(pathname: Pathname): UrlBuilder { + return { + compile: buildURLPositional(pathname), + }; +} diff --git a/src/common/utils/channel/request-from-channel-injection-token.ts b/src/common/utils/channel/request-from-channel-injection-token.ts index 5f4492543f..f4d4fdbe0c 100644 --- a/src/common/utils/channel/request-from-channel-injection-token.ts +++ b/src/common/utils/channel/request-from-channel-injection-token.ts @@ -12,7 +12,7 @@ export type RequestFromChannel = < channel: TChannel, ...request: TChannel["_requestSignature"] extends void ? [] - : [TChannel["_requestSignature"]] + : [SetRequired["_requestSignature"]] ) => Promise["_responseSignature"]>; export const requestFromChannelInjectionToken = diff --git a/src/common/utils/date/get-current-date-time.ts b/src/common/utils/date/get-current-date-time.ts index bf3df2bd78..aa4d5e7fa3 100644 --- a/src/common/utils/date/get-current-date-time.ts +++ b/src/common/utils/date/get-current-date-time.ts @@ -5,3 +5,7 @@ import moment from "moment"; export const getCurrentDateTime = () => moment().utc().format(); + +export const getMillisecondsFromUnixEpoch = () => Date.now(); + +export const getSecondsFromUnixEpoch = () => Math.floor(getMillisecondsFromUnixEpoch() / 1000); diff --git a/src/common/utils/index.ts b/src/common/utils/index.ts index e16f803c56..a9acaede86 100644 --- a/src/common/utils/index.ts +++ b/src/common/utils/index.ts @@ -22,7 +22,6 @@ export * from "./hash-set"; export * from "./n-fircate"; export * from "./noop"; export * from "./observable-crate/impl"; -export * from "./paths"; export * from "./promise-exec"; export * from "./readonly"; export * from "./reject-promise"; diff --git a/src/common/utils/paths.ts b/src/common/utils/paths.ts deleted file mode 100644 index ed31e612fb..0000000000 --- a/src/common/utils/paths.ts +++ /dev/null @@ -1,55 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import path from "path"; -import os from "os"; - -export function resolveTilde(filePath: string) { - if (filePath === "~") { - return os.homedir(); - } - - if (filePath.startsWith("~/")) { - return `${os.homedir()}${filePath.slice(1)}`; - } - - return filePath; -} - -export function resolvePath(filePath: string): string { - return path.resolve(resolveTilde(filePath)); -} - -/** - * Checks if `testPath` represents a potential filesystem entry that would be - * logically "within" the `parentPath` directory. - * - * This function will return `true` in the above case, and `false` otherwise. - * It will return `false` if the two paths are the same (after resolving them). - * - * The function makes no FS calls and is platform dependant. Meaning that the - * results are only guaranteed to be correct for the platform you are running - * on. - * @param parentPath The known path of a directory - * @param testPath The path that is to be tested - */ -export function isLogicalChildPath(parentPath: string, testPath: string): boolean { - parentPath = path.resolve(parentPath); - testPath = path.resolve(testPath); - - if (parentPath === testPath) { - return false; - } - - while (testPath.length >= parentPath.length) { - if (testPath === parentPath) { - return true; - } - - testPath = path.dirname(testPath); - } - - return false; -} diff --git a/src/common/utils/sort-compare.ts b/src/common/utils/sort-compare.ts index ee32ab45c4..35d88c01b9 100644 --- a/src/common/utils/sort-compare.ts +++ b/src/common/utils/sort-compare.ts @@ -3,11 +3,7 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import type { SemVer } from "semver"; import semver, { coerce } from "semver"; -import * as iter from "./iter"; -import type { RawHelmChart } from "../k8s-api/endpoints/helm-charts.api"; -import logger from "../logger"; export enum Ordering { LESS = -1, @@ -49,52 +45,31 @@ export function sortCompare(left: T, right: T): Ordering { return Ordering.GREATER; } -interface ChartVersion { - version: string; - __version?: SemVer | null; -} - -export function sortCompareChartVersions(left: ChartVersion, right: ChartVersion): Ordering { - if (left.__version && right.__version) { - return semver.compare(right.__version, left.__version); - } - - if (!left.__version && right.__version) { - return Ordering.GREATER; - } - - if (left.__version && !right.__version) { - return Ordering.LESS; - } - - return sortCompare(left.version, right.version); -} - - - -export function sortCharts(charts: RawHelmChart[]) { - interface ExtendedHelmChart extends RawHelmChart { - __version?: SemVer | null; - } - - const chartsWithVersion = Array.from( - iter.map( - charts, - chart => { - const __version = coerce(chart.version, { loose: true }); - - if (!__version) { - logger.warn(`[HELM-SERVICE]: Version from helm chart is not loosely coercable to semver.`, { name: chart.name, version: chart.version, repo: chart.repo }); - } - - (chart as ExtendedHelmChart).__version = __version; - - return chart as ExtendedHelmChart; - }, - ), - ); - - return chartsWithVersion - .sort(sortCompareChartVersions) - .map(chart => (delete chart.__version, chart as RawHelmChart)); +/** + * This function sorts of list of items that have what should be a semver version formated string + * as the field `version` but if it is not loosely coercable to semver falls back to sorting them + * alphanumerically + */ +export function sortBySemverVersion(versioneds: T[]): T[] { + return versioneds + .map(versioned => ({ + __version: coerce(versioned.version, { loose: true }), + raw: versioned, + })) + .sort((left, right) => { + if (left.__version && right.__version) { + return semver.compare(right.__version, left.__version); + } + + if (!left.__version && right.__version) { + return Ordering.GREATER; + } + + if (left.__version && !right.__version) { + return Ordering.LESS; + } + + return sortCompare(left.raw.version, right.raw.version); + }) + .map(({ raw }) => raw); } diff --git a/src/common/utils/tar.ts b/src/common/utils/tar.ts index d351ec2507..58008dfe9d 100644 --- a/src/common/utils/tar.ts +++ b/src/common/utils/tar.ts @@ -5,7 +5,7 @@ // Helper for working with tarball files (.tar, .tgz) // Docs: https://github.com/npm/node-tar -import type { ExtractOptions, FileStat } from "tar"; +import type { FileStat } from "tar"; import tar from "tar"; import path from "path"; import { parse } from "./json"; @@ -62,18 +62,10 @@ export async function listTarEntries(filePath: string): Promise { await tar.list({ file: filePath, - onentry: (entry: FileStat) => { + onentry: (entry) => { entries.push(path.normalize(entry.path as unknown as string)); }, }); return entries; } - -export function extractTar(filePath: string, opts: ExtractOptions & { sync?: boolean } = {}) { - return tar.extract({ - file: filePath, - cwd: path.dirname(filePath), - ...opts, - }); -} diff --git a/src/common/vars.ts b/src/common/vars.ts index a5507e1ee6..94ac631896 100644 --- a/src/common/vars.ts +++ b/src/common/vars.ts @@ -23,6 +23,9 @@ export const isWindows = process.platform === "win32"; */ export const isLinux = process.platform === "linux"; +/** + * @deprecated switch to using `isDebuggingInjectable` + */ export const isDebugging = ["true", "1", "yes", "y", "on"].includes((process.env.DEBUG ?? "").toLowerCase()); /** diff --git a/src/common/vars/base-bundled-binaries-dir.injectable.ts b/src/common/vars/base-bundled-binaries-dir.injectable.ts index f0d78482c8..968ccc5c5b 100644 --- a/src/common/vars/base-bundled-binaries-dir.injectable.ts +++ b/src/common/vars/base-bundled-binaries-dir.injectable.ts @@ -4,17 +4,17 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import bundledResourcesDirectoryInjectable from "./bundled-resources-dir.injectable"; -import getAbsolutePathInjectable from "../path/get-absolute-path.injectable"; import normalizedPlatformArchitectureInjectable from "./normalized-platform-architecture.injectable"; +import joinPathsInjectable from "../path/join-paths.injectable"; const baseBundledBinariesDirectoryInjectable = getInjectable({ id: "base-bundled-binaries-directory", instantiate: (di) => { const bundledResourcesDirectory = di.inject(bundledResourcesDirectoryInjectable); const normalizedPlatformArchitecture = di.inject(normalizedPlatformArchitectureInjectable); - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); - return getAbsolutePath( + return joinPaths( bundledResourcesDirectory, normalizedPlatformArchitecture, ); diff --git a/src/common/vars/bundled-resources-dir.injectable.ts b/src/common/vars/bundled-resources-dir.injectable.ts index e20a638384..2058b1d5d3 100644 --- a/src/common/vars/bundled-resources-dir.injectable.ts +++ b/src/common/vars/bundled-resources-dir.injectable.ts @@ -5,20 +5,20 @@ import { getInjectable } from "@ogre-tools/injectable"; import isProductionInjectable from "./is-production.injectable"; import normalizedPlatformInjectable from "./normalized-platform.injectable"; -import getAbsolutePathInjectable from "../path/get-absolute-path.injectable"; import lensResourcesDirInjectable from "./lens-resources-dir.injectable"; +import joinPathsInjectable from "../path/join-paths.injectable"; const bundledResourcesDirectoryInjectable = getInjectable({ id: "bundled-resources-directory", instantiate: (di) => { const isProduction = di.inject(isProductionInjectable); const normalizedPlatform = di.inject(normalizedPlatformInjectable); - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const lensResourcesDir = di.inject(lensResourcesDirInjectable); return isProduction ? lensResourcesDir - : getAbsolutePath(lensResourcesDir, "binaries", "client", normalizedPlatform); + : joinPaths(lensResourcesDir, "binaries", "client", normalizedPlatform); }, }); diff --git a/src/common/vars/is-debugging.global-override-for-injectable.ts b/src/common/vars/is-debugging.global-override-for-injectable.ts new file mode 100644 index 0000000000..7aa500ff2e --- /dev/null +++ b/src/common/vars/is-debugging.global-override-for-injectable.ts @@ -0,0 +1,9 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../test-utils/get-global-override"; +import isDebuggingInjectable from "./is-debugging.injectable"; + +export default getGlobalOverride(isDebuggingInjectable, () => false); diff --git a/src/common/vars/is-debugging.injectable.ts b/src/common/vars/is-debugging.injectable.ts new file mode 100644 index 0000000000..079086e628 --- /dev/null +++ b/src/common/vars/is-debugging.injectable.ts @@ -0,0 +1,13 @@ +/** + * 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"; + +const isDebuggingInjectable = getInjectable({ + id: "is-debugging", + instantiate: () => ["true", "1", "yes", "y", "on"].includes((process.env.DEBUG ?? "").toLowerCase()), + causesSideEffects: true, +}); + +export default isDebuggingInjectable; diff --git a/src/common/vars/static-files-directory.injectable.ts b/src/common/vars/static-files-directory.injectable.ts index c881f12b97..e65e854e9c 100644 --- a/src/common/vars/static-files-directory.injectable.ts +++ b/src/common/vars/static-files-directory.injectable.ts @@ -3,17 +3,17 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import getAbsolutePathInjectable from "../path/get-absolute-path.injectable"; +import joinPathsInjectable from "../path/join-paths.injectable"; import lensResourcesDirInjectable from "./lens-resources-dir.injectable"; const staticFilesDirectoryInjectable = getInjectable({ id: "static-files-directory", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const lensResourcesDir = di.inject(lensResourcesDirInjectable); - return getAbsolutePath(lensResourcesDir, "static"); + return joinPaths(lensResourcesDir, "static"); }, }); diff --git a/src/extensions/common-api/k8s-api.ts b/src/extensions/common-api/k8s-api.ts index 7fd25b08a1..f5bf1e4953 100644 --- a/src/extensions/common-api/k8s-api.ts +++ b/src/extensions/common-api/k8s-api.ts @@ -9,18 +9,28 @@ export { ResourceStack } from "../../common/k8s/resource-stack"; import apiManagerInjectable from "../../common/k8s-api/api-manager/manager.injectable"; +import createKubeApiForClusterInjectable from "../../common/k8s-api/create-kube-api-for-cluster.injectable"; +import createKubeApiForRemoteClusterInjectable from "../../common/k8s-api/create-kube-api-for-remote-cluster.injectable"; +import { asLegacyGlobalFunctionForExtensionApi } from "../as-legacy-globals-for-extension-api/as-legacy-global-function-for-extension-api"; import { asLegacyGlobalForExtensionApi } from "../as-legacy-globals-for-extension-api/as-legacy-global-object-for-extension-api"; export const apiManager = asLegacyGlobalForExtensionApi(apiManagerInjectable); +export const forCluster = asLegacyGlobalFunctionForExtensionApi(createKubeApiForClusterInjectable); +export const forRemoteCluster = asLegacyGlobalFunctionForExtensionApi(createKubeApiForRemoteClusterInjectable); -export { - KubeApi, - forCluster, - forRemoteCluster, - type ILocalKubeApiConfig, - type IRemoteKubeApiConfig, - type IKubeApiCluster, -} from "../../common/k8s-api/kube-api"; +export { KubeApi } from "../../common/k8s-api/kube-api"; + +/** + * @deprecated This type is unused + */ +export interface IKubeApiCluster { + metadata: { + uid: string; + }; +} + +export type { CreateKubeApiForRemoteClusterConfig as IRemoteKubeApiConfig } from "../../common/k8s-api/create-kube-api-for-remote-cluster.injectable"; +export type { CreateKubeApiForLocalClusterConfig as ILocalKubeApiConfig } from "../../common/k8s-api/create-kube-api-for-cluster.injectable"; export { KubeObject, diff --git a/src/extensions/extension-discovery/extension-discovery.injectable.ts b/src/extensions/extension-discovery/extension-discovery.injectable.ts index df5efadaf6..09d0f3b0ae 100644 --- a/src/extensions/extension-discovery/extension-discovery.injectable.ts +++ b/src/extensions/extension-discovery/extension-discovery.injectable.ts @@ -16,6 +16,19 @@ import readJsonFileInjectable from "../../common/fs/read-json-file.injectable"; import loggerInjectable from "../../common/logger.injectable"; import pathExistsInjectable from "../../common/fs/path-exists.injectable"; import watchInjectable from "../../common/fs/watch/watch.injectable"; +import accessPathInjectable from "../../common/fs/access-path.injectable"; +import copyInjectable from "../../common/fs/copy.injectable"; +import ensureDirInjectable from "../../common/fs/ensure-dir.injectable"; +import isProductionInjectable from "../../common/vars/is-production.injectable"; +import lstatInjectable from "../../common/fs/lstat.injectable"; +import readDirectoryInjectable from "../../common/fs/read-directory.injectable"; +import fileSystemSeparatorInjectable from "../../common/path/separator.injectable"; +import getBasenameOfPathInjectable from "../../common/path/get-basename.injectable"; +import getDirnameOfPathInjectable from "../../common/path/get-dirname.injectable"; +import getRelativePathInjectable from "../../common/path/get-relative-path.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; +import removePathInjectable from "../../common/fs/remove-path.injectable"; +import homeDirectoryPathInjectable from "../../common/os/home-directory-path.injectable"; const extensionDiscoveryInjectable = getInjectable({ id: "extension-discovery", @@ -33,6 +46,19 @@ const extensionDiscoveryInjectable = getInjectable({ pathExists: di.inject(pathExistsInjectable), watch: di.inject(watchInjectable), logger: di.inject(loggerInjectable), + accessPath: di.inject(accessPathInjectable), + copy: di.inject(copyInjectable), + removePath: di.inject(removePathInjectable), + ensureDirectory: di.inject(ensureDirInjectable), + isProduction: di.inject(isProductionInjectable), + lstat: di.inject(lstatInjectable), + readDirectory: di.inject(readDirectoryInjectable), + fileSystemSeparator: di.inject(fileSystemSeparatorInjectable), + getBasenameOfPath: di.inject(getBasenameOfPathInjectable), + getDirnameOfPath: di.inject(getDirnameOfPathInjectable), + getRelativePath: di.inject(getRelativePathInjectable), + joinPaths: di.inject(joinPathsInjectable), + homeDirectoryPath: di.inject(homeDirectoryPathInjectable), }), }); diff --git a/src/extensions/extension-discovery/extension-discovery.test.ts b/src/extensions/extension-discovery/extension-discovery.test.ts index e5a04bd5eb..f3630addaf 100644 --- a/src/extensions/extension-discovery/extension-discovery.test.ts +++ b/src/extensions/extension-discovery/extension-discovery.test.ts @@ -4,37 +4,40 @@ */ import type { FSWatcher } from "chokidar"; -import path from "path"; -import os from "os"; -import { Console } from "console"; import { getDiForUnitTesting } from "../../main/getDiForUnitTesting"; import extensionDiscoveryInjectable from "../extension-discovery/extension-discovery.injectable"; import type { ExtensionDiscovery } from "../extension-discovery/extension-discovery"; import installExtensionInjectable from "../extension-installer/install-extension/install-extension.injectable"; import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; -import mockFs from "mock-fs"; import { delay } from "../../renderer/utils"; -import { observable, when } from "mobx"; +import { observable, runInAction, when } from "mobx"; import readJsonFileInjectable from "../../common/fs/read-json-file.injectable"; import pathExistsInjectable from "../../common/fs/path-exists.injectable"; import watchInjectable from "../../common/fs/watch/watch.injectable"; import extensionApiVersionInjectable from "../../common/vars/extension-api-version.injectable"; - -console = new Console(process.stdout, process.stderr); // fix mockFS +import removePathInjectable from "../../common/fs/remove-path.injectable"; +import type { JoinPaths } from "../../common/path/join-paths.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; +import homeDirectoryPathInjectable from "../../common/os/home-directory-path.injectable"; describe("ExtensionDiscovery", () => { let extensionDiscovery: ExtensionDiscovery; let readJsonFileMock: jest.Mock; let pathExistsMock: jest.Mock; let watchMock: jest.Mock; + let joinPaths: JoinPaths; + let homeDirectoryPath: string; beforeEach(() => { const di = getDiForUnitTesting({ doGeneralOverrides: true }); - di.override(directoryForUserDataInjectable, () => "some-directory-for-user-data"); + di.override(directoryForUserDataInjectable, () => "/some-directory-for-user-data"); di.override(installExtensionInjectable, () => () => Promise.resolve()); di.override(extensionApiVersionInjectable, () => "5.0.0"); + joinPaths = di.inject(joinPathsInjectable); + homeDirectoryPath = di.inject(homeDirectoryPathInjectable); + readJsonFileMock = jest.fn(); di.override(readJsonFileInjectable, () => readJsonFileMock); @@ -44,21 +47,17 @@ describe("ExtensionDiscovery", () => { watchMock = jest.fn(); di.override(watchInjectable, () => watchMock); - mockFs(); + di.override(removePathInjectable, () => async () => {}); // allow deleting files for now extensionDiscovery = di.inject(extensionDiscoveryInjectable); }); - afterEach(() => { - mockFs.restore(); - }); - it("emits add for added extension", async () => { const letTestFinish = observable.box(false); let addHandler!: (filePath: string) => void; readJsonFileMock.mockImplementation((p) => { - expect(p).toBe(path.join(os.homedir(), ".k8slens/extensions/my-extension/package.json")); + expect(p).toBe(joinPaths(homeDirectoryPath, ".k8slens/extensions/my-extension/package.json")); return { name: "my-extension", @@ -89,7 +88,7 @@ describe("ExtensionDiscovery", () => { extensionDiscovery.events.on("add", extension => { expect(extension).toEqual({ absolutePath: expect.any(String), - id: path.normalize("some-directory-for-user-data/node_modules/my-extension/package.json"), + id: "/some-directory-for-user-data/node_modules/my-extension/package.json", isBundled: false, isEnabled: false, isCompatible: true, @@ -100,12 +99,12 @@ describe("ExtensionDiscovery", () => { lens: "5.0.0", }, }, - manifestPath: path.normalize("some-directory-for-user-data/node_modules/my-extension/package.json"), + manifestPath: "/some-directory-for-user-data/node_modules/my-extension/package.json", }); - letTestFinish.set(true); + runInAction(() => letTestFinish.set(true)); }); - addHandler(path.join(extensionDiscovery.localFolderPath, "/my-extension/package.json")); + addHandler(joinPaths(extensionDiscovery.localFolderPath, "/my-extension/package.json")); await when(() => letTestFinish.get()); }); @@ -133,7 +132,7 @@ describe("ExtensionDiscovery", () => { extensionDiscovery.events.on("add", onAdd); - addHandler(path.join(extensionDiscovery.localFolderPath, "/my-extension/node_modules/dep/package.json")); + addHandler(joinPaths(extensionDiscovery.localFolderPath, "/my-extension/node_modules/dep/package.json")); await delay(10); diff --git a/src/extensions/extension-discovery/extension-discovery.ts b/src/extensions/extension-discovery/extension-discovery.ts index e6f500805a..c7781d78a6 100644 --- a/src/extensions/extension-discovery/extension-discovery.ts +++ b/src/extensions/extension-discovery/extension-discovery.ts @@ -5,16 +5,12 @@ import { ipcRenderer } from "electron"; import { EventEmitter } from "events"; -import fse from "fs-extra"; import { makeObservable, observable, reaction, when } from "mobx"; -import os from "os"; -import path from "path"; import { broadcastMessage, ipcMainHandle, ipcRendererOn } from "../../common/ipc"; import { isErrnoException, toJS } from "../../common/utils"; import type { ExtensionsStore } from "../extensions-store/extensions-store"; import type { ExtensionLoader } from "../extension-loader"; import type { LensExtensionId, LensExtensionManifest } from "../lens-extension"; -import { isProduction } from "../../common/vars"; import type { ExtensionInstallationStateStore } from "../extension-installation-state-store/extension-installation-state-store"; import type { PackageJson } from "type-fest"; import { extensionDiscoveryStateChannel } from "../../common/ipc/extension-handling"; @@ -23,20 +19,46 @@ import type { ReadJson } from "../../common/fs/read-json-file.injectable"; import type { Logger } from "../../common/logger"; import type { PathExists } from "../../common/fs/path-exists.injectable"; import type { Watch } from "../../common/fs/watch/watch.injectable"; +import type { Stats } from "fs"; +import { constants } from "fs"; +import type { LStat } from "../../common/fs/lstat.injectable"; +import type { ReadDirectory } from "../../common/fs/read-directory.injectable"; +import type { EnsureDirectory } from "../../common/fs/ensure-dir.injectable"; +import type { AccessPath } from "../../common/fs/access-path.injectable"; +import type { Copy } from "../../common/fs/copy.injectable"; +import type { JoinPaths } from "../../common/path/join-paths.injectable"; +import type { GetBasenameOfPath } from "../../common/path/get-basename.injectable"; +import type { GetDirnameOfPath } from "../../common/path/get-dirname.injectable"; +import type { GetRelativePath } from "../../common/path/get-relative-path.injectable"; +import type { RemovePath } from "../../common/fs/remove-path.injectable"; +import type TypedEventEmitter from "typed-emitter"; interface Dependencies { - extensionLoader: ExtensionLoader; - extensionsStore: ExtensionsStore; - extensionInstallationStateStore: ExtensionInstallationStateStore; + readonly extensionLoader: ExtensionLoader; + readonly extensionsStore: ExtensionsStore; + readonly extensionInstallationStateStore: ExtensionInstallationStateStore; + readonly extensionPackageRootDirectory: string; + readonly staticFilesDirectory: string; + readonly logger: Logger; + readonly isProduction: boolean; + readonly fileSystemSeparator: string; + readonly homeDirectoryPath: string; isCompatibleExtension: (manifest: LensExtensionManifest) => boolean; installExtension: (name: string) => Promise; installExtensions: (packageJsonPath: string, packagesJson: PackageJson) => Promise; - extensionPackageRootDirectory: string; - staticFilesDirectory: string; readJsonFile: ReadJson; pathExists: PathExists; + removePath: RemovePath; + lstat: LStat; watch: Watch; - logger: Logger; + readDirectory: ReadDirectory; + ensureDirectory: EnsureDirectory; + accessPath: AccessPath; + copy: Copy; + joinPaths: JoinPaths; + getBasenameOfPath: GetBasenameOfPath; + getDirnameOfPath: GetDirnameOfPath; + getRelativePath: GetRelativePath; } export interface InstalledExtension { @@ -67,12 +89,17 @@ interface ExtensionDiscoveryChannelMessage { * Returns true if the lstat is for a directory-like file (e.g. isDirectory or symbolic link) * @param lstat the stats to compare */ -const isDirectoryLike = (lstat: fse.Stats) => lstat.isDirectory() || lstat.isSymbolicLink(); +const isDirectoryLike = (lstat: Stats) => lstat.isDirectory() || lstat.isSymbolicLink(); interface LoadFromFolderOptions { isBundled?: boolean; } +interface ExtensionDiscoveryEvents { + add: (ext: InstalledExtension) => void; + remove: (extId: LensExtensionId) => void; +} + /** * Discovers installed bundled and local extensions from the filesystem. * Also watches for added and removed local extensions by watching the directory. @@ -96,30 +123,30 @@ export class ExtensionDiscovery { return when(() => this.isLoaded); } - public events = new EventEmitter(); + public readonly events: TypedEventEmitter = new EventEmitter(); constructor(protected readonly dependencies: Dependencies) { makeObservable(this); } get localFolderPath(): string { - return path.join(os.homedir(), ".k8slens", "extensions"); + return this.dependencies.joinPaths(this.dependencies.homeDirectoryPath, ".k8slens", "extensions"); } get packageJsonPath(): string { - return path.join(this.dependencies.extensionPackageRootDirectory, manifestFilename); + return this.dependencies.joinPaths(this.dependencies.extensionPackageRootDirectory, manifestFilename); } get inTreeTargetPath(): string { - return path.join(this.dependencies.extensionPackageRootDirectory, "extensions"); + return this.dependencies.joinPaths(this.dependencies.extensionPackageRootDirectory, "extensions"); } get inTreeFolderPath(): string { - return path.resolve(this.dependencies.staticFilesDirectory, "../extensions"); + return this.dependencies.joinPaths(this.dependencies.staticFilesDirectory, "../extensions"); } get nodeModulesPath(): string { - return path.join(this.dependencies.extensionPackageRootDirectory, "node_modules"); + return this.dependencies.joinPaths(this.dependencies.extensionPackageRootDirectory, "node_modules"); } /** @@ -184,24 +211,24 @@ export class ExtensionDiscovery { handleWatchFileAdd = async (manifestPath: string): Promise => { // e.g. "foo/package.json" - const relativePath = path.relative(this.localFolderPath, manifestPath); + const relativePath = this.dependencies.getRelativePath(this.localFolderPath, manifestPath); // Converts "foo/package.json" to ["foo", "package.json"], where length of 2 implies // that the added file is in a folder under local folder path. // This safeguards against a file watch being triggered under a sub-directory which is not an extension. - const isUnderLocalFolderPath = relativePath.split(path.sep).length === 2; + const isUnderLocalFolderPath = relativePath.split(this.dependencies.fileSystemSeparator).length === 2; - if (path.basename(manifestPath) === manifestFilename && isUnderLocalFolderPath) { + if (this.dependencies.getBasenameOfPath(manifestPath) === manifestFilename && isUnderLocalFolderPath) { try { this.dependencies.extensionInstallationStateStore.setInstallingFromMain(manifestPath); - const absPath = path.dirname(manifestPath); + const absPath = this.dependencies.getDirnameOfPath(manifestPath); // this.loadExtensionFromPath updates this.packagesJson const extension = await this.loadExtensionFromFolder(absPath); if (extension) { // Remove a broken symlink left by a previous installation if it exists. - await fse.remove(extension.manifestPath); + await this.dependencies.removePath(extension.manifestPath); // Install dependencies for the new extension await this.dependencies.installExtension(extension.absolutePath); @@ -226,8 +253,8 @@ export class ExtensionDiscovery { handleWatchUnlinkEvent = async (filePath: string): Promise => { // Check that the removed path is directly under this.localFolderPath // Note that the watcher can create unlink events for subdirectories of the extension - const extensionFolderName = path.basename(filePath); - const expectedPath = path.relative(this.localFolderPath, filePath); + const extensionFolderName = this.dependencies.getBasenameOfPath(filePath); + const expectedPath = this.dependencies.getRelativePath(this.localFolderPath, filePath); if (expectedPath !== extensionFolderName) { return; @@ -264,7 +291,7 @@ export class ExtensionDiscovery { * @param name e.g. "@mirantis/lens-extension-cc" */ removeSymlinkByPackageName(name: string): Promise { - return fse.remove(this.getInstalledPath(name)); + return this.dependencies.removePath(this.getInstalledPath(name)); } /** @@ -286,7 +313,7 @@ export class ExtensionDiscovery { await this.removeSymlinkByPackageName(manifest.name); // fs.remove does nothing if the path doesn't exist anymore - await fse.remove(absolutePath); + await this.dependencies.removePath(absolutePath); } async load(): Promise> { @@ -301,34 +328,29 @@ export class ExtensionDiscovery { `${logModule} loading extensions from ${this.dependencies.extensionPackageRootDirectory}`, ); - // fs.remove won't throw if path is missing - await fse.remove(path.join(this.dependencies.extensionPackageRootDirectory, "package-lock.json")); + await this.dependencies.removePath(this.dependencies.joinPaths(this.dependencies.extensionPackageRootDirectory, "package-lock.json")); - try { - // Verify write access to static/extensions, which is needed for symlinking - await fse.access(this.inTreeFolderPath, fse.constants.W_OK); + const canWriteToInTreeFolder = await this.dependencies.accessPath(this.inTreeFolderPath, constants.W_OK); + if (canWriteToInTreeFolder) { // Set bundled folder path to static/extensions this.bundledFolderPath = this.inTreeFolderPath; - } catch { - // If there is error accessing static/extensions, we need to copy in-tree extensions so that we can symlink them properly on "npm install". - // The error can happen if there is read-only rights to static/extensions, which would fail symlinking. - + } else { // Remove e.g. /Users//Library/Application Support/LensDev/extensions - await fse.remove(this.inTreeTargetPath); + await this.dependencies.removePath(this.inTreeTargetPath); // Create folder e.g. /Users//Library/Application Support/LensDev/extensions - await fse.ensureDir(this.inTreeTargetPath); + await this.dependencies.ensureDirectory(this.inTreeTargetPath); // Copy static/extensions to e.g. /Users//Library/Application Support/LensDev/extensions - await fse.copy(this.inTreeFolderPath, this.inTreeTargetPath); + await this.dependencies.copy(this.inTreeFolderPath, this.inTreeTargetPath); // Set bundled folder path to e.g. /Users//Library/Application Support/LensDev/extensions this.bundledFolderPath = this.inTreeTargetPath; } - await fse.ensureDir(this.nodeModulesPath); - await fse.ensureDir(this.localFolderPath); + await this.dependencies.ensureDirectory(this.nodeModulesPath); + await this.dependencies.ensureDirectory(this.localFolderPath); const extensions = await this.ensureExtensions(); @@ -342,7 +364,7 @@ export class ExtensionDiscovery { * e.g. "/Users//Library/Application Support/Lens/node_modules/@publisher/extension" */ protected getInstalledPath(name: string): string { - return path.join(this.nodeModulesPath, name); + return this.dependencies.joinPaths(this.nodeModulesPath, name); } /** @@ -350,7 +372,7 @@ export class ExtensionDiscovery { * e.g. "/Users//Library/Application Support/Lens/node_modules/@publisher/extension/package.json" */ protected getInstalledManifestPath(name: string): string { - return path.join(this.getInstalledPath(name), manifestFilename); + return this.dependencies.joinPaths(this.getInstalledPath(name), manifestFilename); } /** @@ -362,10 +384,11 @@ export class ExtensionDiscovery { const manifest = await this.dependencies.readJsonFile(manifestPath) as unknown as LensExtensionManifest; const id = this.getInstalledManifestPath(manifest.name); const isEnabled = this.dependencies.extensionsStore.isEnabled({ id, isBundled }); - const extensionDir = path.dirname(manifestPath); - const packedName = manifest.name.replaceAll("@", "").replaceAll("/", "-"); - const npmPackage = path.join(extensionDir, `${packedName}-${manifest.version}.tgz`); - const absolutePath = (isProduction && await this.dependencies.pathExists(npmPackage)) ? npmPackage : extensionDir; + const extensionDir = this.dependencies.getDirnameOfPath(manifestPath); + const npmPackage = this.dependencies.joinPaths(extensionDir, `${manifest.name}-${manifest.version}.tgz`); + const absolutePath = this.dependencies.isProduction && await this.dependencies.pathExists(npmPackage) + ? npmPackage + : extensionDir; const isCompatible = isBundled || this.dependencies.isCompatibleExtension(manifest); return { @@ -416,10 +439,10 @@ export class ExtensionDiscovery { async loadBundledExtensions(): Promise { const extensions: InstalledExtension[] = []; const folderPath = this.bundledFolderPath; - const paths = await fse.readdir(folderPath); + const paths = await this.dependencies.readDirectory(folderPath); for (const fileName of paths) { - const absPath = path.resolve(folderPath, fileName); + const absPath = this.dependencies.joinPaths(folderPath, fileName); const extension = await this.loadExtensionFromFolder(absPath, { isBundled: true }); if (extension) { @@ -433,7 +456,7 @@ export class ExtensionDiscovery { async loadFromFolder(folderPath: string, bundledExtensions: string[]): Promise { const extensions: InstalledExtension[] = []; - const paths = await fse.readdir(folderPath); + const paths = await this.dependencies.readDirectory(folderPath); for (const fileName of paths) { // do not allow to override bundled extensions @@ -441,17 +464,21 @@ export class ExtensionDiscovery { continue; } - const absPath = path.resolve(folderPath, fileName); + const absPath = this.dependencies.joinPaths(folderPath, fileName); - if (!fse.existsSync(absPath)) { - continue; - } + try { + const lstat = await this.dependencies.lstat(absPath); - const lstat = await fse.lstat(absPath); + // skip non-directories + if (!isDirectoryLike(lstat)) { + continue; + } + } catch (error) { + if (isErrnoException(error) && error.code === "ENOENT") { + continue; + } - // skip non-directories - if (!isDirectoryLike(lstat)) { - continue; + throw error; } const extension = await this.loadExtensionFromFolder(absPath); @@ -471,7 +498,7 @@ export class ExtensionDiscovery { * @param folderPath Folder path to extension */ async loadExtensionFromFolder(folderPath: string, { isBundled = false }: LoadFromFolderOptions = {}): Promise { - const manifestPath = path.resolve(folderPath, manifestFilename); + const manifestPath = this.dependencies.joinPaths(folderPath, manifestFilename); return this.getByManifest(manifestPath, { isBundled }); } diff --git a/src/extensions/extension-loader/extension-loader.injectable.ts b/src/extensions/extension-loader/extension-loader.injectable.ts index 7fe1cd5421..48edce4446 100644 --- a/src/extensions/extension-loader/extension-loader.injectable.ts +++ b/src/extensions/extension-loader/extension-loader.injectable.ts @@ -9,6 +9,9 @@ import { createExtensionInstanceInjectionToken } from "./create-extension-instan import extensionInstancesInjectable from "./extension-instances.injectable"; import type { LensExtension } from "../lens-extension"; import extensionInjectable from "./extension/extension.injectable"; +import loggerInjectable from "../../common/logger.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; +import getDirnameOfPathInjectable from "../../common/path/get-dirname.injectable"; const extensionLoaderInjectable = getInjectable({ id: "extension-loader", @@ -18,6 +21,9 @@ const extensionLoaderInjectable = getInjectable({ createExtensionInstance: di.inject(createExtensionInstanceInjectionToken), extensionInstances: di.inject(extensionInstancesInjectable), getExtension: (instance: LensExtension) => di.inject(extensionInjectable, instance), + logger: di.inject(loggerInjectable), + joinPaths: di.inject(joinPathsInjectable), + getDirnameOfPath: di.inject(getDirnameOfPathInjectable), }), }); diff --git a/src/extensions/extension-loader/extension-loader.ts b/src/extensions/extension-loader/extension-loader.ts index 16b28de8e1..5c63451276 100644 --- a/src/extensions/extension-loader/extension-loader.ts +++ b/src/extensions/extension-loader/extension-loader.ts @@ -7,11 +7,9 @@ import { ipcMain, ipcRenderer } from "electron"; import { isEqual } from "lodash"; import type { ObservableMap } from "mobx"; import { action, computed, makeObservable, observable, observe, reaction, when } from "mobx"; -import path from "path"; import { broadcastMessage, ipcMainOn, ipcRendererOn, ipcMainHandle } from "../../common/ipc"; import type { Disposer } from "../../common/utils"; import { isDefined, toJS } from "../../common/utils"; -import logger from "../../main/logger"; import type { InstalledExtension } from "../extension-discovery/extension-discovery"; import type { LensExtension, LensExtensionConstructor, LensExtensionId } from "../lens-extension"; import type { LensRendererExtension } from "../lens-renderer-extension"; @@ -23,14 +21,20 @@ import assert from "assert"; import { EventEmitter } from "../../common/event-emitter"; import type { CreateExtensionInstance } from "./create-extension-instance.token"; import type { Extension } from "./extension/extension.injectable"; +import type { Logger } from "../../common/logger"; +import type { JoinPaths } from "../../common/path/join-paths.injectable"; +import type { GetDirnameOfPath } from "../../common/path/get-dirname.injectable"; const logModule = "[EXTENSIONS-LOADER]"; interface Dependencies { + readonly extensionInstances: ObservableMap; + readonly logger: Logger; updateExtensionsState: (extensionsState: Record) => void; createExtensionInstance: CreateExtensionInstance; - readonly extensionInstances: ObservableMap; getExtension: (instance: LensExtension) => Extension; + joinPaths: JoinPaths; + getDirnameOfPath: GetDirnameOfPath; } export interface ExtensionLoading { @@ -159,7 +163,7 @@ export class ExtensionLoader { @action removeInstance(lensExtensionId: LensExtensionId) { - logger.info(`${logModule} deleting extension instance ${lensExtensionId}`); + this.dependencies.logger.info(`${logModule} deleting extension instance ${lensExtensionId}`); const instance = this.dependencies.extensionInstances.get(lensExtensionId); if (!instance) { @@ -177,7 +181,7 @@ export class ExtensionLoader { this.dependencies.extensionInstances.delete(lensExtensionId); this.nonInstancesByName.delete(instance.name); } catch (error) { - logger.error(`${logModule}: deactivation extension error`, { lensExtensionId, error }); + this.dependencies.logger.error(`${logModule}: deactivation extension error`, { lensExtensionId, error }); } } @@ -252,7 +256,7 @@ export class ExtensionLoader { } loadOnClusterManagerRenderer = () => { - logger.debug(`${logModule}: load on main renderer (cluster manager)`); + this.dependencies.logger.debug(`${logModule}: load on main renderer (cluster manager)`); return this.autoInitExtensions(async (ext) => { const extension = ext as LensRendererExtension; @@ -274,7 +278,7 @@ export class ExtensionLoader { }; loadOnClusterRenderer = () => { - logger.debug(`${logModule}: load on cluster renderer (dashboard)`); + this.dependencies.logger.debug(`${logModule}: load on cluster renderer (dashboard)`); this.autoInitExtensions(async () => []); }; @@ -313,7 +317,7 @@ export class ExtensionLoader { activated: instance.activate(), }; } catch (err) { - logger.error(`${logModule}: error loading extension`, { ext: extension, err }); + this.dependencies.logger.error(`${logModule}: error loading extension`, { ext: extension, err }); } } else if (!extension.isEnabled && alreadyInit) { this.removeInstance(extId); @@ -330,7 +334,7 @@ export class ExtensionLoader { extensions.map(extension => // If extension activation fails, log error extension.activated.catch((error) => { - logger.error(`${logModule}: activation extension error`, { ext: extension.installedExtension, error }); + this.dependencies.logger.error(`${logModule}: activation extension error`, { ext: extension.installedExtension, error }); }), ), ); @@ -344,7 +348,7 @@ export class ExtensionLoader { // Return ExtensionLoading[] return extensions.map(extension => { const loaded = extension.instance.enable(register).catch((err) => { - logger.error(`${logModule}: failed to enable`, { ext: extension, err }); + this.dependencies.logger.error(`${logModule}: failed to enable`, { ext: extension, err }); }); return { @@ -370,14 +374,14 @@ export class ExtensionLoader { return null; } - const extAbsolutePath = path.resolve(path.join(path.dirname(extension.manifestPath), extRelativePath)); + const extAbsolutePath = this.dependencies.joinPaths(this.dependencies.getDirnameOfPath(extension.manifestPath), extRelativePath); try { return __non_webpack_require__(extAbsolutePath).default; } catch (error) { const message = (error instanceof Error ? error.stack : undefined) || error; - logger.error(`${logModule}: can't load ${entryPointName} for "${extension.manifest.name}": ${message}`, { extension }); + this.dependencies.logger.error(`${logModule}: can't load ${entryPointName} for "${extension.manifest.name}": ${message}`, { extension }); } return null; diff --git a/src/extensions/extension-loader/file-system-provisioner-store/directory-for-extension-data.injectable.ts b/src/extensions/extension-loader/file-system-provisioner-store/directory-for-extension-data.injectable.ts index 896c74da6d..469ed85949 100644 --- a/src/extensions/extension-loader/file-system-provisioner-store/directory-for-extension-data.injectable.ts +++ b/src/extensions/extension-loader/file-system-provisioner-store/directory-for-extension-data.injectable.ts @@ -4,16 +4,16 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import directoryForUserDataInjectable from "../../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; -import getAbsolutePathInjectable from "../../../common/path/get-absolute-path.injectable"; +import joinPathsInjectable from "../../../common/path/join-paths.injectable"; const directoryForExtensionDataInjectable = getInjectable({ id: "directory-for-extension-data", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const directoryForUserData = di.inject(directoryForUserDataInjectable); - return getAbsolutePath(directoryForUserData, "extension_data"); + return joinPaths(directoryForUserData, "extension_data"); }, }); diff --git a/src/features/cluster/__snapshots__/order-of-sidebar-items.test.tsx.snap b/src/features/cluster/__snapshots__/order-of-sidebar-items.test.tsx.snap index 7f76811494..8a293a41f9 100644 --- a/src/features/cluster/__snapshots__/order-of-sidebar-items.test.tsx.snap +++ b/src/features/cluster/__snapshots__/order-of-sidebar-items.test.tsx.snap @@ -484,6 +484,7 @@ exports[`cluster - order of sidebar items when rendered renders 1`] = ` > -

+
Close ⌘+W
@@ -1096,6 +1099,7 @@ exports[`cluster - order of sidebar items when rendered when parent is expanded > -
+
Close ⌘+W
diff --git a/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-core.test.tsx.snap b/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-core.test.tsx.snap index 49fcc917a4..6d64889cff 100644 --- a/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-core.test.tsx.snap +++ b/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-core.test.tsx.snap @@ -457,6 +457,7 @@ exports[`cluster - sidebar and tab navigation for core given core registrations > -
+
Close ⌘+W
@@ -990,6 +993,7 @@ exports[`cluster - sidebar and tab navigation for core given core registrations > -
+
Close ⌘+W
@@ -1543,6 +1549,7 @@ exports[`cluster - sidebar and tab navigation for core given core registrations > -
+
Close ⌘+W
@@ -1976,6 +1985,7 @@ exports[`cluster - sidebar and tab navigation for core given core registrations > -
+
Close ⌘+W
@@ -2388,6 +2400,7 @@ exports[`cluster - sidebar and tab navigation for core given core registrations > -
+
Close ⌘+W
@@ -2941,6 +2956,7 @@ exports[`cluster - sidebar and tab navigation for core given core registrations > -
+
Close ⌘+W
@@ -3474,6 +3492,7 @@ exports[`cluster - sidebar and tab navigation for core given core registrations > -
+
Close ⌘+W
diff --git a/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-extensions.test.tsx.snap b/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-extensions.test.tsx.snap index fff3da0126..ac415ae3e2 100644 --- a/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-extensions.test.tsx.snap +++ b/src/features/cluster/__snapshots__/sidebar-and-tab-navigation-for-extensions.test.tsx.snap @@ -457,6 +457,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
@@ -990,6 +993,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
@@ -1559,6 +1565,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
@@ -2047,6 +2056,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
@@ -2535,6 +2547,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
@@ -2986,6 +3001,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
@@ -3555,6 +3573,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
@@ -4088,6 +4109,7 @@ exports[`cluster - sidebar and tab navigation for extensions given extension wit > -
+
Close ⌘+W
diff --git a/src/features/cluster/__snapshots__/visibility-of-sidebar-items.test.tsx.snap b/src/features/cluster/__snapshots__/visibility-of-sidebar-items.test.tsx.snap index ed36d5134f..7fe8edf8cf 100644 --- a/src/features/cluster/__snapshots__/visibility-of-sidebar-items.test.tsx.snap +++ b/src/features/cluster/__snapshots__/visibility-of-sidebar-items.test.tsx.snap @@ -429,6 +429,7 @@ exports[`cluster - visibility of sidebar items given kube resource for route is > -
+
Close ⌘+W
@@ -974,6 +977,7 @@ exports[`cluster - visibility of sidebar items given kube resource for route is > -
+
Close ⌘+W
diff --git a/src/features/cluster/__snapshots__/workload-overview.test.tsx.snap b/src/features/cluster/__snapshots__/workload-overview.test.tsx.snap index 6dbe47992f..e53ace250f 100644 --- a/src/features/cluster/__snapshots__/workload-overview.test.tsx.snap +++ b/src/features/cluster/__snapshots__/workload-overview.test.tsx.snap @@ -484,6 +484,7 @@ exports[`workload overview when navigating to workload overview renders 1`] = ` > -
+
Close ⌘+W
diff --git a/src/features/cluster/delete-dialog/__snapshots__/delete-cluster-dialog.test.tsx.snap b/src/features/cluster/delete-dialog/__snapshots__/delete-cluster-dialog.test.tsx.snap new file mode 100644 index 0000000000..907f60bb8f --- /dev/null +++ b/src/features/cluster/delete-dialog/__snapshots__/delete-cluster-dialog.test.tsx.snap @@ -0,0 +1,2192 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`Deleting a cluster when an internal kubeconfig cluster is used when the dialog is opened renders 1`] = ` + +
+
+
+
+ + + home + + + + + arrow_back + + + + + arrow_forward + + +
+
+
+
+
+
+
+
+
+ Catalog +
+
    +
  • +
    +
    +
    + Browse +
    +
    +
    • +
  • +
    +
    + + + expand_more + + +
    +
    +
    + Categories +
    +
    +
    +
      +
      +
      +
    • +
      +
      + + + settings + + +
      +
      +
      +
      + General +
      +
      +
      +
      +
      • +
    • +
      +
      + + + +
      +
      +
      +
      + Clusters +
      +
      +
      +
      +
      • +
    • +
      +
      + + + public + + +
      +
      +
      +
      + Web Links +
      +
      +
      +
      +
      • +
      +
      +
    +
    • +
+
+
+
+
+
+
+
+
+
+
+
+
+ + + arrow_left + + +
+
+ 0 +
+
+ + + arrow_right + + +
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete the + + some-context + + context from Lens's internal kubeconfig? +
+
+ + + warning_amber + + +

+ Are you sure you want to delete it? It can be re-added through the copy/paste mechanism. +

+
+
+
+ + +
+
+
+ +`; + +exports[`Deleting a cluster when the kubeconfig has multiple clusters when the dialog is opened for not the current cluster renders 1`] = ` + +
+
+
+
+ + + home + + + + + arrow_back + + + + + arrow_forward + + +
+
+
+
+
+
+
+
+
+ Catalog +
+
    +
  • +
    +
    +
    + Browse +
    +
    +
    • +
  • +
    +
    + + + expand_more + + +
    +
    +
    + Categories +
    +
    +
    +
      +
      +
      +
    • +
      +
      + + + settings + + +
      +
      +
      +
      + General +
      +
      +
      +
      +
      • +
    • +
      +
      + + + +
      +
      +
      +
      + Clusters +
      +
      +
      +
      +
      • +
    • +
      +
      + + + public + + +
      +
      +
      +
      + Web Links +
      +
      +
      +
      +
      • +
      +
      +
    +
    • +
+
+
+
+
+
+
+
+
+
+
+
+
+ + + arrow_left + + +
+
+ 0 +
+
+ + + arrow_right + + +
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete the + + some-non-current-context + + context from + + ./temp-kube-config + + ? +
+
+ + + warning_amber + + +

+ The contents of kubeconfig file will be changed! +

+
+
+
+ +
+
+
+ + +
+
+
+ +`; + +exports[`Deleting a cluster when the kubeconfig has multiple clusters when the dialog is opened for not the current cluster when context switching checkbox is clicked renders 1`] = ` + +
+
+
+
+ + + home + + + + + arrow_back + + + + + arrow_forward + + +
+
+
+
+
+
+
+
+
+ Catalog +
+
    +
  • +
    +
    +
    + Browse +
    +
    +
    • +
  • +
    +
    + + + expand_more + + +
    +
    +
    + Categories +
    +
    +
    +
      +
      +
      +
    • +
      +
      + + + settings + + +
      +
      +
      +
      + General +
      +
      +
      +
      +
      • +
    • +
      +
      + + + +
      +
      +
      +
      + Clusters +
      +
      +
      +
      +
      • +
    • +
      +
      + + + public + + +
      +
      +
      +
      + Web Links +
      +
      +
      +
      +
      • +
      +
      +
    +
    • +
+
+
+
+
+
+
+
+
+
+
+
+
+ + + arrow_left + + +
+
+ 0 +
+
+ + + arrow_right + + +
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete the + + some-non-current-context + + context from + + ./temp-kube-config + + ? +
+
+ + + warning_amber + + +

+ The contents of kubeconfig file will be changed! +

+
+
+
+ +
+
+
+ + +
+
+
+ Select new context... +
+
+ +
+
+
+ + +
+
+
+
+
+
+ + +
+
+
+ +`; + +exports[`Deleting a cluster when the kubeconfig has multiple clusters when the dialog is opened for the current cluster renders 1`] = ` + +
+
+
+
+ + + home + + + + + arrow_back + + + + + arrow_forward + + +
+
+
+
+
+
+
+
+
+ Catalog +
+
    +
  • +
    +
    +
    + Browse +
    +
    +
    • +
  • +
    +
    + + + expand_more + + +
    +
    +
    + Categories +
    +
    +
    +
      +
      +
      +
    • +
      +
      + + + settings + + +
      +
      +
      +
      + General +
      +
      +
      +
      +
      • +
    • +
      +
      + + + +
      +
      +
      +
      + Clusters +
      +
      +
      +
      +
      • +
    • +
      +
      + + + public + + +
      +
      +
      +
      + Web Links +
      +
      +
      +
      +
      • +
      +
      +
    +
    • +
+
+
+
+
+
+
+
+
+
+
+
+
+ + + arrow_left + + +
+
+ 0 +
+
+ + + arrow_right + + +
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete the + + some-current-context + + context from + + ./temp-kube-config + + ? +
+
+ + + warning_amber + + +

+ This will remove active context in kubeconfig. Use drop down below to select a different one. +

+
+
+
+ +
+
+
+ + +
+
+
+ Select new context... +
+
+ +
+
+
+ + +
+
+
+
+
+
+ + +
+
+
+ +`; + +exports[`Deleting a cluster when the kubeconfig has only one cluster when the dialog is opened renders 1`] = ` + +
+
+
+
+ + + home + + + + + arrow_back + + + + + arrow_forward + + +
+
+
+
+
+
+
+
+
+ Catalog +
+
    +
  • +
    +
    +
    + Browse +
    +
    +
    • +
  • +
    +
    + + + expand_more + + +
    +
    +
    + Categories +
    +
    +
    +
      +
      +
      +
    • +
      +
      + + + settings + + +
      +
      +
      +
      + General +
      +
      +
      +
      +
      • +
    • +
      +
      + + + +
      +
      +
      +
      + Clusters +
      +
      +
      +
      +
      • +
    • +
      +
      + + + public + + +
      +
      +
      +
      + Web Links +
      +
      +
      +
      +
      • +
      +
      +
    +
    • +
+
+
+
+
+
+
+
+
+
+
+
+
+ + + arrow_left + + +
+
+ 0 +
+
+ + + arrow_right + + +
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete the + + some-context + + context from + + ./temp-kube-config + + ? +
+
+ + + warning_amber + + +

+ This will remove the last context in kubeconfig. There will be no active context. +

+
+
+
+ + +
+
+
+ +`; diff --git a/src/features/cluster/delete-dialog/common/clear-as-deleting-channel.injectable.ts b/src/features/cluster/delete-dialog/common/clear-as-deleting-channel.injectable.ts new file mode 100644 index 0000000000..d45fecb3c2 --- /dev/null +++ b/src/features/cluster/delete-dialog/common/clear-as-deleting-channel.injectable.ts @@ -0,0 +1,20 @@ +/** + * 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 type { ClusterId } from "../../../../common/cluster-types"; +import type { RequestChannel } from "../../../../common/utils/channel/request-channel-injection-token"; +import { requestChannelInjectionToken } from "../../../../common/utils/channel/request-channel-injection-token"; + +export type ClearClusterAsDeletingChannel = RequestChannel; + +const clearClusterAsDeletingChannelInjectable = getInjectable({ + id: "clear-cluster-as-deleting-channel", + instantiate: (): ClearClusterAsDeletingChannel => ({ + id: "clear-cluster-as-deleting", + }), + injectionToken: requestChannelInjectionToken, +}); + +export default clearClusterAsDeletingChannelInjectable; diff --git a/src/features/cluster/delete-dialog/common/delete-channel.injectable.ts b/src/features/cluster/delete-dialog/common/delete-channel.injectable.ts new file mode 100644 index 0000000000..9242b062c5 --- /dev/null +++ b/src/features/cluster/delete-dialog/common/delete-channel.injectable.ts @@ -0,0 +1,20 @@ +/** + * 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 type { ClusterId } from "../../../../common/cluster-types"; +import type { RequestChannel } from "../../../../common/utils/channel/request-channel-injection-token"; +import { requestChannelInjectionToken } from "../../../../common/utils/channel/request-channel-injection-token"; + +export type DeleteClusterChannel = RequestChannel; + +const deleteClusterChannelInjectable = getInjectable({ + id: "delete-cluster-channel", + instantiate: (): DeleteClusterChannel => ({ + id: "delete-cluster", + }), + injectionToken: requestChannelInjectionToken, +}); + +export default deleteClusterChannelInjectable; diff --git a/src/features/cluster/delete-dialog/common/set-as-deleting-channel.injectable.ts b/src/features/cluster/delete-dialog/common/set-as-deleting-channel.injectable.ts new file mode 100644 index 0000000000..b625dfa14e --- /dev/null +++ b/src/features/cluster/delete-dialog/common/set-as-deleting-channel.injectable.ts @@ -0,0 +1,20 @@ +/** + * 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 type { ClusterId } from "../../../../common/cluster-types"; +import type { RequestChannel } from "../../../../common/utils/channel/request-channel-injection-token"; +import { requestChannelInjectionToken } from "../../../../common/utils/channel/request-channel-injection-token"; + +export type SetClusterAsDeletingChannel = RequestChannel; + +const setClusterAsDeletingChannelInjectable = getInjectable({ + id: "set-cluster-as-deleting-channel", + instantiate: (): SetClusterAsDeletingChannel => ({ + id: "set-cluster-as-deleting", + }), + injectionToken: requestChannelInjectionToken, +}); + +export default setClusterAsDeletingChannelInjectable; diff --git a/src/features/cluster/delete-dialog/delete-cluster-dialog.test.tsx b/src/features/cluster/delete-dialog/delete-cluster-dialog.test.tsx new file mode 100644 index 0000000000..a65d19b052 --- /dev/null +++ b/src/features/cluster/delete-dialog/delete-cluster-dialog.test.tsx @@ -0,0 +1,284 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import "@testing-library/jest-dom/extend-expect"; +import { KubeConfig } from "@kubernetes/client-node"; +import type { RenderResult } from "@testing-library/react"; +import type { CreateCluster } from "../../../common/cluster/create-cluster-injection-token"; +import { createClusterInjectionToken } from "../../../common/cluster/create-cluster-injection-token"; +import createContextHandlerInjectable from "../../../main/context-handler/create-context-handler.injectable"; +import createKubeconfigManagerInjectable from "../../../main/kubeconfig-manager/create-kubeconfig-manager.injectable"; +import normalizedPlatformInjectable from "../../../common/vars/normalized-platform.injectable"; +import kubectlBinaryNameInjectable from "../../../main/kubectl/binary-name.injectable"; +import kubectlDownloadingNormalizedArchInjectable from "../../../main/kubectl/normalized-arch.injectable"; +import openDeleteClusterDialogInjectable, { type OpenDeleteClusterDialog } from "../../../renderer/components/delete-cluster-dialog/open.injectable"; +import { type ApplicationBuilder, getApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; +import storesAndApisCanBeCreatedInjectable from "../../../renderer/stores-apis-can-be-created.injectable"; +import type { Cluster } from "../../../common/cluster/cluster"; +import navigateToCatalogInjectable from "../../../common/front-end-routing/routes/catalog/navigate-to-catalog.injectable"; +import appEventBusInjectable from "../../../common/app-event-bus/app-event-bus.injectable"; +import directoryForKubeConfigsInjectable from "../../../common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable"; +import joinPathsInjectable from "../../../common/path/join-paths.injectable"; + +const currentClusterServerUrl = "https://localhost"; +const nonCurrentClusterServerUrl = "http://localhost"; +const multiClusterConfig = ` +apiVersion: v1 +clusters: +- cluster: + server: ${currentClusterServerUrl} + name: some-current-context-cluster +- cluster: + server: ${nonCurrentClusterServerUrl} + name: some-non-current-context-cluster +contexts: +- context: + cluster: some-current-context-cluster + user: some-user + name: some-current-context +- context: + cluster: some-non-current-context-cluster + user: some-user + name: some-non-current-context +current-context: some-current-context +kind: Config +preferences: {} +users: +- name: some-user + user: + token: kubeconfig-user-q4lm4:xxxyyyy +`; + +const singleClusterServerUrl = "http://localhost"; +const singleClusterConfig = ` +apiVersion: v1 +clusters: +- cluster: + server: ${singleClusterServerUrl} + name: some-cluster +contexts: +- context: + cluster: some-cluster + user: some-user + name: some-context +current-context: some-context +kind: Config +preferences: {} +users: +- name: some-user + user: + token: kubeconfig-user-q4lm4:xxxyyyy +`; + +describe("Deleting a cluster", () => { + let builder: ApplicationBuilder; + let openDeleteClusterDialog: OpenDeleteClusterDialog; + let createCluster: CreateCluster; + let rendered: RenderResult; + let config: KubeConfig; + + beforeEach(async () => { + config = new KubeConfig(); + builder = getApplicationBuilder(); + + builder.beforeApplicationStart((mainDi) => { + mainDi.override(createContextHandlerInjectable, () => () => undefined as never); + mainDi.override(createKubeconfigManagerInjectable, () => () => undefined as never); + mainDi.override(kubectlBinaryNameInjectable, () => "kubectl"); + mainDi.override(kubectlDownloadingNormalizedArchInjectable, () => "amd64"); + mainDi.override(normalizedPlatformInjectable, () => "darwin"); + }); + + builder.beforeWindowStart((windowDi) => { + windowDi.override(storesAndApisCanBeCreatedInjectable, () => true); + openDeleteClusterDialog = windowDi.inject(openDeleteClusterDialogInjectable); + + // TODO: remove this line when all global uses of appEventBus are removed + windowDi.permitSideEffects(appEventBusInjectable); + }); + + builder.afterWindowStart(windowDi => { + createCluster = windowDi.inject(createClusterInjectionToken); + + const navigateToCatalog = windowDi.inject(navigateToCatalogInjectable); + + navigateToCatalog(); + }); + + rendered = await builder.render(); + }); + + describe("when the kubeconfig has multiple clusters", () => { + let currentCluster: Cluster; + let nonCurrentCluster: Cluster; + + beforeEach(() => { + config.loadFromString(multiClusterConfig); + + currentCluster = createCluster({ + id: "some-current-context-cluster", + contextName: "some-current-context", + preferences: { + clusterName: "some-current-context-cluster", + }, + kubeConfigPath: "./temp-kube-config", + }, { + clusterServerUrl: currentClusterServerUrl, + }); + nonCurrentCluster = createCluster({ + id: "some-non-current-context-cluster", + contextName: "some-non-current-context", + preferences: { + clusterName: "some-non-current-context-cluster", + }, + kubeConfigPath: "./temp-kube-config", + }, { + clusterServerUrl: currentClusterServerUrl, + }); + }); + + describe("when the dialog is opened for the current cluster", () => { + // TODO: replace with actual behaviour instead of technical use + beforeEach(async () => { + openDeleteClusterDialog({ + cluster: currentCluster, + config, + }); + + await rendered.findByTestId("delete-cluster-dialog"); + }); + + it("renders", () => { + expect(rendered.baseElement).toMatchSnapshot(); + }); + + it("shows context switcher", () => { + expect(rendered.queryByText("Select new context...")).toBeInTheDocument(); + }); + + it("shows warning", () => { + expect(rendered.queryByTestId("current-context-warning")).toBeInTheDocument(); + }); + }); + + describe("when the dialog is opened for not the current cluster", () => { + // TODO: replace with actual behaviour instead of technical use + beforeEach(async () => { + openDeleteClusterDialog({ + cluster: nonCurrentCluster, + config, + }); + + await rendered.findByTestId("delete-cluster-dialog"); + }); + + it("renders", () => { + expect(rendered.baseElement).toMatchSnapshot(); + }); + + it("shows warning", () => { + expect(rendered.queryByTestId("kubeconfig-change-warning")).toBeInTheDocument(); + }); + + it("does not show context switcher", () => { + expect(rendered.queryByText("Select new context...")).not.toBeInTheDocument(); + }); + + describe("when context switching checkbox is clicked", () => { + beforeEach(() => { + rendered.getByTestId("delete-cluster-dialog-context-switch").click(); + }); + + it("renders", () => { + expect(rendered.baseElement).toMatchSnapshot(); + }); + + it("shows context switcher", () => { + expect(rendered.queryByText("Select new context...")).toBeInTheDocument(); + }); + }); + }); + }); + + describe("when an internal kubeconfig cluster is used", () => { + let currentCluster: Cluster; + + beforeEach(() => { + config.loadFromString(singleClusterConfig); + + const directoryForKubeConfigs = builder.applicationWindow.only.di.inject(directoryForKubeConfigsInjectable); + const joinPaths = builder.applicationWindow.only.di.inject(joinPathsInjectable); + + currentCluster = createCluster({ + id: "some-cluster", + contextName: "some-context", + preferences: { + clusterName: "some-cluster", + }, + kubeConfigPath: joinPaths(directoryForKubeConfigs, "some-cluster.json"), + }, { + clusterServerUrl: singleClusterServerUrl, + }); + }); + + describe("when the dialog is opened", () => { + // TODO: replace with actual behaviour instead of technical use + beforeEach(async () => { + openDeleteClusterDialog({ + cluster: currentCluster, + config, + }); + + await rendered.findByTestId("delete-cluster-dialog"); + }); + + it("renders", () => { + expect(rendered.baseElement).toMatchSnapshot(); + }); + + it("shows warning", () => { + expect(rendered.queryByTestId("internal-kubeconfig-warning")).toBeInTheDocument(); + }); + }); + }); + + describe("when the kubeconfig has only one cluster", () => { + let currentCluster: Cluster; + + beforeEach(() => { + config.loadFromString(singleClusterConfig); + + currentCluster = createCluster({ + id: "some-cluster", + contextName: "some-context", + preferences: { + clusterName: "some-cluster", + }, + kubeConfigPath: "./temp-kube-config", + }, { + clusterServerUrl: singleClusterServerUrl, + }); + }); + + describe("when the dialog is opened", () => { + // TODO: replace with actual behaviour instead of technical use + beforeEach(async () => { + openDeleteClusterDialog({ + cluster: currentCluster, + config, + }); + + await rendered.findByTestId("delete-cluster-dialog"); + }); + + it("renders", () => { + expect(rendered.baseElement).toMatchSnapshot(); + }); + + it("shows warning", () => { + expect(rendered.queryByTestId("no-more-contexts-warning")).toBeInTheDocument(); + }); + }); + }); +}); diff --git a/src/features/cluster/delete-dialog/main/clear-as-deleteing-channel-handler.injectable.ts b/src/features/cluster/delete-dialog/main/clear-as-deleteing-channel-handler.injectable.ts new file mode 100644 index 0000000000..f1b89573d8 --- /dev/null +++ b/src/features/cluster/delete-dialog/main/clear-as-deleteing-channel-handler.injectable.ts @@ -0,0 +1,23 @@ +/** + * 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 { requestChannelListenerInjectionToken } from "../../../../common/utils/channel/request-channel-listener-injection-token"; +import clustersThatAreBeingDeletedInjectable from "../../../../main/cluster/are-being-deleted.injectable"; +import clearClusterAsDeletingChannelInjectable from "../common/clear-as-deleting-channel.injectable"; + +const clearClusterAsDeletingChannelHandlerInjectable = getInjectable({ + id: "clear-cluster-as-deleting-channel-handler", + instantiate: (di) => { + const clustersThatAreBeingDeleted = di.inject(clustersThatAreBeingDeletedInjectable); + + return { + channel: di.inject(clearClusterAsDeletingChannelInjectable), + handler: (clusterId) => clustersThatAreBeingDeleted.delete(clusterId), + }; + }, + injectionToken: requestChannelListenerInjectionToken, +}); + +export default clearClusterAsDeletingChannelHandlerInjectable; diff --git a/src/features/cluster/delete-dialog/main/delete-channel-handler.injectable.ts b/src/features/cluster/delete-dialog/main/delete-channel-handler.injectable.ts new file mode 100644 index 0000000000..8945ffe625 --- /dev/null +++ b/src/features/cluster/delete-dialog/main/delete-channel-handler.injectable.ts @@ -0,0 +1,56 @@ +/** + * 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 appEventBusInjectable from "../../../../common/app-event-bus/app-event-bus.injectable"; +import clusterFramesInjectable from "../../../../common/cluster-frames.injectable"; +import clusterStoreInjectable from "../../../../common/cluster-store/cluster-store.injectable"; +import directoryForLensLocalStorageInjectable from "../../../../common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable"; +import deleteFileInjectable from "../../../../common/fs/delete-file.injectable"; +import joinPathsInjectable from "../../../../common/path/join-paths.injectable"; +import { requestChannelListenerInjectionToken } from "../../../../common/utils/channel/request-channel-listener-injection-token"; +import deleteClusterChannelInjectable from "../common/delete-channel.injectable"; + +const deleteClusterChannelHandlerInjectable = getInjectable({ + id: "delete-cluster-channel-handler", + instantiate: (di) => { + const appEventBus = di.inject(appEventBusInjectable); + const clusterStore = di.inject(clusterStoreInjectable); + const clusterFrames = di.inject(clusterFramesInjectable); + const joinPaths = di.inject(joinPathsInjectable); + const directoryForLensLocalStorage = di.inject(directoryForLensLocalStorageInjectable); + const deleteFile = di.inject(deleteFileInjectable); + + return { + channel: di.inject(deleteClusterChannelInjectable), + handler: async (clusterId) =>{ + appEventBus.emit({ name: "cluster", action: "remove" }); + + const cluster = clusterStore.getById(clusterId); + + if (!cluster) { + return; + } + + cluster.disconnect(); + clusterFrames.delete(cluster.id); + + // Remove from the cluster store as well, this should clear any old settings + clusterStore.clusters.delete(cluster.id); + + try { + // remove the local storage file + const localStorageFilePath = joinPaths(directoryForLensLocalStorage, `${cluster.id}.json`); + + await deleteFile(localStorageFilePath); + } catch { + // ignore error + } + }, + }; + }, + injectionToken: requestChannelListenerInjectionToken, +}); + +export default deleteClusterChannelHandlerInjectable; diff --git a/src/features/cluster/delete-dialog/main/set-as-deleteing-channel-handler.injectable.ts b/src/features/cluster/delete-dialog/main/set-as-deleteing-channel-handler.injectable.ts new file mode 100644 index 0000000000..0b8862e384 --- /dev/null +++ b/src/features/cluster/delete-dialog/main/set-as-deleteing-channel-handler.injectable.ts @@ -0,0 +1,23 @@ +/** + * 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 { requestChannelListenerInjectionToken } from "../../../../common/utils/channel/request-channel-listener-injection-token"; +import clustersThatAreBeingDeletedInjectable from "../../../../main/cluster/are-being-deleted.injectable"; +import setClusterAsDeletingChannelInjectable from "../common/set-as-deleting-channel.injectable"; + +const setClusterAsDeletingChannelHandlerInjectable = getInjectable({ + id: "set-cluster-as-deleting-channel-handler", + instantiate: (di) => { + const clustersThatAreBeingDeleted = di.inject(clustersThatAreBeingDeletedInjectable); + + return { + channel: di.inject(setClusterAsDeletingChannelInjectable), + handler: (clusterId) => clustersThatAreBeingDeleted.add(clusterId), + }; + }, + injectionToken: requestChannelListenerInjectionToken, +}); + +export default setClusterAsDeletingChannelHandlerInjectable; diff --git a/src/features/cluster/delete-dialog/renderer/request-clear-as-deleting.injectable.ts b/src/features/cluster/delete-dialog/renderer/request-clear-as-deleting.injectable.ts new file mode 100644 index 0000000000..b480630f6c --- /dev/null +++ b/src/features/cluster/delete-dialog/renderer/request-clear-as-deleting.injectable.ts @@ -0,0 +1,22 @@ +/** + * 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 type { ClusterId } from "../../../../common/cluster-types"; +import requestFromChannelInjectable from "../../../../renderer/utils/channel/request-from-channel.injectable"; +import clearClusterAsDeletingChannelInjectable from "../common/clear-as-deleting-channel.injectable"; + +export type RequestClearClusterAsDeleting = (clusterId: ClusterId) => Promise; + +const requestClearClusterAsDeletingInjectable = getInjectable({ + id: "request-clear-cluster-as-deleting", + instantiate: (di): RequestClearClusterAsDeleting => { + const requestChannel = di.inject(requestFromChannelInjectable); + const clearClusterAsDeletingChannel = di.inject(clearClusterAsDeletingChannelInjectable); + + return (clusterId) => requestChannel(clearClusterAsDeletingChannel, clusterId); + }, +}); + +export default requestClearClusterAsDeletingInjectable; diff --git a/src/features/cluster/delete-dialog/renderer/request-delete.injectable.ts b/src/features/cluster/delete-dialog/renderer/request-delete.injectable.ts new file mode 100644 index 0000000000..602923e60e --- /dev/null +++ b/src/features/cluster/delete-dialog/renderer/request-delete.injectable.ts @@ -0,0 +1,22 @@ +/** + * 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 type { ClusterId } from "../../../../common/cluster-types"; +import requestFromChannelInjectable from "../../../../renderer/utils/channel/request-from-channel.injectable"; +import deleteClusterChannelInjectable from "../common/delete-channel.injectable"; + +export type RequestDeleteCluster = (clusterId: ClusterId) => Promise; + +const requestDeleteClusterInjectable = getInjectable({ + id: "request-delete-cluster", + instantiate: (di): RequestDeleteCluster => { + const requestChannel = di.inject(requestFromChannelInjectable); + const deleteClusterChannel = di.inject(deleteClusterChannelInjectable); + + return (clusterId) => requestChannel(deleteClusterChannel, clusterId); + }, +}); + +export default requestDeleteClusterInjectable; diff --git a/src/features/cluster/delete-dialog/renderer/request-set-as-deleting.injectable.ts b/src/features/cluster/delete-dialog/renderer/request-set-as-deleting.injectable.ts new file mode 100644 index 0000000000..997348d44d --- /dev/null +++ b/src/features/cluster/delete-dialog/renderer/request-set-as-deleting.injectable.ts @@ -0,0 +1,22 @@ +/** + * 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 type { ClusterId } from "../../../../common/cluster-types"; +import requestFromChannelInjectable from "../../../../renderer/utils/channel/request-from-channel.injectable"; +import setClusterAsDeletingChannelInjectable from "../common/set-as-deleting-channel.injectable"; + +export type RequestSetClusterAsDeleting = (clusterId: ClusterId) => Promise; + +const requestSetClusterAsDeletingInjectable = getInjectable({ + id: "request-set-cluster-as-deleting", + instantiate: (di): RequestSetClusterAsDeleting => { + const requestChannel = di.inject(requestFromChannelInjectable); + const setClusterAsDeletingChannel = di.inject(setClusterAsDeletingChannelInjectable); + + return (clusterId) => requestChannel(setClusterAsDeletingChannel, clusterId); + }, +}); + +export default requestSetClusterAsDeletingInjectable; diff --git a/src/features/cluster/extension-api/__snapshots__/disable-cluster-pages-when-cluster-is-not-relevant.test.tsx.snap b/src/features/cluster/extension-api/__snapshots__/disable-cluster-pages-when-cluster-is-not-relevant.test.tsx.snap index d7daa6bf14..7c81e1dfd7 100644 --- a/src/features/cluster/extension-api/__snapshots__/disable-cluster-pages-when-cluster-is-not-relevant.test.tsx.snap +++ b/src/features/cluster/extension-api/__snapshots__/disable-cluster-pages-when-cluster-is-not-relevant.test.tsx.snap @@ -310,6 +310,7 @@ exports[`disable-cluster-pages-when-cluster-is-not-relevant given extension shou > -
+
Close ⌘+W
@@ -817,6 +820,7 @@ exports[`disable-cluster-pages-when-cluster-is-not-relevant given extension shou > -
+
Close ⌘+W
@@ -1324,6 +1330,7 @@ exports[`disable-cluster-pages-when-cluster-is-not-relevant given not yet known > -
+
Close ⌘+W
diff --git a/src/features/cluster/extension-api/__snapshots__/disable-sidebar-items-when-cluster-is-not-relevant.test.tsx.snap b/src/features/cluster/extension-api/__snapshots__/disable-sidebar-items-when-cluster-is-not-relevant.test.tsx.snap index 3dde5af5d5..5642dbcf22 100644 --- a/src/features/cluster/extension-api/__snapshots__/disable-sidebar-items-when-cluster-is-not-relevant.test.tsx.snap +++ b/src/features/cluster/extension-api/__snapshots__/disable-sidebar-items-when-cluster-is-not-relevant.test.tsx.snap @@ -448,6 +448,7 @@ exports[`disable sidebar items when cluster is not relevant given extension shou > -
+
Close ⌘+W
@@ -955,6 +958,7 @@ exports[`disable sidebar items when cluster is not relevant given extension shou > -
+
Close ⌘+W
@@ -1462,6 +1468,7 @@ exports[`disable sidebar items when cluster is not relevant given not yet known > -
+
Close ⌘+W
diff --git a/src/features/cluster/kube-object-details/extension-api/__snapshots__/disable-kube-object-detail-items-when-cluster-is-not-relevant.test.tsx.snap b/src/features/cluster/kube-object-details/extension-api/__snapshots__/disable-kube-object-detail-items-when-cluster-is-not-relevant.test.tsx.snap index 60f0d0095a..0221082e02 100644 --- a/src/features/cluster/kube-object-details/extension-api/__snapshots__/disable-kube-object-detail-items-when-cluster-is-not-relevant.test.tsx.snap +++ b/src/features/cluster/kube-object-details/extension-api/__snapshots__/disable-kube-object-detail-items-when-cluster-is-not-relevant.test.tsx.snap @@ -367,6 +367,7 @@ exports[`disable kube object detail items when cluster is not relevant given ext > -
+
Close ⌘+W
@@ -849,6 +852,7 @@ exports[`disable kube object detail items when cluster is not relevant given ext > -
+
Close ⌘+W
@@ -1331,6 +1337,7 @@ exports[`disable kube object detail items when cluster is not relevant given not > -
+
Close ⌘+W
diff --git a/src/features/cluster/kube-object-menu/extension-api/__snapshots__/disable-kube-object-menu-items-when-cluster-is-not-relevant.test.tsx.snap b/src/features/cluster/kube-object-menu/extension-api/__snapshots__/disable-kube-object-menu-items-when-cluster-is-not-relevant.test.tsx.snap index 9459045e02..292a820f4b 100644 --- a/src/features/cluster/kube-object-menu/extension-api/__snapshots__/disable-kube-object-menu-items-when-cluster-is-not-relevant.test.tsx.snap +++ b/src/features/cluster/kube-object-menu/extension-api/__snapshots__/disable-kube-object-menu-items-when-cluster-is-not-relevant.test.tsx.snap @@ -315,6 +315,7 @@ exports[`disable kube object menu items when cluster is not relevant given exten > -
+
Close ⌘+W
@@ -701,6 +704,7 @@ exports[`disable kube object menu items when cluster is not relevant given exten > -
+
Close ⌘+W
@@ -1087,6 +1093,7 @@ exports[`disable kube object menu items when cluster is not relevant given not y > -
+
Close ⌘+W
diff --git a/src/features/cluster/kube-object-status-icon/__snapshots__/show-status-for-a-kube-object.test.tsx.snap b/src/features/cluster/kube-object-status-icon/__snapshots__/show-status-for-a-kube-object.test.tsx.snap index 042e9f02ab..dec48cdc12 100644 --- a/src/features/cluster/kube-object-status-icon/__snapshots__/show-status-for-a-kube-object.test.tsx.snap +++ b/src/features/cluster/kube-object-status-icon/__snapshots__/show-status-for-a-kube-object.test.tsx.snap @@ -304,6 +304,7 @@ exports[`show status for a kube object given application starts and in test page > -
+
Close ⌘+W
@@ -725,6 +728,7 @@ exports[`show status for a kube object given application starts and in test page > -
+
Close ⌘+W
@@ -1146,6 +1152,7 @@ exports[`show status for a kube object given application starts and in test page > -
+
Close ⌘+W
@@ -1527,6 +1536,7 @@ exports[`show status for a kube object given application starts and in test page > -
+
Close ⌘+W
@@ -1908,6 +1920,7 @@ exports[`show status for a kube object given application starts and in test page > -
+
Close ⌘+W
@@ -2329,6 +2344,7 @@ exports[`show status for a kube object given application starts and in test page > -
+
Close ⌘+W
diff --git a/src/features/cluster/kube-object-status-icon/extension-api/__snapshots__/disable-kube-object-statuses-when-cluster-is-not-relevant.test.tsx.snap b/src/features/cluster/kube-object-status-icon/extension-api/__snapshots__/disable-kube-object-statuses-when-cluster-is-not-relevant.test.tsx.snap index 001f97e00b..9fc7e6bbf1 100644 --- a/src/features/cluster/kube-object-status-icon/extension-api/__snapshots__/disable-kube-object-statuses-when-cluster-is-not-relevant.test.tsx.snap +++ b/src/features/cluster/kube-object-status-icon/extension-api/__snapshots__/disable-kube-object-statuses-when-cluster-is-not-relevant.test.tsx.snap @@ -344,6 +344,7 @@ exports[`disable kube object statuses when cluster is not relevant given extensi > -
+
Close ⌘+W
@@ -725,6 +728,7 @@ exports[`disable kube object statuses when cluster is not relevant given extensi > -
+
Close ⌘+W
@@ -1106,6 +1112,7 @@ exports[`disable kube object statuses when cluster is not relevant given not yet > -
+
Close ⌘+W
diff --git a/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-new-tab.test.tsx.snap b/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-new-tab.test.tsx.snap index f46517dc0b..b087beee3d 100644 --- a/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-new-tab.test.tsx.snap +++ b/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-new-tab.test.tsx.snap @@ -548,6 +548,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -1183,6 +1186,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -1823,6 +1829,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -2532,6 +2541,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -2581,6 +2593,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -3216,6 +3231,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -3265,6 +3283,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -3972,6 +3993,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -4021,6 +4045,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -4730,6 +4757,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -5453,6 +5483,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -6171,6 +6204,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -6880,6 +6916,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -7589,6 +7628,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -8845,6 +8887,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
@@ -10657,6 +10702,7 @@ exports[`cluster/namespaces - edit namespace from new tab when navigating to nam > -
+
Close ⌘+W
diff --git a/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-previously-opened-tab.test.tsx.snap b/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-previously-opened-tab.test.tsx.snap index e23184d8fc..f82cbc2e0e 100644 --- a/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-previously-opened-tab.test.tsx.snap +++ b/src/features/cluster/namespaces/__snapshots__/edit-namespace-from-previously-opened-tab.test.tsx.snap @@ -455,6 +455,7 @@ exports[`cluster/namespaces - edit namespaces from previously opened tab given t > -
+
Close ⌘+W
@@ -997,6 +1000,7 @@ exports[`cluster/namespaces - edit namespaces from previously opened tab given t > -
+
Close ⌘+W
diff --git a/src/features/cluster/sidebar-and-tab-navigation-for-core.test.tsx b/src/features/cluster/sidebar-and-tab-navigation-for-core.test.tsx index 2272fc0db6..519e6bb3c8 100644 --- a/src/features/cluster/sidebar-and-tab-navigation-for-core.test.tsx +++ b/src/features/cluster/sidebar-and-tab-navigation-for-core.test.tsx @@ -22,7 +22,6 @@ import pathExistsInjectable from "../../common/fs/path-exists.injectable"; import readJsonFileInjectable from "../../common/fs/read-json-file.injectable"; import { navigateToRouteInjectionToken } from "../../common/front-end-routing/navigate-to-route-injection-token"; import sidebarStorageInjectable from "../../renderer/components/layout/sidebar-storage/sidebar-storage.injectable"; -import hostedClusterIdInjectable from "../../renderer/cluster-frame-context/hosted-cluster-id.injectable"; import { advanceFakeTime, useFakeTime } from "../../common/test-utils/use-fake-time"; import storageSaveDelayInjectable from "../../renderer/utils/create-storage/storage-save-delay.injectable"; @@ -38,7 +37,6 @@ describe("cluster - sidebar and tab navigation for core", () => { builder.setEnvironmentToClusterFrame(); builder.beforeWindowStart((windowDi) => { - windowDi.override(hostedClusterIdInjectable, () => "some-hosted-cluster-id"); windowDi.override(storageSaveDelayInjectable, () => 250); windowDi.override( @@ -98,7 +96,7 @@ describe("cluster - sidebar and tab navigation for core", () => { const writeJsonFileFake = windowDi.inject(writeJsonFileInjectable); await writeJsonFileFake( - "/some-directory-for-lens-local-storage/some-hosted-cluster-id.json", + "/some-directory-for-lens-local-storage/some-cluster-id.json", { sidebar: { expanded: { "some-parent-id": true }, @@ -286,7 +284,7 @@ describe("cluster - sidebar and tab navigation for core", () => { const readJsonFileFake = windowDi.inject(readJsonFileInjectable); const actual = await readJsonFileFake( - "/some-directory-for-lens-local-storage/some-hosted-cluster-id.json", + "/some-directory-for-lens-local-storage/some-cluster-id.json", ); expect(actual).toEqual({ diff --git a/src/features/cluster/sidebar-and-tab-navigation-for-extensions.test.tsx b/src/features/cluster/sidebar-and-tab-navigation-for-extensions.test.tsx index 8d3de582ad..a228cc880e 100644 --- a/src/features/cluster/sidebar-and-tab-navigation-for-extensions.test.tsx +++ b/src/features/cluster/sidebar-and-tab-navigation-for-extensions.test.tsx @@ -15,7 +15,6 @@ import pathExistsInjectable from "../../common/fs/path-exists.injectable"; import readJsonFileInjectable from "../../common/fs/read-json-file.injectable"; import { navigateToRouteInjectionToken } from "../../common/front-end-routing/navigate-to-route-injection-token"; import assert from "assert"; -import hostedClusterIdInjectable from "../../renderer/cluster-frame-context/hosted-cluster-id.injectable"; import { advanceFakeTime, useFakeTime } from "../../common/test-utils/use-fake-time"; import type { IObservableValue } from "mobx"; import { runInAction, computed, observable } from "mobx"; @@ -34,7 +33,6 @@ describe("cluster - sidebar and tab navigation for extensions", () => { applicationBuilder.setEnvironmentToClusterFrame(); applicationBuilder.beforeWindowStart((windowDi) => { - windowDi.override(hostedClusterIdInjectable, () => "some-hosted-cluster-id"); windowDi.override(storageSaveDelayInjectable, () => 250); windowDi.override( @@ -178,7 +176,7 @@ describe("cluster - sidebar and tab navigation for extensions", () => { const writeJsonFileFake = windowDi.inject(writeJsonFileInjectable); await writeJsonFileFake( - "/some-directory-for-lens-local-storage/some-hosted-cluster-id.json", + "/some-directory-for-lens-local-storage/some-cluster-id.json", { sidebar: { expanded: { "some-extension-name-some-parent-id": true }, @@ -214,7 +212,7 @@ describe("cluster - sidebar and tab navigation for extensions", () => { const writeJsonFileFake = windowDi.inject(writeJsonFileInjectable); await writeJsonFileFake( - "/some-directory-for-lens-local-storage/some-hosted-cluster-id.json", + "/some-directory-for-lens-local-storage/some-cluster-id.json", { sidebar: { expanded: { "some-extension-name-some-unknown-parent-id": true }, @@ -244,7 +242,7 @@ describe("cluster - sidebar and tab navigation for extensions", () => { const writeJsonFileFake = windowDi.inject(writeJsonFileInjectable); await writeJsonFileFake( - "/some-directory-for-lens-local-storage/some-hosted-cluster-id.json", + "/some-directory-for-lens-local-storage/some-cluster-id.json", { someThingButSidebar: {}, }, @@ -390,7 +388,7 @@ describe("cluster - sidebar and tab navigation for extensions", () => { const pathExistsFake = windowDi.inject(pathExistsInjectable); const actual = await pathExistsFake( - "/some-directory-for-lens-local-storage/some-hosted-cluster-id.json", + "/some-directory-for-lens-local-storage/some-cluster-id.json", ); expect(actual).toBe(false); @@ -402,7 +400,7 @@ describe("cluster - sidebar and tab navigation for extensions", () => { const readJsonFileFake = windowDi.inject(readJsonFileInjectable); const actual = await readJsonFileFake( - "/some-directory-for-lens-local-storage/some-hosted-cluster-id.json", + "/some-directory-for-lens-local-storage/some-cluster-id.json", ); expect(actual).toEqual({ diff --git a/src/features/cluster/workloads/overview/extension-api/__snapshots__/disable-workloads-overview-details-when-cluster-is-not-relevant.test.tsx.snap b/src/features/cluster/workloads/overview/extension-api/__snapshots__/disable-workloads-overview-details-when-cluster-is-not-relevant.test.tsx.snap index 2fd23c30cc..4dc26ef987 100644 --- a/src/features/cluster/workloads/overview/extension-api/__snapshots__/disable-workloads-overview-details-when-cluster-is-not-relevant.test.tsx.snap +++ b/src/features/cluster/workloads/overview/extension-api/__snapshots__/disable-workloads-overview-details-when-cluster-is-not-relevant.test.tsx.snap @@ -435,6 +435,7 @@ exports[`disable workloads overview details when cluster is not relevant given e > -
+
Close ⌘+W
@@ -942,6 +945,7 @@ exports[`disable workloads overview details when cluster is not relevant given e > -
+
Close ⌘+W
@@ -1449,6 +1455,7 @@ exports[`disable workloads overview details when cluster is not relevant given n > -
+
Close ⌘+W
diff --git a/src/features/helm-charts/__snapshots__/add-custom-helm-repository-in-preferences.test.ts.snap b/src/features/helm-charts/__snapshots__/add-custom-helm-repository-in-preferences.test.ts.snap index c02c727480..433cf01bac 100644 --- a/src/features/helm-charts/__snapshots__/add-custom-helm-repository-in-preferences.test.ts.snap +++ b/src/features/helm-charts/__snapshots__/add-custom-helm-repository-in-preferences.test.ts.snap @@ -272,7 +272,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -303,7 +303,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -850,7 +850,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -881,7 +881,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -1439,7 +1439,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -1470,7 +1470,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -2139,7 +2139,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -2170,7 +2170,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -2736,7 +2736,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -2767,7 +2767,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -3436,7 +3436,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -3467,7 +3467,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -4318,7 +4318,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -4349,7 +4349,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -5018,7 +5018,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -5049,7 +5049,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -5900,7 +5900,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -5931,7 +5931,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -6601,7 +6601,7 @@ exports[`add custom helm repository in preferences when navigating to preference @@ -6632,7 +6632,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -6916,7 +6916,7 @@ exports[`add custom helm repository in preferences when navigating to preference />
@@ -7229,7 +7229,7 @@ exports[`add custom helm repository in preferences when navigating to preference > @@ -7502,7 +7502,7 @@ exports[`add custom helm repository in preferences when navigating to preference />
@@ -7815,7 +7815,7 @@ exports[`add custom helm repository in preferences when navigating to preference > diff --git a/src/features/helm-charts/__snapshots__/add-helm-repository-from-list-in-preferences.test.ts.snap b/src/features/helm-charts/__snapshots__/add-helm-repository-from-list-in-preferences.test.ts.snap index 193511c896..2e520db845 100644 --- a/src/features/helm-charts/__snapshots__/add-helm-repository-from-list-in-preferences.test.ts.snap +++ b/src/features/helm-charts/__snapshots__/add-helm-repository-from-list-in-preferences.test.ts.snap @@ -272,7 +272,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -303,7 +303,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -850,7 +850,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -881,7 +881,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -1439,7 +1439,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -1470,7 +1470,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -2081,7 +2081,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -2112,7 +2112,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -2670,7 +2670,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -2701,7 +2701,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -3259,7 +3259,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -3290,7 +3290,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -3837,7 +3837,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -3868,7 +3868,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -4460,7 +4460,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -4491,7 +4491,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -5146,7 +5146,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -5177,7 +5177,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > @@ -5769,7 +5769,7 @@ exports[`add helm repository from list in preferences when navigating to prefere @@ -5800,7 +5800,7 @@ exports[`add helm repository from list in preferences when navigating to prefere > diff --git a/src/features/helm-charts/__snapshots__/listing-active-helm-repositories-in-preferences.test.ts.snap b/src/features/helm-charts/__snapshots__/listing-active-helm-repositories-in-preferences.test.ts.snap index 146fb371aa..2e1faa2e6b 100644 --- a/src/features/helm-charts/__snapshots__/listing-active-helm-repositories-in-preferences.test.ts.snap +++ b/src/features/helm-charts/__snapshots__/listing-active-helm-repositories-in-preferences.test.ts.snap @@ -272,7 +272,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -303,7 +303,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -850,7 +850,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -881,7 +881,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -1428,7 +1428,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -1459,7 +1459,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -1898,7 +1898,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -1929,7 +1929,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -2476,7 +2476,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -2507,7 +2507,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -2946,7 +2946,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -2977,7 +2977,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -3524,7 +3524,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -3555,7 +3555,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -4147,7 +4147,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -4178,7 +4178,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -4617,7 +4617,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -4648,7 +4648,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > @@ -5087,7 +5087,7 @@ exports[`listing active helm repositories in preferences when navigating to pref @@ -5118,7 +5118,7 @@ exports[`listing active helm repositories in preferences when navigating to pref > diff --git a/src/features/helm-charts/__snapshots__/remove-helm-repository-from-list-of-active-repository-in-preferences.test.ts.snap b/src/features/helm-charts/__snapshots__/remove-helm-repository-from-list-of-active-repository-in-preferences.test.ts.snap index 2cb3b4e60d..b18419092b 100644 --- a/src/features/helm-charts/__snapshots__/remove-helm-repository-from-list-of-active-repository-in-preferences.test.ts.snap +++ b/src/features/helm-charts/__snapshots__/remove-helm-repository-from-list-of-active-repository-in-preferences.test.ts.snap @@ -272,7 +272,7 @@ exports[`remove helm repository from list of active repositories in preferences @@ -303,7 +303,7 @@ exports[`remove helm repository from list of active repositories in preferences > @@ -850,7 +850,7 @@ exports[`remove helm repository from list of active repositories in preferences @@ -881,7 +881,7 @@ exports[`remove helm repository from list of active repositories in preferences > @@ -1439,7 +1439,7 @@ exports[`remove helm repository from list of active repositories in preferences @@ -1470,7 +1470,7 @@ exports[`remove helm repository from list of active repositories in preferences > @@ -2028,7 +2028,7 @@ exports[`remove helm repository from list of active repositories in preferences @@ -2059,7 +2059,7 @@ exports[`remove helm repository from list of active repositories in preferences > diff --git a/src/features/helm-charts/add-custom-helm-repository-in-preferences.test.ts b/src/features/helm-charts/add-custom-helm-repository-in-preferences.test.ts index f77a550575..fb7b655dfe 100644 --- a/src/features/helm-charts/add-custom-helm-repository-in-preferences.test.ts +++ b/src/features/helm-charts/add-custom-helm-repository-in-preferences.test.ts @@ -17,6 +17,7 @@ import isPathInjectable from "../../renderer/components/input/validators/is-path import showSuccessNotificationInjectable from "../../renderer/components/notifications/show-success-notification.injectable"; import showErrorNotificationInjectable from "../../renderer/components/notifications/show-error-notification.injectable"; import type { AsyncResult } from "../../common/utils/async-result"; +import { useFakeTime } from "../../common/test-utils/use-fake-time"; describe("add custom helm repository in preferences", () => { let builder: ApplicationBuilder; @@ -33,6 +34,8 @@ describe("add custom helm repository in preferences", () => { builder = getApplicationBuilder(); + useFakeTime("2021-01-01 12:00:00"); + execFileMock = asyncFn(); getActiveHelmRepositoriesMock = asyncFn(); showSuccessNotificationMock = jest.fn(); diff --git a/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-new-tab.test.ts.snap b/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-new-tab.test.ts.snap index 15c98bdca1..043ee215ba 100644 --- a/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-new-tab.test.ts.snap +++ b/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-new-tab.test.ts.snap @@ -2010,6 +2010,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -2765,6 +2768,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -3764,6 +3770,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -4737,6 +4746,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -5705,6 +5717,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -6673,6 +6688,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -7663,6 +7681,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -8662,6 +8683,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -9630,6 +9654,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -10653,6 +10680,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -12261,6 +12291,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -13109,6 +13142,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -14323,6 +14359,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -14372,6 +14411,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -15127,6 +15169,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -15176,6 +15221,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -16146,6 +16194,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -16195,6 +16246,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -17163,6 +17217,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
@@ -18131,6 +18188,7 @@ exports[`installing helm chart from new tab given tab for installing chart was n > -
+
Close ⌘+W
diff --git a/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-previously-opened-tab.test.ts.snap b/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-previously-opened-tab.test.ts.snap index c0359c4b88..ea4fa6fc90 100644 --- a/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-previously-opened-tab.test.ts.snap +++ b/src/features/helm-charts/installing-chart/__snapshots__/installing-helm-chart-from-previously-opened-tab.test.ts.snap @@ -430,6 +430,7 @@ exports[`installing helm chart from previously opened tab given tab for installi > -
+
Close ⌘+W
@@ -947,6 +950,7 @@ exports[`installing helm chart from previously opened tab given tab for installi > -
+
Close ⌘+W
diff --git a/src/features/helm-charts/installing-chart/__snapshots__/opening-dock-tab-for-installing-helm-chart.test.ts.snap b/src/features/helm-charts/installing-chart/__snapshots__/opening-dock-tab-for-installing-helm-chart.test.ts.snap index a7fcf85592..dcd2bb5dd1 100644 --- a/src/features/helm-charts/installing-chart/__snapshots__/opening-dock-tab-for-installing-helm-chart.test.ts.snap +++ b/src/features/helm-charts/installing-chart/__snapshots__/opening-dock-tab-for-installing-helm-chart.test.ts.snap @@ -434,14 +434,8 @@ exports[`opening dock tab for installing helm chart given application is started
-
- Item list is empty -
-
+ class="Spinner singleColor center" + />
-
+
Close ⌘+W
diff --git a/src/features/helm-charts/installing-chart/installing-helm-chart-from-new-tab.test.ts b/src/features/helm-charts/installing-chart/installing-helm-chart-from-new-tab.test.ts index f86471e897..9d6c43790d 100644 --- a/src/features/helm-charts/installing-chart/installing-helm-chart-from-new-tab.test.ts +++ b/src/features/helm-charts/installing-chart/installing-helm-chart-from-new-tab.test.ts @@ -8,98 +8,56 @@ import type { RenderResult } from "@testing-library/react"; import { fireEvent } from "@testing-library/react"; import type { ApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; import { getApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; -import type { CallForHelmCharts } from "../../../renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable"; -import callForHelmChartsInjectable from "../../../renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable"; import { HelmChart } from "../../../common/k8s-api/endpoints/helm-charts.api"; import getRandomInstallChartTabIdInjectable from "../../../renderer/components/dock/install-chart/get-random-install-chart-tab-id.injectable"; -import type { CallForHelmChartValues } from "../../../renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable"; -import callForHelmChartValuesInjectable from "../../../renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable"; -import type { CallForCreateHelmRelease } from "../../../renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable"; -import callForCreateHelmReleaseInjectable from "../../../renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable"; +import type { RequestCreateHelmRelease } from "../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; +import requestCreateHelmReleaseInjectable from "../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; import currentPathInjectable from "../../../renderer/routes/current-path.injectable"; -import namespaceStoreInjectable from "../../../renderer/components/+namespaces/store.injectable"; -import type { NamespaceStore } from "../../../renderer/components/+namespaces/store"; -import type { CallForHelmChartReadme } from "../../../renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable"; -import callForHelmChartReadmeInjectable from "../../../renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable"; -import type { CallForHelmChartVersions } from "../../../renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; -import callForHelmChartVersionsInjectable from "../../../renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; import writeJsonFileInjectable from "../../../common/fs/write-json-file.injectable"; import directoryForLensLocalStorageInjectable from "../../../common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable"; -import hostedClusterIdInjectable from "../../../renderer/cluster-frame-context/hosted-cluster-id.injectable"; import dockStoreInjectable from "../../../renderer/components/dock/dock/store.injectable"; import readJsonFileInjectable from "../../../common/fs/read-json-file.injectable"; import type { DiContainer } from "@ogre-tools/injectable"; -import callForHelmReleasesInjectable from "../../../renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.injectable"; -import callForHelmReleaseDetailsInjectable from "../../../renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.injectable"; +import type { RequestHelmCharts } from "../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import type { RequestHelmChartVersions } from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import type { RequestHelmChartReadme } from "../../../common/k8s-api/endpoints/helm-charts.api/request-readme.injectable"; +import type { RequestHelmChartValues } from "../../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; +import requestHelmChartsInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import requestHelmChartVersionsInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import requestHelmChartReadmeInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-readme.injectable"; +import requestHelmChartValuesInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; +import type { RequestDetailedHelmRelease } from "../../../renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable"; +import requestDetailedHelmReleaseInjectable from "../../../renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable"; describe("installing helm chart from new tab", () => { let builder: ApplicationBuilder; - let callForHelmChartsMock: AsyncFnMock; - let callForHelmChartVersionsMock: AsyncFnMock; - let callForHelmChartReadmeMock: AsyncFnMock; - let callForHelmChartValuesMock: AsyncFnMock; - let callForCreateHelmReleaseMock: AsyncFnMock; + let requestDetailedHelmReleaseMock: AsyncFnMock; + let requestHelmChartsMock: AsyncFnMock; + let requestHelmChartVersionsMock: AsyncFnMock; + let requestHelmChartReadmeMock: AsyncFnMock; + let requestHelmChartValuesMock: AsyncFnMock; + let requestCreateHelmReleaseMock: AsyncFnMock; beforeEach(() => { builder = getApplicationBuilder(); builder.setEnvironmentToClusterFrame(); - callForHelmChartsMock = asyncFn(); - callForHelmChartVersionsMock = asyncFn(); - callForHelmChartReadmeMock = asyncFn(); - callForHelmChartValuesMock = asyncFn(); - callForCreateHelmReleaseMock = asyncFn(); + requestDetailedHelmReleaseMock = asyncFn(); + requestHelmChartsMock = asyncFn(); + requestHelmChartVersionsMock = asyncFn(); + requestHelmChartReadmeMock = asyncFn(); + requestHelmChartValuesMock = asyncFn(); + requestCreateHelmReleaseMock = asyncFn(); builder.beforeWindowStart((windowDi) => { - windowDi.override(callForHelmReleasesInjectable, () => async () => []); - windowDi.override(callForHelmReleaseDetailsInjectable, () => () => new Promise(() => {})); - - windowDi.override( - directoryForLensLocalStorageInjectable, - () => "/some-directory-for-lens-local-storage", - ); - - windowDi.override(hostedClusterIdInjectable, () => "some-cluster-id"); - - windowDi.override( - callForHelmChartsInjectable, - () => callForHelmChartsMock, - ); - - windowDi.override( - callForHelmChartVersionsInjectable, - () => callForHelmChartVersionsMock, - ); - - windowDi.override( - callForHelmChartReadmeInjectable, - () => callForHelmChartReadmeMock, - ); - - windowDi.override( - callForHelmChartValuesInjectable, - () => callForHelmChartValuesMock, - ); - - windowDi.override( - callForCreateHelmReleaseInjectable, - () => callForCreateHelmReleaseMock, - ); - - // TODO: Replace store mocking with mock for the actual side-effect (where the namespaces are coming from) - windowDi.override( - namespaceStoreInjectable, - () => - ({ - contextNamespaces: [], - items: [ - { getName: () => "default" }, - { getName: () => "some-other-namespace" }, - ], - selectNamespaces: () => {}, - } as unknown as NamespaceStore), - ); + windowDi.override(directoryForLensLocalStorageInjectable, () => "/some-directory-for-lens-local-storage"); + windowDi.override(requestDetailedHelmReleaseInjectable, () => requestDetailedHelmReleaseMock); + windowDi.override(requestHelmChartsInjectable, () => requestHelmChartsMock); + windowDi.override(requestHelmChartVersionsInjectable, () => requestHelmChartVersionsMock); + windowDi.override(requestHelmChartReadmeInjectable, () => requestHelmChartReadmeMock); + windowDi.override(requestHelmChartValuesInjectable, () => requestHelmChartValuesMock); + windowDi.override(requestCreateHelmReleaseInjectable, () => requestCreateHelmReleaseMock); windowDi.override(getRandomInstallChartTabIdInjectable, () => jest @@ -108,6 +66,9 @@ describe("installing helm chart from new tab", () => { .mockReturnValueOnce("some-second-tab-id"), ); }); + + builder.namespaces.add("default"); + builder.namespaces.add("some-other-namespace"); }); describe("given tab for installing chart was not previously opened and application is started", () => { @@ -136,7 +97,6 @@ describe("installing helm chart from new tab", () => { // TODO: Make TerminalWindow unit testable to allow realistic behaviour dockStore.closeTab("terminal"); - }); it("renders", () => { @@ -144,14 +104,13 @@ describe("installing helm chart from new tab", () => { }); describe("when navigating to helm charts", () => { - beforeEach(async () => { builder.helmCharts.navigate({ chartName: "some-name", repo: "some-repository", }); - await callForHelmChartsMock.resolve([ + await requestHelmChartsMock.resolve([ HelmChart.create({ apiVersion: "some-api-version", name: "some-name", @@ -185,7 +144,7 @@ describe("installing helm chart from new tab", () => { }), ]); - await callForHelmChartVersionsMock.resolve([ + await requestHelmChartVersionsMock.resolve([ HelmChart.create({ apiVersion: "some-api-version", name: "some-name", @@ -219,7 +178,7 @@ describe("installing helm chart from new tab", () => { }), ]); - await callForHelmChartReadmeMock.resolve("some-readme"); + await requestHelmChartReadmeMock.resolve("some-readme"); }); it("renders", () => { @@ -228,7 +187,7 @@ describe("installing helm chart from new tab", () => { describe("when selecting to install the chart", () => { beforeEach(() => { - callForHelmChartVersionsMock.mockClear(); + requestHelmChartVersionsMock.mockClear(); const installButton = rendered.getByTestId( "install-chart-for-some-repository-some-name", @@ -248,7 +207,7 @@ describe("installing helm chart from new tab", () => { }); it("calls for default configuration of the chart", () => { - expect(callForHelmChartValuesMock).toHaveBeenCalledWith( + expect(requestHelmChartValuesMock).toHaveBeenCalledWith( "some-repository", "some-name", "some-version", @@ -256,7 +215,7 @@ describe("installing helm chart from new tab", () => { }); it("calls for available versions", () => { - expect(callForHelmChartVersionsMock).toHaveBeenCalledWith( + expect(requestHelmChartVersionsMock).toHaveBeenCalledWith( "some-repository", "some-name", ); @@ -268,18 +227,8 @@ describe("installing helm chart from new tab", () => { ).toBeInTheDocument(); }); - it("given default configuration resolves but versions have not resolved yet, still shows the spinner", async () => { - await callForHelmChartValuesMock.resolve( - "some-default-configuration", - ); - - expect( - rendered.getByTestId("install-chart-tab-spinner"), - ).toBeInTheDocument(); - }); - it("given versions resolve but default configuration has not resolved yet, still shows the spinner", async () => { - await callForHelmChartVersionsMock.resolve([]); + await requestHelmChartVersionsMock.resolve([]); expect( rendered.getByTestId("install-chart-tab-spinner"), @@ -288,11 +237,11 @@ describe("installing helm chart from new tab", () => { describe("when default configuration and versions resolve", () => { beforeEach(async () => { - await callForHelmChartValuesMock.resolve( + await requestHelmChartValuesMock.resolve( "some-default-configuration", ); - await callForHelmChartVersionsMock.resolve([ + await requestHelmChartVersionsMock.resolve([ HelmChart.create({ apiVersion: "some-api-version", name: "some-name", @@ -385,7 +334,7 @@ describe("installing helm chart from new tab", () => { }); it("calls for installation with default configuration", () => { - expect(callForCreateHelmReleaseMock).toHaveBeenCalledWith({ + expect(requestCreateHelmReleaseMock).toHaveBeenCalledWith({ chart: "some-name", name: undefined, namespace: "default", @@ -397,7 +346,7 @@ describe("installing helm chart from new tab", () => { describe("when installation resolves", () => { beforeEach(async () => { - await callForCreateHelmReleaseMock.resolve({ + await requestCreateHelmReleaseMock.resolve({ log: "some-execution-output", release: { @@ -496,8 +445,8 @@ describe("installing helm chart from new tab", () => { describe("given opening details for second chart, when details resolve", () => { beforeEach(async () => { - callForHelmChartReadmeMock.mockClear(); - callForHelmChartVersionsMock.mockClear(); + requestHelmChartReadmeMock.mockClear(); + requestHelmChartVersionsMock.mockClear(); const row = rendered.getByTestId( "helm-chart-row-for-some-repository-some-other-name", @@ -505,7 +454,7 @@ describe("installing helm chart from new tab", () => { fireEvent.click(row); - await callForHelmChartVersionsMock.resolve([ + await requestHelmChartVersionsMock.resolve([ HelmChart.create({ apiVersion: "some-api-version", name: "some-other-name", @@ -523,7 +472,7 @@ describe("installing helm chart from new tab", () => { }), ]); - await callForHelmChartReadmeMock.resolve("some-readme"); + await requestHelmChartReadmeMock.resolve("some-readme"); }); it("renders", () => { @@ -532,7 +481,7 @@ describe("installing helm chart from new tab", () => { describe("when selecting to install second chart", () => { beforeEach(() => { - callForHelmChartVersionsMock.mockClear(); + requestHelmChartVersionsMock.mockClear(); const installButton = rendered.getByTestId( "install-chart-for-some-repository-some-other-name", @@ -560,7 +509,7 @@ describe("installing helm chart from new tab", () => { }); it("calls for default configuration of the second chart", () => { - expect(callForHelmChartValuesMock).toHaveBeenCalledWith( + expect(requestHelmChartValuesMock).toHaveBeenCalledWith( "some-repository", "some-other-name", "some-version", @@ -568,7 +517,7 @@ describe("installing helm chart from new tab", () => { }); it("calls for available versions for the second chart", () => { - expect(callForHelmChartVersionsMock).toHaveBeenCalledWith( + expect(requestHelmChartVersionsMock).toHaveBeenCalledWith( "some-repository", "some-other-name", ); @@ -582,11 +531,11 @@ describe("installing helm chart from new tab", () => { describe("when configuration and versions resolve", () => { beforeEach(async () => { - await callForHelmChartValuesMock.resolve( + await requestHelmChartValuesMock.resolve( "some-other-default-configuration", ); - await callForHelmChartVersionsMock.resolve([]); + await requestHelmChartVersionsMock.resolve([]); }); it("renders", () => { @@ -607,7 +556,7 @@ describe("installing helm chart from new tab", () => { fireEvent.click(installButton); expect( - callForCreateHelmReleaseMock, + requestCreateHelmReleaseMock, ).toHaveBeenCalledWith({ chart: "some-other-name", name: undefined, @@ -620,8 +569,8 @@ describe("installing helm chart from new tab", () => { describe("when selecting the dock tab for installing first chart", () => { beforeEach(() => { - callForHelmChartValuesMock.mockClear(); - callForHelmChartVersionsMock.mockClear(); + requestHelmChartValuesMock.mockClear(); + requestHelmChartVersionsMock.mockClear(); const tab = rendered.getByTestId( "dock-tab-for-some-first-tab-id", @@ -636,13 +585,13 @@ describe("installing helm chart from new tab", () => { it("does not call for default configuration", () => { expect( - callForHelmChartValuesMock, + requestHelmChartValuesMock, ).not.toHaveBeenCalled(); }); it("does not call for available versions", () => { expect( - callForHelmChartVersionsMock, + requestHelmChartVersionsMock, ).not.toHaveBeenCalled(); }); @@ -660,7 +609,7 @@ describe("installing helm chart from new tab", () => { fireEvent.click(installButton); expect( - callForCreateHelmReleaseMock, + requestCreateHelmReleaseMock, ).toHaveBeenCalledWith({ chart: "some-name", name: undefined, @@ -679,8 +628,8 @@ describe("installing helm chart from new tab", () => { let menu: { selectOption: (labelText: string) => void }; beforeEach(() => { - callForHelmChartVersionsMock.mockClear(); - callForHelmChartValuesMock.mockClear(); + requestHelmChartVersionsMock.mockClear(); + requestHelmChartValuesMock.mockClear(); const menuId = "install-chart-version-select-for-some-first-tab-id"; @@ -708,7 +657,7 @@ describe("installing helm chart from new tab", () => { }); it("calls for default configuration for the version of chart", () => { - expect(callForHelmChartValuesMock).toHaveBeenCalledWith( + expect(requestHelmChartValuesMock).toHaveBeenCalledWith( "some-repository", "some-name", "some-other-version", @@ -725,7 +674,7 @@ describe("installing helm chart from new tab", () => { it("does not call for versions again", () => { expect( - callForHelmChartVersionsMock, + requestHelmChartVersionsMock, ).not.toHaveBeenCalled(); }); @@ -747,7 +696,7 @@ describe("installing helm chart from new tab", () => { describe("when default configuration resolves", () => { beforeEach(async () => { - await callForHelmChartValuesMock.resolve( + await requestHelmChartValuesMock.resolve( "some-default-configuration-for-other-version", ); }); @@ -772,7 +721,7 @@ describe("installing helm chart from new tab", () => { fireEvent.click(installButton); expect( - callForCreateHelmReleaseMock, + requestCreateHelmReleaseMock, ).toHaveBeenCalledWith({ chart: "some-name", name: undefined, @@ -829,7 +778,7 @@ describe("installing helm chart from new tab", () => { fireEvent.click(installButton); - expect(callForCreateHelmReleaseMock).toHaveBeenCalledWith( + expect(requestCreateHelmReleaseMock).toHaveBeenCalledWith( { chart: "some-name", name: undefined, @@ -892,7 +841,7 @@ describe("installing helm chart from new tab", () => { ) .selectOption("some-other-version"); - await callForHelmChartValuesMock.resolve( + await requestHelmChartValuesMock.resolve( "some-default-configuration-for-other-version", ); @@ -948,7 +897,7 @@ describe("installing helm chart from new tab", () => { fireEvent.click(installButton); - expect(callForCreateHelmReleaseMock).toHaveBeenCalledWith({ + expect(requestCreateHelmReleaseMock).toHaveBeenCalledWith({ chart: "some-name", name: undefined, namespace: "default", @@ -965,7 +914,7 @@ describe("installing helm chart from new tab", () => { ) .selectOption("some-other-version"); - await callForHelmChartValuesMock.resolve( + await requestHelmChartValuesMock.resolve( "some-default-configuration-for-other-version", ); @@ -1014,7 +963,7 @@ describe("installing helm chart from new tab", () => { fireEvent.click(installButton); - expect(callForCreateHelmReleaseMock).toHaveBeenCalledWith({ + expect(requestCreateHelmReleaseMock).toHaveBeenCalledWith({ chart: "some-name", name: "some-custom-name", namespace: "default", diff --git a/src/features/helm-charts/installing-chart/installing-helm-chart-from-previously-opened-tab.test.ts b/src/features/helm-charts/installing-chart/installing-helm-chart-from-previously-opened-tab.test.ts index c49f3a7942..978e1635a7 100644 --- a/src/features/helm-charts/installing-chart/installing-helm-chart-from-previously-opened-tab.test.ts +++ b/src/features/helm-charts/installing-chart/installing-helm-chart-from-previously-opened-tab.test.ts @@ -9,23 +9,23 @@ import type { ApplicationBuilder } from "../../../renderer/components/test-utils import { getApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; import { HelmChart } from "../../../common/k8s-api/endpoints/helm-charts.api"; import getRandomInstallChartTabIdInjectable from "../../../renderer/components/dock/install-chart/get-random-install-chart-tab-id.injectable"; -import type { CallForHelmChartValues } from "../../../renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable"; -import callForHelmChartValuesInjectable from "../../../renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable"; import namespaceStoreInjectable from "../../../renderer/components/+namespaces/store.injectable"; import type { NamespaceStore } from "../../../renderer/components/+namespaces/store"; -import type { CallForHelmChartVersions } from "../../../renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; -import callForHelmChartVersionsInjectable from "../../../renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; import writeJsonFileInjectable from "../../../common/fs/write-json-file.injectable"; import directoryForLensLocalStorageInjectable from "../../../common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable"; import hostedClusterIdInjectable from "../../../renderer/cluster-frame-context/hosted-cluster-id.injectable"; import { TabKind } from "../../../renderer/components/dock/dock/store"; import { controlWhenStoragesAreReady } from "../../../renderer/utils/create-storage/storages-are-ready"; -import callForCreateHelmReleaseInjectable from "../../../renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable"; +import requestCreateHelmReleaseInjectable from "../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; +import type { RequestHelmChartVersions } from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import requestHelmChartVersionsInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import type { RequestHelmChartValues } from "../../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; +import requestHelmChartValuesInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; describe("installing helm chart from previously opened tab", () => { let builder: ApplicationBuilder; - let callForHelmChartVersionsMock: AsyncFnMock; - let callForHelmChartValuesMock: AsyncFnMock; + let requestHelmChartVersionsMock: AsyncFnMock; + let requestHelmChartValuesMock: AsyncFnMock; let storagesAreReady: () => Promise; beforeEach(() => { @@ -33,38 +33,17 @@ describe("installing helm chart from previously opened tab", () => { builder.setEnvironmentToClusterFrame(); - callForHelmChartVersionsMock = asyncFn(); - callForHelmChartValuesMock = asyncFn(); + requestHelmChartVersionsMock = asyncFn(); + requestHelmChartValuesMock = asyncFn(); builder.beforeWindowStart((windowDi) => { - windowDi.override( - directoryForLensLocalStorageInjectable, - () => "/some-directory-for-lens-local-storage", - ); - - windowDi.override(hostedClusterIdInjectable, () => "some-cluster-id"); - storagesAreReady = controlWhenStoragesAreReady(windowDi); - windowDi.override( - callForHelmChartVersionsInjectable, - () => callForHelmChartVersionsMock, - ); - - windowDi.override( - callForHelmChartValuesInjectable, - () => callForHelmChartValuesMock, - ); - - windowDi.override( - callForHelmChartValuesInjectable, - () => callForHelmChartValuesMock, - ); - - windowDi.override( - callForCreateHelmReleaseInjectable, - () => jest.fn(), - ); + windowDi.override(directoryForLensLocalStorageInjectable, () => "/some-directory-for-lens-local-storage"); + windowDi.override(hostedClusterIdInjectable, () => "some-cluster-id"); + windowDi.override(requestHelmChartVersionsInjectable, () => requestHelmChartVersionsMock); + windowDi.override(requestHelmChartValuesInjectable, () => requestHelmChartValuesMock); + windowDi.override(requestCreateHelmReleaseInjectable, () => jest.fn()); // TODO: Replace store mocking with mock for the actual side-effect (where the namespaces are coming from) windowDi.override( @@ -154,7 +133,7 @@ describe("installing helm chart from previously opened tab", () => { }); it("calls for default configuration of the chart", () => { - expect(callForHelmChartValuesMock).toHaveBeenCalledWith( + expect(requestHelmChartValuesMock).toHaveBeenCalledWith( "some-repository", "some-name", "some-other-version", @@ -162,7 +141,7 @@ describe("installing helm chart from previously opened tab", () => { }); it("calls for available versions", () => { - expect(callForHelmChartVersionsMock).toHaveBeenCalledWith( + expect(requestHelmChartVersionsMock).toHaveBeenCalledWith( "some-repository", "some-name", ); @@ -170,11 +149,11 @@ describe("installing helm chart from previously opened tab", () => { describe("when configuration and version resolves", () => { beforeEach(async () => { - await callForHelmChartValuesMock.resolve( + await requestHelmChartValuesMock.resolve( "some-default-configuration", ); - await callForHelmChartVersionsMock.resolve([ + await requestHelmChartVersionsMock.resolve([ HelmChart.create({ apiVersion: "some-api-version", name: "some-name", diff --git a/src/features/helm-charts/installing-chart/opening-dock-tab-for-installing-helm-chart.test.ts b/src/features/helm-charts/installing-chart/opening-dock-tab-for-installing-helm-chart.test.ts index ddc682afd2..fa37f5d97f 100644 --- a/src/features/helm-charts/installing-chart/opening-dock-tab-for-installing-helm-chart.test.ts +++ b/src/features/helm-charts/installing-chart/opening-dock-tab-for-installing-helm-chart.test.ts @@ -8,69 +8,44 @@ import type { RenderResult } from "@testing-library/react"; import { fireEvent } from "@testing-library/react"; import type { ApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; import { getApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; -import type { CallForHelmCharts } from "../../../renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable"; -import callForHelmChartsInjectable from "../../../renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable"; import { HelmChart } from "../../../common/k8s-api/endpoints/helm-charts.api"; import getRandomInstallChartTabIdInjectable from "../../../renderer/components/dock/install-chart/get-random-install-chart-tab-id.injectable"; -import callForHelmChartValuesInjectable from "../../../renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable"; -import callForCreateHelmReleaseInjectable from "../../../renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable"; -import type { CallForHelmChartReadme } from "../../../renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable"; -import callForHelmChartReadmeInjectable from "../../../renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable"; -import type { CallForHelmChartVersions } from "../../../renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; -import callForHelmChartVersionsInjectable from "../../../renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; +import requestCreateHelmReleaseInjectable from "../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; import { flushPromises } from "../../../common/test-utils/flush-promises"; import directoryForLensLocalStorageInjectable from "../../../common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable"; import hostedClusterIdInjectable from "../../../renderer/cluster-frame-context/hosted-cluster-id.injectable"; import dockStoreInjectable from "../../../renderer/components/dock/dock/store.injectable"; +import type { RequestHelmCharts } from "../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import type { RequestHelmChartVersions } from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import type { RequestHelmChartReadme } from "../../../common/k8s-api/endpoints/helm-charts.api/request-readme.injectable"; +import requestHelmChartsInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import requestHelmChartVersionsInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import requestHelmChartReadmeInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-readme.injectable"; +import requestHelmChartValuesInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; describe("opening dock tab for installing helm chart", () => { let builder: ApplicationBuilder; - let callForHelmChartsMock: AsyncFnMock; - let callForHelmChartVersionsMock: AsyncFnMock; - let callForHelmChartReadmeMock: AsyncFnMock; - let callForHelmChartValuesMock: jest.Mock; + let requestHelmChartsMock: AsyncFnMock; + let requestHelmChartVersionsMock: AsyncFnMock; + let requestHelmChartReadmeMock: AsyncFnMock; + let requestHelmChartValuesMock: jest.Mock; beforeEach(() => { builder = getApplicationBuilder(); - callForHelmChartsMock = asyncFn(); - callForHelmChartVersionsMock = asyncFn(); - callForHelmChartReadmeMock = asyncFn(); - callForHelmChartValuesMock = jest.fn(); + requestHelmChartsMock = asyncFn(); + requestHelmChartVersionsMock = asyncFn(); + requestHelmChartReadmeMock = asyncFn(); + requestHelmChartValuesMock = jest.fn(); builder.beforeWindowStart((windowDi) => { - windowDi.override( - directoryForLensLocalStorageInjectable, - () => "/some-directory-for-lens-local-storage", - ); - + windowDi.override(directoryForLensLocalStorageInjectable, () => "/some-directory-for-lens-local-storage"); windowDi.override(hostedClusterIdInjectable, () => "some-cluster-id"); - - windowDi.override( - callForHelmChartsInjectable, - () => callForHelmChartsMock, - ); - - windowDi.override( - callForHelmChartVersionsInjectable, - () => callForHelmChartVersionsMock, - ); - - windowDi.override( - callForHelmChartReadmeInjectable, - () => callForHelmChartReadmeMock, - ); - - windowDi.override( - callForHelmChartValuesInjectable, - () => callForHelmChartValuesMock, - ); - - windowDi.override( - callForCreateHelmReleaseInjectable, - () => jest.fn(), - ); - + windowDi.override(requestHelmChartsInjectable, () => requestHelmChartsMock); + windowDi.override(requestHelmChartVersionsInjectable, () => requestHelmChartVersionsMock); + windowDi.override(requestHelmChartReadmeInjectable, () => requestHelmChartReadmeMock); + windowDi.override(requestHelmChartValuesInjectable, () => requestHelmChartValuesMock); + windowDi.override(requestCreateHelmReleaseInjectable, () => jest.fn()); windowDi.override(getRandomInstallChartTabIdInjectable, () => jest .fn(() => "some-irrelevant-tab-id") @@ -102,12 +77,12 @@ describe("opening dock tab for installing helm chart", () => { }); it("calls for charts", () => { - expect(callForHelmChartsMock).toHaveBeenCalled(); + expect(requestHelmChartsMock).toHaveBeenCalled(); }); describe("when charts resolve", () => { beforeEach(async () => { - await callForHelmChartsMock.resolve([ + await requestHelmChartsMock.resolve([ HelmChart.create({ apiVersion: "some-api-version", name: "some-name", @@ -160,7 +135,7 @@ describe("opening dock tab for installing helm chart", () => { }); it("calls for chart versions", () => { - expect(callForHelmChartVersionsMock).toHaveBeenCalledWith( + expect(requestHelmChartVersionsMock).toHaveBeenCalledWith( "some-repository", "some-name", ); @@ -174,7 +149,7 @@ describe("opening dock tab for installing helm chart", () => { describe("when chart versions resolve", () => { beforeEach(async () => { - await callForHelmChartVersionsMock.resolve([ + await requestHelmChartVersionsMock.resolve([ HelmChart.create({ apiVersion: "some-api-version", name: "some-name", @@ -210,7 +185,7 @@ describe("opening dock tab for installing helm chart", () => { }); it("calls for chart readme for the version", () => { - expect(callForHelmChartReadmeMock).toHaveBeenCalledWith( + expect(requestHelmChartReadmeMock).toHaveBeenCalledWith( "some-repository", "some-name", "some-version", @@ -243,7 +218,7 @@ describe("opening dock tab for installing helm chart", () => { describe("when readme resolves", () => { beforeEach(async () => { - await callForHelmChartReadmeMock.resolve("some-readme"); + await requestHelmChartReadmeMock.resolve("some-readme"); }); it("renders", () => { @@ -258,7 +233,7 @@ describe("opening dock tab for installing helm chart", () => { describe("when selecting different version", () => { beforeEach(() => { - callForHelmChartReadmeMock.mockClear(); + requestHelmChartReadmeMock.mockClear(); builder.select .openMenu( @@ -280,7 +255,7 @@ describe("opening dock tab for installing helm chart", () => { }); it("calls for chart readme for the version", () => { - expect(callForHelmChartReadmeMock).toHaveBeenCalledWith( + expect(requestHelmChartReadmeMock).toHaveBeenCalledWith( "some-repository", "some-name", "some-other-version", @@ -289,7 +264,7 @@ describe("opening dock tab for installing helm chart", () => { describe("when readme resolves", () => { beforeEach(async () => { - await callForHelmChartReadmeMock.resolve("some-readme"); + await requestHelmChartReadmeMock.resolve("some-readme"); }); it("renders", () => { @@ -305,7 +280,7 @@ describe("opening dock tab for installing helm chart", () => { await flushPromises(); - expect(callForHelmChartValuesMock).toHaveBeenCalledWith( + expect(requestHelmChartValuesMock).toHaveBeenCalledWith( "some-repository", "some-name", "some-other-version", @@ -316,7 +291,7 @@ describe("opening dock tab for installing helm chart", () => { describe("when selecting to install the chart", () => { beforeEach(() => { - callForHelmChartVersionsMock.mockClear(); + requestHelmChartVersionsMock.mockClear(); const installButton = rendered.getByTestId( "install-chart-for-some-repository-some-name", diff --git a/src/features/helm-charts/listing-active-helm-repositories-in-preferences.test.ts b/src/features/helm-charts/listing-active-helm-repositories-in-preferences.test.ts index c8407767ef..19aaf28938 100644 --- a/src/features/helm-charts/listing-active-helm-repositories-in-preferences.test.ts +++ b/src/features/helm-charts/listing-active-helm-repositories-in-preferences.test.ts @@ -10,7 +10,7 @@ import readYamlFileInjectable from "../../common/fs/read-yaml-file.injectable"; import type { AsyncFnMock } from "@async-fn/jest"; import asyncFn from "@async-fn/jest"; import type { HelmRepositoriesFromYaml } from "../../main/helm/repositories/get-active-helm-repositories/get-active-helm-repositories.injectable"; -import execFileInjectable from "../../common/fs/exec-file.injectable"; +import execFileInjectable, { type ExecFile } from "../../common/fs/exec-file.injectable"; import helmBinaryPathInjectable from "../../main/helm/helm-binary-path.injectable"; import loggerInjectable from "../../common/logger.injectable"; import type { Logger } from "../../common/logger"; @@ -21,7 +21,7 @@ describe("listing active helm repositories in preferences", () => { let builder: ApplicationBuilder; let rendered: RenderResult; let readYamlFileMock: AsyncFnMock; - let execFileMock: AsyncFnMock>; + let execFileMock: AsyncFnMock; let loggerStub: Logger; let showErrorNotificationMock: jest.Mock; diff --git a/src/features/helm-charts/upgrade-chart/__snapshots__/upgrade-chart-new-tab.test.ts.snap b/src/features/helm-charts/upgrade-chart/__snapshots__/upgrade-chart-new-tab.test.ts.snap new file mode 100644 index 0000000000..52d08559d6 --- /dev/null +++ b/src/features/helm-charts/upgrade-chart/__snapshots__/upgrade-chart-new-tab.test.ts.snap @@ -0,0 +1,5785 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`New Upgrade Helm Chart Dock Tab given a namespace is selected when navigating to the helm releases view renders 1`] = ` + +
+
+
+
+
+
+
+ ?? +
+
+
+
+
+ + + + + + Workloads + + + + keyboard_arrow_down + + + +
+
+ + + + list + + + + Config + + +
+
+ + + + device_hub + + + + Network + + + + keyboard_arrow_down + + + +
+
+ + + + storage + + + + Storage + + +
+
+ + + + + + Helm + + + + keyboard_arrow_down + + + +
+
+ + + + security + + + + Access Control + + +
+
+ + + + extension + + + + Custom Resources + + + + keyboard_arrow_down + + + +
+
+
+
+
+
+
+
+ + +
+
+
+
+
+ Releases +
+
+ 0 items +
+
+
+ + +
+
+
+ Namespace: my-second-namespace +
+
+ +
+
+
+ + +
+
+
+
+
+ +
+
+
+
+
+
+
+ +
+
+
+ Name +
+ + + arrow_drop_down + + +
+
+
+ Namespace +
+ + + arrow_drop_down + + +
+
+
+ Chart +
+ + + arrow_drop_down + + +
+
+
+ Revision +
+ + + arrow_drop_down + + +
+
+
+ Version +
+
+
+
+ App Version +
+
+
+
+ Status +
+ + + arrow_drop_down + + +
+
+
+ Updated +
+ + + arrow_drop_down + + +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + add + + +
+ New tab +
+
+
+
+
+
+
+
+ +`; + +exports[`New Upgrade Helm Chart Dock Tab given a namespace is selected when navigating to the helm releases view when helm releases resolves renders 1`] = ` + +
+
+
+
+
+
+
+ ?? +
+
+
+
+
+ + + + + + Workloads + + + + keyboard_arrow_down + + + +
+
+ + + + list + + + + Config + + +
+
+ + + + device_hub + + + + Network + + + + keyboard_arrow_down + + + +
+
+ + + + storage + + + + Storage + + +
+
+ + + + + + Helm + + + + keyboard_arrow_down + + + +
+
+ + + + security + + + + Access Control + + +
+
+ + + + extension + + + + Custom Resources + + + + keyboard_arrow_down + + + +
+
+
+
+
+
+
+
+ + +
+
+
+
+
+ Releases +
+
+ 1 item +
+
+
+ + +
+
+
+ Namespace: my-second-namespace +
+
+ +
+
+
+ + +
+
+
+
+
+ +
+
+
+
+
+
+
+ +
+
+
+ Name +
+ + + arrow_drop_down + + +
+
+
+ Namespace +
+ + + arrow_drop_down + + +
+
+
+ Chart +
+ + + arrow_drop_down + + +
+
+
+ Revision +
+ + + arrow_drop_down + + +
+
+
+ Version +
+
+
+
+ App Version +
+
+
+
+ Status +
+ + + arrow_drop_down + + +
+
+
+ Updated +
+ + + arrow_drop_down + + +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+ +
+
+ some-name +
+
+ my-second-namespace +
+
+ some-chart +
+
+ NaN +
+
+ 1.0.0 +
+
+ some-app-version +
+
+ Some-status +
+
+ NaNy +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + add + + +
+ New tab +
+
+
+
+
+
+
+
+ +`; + +exports[`New Upgrade Helm Chart Dock Tab given a namespace is selected when navigating to the helm releases view when helm releases resolves when clicking the menu for a helm release renders 1`] = ` + +
+
+
+
+
+
+
+ ?? +
+
+
+
+
+ + + + + + Workloads + + + + keyboard_arrow_down + + + +
+
+ + + + list + + + + Config + + +
+
+ + + + device_hub + + + + Network + + + + keyboard_arrow_down + + + +
+
+ + + + storage + + + + Storage + + +
+
+ + + + + + Helm + + + + keyboard_arrow_down + + + +
+
+ + + + security + + + + Access Control + + +
+
+ + + + extension + + + + Custom Resources + + + + keyboard_arrow_down + + + +
+
+
+
+
+
+
+
+ + +
+
+
+
+
+ Releases +
+
+ 1 item +
+
+
+ + +
+
+
+ Namespace: my-second-namespace +
+
+ +
+
+
+ + +
+
+
+
+
+ +
+
+
+
+
+
+
+ +
+
+
+ Name +
+ + + arrow_drop_down + + +
+
+
+ Namespace +
+ + + arrow_drop_down + + +
+
+
+ Chart +
+ + + arrow_drop_down + + +
+
+
+ Revision +
+ + + arrow_drop_down + + +
+
+
+ Version +
+
+
+
+ App Version +
+
+
+
+ Status +
+ + + arrow_drop_down + + +
+
+
+ Updated +
+ + + arrow_drop_down + + +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+ +
+
+ some-name +
+
+ my-second-namespace +
+
+ some-chart +
+
+ NaN +
+
+ 1.0.0 +
+
+ some-app-version +
+
+ Some-status +
+
+ NaNy +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + add + + +
+ New tab +
+
+
+
+
+
+
+
+ + +`; + +exports[`New Upgrade Helm Chart Dock Tab given a namespace is selected when navigating to the helm releases view when helm releases resolves when clicking the menu for a helm release when clicking the upgrade chart menu item renders 1`] = ` + +
+
+
+
+
+
+
+ ?? +
+
+
+
+
+ + + + + + Workloads + + + + keyboard_arrow_down + + + +
+
+ + + + list + + + + Config + + +
+
+ + + + device_hub + + + + Network + + + + keyboard_arrow_down + + + +
+
+ + + + storage + + + + Storage + + +
+
+ + + + + + Helm + + + + keyboard_arrow_down + + + +
+
+ + + + security + + + + Access Control + + +
+
+ + + + extension + + + + Custom Resources + + + + keyboard_arrow_down + + + +
+
+
+
+
+
+
+
+ + +
+
+
+
+
+ Releases +
+
+ 1 item +
+
+
+ + +
+
+
+ Namespace: my-second-namespace +
+
+ +
+
+
+ + +
+
+
+
+
+ +
+
+
+
+
+
+
+ +
+
+
+ Name +
+ + + arrow_drop_down + + +
+
+
+ Namespace +
+ + + arrow_drop_down + + +
+
+
+ Chart +
+ + + arrow_drop_down + + +
+
+
+ Revision +
+ + + arrow_drop_down + + +
+
+
+ Version +
+
+
+
+ App Version +
+
+
+
+ Status +
+ + + arrow_drop_down + + +
+
+
+ Updated +
+ + + arrow_drop_down + + +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+ +
+
+ some-name +
+
+ my-second-namespace +
+
+ some-chart +
+
+ NaN +
+
+ 1.0.0 +
+
+ some-app-version +
+
+ Some-status +
+
+ NaNy +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+ + + add + + +
+ New tab +
+
+ + + fullscreen + + +
+ Fit to window +
+ + + keyboard_arrow_down + + +
+ Minimize +
+
+
+
+
+
+
+
+
+
+ +`; + +exports[`New Upgrade Helm Chart Dock Tab given a namespace is selected when navigating to the helm releases view when helm releases resolves when clicking the menu for a helm release when clicking the upgrade chart menu item when request for all helm charts resolves when the requests of versions of the helm charts resolves renders 1`] = ` + +
+
+
+
+
+
+
+ ?? +
+
+
+
+
+ + + + + + Workloads + + + + keyboard_arrow_down + + + +
+
+ + + + list + + + + Config + + +
+
+ + + + device_hub + + + + Network + + + + keyboard_arrow_down + + + +
+
+ + + + storage + + + + Storage + + +
+
+ + + + + + Helm + + + + keyboard_arrow_down + + + +
+
+ + + + security + + + + Access Control + + +
+
+ + + + extension + + + + Custom Resources + + + + keyboard_arrow_down + + + +
+
+
+
+
+
+
+
+ + +
+
+
+
+
+ Releases +
+
+ 1 item +
+
+
+ + +
+
+
+ Namespace: my-second-namespace +
+
+ +
+
+
+ + +
+
+
+
+
+ +
+
+
+
+
+
+
+ +
+
+
+ Name +
+ + + arrow_drop_down + + +
+
+
+ Namespace +
+ + + arrow_drop_down + + +
+
+
+ Chart +
+ + + arrow_drop_down + + +
+
+
+ Revision +
+ + + arrow_drop_down + + +
+
+
+ Version +
+
+
+
+ App Version +
+
+
+
+ Status +
+ + + arrow_drop_down + + +
+
+
+ Updated +
+ + + arrow_drop_down + + +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+ +
+
+ some-name +
+
+ my-second-namespace +
+
+ some-chart +
+
+ NaN +
+
+ 1.0.0 +
+
+ some-app-version +
+
+ Some-status +
+
+ NaNy +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+ + + add + + +
+ New tab +
+
+ + + fullscreen + + +
+ Fit to window +
+ + + keyboard_arrow_down + + +
+ Minimize +
+
+
+
+
+
+
+
+ + Release + + +
+ some-name +
+ + Namespace + + +
+ my-second-namespace +
+ + Version + + +
+ 1.0.0 +
+ + Upgrade version + +
+ + +
+
+
+ some-repo/some-chart-1.0.1 +
+
+ +
+
+
+ + +
+
+
+
+
+
+ + + +
+ +
+
+
+
+
+
+ +`; + +exports[`New Upgrade Helm Chart Dock Tab given a namespace is selected when navigating to the helm releases view when helm releases resolves when clicking the menu for a helm release when clicking the upgrade chart menu item when request for all helm charts resolves when the requests of versions of the helm charts resolves when the configuration request resolves when closing the upgrade chart tab renders 1`] = ` + +
+
+
+
+
+
+
+ ?? +
+
+
+
+
+ + + + + + Workloads + + + + keyboard_arrow_down + + + +
+
+ + + + list + + + + Config + + +
+
+ + + + device_hub + + + + Network + + + + keyboard_arrow_down + + + +
+
+ + + + storage + + + + Storage + + +
+
+ + + + + + Helm + + + + keyboard_arrow_down + + + +
+
+ + + + security + + + + Access Control + + +
+
+ + + + extension + + + + Custom Resources + + + + keyboard_arrow_down + + + +
+
+
+
+
+
+
+
+ + +
+
+
+
+
+ Releases +
+
+ 1 item +
+
+
+ + +
+
+
+ Namespace: my-second-namespace +
+
+ +
+
+
+ + +
+
+
+
+
+ +
+
+
+
+
+
+
+ +
+
+
+ Name +
+ + + arrow_drop_down + + +
+
+
+ Namespace +
+ + + arrow_drop_down + + +
+
+
+ Chart +
+ + + arrow_drop_down + + +
+
+
+ Revision +
+ + + arrow_drop_down + + +
+
+
+ Version +
+
+
+
+ App Version +
+
+
+
+ Status +
+ + + arrow_drop_down + + +
+
+
+ Updated +
+ + + arrow_drop_down + + +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+ +
+
+ some-name +
+
+ my-second-namespace +
+
+ some-chart +
+
+ NaN +
+
+ 1.0.0 +
+
+ some-app-version +
+
+ Some-status +
+
+ NaNy +
+
+
+ + + more_vert + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + add + + +
+ New tab +
+
+
+
+
+
+
+
+ +`; diff --git a/src/features/helm-charts/upgrade-chart/upgrade-chart-new-tab.test.ts b/src/features/helm-charts/upgrade-chart/upgrade-chart-new-tab.test.ts new file mode 100644 index 0000000000..c58cf24ba2 --- /dev/null +++ b/src/features/helm-charts/upgrade-chart/upgrade-chart-new-tab.test.ts @@ -0,0 +1,268 @@ +/** + * 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 { RenderResult } from "@testing-library/react"; +import type { NavigateToHelmReleases } from "../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable"; +import navigateToHelmReleasesInjectable from "../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable"; +import { HelmChart } from "../../../common/k8s-api/endpoints/helm-charts.api"; +import type { RequestHelmCharts } from "../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import requestHelmChartsInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import type { RequestHelmChartVersions } from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import requestHelmChartVersionsInjectable from "../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import type { RequestHelmReleaseConfiguration } from "../../../common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable"; +import requestHelmReleaseConfigurationInjectable from "../../../common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable"; +import type { RequestHelmReleases } from "../../../common/k8s-api/endpoints/helm-releases.api/request-releases.injectable"; +import requestHelmReleasesInjectable from "../../../common/k8s-api/endpoints/helm-releases.api/request-releases.injectable"; +import { advanceFakeTime, useFakeTime } from "../../../common/test-utils/use-fake-time"; +import dockStoreInjectable from "../../../renderer/components/dock/dock/store.injectable"; +import type { ApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; +import { getApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder"; + +describe("New Upgrade Helm Chart Dock Tab", () => { + let builder: ApplicationBuilder; + let renderResult: RenderResult; + let requestHelmReleaseConfigurationMock: AsyncFnMock; + let requestHelmReleasesMock: AsyncFnMock; + let requestHelmChartsMock: AsyncFnMock; + let requestHelmChartVersionsMock: AsyncFnMock; + let navigateToHelmReleases: NavigateToHelmReleases; + + beforeEach(async () => { + builder = getApplicationBuilder(); + builder.setEnvironmentToClusterFrame(); + + builder.beforeWindowStart((windowDi) => { + requestHelmReleaseConfigurationMock = asyncFn(); + windowDi.override(requestHelmReleaseConfigurationInjectable, () => requestHelmReleaseConfigurationMock); + + requestHelmReleasesMock = asyncFn(); + windowDi.override(requestHelmReleasesInjectable, () => requestHelmReleasesMock); + + requestHelmChartsMock = asyncFn(); + windowDi.override(requestHelmChartsInjectable, () => requestHelmChartsMock); + + requestHelmChartVersionsMock = asyncFn(); + windowDi.override(requestHelmChartVersionsInjectable, () => requestHelmChartVersionsMock); + + navigateToHelmReleases = windowDi.inject(navigateToHelmReleasesInjectable); + }); + + useFakeTime("2020-01-12 12:00:00"); + + builder.namespaces.add("my-first-namespace"); + builder.namespaces.add("my-second-namespace"); + + renderResult = await builder.render(); + + const dockStore = builder.applicationWindow.only.di.inject(dockStoreInjectable); + + // TODO: Make TerminalWindow unit testable to allow realistic behaviour + dockStore.closeTab("terminal"); + }); + + describe("given a namespace is selected", () => { + beforeEach(() => { + builder.namespaces.select("my-second-namespace"); + }); + + describe("when navigating to the helm releases view", () => { + beforeEach(() => { + navigateToHelmReleases(); + }); + + it("renders", () => { + expect(renderResult.baseElement).toMatchSnapshot(); + }); + + it("requests helm releases for the selected namespace", () => { + expect(requestHelmReleasesMock).toBeCalledWith("my-second-namespace"); + }); + + describe("when helm releases resolves", () => { + beforeEach(async () => { + await requestHelmReleasesMock.resolve([ + { + appVersion: "some-app-version", + name: "some-name", + namespace: "my-second-namespace", + chart: "some-chart-1.0.0", + status: "some-status", + updated: "some-updated", + revision: "some-revision", + }, + ]); + }); + + it("renders", () => { + expect(renderResult.baseElement).toMatchSnapshot(); + }); + + describe("when clicking the menu for a helm release", () => { + beforeEach(() => { + const helmReleaseMenu = renderResult.getByTestId("menu-actions-icon-for-release-menu-for-my-second-namespace/some-name"); + + helmReleaseMenu.click(); + }); + + it("renders", () => { + expect(renderResult.baseElement).toMatchSnapshot(); + }); + + describe("when clicking the upgrade chart menu item", () => { + beforeEach(() => { + const upgradeHelmChartMenuItem = renderResult.getByTestId("upgrade-chart-menu-item-for-my-second-namespace/some-name"); + + upgradeHelmChartMenuItem.click(); + advanceFakeTime(100); + }); + + it("renders", () => { + expect(renderResult.baseElement).toMatchSnapshot(); + }); + + it("requests all helm charts", () => { + expect(requestHelmChartsMock).toBeCalled(); + }); + + describe("when request for all helm charts resolves", () => { + beforeEach(async () => { + await requestHelmChartsMock.resolve([ + HelmChart.create({ + apiVersion: "1.2.3", + version: "1.0.0", + created: "at-some-time", + name: "some-chart", + repo: "some-repo", + }), + HelmChart.create({ + apiVersion: "1.2.3", + version: "1.0.0", + created: "at-some-third-time", + name: "some-chart", + repo: "some-third-repo", + }), + HelmChart.create({ + apiVersion: "1.2.3", + version: "0.9.0", + created: "at-some-other-time", + name: "some-other-chart", + repo: "some-repo", + }), + ]); + }); + + it("requests versions of the helm charts", () => { + expect(requestHelmChartVersionsMock).toBeCalledWith( + "some-repo", + "some-chart", + ); + expect(requestHelmChartVersionsMock).toBeCalledWith( + "some-third-repo", + "some-chart", + ); + }); + + it("shows the dock tab of the upgrade chart tab", () => { + expect(renderResult.queryByTestId("dock-tab-content-for-some-irrelevant-random-id")).toBeInTheDocument(); + }); + + it("does not yet show the dock contents of the upgrade chart tab", () => { + expect(renderResult.queryByTestId("upgrade-chart-dock-tab-contents-for-my-second-namespace/some-name")).not.toBeInTheDocument(); + }); + + describe("when the requests of versions of the helm charts resolves", () => { + beforeEach(async () => { + await requestHelmChartVersionsMock.resolveSpecific( + ["some-repo", "some-chart"], + [ + HelmChart.create({ + apiVersion: "1.2.3", + version: "1.0.0", + created: "at-some-time", + name: "some-chart", + repo: "some-repo", + }), + HelmChart.create({ + apiVersion: "1.2.3", + version: "1.0.1", + created: "at-some-time", + name: "some-chart", + repo: "some-repo", + }), + ], + ); + + await requestHelmChartVersionsMock.resolveSpecific( + ["some-third-repo", "some-chart"], + [ + HelmChart.create({ + apiVersion: "1.2.3", + version: "0.9.0", + created: "at-some-other-time", + name: "some-other-chart", + repo: "some-repo", + }), + HelmChart.create({ + apiVersion: "1.2.3", + version: "0.9.1", + created: "at-some-other-time", + name: "some-other-chart", + repo: "some-repo", + }), + ], + ); + }); + + it("renders", () => { + expect(renderResult.baseElement).toMatchSnapshot(); + }); + + it("shows the dock contents of the upgrade chart tab", () => { + expect(renderResult.queryByTestId("upgrade-chart-dock-tab-contents-for-my-second-namespace/some-name")).toBeInTheDocument(); + }); + + it("requests the configuration for the specific helm release", () => { + expect(requestHelmReleaseConfigurationMock).toBeCalledWith( + "some-name", + "my-second-namespace", + true, + ); + }); + + describe("when the configuration request resolves", () => { + beforeEach(async () => { + await requestHelmReleaseConfigurationMock.resolve("some confiration for the helm release"); + }); + + it("renders", () => { + expect(renderResult.baseElement).toMatchSnapshot(); + }); + + describe("when closing the upgrade chart tab", () => { + beforeEach(() => { + const closeDockTab = renderResult.getByTestId("dock-tab-close-for-some-irrelevant-random-id"); + + closeDockTab.click(); + }); + + it("renders", () => { + expect(renderResult.baseElement).toMatchSnapshot(); + }); + + it("does so", () => { + expect(renderResult.queryByTestId("dock-tab-content-for-some-irrelevant-random-id")).not.toBeInTheDocument(); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); +}); diff --git a/src/features/helm-releases/__snapshots__/showing-details-for-helm-release.test.ts.snap b/src/features/helm-releases/__snapshots__/showing-details-for-helm-release.test.ts.snap index ced68044ac..a4159c60be 100644 --- a/src/features/helm-releases/__snapshots__/showing-details-for-helm-release.test.ts.snap +++ b/src/features/helm-releases/__snapshots__/showing-details-for-helm-release.test.ts.snap @@ -661,6 +661,7 @@ exports[`showing details for helm release given application is started when navi > -
+
Close ⌘+W
@@ -1404,6 +1407,7 @@ exports[`showing details for helm release given application is started when navi > -
+
Close ⌘+W
@@ -2131,7 +2137,7 @@ exports[`showing details for helm release given application is started when navi
- + 1.0.0
@@ -2212,7 +2219,7 @@ exports[`showing details for helm release given application is started when navi
- + 2.0.0
@@ -2315,6 +2323,7 @@ exports[`showing details for helm release given application is started when navi > -
+
Close ⌘+W
@@ -3042,7 +3053,7 @@ exports[`showing details for helm release given application is started when navi
- + 1.0.0
@@ -3123,7 +3135,7 @@ exports[`showing details for helm release given application is started when navi
- + 2.0.0
@@ -3226,6 +3239,7 @@ exports[`showing details for helm release given application is started when navi > -
+
Close ⌘+W
@@ -4014,7 +4030,7 @@ exports[`showing details for helm release given application is started when navi
- + 1.0.0
@@ -4095,7 +4112,7 @@ exports[`showing details for helm release given application is started when navi
- + 2.0.0
@@ -4198,6 +4216,7 @@ exports[`showing details for helm release given application is started when navi > -
+
Close ⌘+W
@@ -4986,7 +5007,7 @@ exports[`showing details for helm release given application is started when navi
- + 1.0.0
@@ -5067,7 +5089,7 @@ exports[`showing details for helm release given application is started when navi
- + 2.0.0
@@ -5170,6 +5193,7 @@ exports[`showing details for helm release given application is started when navi > -
+
Close ⌘+W
@@ -5280,6 +5306,7 @@ exports[`showing details for helm release given application is started when navi >
  • - some-chart + some-chart-1.0.0
    • @@ -6210,7 +6239,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -6291,7 +6321,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -6394,6 +6425,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -6504,6 +6538,7 @@ exports[`showing details for helm release given application is started when navi >
  • - some-chart + some-chart-1.0.0
    • @@ -7434,7 +7471,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -7515,7 +7553,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -7618,6 +7657,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -7728,6 +7770,7 @@ exports[`showing details for helm release given application is started when navi >
  • - some-chart + some-chart-1.0.0
    • @@ -8008,7 +8053,7 @@ exports[`showing details for helm release given application is started when navi `; -exports[`showing details for helm release given application is started when navigating to helm releases when releases resolve when selecting release to see details when call for release resolve with release when configuration resolves when changing the configuration when saving when update resolves with failure renders 1`] = ` +exports[`showing details for helm release given application is started when navigating to helm releases when releases resolve when selecting release to see details when call for release resolve with release when configuration resolves when changing the configuration when saving when requestHelmCharts resolves when requestHelmChartVersions resolves when update resolves with failure renders 1`] = `
    -
    +
    Close ⌘+W
    @@ -8779,6 +8827,7 @@ exports[`showing details for helm release given application is started when navi >
  • - some-chart + some-chart-1.0.0
    • @@ -9059,7 +9110,7 @@ exports[`showing details for helm release given application is started when navi `; -exports[`showing details for helm release given application is started when navigating to helm releases when releases resolve when selecting release to see details when call for release resolve with release when configuration resolves when changing the configuration when saving when update resolves with success renders 1`] = ` +exports[`showing details for helm release given application is started when navigating to helm releases when releases resolve when selecting release to see details when call for release resolve with release when configuration resolves when changing the configuration when saving when requestHelmCharts resolves when requestHelmChartVersions resolves when update resolves with success renders 1`] = `
    -
    +
    Close ⌘+W
    @@ -9830,6 +9884,7 @@ exports[`showing details for helm release given application is started when navi >
  • - some-chart + some-chart-1.0.0
    • @@ -10762,7 +10819,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -10843,7 +10901,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -10946,6 +11005,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -11056,6 +11118,7 @@ exports[`showing details for helm release given application is started when navi >
  • - some-chart + some-chart-1.0.0
    • @@ -11986,7 +12051,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -12067,7 +12133,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -12170,6 +12237,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -12219,6 +12289,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -12955,7 +13028,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -13036,7 +13110,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -13139,6 +13214,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -13930,7 +14008,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -14011,7 +14090,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -14114,6 +14194,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -14841,7 +14924,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -14922,7 +15006,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -15025,6 +15110,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    @@ -15813,7 +15901,7 @@ exports[`showing details for helm release given application is started when navi
    - + 1.0.0
    @@ -15894,7 +15983,7 @@ exports[`showing details for helm release given application is started when navi
    - + 2.0.0
    @@ -15997,6 +16087,7 @@ exports[`showing details for helm release given application is started when navi > -
    +
    Close ⌘+W
    diff --git a/src/features/helm-releases/showing-details-for-helm-release.test.ts b/src/features/helm-releases/showing-details-for-helm-release.test.ts index 4a4dc27149..57bf101414 100644 --- a/src/features/helm-releases/showing-details-for-helm-release.test.ts +++ b/src/features/helm-releases/showing-details-for-helm-release.test.ts @@ -9,27 +9,38 @@ import type { RenderResult } from "@testing-library/react"; import { fireEvent } from "@testing-library/react"; import type { AsyncFnMock } from "@async-fn/jest"; import asyncFn from "@async-fn/jest"; -import type { CallForHelmReleases } from "../../renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.injectable"; -import callForHelmReleasesInjectable from "../../renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.injectable"; -import namespaceStoreInjectable from "../../renderer/components/+namespaces/store.injectable"; -import type { NamespaceStore } from "../../renderer/components/+namespaces/store"; -import type { CallForHelmReleaseConfiguration } from "../../renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.injectable"; -import callForHelmReleaseConfigurationInjectable from "../../renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.injectable"; -import type { CallForHelmReleaseUpdate } from "../../renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.injectable"; -import callForHelmReleaseUpdateInjectable from "../../renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.injectable"; +import type { RequestHelmReleases } from "../../common/k8s-api/endpoints/helm-releases.api/request-releases.injectable"; +import requestHelmReleasesInjectable from "../../common/k8s-api/endpoints/helm-releases.api/request-releases.injectable"; +import type { RequestHelmReleaseConfiguration } from "../../common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable"; +import requestHelmReleaseConfigurationInjectable from "../../common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable"; +import type { RequestHelmReleaseUpdate } from "../../common/k8s-api/endpoints/helm-releases.api/request-update.injectable"; +import requestHelmReleaseUpdateInjectable from "../../common/k8s-api/endpoints/helm-releases.api/request-update.injectable"; import { useFakeTime } from "../../common/test-utils/use-fake-time"; -import type { CallForHelmRelease, DetailedHelmRelease } from "../../renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release.injectable"; -import callForHelmReleaseInjectable from "../../renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release.injectable"; +import type { RequestDetailedHelmRelease } from "../../renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable"; +import requestDetailedHelmReleaseInjectable from "../../renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable"; import showSuccessNotificationInjectable from "../../renderer/components/notifications/show-success-notification.injectable"; import showCheckedErrorInjectable from "../../renderer/components/notifications/show-checked-error.injectable"; import getRandomUpgradeChartTabIdInjectable from "../../renderer/components/dock/upgrade-chart/get-random-upgrade-chart-tab-id.injectable"; +import type { RequestHelmCharts } from "../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import type { RequestHelmChartVersions } from "../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import type { RequestHelmChartReadme } from "../../common/k8s-api/endpoints/helm-charts.api/request-readme.injectable"; +import type { RequestHelmChartValues } from "../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; +import requestHelmChartsInjectable from "../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import requestHelmChartVersionsInjectable from "../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import requestHelmChartReadmeInjectable from "../../common/k8s-api/endpoints/helm-charts.api/request-readme.injectable"; +import requestHelmChartValuesInjectable from "../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; +import { HelmChart } from "../../common/k8s-api/endpoints/helm-charts.api"; describe("showing details for helm release", () => { let builder: ApplicationBuilder; - let callForHelmReleasesMock: AsyncFnMock; - let callForHelmReleaseMock: AsyncFnMock; - let callForHelmReleaseConfigurationMock: AsyncFnMock; - let callForHelmReleaseUpdateMock: AsyncFnMock; + let requestHelmReleasesMock: AsyncFnMock; + let requestDetailedHelmReleaseMock: AsyncFnMock; + let requestHelmReleaseConfigurationMock: AsyncFnMock; + let requestHelmReleaseUpdateMock: AsyncFnMock; + let requestHelmChartsMock: AsyncFnMock; + let requestHelmChartVersionsMock: AsyncFnMock; + let requestHelmChartReadmeMock: AsyncFnMock; + let requestHelmChartValuesMock: AsyncFnMock; let showSuccessNotificationMock: jest.Mock; let showCheckedErrorNotificationMock: jest.Mock; @@ -40,60 +51,36 @@ describe("showing details for helm release", () => { builder.setEnvironmentToClusterFrame(); - callForHelmReleasesMock = asyncFn(); - callForHelmReleaseMock = asyncFn(); - callForHelmReleaseConfigurationMock = asyncFn(); - callForHelmReleaseUpdateMock = asyncFn(); + requestHelmReleasesMock = asyncFn(); + requestDetailedHelmReleaseMock = asyncFn(); + requestHelmReleaseConfigurationMock = asyncFn(); + requestHelmReleaseUpdateMock = asyncFn(); + requestHelmChartsMock = asyncFn(); + requestHelmChartVersionsMock = asyncFn(); + requestHelmChartReadmeMock = asyncFn(); + requestHelmChartValuesMock = asyncFn(); showSuccessNotificationMock = jest.fn(); showCheckedErrorNotificationMock = jest.fn(); builder.beforeWindowStart((windowDi) => { - windowDi.override( - getRandomUpgradeChartTabIdInjectable, - () => () => "some-tab-id", - ); - - windowDi.override( - showSuccessNotificationInjectable, - () => showSuccessNotificationMock, - ); - - windowDi.override( - showCheckedErrorInjectable, - () => showCheckedErrorNotificationMock, - ); - - windowDi.override( - callForHelmReleasesInjectable, - () => callForHelmReleasesMock, - ); - - windowDi.override( - callForHelmReleaseInjectable, - () => callForHelmReleaseMock, - ); - - windowDi.override( - callForHelmReleaseConfigurationInjectable, - () => callForHelmReleaseConfigurationMock, - ); - - windowDi.override( - callForHelmReleaseUpdateInjectable, - () => callForHelmReleaseUpdateMock, - ); - - windowDi.override( - namespaceStoreInjectable, - () => - ({ - contextNamespaces: ["some-namespace", "some-other-namespace"], - items: [], - selectNamespaces: () => {}, - } as unknown as NamespaceStore), - ); + windowDi.override(getRandomUpgradeChartTabIdInjectable, () => () => "some-tab-id"); + windowDi.override(showSuccessNotificationInjectable, () => showSuccessNotificationMock); + windowDi.override(showCheckedErrorInjectable, () => showCheckedErrorNotificationMock); + windowDi.override(requestHelmReleasesInjectable, () => requestHelmReleasesMock); + windowDi.override(requestDetailedHelmReleaseInjectable, () => requestDetailedHelmReleaseMock); + windowDi.override(requestHelmReleaseConfigurationInjectable, () => requestHelmReleaseConfigurationMock); + windowDi.override(requestHelmReleaseUpdateInjectable, () => requestHelmReleaseUpdateMock); + windowDi.override(requestHelmChartsInjectable, () => requestHelmChartsMock); + windowDi.override(requestHelmChartVersionsInjectable, () => requestHelmChartVersionsMock); + windowDi.override(requestHelmChartReadmeInjectable, () => requestHelmChartReadmeMock); + windowDi.override(requestHelmChartValuesInjectable, () => requestHelmChartValuesMock); }); + + builder.namespaces.add("some-namespace"); + builder.namespaces.select("some-namespace"); + builder.namespaces.add("some-namespace"); + builder.namespaces.select("some-other-namespace"); }); describe("given application is started", () => { @@ -119,7 +106,7 @@ describe("showing details for helm release", () => { }); it("calls for releases for each selected namespace", () => { - expect(callForHelmReleasesMock.mock.calls).toEqual([ + expect(requestHelmReleasesMock.mock.calls).toEqual([ ["some-namespace"], ["some-other-namespace"], ]); @@ -132,22 +119,22 @@ describe("showing details for helm release", () => { }); it("when releases resolve but there is none, renders", async () => { - await callForHelmReleasesMock.resolve([]); - await callForHelmReleasesMock.resolve([]); + await requestHelmReleasesMock.resolve([]); + await requestHelmReleasesMock.resolve([]); expect(rendered.baseElement).toMatchSnapshot(); }); describe("when releases resolve", () => { beforeEach(async () => { - await callForHelmReleasesMock.resolveSpecific( + await requestHelmReleasesMock.resolveSpecific( ([namespace]) => namespace === "some-namespace", [ { appVersion: "some-app-version", name: "some-name", namespace: "some-namespace", - chart: "some-chart", + chart: "some-chart-1.0.0", status: "some-status", updated: "some-updated", revision: "some-revision", @@ -155,14 +142,14 @@ describe("showing details for helm release", () => { ], ); - await callForHelmReleasesMock.resolveSpecific( + await requestHelmReleasesMock.resolveSpecific( ([namespace]) => namespace === "some-other-namespace", [ { appVersion: "some-other-app-version", name: "some-other-name", namespace: "some-other-namespace", - chart: "some-other-chart", + chart: "some-other-chart-2.0.0", status: "some-other-status", updated: "some-other-updated", revision: "some-other-revision", @@ -201,7 +188,7 @@ describe("showing details for helm release", () => { }); it("calls for release", () => { - expect(callForHelmReleaseMock).toHaveBeenCalledWith( + expect(requestDetailedHelmReleaseMock).toHaveBeenCalledWith( "some-name", "some-namespace", ); @@ -215,7 +202,7 @@ describe("showing details for helm release", () => { describe("when opening details for second release", () => { beforeEach(() => { - callForHelmReleaseMock.mockClear(); + requestDetailedHelmReleaseMock.mockClear(); const row = rendered.getByTestId( "helm-release-row-for-some-other-namespace/some-other-name", @@ -229,7 +216,7 @@ describe("showing details for helm release", () => { }); it("calls for another release", () => { - expect(callForHelmReleaseMock).toHaveBeenCalledWith( + expect(requestDetailedHelmReleaseMock).toHaveBeenCalledWith( "some-other-name", "some-other-namespace", ); @@ -269,7 +256,7 @@ describe("showing details for helm release", () => { describe("when opening details for same release", () => { beforeEach(() => { - callForHelmReleaseMock.mockClear(); + requestDetailedHelmReleaseMock.mockClear(); const row = rendered.getByTestId( "helm-release-row-for-some-namespace/some-name", @@ -283,15 +270,14 @@ describe("showing details for helm release", () => { }); it("does not reload", () => { - expect(callForHelmReleaseMock).not.toHaveBeenCalled(); + expect(requestDetailedHelmReleaseMock).not.toHaveBeenCalled(); }); }); }); - describe("when call for release resolves with error", () => { beforeEach(async () => { - await callForHelmReleaseMock.resolve({ + await requestDetailedHelmReleaseMock.resolve({ callWasSuccessful: false, error: "some-error", }); @@ -314,15 +300,55 @@ describe("showing details for helm release", () => { }); it("does not call for release configuration", () => { - expect(callForHelmReleaseConfigurationMock).not.toHaveBeenCalled(); + expect(requestHelmReleaseConfigurationMock).not.toHaveBeenCalled(); }); }); describe("when call for release resolve with release", () => { beforeEach(async () => { - await callForHelmReleaseMock.resolve({ + await requestDetailedHelmReleaseMock.resolve({ callWasSuccessful: true, - response: detailedReleaseFake, + response: { + release: { + appVersion: "some-app-version", + chart: "some-chart-1.0.0", + status: "some-status", + updated: "some-updated", + revision: "some-revision", + name: "some-name", + namespace: "some-namespace", + }, + + details: { + name: "some-name", + namespace: "some-namespace", + version: "some-version", + config: "some-config", + manifest: "some-manifest", + + info: { + deleted: "some-deleted", + description: "some-description", + first_deployed: "some-first-deployed", + last_deployed: "some-last-deployed", + notes: "some-notes", + status: "some-status", + }, + + resources: [ + { + kind: "some-kind", + apiVersion: "some-api-version", + metadata: { + uid: "some-uid", + name: "some-resource", + namespace: "some-namespace", + creationTimestamp: "2015-10-22T07:28:00Z", + }, + }, + ], + }, + }, }); }); @@ -331,7 +357,7 @@ describe("showing details for helm release", () => { }); it("calls for release configuration", () => { - expect(callForHelmReleaseConfigurationMock).toHaveBeenCalledWith( + expect(requestHelmReleaseConfigurationMock).toHaveBeenCalledWith( "some-name", "some-namespace", true, @@ -340,7 +366,7 @@ describe("showing details for helm release", () => { describe("when configuration resolves", () => { beforeEach(async () => { - await callForHelmReleaseConfigurationMock.resolve( + await requestHelmReleaseConfigurationMock.resolve( "some-configuration", ); }); @@ -405,12 +431,12 @@ describe("showing details for helm release", () => { }); it("does not save changes yet", () => { - expect(callForHelmReleaseUpdateMock).not.toHaveBeenCalled(); + expect(requestHelmReleaseUpdateMock).not.toHaveBeenCalled(); }); describe("when toggling to see only user defined values", () => { beforeEach(() => { - callForHelmReleaseConfigurationMock.mockClear(); + requestHelmReleaseConfigurationMock.mockClear(); const toggle = rendered.getByTestId( "user-supplied-values-only-checkbox", @@ -420,7 +446,7 @@ describe("showing details for helm release", () => { }); it("calls for only user defined configuration", () => { - expect(callForHelmReleaseConfigurationMock).toHaveBeenCalledWith( + expect(requestHelmReleaseConfigurationMock).toHaveBeenCalledWith( "some-name", "some-namespace", false, @@ -429,7 +455,7 @@ describe("showing details for helm release", () => { describe("when configuration resolves", () => { beforeEach(async () => { - await callForHelmReleaseConfigurationMock.resolve( + await requestHelmReleaseConfigurationMock.resolve( "some-other-configuration", ); }); @@ -447,7 +473,7 @@ describe("showing details for helm release", () => { }); it("when toggling again, calls for all configuration", () => { - callForHelmReleaseConfigurationMock.mockClear(); + requestHelmReleaseConfigurationMock.mockClear(); const toggle = rendered.getByTestId( "user-supplied-values-only-checkbox", @@ -455,7 +481,7 @@ describe("showing details for helm release", () => { fireEvent.click(toggle); - expect(callForHelmReleaseConfigurationMock).toHaveBeenCalledWith( + expect(requestHelmReleaseConfigurationMock).toHaveBeenCalledWith( "some-name", "some-namespace", true, @@ -477,20 +503,6 @@ describe("showing details for helm release", () => { expect(rendered.baseElement).toMatchSnapshot(); }); - it("calls for update", () => { - expect(callForHelmReleaseUpdateMock).toHaveBeenCalledWith( - "some-name", - "some-namespace", - - { - chart: "some-chart", - repo: "", - values: "some-new-configuration", - version: "", - }, - ); - }); - it("shows spinner", () => { const saveButton = rendered.getByTestId( "helm-release-configuration-save-button", @@ -499,78 +511,115 @@ describe("showing details for helm release", () => { expect(saveButton).toHaveClass("waiting"); }); - describe("when update resolves with success", () => { + describe("when requestHelmCharts resolves", () => { beforeEach(async () => { - callForHelmReleasesMock.mockClear(); - callForHelmReleaseConfigurationMock.mockClear(); - - await callForHelmReleaseUpdateMock.resolve({ - updateWasSuccessful: true, + await requestHelmChartsMock.resolve([HelmChart.create({ + apiVersion: "1.2.3", + version: "1.0.0", + created: "at-some-time", + name: "some-chart", + repo: "some-repo", + })]); + }); + describe("when requestHelmChartVersions resolves", () => { + beforeEach(async () => { + await requestHelmChartVersionsMock.resolve([HelmChart.create({ + apiVersion: "1.2.3", + version: "1.0.0", + created: "at-some-time", + name: "some-chart", + repo: "some-repo", + })]); }); - }); - it("renders", () => { - expect(rendered.baseElement).toMatchSnapshot(); - }); + it("calls for update", () => { + expect(requestHelmReleaseUpdateMock).toHaveBeenCalledWith( + "some-name", + "some-namespace", - it("does not show spinner anymore", () => { - const saveButton = rendered.getByTestId( - "helm-release-configuration-save-button", - ); - - expect(saveButton).not.toHaveClass("waiting"); - }); - - it("reloads the configuration", () => { - expect(callForHelmReleaseConfigurationMock).toHaveBeenCalledWith( - "some-name", - "some-namespace", - true, - ); - }); - - it("shows success notification", () => { - expect(showSuccessNotificationMock).toHaveBeenCalled(); - }); - - it("does not show error notification", () => { - expect(showCheckedErrorNotificationMock).not.toHaveBeenCalled(); - }); - }); - - describe("when update resolves with failure", () => { - beforeEach(async () => { - callForHelmReleasesMock.mockClear(); - callForHelmReleaseConfigurationMock.mockClear(); - - await callForHelmReleaseUpdateMock.resolve({ - updateWasSuccessful: false, - error: "some-error", + { + chart: "some-chart", + repo: "some-repo", + values: "some-new-configuration", + version: "1.0.0", + }, + ); }); - }); - it("renders", () => { - expect(rendered.baseElement).toMatchSnapshot(); - }); + describe("when update resolves with success", () => { + beforeEach(async () => { + requestHelmReleasesMock.mockClear(); + requestHelmReleaseConfigurationMock.mockClear(); - it("does not show spinner anymore", () => { - const saveButton = rendered.getByTestId( - "helm-release-configuration-save-button", - ); + await requestHelmReleaseUpdateMock.resolve({ + updateWasSuccessful: true, + }); + }); - expect(saveButton).not.toHaveClass("waiting"); - }); + it("renders", () => { + expect(rendered.baseElement).toMatchSnapshot(); + }); - it("does not reload the configuration", () => { - expect(callForHelmReleaseConfigurationMock).not.toHaveBeenCalled(); - }); + it("does not show spinner anymore", () => { + const saveButton = rendered.getByTestId( + "helm-release-configuration-save-button", + ); - it("does not show success notification", () => { - expect(showSuccessNotificationMock).not.toHaveBeenCalled(); - }); + expect(saveButton).not.toHaveClass("waiting"); + }); - it("shows error notification", () => { - expect(showCheckedErrorNotificationMock).toHaveBeenCalled(); + it("reloads the configuration", () => { + expect(requestHelmReleaseConfigurationMock).toHaveBeenCalledWith( + "some-name", + "some-namespace", + true, + ); + }); + + it("shows success notification", () => { + expect(showSuccessNotificationMock).toHaveBeenCalled(); + }); + + it("does not show error notification", () => { + expect(showCheckedErrorNotificationMock).not.toHaveBeenCalled(); + }); + }); + + describe("when update resolves with failure", () => { + beforeEach(async () => { + requestHelmReleasesMock.mockClear(); + requestHelmReleaseConfigurationMock.mockClear(); + + await requestHelmReleaseUpdateMock.resolve({ + updateWasSuccessful: false, + error: "some-error", + }); + }); + + it("renders", () => { + expect(rendered.baseElement).toMatchSnapshot(); + }); + + it("does not show spinner anymore", () => { + const saveButton = rendered.getByTestId( + "helm-release-configuration-save-button", + ); + + expect(saveButton).not.toHaveClass("waiting"); + }); + + it("does not reload the configuration", () => { + expect(requestHelmReleaseConfigurationMock).not.toHaveBeenCalled(); + }); + + it("does not show success notification", () => { + expect(showSuccessNotificationMock).not.toHaveBeenCalled(); + }); + + it("shows error notification", () => { + expect(showCheckedErrorNotificationMock).toHaveBeenCalled(); + }); + }); }); }); }); @@ -582,45 +631,3 @@ describe("showing details for helm release", () => { }); }); }); - -const detailedReleaseFake: DetailedHelmRelease = { - release: { - appVersion: "some-app-version", - chart: "some-chart", - status: "some-status", - updated: "some-updated", - revision: "some-revision", - name: "some-name", - namespace: "some-namespace", - }, - - details: { - name: "some-name", - namespace: "some-namespace", - version: "some-version", - config: "some-config", - manifest: "some-manifest", - - info: { - deleted: "some-deleted", - description: "some-description", - first_deployed: "some-first-deployed", - last_deployed: "some-last-deployed", - notes: "some-notes", - status: "some-status", - }, - - resources: [ - { - kind: "some-kind", - apiVersion: "some-api-version", - metadata: { - uid: "some-uid", - name: "some-resource", - namespace: "some-namespace", - creationTimestamp: "2015-10-22T07:28:00Z", - }, - }, - ], - }, -}; diff --git a/src/features/pod-logs/__snapshots__/download-logs.test.tsx.snap b/src/features/pod-logs/__snapshots__/download-logs.test.tsx.snap index 91c58b443b..442d92dbe9 100644 --- a/src/features/pod-logs/__snapshots__/download-logs.test.tsx.snap +++ b/src/features/pod-logs/__snapshots__/download-logs.test.tsx.snap @@ -430,6 +430,7 @@ exports[`download logs options in logs dock tab opening pod logs when logs avail > -
    +
    Close ⌘+W
    @@ -1280,6 +1283,7 @@ exports[`download logs options in logs dock tab opening pod logs when logs not a > -
    +
    Close ⌘+W
    diff --git a/src/features/preferences/__snapshots__/navigation-to-kubernetes-preferences.test.ts.snap b/src/features/preferences/__snapshots__/navigation-to-kubernetes-preferences.test.ts.snap index f450498468..98d08a56a7 100644 --- a/src/features/preferences/__snapshots__/navigation-to-kubernetes-preferences.test.ts.snap +++ b/src/features/preferences/__snapshots__/navigation-to-kubernetes-preferences.test.ts.snap @@ -909,7 +909,7 @@ exports[`preferences - navigation to kubernetes preferences given in preferences @@ -940,7 +940,7 @@ exports[`preferences - navigation to kubernetes preferences given in preferences > diff --git a/src/features/quitting-and-restarting-the-app/opening-application-window-using-tray.test.ts b/src/features/quitting-and-restarting-the-app/opening-application-window-using-tray.test.ts index 86f0a6b83a..b1769e80af 100644 --- a/src/features/quitting-and-restarting-the-app/opening-application-window-using-tray.test.ts +++ b/src/features/quitting-and-restarting-the-app/opening-application-window-using-tray.test.ts @@ -37,7 +37,7 @@ describe("opening application window using tray", () => { mainDi.override( lensResourcesDirInjectable, - () => "some-lens-resources-directory", + () => "/some-lens-resources-directory", ); const loadFileMock = jest @@ -119,7 +119,7 @@ describe("opening application window using tray", () => { }); it("starts loading static HTML of splash window", () => { - expect(callForSplashWindowHtmlMock).toHaveBeenCalledWith("/some-absolute-root-directory/some-lens-resources-directory/static/splash.html"); + expect(callForSplashWindowHtmlMock).toHaveBeenCalledWith("/some-lens-resources-directory/static/splash.html"); }); describe("when loading of splash window HTML resolves", () => { diff --git a/src/jest.setup.ts b/src/jest.setup.ts index eb1e801f72..41fa87389b 100644 --- a/src/jest.setup.ts +++ b/src/jest.setup.ts @@ -3,7 +3,6 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import fetchMock from "jest-fetch-mock"; import configurePackages from "./common/configure-packages"; import { configure } from "mobx"; import { setImmediate } from "timers"; @@ -20,9 +19,6 @@ configure({ safeDescriptors: false, }); -// rewire global.fetch to call 'fetchMock' -fetchMock.enableMocks(); - // Mock __non_webpack_require__ for tests globalThis.__non_webpack_require__ = jest.fn(); diff --git a/src/main/__test__/kubeconfig-manager.test.ts b/src/main/__test__/kubeconfig-manager.test.ts index 9cac0063ee..6a33093cb4 100644 --- a/src/main/__test__/kubeconfig-manager.test.ts +++ b/src/main/__test__/kubeconfig-manager.test.ts @@ -4,12 +4,7 @@ */ import { getDiForUnitTesting } from "../getDiForUnitTesting"; import { KubeconfigManager } from "../kubeconfig-manager/kubeconfig-manager"; -import mockFs from "mock-fs"; import type { Cluster } from "../../common/cluster/cluster"; -import fse from "fs-extra"; -import { loadYaml } from "@kubernetes/client-node"; -import { Console } from "console"; -import * as path from "path"; import createKubeconfigManagerInjectable from "../kubeconfig-manager/create-kubeconfig-manager.injectable"; import { createClusterInjectionToken } from "../../common/cluster/create-cluster-injection-token"; import directoryForTempInjectable from "../../common/app-paths/directory-for-temp/directory-for-temp.injectable"; @@ -18,31 +13,53 @@ import type { DiContainer } from "@ogre-tools/injectable"; import { parse } from "url"; import loggerInjectable from "../../common/logger.injectable"; import type { Logger } from "../../common/logger"; -import assert from "assert"; import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; import normalizedPlatformInjectable from "../../common/vars/normalized-platform.injectable"; import kubectlBinaryNameInjectable from "../kubectl/binary-name.injectable"; import kubectlDownloadingNormalizedArchInjectable from "../kubectl/normalized-arch.injectable"; - -console = new Console(process.stdout, process.stderr); // fix mockFS +import type { ReadFile } from "../../common/fs/read-file.injectable"; +import readFileInjectable from "../../common/fs/read-file.injectable"; +import type { AsyncFnMock } from "@async-fn/jest"; +import asyncFn from "@async-fn/jest"; +import type { WriteFile } from "../../common/fs/write-file.injectable"; +import writeFileInjectable from "../../common/fs/write-file.injectable"; +import type { PathExists } from "../../common/fs/path-exists.injectable"; +import pathExistsInjectable from "../../common/fs/path-exists.injectable"; +import type { DeleteFile } from "../../common/fs/delete-file.injectable"; +import deleteFileInjectable from "../../common/fs/delete-file.injectable"; const clusterServerUrl = "https://192.168.64.3:8443"; describe("kubeconfig manager tests", () => { let clusterFake: Cluster; - let createKubeconfigManager: (cluster: Cluster) => KubeconfigManager | undefined; + let createKubeconfigManager: (cluster: Cluster) => KubeconfigManager; let di: DiContainer; let loggerMock: jest.Mocked; + let readFileMock: AsyncFnMock; + let deleteFileMock: AsyncFnMock; + let writeFileMock: AsyncFnMock; + let pathExistsMock: AsyncFnMock; + let kubeConfManager: KubeconfigManager; + let ensureServerMock: AsyncFnMock<() => Promise>; beforeEach(async () => { di = getDiForUnitTesting({ doGeneralOverrides: true }); - di.override(directoryForTempInjectable, () => "some-directory-for-temp"); - di.override(directoryForUserDataInjectable, () => "some-directory-for-user-data"); + di.override(directoryForTempInjectable, () => "/some-directory-for-temp"); + di.override(directoryForUserDataInjectable, () => "/some-directory-for-user-data"); di.override(kubectlBinaryNameInjectable, () => "kubectl"); di.override(kubectlDownloadingNormalizedArchInjectable, () => "amd64"); di.override(normalizedPlatformInjectable, () => "darwin"); + readFileMock = asyncFn(); + di.override(readFileInjectable, () => readFileMock); + writeFileMock = asyncFn(); + di.override(writeFileInjectable, () => writeFileMock); + pathExistsMock = asyncFn(); + di.override(pathExistsInjectable, () => pathExistsMock); + deleteFileMock = asyncFn(); + di.override(deleteFileInjectable, () => deleteFileMock); + loggerMock = { warn: jest.fn(), debug: jest.fn(), @@ -53,29 +70,7 @@ describe("kubeconfig manager tests", () => { di.override(loggerInjectable, () => loggerMock); - mockFs({ - "minikube-config.yml": JSON.stringify({ - apiVersion: "v1", - clusters: [{ - name: "minikube", - cluster: { - server: clusterServerUrl, - }, - }], - contexts: [{ - context: { - cluster: "minikube", - user: "minikube", - }, - name: "minikube", - }], - users: [{ - name: "minikube", - }], - kind: "Config", - preferences: {}, - }), - }); + ensureServerMock = asyncFn(); di.override(createContextHandlerInjectable, () => (cluster) => ({ restartServer: jest.fn(), @@ -86,7 +81,7 @@ describe("kubeconfig manager tests", () => { resolveAuthProxyCa: jest.fn(), resolveAuthProxyUrl: jest.fn(), setupPrometheus: jest.fn(), - ensureServer: jest.fn(), + ensureServer: ensureServerMock, })); const createCluster = di.inject(createClusterInjectionToken); @@ -96,48 +91,222 @@ describe("kubeconfig manager tests", () => { clusterFake = createCluster({ id: "foo", contextName: "minikube", - kubeConfigPath: "minikube-config.yml", + kubeConfigPath: "/minikube-config.yml", }, { clusterServerUrl, }); jest.spyOn(KubeconfigManager.prototype, "resolveProxyUrl", "get").mockReturnValue("http://127.0.0.1:9191/foo"); + + kubeConfManager = createKubeconfigManager(clusterFake); }); - afterEach(() => { - mockFs.restore(); + describe("when calling clear", () => { + it("should resolve immediately", async () => { + await kubeConfManager.clear(); + }); + + it("being called several times shouldn't throw", async () => { + await kubeConfManager.clear(); + await kubeConfManager.clear(); + await kubeConfManager.clear(); + }); }); - it("should create 'temp' kube config with proxy", async () => { - const kubeConfManager = createKubeconfigManager(clusterFake); + describe("when getPath() is called initially", () => { + let getPathPromise: Promise; - assert(kubeConfManager, "should actually create one"); + beforeEach(async () => { + getPathPromise = kubeConfManager.getPath(); + }); - expect(loggerMock.error).not.toBeCalled(); - expect(await kubeConfManager.getPath()).toBe(`some-directory-for-temp${path.sep}kubeconfig-foo`); - // this causes an intermittent "ENXIO: no such device or address, read" error - // const file = await fse.readFile(await kubeConfManager.getPath()); - const file = fse.readFileSync(await kubeConfManager.getPath()); - const yml = loadYaml(file.toString()); + it("should not call pathExists()", () => { + expect(pathExistsMock).not.toBeCalled(); + }); - expect(yml["current-context"]).toBe("minikube"); - expect(yml["clusters"][0]["cluster"]["server"].endsWith("/foo")).toBe(true); - expect(yml["users"][0]["name"]).toBe("proxy"); - }); + it("should call ensureServer on the cluster context", () => { + expect(ensureServerMock).toBeCalledTimes(1); + }); - it("should remove 'temp' kube config on unlink and remove reference from inside class", async () => { - const kubeConfManager = createKubeconfigManager(clusterFake); + describe("when ensureServer resolves", () => { + beforeEach(async () => { + await ensureServerMock.resolve(); - assert(kubeConfManager, "should actually create one"); + // clear state of calls + ensureServerMock.mock.calls.length = 0; + }); - const configPath = await kubeConfManager.getPath(); + describe("when reading cluster's kubeconfig resolves", () => { + beforeEach(async () => { + await readFileMock.resolveSpecific( + ["/minikube-config.yml"], + JSON.stringify({ + apiVersion: "v1", + clusters: [{ + name: "minikube", + cluster: { + server: clusterServerUrl, + }, + }], + contexts: [{ + context: { + cluster: "minikube", + user: "minikube", + }, + name: "minikube", + }], + users: [{ + name: "minikube", + }], + kind: "Config", + preferences: {}, + }), + ); + }); - expect(await fse.pathExists(configPath)).toBe(true); - await kubeConfManager.clear(); - expect(await fse.pathExists(configPath)).toBe(false); - await kubeConfManager.clear(); // doesn't throw - expect(async () => { - await kubeConfManager.getPath(); - }).rejects.toThrow("already unlinked"); + describe("when writing out new proxy kubeconfig resolves", () => { + beforeEach(async () => { + await writeFileMock.resolveSpecific( + ["/some-directory-for-temp/kubeconfig-foo", "apiVersion: v1\nkind: Config\npreferences: {}\ncurrent-context: minikube\nclusters:\n - name: minikube\n cluster:\n server: http://127.0.0.1:9191/foo\ncontexts:\n - name: minikube\n context:\n cluster: minikube\n user: proxy\nusers:\n - name: proxy\n user: {}\n"], + ); + }); + + it("should allow getPath to resolve with the path to the kubeconfig", async () => { + expect(await getPathPromise).toBe("/some-directory-for-temp/kubeconfig-foo"); + }); + + describe("when calling clear", () => { + let clearPromise: Promise; + + beforeEach(() => { + clearPromise = kubeConfManager.clear(); + }); + + it("should call deleteFile", () => { + expect(deleteFileMock).toBeCalledTimes(1); + }); + + describe("when deleteFile resolves", () => { + beforeEach(async () => { + await deleteFileMock.resolveSpecific( + ["/some-directory-for-temp/kubeconfig-foo"], + ); + }); + + it("should allow clear to resolve", async () => { + await clearPromise; + }); + }); + + describe("when deleteFile rejects with ENOENT", () => { + beforeEach(async () => { + await deleteFileMock.resolveSpecific( + ["/some-directory-for-temp/kubeconfig-foo"], + Promise.reject(Object.assign(new Error("file not found"), { + code: "ENOENT", + })), + ); + }); + + it("should allow clear to resolve", async () => { + await clearPromise; + }); + }); + + it("when deleteFile rejects with some other error; clear should also reject", async () => { + const expectPromise = expect(clearPromise).rejects.toBeDefined(); + + await deleteFileMock.reject(new Error("some other error")); + await expectPromise; + }); + }); + + describe("when calling getPath a second time", () => { + let getPathPromise: Promise; + + beforeEach(async () => { + getPathPromise = kubeConfManager.getPath(); + }); + + it("should call pathExists", () => { + expect(pathExistsMock).toBeCalledTimes(1); + }); + + describe("when pathExists resoves to true", () => { + beforeEach(async () => { + await pathExistsMock.resolveSpecific( + ["/some-directory-for-temp/kubeconfig-foo"], + true, + ); + }); + + it("always getPath to resolve with path", async () => { + expect(await getPathPromise).toBe("/some-directory-for-temp/kubeconfig-foo"); + }); + }); + + describe("when pathExists resoves to false", () => { + beforeEach(async () => { + await pathExistsMock.resolveSpecific( + ["/some-directory-for-temp/kubeconfig-foo"], + false, + ); + }); + + it("should call ensureServer on the cluster context", () => { + expect(ensureServerMock).toBeCalledTimes(1); + }); + + describe("when ensureServer resolves", () => { + beforeEach(async () => { + await ensureServerMock.resolve(); + }); + + describe("when reading cluster's kubeconfig resolves", () => { + beforeEach(async () => { + await readFileMock.resolveSpecific( + ["/minikube-config.yml"], + JSON.stringify({ + apiVersion: "v1", + clusters: [{ + name: "minikube", + cluster: { + server: clusterServerUrl, + }, + }], + contexts: [{ + context: { + cluster: "minikube", + user: "minikube", + }, + name: "minikube", + }], + users: [{ + name: "minikube", + }], + kind: "Config", + preferences: {}, + }), + ); + }); + + describe("when writing out new proxy kubeconfig resolves", () => { + beforeEach(async () => { + await writeFileMock.resolveSpecific( + ["/some-directory-for-temp/kubeconfig-foo", "apiVersion: v1\nkind: Config\npreferences: {}\ncurrent-context: minikube\nclusters:\n - name: minikube\n cluster:\n server: http://127.0.0.1:9191/foo\ncontexts:\n - name: minikube\n context:\n cluster: minikube\n user: proxy\nusers:\n - name: proxy\n user: {}\n"], + ); + }); + + it("should allow getPath to resolve with the path to the kubeconfig", async () => { + expect(await getPathPromise).toBe("/some-directory-for-temp/kubeconfig-foo"); + }); + }); + }); + }); + }); + }); + }); + }); + }); }); }); diff --git a/src/main/app-paths/get-electron-app-path/get-electron-app-path.test.ts b/src/main/app-paths/get-electron-app-path/get-electron-app-path.test.ts index 8e28c806d7..ca30b690b9 100644 --- a/src/main/app-paths/get-electron-app-path/get-electron-app-path.test.ts +++ b/src/main/app-paths/get-electron-app-path/get-electron-app-path.test.ts @@ -6,8 +6,6 @@ import electronAppInjectable from "../../electron-app/electron-app.injectable"; import getElectronAppPathInjectable from "./get-electron-app-path.injectable"; import { getDiForUnitTesting } from "../../getDiForUnitTesting"; import type { App } from "electron"; -import joinPathsInjectable from "../../../common/path/join-paths.injectable"; -import { joinPathsFake } from "../../../common/test-utils/join-paths-fake"; describe("get-electron-app-path", () => { let getElectronAppPath: (name: string) => string; @@ -31,7 +29,6 @@ describe("get-electron-app-path", () => { } as App; di.override(electronAppInjectable, () => appStub); - di.override(joinPathsInjectable, () => joinPathsFake); getElectronAppPath = di.inject(getElectronAppPathInjectable) as (name: string) => string; }); diff --git a/src/main/create-cluster/create-cluster.injectable.ts b/src/main/create-cluster/create-cluster.injectable.ts index d8bf4209f0..5290e92db3 100644 --- a/src/main/create-cluster/create-cluster.injectable.ts +++ b/src/main/create-cluster/create-cluster.injectable.ts @@ -16,6 +16,7 @@ import loggerInjectable from "../../common/logger.injectable"; import detectorRegistryInjectable from "../cluster-detectors/detector-registry.injectable"; import createVersionDetectorInjectable from "../cluster-detectors/create-version-detector.injectable"; import broadcastMessageInjectable from "../../common/ipc/broadcast-message.injectable"; +import loadConfigfromFileInjectable from "../../common/kube-helpers/load-config-from-file.injectable"; const createClusterInjectable = getInjectable({ id: "create-cluster", @@ -32,6 +33,7 @@ const createClusterInjectable = getInjectable({ detectorRegistry: di.inject(detectorRegistryInjectable), createVersionDetector: di.inject(createVersionDetectorInjectable), broadcastMessage: di.inject(broadcastMessageInjectable), + loadConfigfromFile: di.inject(loadConfigfromFileInjectable), }; return (model, configData) => new Cluster(dependencies, model, configData); diff --git a/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.injectable.ts b/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.injectable.ts index c78514d631..dc71c1fd57 100644 --- a/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.injectable.ts +++ b/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.injectable.ts @@ -3,37 +3,27 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import directoryForLensLocalStorageInjectable from "../../../../common/directory-for-lens-local-storage/directory-for-lens-local-storage.injectable"; import { setupIpcMainHandlers } from "./setup-ipc-main-handlers"; import loggerInjectable from "../../../../common/logger.injectable"; import clusterManagerInjectable from "../../../cluster/manager.injectable"; import applicationMenuItemsInjectable from "../../../menu/application-menu-items.injectable"; -import getAbsolutePathInjectable from "../../../../common/path/get-absolute-path.injectable"; import clusterStoreInjectable from "../../../../common/cluster-store/cluster-store.injectable"; import { onLoadOfApplicationInjectionToken } from "../../../start-main-application/runnable-tokens/on-load-of-application-injection-token"; import operatingSystemThemeInjectable from "../../../theme/operating-system-theme.injectable"; import catalogEntityRegistryInjectable from "../../../catalog/entity-registry.injectable"; import askUserForFilePathsInjectable from "../../../ipc/ask-user-for-file-paths.injectable"; -import clustersThatAreBeingDeletedInjectable from "../../../cluster/are-being-deleted.injectable"; const setupIpcMainHandlersInjectable = getInjectable({ id: "setup-ipc-main-handlers", instantiate: (di) => { const logger = di.inject(loggerInjectable); - - const directoryForLensLocalStorage = di.inject( - directoryForLensLocalStorageInjectable, - ); - const clusterManager = di.inject(clusterManagerInjectable); const applicationMenuItems = di.inject(applicationMenuItemsInjectable); - const getAbsolutePath = di.inject(getAbsolutePathInjectable); const catalogEntityRegistry = di.inject(catalogEntityRegistryInjectable); const clusterStore = di.inject(clusterStoreInjectable); const operatingSystemTheme = di.inject(operatingSystemThemeInjectable); const askUserForFilePaths = di.inject(askUserForFilePathsInjectable); - const clustersThatAreBeingDeleted = di.inject(clustersThatAreBeingDeletedInjectable); return { id: "setup-ipc-main-handlers", @@ -42,14 +32,11 @@ const setupIpcMainHandlersInjectable = getInjectable({ setupIpcMainHandlers({ applicationMenuItems, - getAbsolutePath, - directoryForLensLocalStorage, clusterManager, catalogEntityRegistry, clusterStore, operatingSystemTheme, askUserForFilePaths, - clustersThatAreBeingDeleted, }); }, }; diff --git a/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.ts b/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.ts index 6f873cd2c3..8be12213fe 100644 --- a/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.ts +++ b/src/main/electron-app/runnables/setup-ipc-main-handlers/setup-ipc-main-handlers.ts @@ -5,7 +5,7 @@ import type { IpcMainInvokeEvent } from "electron"; import { BrowserWindow, Menu } from "electron"; import { clusterFrameMap } from "../../../../common/cluster-frames"; -import { clusterActivateHandler, clusterSetFrameIdHandler, clusterVisibilityHandler, clusterRefreshHandler, clusterDisconnectHandler, clusterKubectlApplyAllHandler, clusterKubectlDeleteAllHandler, clusterDeleteHandler, clusterSetDeletingHandler, clusterClearDeletingHandler } from "../../../../common/ipc/cluster"; +import { clusterActivateHandler, clusterSetFrameIdHandler, clusterVisibilityHandler, clusterRefreshHandler, clusterDisconnectHandler, clusterKubectlApplyAllHandler, clusterKubectlDeleteAllHandler } from "../../../../common/ipc/cluster"; import type { ClusterId } from "../../../../common/cluster-types"; import { ClusterStore } from "../../../../common/cluster-store/cluster-store"; import { appEventBus } from "../../../../common/app-event-bus/event-bus"; @@ -14,9 +14,7 @@ import type { CatalogEntityRegistry } from "../../../catalog"; import { pushCatalogToRenderer } from "../../../catalog-pusher"; import type { ClusterManager } from "../../../cluster/manager"; import { ResourceApplier } from "../../../resource-applier"; -import { remove } from "fs-extra"; -import type { IComputedValue, ObservableSet } from "mobx"; -import type { GetAbsolutePath } from "../../../../common/path/get-absolute-path.injectable"; +import type { IComputedValue } from "mobx"; import type { MenuItemOpts } from "../../../menu/application-menu-items.injectable"; import { windowActionHandleChannel, windowLocationChangedChannel, windowOpenAppMenuAsContextMenuChannel } from "../../../../common/ipc/window"; import { handleWindowAction, onLocationChange } from "../../../ipc/window"; @@ -26,27 +24,21 @@ import type { Theme } from "../../../theme/operating-system-theme-state.injectab import type { AskUserForFilePaths } from "../../../ipc/ask-user-for-file-paths.injectable"; interface Dependencies { - directoryForLensLocalStorage: string; - getAbsolutePath: GetAbsolutePath; applicationMenuItems: IComputedValue; clusterManager: ClusterManager; catalogEntityRegistry: CatalogEntityRegistry; clusterStore: ClusterStore; operatingSystemTheme: IComputedValue; askUserForFilePaths: AskUserForFilePaths; - clustersThatAreBeingDeleted: ObservableSet; } export const setupIpcMainHandlers = ({ applicationMenuItems, - directoryForLensLocalStorage, - getAbsolutePath, clusterManager, catalogEntityRegistry, clusterStore, operatingSystemTheme, askUserForFilePaths, - clustersThatAreBeingDeleted, }: Dependencies) => { ipcMainHandle(clusterActivateHandler, (event, clusterId: ClusterId, force = false) => { return ClusterStore.getInstance() @@ -85,40 +77,6 @@ export const setupIpcMainHandlers = ({ } }); - ipcMainHandle(clusterDeleteHandler, async (event, clusterId: ClusterId) => { - appEventBus.emit({ name: "cluster", action: "remove" }); - - const clusterStore = ClusterStore.getInstance(); - const cluster = clusterStore.getById(clusterId); - - if (!cluster) { - return; - } - - cluster.disconnect(); - clusterFrameMap.delete(cluster.id); - - // Remove from the cluster store as well, this should clear any old settings - clusterStore.clusters.delete(cluster.id); - - try { - // remove the local storage file - const localStorageFilePath = getAbsolutePath(directoryForLensLocalStorage, `${cluster.id}.json`); - - await remove(localStorageFilePath); - } catch { - // ignore error - } - }); - - ipcMainHandle(clusterSetDeletingHandler, (event, clusterId: string) => { - clustersThatAreBeingDeleted.add(clusterId); - }); - - ipcMainHandle(clusterClearDeletingHandler, (event, clusterId: string) => { - clustersThatAreBeingDeleted.delete(clusterId); - }); - ipcMainHandle(clusterKubectlApplyAllHandler, async (event, clusterId: ClusterId, resources: string[], extraArgs: string[]) => { appEventBus.emit({ name: "cluster", action: "kubectl-apply-all" }); const cluster = ClusterStore.getInstance().getById(clusterId); diff --git a/src/main/get-metrics.injectable.ts b/src/main/get-metrics.injectable.ts index 4d6634909c..0ceaf01735 100644 --- a/src/main/get-metrics.injectable.ts +++ b/src/main/get-metrics.injectable.ts @@ -4,10 +4,10 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import type { Cluster } from "../common/cluster/cluster"; -import type { IMetricsReqParams } from "../common/k8s-api/endpoints/metrics.api"; +import type { RequestMetricsParams } from "../common/k8s-api/endpoints/metrics.api/request-metrics.injectable"; import k8sRequestInjectable from "./k8s-request.injectable"; -export type GetMetrics = (cluster: Cluster, prometheusPath: string, queryParams: IMetricsReqParams & { query: string }) => Promise; +export type GetMetrics = (cluster: Cluster, prometheusPath: string, queryParams: RequestMetricsParams & { query: string }) => Promise; const getMetricsInjectable = getInjectable({ id: "get-metrics", diff --git a/src/main/getDiForUnitTesting.ts b/src/main/getDiForUnitTesting.ts index bbda6d5838..10185938c8 100644 --- a/src/main/getDiForUnitTesting.ts +++ b/src/main/getDiForUnitTesting.ts @@ -18,10 +18,6 @@ import fileSystemProvisionerStoreInjectable from "../extensions/extension-loader import type { FileSystemProvisionerStore } from "../extensions/extension-loader/file-system-provisioner-store/file-system-provisioner-store"; import userStoreInjectable from "../common/user-store/user-store.injectable"; import type { UserStore } from "../common/user-store"; -import getAbsolutePathInjectable from "../common/path/get-absolute-path.injectable"; -import { getAbsolutePathFake } from "../common/test-utils/get-absolute-path-fake"; -import joinPathsInjectable from "../common/path/join-paths.injectable"; -import { joinPathsFake } from "../common/test-utils/join-paths-fake"; import hotbarStoreInjectable from "../common/hotbars/store.injectable"; import appEventBusInjectable from "../common/app-event-bus/app-event-bus.injectable"; import { EventEmitter } from "../common/event-emitter"; @@ -74,7 +70,7 @@ import getRandomIdInjectable from "../common/utils/get-random-id.injectable"; import periodicalCheckForUpdatesInjectable from "./application-update/periodical-check-for-updates/periodical-check-for-updates.injectable"; import execFileInjectable from "../common/fs/exec-file.injectable"; import normalizedPlatformArchitectureInjectable from "../common/vars/normalized-platform-architecture.injectable"; -import getHelmChartInjectable from "./helm/helm-service/get-helm-chart.injectable"; +import getHelmChartVersionsInjectable from "./helm/helm-service/get-helm-chart-versions.injectable"; import getHelmChartValuesInjectable from "./helm/helm-service/get-helm-chart-values.injectable"; import listHelmChartsInjectable from "./helm/helm-service/list-helm-charts.injectable"; import deleteHelmReleaseInjectable from "./helm/helm-service/delete-helm-release.injectable"; @@ -161,7 +157,7 @@ export function getDiForUnitTesting(opts: { doGeneralOverrides?: boolean } = {}) di.override(periodicalCheckForUpdatesInjectable, () => ({ start: () => {}, stop: () => {}, started: false })); overrideFunctionalInjectables(di, [ - getHelmChartInjectable, + getHelmChartVersionsInjectable, getHelmChartValuesInjectable, listHelmChartsInjectable, deleteHelmReleaseInjectable, @@ -228,8 +224,6 @@ const overrideRunnablesHavingSideEffects = (di: DiContainer) => { const overrideOperatingSystem = (di: DiContainer) => { di.override(platformInjectable, () => "darwin"); - di.override(getAbsolutePathInjectable, () => getAbsolutePathFake); - di.override(joinPathsInjectable, () => joinPathsFake); di.override(normalizedPlatformArchitectureInjectable, () => "arm64"); }; @@ -267,7 +261,7 @@ const overrideElectronFeatures = (di: DiContainer) => { di.override( getElectronAppPathInjectable, - () => (name: string) => `some-electron-app-path-for-${kebabCase(name)}`, + () => (name: string) => `/some-electron-app-path-for-${kebabCase(name)}`, ); di.override(setElectronAppPathInjectable, () => () => {}); diff --git a/src/main/helm/__tests__/helm-service.test.ts b/src/main/helm/__tests__/helm-service.test.ts index ea0a28b1e9..982a361f30 100644 --- a/src/main/helm/__tests__/helm-service.test.ts +++ b/src/main/helm/__tests__/helm-service.test.ts @@ -8,7 +8,7 @@ import listHelmChartsInjectable from "../helm-service/list-helm-charts.injectabl import getActiveHelmRepositoriesInjectable from "../repositories/get-active-helm-repositories/get-active-helm-repositories.injectable"; import type { AsyncResult } from "../../../common/utils/async-result"; import type { HelmRepo } from "../../../common/helm/helm-repo"; -import { sortCharts } from "../../../common/utils"; +import { sortBySemverVersion } from "../../../common/utils"; import helmChartManagerInjectable from "../helm-chart-manager.injectable"; describe("Helm Service tests", () => { @@ -203,7 +203,7 @@ describe("Helm Service tests", () => { const charts = new Map([ ["stable", { - "invalid-semver": sortCharts([ + "invalid-semver": sortBySemverVersion([ { apiVersion: "3.0.0", name: "weird-versioning", @@ -237,7 +237,7 @@ const charts = new Map([ created: "now", }, ]), - "apm-server": sortCharts([ + "apm-server": sortBySemverVersion([ { apiVersion: "3.0.0", name: "apm-server", @@ -255,7 +255,7 @@ const charts = new Map([ created: "now", }, ]), - "redis": sortCharts([ + "redis": sortBySemverVersion([ { apiVersion: "3.0.0", name: "apm-server", @@ -275,7 +275,7 @@ const charts = new Map([ ]), }], ["experiment", { - "fairwind": sortCharts([ + "fairwind": sortBySemverVersion([ { apiVersion: "3.0.0", name: "fairwind", @@ -296,7 +296,7 @@ const charts = new Map([ ]), }], ["bitnami", { - "hotdog": sortCharts([ + "hotdog": sortBySemverVersion([ { apiVersion: "3.0.0", name: "hotdog", @@ -314,7 +314,7 @@ const charts = new Map([ created: "now", }, ]), - "pretzel": sortCharts([ + "pretzel": sortBySemverVersion([ { apiVersion: "3.0.0", name: "pretzel", diff --git a/src/main/helm/helm-binary-path.injectable.ts b/src/main/helm/helm-binary-path.injectable.ts index d5983572c7..6d8c661547 100644 --- a/src/main/helm/helm-binary-path.injectable.ts +++ b/src/main/helm/helm-binary-path.injectable.ts @@ -4,21 +4,21 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import { getBinaryName } from "../../common/vars"; -import getAbsolutePathInjectable from "../../common/path/get-absolute-path.injectable"; import normalizedPlatformInjectable from "../../common/vars/normalized-platform.injectable"; import baseBundledBinariesDirectoryInjectable from "../../common/vars/base-bundled-binaries-dir.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; const helmBinaryPathInjectable = getInjectable({ id: "helm-binary-path", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const normalizedPlatform = di.inject(normalizedPlatformInjectable); const baseBundledBinariesDirectory = di.inject(baseBundledBinariesDirectoryInjectable); const helmBinaryName = getBinaryName("helm", { forPlatform: normalizedPlatform }); - return getAbsolutePath(baseBundledBinariesDirectory, helmBinaryName); + return joinPaths(baseBundledBinariesDirectory, helmBinaryName); }, }); diff --git a/src/main/helm/helm-chart-manager.ts b/src/main/helm/helm-chart-manager.ts index 2eae449aea..dfc80a78e4 100644 --- a/src/main/helm/helm-chart-manager.ts +++ b/src/main/helm/helm-chart-manager.ts @@ -5,14 +5,14 @@ import fs from "fs"; import * as yaml from "js-yaml"; -import type { RepoHelmChartList } from "../../common/k8s-api/endpoints/helm-charts.api"; -import { iter, put, sortCharts } from "../../common/utils"; +import { iter, put, sortBySemverVersion } from "../../common/utils"; import { execHelm } from "./exec"; import type { SetRequired } from "type-fest"; import { assert } from "console"; import type { HelmRepo } from "../../common/helm/helm-repo"; import type { HelmChartManagerCache } from "./helm-chart-manager-cache.injectable"; import type { Logger } from "../../common/logger"; +import type { RepoHelmChartList } from "../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; export interface HelmCacheFile { apiVersion: string; @@ -118,7 +118,7 @@ function normalizeHelmCharts(repoName: string, entries: RepoHelmChartList): Repo Object.entries(entries), ([name, charts]) => [ name, - sortCharts( + sortBySemverVersion( charts.map(chart => ({ ...chart, created: Date.parse(chart.created).toString(), diff --git a/src/main/helm/helm-service/get-helm-chart-readme.global-override-for-injectable.ts b/src/main/helm/helm-service/get-helm-chart-readme.global-override-for-injectable.ts new file mode 100644 index 0000000000..6d2c016251 --- /dev/null +++ b/src/main/helm/helm-service/get-helm-chart-readme.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../../../common/test-utils/get-global-override"; +import getHelmChartReadmeInjectable from "./get-helm-chart-readme.injectable"; + +export default getGlobalOverride(getHelmChartReadmeInjectable, () => () => { + throw new Error("tried to get a helm chart's readme without overriding"); +}); diff --git a/src/main/helm/helm-service/get-helm-chart.injectable.ts b/src/main/helm/helm-service/get-helm-chart-readme.injectable.ts similarity index 73% rename from src/main/helm/helm-service/get-helm-chart.injectable.ts rename to src/main/helm/helm-service/get-helm-chart-readme.injectable.ts index bd9615a3c4..ff5aa2fd0a 100644 --- a/src/main/helm/helm-service/get-helm-chart.injectable.ts +++ b/src/main/helm/helm-service/get-helm-chart-readme.injectable.ts @@ -7,8 +7,8 @@ import getActiveHelmRepositoryInjectable from "../repositories/get-active-helm-r import type { HelmRepo } from "../../../common/helm/helm-repo"; import helmChartManagerInjectable from "../helm-chart-manager.injectable"; -const getHelmChartInjectable = getInjectable({ - id: "get-helm-chart", +const getHelmChartReadmeInjectable = getInjectable({ + id: "get-helm-chart-readme", instantiate: (di) => { const getActiveHelmRepository = di.inject(getActiveHelmRepositoryInjectable); @@ -21,16 +21,11 @@ const getHelmChartInjectable = getInjectable({ return undefined; } - const chartManager = getChartManager(repo); - - return { - readme: await chartManager.getReadme(chartName, version), - versions: await chartManager.chartVersions(chartName), - }; + return getChartManager(repo).getReadme(chartName, version); }; }, causesSideEffects: true, }); -export default getHelmChartInjectable; +export default getHelmChartReadmeInjectable; diff --git a/src/main/helm/helm-service/get-helm-chart-versions.injectable.ts b/src/main/helm/helm-service/get-helm-chart-versions.injectable.ts new file mode 100644 index 0000000000..8c55ea7921 --- /dev/null +++ b/src/main/helm/helm-service/get-helm-chart-versions.injectable.ts @@ -0,0 +1,31 @@ +/** + * 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 type { HelmRepo } from "../../../common/helm/helm-repo"; +import helmChartManagerInjectable from "../helm-chart-manager.injectable"; +import getActiveHelmRepositoryInjectable from "../repositories/get-active-helm-repository.injectable"; + +const getHelmChartVersionsInjectable = getInjectable({ + id: "get-helm-chart-versions", + + instantiate: (di) => { + const getActiveHelmRepository = di.inject(getActiveHelmRepositoryInjectable); + const getChartManager = (repo: HelmRepo) => di.inject(helmChartManagerInjectable, repo); + + return async (repoName: string, chartName: string) => { + const repo = await getActiveHelmRepository(repoName); + + if (!repo) { + return undefined; + } + + return getChartManager(repo).chartVersions(chartName); + }; + }, + + causesSideEffects: true, +}); + +export default getHelmChartVersionsInjectable; diff --git a/src/main/k8s/api-base.injectable.ts b/src/main/k8s/api-base.injectable.ts new file mode 100644 index 0000000000..07a9424993 --- /dev/null +++ b/src/main/k8s/api-base.injectable.ts @@ -0,0 +1,33 @@ +/** + * 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 createJsonApiInjectable from "../../common/k8s-api/create-json-api.injectable"; +import { apiPrefix } from "../../common/vars"; +import isDebuggingInjectable from "../../common/vars/is-debugging.injectable"; +import isDevelopmentInjectable from "../../common/vars/is-development.injectable"; +import lensProxyPortInjectable from "../lens-proxy/lens-proxy-port.injectable"; + +const apiBaseInjectable = getInjectable({ + id: "api-base", + instantiate: (di) => { + const proxyPort = di.inject(lensProxyPortInjectable); + const createJsonApi = di.inject(createJsonApiInjectable); + const isDebugging = di.inject(isDebuggingInjectable); + + return createJsonApi({ + serverAddress: `http://127.0.0.1:${proxyPort.get()}`, + apiBase: apiPrefix, + debug: di.inject(isDevelopmentInjectable) || isDebugging, + }, { + headers: { + "Host": `localhost:${proxyPort.get()}`, + }, + }); + }, + injectionToken: apiBaseInjectionToken, +}); + +export default apiBaseInjectable; diff --git a/src/main/kube-auth-proxy/create-kube-auth-proxy.injectable.ts b/src/main/kube-auth-proxy/create-kube-auth-proxy.injectable.ts index 67cfd8c26e..f272d9e56f 100644 --- a/src/main/kube-auth-proxy/create-kube-auth-proxy.injectable.ts +++ b/src/main/kube-auth-proxy/create-kube-auth-proxy.injectable.ts @@ -6,7 +6,6 @@ import { getInjectable } from "@ogre-tools/injectable"; import type { KubeAuthProxyDependencies } from "./kube-auth-proxy"; import { KubeAuthProxy } from "./kube-auth-proxy"; import type { Cluster } from "../../common/cluster/cluster"; -import path from "path"; import selfsigned from "selfsigned"; import { getBinaryName } from "../../common/vars"; import spawnInjectable from "../child-process/spawn.injectable"; @@ -14,6 +13,7 @@ import { getKubeAuthProxyCertificate } from "./get-kube-auth-proxy-certificate"; import loggerInjectable from "../../common/logger.injectable"; import baseBundledBinariesDirectoryInjectable from "../../common/vars/base-bundled-binaries-dir.injectable"; import waitUntilPortIsUsedInjectable from "./wait-until-port-is-used/wait-until-port-is-used.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; export type CreateKubeAuthProxy = (cluster: Cluster, environmentVariables: NodeJS.ProcessEnv) => KubeAuthProxy; @@ -22,11 +22,12 @@ const createKubeAuthProxyInjectable = getInjectable({ instantiate: (di): CreateKubeAuthProxy => { const binaryName = getBinaryName("lens-k8s-proxy"); + const joinPaths = di.inject(joinPathsInjectable); return (cluster: Cluster, environmentVariables: NodeJS.ProcessEnv) => { const clusterUrl = new URL(cluster.apiUrl); const dependencies: KubeAuthProxyDependencies = { - proxyBinPath: path.join(di.inject(baseBundledBinariesDirectoryInjectable), binaryName), + proxyBinPath: joinPaths(di.inject(baseBundledBinariesDirectoryInjectable), binaryName), proxyCert: getKubeAuthProxyCertificate(clusterUrl.hostname, selfsigned.generate), spawn: di.inject(spawnInjectable), logger: di.inject(loggerInjectable), diff --git a/src/main/kubeconfig-manager/create-kubeconfig-manager.injectable.ts b/src/main/kubeconfig-manager/create-kubeconfig-manager.injectable.ts index e1f365f098..ed75943398 100644 --- a/src/main/kubeconfig-manager/create-kubeconfig-manager.injectable.ts +++ b/src/main/kubeconfig-manager/create-kubeconfig-manager.injectable.ts @@ -9,6 +9,11 @@ import type { KubeconfigManagerDependencies } from "./kubeconfig-manager"; import { KubeconfigManager } from "./kubeconfig-manager"; import loggerInjectable from "../../common/logger.injectable"; import lensProxyPortInjectable from "../lens-proxy/lens-proxy-port.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; +import getDirnameOfPathInjectable from "../../common/path/get-dirname.injectable"; +import deleteFileInjectable from "../../common/fs/delete-file.injectable"; +import pathExistsInjectable from "../../common/fs/path-exists.injectable"; +import writeFileInjectable from "../../common/fs/write-file.injectable"; export interface KubeConfigManagerInstantiationParameter { cluster: Cluster; @@ -24,6 +29,11 @@ const createKubeconfigManagerInjectable = getInjectable({ directoryForTemp: di.inject(directoryForTempInjectable), logger: di.inject(loggerInjectable), lensProxyPort: di.inject(lensProxyPortInjectable), + joinPaths: di.inject(joinPathsInjectable), + getDirnameOfPath: di.inject(getDirnameOfPathInjectable), + deleteFile: di.inject(deleteFileInjectable), + pathExists: di.inject(pathExistsInjectable), + writeFile: di.inject(writeFileInjectable), }; return (cluster) => new KubeconfigManager(dependencies, cluster); diff --git a/src/main/kubeconfig-manager/kubeconfig-manager.ts b/src/main/kubeconfig-manager/kubeconfig-manager.ts index d7a9794a0f..a51599169e 100644 --- a/src/main/kubeconfig-manager/kubeconfig-manager.ts +++ b/src/main/kubeconfig-manager/kubeconfig-manager.ts @@ -6,17 +6,25 @@ import type { KubeConfig } from "@kubernetes/client-node"; import type { Cluster } from "../../common/cluster/cluster"; import type { ClusterContextHandler } from "../context-handler/context-handler"; -import path from "path"; -import fs from "fs-extra"; import { dumpConfigYaml } from "../../common/kube-helpers"; import { isErrnoException } from "../../common/utils"; import type { PartialDeep } from "type-fest"; import type { Logger } from "../../common/logger"; +import type { JoinPaths } from "../../common/path/join-paths.injectable"; +import type { GetDirnameOfPath } from "../../common/path/get-dirname.injectable"; +import type { PathExists } from "../../common/fs/path-exists.injectable"; +import type { DeleteFile } from "../../common/fs/delete-file.injectable"; +import type { WriteFile } from "../../common/fs/write-file.injectable"; export interface KubeconfigManagerDependencies { readonly directoryForTemp: string; readonly logger: Logger; - lensProxyPort: { get: () => number }; + readonly lensProxyPort: { get: () => number }; + joinPaths: JoinPaths; + getDirnameOfPath: GetDirnameOfPath; + pathExists: PathExists; + deleteFile: DeleteFile; + writeFile: WriteFile; } export class KubeconfigManager { @@ -24,10 +32,9 @@ export class KubeconfigManager { * The path to the temp config file * * - if `string` then path - * - if `null` then not yet created - * - if `undefined` then unlinked by calling `clear()` + * - if `null` then not yet created or was cleared */ - protected tempFilePath: string | null | undefined = null; + protected tempFilePath: string | null = null; protected readonly contextHandler: ClusterContextHandler; @@ -40,11 +47,7 @@ export class KubeconfigManager { * @returns The path to the temporary kubeconfig */ async getPath(): Promise { - if (this.tempFilePath === undefined) { - throw new Error("kubeconfig is already unlinked"); - } - - if (this.tempFilePath === null || !(await fs.pathExists(this.tempFilePath))) { + if (this.tempFilePath === null || !(await this.dependencies.pathExists(this.tempFilePath))) { return await this.ensureFile(); } @@ -62,13 +65,13 @@ export class KubeconfigManager { this.dependencies.logger.info(`[KUBECONFIG-MANAGER]: Deleting temporary kubeconfig: ${this.tempFilePath}`); try { - await fs.unlink(this.tempFilePath); + await this.dependencies.deleteFile(this.tempFilePath); } catch (error) { if (isErrnoException(error) && error.code !== "ENOENT") { throw error; } } finally { - this.tempFilePath = undefined; + this.tempFilePath = null; } } @@ -78,7 +81,7 @@ export class KubeconfigManager { return this.tempFilePath = await this.createProxyKubeconfig(); } catch (error) { - throw Object.assign(new Error("Failed to creat temp config for auth-proxy"), { cause: error }); + throw new Error(`Failed to creat temp config for auth-proxy: ${error}`); } } @@ -93,7 +96,7 @@ export class KubeconfigManager { protected async createProxyKubeconfig(): Promise { const { cluster } = this; const { contextName, id } = cluster; - const tempFile = path.join( + const tempFile = this.dependencies.joinPaths( this.dependencies.directoryForTemp, `kubeconfig-${id}`, ); @@ -121,8 +124,7 @@ export class KubeconfigManager { // write const configYaml = dumpConfigYaml(proxyConfig); - await fs.ensureDir(path.dirname(tempFile)); - await fs.writeFile(tempFile, configYaml, { mode: 0o600 }); + await this.dependencies.writeFile(tempFile, configYaml, { mode: 0o600 }); this.dependencies.logger.debug(`[KUBECONFIG-MANAGER]: Created temp kubeconfig "${contextName}" at "${tempFile}": \n${configYaml}`); return tempFile; diff --git a/src/main/kubectl/bundled-binary-path.injectable.ts b/src/main/kubectl/bundled-binary-path.injectable.ts index df5ee63c04..f3321f7776 100644 --- a/src/main/kubectl/bundled-binary-path.injectable.ts +++ b/src/main/kubectl/bundled-binary-path.injectable.ts @@ -3,16 +3,20 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import path from "path"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; import baseBundledBinariesDirectoryInjectable from "../../common/vars/base-bundled-binaries-dir.injectable"; import kubectlBinaryNameInjectable from "./binary-name.injectable"; const bundledKubectlBinaryPathInjectable = getInjectable({ id: "bundled-kubectl-binary-path", - instantiate: (di) => path.join( - di.inject(baseBundledBinariesDirectoryInjectable), - di.inject(kubectlBinaryNameInjectable), - ), + instantiate: (di) => { + const joinPaths = di.inject(joinPathsInjectable); + + return joinPaths( + di.inject(baseBundledBinariesDirectoryInjectable), + di.inject(kubectlBinaryNameInjectable), + ); + }, }); export default bundledKubectlBinaryPathInjectable; diff --git a/src/main/kubectl/create-kubectl.injectable.ts b/src/main/kubectl/create-kubectl.injectable.ts index d0187f7ba4..f5a278ab7b 100644 --- a/src/main/kubectl/create-kubectl.injectable.ts +++ b/src/main/kubectl/create-kubectl.injectable.ts @@ -14,6 +14,9 @@ import bundledKubectlBinaryPathInjectable from "./bundled-binary-path.injectable import baseBundledBinariesDirectoryInjectable from "../../common/vars/base-bundled-binaries-dir.injectable"; import bundledKubectlVersionInjectable from "../../common/vars/bundled-kubectl-version.injectable"; import kubectlVersionMapInjectable from "./version-map.injectable"; +import getDirnameOfPathInjectable from "../../common/path/get-dirname.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; +import getBasenameOfPathInjectable from "../../common/path/get-basename.injectable"; const createKubectlInjectable = getInjectable({ id: "create-kubectl", @@ -29,6 +32,9 @@ const createKubectlInjectable = getInjectable({ baseBundeledBinariesDirectory: di.inject(baseBundledBinariesDirectoryInjectable), bundledKubectlVersion: di.inject(bundledKubectlVersionInjectable), kubectlVersionMap: di.inject(kubectlVersionMapInjectable), + getDirnameOfPath: di.inject(getDirnameOfPathInjectable), + joinPaths: di.inject(joinPathsInjectable), + getBasenameOfPath: di.inject(getBasenameOfPathInjectable), }; return (clusterVersion: string) => new Kubectl(dependencies, clusterVersion); diff --git a/src/main/kubectl/kubectl.ts b/src/main/kubectl/kubectl.ts index 2c99beec22..b77dbba97d 100644 --- a/src/main/kubectl/kubectl.ts +++ b/src/main/kubectl/kubectl.ts @@ -3,7 +3,6 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import path from "path"; import fs from "fs"; import { promiseExecFile } from "../../common/utils/promise-exec"; import logger from "../logger"; @@ -15,6 +14,9 @@ import got from "got/dist/source"; import { promisify } from "util"; import stream from "stream"; import { noop } from "lodash/fp"; +import type { JoinPaths } from "../../common/path/join-paths.injectable"; +import type { GetDirnameOfPath } from "../../common/path/get-dirname.injectable"; +import type { GetBasenameOfPath } from "../../common/path/get-basename.injectable"; const initScriptVersionString = "# lens-initscript v3"; @@ -33,6 +35,9 @@ export interface KubectlDependencies { }; readonly bundledKubectlVersion: string; readonly kubectlVersionMap: Map; + joinPaths: JoinPaths; + getDirnameOfPath: GetDirnameOfPath; + getBasenameOfPath: GetBasenameOfPath; } export class Kubectl { @@ -71,8 +76,8 @@ export class Kubectl { } this.url = `${this.getDownloadMirror()}/v${this.kubectlVersion}/bin/${this.dependencies.normalizedDownloadPlatform}/${this.dependencies.normalizedDownloadArch}/${this.dependencies.kubectlBinaryName}`; - this.dirname = path.normalize(path.join(this.getDownloadDir(), this.kubectlVersion)); - this.path = path.join(this.dirname, this.dependencies.kubectlBinaryName); + this.dirname = this.dependencies.joinPaths(this.getDownloadDir(), this.kubectlVersion); + this.path = this.dependencies.joinPaths(this.dirname, this.dependencies.kubectlBinaryName); } public getBundledPath() { @@ -85,7 +90,7 @@ export class Kubectl { protected getDownloadDir() { if (this.dependencies.userStore.downloadBinariesPath) { - return path.join(this.dependencies.userStore.downloadBinariesPath, "kubectl"); + return this.dependencies.joinPaths(this.dependencies.userStore.downloadBinariesPath, "kubectl"); } return this.dependencies.directoryForKubectlBinaries; @@ -104,7 +109,7 @@ export class Kubectl { if (!await this.checkBinary(this.getBundledPath(), false)) { Kubectl.invalidBundle = true; - return path.basename(this.getBundledPath()); + return this.dependencies.getBasenameOfPath(this.getBundledPath()); } try { @@ -246,7 +251,7 @@ export class Kubectl { } public async downloadKubectl() { - await ensureDir(path.dirname(this.path), 0o755); + await ensureDir(this.dependencies.getDirnameOfPath(this.path), 0o755); logger.info(`Downloading kubectl ${this.kubectlVersion} from ${this.url} to ${this.path}`); @@ -268,9 +273,9 @@ export class Kubectl { const binariesDir = this.dependencies.baseBundeledBinariesDirectory; const kubectlPath = this.dependencies.userStore.downloadKubectlBinaries ? this.dirname - : path.dirname(this.getPathFromPreferences()); + : this.dependencies.getDirnameOfPath(this.getPathFromPreferences()); - const bashScriptPath = path.join(this.dirname, ".bash_set_path"); + const bashScriptPath = this.dependencies.joinPaths(this.dirname, ".bash_set_path"); const bashScript = [ initScriptVersionString, "tempkubeconfig=\"$KUBECONFIG\"", @@ -292,7 +297,7 @@ export class Kubectl { "unset tempkubeconfig", ].join("\n"); - const zshScriptPath = path.join(this.dirname, ".zlogin"); + const zshScriptPath = this.dependencies.joinPaths(this.dirname, ".zlogin"); const zshScript = [ initScriptVersionString, "tempkubeconfig=\"$KUBECONFIG\"", diff --git a/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.injectable.ts b/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.injectable.ts index a9dc0c6747..550a8d2560 100644 --- a/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.injectable.ts +++ b/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.injectable.ts @@ -4,15 +4,15 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import { shellApiRequest } from "./shell-api-request"; -import createShellSessionInjectable from "../../../shell-session/create-shell-session.injectable"; import shellRequestAuthenticatorInjectable from "./shell-request-authenticator/shell-request-authenticator.injectable"; import clusterManagerInjectable from "../../../cluster/manager.injectable"; +import openShellSessionInjectable from "../../../shell-session/create-shell-session.injectable"; const shellApiRequestInjectable = getInjectable({ id: "shell-api-request", instantiate: (di) => shellApiRequest({ - createShellSession: di.inject(createShellSessionInjectable), + openShellSession: di.inject(openShellSessionInjectable), authenticateRequest: di.inject(shellRequestAuthenticatorInjectable).authenticate, clusterManager: di.inject(clusterManagerInjectable), }), diff --git a/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.ts b/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.ts index b01a1db44b..f4492e96f6 100644 --- a/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.ts +++ b/src/main/lens-proxy/proxy-functions/shell-api-request/shell-api-request.ts @@ -4,28 +4,20 @@ */ import logger from "../../../logger"; -import type WebSocket from "ws"; import { Server as WebSocketServer } from "ws"; import type { ProxyApiRequestArgs } from "../types"; import type { ClusterManager } from "../../../cluster/manager"; import URLParse from "url-parse"; -import type { Cluster } from "../../../../common/cluster/cluster"; import type { ClusterId } from "../../../../common/cluster-types"; +import type { OpenShellSession } from "../../../shell-session/create-shell-session.injectable"; interface Dependencies { authenticateRequest: (clusterId: ClusterId, tabId: string, shellToken: string | undefined) => boolean; - - createShellSession: (args: { - webSocket: WebSocket; - cluster: Cluster; - tabId: string; - nodeName?: string; - }) => { open: () => Promise }; - + openShellSession: OpenShellSession; clusterManager: ClusterManager; } -export const shellApiRequest = ({ createShellSession, authenticateRequest, clusterManager }: Dependencies) => ({ req, socket, head }: ProxyApiRequestArgs): void => { +export const shellApiRequest = ({ openShellSession, authenticateRequest, clusterManager }: Dependencies) => ({ req, socket, head }: ProxyApiRequestArgs): void => { const cluster = clusterManager.getClusterForRequest(req); const { query: { node: nodeName, shellToken, id: tabId }} = new URLParse(req.url, true); @@ -37,10 +29,8 @@ export const shellApiRequest = ({ createShellSession, authenticateRequest, clust const ws = new WebSocketServer({ noServer: true }); - ws.handleUpgrade(req, socket, head, (webSocket) => { - const shell = createShellSession({ webSocket, cluster, tabId, nodeName }); - - shell.open() + ws.handleUpgrade(req, socket, head, (websocket) => { + openShellSession({ websocket, cluster, tabId, nodeName }) .catch(error => logger.error(`[SHELL-SESSION]: failed to open a ${nodeName ? "node" : "local"} shell`, error)); }); }; diff --git a/src/main/resource-applier.ts b/src/main/resource-applier.ts index 30c85e8fa0..4ea984db0a 100644 --- a/src/main/resource-applier.ts +++ b/src/main/resource-applier.ts @@ -4,7 +4,6 @@ */ import type { Cluster } from "../common/cluster/cluster"; -import type { KubernetesObject } from "@kubernetes/client-node"; import { exec } from "child_process"; import fs from "fs-extra"; import * as yaml from "js-yaml"; @@ -15,6 +14,7 @@ import { appEventBus } from "../common/app-event-bus/event-bus"; import { isChildProcessError } from "../common/utils"; import type { Patch } from "rfc6902"; import { promiseExecFile } from "../common/utils/promise-exec"; +import type { KubernetesObject } from "@kubernetes/client-node"; export class ResourceApplier { constructor(protected cluster: Cluster) {} @@ -62,11 +62,12 @@ export class ResourceApplier { } } - async apply(resource: KubernetesObject | any): Promise { - resource = this.sanitizeObject(resource); + async create(resource: string): Promise { appEventBus.emit({ name: "resource", action: "apply" }); - return this.kubectlApply(yaml.dump(resource)); + console.log({ resource }); + + return this.kubectlApply(this.sanitizeObject(resource)); } protected async kubectlApply(content: string): Promise { @@ -149,17 +150,13 @@ export class ResourceApplier { }); } - protected sanitizeObject(resource: KubernetesObject | any) { - const res = JSON.parse(JSON.stringify(resource)); + protected sanitizeObject(resource: string) { + const res = yaml.load(resource) as Partial & { status?: object }; delete res.status; delete res.metadata?.resourceVersion; - const annotations = res.metadata?.annotations; + delete res.metadata?.annotations?.["kubectl.kubernetes.io/last-applied-configuration"]; - if (annotations) { - delete annotations["kubectl.kubernetes.io/last-applied-configuration"]; - } - - return res; + return yaml.dump(res); } } diff --git a/src/main/routes/helm/charts/get-chart-route.injectable.ts b/src/main/routes/helm/charts/get-readme-route.injectable.ts similarity index 58% rename from src/main/routes/helm/charts/get-chart-route.injectable.ts rename to src/main/routes/helm/charts/get-readme-route.injectable.ts index 012584dbfc..f3b52073c2 100644 --- a/src/main/routes/helm/charts/get-chart-route.injectable.ts +++ b/src/main/routes/helm/charts/get-readme-route.injectable.ts @@ -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; diff --git a/src/main/routes/helm/charts/get-chart-values-route.injectable.ts b/src/main/routes/helm/charts/get-values-route.injectable.ts similarity index 84% rename from src/main/routes/helm/charts/get-chart-values-route.injectable.ts rename to src/main/routes/helm/charts/get-values-route.injectable.ts index 3cb7fd8f46..49efe5fb0c 100644 --- a/src/main/routes/helm/charts/get-chart-values-route.injectable.ts +++ b/src/main/routes/helm/charts/get-values-route.injectable.ts @@ -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; diff --git a/src/main/routes/helm/charts/get-versions-route.injectable.ts b/src/main/routes/helm/charts/get-versions-route.injectable.ts new file mode 100644 index 0000000000..933d94743b --- /dev/null +++ b/src/main/routes/helm/charts/get-versions-route.injectable.ts @@ -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; diff --git a/src/main/routes/helm/charts/list-charts-route.injectable.ts b/src/main/routes/helm/charts/list-route.injectable.ts similarity index 82% rename from src/main/routes/helm/charts/list-charts-route.injectable.ts rename to src/main/routes/helm/charts/list-route.injectable.ts index 946b7fe022..402a3d7cd1 100644 --- a/src/main/routes/helm/charts/list-charts-route.injectable.ts +++ b/src/main/routes/helm/charts/list-route.injectable.ts @@ -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; diff --git a/src/main/routes/kubeconfig-route/get-service-account-route.injectable.ts b/src/main/routes/kubeconfig-route/get-service-account-route.injectable.ts index 48bdc5f644..476ee983a3 100644 --- a/src/main/routes/kubeconfig-route/get-service-account-route.injectable.ts +++ b/src/main/routes/kubeconfig-route/get-service-account-route.injectable.ts @@ -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, - }; + }); } diff --git a/src/main/routes/metrics/add-metrics-route.injectable.ts b/src/main/routes/metrics/add-metrics-route.injectable.ts index 5f97ddf4c3..e55fc8bec8 100644 --- a/src/main/routes/metrics/add-metrics-route.injectable.ts +++ b/src/main/routes/metrics/add-metrics-route.injectable.ts @@ -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): Promise => { +const loadMetricsFor = (getMetrics: GetMetrics) => async (promQueries: string[], cluster: Cluster, prometheusPath: string, queryParams: Partial>): Promise => { const queries = promQueries.map(p => p.trim()); const loaders = new Map>(); @@ -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> = Object.fromEntries(query.entries()); const prometheusMetadata: ClusterPrometheusMetadata = {}; try { diff --git a/src/main/routes/resource-applier/apply-resource-route.injectable.ts b/src/main/routes/resource-applier/create-resource-route.injectable.ts similarity index 53% rename from src/main/routes/resource-applier/apply-resource-route.injectable.ts rename to src/main/routes/resource-applier/create-resource-route.injectable.ts index 45f484fd3f..6e756c1861 100644 --- a/src/main/routes/resource-applier/apply-resource-route.injectable.ts +++ b/src/main/routes/resource-applier/create-resource-route.injectable.ts @@ -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; diff --git a/src/main/routes/static-file-route.injectable.ts b/src/main/routes/static-file-route.injectable.ts index 2650410d0b..90c3d02442 100644 --- a/src/main/routes/static-file-route.injectable.ts +++ b/src/main/routes/static-file-route.injectable.ts @@ -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; - 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, }), ); }, diff --git a/src/main/shell-session/create-shell-session.injectable.ts b/src/main/shell-session/create-shell-session.injectable.ts index 5bd5569053..49ba44cb67 100644 --- a/src/main/shell-session/create-shell-session.injectable.ts +++ b/src/main/shell-session/create-shell-session.injectable.ts @@ -5,25 +5,30 @@ import { getInjectable } from "@ogre-tools/injectable"; import type { Cluster } from "../../common/cluster/cluster"; import type WebSocket from "ws"; -import localShellSessionInjectable from "./local-shell-session/local-shell-session.injectable"; -import nodeShellSessionInjectable from "./node-shell-session/node-shell-session.injectable"; +import openLocalShellSessionInjectable from "./local-shell-session/open.injectable"; +import openNodeShellSessionInjectable from "./node-shell-session/open.injectable"; -interface Args { - webSocket: WebSocket; +export interface OpenShellSessionArgs { + websocket: WebSocket; cluster: Cluster; tabId: string; nodeName?: string; } -const createShellSessionInjectable = getInjectable({ - id: "create-shell-session", +export type OpenShellSession = (args: OpenShellSessionArgs) => Promise; - instantiate: - (di) => - ({ nodeName, ...rest }: Args) => - !nodeName - ? di.inject(localShellSessionInjectable, rest) - : di.inject(nodeShellSessionInjectable, { nodeName, ...rest }), +const openShellSessionInjectable = getInjectable({ + id: "open-shell-session", + + instantiate: (di): OpenShellSession => { + const openLocalShellSession = di.inject(openLocalShellSessionInjectable); + + return ({ nodeName, ...args }) => ( + nodeName + ? di.inject(openNodeShellSessionInjectable, { nodeName, ...args }) + : openLocalShellSession(args) + ); + }, }); -export default createShellSessionInjectable; +export default openShellSessionInjectable; diff --git a/src/main/shell-session/local-shell-session/local-shell-session.injectable.ts b/src/main/shell-session/local-shell-session/local-shell-session.injectable.ts deleted file mode 100644 index ed9b86819b..0000000000 --- a/src/main/shell-session/local-shell-session/local-shell-session.injectable.ts +++ /dev/null @@ -1,33 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; -import { LocalShellSession } from "./local-shell-session"; -import type { Cluster } from "../../../common/cluster/cluster"; -import type WebSocket from "ws"; -import createKubectlInjectable from "../../kubectl/create-kubectl.injectable"; -import terminalShellEnvModifiersInjectable from "../shell-env-modifier/terminal-shell-env-modify.injectable"; - -interface InstantiationParameter { - webSocket: WebSocket; - cluster: Cluster; - tabId: string; -} - -const localShellSessionInjectable = getInjectable({ - id: "local-shell-session", - - instantiate: (di, { cluster, tabId, webSocket }: InstantiationParameter) => { - const createKubectl = di.inject(createKubectlInjectable); - const localShellEnvModify = di.inject(terminalShellEnvModifiersInjectable); - - const kubectl = createKubectl(cluster.version); - - return new LocalShellSession(localShellEnvModify, kubectl, webSocket, cluster, tabId); - }, - - lifecycle: lifecycleEnum.transient, -}); - -export default localShellSessionInjectable; diff --git a/src/main/shell-session/local-shell-session/local-shell-session.ts b/src/main/shell-session/local-shell-session/local-shell-session.ts index 9f42c7f242..c13bbeb5a2 100644 --- a/src/main/shell-session/local-shell-session/local-shell-session.ts +++ b/src/main/shell-session/local-shell-session/local-shell-session.ts @@ -3,24 +3,32 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import type WebSocket from "ws"; -import path from "path"; -import { UserStore } from "../../../common/user-store"; -import type { Cluster } from "../../../common/cluster/cluster"; -import type { ClusterId } from "../../../common/cluster-types"; +import type { UserStore } from "../../../common/user-store"; +import type { ShellSessionArgs, ShellSessionDependencies } from "../shell-session"; import { ShellSession } from "../shell-session"; -import type { Kubectl } from "../../kubectl/kubectl"; -import { baseBinariesDir } from "../../../common/vars"; +import type { ModifyTerminalShellEnv } from "../shell-env-modifier/modify-terminal-shell-env.injectable"; +import type { JoinPaths } from "../../../common/path/join-paths.injectable"; +import type { GetDirnameOfPath } from "../../../common/path/get-dirname.injectable"; +import type { GetBasenameOfPath } from "../../../common/path/get-basename.injectable"; + +export interface LocalShellSessionDependencies extends ShellSessionDependencies { + readonly directoryForBinaries: string; + readonly userStore: UserStore; + modifyTerminalShellEnv: ModifyTerminalShellEnv; + joinPaths: JoinPaths; + getDirnameOfPath: GetDirnameOfPath; + getBasenameOfPath: GetBasenameOfPath; +} export class LocalShellSession extends ShellSession { ShellType = "shell"; - constructor(protected shellEnvModify: (clusterId: ClusterId, env: Record) => Record, kubectl: Kubectl, websocket: WebSocket, cluster: Cluster, terminalId: string) { - super(kubectl, websocket, cluster, terminalId); + constructor(protected readonly dependencies: LocalShellSessionDependencies, args: ShellSessionArgs) { + super(dependencies, args); } protected getPathEntries(): string[] { - return [baseBinariesDir.get()]; + return [this.dependencies.directoryForBinaries]; } protected get cwd(): string | undefined { @@ -31,7 +39,7 @@ export class LocalShellSession extends ShellSession { let env = await this.getCachedShellEnv(); // extensions can modify the env - env = this.shellEnvModify(this.cluster.id, env); + env = this.dependencies.modifyTerminalShellEnv(this.cluster.id, env); const shell = env.PTYSHELL; @@ -45,16 +53,18 @@ export class LocalShellSession extends ShellSession { } protected async getShellArgs(shell: string): Promise { - const pathFromPreferences = UserStore.getInstance().kubectlBinariesPath || this.kubectl.getBundledPath(); - const kubectlPathDir = UserStore.getInstance().downloadKubectlBinaries ? await this.kubectlBinDirP : path.dirname(pathFromPreferences); + const pathFromPreferences = this.dependencies.userStore.kubectlBinariesPath || this.kubectl.getBundledPath(); + const kubectlPathDir = this.dependencies.userStore.downloadKubectlBinaries + ? await this.kubectlBinDirP + : this.dependencies.getDirnameOfPath(pathFromPreferences); - switch(path.basename(shell)) { + switch(this.dependencies.getBasenameOfPath(shell)) { case "powershell.exe": - return ["-NoExit", "-command", `& {$Env:PATH="${kubectlPathDir};${baseBinariesDir.get()};$Env:PATH"}`]; + return ["-NoExit", "-command", `& {$Env:PATH="${kubectlPathDir};${this.dependencies.directoryForBinaries};$Env:PATH"}`]; case "bash": - return ["--init-file", path.join(await this.kubectlBinDirP, ".bash_set_path")]; + return ["--init-file", this.dependencies.joinPaths(await this.kubectlBinDirP, ".bash_set_path")]; case "fish": - return ["--login", "--init-command", `export PATH="${kubectlPathDir}:${baseBinariesDir.get()}:$PATH"; export KUBECONFIG="${await this.kubeconfigPathP}"`]; + return ["--login", "--init-command", `export PATH="${kubectlPathDir}:${this.dependencies.directoryForBinaries}:$PATH"; export KUBECONFIG="${await this.kubeconfigPathP}"`]; case "zsh": return ["--login"]; default: diff --git a/src/main/shell-session/local-shell-session/open.injectable.ts b/src/main/shell-session/local-shell-session/open.injectable.ts new file mode 100644 index 0000000000..0187ba97e7 --- /dev/null +++ b/src/main/shell-session/local-shell-session/open.injectable.ts @@ -0,0 +1,55 @@ +/** + * 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 type { LocalShellSessionDependencies } from "./local-shell-session"; +import { LocalShellSession } from "./local-shell-session"; +import createKubectlInjectable from "../../kubectl/create-kubectl.injectable"; +import modifyTerminalShellEnvInjectable from "../shell-env-modifier/modify-terminal-shell-env.injectable"; +import directoryForBinariesInjectable from "../../../common/app-paths/directory-for-binaries/directory-for-binaries.injectable"; +import isMacInjectable from "../../../common/vars/is-mac.injectable"; +import type { Cluster } from "../../../common/cluster/cluster"; +import isWindowsInjectable from "../../../common/vars/is-windows.injectable"; +import loggerInjectable from "../../../common/logger.injectable"; +import userStoreInjectable from "../../../common/user-store/user-store.injectable"; +import type WebSocket from "ws"; +import getDirnameOfPathInjectable from "../../../common/path/get-dirname.injectable"; +import joinPathsInjectable from "../../../common/path/join-paths.injectable"; +import getBasenameOfPathInjectable from "../../../common/path/get-basename.injectable"; + +export interface OpenLocalShellSessionArgs { + websocket: WebSocket; + cluster: Cluster; + tabId: string; +} + +export type OpenLocalShellSession = (args: OpenLocalShellSessionArgs) => Promise; + +const openLocalShellSessionInjectable = getInjectable({ + id: "open-local-shell-session", + + instantiate: (di): OpenLocalShellSession => { + const createKubectl = di.inject(createKubectlInjectable); + const dependencies: LocalShellSessionDependencies = { + directoryForBinaries: di.inject(directoryForBinariesInjectable), + isMac: di.inject(isMacInjectable), + modifyTerminalShellEnv: di.inject(modifyTerminalShellEnvInjectable), + isWindows: di.inject(isWindowsInjectable), + logger: di.inject(loggerInjectable), + userStore: di.inject(userStoreInjectable), + getDirnameOfPath: di.inject(getDirnameOfPathInjectable), + joinPaths: di.inject(joinPathsInjectable), + getBasenameOfPath: di.inject(getBasenameOfPathInjectable), + }; + + return (args) => { + const kubectl = createKubectl(args.cluster.version); + const session = new LocalShellSession(dependencies, { kubectl, ...args }); + + return session.open(); + }; + }, +}); + +export default openLocalShellSessionInjectable; diff --git a/src/main/shell-session/node-shell-session/node-shell-session.injectable.ts b/src/main/shell-session/node-shell-session/node-shell-session.injectable.ts deleted file mode 100644 index e2514708e6..0000000000 --- a/src/main/shell-session/node-shell-session/node-shell-session.injectable.ts +++ /dev/null @@ -1,32 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; -import type { Cluster } from "../../../common/cluster/cluster"; -import type WebSocket from "ws"; -import createKubectlInjectable from "../../kubectl/create-kubectl.injectable"; -import { NodeShellSession } from "./node-shell-session"; - -interface InstantiationParameter { - webSocket: WebSocket; - cluster: Cluster; - tabId: string; - nodeName: string; -} - -const nodeShellSessionInjectable = getInjectable({ - id: "node-shell-session", - - instantiate: (di, { cluster, tabId, webSocket, nodeName }: InstantiationParameter) => { - const createKubectl = di.inject(createKubectlInjectable); - - const kubectl = createKubectl(cluster.version); - - return new NodeShellSession(nodeName, kubectl, webSocket, cluster, tabId); - }, - - lifecycle: lifecycleEnum.transient, -}); - -export default nodeShellSessionInjectable; diff --git a/src/main/shell-session/node-shell-session/node-shell-session.ts b/src/main/shell-session/node-shell-session/node-shell-session.ts index 4c619a612c..6a8af4c09e 100644 --- a/src/main/shell-session/node-shell-session/node-shell-session.ts +++ b/src/main/shell-session/node-shell-session/node-shell-session.ts @@ -3,28 +3,34 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import type WebSocket from "ws"; import { v4 as uuid } from "uuid"; import { Watch, CoreV1Api } from "@kubernetes/client-node"; import type { KubeConfig } from "@kubernetes/client-node"; -import type { Cluster } from "../../../common/cluster/cluster"; +import type { ShellSessionArgs, ShellSessionDependencies } from "../shell-session"; import { ShellOpenError, ShellSession } from "../shell-session"; import { get, once } from "lodash"; import { Node, NodeApi } from "../../../common/k8s-api/endpoints"; -import { KubeJsonApi } from "../../../common/k8s-api/kube-json-api"; -import logger from "../../logger"; -import type { Kubectl } from "../../kubectl/kubectl"; import { TerminalChannels } from "../../../common/terminal/channels"; +import type { CreateKubeJsonApiForCluster } from "../../../common/k8s-api/create-kube-json-api-for-cluster.injectable"; + +export interface NodeShellSessionArgs extends ShellSessionArgs { + nodeName: string; +} + +export interface NodeShellSessionDependencies extends ShellSessionDependencies { + createKubeJsonApiForCluster: CreateKubeJsonApiForCluster; +} export class NodeShellSession extends ShellSession { ShellType = "node-shell"; protected readonly podName = `node-shell-${uuid()}`; - + protected readonly nodeName: string; protected readonly cwd: string | undefined = undefined; - constructor(protected nodeName: string, kubectl: Kubectl, socket: WebSocket, cluster: Cluster, terminalId: string) { - super(kubectl, socket, cluster, terminalId); + constructor(protected readonly dependencies: NodeShellSessionDependencies, { nodeName, ...args }: NodeShellSessionArgs) { + super(dependencies, args); + this.nodeName = nodeName; } public async open() { @@ -35,7 +41,7 @@ export class NodeShellSession extends ShellSession { const cleanup = once(() => { coreApi .deleteNamespacedPod(this.podName, "kube-system") - .catch(error => logger.warn(`[NODE-SHELL]: failed to remove pod shell`, error)); + .catch(error => this.dependencies.logger.warn(`[NODE-SHELL]: failed to remove pod shell`, error)); }); this.websocket.once("close", cleanup); @@ -63,7 +69,7 @@ export class NodeShellSession extends ShellSession { const args = ["exec", "-i", "-t", "-n", "kube-system", this.podName, "--"]; const nodeApi = new NodeApi({ objectConstructor: Node, - request: KubeJsonApi.forCluster(this.cluster.id), + request: this.dependencies.createKubeJsonApiForCluster(this.cluster.id), }); const node = await nodeApi.get({ name: this.nodeName }); @@ -75,7 +81,7 @@ export class NodeShellSession extends ShellSession { switch (nodeOs) { default: - logger.warn(`[NODE-SHELL-SESSION]: could not determine node OS, falling back with assumption of linux`); + this.dependencies.logger.warn(`[NODE-SHELL-SESSION]: could not determine node OS, falling back with assumption of linux`); // fallthrough case "linux": args.push("sh", "-c", "((clear && bash) || (clear && ash) || (clear && sh))"); @@ -127,7 +133,7 @@ export class NodeShellSession extends ShellSession { } protected waitForRunningPod(kc: KubeConfig): Promise { - logger.debug(`[NODE-SHELL]: waiting for ${this.podName} to be running`); + this.dependencies.logger.debug(`[NODE-SHELL]: waiting for ${this.podName} to be running`); return new Promise((resolve, reject) => { new Watch(kc) @@ -146,19 +152,19 @@ export class NodeShellSession extends ShellSession { }, // done callback is called if the watch terminates normally (err) => { - logger.error(`[NODE-SHELL]: ${this.podName} was not created in time`); + this.dependencies.logger.error(`[NODE-SHELL]: ${this.podName} was not created in time`); reject(err); }, ) .then(req => { setTimeout(() => { - logger.error(`[NODE-SHELL]: aborting wait for ${this.podName}, timing out`); + this.dependencies.logger.error(`[NODE-SHELL]: aborting wait for ${this.podName}, timing out`); req.abort(); reject("Pod creation timed out"); }, 2 * 60 * 1000); // 2 * 60 * 1000 }) .catch(error => { - logger.error(`[NODE-SHELL]: waiting for ${this.podName} failed: ${error}`); + this.dependencies.logger.error(`[NODE-SHELL]: waiting for ${this.podName} failed: ${error}`); reject(error); }); }); diff --git a/src/main/shell-session/node-shell-session/open.injectable.ts b/src/main/shell-session/node-shell-session/open.injectable.ts new file mode 100644 index 0000000000..9bc418d812 --- /dev/null +++ b/src/main/shell-session/node-shell-session/open.injectable.ts @@ -0,0 +1,42 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; +import type { Cluster } from "../../../common/cluster/cluster"; +import type WebSocket from "ws"; +import createKubectlInjectable from "../../kubectl/create-kubectl.injectable"; +import type { NodeShellSessionDependencies } from "./node-shell-session"; +import { NodeShellSession } from "./node-shell-session"; +import isMacInjectable from "../../../common/vars/is-mac.injectable"; +import isWindowsInjectable from "../../../common/vars/is-windows.injectable"; +import loggerInjectable from "../../../common/logger.injectable"; +import createKubeJsonApiForClusterInjectable from "../../../common/k8s-api/create-kube-json-api-for-cluster.injectable"; + +export interface NodeShellSessionArgs { + websocket: WebSocket; + cluster: Cluster; + tabId: string; + nodeName: string; +} + +const openNodeShellSessionInjectable = getInjectable({ + id: "open-node-shell-session", + instantiate: (di, params: NodeShellSessionArgs) => { + const createKubectl = di.inject(createKubectlInjectable); + const dependencies: NodeShellSessionDependencies = { + isMac: di.inject(isMacInjectable), + isWindows: di.inject(isWindowsInjectable), + logger: di.inject(loggerInjectable), + createKubeJsonApiForCluster: di.inject(createKubeJsonApiForClusterInjectable), + }; + const kubectl = createKubectl(params.cluster.version); + const session = new NodeShellSession(dependencies, { kubectl, ...params }); + + return session.open(); + }, + // NOTE: this must be transient to bypass the circular dependency of `createKubeJsonApiForClusterInjectable` on the lens proxy port + lifecycle: lifecycleEnum.transient, +}); + +export default openNodeShellSessionInjectable; diff --git a/src/main/shell-session/shell-env-modifier/modify-terminal-shell-env.injectable.ts b/src/main/shell-session/shell-env-modifier/modify-terminal-shell-env.injectable.ts new file mode 100644 index 0000000000..559dbcf645 --- /dev/null +++ b/src/main/shell-session/shell-env-modifier/modify-terminal-shell-env.injectable.ts @@ -0,0 +1,49 @@ +/** + * 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 { computed } from "mobx"; +import type { ClusterId } from "../../../common/cluster-types"; +import { isDefined } from "../../../common/utils"; +import mainExtensionsInjectable from "../../../extensions/main-extensions.injectable"; +import catalogEntityRegistryInjectable from "../../catalog/entity-registry.injectable"; + +export type ModifyTerminalShellEnv = (clusterId: ClusterId, env: Partial>) => Partial>; + +const modifyTerminalShellEnvInjectable = getInjectable({ + id: "terminal-shell-env-modify", + + instantiate: (di): ModifyTerminalShellEnv => { + const extensions = di.inject(mainExtensionsInjectable); + const catalogEntityRegistry = di.inject(catalogEntityRegistryInjectable); + const terminalShellEnvModifiers = computed(() => ( + extensions.get() + .map((extension) => extension.terminalShellEnvModifier) + .filter(isDefined) + )); + + return (clusterId, env) => { + const modifiers = terminalShellEnvModifiers.get(); + + if (modifiers.length === 0) { + return env; + } + + const entity = catalogEntityRegistry.findById(clusterId); + + if (entity) { + const ctx = { catalogEntity: entity }; + + // clone it so the passed value is not also modified + env = JSON.parse(JSON.stringify(env)); + env = modifiers.reduce((env, modifier) => modifier(ctx, env), env); + } + + return env; + }; + }, +}); + +export default modifyTerminalShellEnvInjectable; diff --git a/src/main/shell-session/shell-env-modifier/terminal-shell-env-modifiers.ts b/src/main/shell-session/shell-env-modifier/terminal-shell-env-modifiers.ts deleted file mode 100644 index bf6a290052..0000000000 --- a/src/main/shell-session/shell-env-modifier/terminal-shell-env-modifiers.ts +++ /dev/null @@ -1,42 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import type { IComputedValue } from "mobx"; -import { computed } from "mobx"; -import type { ClusterId } from "../../../common/cluster-types"; -import { isDefined } from "../../../common/utils"; -import type { LensMainExtension } from "../../../extensions/lens-main-extension"; -import type { CatalogEntityRegistry } from "../../catalog"; - -interface Dependencies { - extensions: IComputedValue; - catalogEntityRegistry: CatalogEntityRegistry; -} - -export const terminalShellEnvModify = ({ extensions, catalogEntityRegistry }: Dependencies) => - (clusterId: ClusterId, env: Record) => { - const terminalShellEnvModifiers = computed(() => ( - extensions.get() - .map((extension) => extension.terminalShellEnvModifier) - .filter(isDefined) - )) - .get(); - - if (terminalShellEnvModifiers.length === 0) { - return env; - } - - const entity = catalogEntityRegistry.findById(clusterId); - - if (entity) { - const ctx = { catalogEntity: entity }; - - // clone it so the passed value is not also modified - env = JSON.parse(JSON.stringify(env)); - env = terminalShellEnvModifiers.reduce((env, modifier) => modifier(ctx, env), env); - } - - return env; - }; diff --git a/src/main/shell-session/shell-env-modifier/terminal-shell-env-modify.injectable.ts b/src/main/shell-session/shell-env-modifier/terminal-shell-env-modify.injectable.ts deleted file mode 100644 index 7d8cb37a1c..0000000000 --- a/src/main/shell-session/shell-env-modifier/terminal-shell-env-modify.injectable.ts +++ /dev/null @@ -1,21 +0,0 @@ -/** - * 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 mainExtensionsInjectable from "../../../extensions/main-extensions.injectable"; -import { terminalShellEnvModify } from "./terminal-shell-env-modifiers"; -import catalogEntityRegistryInjectable from "../../catalog/entity-registry.injectable"; - -const terminalShellEnvModifyInjectable = getInjectable({ - id: "terminal-shell-env-modify", - - instantiate: (di) => - terminalShellEnvModify({ - extensions: di.inject(mainExtensionsInjectable), - catalogEntityRegistry: di.inject(catalogEntityRegistryInjectable), - }), -}); - -export default terminalShellEnvModifyInjectable; diff --git a/src/main/shell-session/shell-session.ts b/src/main/shell-session/shell-session.ts index 42286ee24d..98d1303d83 100644 --- a/src/main/shell-session/shell-session.ts +++ b/src/main/shell-session/shell-session.ts @@ -11,14 +11,13 @@ import { app } from "electron"; import { clearKubeconfigEnvVars } from "../utils/clear-kube-env-vars"; import path from "path"; import os from "os"; -import { isMac, isWindows } from "../../common/vars"; import { UserStore } from "../../common/user-store"; import * as pty from "node-pty"; import { appEventBus } from "../../common/app-event-bus/event-bus"; -import logger from "../logger"; import { stat } from "fs/promises"; import { getOrInsertWith } from "../../common/utils"; import { type TerminalMessage, TerminalChannels } from "../../common/terminal/channels"; +import type { Logger } from "../../common/logger"; export class ShellOpenError extends Error { constructor(message: string, options?: ErrorOptions) { @@ -104,6 +103,19 @@ export enum WebSocketCloseEvent { TlsHandshake = 1015, } +export interface ShellSessionDependencies { + readonly isWindows: boolean; + readonly isMac: boolean; + readonly logger: Logger; +} + +export interface ShellSessionArgs { + kubectl: Kubectl; + websocket: WebSocket; + cluster: Cluster; + tabId: string; +} + export abstract class ShellSession { abstract readonly ShellType: string; @@ -130,6 +142,9 @@ export abstract class ShellSession { protected readonly kubectlBinDirP: Promise; protected readonly kubeconfigPathP: Promise; protected readonly terminalId: string; + protected readonly kubectl: Kubectl; + protected readonly websocket: WebSocket; + protected readonly cluster: Cluster; protected abstract get cwd(): string | undefined; @@ -147,12 +162,15 @@ export abstract class ShellSession { }) )); - logger.info(`[SHELL-SESSION]: PTY for ${this.terminalId} is ${resume ? "resumed" : "started"} with PID=${shellProcess.pid}`); + this.dependencies.logger.info(`[SHELL-SESSION]: PTY for ${this.terminalId} is ${resume ? "resumed" : "started"} with PID=${shellProcess.pid}`); return { shellProcess, resume }; } - constructor(protected readonly kubectl: Kubectl, protected readonly websocket: WebSocket, protected readonly cluster: Cluster, terminalId: string) { + constructor(protected readonly dependencies: ShellSessionDependencies, { kubectl, websocket, cluster, tabId: terminalId }: ShellSessionArgs) { + this.kubectl = kubectl; + this.websocket = websocket; + this.cluster = cluster; this.kubeconfigPathP = this.cluster.getProxyKubeconfigPath(); this.kubectlBinDirP = this.kubectl.binDir(); this.terminalId = `${cluster.id}:${terminalId}`; @@ -165,7 +183,7 @@ export abstract class ShellSession { protected async getCwd(env: Record): Promise { const cwdOptions = [this.cwd]; - if (isWindows) { + if (this.dependencies.isWindows) { cwdOptions.push( env.USERPROFILE, os.homedir(), @@ -177,7 +195,7 @@ export abstract class ShellSession { os.homedir(), ); - if (isMac) { + if (this.dependencies.isMac) { cwdOptions.push("/Users"); } else { cwdOptions.push("/home"); @@ -214,7 +232,7 @@ export abstract class ShellSession { this.running = true; shellProcess.onData(data => this.send({ type: TerminalChannels.STDOUT, data })); shellProcess.onExit(({ exitCode }) => { - logger.info(`[SHELL-SESSION]: shell has exited for ${this.terminalId} closed with exitcode=${exitCode}`); + this.dependencies.logger.info(`[SHELL-SESSION]: shell has exited for ${this.terminalId} closed with exitcode=${exitCode}`); // This might already be false because of the kill() within the websocket.on("close") handler if (this.running) { @@ -232,11 +250,11 @@ export abstract class ShellSession { this.websocket .on("message", (rawData: unknown): void => { if (!this.running) { - return void logger.debug(`[SHELL-SESSION]: received message from ${this.terminalId}, but shellProcess isn't running`); + return void this.dependencies.logger.debug(`[SHELL-SESSION]: received message from ${this.terminalId}, but shellProcess isn't running`); } if (!(rawData instanceof Buffer)) { - return void logger.error(`[SHELL-SESSION]: Received message non-buffer message.`, { rawData }); + return void this.dependencies.logger.error(`[SHELL-SESSION]: Received message non-buffer message.`, { rawData }); } const data = rawData.toString(); @@ -252,18 +270,18 @@ export abstract class ShellSession { shellProcess.resize(message.data.width, message.data.height); break; case TerminalChannels.PING: - logger.silly(`[SHELL-SESSION]: ${this.terminalId} ping!`); + this.dependencies.logger.silly(`[SHELL-SESSION]: ${this.terminalId} ping!`); break; default: - logger.warn(`[SHELL-SESSION]: unknown or unhandleable message type for ${this.terminalId}`, message); + this.dependencies.logger.warn(`[SHELL-SESSION]: unknown or unhandleable message type for ${this.terminalId}`, message); break; } } catch (error) { - logger.error(`[SHELL-SESSION]: failed to handle message for ${this.terminalId}`, error); + this.dependencies.logger.error(`[SHELL-SESSION]: failed to handle message for ${this.terminalId}`, error); } }) .once("close", code => { - logger.info(`[SHELL-SESSION]: websocket for ${this.terminalId} closed with code=${WebSocketCloseEvent[code]}(${code})`, { cluster: this.cluster.getMeta() }); + this.dependencies.logger.info(`[SHELL-SESSION]: websocket for ${this.terminalId} closed with code=${WebSocketCloseEvent[code]}(${code})`, { cluster: this.cluster.getMeta() }); const stopShellSession = this.running && ( @@ -278,11 +296,11 @@ export abstract class ShellSession { this.running = false; try { - logger.info(`[SHELL-SESSION]: Killing shell process (pid=${shellProcess.pid}) for ${this.terminalId}`); + this.dependencies.logger.info(`[SHELL-SESSION]: Killing shell process (pid=${shellProcess.pid}) for ${this.terminalId}`); shellProcess.kill(); ShellSession.processes.delete(this.terminalId); } catch (error) { - logger.warn(`[SHELL-SESSION]: failed to kill shell process (pid=${shellProcess.pid}) for ${this.terminalId}`, error); + this.dependencies.logger.warn(`[SHELL-SESSION]: failed to kill shell process (pid=${shellProcess.pid}) for ${this.terminalId}`, error); } } }); @@ -319,7 +337,7 @@ export abstract class ShellSession { delete env.DEBUG; // don't pass DEBUG into shells - if (isWindows) { + if (this.dependencies.isWindows) { env.SystemRoot = process.env.SystemRoot; env.PTYSHELL = shell || "powershell.exe"; env.PATH = pathStr; diff --git a/src/main/start-main-application/lens-window/splash-window/splash-window.injectable.ts b/src/main/start-main-application/lens-window/splash-window/splash-window.injectable.ts index 72c65d6c8d..978309c4d0 100644 --- a/src/main/start-main-application/lens-window/splash-window/splash-window.injectable.ts +++ b/src/main/start-main-application/lens-window/splash-window/splash-window.injectable.ts @@ -5,7 +5,7 @@ import { getInjectable } from "@ogre-tools/injectable"; import createLensWindowInjectable from "../application-window/create-lens-window.injectable"; import staticFilesDirectoryInjectable from "../../../../common/vars/static-files-directory.injectable"; -import getAbsolutePathInjectable from "../../../../common/path/get-absolute-path.injectable"; +import joinPathsInjectable from "../../../../common/path/join-paths.injectable"; const splashWindowInjectable = getInjectable({ id: "splash-window", @@ -13,8 +13,8 @@ const splashWindowInjectable = getInjectable({ instantiate: (di) => { const createLensWindow = di.inject(createLensWindowInjectable); const staticFilesDirectory = di.inject(staticFilesDirectoryInjectable); - const getAbsolutePath = di.inject(getAbsolutePathInjectable); - const splashWindowFile = getAbsolutePath(staticFilesDirectory, "splash.html"); + const joinPaths = di.inject(joinPathsInjectable); + const splashWindowFile = joinPaths(staticFilesDirectory, "splash.html"); return createLensWindow({ id: "splash", diff --git a/src/main/tray/menu-icon/get-tray-icon-path.injectable.ts b/src/main/tray/menu-icon/get-tray-icon-path.injectable.ts index fe2746a2ab..30d2e58858 100644 --- a/src/main/tray/menu-icon/get-tray-icon-path.injectable.ts +++ b/src/main/tray/menu-icon/get-tray-icon-path.injectable.ts @@ -3,34 +3,33 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import getAbsolutePathInjectable from "../../../common/path/get-absolute-path.injectable"; import staticFilesDirectoryInjectable from "../../../common/vars/static-files-directory.injectable"; import isDevelopmentInjectable from "../../../common/vars/is-development.injectable"; import isMacInjectable from "../../../common/vars/is-mac.injectable"; import { camelCase, flow, upperFirst } from "lodash/fp"; +import joinPathsInjectable from "../../../common/path/join-paths.injectable"; const upperCamelCase = flow(camelCase, upperFirst); const getTrayIconPathInjectable = getInjectable({ id: "get-tray-icon-path", instantiate: (di) => { - const getAbsolutePath = di.inject(getAbsolutePathInjectable); + const joinPaths = di.inject(joinPathsInjectable); const staticFilesDirectory = di.inject(staticFilesDirectoryInjectable); const isDevelopment = di.inject(isDevelopmentInjectable); const isMac = di.inject(isMacInjectable); - const baseIconDirectory = getAbsolutePath( + const baseIconDirectory = joinPaths( staticFilesDirectory, isDevelopment ? "../build/tray" : "icons", // copied within electron-builder extras ); const fileSuffix = isMac ? "Template.png" : ".png"; - return (name: string) => - getAbsolutePath( - baseIconDirectory, - `trayIcon${upperCamelCase(name)}${fileSuffix}`, - ); + return (name: string) => joinPaths( + baseIconDirectory, + `trayIcon${upperCamelCase(name)}${fileSuffix}`, + ); }, }); diff --git a/src/migrations/cluster-store/3.6.0-beta.1.ts b/src/migrations/cluster-store/3.6.0-beta.1.ts index 09dbd1fd61..5f6bdbc9b7 100644 --- a/src/migrations/cluster-store/3.6.0-beta.1.ts +++ b/src/migrations/cluster-store/3.6.0-beta.1.ts @@ -6,9 +6,8 @@ // Move embedded kubeconfig into separate file and add reference to it to cluster settings // convert file path cluster icons to their base64 encoded versions -import path from "path"; import fse from "fs-extra"; -import { loadConfigFromFileSync } from "../../common/kube-helpers"; +import { loadConfigFromString } from "../../common/kube-helpers"; import type { MigrationDeclaration } from "../helpers"; import { migrationLog } from "../helpers"; import type { ClusterModel } from "../../common/cluster-types"; @@ -19,6 +18,8 @@ import directoryForKubeConfigsInjectable from "../../common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable"; import getCustomKubeConfigDirectoryInjectable from "../../common/app-paths/get-custom-kube-config-directory/get-custom-kube-config-directory.injectable"; +import readFileSyncInjectable from "../../common/fs/read-file-sync.injectable"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; interface Pre360ClusterModel extends ClusterModel { kubeConfig?: string; @@ -32,6 +33,8 @@ export default { const userDataPath = di.inject(directoryForUserDataInjectable); const kubeConfigsPath = di.inject(directoryForKubeConfigsInjectable); const getCustomKubeConfigDirectory = di.inject(getCustomKubeConfigDirectoryInjectable); + const readFileSync = di.inject(readFileSyncInjectable); + const joinPaths = di.inject(joinPathsInjectable); const storedClusters: Pre360ClusterModel[] = store.get("clusters") ?? []; const migratedClusters: ClusterModel[] = []; @@ -55,7 +58,7 @@ export default { fse.writeFileSync(absPath, clusterModel.kubeConfig, { encoding: "utf-8", mode: 0o600 }); clusterModel.kubeConfigPath = absPath; - clusterModel.contextName = loadConfigFromFileSync(clusterModel.kubeConfigPath).config.getCurrentContext(); + clusterModel.contextName = loadConfigFromString(readFileSync(absPath)).config.getCurrentContext(); delete clusterModel.kubeConfig; } catch (error) { @@ -71,7 +74,7 @@ export default { if (clusterModel.preferences?.icon) { migrationLog(`migrating ${clusterModel.preferences.icon} for ${clusterModel.preferences.clusterName}`); const iconPath = clusterModel.preferences.icon.replace("store://", ""); - const fileData = fse.readFileSync(path.join(userDataPath, iconPath)); + const fileData = fse.readFileSync(joinPaths(userDataPath, iconPath)); clusterModel.preferences.icon = `data:;base64,${fileData.toString("base64")}`; } else { diff --git a/src/migrations/cluster-store/5.0.0-beta.10.ts b/src/migrations/cluster-store/5.0.0-beta.10.ts index 9172969a85..97b94dc7f7 100644 --- a/src/migrations/cluster-store/5.0.0-beta.10.ts +++ b/src/migrations/cluster-store/5.0.0-beta.10.ts @@ -3,13 +3,13 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import path from "path"; import fse from "fs-extra"; import type { ClusterModel } from "../../common/cluster-types"; import type { MigrationDeclaration } from "../helpers"; import { getLegacyGlobalDiForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api"; import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; import { isErrnoException } from "../../common/utils"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; interface Pre500WorkspaceStoreModel { workspaces: { @@ -24,9 +24,10 @@ export default { const di = getLegacyGlobalDiForExtensionApi(); const userDataPath = di.inject(directoryForUserDataInjectable); + const joinPaths = di.inject(joinPathsInjectable); try { - const workspaceData: Pre500WorkspaceStoreModel = fse.readJsonSync(path.join(userDataPath, "lens-workspace-store.json")); + const workspaceData: Pre500WorkspaceStoreModel = fse.readJsonSync(joinPaths(userDataPath, "lens-workspace-store.json")); const workspaces = new Map(); // mapping from WorkspaceId to name for (const { id, name } of workspaceData.workspaces) { diff --git a/src/migrations/cluster-store/5.0.0-beta.13.ts b/src/migrations/cluster-store/5.0.0-beta.13.ts index dc85a04718..87d88b143a 100644 --- a/src/migrations/cluster-store/5.0.0-beta.13.ts +++ b/src/migrations/cluster-store/5.0.0-beta.13.ts @@ -7,12 +7,11 @@ import type { ClusterModel, ClusterPreferences, ClusterPrometheusPreferences } f import type { MigrationDeclaration } from "../helpers"; import { migrationLog } from "../helpers"; import { generateNewIdFor } from "../utils"; -import path from "path"; import { moveSync, removeSync } from "fs-extra"; import { getLegacyGlobalDiForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api"; -import directoryForUserDataInjectable - from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; +import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; import { isDefined } from "../../common/utils"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; function mergePrometheusPreferences(left: ClusterPrometheusPreferences, right: ClusterPrometheusPreferences): ClusterPrometheusPreferences { if (left.prometheus && left.prometheusProvider) { @@ -79,29 +78,29 @@ function mergeClusterModel(prev: ClusterModel, right: Omit): }; } -function moveStorageFolder({ folder, newId, oldId }: { folder: string; newId: string; oldId: string }): void { - const oldPath = path.resolve(folder, `${oldId}.json`); - const newPath = path.resolve(folder, `${newId}.json`); - - try { - moveSync(oldPath, newPath); - } catch (error) { - if (String(error).includes("dest already exists")) { - migrationLog(`Multiple old lens-local-storage files for newId=${newId}. Removing ${oldId}.json`); - removeSync(oldPath); - } - } -} - export default { version: "5.0.0-beta.13", run(store) { const di = getLegacyGlobalDiForExtensionApi(); const userDataPath = di.inject(directoryForUserDataInjectable); + const joinPaths = di.inject(joinPathsInjectable); - const folder = path.resolve(userDataPath, "lens-local-storage"); + const moveStorageFolder = ({ folder, newId, oldId }: { folder: string; newId: string; oldId: string }): void => { + const oldPath = joinPaths(folder, `${oldId}.json`); + const newPath = joinPaths(folder, `${newId}.json`); + try { + moveSync(oldPath, newPath); + } catch (error) { + if (String(error).includes("dest already exists")) { + migrationLog(`Multiple old lens-local-storage files for newId=${newId}. Removing ${oldId}.json`); + removeSync(oldPath); + } + } + }; + + const folder = joinPaths(userDataPath, "lens-local-storage"); const oldClusters: ClusterModel[] = store.get("clusters") ?? []; const clusters = new Map(); diff --git a/src/migrations/hotbar-store/5.0.0-beta.10.ts b/src/migrations/hotbar-store/5.0.0-beta.10.ts index 95a4c616d4..771a37fa36 100644 --- a/src/migrations/hotbar-store/5.0.0-beta.10.ts +++ b/src/migrations/hotbar-store/5.0.0-beta.10.ts @@ -5,7 +5,6 @@ import fse from "fs-extra"; import { isNull } from "lodash"; -import path from "path"; import * as uuid from "uuid"; import type { ClusterStoreModel } from "../../common/cluster-store/cluster-store"; import type { Hotbar, HotbarItem } from "../../common/hotbars/types"; @@ -17,6 +16,7 @@ import { getLegacyGlobalDiForExtensionApi } from "../../extensions/as-legacy-glo import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; import catalogCatalogEntityInjectable from "../../common/catalog-entities/general-catalog-entities/implementations/catalog-catalog-entity.injectable"; import { isDefined, isErrnoException } from "../../common/utils"; +import joinPathsInjectable from "../../common/path/join-paths.injectable"; interface Pre500WorkspaceStoreModel { workspaces: { @@ -40,6 +40,7 @@ export default { const di = getLegacyGlobalDiForExtensionApi(); const userDataPath = di.inject(directoryForUserDataInjectable); + const joinPaths = di.inject(joinPathsInjectable); // Hotbars might be empty, if some of the previous migrations weren't run if (hotbars.length === 0) { @@ -56,8 +57,8 @@ export default { } try { - const workspaceStoreData: Pre500WorkspaceStoreModel = fse.readJsonSync(path.join(userDataPath, "lens-workspace-store.json")); - const { clusters = [] }: ClusterStoreModel = fse.readJSONSync(path.join(userDataPath, "lens-cluster-store.json")); + const workspaceStoreData: Pre500WorkspaceStoreModel = fse.readJsonSync(joinPaths(userDataPath, "lens-workspace-store.json")); + const { clusters = [] }: ClusterStoreModel = fse.readJSONSync(joinPaths(userDataPath, "lens-cluster-store.json")); const workspaceHotbars = new Map(); // mapping from WorkspaceId to HotBar for (const { id, name } of workspaceStoreData.workspaces) { diff --git a/src/migrations/user-store/5.0.3-beta.1.ts b/src/migrations/user-store/5.0.3-beta.1.ts index 40f93312cf..cf18ccd3e4 100644 --- a/src/migrations/user-store/5.0.3-beta.1.ts +++ b/src/migrations/user-store/5.0.3-beta.1.ts @@ -4,18 +4,18 @@ */ import { existsSync, readFileSync } from "fs"; -import path from "path"; import os from "os"; import type { ClusterStoreModel } from "../../common/cluster-store/cluster-store"; import type { KubeconfigSyncEntry, UserPreferencesModel } from "../../common/user-store"; import type { MigrationDeclaration } from "../helpers"; import { migrationLog } from "../helpers"; -import { isErrnoException, isLogicalChildPath } from "../../common/utils"; +import { isErrnoException } from "../../common/utils"; import { getLegacyGlobalDiForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api"; -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 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 joinPathsInjectable from "../../common/path/join-paths.injectable"; +import isLogicalChildPathInjectable from "../../common/path/is-logical-child-path.injectable"; +import getDirnameOfPathInjectable from "../../common/path/get-dirname.injectable"; export default { version: "5.0.3-beta.1", @@ -27,18 +27,21 @@ export default { const userDataPath = di.inject(directoryForUserDataInjectable); const kubeConfigsPath = di.inject(directoryForKubeConfigsInjectable); + const joinPaths = di.inject(joinPathsInjectable); + const isLogicalChildPath = di.inject(isLogicalChildPathInjectable); + const getDirnameOfPath = di.inject(getDirnameOfPathInjectable); - const { clusters = [] }: ClusterStoreModel = JSON.parse(readFileSync(path.resolve(userDataPath, "lens-cluster-store.json"), "utf-8")) ?? {}; - const extensionDataDir = path.resolve(userDataPath, "extension_data"); + const { clusters = [] }: ClusterStoreModel = JSON.parse(readFileSync(joinPaths(userDataPath, "lens-cluster-store.json"), "utf-8")) ?? {}; + const extensionDataDir = joinPaths(userDataPath, "extension_data"); const syncPaths = new Set(syncKubeconfigEntries.map(s => s.filePath)); - syncPaths.add(path.join(os.homedir(), ".kube")); + syncPaths.add(joinPaths(os.homedir(), ".kube")); for (const cluster of clusters) { if (!cluster.kubeConfigPath) { continue; } - const dirOfKubeconfig = path.dirname(cluster.kubeConfigPath); + const dirOfKubeconfig = getDirnameOfPath(cluster.kubeConfigPath); if (dirOfKubeconfig === kubeConfigsPath) { migrationLog(`Skipping ${cluster.id} because kubeConfigPath is under the stored KubeConfig folder`); diff --git a/src/renderer/api/index.ts b/src/renderer/api/index.ts deleted file mode 100644 index 379d1e292b..0000000000 --- a/src/renderer/api/index.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -export { apiBase, apiKube } from "../../common/k8s-api"; diff --git a/src/renderer/api/on-api-error.ts b/src/renderer/api/on-api-error.ts deleted file mode 100644 index c3cb2bb7f7..0000000000 --- a/src/renderer/api/on-api-error.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import type { Response } from "node-fetch"; -import type { JsonApiErrorParsed } from "../../common/k8s-api/json-api"; -import { Notifications } from "../components/notifications"; - -export function onApiError(error: JsonApiErrorParsed, res: Response) { - switch (res.status) { - case 403: - error.isUsedForNotification = true; - Notifications.error(error); - break; - } -} diff --git a/src/renderer/api/setup-on-api-errors.injectable.ts b/src/renderer/api/setup-on-api-errors.injectable.ts deleted file mode 100644 index a352293b5e..0000000000 --- a/src/renderer/api/setup-on-api-errors.injectable.ts +++ /dev/null @@ -1,24 +0,0 @@ -/** - * 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 { apiBase } from "../../common/k8s-api"; -import { onApiError } from "./on-api-error"; -import { beforeFrameStartsInjectionToken } from "../before-frame-starts/before-frame-starts-injection-token"; - -const setupOnApiErrorListenersInjectable = getInjectable({ - id: "setup-on-api-error-listeners", - - instantiate: () => ({ - id: "setup-on-api-error-listeners", - run: () => { - apiBase?.onError.addListener(onApiError); - }, - }), - - injectionToken: beforeFrameStartsInjectionToken, - causesSideEffects: true, -}); - -export default setupOnApiErrorListenersInjectable; diff --git a/src/renderer/components/+add-cluster/add-cluster.tsx b/src/renderer/components/+add-cluster/add-cluster.tsx index 503632b51f..1d062dbd31 100644 --- a/src/renderer/components/+add-cluster/add-cluster.tsx +++ b/src/renderer/components/+add-cluster/add-cluster.tsx @@ -10,7 +10,6 @@ import fse from "fs-extra"; import { debounce } from "lodash"; import { action, computed, makeObservable, observable } from "mobx"; import { observer } from "mobx-react"; -import path from "path"; import React from "react"; import * as uuid from "uuid"; import { appEventBus } from "../../../common/app-event-bus/event-bus"; @@ -25,6 +24,8 @@ import { withInjectables } from "@ogre-tools/injectable-react"; import getCustomKubeConfigDirectoryInjectable from "../../../common/app-paths/get-custom-kube-config-directory/get-custom-kube-config-directory.injectable"; import type { NavigateToCatalog } from "../../../common/front-end-routing/routes/catalog/navigate-to-catalog.injectable"; import navigateToCatalogInjectable from "../../../common/front-end-routing/routes/catalog/navigate-to-catalog.injectable"; +import type { GetDirnameOfPath } from "../../../common/path/get-dirname.injectable"; +import getDirnameOfPathInjectable from "../../../common/path/get-dirname.injectable"; interface Option { config: KubeConfig; @@ -34,6 +35,7 @@ interface Option { interface Dependencies { getCustomKubeConfigDirectory: (directoryName: string) => string; navigateToCatalog: NavigateToCatalog; + getDirnameOfPath: GetDirnameOfPath; } function getContexts(config: KubeConfig): Map { @@ -90,7 +92,7 @@ class NonInjectedAddCluster extends React.Component { try { const absPath = this.props.getCustomKubeConfigDirectory(uuid.v4()); - await fse.ensureDir(path.dirname(absPath)); + await fse.ensureDir(this.props.getDirnameOfPath(absPath)); await fse.writeFile(absPath, this.customConfig.trim(), { encoding: "utf-8", mode: 0o600 }); Notifications.ok(`Successfully added ${this.kubeContexts.size} new cluster(s)`); @@ -155,10 +157,8 @@ class NonInjectedAddCluster extends React.Component { export const AddCluster = withInjectables(NonInjectedAddCluster, { getProps: (di) => ({ - getCustomKubeConfigDirectory: di.inject( - getCustomKubeConfigDirectoryInjectable, - ), - + getCustomKubeConfigDirectory: di.inject(getCustomKubeConfigDirectoryInjectable), navigateToCatalog: di.inject(navigateToCatalogInjectable), + getDirnameOfPath: di.inject(getDirnameOfPathInjectable), }), }); diff --git a/src/renderer/components/+catalog/catalog-menu.tsx b/src/renderer/components/+catalog/catalog-menu.tsx index 8a672ddb44..5947f0a301 100644 --- a/src/renderer/components/+catalog/catalog-menu.tsx +++ b/src/renderer/components/+catalog/catalog-menu.tsx @@ -9,23 +9,21 @@ import styles from "./catalog-menu.module.scss"; import React from "react"; import type { TreeItemProps } from "@material-ui/lab"; import { TreeItem, TreeView } from "@material-ui/lab"; -import { catalogCategoryRegistry } from "../../api/catalog-category-registry"; import { Icon } from "../icon"; import { StylesProvider } from "@material-ui/core"; import { cssNames } from "../../utils"; import type { CatalogCategory } from "../../api/catalog-entity"; import { observer } from "mobx-react"; import { CatalogCategoryLabel } from "./catalog-category-label"; +import type { IComputedValue } from "mobx"; +import { withInjectables } from "@ogre-tools/injectable-react"; +import filteredCategoriesInjectable from "../../../common/catalog/filtered-categories.injectable"; export interface CatalogMenuProps { activeTab: string | undefined; onItemClick: (id: string) => void; } -function getCategories() { - return catalogCategoryRegistry.filteredItems; -} - function getCategoryIcon(category: CatalogCategory) { const { icon } = category.metadata ?? {}; @@ -44,44 +42,56 @@ function Item(props: TreeItemProps) { ); } -export const CatalogMenu = observer((props: CatalogMenuProps) => { - return ( - // Overwrite Material UI styles with injectFirst https://material-ui.com/guides/interoperability/#controlling-priority-4 - -
    -
    Catalog
    - } - defaultExpandIcon={} - selected={props.activeTab || "browse"} +interface Dependencies { + filteredCategories: IComputedValue; +} + +const NonInjectedCatalogMenu = observer(({ + activeTab, + filteredCategories, + onItemClick, +}: CatalogMenuProps & Dependencies) => ( + // Overwrite Material UI styles with injectFirst https://material-ui.com/guides/interoperability/#controlling-priority-4 + +
    +
    Catalog
    + } + defaultExpandIcon={} + selected={activeTab || "browse"} + > + onItemClick("*")} /> + Categories
    } + className={cssNames(styles.bordered)} > - props.onItemClick("*")} - /> - Categories
    } - className={cssNames(styles.bordered)} - > - { - getCategories().map(category => ( + { + filteredCategories.get() + .map(category => ( } + label={} data-testid={`${category.getId()}-tab`} - onClick={() => props.onItemClick(category.getId())} - /> + onClick={() => onItemClick(category.getId())} /> )) - } - - -
    - - ); + } + + +
    + +)); + +export const CatalogMenu = withInjectables(NonInjectedCatalogMenu, { + getProps: (di, props) => ({ + ...props, + filteredCategories: di.inject(filteredCategoriesInjectable), + }), }); diff --git a/src/renderer/components/+cluster/cluster-metric-switchers.tsx b/src/renderer/components/+cluster/cluster-metric-switchers.tsx index 716084026d..7c072118dc 100644 --- a/src/renderer/components/+cluster/cluster-metric-switchers.tsx +++ b/src/renderer/components/+cluster/cluster-metric-switchers.tsx @@ -24,7 +24,7 @@ const NonInjectedClusterMetricSwitchers = observer(({ nodeStore, }: Dependencies) => { const { masterNodes, workerNodes } = nodeStore; - const { cpuUsage, memoryUsage } = clusterOverviewStore.metrics; + const { cpuUsage, memoryUsage } = clusterOverviewStore.metrics ?? {}; const hasMasterNodes = masterNodes.length > 0; const hasWorkerNodes = workerNodes.length > 0; const hasCpuMetrics = normalizeMetrics(cpuUsage).data.result[0].values.length > 0; diff --git a/src/renderer/components/+cluster/cluster-metrics.tsx b/src/renderer/components/+cluster/cluster-metrics.tsx index e744383a94..028885e7f3 100644 --- a/src/renderer/components/+cluster/cluster-metrics.tsx +++ b/src/renderer/components/+cluster/cluster-metrics.tsx @@ -26,8 +26,8 @@ interface Dependencies { const NonInjectedClusterMetrics = observer(({ clusterOverviewStore: { metricType, metricNodeRole, getMetricsValues, metricsLoaded, metrics }}: Dependencies) => { const [plugins] = useState([new ZebraStripesPlugin()]); - const { memoryCapacity, cpuCapacity } = getMetricLastPoints(metrics); - const metricValues = getMetricsValues(metrics); + const { memoryCapacity, cpuCapacity } = getMetricLastPoints(metrics ?? {}); + const metricValues = getMetricsValues(metrics ?? {}); const colors = { cpu: "#3D90CE", memory: "#C93DCE" }; const data = metricValues.map(value => ({ x: value[0], diff --git a/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.injectable.ts b/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.injectable.ts index b81cb5c3ac..6389009785 100644 --- a/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.injectable.ts +++ b/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.injectable.ts @@ -12,6 +12,7 @@ import clusterApiInjectable from "../../../../common/k8s-api/endpoints/cluster.a import storesAndApisCanBeCreatedInjectable from "../../../stores-apis-can-be-created.injectable"; import assert from "assert"; import nodeStoreInjectable from "../../+nodes/store.injectable"; +import requestClusterMetricsByNodeNamesInjectable from "../../../../common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable"; const clusterOverviewStoreInjectable = getInjectable({ id: "cluster-overview-store", @@ -30,6 +31,7 @@ const clusterOverviewStoreInjectable = getInjectable({ }, ), nodeStore: di.inject(nodeStoreInjectable), + requestClusterMetricsByNodeNames: di.inject(requestClusterMetricsByNodeNamesInjectable), }, clusterApi); }, injectionToken: kubeObjectStoreInjectionToken, diff --git a/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.ts b/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.ts index d3f47cb430..2669cb71a6 100644 --- a/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.ts +++ b/src/renderer/components/+cluster/cluster-overview-store/cluster-overview-store.ts @@ -6,11 +6,12 @@ import { action, observable, reaction, when, makeObservable } from "mobx"; import { KubeObjectStore } from "../../../../common/k8s-api/kube-object.store"; import type { Cluster, ClusterApi } from "../../../../common/k8s-api/endpoints"; -import { getMetricsByNodeNames, type ClusterMetricData } from "../../../../common/k8s-api/endpoints"; import type { StorageLayer } from "../../../utils"; import { autoBind } from "../../../utils"; -import { type IMetricsReqParams, normalizeMetrics } from "../../../../common/k8s-api/endpoints/metrics.api"; import type { NodeStore } from "../../+nodes/store"; +import type { ClusterMetricData, RequestClusterMetricsByNodeNames } from "../../../../common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable"; +import type { RequestMetricsParams } from "../../../../common/k8s-api/endpoints/metrics.api/request-metrics.injectable"; +import { normalizeMetrics } from "../../../../common/k8s-api/endpoints/metrics.api"; export enum MetricType { MEMORY = "memory", @@ -30,11 +31,15 @@ export interface ClusterOverviewStorageState { interface ClusterOverviewStoreDependencies { readonly storage: StorageLayer; readonly nodeStore: NodeStore; + requestClusterMetricsByNodeNames: RequestClusterMetricsByNodeNames; } export class ClusterOverviewStore extends KubeObjectStore implements ClusterOverviewStorageState { - @observable metrics: Partial = {}; - @observable metricsLoaded = false; + @observable metrics: ClusterMetricData | undefined = undefined; + + get metricsLoaded() { + return !!this.metrics; + } get metricType(): MetricType { return this.dependencies.storage.get().metricType; @@ -64,9 +69,10 @@ export class ClusterOverviewStore extends KubeObjectStore i // TODO: refactor, seems not a correct place to be // auto-refresh metrics on user-action reaction(() => this.metricNodeRole, () => { - if (!this.metricsLoaded) return; - this.resetMetrics(); - this.loadMetrics(); + if (this.metrics) { + this.resetMetrics(); + this.loadMetrics(); + } }); // check which node type to select @@ -79,13 +85,12 @@ export class ClusterOverviewStore extends KubeObjectStore i } @action - async loadMetrics(params?: IMetricsReqParams) { + async loadMetrics(params?: RequestMetricsParams) { await when(() => this.dependencies.nodeStore.isLoaded); const { masterNodes, workerNodes } = this.dependencies.nodeStore; const nodes = this.metricNodeRole === MetricNodeRole.MASTER && masterNodes.length ? masterNodes : workerNodes; - this.metrics = await getMetricsByNodeNames(nodes.map(node => node.getName()), params); - this.metricsLoaded = true; + this.metrics = await this.dependencies.requestClusterMetricsByNodeNames(nodes.map(node => node.getName()), params); } getMetricsValues(source: Partial): [number, string][] { @@ -101,8 +106,7 @@ export class ClusterOverviewStore extends KubeObjectStore i @action resetMetrics() { - this.metrics = {}; - this.metricsLoaded = false; + this.metrics = undefined; } reset() { diff --git a/src/renderer/components/+cluster/cluster-pie-charts.tsx b/src/renderer/components/+cluster/cluster-pie-charts.tsx index 6d633c9eb9..fc18e26d18 100644 --- a/src/renderer/components/+cluster/cluster-pie-charts.tsx +++ b/src/renderer/components/+cluster/cluster-pie-charts.tsx @@ -23,6 +23,7 @@ import clusterOverviewStoreInjectable from "./cluster-overview-store/cluster-ove import nodeStoreInjectable from "../+nodes/store.injectable"; import type { IComputedValue } from "mobx"; import activeThemeInjectable from "../../themes/active.injectable"; +import type { ClusterMetricData } from "../../../common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable"; function createLabels(rawLabelData: [string, number | undefined][]): string[] { return rawLabelData.map(([key, value]) => `${key}: ${value?.toFixed(2) || "N/A"}`); @@ -48,16 +49,32 @@ const NonInjectedClusterPieCharts = observer(({ ); }; - const renderCharts = () => { - const data = getMetricLastPoints(clusterOverviewStore.metrics); - const { memoryUsage, memoryRequests, memoryAllocatableCapacity, memoryCapacity, memoryLimits } = data; - const { cpuUsage, cpuRequests, cpuAllocatableCapacity, cpuCapacity, cpuLimits } = data; - const { podUsage, podAllocatableCapacity, podCapacity } = data; + const renderCharts = (lastPoints: Partial>) => { + const { + memoryUsage, memoryRequests, memoryAllocatableCapacity, memoryCapacity, memoryLimits, + cpuUsage, cpuRequests, cpuAllocatableCapacity, cpuCapacity, cpuLimits, + podUsage, podAllocatableCapacity, podCapacity, + } = lastPoints; + + if ( + typeof cpuCapacity !== "number" || + typeof cpuAllocatableCapacity !== "number" || + typeof cpuLimits !== "number" || + typeof podCapacity !== "number" || + typeof podAllocatableCapacity !== "number" || + typeof memoryAllocatableCapacity !== "number" || + typeof memoryCapacity !== "number" || + typeof memoryLimits !== "number" || + typeof memoryUsage !== "number" || + typeof memoryRequests !== "number" + ) { + return null; + } + const cpuLimitsOverload = cpuLimits > cpuAllocatableCapacity; const memoryLimitsOverload = memoryLimits > memoryAllocatableCapacity; const defaultColor = activeTheme.get().colors.pieChartDefaultColor; - if (!memoryCapacity || !cpuCapacity || !podCapacity || !memoryAllocatableCapacity || !cpuAllocatableCapacity || !podAllocatableCapacity) return null; const cpuData: PieChartData = { datasets: [ { @@ -218,7 +235,7 @@ const NonInjectedClusterPieCharts = observer(({ ); }; - const renderContent = ({ metricNodeRole, metricsLoaded }: ClusterOverviewStore) => { + const renderContent = ({ metricNodeRole, metrics }: ClusterOverviewStore) => { const { masterNodes, workerNodes } = nodeStore; const nodes = metricNodeRole === MetricNodeRole.MASTER ? masterNodes : workerNodes; @@ -231,14 +248,16 @@ const NonInjectedClusterPieCharts = observer(({ ); } - if (!metricsLoaded) { + if (!metrics) { return (
    ); } - const { memoryCapacity, cpuCapacity, podCapacity } = getMetricLastPoints(clusterOverviewStore.metrics); + + const lastPoints = getMetricLastPoints(metrics); + const { memoryCapacity, cpuCapacity, podCapacity } = lastPoints; if (!memoryCapacity || !cpuCapacity || !podCapacity) { return ( @@ -248,7 +267,7 @@ const NonInjectedClusterPieCharts = observer(({ ); } - return renderCharts(); + return renderCharts(lastPoints); }; return ( diff --git a/src/renderer/components/+extensions/__tests__/extensions.test.tsx b/src/renderer/components/+extensions/__tests__/extensions.test.tsx index 5de9e15f1f..52843d8b3d 100644 --- a/src/renderer/components/+extensions/__tests__/extensions.test.tsx +++ b/src/renderer/components/+extensions/__tests__/extensions.test.tsx @@ -5,14 +5,11 @@ import "@testing-library/jest-dom/extend-expect"; import { fireEvent, screen, waitFor } from "@testing-library/react"; -import fse from "fs-extra"; import React from "react"; import type { ExtensionDiscovery } from "../../../../extensions/extension-discovery/extension-discovery"; import type { ExtensionLoader } from "../../../../extensions/extension-loader"; import { ConfirmDialog } from "../../confirm-dialog"; import { Extensions } from "../extensions"; -import mockFs from "mock-fs"; -import { mockWindow } from "../../../../../__mocks__/windowMock"; import { getDiForUnitTesting } from "../../../getDiForUnitTesting"; import extensionLoaderInjectable from "../../../../extensions/extension-loader/extension-loader.injectable"; import type { DiRender } from "../../test-utils/renderFor"; @@ -20,18 +17,15 @@ import { renderFor } from "../../test-utils/renderFor"; import extensionDiscoveryInjectable from "../../../../extensions/extension-discovery/extension-discovery.injectable"; import directoryForUserDataInjectable from "../../../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable"; import directoryForDownloadsInjectable from "../../../../common/app-paths/directory-for-downloads/directory-for-downloads.injectable"; -import getConfigurationFileModelInjectable from "../../../../common/get-configuration-file-model/get-configuration-file-model.injectable"; import assert from "assert"; -import type { InstallFromInput } from "../install-from-input/install-from-input"; -import installFromInputInjectable from "../install-from-input/install-from-input.injectable"; +import type { InstallExtensionFromInput } from "../install-extension-from-input.injectable"; +import installExtensionFromInputInjectable from "../install-extension-from-input.injectable"; import type { ExtensionInstallationStateStore } from "../../../../extensions/extension-installation-state-store/extension-installation-state-store"; import extensionInstallationStateStoreInjectable from "../../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable"; import { observable, when } from "mobx"; +import type { DeleteFile } from "../../../../common/fs/delete-file.injectable"; +import deleteFileInjectable from "../../../../common/fs/delete-file.injectable"; -mockWindow(); - -jest.setTimeout(30000); -jest.mock("fs-extra"); jest.mock("../../notifications"); jest.mock("../../../../common/utils/downloadFile", () => ({ @@ -52,9 +46,10 @@ jest.mock("../../../../common/utils/tar"); describe("Extensions", () => { let extensionLoader: ExtensionLoader; let extensionDiscovery: ExtensionDiscovery; - let installFromInput: jest.MockedFunction; + let installExtensionFromInput: jest.MockedFunction; let extensionInstallationStateStore: ExtensionInstallationStateStore; let render: DiRender; + let deleteFileMock: jest.MockedFunction; beforeEach(() => { const di = getDiForUnitTesting({ doGeneralOverrides: true }); @@ -62,17 +57,13 @@ describe("Extensions", () => { di.override(directoryForUserDataInjectable, () => "some-directory-for-user-data"); di.override(directoryForDownloadsInjectable, () => "some-directory-for-downloads"); - di.permitSideEffects(getConfigurationFileModelInjectable); - - mockFs({ - "some-directory-for-user-data": {}, - }); - render = renderFor(di); - installFromInput = jest.fn(); + installExtensionFromInput = jest.fn(); + di.override(installExtensionFromInputInjectable, () => installExtensionFromInput); - di.override(installFromInputInjectable, () => installFromInput); + deleteFileMock = jest.fn(); + di.override(deleteFileInjectable, () => deleteFileMock); extensionLoader = di.inject(extensionLoaderInjectable); extensionDiscovery = di.inject(extensionDiscoveryInjectable); @@ -95,10 +86,6 @@ describe("Extensions", () => { extensionDiscovery.uninstallExtension = jest.fn(() => Promise.resolve()); }); - afterEach(() => { - mockFs.restore(); - }); - it("disables uninstall and disable buttons while uninstalling", async () => { extensionDiscovery.isLoaded = true; @@ -138,8 +125,8 @@ describe("Extensions", () => { const resolveInstall = observable.box(false); - (fse.unlink as jest.MockedFunction).mockReturnValue(Promise.resolve()); - installFromInput.mockImplementation(async (input) => { + deleteFileMock.mockReturnValue(Promise.resolve()); + installExtensionFromInput.mockImplementation(async (input) => { expect(input).toBe("https://test.extensionurl/package.tgz"); const clear = extensionInstallationStateStore.startPreInstall(); diff --git a/src/renderer/components/+extensions/attempt-install-by-info.injectable.tsx b/src/renderer/components/+extensions/attempt-install-by-info.injectable.tsx index dd320407a5..36f6b2afc4 100644 --- a/src/renderer/components/+extensions/attempt-install-by-info.injectable.tsx +++ b/src/renderer/components/+extensions/attempt-install-by-info.injectable.tsx @@ -2,22 +2,18 @@ * Copyright (c) OpenLens Authors. All rights reserved. * Licensed under MIT License. See LICENSE in root directory for more information. */ -import type { ExtendableDisposer } from "../../../common/utils"; import { downloadFile, downloadJson } from "../../../common/utils"; import { Notifications } from "../notifications"; import React from "react"; -import path from "path"; import { SemVer } from "semver"; import URLParse from "url-parse"; -import type { InstallRequest } from "./attempt-install/install-request"; -import type { ExtensionInstallationStateStore } from "../../../extensions/extension-installation-state-store/extension-installation-state-store"; -import type { Confirm } from "../confirm-dialog/confirm.injectable"; import { getInjectable } from "@ogre-tools/injectable"; import attemptInstallInjectable from "./attempt-install/attempt-install.injectable"; import getBaseRegistryUrlInjectable from "./get-base-registry-url/get-base-registry-url.injectable"; import extensionInstallationStateStoreInjectable from "../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable"; import confirmInjectable from "../confirm-dialog/confirm.injectable"; import { reduce } from "lodash"; +import getBasenameOfPathInjectable from "../../../common/path/get-basename.injectable"; export interface ExtensionInfo { name: string; @@ -27,126 +23,113 @@ export interface ExtensionInfo { export type AttemptInstallByInfo = (info: ExtensionInfo) => Promise; -interface Dependencies { - attemptInstall: (request: InstallRequest, d: ExtendableDisposer) => Promise; - getBaseRegistryUrl: () => Promise; - extensionInstallationStateStore: ExtensionInstallationStateStore; - confirm: Confirm; -} +const attemptInstallByInfoInjectable = getInjectable({ + id: "attempt-install-by-info", + instantiate: (di): AttemptInstallByInfo => { + const attemptInstall = di.inject(attemptInstallInjectable); + const getBaseRegistryUrl = di.inject(getBaseRegistryUrlInjectable); + const extensionInstallationStateStore = di.inject(extensionInstallationStateStoreInjectable); + const confirm = di.inject(confirmInjectable); + const getBasenameOfPath = di.inject(getBasenameOfPathInjectable); -const attemptInstallByInfo = ({ - attemptInstall, - getBaseRegistryUrl, - extensionInstallationStateStore, - confirm, -}: Dependencies): AttemptInstallByInfo => ( - async (info) => { - const { name, version, requireConfirmation = false } = info; - const disposer = extensionInstallationStateStore.startPreInstall(); - const baseUrl = await getBaseRegistryUrl(); - const registryUrl = new URLParse(baseUrl).set("pathname", name).toString(); - let json: any; - let finalVersion = version; + return async (info) => { + const { name, version, requireConfirmation = false } = info; + const disposer = extensionInstallationStateStore.startPreInstall(); + const baseUrl = await getBaseRegistryUrl(); + const registryUrl = new URLParse(baseUrl).set("pathname", name).toString(); + let json: any; + let finalVersion = version; - try { - json = await downloadJson({ url: registryUrl }).promise; + try { + json = await downloadJson({ url: registryUrl }).promise; - if (!json || json.error || typeof json.versions !== "object" || !json.versions) { - const message = json?.error ? `: ${json.error}` : ""; + if (!json || json.error || typeof json.versions !== "object" || !json.versions) { + const message = json?.error ? `: ${json.error}` : ""; - Notifications.error(`Failed to get registry information for that extension${message}`); - - return disposer(); - } - } catch (error) { - if (error instanceof SyntaxError) { - // assume invalid JSON - console.warn("Set registry has invalid json", { url: baseUrl }, error); - Notifications.error("Failed to get valid registry information for that extension. Registry did not return valid JSON"); - } else { - console.error("Failed to download registry information", error); - Notifications.error(`Failed to get valid registry information for that extension. ${error}`); - } - - return disposer(); - } - - if (version) { - if (!json.versions[version]) { - if (json["dist-tags"][version]) { - finalVersion = json["dist-tags"][version]; - } else { - Notifications.error(( -

    - {"The "} - {name} - {" extension does not have a version or tag "} - {version} - . -

    - )); + Notifications.error(`Failed to get registry information for that extension${message}`); return disposer(); } + } catch (error) { + if (error instanceof SyntaxError) { + // assume invalid JSON + console.warn("Set registry has invalid json", { url: baseUrl }, error); + Notifications.error("Failed to get valid registry information for that extension. Registry did not return valid JSON"); + } else { + console.error("Failed to download registry information", error); + Notifications.error(`Failed to get valid registry information for that extension. ${error}`); + } + + return disposer(); } - } else { - const versions = Object.keys(json.versions) - .map(version => new SemVer(version, { loose: true })) + + if (version) { + if (!json.versions[version]) { + if (json["dist-tags"][version]) { + finalVersion = json["dist-tags"][version]; + } else { + Notifications.error(( +

    + {"The "} + {name} + {" extension does not have a version or tag "} + {version} + . +

    + )); + + return disposer(); + } + } + } else { + const versions = Object.keys(json.versions) + .map(version => new SemVer(version, { loose: true })) // ignore pre-releases for auto picking the version - .filter(version => version.prerelease.length === 0); + .filter(version => version.prerelease.length === 0); - const latestVersion = reduce(versions, (prev, curr) => prev.compareMain(curr) === -1 ? curr : prev); + const latestVersion = reduce(versions, (prev, curr) => prev.compareMain(curr) === -1 ? curr : prev); - if (!latestVersion) { - console.error("No versions supplied for that extension", { name }); - Notifications.error(`No versions found for ${name}`); + if (!latestVersion) { + console.error("No versions supplied for that extension", { name }); + Notifications.error(`No versions found for ${name}`); - return disposer(); + return disposer(); + } + + finalVersion = latestVersion.format(); } - finalVersion = latestVersion.format(); - } + if (requireConfirmation) { + const proceed = await confirm({ + message: ( +

    + Are you sure you want to install + {" "} + + {name} + @ + {finalVersion} + + ? +

    + ), + labelCancel: "Cancel", + labelOk: "Install", + }); - if (requireConfirmation) { - const proceed = await confirm({ - message: ( -

    - Are you sure you want to install - {" "} - - {name} - @ - {finalVersion} - - ? -

    - ), - labelCancel: "Cancel", - labelOk: "Install", - }); - - if (!proceed) { - return disposer(); + if (!proceed) { + return disposer(); + } } - } - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - const url = json.versions[finalVersion!].dist.tarball; - const fileName = path.basename(url); - const { promise: dataP } = downloadFile({ url, timeout: 10 * 60 * 1000 }); + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const url = json.versions[finalVersion!].dist.tarball; + const fileName = getBasenameOfPath(url); + const { promise: dataP } = downloadFile({ url, timeout: 10 * 60 * 1000 }); - return attemptInstall({ fileName, dataP }, disposer); - } -); - -const attemptInstallByInfoInjectable = getInjectable({ - id: "attempt-install-by-info", - instantiate: (di) => attemptInstallByInfo({ - attemptInstall: di.inject(attemptInstallInjectable), - getBaseRegistryUrl: di.inject(getBaseRegistryUrlInjectable), - extensionInstallationStateStore: di.inject(extensionInstallationStateStoreInjectable), - confirm: di.inject(confirmInjectable), - }), + return attemptInstall({ fileName, dataP }, disposer); + }; + }, }); export default attemptInstallByInfoInjectable; diff --git a/src/renderer/components/+extensions/attempt-install/attempt-install.tsx b/src/renderer/components/+extensions/attempt-install/attempt-install.tsx index 9d83862357..de8c968201 100644 --- a/src/renderer/components/+extensions/attempt-install/attempt-install.tsx +++ b/src/renderer/components/+extensions/attempt-install/attempt-install.tsx @@ -2,12 +2,8 @@ * Copyright (c) OpenLens Authors. All rights reserved. * Licensed under MIT License. See LICENSE in root directory for more information. */ -import type { - Disposer, - ExtendableDisposer } from "../../../../common/utils"; -import { - disposer, -} from "../../../../common/utils"; +import type { ExtendableDisposer } from "../../../../common/utils"; +import { disposer } from "../../../../common/utils"; import { Notifications } from "../../notifications"; import { Button } from "../../button"; import type { ExtensionLoader } from "../../../../extensions/extension-loader"; @@ -15,29 +11,19 @@ import type { LensExtensionId } from "../../../../extensions/lens-extension"; import React from "react"; import { remove as removeDir } from "fs-extra"; import { shell } from "electron"; -import type { InstallRequestValidated } from "./create-temp-files-and-validate/create-temp-files-and-validate"; import type { InstallRequest } from "./install-request"; -import type { - ExtensionInstallationStateStore } from "../../../../extensions/extension-installation-state-store/extension-installation-state-store"; -import { - ExtensionInstallationState, -} from "../../../../extensions/extension-installation-state-store/extension-installation-state-store"; +import type { ExtensionInstallationStateStore } from "../../../../extensions/extension-installation-state-store/extension-installation-state-store"; +import { ExtensionInstallationState } from "../../../../extensions/extension-installation-state-store/extension-installation-state-store"; +import type { UnpackExtension } from "./unpack-extension/unpack-extension.injectable"; +import type { CreateTempFilesAndValidate } from "./create-temp-files-and-validate/create-temp-files-and-validate.injectable"; +import type { GetExtensionDestFolder } from "./get-extension-dest-folder/get-extension-dest-folder.injectable"; interface Dependencies { extensionLoader: ExtensionLoader; uninstallExtension: (id: LensExtensionId) => Promise; - - unpackExtension: ( - request: InstallRequestValidated, - disposeDownloading: Disposer, - ) => Promise; - - createTempFilesAndValidate: ( - installRequest: InstallRequest, - ) => Promise; - - getExtensionDestFolder: (name: string) => string; - + unpackExtension: UnpackExtension; + createTempFilesAndValidate: CreateTempFilesAndValidate; + getExtensionDestFolder: GetExtensionDestFolder; extensionInstallationStateStore: ExtensionInstallationStateStore; } @@ -51,6 +37,8 @@ export const attemptInstall = extensionInstallationStateStore, }: Dependencies) => async (request: InstallRequest, d?: ExtendableDisposer): Promise => { + console.log("Attempting to install extension"); + const dispose = disposer( extensionInstallationStateStore.startPreInstall(), d, diff --git a/src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.injectable.tsx b/src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.injectable.tsx index d0d71e6fbe..951c45d246 100644 --- a/src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.injectable.tsx +++ b/src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.injectable.tsx @@ -3,16 +3,102 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import { createTempFilesAndValidate } from "./create-temp-files-and-validate"; import extensionDiscoveryInjectable from "../../../../../extensions/extension-discovery/extension-discovery.injectable"; +import React from "react"; +import type { LensExtensionId, LensExtensionManifest } from "../../../../../extensions/lens-extension"; +import { getMessageFromError } from "../../get-message-from-error/get-message-from-error"; +import type { InstallRequest } from "../install-request"; +import { validatePackage } from "../validate-package/validate-package"; +import joinPathsInjectable from "../../../../../common/path/join-paths.injectable"; +import tempDirectoryPathInjectable from "../../../../../common/os/temp-directory-path.injectable"; +import ensureDirInjectable from "../../../../../common/fs/ensure-dir.injectable"; +import writeFileInjectable from "../../../../../common/fs/write-file.injectable"; +import loggerInjectable from "../../../../../common/logger.injectable"; +import showErrorNotificationInjectable from "../../../notifications/show-error-notification.injectable"; + +export interface InstallRequestValidated { + fileName: string; + data: Buffer; + id: LensExtensionId; + manifest: LensExtensionManifest; + tempFile: string; // temp system path to packed extension for unpacking +} + +export type CreateTempFilesAndValidate = (req: InstallRequest) => Promise; const createTempFilesAndValidateInjectable = getInjectable({ id: "create-temp-files-and-validate", - instantiate: (di) => - createTempFilesAndValidate({ - extensionDiscovery: di.inject(extensionDiscoveryInjectable), - }), + instantiate: (di) => { + const extensionDiscovery = di.inject(extensionDiscoveryInjectable); + const joinPaths = di.inject(joinPathsInjectable); + const tempDirectoryPath = di.inject(tempDirectoryPathInjectable); + const ensureDir = di.inject(ensureDirInjectable); + const writeFile = di.inject(writeFileInjectable); + const logger = di.inject(loggerInjectable); + const showErrorNotification = di.inject(showErrorNotificationInjectable); + + const baseTempExtensionsDirectory = joinPaths(tempDirectoryPath, "lens-extensions"); + const getExtensionPackageTemp = (fileName: string) => joinPaths(baseTempExtensionsDirectory, fileName); + + return async ({ + fileName, + dataP, + }: InstallRequest): Promise => { + // copy files to temp + await ensureDir(baseTempExtensionsDirectory); + + // validate packages + const tempFile = getExtensionPackageTemp(fileName); + + try { + const data = await dataP; + + if (!data) { + return null; + } + + await writeFile(tempFile, data); + logger.info("validating package", tempFile); + const manifest = await validatePackage(tempFile); + const id = joinPaths( + extensionDiscovery.nodeModulesPath, + manifest.name, + "package.json", + ); + + return { + fileName, + data, + manifest, + tempFile, + id, + }; + } catch (error) { + const message = getMessageFromError(error); + + logger.info( + `[EXTENSION-INSTALLATION]: installing ${fileName} has failed: ${message}`, + { error }, + ); + showErrorNotification( +
    +

    + {"Installing "} + {fileName} + {" has failed, skipping."} +

    +

    + {"Reason: "} + {message} +

    +
    , + ); + } + + return null; + }; + }, }); export default createTempFilesAndValidateInjectable; diff --git a/src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.tsx b/src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.tsx deleted file mode 100644 index b3df89ca92..0000000000 --- a/src/renderer/components/+extensions/attempt-install/create-temp-files-and-validate/create-temp-files-and-validate.tsx +++ /dev/null @@ -1,94 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import { validatePackage } from "../validate-package/validate-package"; -import type { ExtensionDiscovery } from "../../../../../extensions/extension-discovery/extension-discovery"; -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 os from "os"; -import type { - LensExtensionId, - LensExtensionManifest, -} from "../../../../../extensions/lens-extension"; -import type { InstallRequest } from "../install-request"; - -export interface InstallRequestValidated { - fileName: string; - data: Buffer; - id: LensExtensionId; - manifest: LensExtensionManifest; - tempFile: string; // temp system path to packed extension for unpacking -} - -interface Dependencies { - extensionDiscovery: ExtensionDiscovery; -} - -export const createTempFilesAndValidate = - ({ extensionDiscovery }: Dependencies) => - async ({ - fileName, - dataP, - }: InstallRequest): Promise => { - // copy files to temp - await fse.ensureDir(getExtensionPackageTemp()); - - // validate packages - const tempFile = getExtensionPackageTemp(fileName); - - try { - const data = await dataP; - - if (!data) { - return null; - } - - await fse.writeFile(tempFile, data); - const manifest = await validatePackage(tempFile); - const id = path.join( - extensionDiscovery.nodeModulesPath, - manifest.name, - "package.json", - ); - - return { - fileName, - data, - manifest, - tempFile, - id, - }; - } catch (error) { - const message = getMessageFromError(error); - - logger.info( - `[EXTENSION-INSTALLATION]: installing ${fileName} has failed: ${message}`, - { error }, - ); - Notifications.error( -
    -

    - {"Installing "} - {fileName} - {" has failed, skipping."} -

    -

    - {"Reason: "} - {message} -

    -
    , - ); - } - - return null; - }; - - -function getExtensionPackageTemp(fileName = "") { - return path.join(os.tmpdir(), "lens-extensions", fileName); -} diff --git a/src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.injectable.ts b/src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.injectable.ts index 3062439e1b..2c46b595a4 100644 --- a/src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.injectable.ts +++ b/src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.injectable.ts @@ -3,18 +3,21 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; - +import joinPathsInjectable from "../../../../../common/path/join-paths.injectable"; import extensionDiscoveryInjectable from "../../../../../extensions/extension-discovery/extension-discovery.injectable"; +import { sanitizeExtensionName } from "../../../../../extensions/lens-extension"; -import { getExtensionDestFolder } from "./get-extension-dest-folder"; +export type GetExtensionDestFolder = (extensionName: string) => string; const getExtensionDestFolderInjectable = getInjectable({ id: "get-extension-dest-folder", - instantiate: (di) => - getExtensionDestFolder({ - extensionDiscovery: di.inject(extensionDiscoveryInjectable), - }), + instantiate: (di): GetExtensionDestFolder => { + const extensionDiscovery = di.inject(extensionDiscoveryInjectable); + const joinPaths = di.inject(joinPathsInjectable); + + return (name) => joinPaths(extensionDiscovery.localFolderPath, sanitizeExtensionName(name)); + }, }); export default getExtensionDestFolderInjectable; diff --git a/src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.ts b/src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.ts deleted file mode 100644 index 52e06d2cca..0000000000 --- a/src/renderer/components/+extensions/attempt-install/get-extension-dest-folder/get-extension-dest-folder.ts +++ /dev/null @@ -1,16 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import type { ExtensionDiscovery } from "../../../../../extensions/extension-discovery/extension-discovery"; -import { sanitizeExtensionName } from "../../../../../extensions/lens-extension"; -import path from "path"; - -interface Dependencies { - extensionDiscovery: ExtensionDiscovery; -} - -export const getExtensionDestFolder = - ({ extensionDiscovery }: Dependencies) => - (name: string) => - path.join(extensionDiscovery.localFolderPath, sanitizeExtensionName(name)); diff --git a/src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.injectable.tsx b/src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.injectable.tsx index ebbc3639c5..9a10062f7e 100644 --- a/src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.injectable.tsx +++ b/src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.injectable.tsx @@ -2,23 +2,129 @@ * Copyright (c) OpenLens Authors. All rights reserved. * Licensed under MIT License. See LICENSE in root directory for more information. */ +import React from "react"; import { getInjectable } from "@ogre-tools/injectable"; -import { unpackExtension } from "./unpack-extension"; import extensionLoaderInjectable from "../../../../../extensions/extension-loader/extension-loader.injectable"; -import getExtensionDestFolderInjectable - from "../get-extension-dest-folder/get-extension-dest-folder.injectable"; -import extensionInstallationStateStoreInjectable - from "../../../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable"; +import getExtensionDestFolderInjectable from "../get-extension-dest-folder/get-extension-dest-folder.injectable"; +import extensionInstallationStateStoreInjectable from "../../../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable"; +import type { InstallRequestValidated } from "../create-temp-files-and-validate/create-temp-files-and-validate.injectable"; +import type { Disposer } from "../../../../utils"; +import { noop } from "../../../../utils"; +import { extensionDisplayName } from "../../../../../extensions/lens-extension"; +import joinPathsInjectable from "../../../../../common/path/join-paths.injectable"; +import loggerInjectable from "../../../../../common/logger.injectable"; +import { when } from "mobx"; +import { getMessageFromError } from "../../get-message-from-error/get-message-from-error"; +import showSuccessNotificationInjectable from "../../../notifications/show-success-notification.injectable"; +import showErrorNotificationInjectable from "../../../notifications/show-error-notification.injectable"; +import getDirnameOfPathInjectable from "../../../../../common/path/get-dirname.injectable"; +import getBasenameOfPathInjectable from "../../../../../common/path/get-basename.injectable"; +import extractTarInjectable from "../../../../../common/fs/extract-tar.injectable"; +import ensureDirInjectable from "../../../../../common/fs/ensure-dir.injectable"; +import removePathInjectable from "../../../../../common/fs/remove-path.injectable"; +import deleteFileInjectable from "../../../../../common/fs/delete-file.injectable"; +import readDirectoryInjectable from "../../../../../common/fs/read-directory.injectable"; +import moveInjectable from "../../../../../common/fs/move.injectable"; + +export type UnpackExtension = (request: InstallRequestValidated, disposeDownloading?: Disposer) => Promise; const unpackExtensionInjectable = getInjectable({ id: "unpack-extension", - instantiate: (di) => - unpackExtension({ - extensionLoader: di.inject(extensionLoaderInjectable), - getExtensionDestFolder: di.inject(getExtensionDestFolderInjectable), - extensionInstallationStateStore: di.inject(extensionInstallationStateStoreInjectable), - }), + instantiate: (di): UnpackExtension => { + const extensionLoader = di.inject(extensionLoaderInjectable); + const getExtensionDestFolder = di.inject(getExtensionDestFolderInjectable); + const extensionInstallationStateStore = di.inject(extensionInstallationStateStoreInjectable); + const joinPaths = di.inject(joinPathsInjectable); + const getDirnameOfPath = di.inject(getDirnameOfPathInjectable); + const getBasenameOfPath = di.inject(getBasenameOfPathInjectable); + const logger = di.inject(loggerInjectable); + const showOkNotification = di.inject(showSuccessNotificationInjectable); + const showErrorNotification = di.inject(showErrorNotificationInjectable); + const extractTar = di.inject(extractTarInjectable); + const ensureDir = di.inject(ensureDirInjectable); + const removePath = di.inject(removePathInjectable); + const deleteFile = di.inject(deleteFileInjectable); + const readDirectory = di.inject(readDirectoryInjectable); + const move = di.inject(moveInjectable); + + return async (request, disposeDownloading) => { + const { + id, + fileName, + tempFile, + manifest: { name, version }, + } = request; + + extensionInstallationStateStore.setInstalling(id); + disposeDownloading?.(); + + const displayName = extensionDisplayName(name, version); + const extensionFolder = getExtensionDestFolder(name); + const unpackingTempFolder = joinPaths( + getDirnameOfPath(tempFile), + `${getBasenameOfPath(tempFile)}-unpacked`, + ); + + logger.info(`Unpacking extension ${displayName}`, { fileName, tempFile }); + + try { + // extract to temp folder first + await removePath(unpackingTempFolder).catch(noop); + await ensureDir(unpackingTempFolder); + await extractTar(tempFile, { cwd: unpackingTempFolder }); + + // move contents to extensions folder + const unpackedFiles = await readDirectory(unpackingTempFolder); + let unpackedRootFolder = unpackingTempFolder; + + if (unpackedFiles.length === 1) { + // check if %extension.tgz was packed with single top folder, + // e.g. "npm pack %ext_name" downloads file with "package" root folder within tarball + unpackedRootFolder = joinPaths(unpackingTempFolder, unpackedFiles[0]); + } + + await ensureDir(extensionFolder); + await move(unpackedRootFolder, extensionFolder, { overwrite: true }); + + // wait for the loader has actually install it + await when(() => extensionLoader.userExtensions.has(id)); + + // Enable installed extensions by default. + extensionLoader.setIsEnabled(id, true); + + showOkNotification( +

    + {"Extension "} + {displayName} + {" successfully installed!"} +

    , + ); + } catch (error) { + const message = getMessageFromError(error); + + logger.info( + `[EXTENSION-INSTALLATION]: installing ${request.fileName} has failed: ${message}`, + { error }, + ); + showErrorNotification( +

    + {"Installing extension "} + {displayName} + {" has failed: "} + {message} +

    , + ); + } finally { + // Remove install state once finished + extensionInstallationStateStore.clearInstalling(id); + + // clean up + removePath(unpackingTempFolder).catch(noop); + deleteFile(tempFile).catch(noop); + } + }; + }, }); export default unpackExtensionInjectable; diff --git a/src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.tsx b/src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.tsx deleted file mode 100644 index 44b02f6351..0000000000 --- a/src/renderer/components/+extensions/attempt-install/unpack-extension/unpack-extension.tsx +++ /dev/null @@ -1,106 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import type { InstallRequestValidated } from "../create-temp-files-and-validate/create-temp-files-and-validate"; -import type { Disposer } from "../../../../../common/utils"; -import { extractTar, noop } from "../../../../../common/utils"; -import { extensionDisplayName } from "../../../../../extensions/lens-extension"; -import logger from "../../../../../main/logger"; -import type { ExtensionLoader } from "../../../../../extensions/extension-loader"; -import { Notifications } from "../../../notifications"; -import { getMessageFromError } from "../../get-message-from-error/get-message-from-error"; -import path from "path"; -import fse from "fs-extra"; -import { when } from "mobx"; -import React from "react"; -import type { ExtensionInstallationStateStore } from "../../../../../extensions/extension-installation-state-store/extension-installation-state-store"; - -interface Dependencies { - extensionLoader: ExtensionLoader; - getExtensionDestFolder: (name: string) => string; - extensionInstallationStateStore: ExtensionInstallationStateStore; -} - -export const unpackExtension = - ({ - extensionLoader, - getExtensionDestFolder, - extensionInstallationStateStore, - }: Dependencies) => - async (request: InstallRequestValidated, disposeDownloading?: Disposer) => { - const { - id, - fileName, - tempFile, - manifest: { name, version }, - } = request; - - extensionInstallationStateStore.setInstalling(id); - disposeDownloading?.(); - - const displayName = extensionDisplayName(name, version); - const extensionFolder = getExtensionDestFolder(name); - const unpackingTempFolder = path.join( - path.dirname(tempFile), - `${path.basename(tempFile)}-unpacked`, - ); - - logger.info(`Unpacking extension ${displayName}`, { fileName, tempFile }); - - try { - // extract to temp folder first - await fse.remove(unpackingTempFolder).catch(noop); - await fse.ensureDir(unpackingTempFolder); - await extractTar(tempFile, { cwd: unpackingTempFolder }); - - // move contents to extensions folder - const unpackedFiles = await fse.readdir(unpackingTempFolder); - let unpackedRootFolder = unpackingTempFolder; - - if (unpackedFiles.length === 1) { - // check if %extension.tgz was packed with single top folder, - // e.g. "npm pack %ext_name" downloads file with "package" root folder within tarball - unpackedRootFolder = path.join(unpackingTempFolder, unpackedFiles[0]); - } - - await fse.ensureDir(extensionFolder); - await fse.move(unpackedRootFolder, extensionFolder, { overwrite: true }); - - // wait for the loader has actually install it - await when(() => extensionLoader.userExtensions.has(id)); - - // Enable installed extensions by default. - extensionLoader.setIsEnabled(id, true); - - Notifications.ok( -

    - {"Extension "} - {displayName} - {" successfully installed!"} -

    , - ); - } catch (error) { - const message = getMessageFromError(error); - - logger.info( - `[EXTENSION-INSTALLATION]: installing ${request.fileName} has failed: ${message}`, - { error }, - ); - Notifications.error( -

    - {"Installing extension "} - {displayName} - {" has failed: "} - {message} -

    , - ); - } finally { - // Remove install state once finished - extensionInstallationStateStore.clearInstalling(id); - - // clean up - fse.remove(unpackingTempFolder).catch(noop); - fse.unlink(tempFile).catch(noop); - } - }; diff --git a/src/renderer/components/+extensions/attempt-installs/attempt-installs.injectable.ts b/src/renderer/components/+extensions/attempt-installs/attempt-installs.injectable.ts index 407668989f..78939ef264 100644 --- a/src/renderer/components/+extensions/attempt-installs/attempt-installs.injectable.ts +++ b/src/renderer/components/+extensions/attempt-installs/attempt-installs.injectable.ts @@ -3,16 +3,29 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import { attemptInstalls } from "./attempt-installs"; +import getBasenameOfPathInjectable from "../../../../common/path/get-basename.injectable"; import attemptInstallInjectable from "../attempt-install/attempt-install.injectable"; +import readFileNotifyInjectable from "../read-file-notify/read-file-notify.injectable"; + +export type AttemptInstalls = (filePaths: string[]) => Promise; const attemptInstallsInjectable = getInjectable({ id: "attempt-installs", - instantiate: (di) => - attemptInstalls({ - attemptInstall: di.inject(attemptInstallInjectable), - }), + instantiate: (di): AttemptInstalls => { + const attemptInstall = di.inject(attemptInstallInjectable); + const getBasenameOfPath = di.inject(getBasenameOfPathInjectable); + const readFileNotify = di.inject(readFileNotifyInjectable); + + return async (filePaths) => { + await Promise.allSettled(filePaths.map(filePath => ( + attemptInstall({ + fileName: getBasenameOfPath(filePath), + dataP: readFileNotify(filePath), + }) + ))); + }; + }, }); export default attemptInstallsInjectable; diff --git a/src/renderer/components/+extensions/attempt-installs/attempt-installs.ts b/src/renderer/components/+extensions/attempt-installs/attempt-installs.ts deleted file mode 100644 index c40d9e78ca..0000000000 --- a/src/renderer/components/+extensions/attempt-installs/attempt-installs.ts +++ /dev/null @@ -1,28 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import { readFileNotify } from "../read-file-notify/read-file-notify"; -import path from "path"; -import type { InstallRequest } from "../attempt-install/install-request"; - -interface Dependencies { - attemptInstall: (request: InstallRequest) => Promise; -} - -export const attemptInstalls = - ({ attemptInstall }: Dependencies) => - async (filePaths: string[]): Promise => { - const promises: Promise[] = []; - - for (const filePath of filePaths) { - promises.push( - attemptInstall({ - fileName: path.basename(filePath), - dataP: readFileNotify(filePath), - }), - ); - } - - await Promise.allSettled(promises); - }; diff --git a/src/renderer/components/+extensions/extensions.tsx b/src/renderer/components/+extensions/extensions.tsx index 446f6e0778..933dab8a9a 100644 --- a/src/renderer/components/+extensions/extensions.tsx +++ b/src/renderer/components/+extensions/extensions.tsx @@ -28,21 +28,21 @@ import enableExtensionInjectable from "./enable-extension/enable-extension.injec import disableExtensionInjectable from "./disable-extension/disable-extension.injectable"; import type { ConfirmUninstallExtension } from "./confirm-uninstall-extension.injectable"; import confirmUninstallExtensionInjectable from "./confirm-uninstall-extension.injectable"; -import installFromInputInjectable from "./install-from-input/install-from-input.injectable"; +import type { InstallExtensionFromInput } from "./install-extension-from-input.injectable"; +import installExtensionFromInputInjectable from "./install-extension-from-input.injectable"; import installFromSelectFileDialogInjectable from "./install-from-select-file-dialog.injectable"; import type { LensExtensionId } from "../../../extensions/lens-extension"; import installOnDropInjectable from "./install-on-drop/install-on-drop.injectable"; import { supportedExtensionFormats } from "./supported-extension-formats"; import extensionInstallationStateStoreInjectable from "../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable"; import type { ExtensionInstallationStateStore } from "../../../extensions/extension-installation-state-store/extension-installation-state-store"; -import type { InstallFromInput } from "./install-from-input/install-from-input"; interface Dependencies { userExtensions: IComputedValue; enableExtension: (id: LensExtensionId) => void; disableExtension: (id: LensExtensionId) => void; confirmUninstallExtension: ConfirmUninstallExtension; - installFromInput: InstallFromInput; + installExtensionFromInput: InstallExtensionFromInput; installFromSelectFileDialog: () => Promise; installOnDrop: (files: File[]) => Promise; extensionInstallationStateStore: ExtensionInstallationStateStore; @@ -107,7 +107,7 @@ class NonInjectedExtensions extends React.Component { (this.installPath = value)} - installFromInput={() => this.props.installFromInput(this.installPath)} + installFromInput={() => this.props.installExtensionFromInput(this.installPath)} installFromSelectFileDialog={this.props.installFromSelectFileDialog} installPath={this.installPath} /> @@ -131,7 +131,7 @@ export const Extensions = withInjectables(NonInjectedExtensions, { enableExtension: di.inject(enableExtensionInjectable), disableExtension: di.inject(disableExtensionInjectable), confirmUninstallExtension: di.inject(confirmUninstallExtensionInjectable), - installFromInput: di.inject(installFromInputInjectable), + installExtensionFromInput: di.inject(installExtensionFromInputInjectable), installOnDrop: di.inject(installOnDropInjectable), installFromSelectFileDialog: di.inject(installFromSelectFileDialogInjectable), extensionInstallationStateStore: di.inject(extensionInstallationStateStoreInjectable), diff --git a/src/renderer/components/+extensions/install-extension-from-input.injectable.tsx b/src/renderer/components/+extensions/install-extension-from-input.injectable.tsx new file mode 100644 index 0000000000..7b7d783283 --- /dev/null +++ b/src/renderer/components/+extensions/install-extension-from-input.injectable.tsx @@ -0,0 +1,82 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import React from "react"; +import type { ExtendableDisposer } from "../../../common/utils"; +import { downloadFile } from "../../../common/utils"; +import { InputValidators } from "../input"; +import { getMessageFromError } from "./get-message-from-error/get-message-from-error"; +import { getInjectable } from "@ogre-tools/injectable"; +import attemptInstallInjectable from "./attempt-install/attempt-install.injectable"; +import attemptInstallByInfoInjectable from "./attempt-install-by-info.injectable"; +import extensionInstallationStateStoreInjectable from "../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable"; +import readFileNotifyInjectable from "./read-file-notify/read-file-notify.injectable"; +import getBasenameOfPathInjectable from "../../../common/path/get-basename.injectable"; +import showErrorNotificationInjectable from "../notifications/show-error-notification.injectable"; +import loggerInjectable from "../../../common/logger.injectable"; + +export type InstallExtensionFromInput = (input: string) => Promise; + +const installExtensionFromInputInjectable = getInjectable({ + id: "install-extension-from-input", + + instantiate: (di): InstallExtensionFromInput => { + const attemptInstall = di.inject(attemptInstallInjectable); + const attemptInstallByInfo = di.inject(attemptInstallByInfoInjectable); + const extensionInstallationStateStore = di.inject(extensionInstallationStateStoreInjectable); + const readFileNotify = di.inject(readFileNotifyInjectable); + const getBasenameOfPath = di.inject(getBasenameOfPathInjectable); + const showErrorNotification = di.inject(showErrorNotificationInjectable); + const logger = di.inject(loggerInjectable); + + return async (input) => { + let disposer: ExtendableDisposer | undefined = undefined; + + try { + // fixme: improve error messages for non-tar-file URLs + if (InputValidators.isUrl.validate(input)) { + // install via url + disposer = extensionInstallationStateStore.startPreInstall(); + const { promise } = downloadFile({ url: input, timeout: 10 * 60 * 1000 }); + const fileName = getBasenameOfPath(input); + + return await attemptInstall({ fileName, dataP: promise }, disposer); + } + + try { + await InputValidators.isPath.validate(input); + + // install from system path + const fileName = getBasenameOfPath(input); + + return await attemptInstall({ fileName, dataP: readFileNotify(input) }); + } catch (error) { + const extNameCaptures = InputValidators.isExtensionNameInstallRegex.captures(input); + + if (extNameCaptures) { + const { name, version } = extNameCaptures; + + return await attemptInstallByInfo({ name, version }); + } + } + + throw new Error(`Unknown format of input: ${input}`); + } catch (error) { + const message = getMessageFromError(error); + + logger.info(`[EXTENSION-INSTALL]: installation has failed: ${message}`, { error, installPath: input }); + showErrorNotification(( +

    + {"Installation has failed: "} + {message} +

    + )); + } finally { + disposer?.(); + } + }; + }, +}); + +export default installExtensionFromInputInjectable; diff --git a/src/renderer/components/+extensions/install-from-input/install-from-input.injectable.ts b/src/renderer/components/+extensions/install-from-input/install-from-input.injectable.ts deleted file mode 100644 index 1f1a073293..0000000000 --- a/src/renderer/components/+extensions/install-from-input/install-from-input.injectable.ts +++ /dev/null @@ -1,23 +0,0 @@ -/** - * 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 attemptInstallInjectable from "../attempt-install/attempt-install.injectable"; -import { installFromInput } from "./install-from-input"; -import attemptInstallByInfoInjectable from "../attempt-install-by-info.injectable"; -import extensionInstallationStateStoreInjectable - from "../../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable"; - -const installFromInputInjectable = getInjectable({ - id: "install-extension-from-input", - - instantiate: (di) => - installFromInput({ - attemptInstall: di.inject(attemptInstallInjectable), - attemptInstallByInfo: di.inject(attemptInstallByInfoInjectable), - extensionInstallationStateStore: di.inject(extensionInstallationStateStoreInjectable), - }), -}); - -export default installFromInputInjectable; diff --git a/src/renderer/components/+extensions/install-from-input/install-from-input.tsx b/src/renderer/components/+extensions/install-from-input/install-from-input.tsx deleted file mode 100644 index eb5d6febe4..0000000000 --- a/src/renderer/components/+extensions/install-from-input/install-from-input.tsx +++ /dev/null @@ -1,77 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import type { ExtendableDisposer } from "../../../../common/utils"; -import { downloadFile } from "../../../../common/utils"; -import { InputValidators } from "../../input"; -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 React from "react"; -import { readFileNotify } from "../read-file-notify/read-file-notify"; -import type { InstallRequest } from "../attempt-install/install-request"; -import type { ExtensionInfo } from "../attempt-install-by-info.injectable"; -import type { ExtensionInstallationStateStore } from "../../../../extensions/extension-installation-state-store/extension-installation-state-store"; - -export type InstallFromInput = (input: string) => Promise; - -interface Dependencies { - attemptInstall: (request: InstallRequest, disposer?: ExtendableDisposer) => Promise; - attemptInstallByInfo: (extensionInfo: ExtensionInfo) => Promise; - extensionInstallationStateStore: ExtensionInstallationStateStore; -} - -export const installFromInput = ({ - attemptInstall, - attemptInstallByInfo, - extensionInstallationStateStore, -}: Dependencies): InstallFromInput => ( - async (input) => { - let disposer: ExtendableDisposer | undefined = undefined; - - try { - // fixme: improve error messages for non-tar-file URLs - if (InputValidators.isUrl.validate(input)) { - // install via url - disposer = extensionInstallationStateStore.startPreInstall(); - const { promise } = downloadFile({ url: input, timeout: 10 * 60 * 1000 }); - const fileName = path.basename(input); - - return await attemptInstall({ fileName, dataP: promise }, disposer); - } - - try { - await InputValidators.isPath.validate(input); - - // install from system path - const fileName = path.basename(input); - - return await attemptInstall({ fileName, dataP: readFileNotify(input) }); - } catch (error) { - const extNameCaptures = InputValidators.isExtensionNameInstallRegex.captures(input); - - if (extNameCaptures) { - const { name, version } = extNameCaptures; - - return await attemptInstallByInfo({ name, version }); - } - } - - throw new Error(`Unknown format of input: ${input}`); - } catch (error) { - const message = getMessageFromError(error); - - logger.info(`[EXTENSION-INSTALL]: installation has failed: ${message}`, { error, installPath: input }); - Notifications.error(( -

    - {"Installation has failed: "} - {message} -

    - )); - } finally { - disposer?.(); - } - } -); diff --git a/src/renderer/components/+extensions/read-file-notify/read-file-notify.injectable.ts b/src/renderer/components/+extensions/read-file-notify/read-file-notify.injectable.ts new file mode 100644 index 0000000000..d907314b33 --- /dev/null +++ b/src/renderer/components/+extensions/read-file-notify/read-file-notify.injectable.ts @@ -0,0 +1,38 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import { getMessageFromError } from "../get-message-from-error/get-message-from-error"; +import { getInjectable } from "@ogre-tools/injectable"; +import showErrorNotificationInjectable from "../../notifications/show-error-notification.injectable"; +import loggerInjectable from "../../../../common/logger.injectable"; +import readFileBufferInjectable from "../../../../common/fs/read-file-buffer.injectable"; + +export type ReadFileNotify = (filePath: string, showError?: boolean) => Promise; + +const readFileNotifyInjectable = getInjectable({ + id: "read-file-notify", + instantiate: (di): ReadFileNotify => { + const showErrorNotification = di.inject(showErrorNotificationInjectable); + const logger = di.inject(loggerInjectable); + const readFileBuffer = di.inject(readFileBufferInjectable); + + return async (filePath, showError = true) => { + try { + return await readFileBuffer(filePath); + } catch (error) { + if (showError) { + const message = getMessageFromError(error); + + logger.info(`[EXTENSION-INSTALL]: preloading ${filePath} has failed: ${message}`, { error }); + showErrorNotification(`Error while reading "${filePath}": ${message}`); + } + } + + return null; + }; + }, +}); + +export default readFileNotifyInjectable; + diff --git a/src/renderer/components/+extensions/read-file-notify/read-file-notify.ts b/src/renderer/components/+extensions/read-file-notify/read-file-notify.ts deleted file mode 100644 index 1467f1bc33..0000000000 --- a/src/renderer/components/+extensions/read-file-notify/read-file-notify.ts +++ /dev/null @@ -1,23 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import fse from "fs-extra"; -import { getMessageFromError } from "../get-message-from-error/get-message-from-error"; -import logger from "../../../../main/logger"; -import { Notifications } from "../../notifications"; - -export const readFileNotify = async (filePath: string, showError = true): Promise => { - try { - return await fse.readFile(filePath); - } catch (error) { - if (showError) { - const message = getMessageFromError(error); - - logger.info(`[EXTENSION-INSTALL]: preloading ${filePath} has failed: ${message}`, { error }); - Notifications.error(`Error while reading "${filePath}": ${message}`); - } - } - - return null; -}; diff --git a/src/renderer/components/+helm-charts/details/readme-of-selected-helm-chart.injectable.ts b/src/renderer/components/+helm-charts/details/readme-of-selected-helm-chart.injectable.ts index 21e8bcf7a9..9b639beca2 100644 --- a/src/renderer/components/+helm-charts/details/readme-of-selected-helm-chart.injectable.ts +++ b/src/renderer/components/+helm-charts/details/readme-of-selected-helm-chart.injectable.ts @@ -4,16 +4,16 @@ */ import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; import { asyncComputed } from "@ogre-tools/injectable-react"; -import callForHelmChartReadmeInjectable from "./readme/call-for-helm-chart-readme.injectable"; import helmChartDetailsVersionSelectionInjectable from "./versions/helm-chart-details-version-selection.injectable"; import type { HelmChart } from "../../../../common/k8s-api/endpoints/helm-charts.api"; +import requestHelmChartReadmeInjectable from "../../../../common/k8s-api/endpoints/helm-charts.api/request-readme.injectable"; const readmeOfSelectedHelmChartInjectable = getInjectable({ id: "readme-of-selected-helm-chart", instantiate: (di, chart: HelmChart) => { const selection = di.inject(helmChartDetailsVersionSelectionInjectable, chart); - const callForHelmChartReadme = di.inject(callForHelmChartReadmeInjectable); + const requestHelmChartReadme = di.inject(requestHelmChartReadmeInjectable); return asyncComputed(async () => { const chartVersion = selection.value.get(); @@ -22,7 +22,7 @@ const readmeOfSelectedHelmChartInjectable = getInjectable({ return ""; } - return await callForHelmChartReadme( + return await requestHelmChartReadme( chartVersion.getRepository(), chartVersion.getName(), chartVersion.getVersion(), diff --git a/src/renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable.ts b/src/renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable.ts deleted file mode 100644 index ae9c99edeb..0000000000 --- a/src/renderer/components/+helm-charts/details/readme/call-for-helm-chart-readme.injectable.ts +++ /dev/null @@ -1,29 +0,0 @@ -/** - * 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 { getChartDetails } from "../../../../../common/k8s-api/endpoints/helm-charts.api"; - -export type CallForHelmChartReadme = ( - repo: string, - name: string, - version: string, -) => Promise; - -const callForHelmChartReadmeInjectable = getInjectable({ - id: "call-for-helm-chart-readme", - - instantiate: - (): CallForHelmChartReadme => - async (repository: string, name: string, version: string) => { - // TODO: Dismantle wrong abstraction - const details = await getChartDetails(repository, name, { version }); - - return details.readme; - }, - - causesSideEffects: true, -}); - -export default callForHelmChartReadmeInjectable; diff --git a/src/renderer/components/+helm-charts/details/versions-of-selected-helm-chart.injectable.ts b/src/renderer/components/+helm-charts/details/versions-of-selected-helm-chart.injectable.ts index 14ea00fce2..290fc90b65 100644 --- a/src/renderer/components/+helm-charts/details/versions-of-selected-helm-chart.injectable.ts +++ b/src/renderer/components/+helm-charts/details/versions-of-selected-helm-chart.injectable.ts @@ -4,18 +4,18 @@ */ import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; import { asyncComputed } from "@ogre-tools/injectable-react"; -import callForHelmChartVersionsInjectable from "./versions/call-for-helm-chart-versions.injectable"; import type { HelmChart } from "../../../../common/k8s-api/endpoints/helm-charts.api"; +import requestHelmChartVersionsInjectable from "../../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; const versionsOfSelectedHelmChartInjectable = getInjectable({ id: "versions-of-selected-helm-chart", instantiate: (di, chart: HelmChart) => { - const callForHelmChartVersions = di.inject(callForHelmChartVersionsInjectable); + const requestHelmChartVersions = di.inject(requestHelmChartVersionsInjectable); return asyncComputed( async () => - await callForHelmChartVersions(chart.getRepository(), chart.getName()), + await requestHelmChartVersions(chart.getRepository(), chart.getName()), [], ); }, diff --git a/src/renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable.ts b/src/renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable.ts deleted file mode 100644 index a20f5b60e9..0000000000 --- a/src/renderer/components/+helm-charts/details/versions/call-for-helm-chart-versions.injectable.ts +++ /dev/null @@ -1,28 +0,0 @@ -/** - * 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 type { HelmChart } from "../../../../../common/k8s-api/endpoints/helm-charts.api"; -import { getChartDetails } from "../../../../../common/k8s-api/endpoints/helm-charts.api"; - -export type CallForHelmChartVersions = ( - repo: string, - name: string -) => Promise; - -const callForHelmChartVersionsInjectable = getInjectable({ - id: "call-for-helm-chart-versions", - - instantiate: - (): CallForHelmChartVersions => async (repository: string, name: string) => { - // TODO: Dismantle wrong abstraction - const details = await getChartDetails(repository, name); - - return details.versions; - }, - - causesSideEffects: true, -}); - -export default callForHelmChartVersionsInjectable; diff --git a/src/renderer/components/+helm-charts/get-char-details.injectable.ts b/src/renderer/components/+helm-charts/get-char-details.injectable.ts deleted file mode 100644 index e2c5ccca62..0000000000 --- a/src/renderer/components/+helm-charts/get-char-details.injectable.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * 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 type { GetChartDetailsOptions, IHelmChartDetails } from "../../../common/k8s-api/endpoints/helm-charts.api"; -import { getChartDetails } from "../../../common/k8s-api/endpoints/helm-charts.api"; - -export type GetChartDetails = (repo: string, name: string, opts?: GetChartDetailsOptions) => Promise; - -const getChartDetailsInjectable = getInjectable({ - id: "get-chart-details", - instantiate: (): GetChartDetails => getChartDetails, - causesSideEffects: true, -}); - -export default getChartDetailsInjectable; diff --git a/src/renderer/components/+helm-charts/helm-chart-store.injectable.ts b/src/renderer/components/+helm-charts/helm-chart-store.injectable.ts deleted file mode 100644 index ac05d23368..0000000000 --- a/src/renderer/components/+helm-charts/helm-chart-store.injectable.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * 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 { HelmChartStore } from "./helm-chart.store"; - -const helmChartStoreInjectable = getInjectable({ - id: "helm-chart-store", - instantiate: () => new HelmChartStore(), -}); - -export default helmChartStoreInjectable; diff --git a/src/renderer/components/+helm-charts/helm-chart.store.ts b/src/renderer/components/+helm-charts/helm-chart.store.ts deleted file mode 100644 index 415fe3e333..0000000000 --- a/src/renderer/components/+helm-charts/helm-chart.store.ts +++ /dev/null @@ -1,108 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import semver from "semver"; -import { observable, makeObservable } from "mobx"; -import { autoBind, sortCompareChartVersions } from "../../utils"; -import type { HelmChart } from "../../../common/k8s-api/endpoints/helm-charts.api"; -import { getChartDetails, listCharts } from "../../../common/k8s-api/endpoints/helm-charts.api"; -import { ItemStore } from "../../../common/item.store"; -import flatten from "lodash/flatten"; - -export interface ChartVersion { - repo: string; - version: string; -} - -export class HelmChartStore extends ItemStore { - @observable versions = observable.map(); - - constructor() { - super(); - - makeObservable(this); - autoBind(this); - } - - async loadAll() { - try { - const res = await this.loadItems(() => listCharts()); - - this.failedLoading = false; - - return res; - } catch (error) { - this.failedLoading = true; - - throw error; - } - } - - getByName(name: string, repo?: string) { - if (typeof repo !== "string") { - /** - * FIXME: - * This is here because in strict mode `getByName` MUST be 100% compatiable if called in the - * situation where it is only a "ItemStore" - */ - throw new TypeError("repo must be provided"); - } - - return this.items.find(chart => chart.getName() === name && chart.getRepository() === repo); - } - - protected sortVersions = (versions: ChartVersion[]) => { - return versions - .map(chartVersion => ({ ...chartVersion, __version: semver.coerce(chartVersion.version, { loose: true }) })) - .sort(sortCompareChartVersions) - .map(({ __version, ...chartVersion }) => chartVersion); - }; - - async getVersions(chartName: string, force?: boolean): Promise { - const versions = this.versions.get(chartName); - - if (versions && !force) { - return versions; - } - - const loadVersions = async (repo: string) => { - const { versions } = await getChartDetails(repo, chartName); - - return versions.map(chart => ({ - repo, - version: chart.getVersion(), - })); - }; - - if (!this.isLoaded) { - await this.loadAll(); - } - const repos = this.items - .filter(chart => chart.getName() === chartName) - .map(chart => chart.getRepository()); - - const newVersions = await Promise.all(repos.map(loadVersions)) - .then(flatten) - .then(this.sortVersions); - - this.versions.set(chartName, newVersions); - - return newVersions; - } - - reset() { - super.reset(); - this.versions.clear(); - } - - /** - * @deprecated Not supported - */ - removeItems(): Promise { - throw new Error("removeItems is not supported"); - } -} - -export const helmChartStore = new HelmChartStore(); diff --git a/src/renderer/components/+helm-charts/helm-charts.tsx b/src/renderer/components/+helm-charts/helm-charts.tsx index 5a603cf7aa..a8367aac23 100644 --- a/src/renderer/components/+helm-charts/helm-charts.tsx +++ b/src/renderer/components/+helm-charts/helm-charts.tsx @@ -7,7 +7,6 @@ import "./helm-charts.scss"; import React, { Component } from "react"; import { observer } from "mobx-react"; -import { helmChartStore } from "./helm-chart.store"; import type { HelmChart } from "../../../common/k8s-api/endpoints/helm-charts.api"; import { HelmChartDetails } from "./helm-chart-details"; import { ItemListLayout } from "../item-object-list/list-layout"; @@ -21,6 +20,7 @@ import navigateToHelmChartsInjectable from "../../../common/front-end-routing/ro import { HelmChartIcon } from "./icon"; import helmChartsInjectable from "./helm-charts/helm-charts.injectable"; import selectedHelmChartInjectable from "./helm-charts/selected-helm-chart.injectable"; +import { noop } from "lodash"; enum columnId { name = "name", @@ -35,9 +35,7 @@ interface Dependencies { chartName: IComputedValue; repo: IComputedValue; }; - navigateToHelmCharts: NavigateToHelmCharts; - charts: IAsyncComputed; selectedChart: IComputedValue; } @@ -69,17 +67,31 @@ class NonInjectedHelmCharts extends Component { }; render() { + const { charts } = this.props; const selectedChart = this.props.selectedChart.get(); return (
    - isConfigurable tableId="helm_charts" className="HelmCharts" - store={helmChartStore} + store={{ + get isLoaded() { + return !charts.pending.get(); + }, + failedLoading: false, + getTotalCount: () => charts.value.get().length, + isSelected: (item) => item === selectedChart, + toggleSelection: noop, + isSelectedAll: () => false, + toggleSelectionAll: () => false, + pickOnlySelected: () => [], + removeSelectedItems: async () => {}, + }} + preloadStores={false} getItems={() => this.props.charts.value.get()} isSelectable={false} sortingCallbacks={{ @@ -132,16 +144,12 @@ class NonInjectedHelmCharts extends Component { } } -export const HelmCharts = withInjectables( - NonInjectedHelmCharts, - - { - getProps: (di) => ({ - routeParameters: di.inject(helmChartsRouteParametersInjectable), - navigateToHelmCharts: di.inject(navigateToHelmChartsInjectable), - charts: di.inject(helmChartsInjectable), - selectedChart: di.inject(selectedHelmChartInjectable), - }), - }, -); +export const HelmCharts = withInjectables(NonInjectedHelmCharts, { + getProps: (di) => ({ + routeParameters: di.inject(helmChartsRouteParametersInjectable), + navigateToHelmCharts: di.inject(navigateToHelmChartsInjectable), + charts: di.inject(helmChartsInjectable), + selectedChart: di.inject(selectedHelmChartInjectable), + }), +}); diff --git a/src/renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable.ts b/src/renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable.ts deleted file mode 100644 index 5edc0d7bea..0000000000 --- a/src/renderer/components/+helm-charts/helm-charts/call-for-helm-charts.injectable.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * 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 type { HelmChart } from "../../../../common/k8s-api/endpoints/helm-charts.api"; -import { listCharts } from "../../../../common/k8s-api/endpoints/helm-charts.api"; - -export type CallForHelmCharts = () => Promise; - -const callForHelmChartsInjectable = getInjectable({ - id: "call-for-helm-charts", - instantiate: (): CallForHelmCharts => async () => await listCharts(), - causesSideEffects: true, -}); - -export default callForHelmChartsInjectable; diff --git a/src/renderer/components/+helm-charts/helm-charts/helm-charts.injectable.ts b/src/renderer/components/+helm-charts/helm-charts/helm-charts.injectable.ts index 1324e382a9..af9c02363d 100644 --- a/src/renderer/components/+helm-charts/helm-charts/helm-charts.injectable.ts +++ b/src/renderer/components/+helm-charts/helm-charts/helm-charts.injectable.ts @@ -4,15 +4,15 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import { asyncComputed } from "@ogre-tools/injectable-react"; -import callForHelmChartsInjectable from "./call-for-helm-charts.injectable"; +import requestHelmChartsInjectable from "../../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; const helmChartsInjectable = getInjectable({ id: "helm-charts", instantiate: (di) => { - const callForHelmCharts = di.inject(callForHelmChartsInjectable); + const requestHelmCharts = di.inject(requestHelmChartsInjectable); - return asyncComputed(async () => await callForHelmCharts(), []); + return asyncComputed(async () => await requestHelmCharts(), []); }, }); diff --git a/src/renderer/components/+helm-charts/helm-charts/request-versions-of-chart-for-release.injectable.ts b/src/renderer/components/+helm-charts/helm-charts/request-versions-of-chart-for-release.injectable.ts new file mode 100644 index 0000000000..b49d94fb10 --- /dev/null +++ b/src/renderer/components/+helm-charts/helm-charts/request-versions-of-chart-for-release.injectable.ts @@ -0,0 +1,36 @@ +/** + * 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 type { HelmChart } from "../../../../common/k8s-api/endpoints/helm-charts.api"; +import requestHelmChartVersionsInjectable from "../../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; +import { sortBySemverVersion } from "../../../utils"; +import type { HelmChartVersion } from "./versions"; + +/** + * @param release The release to try and figure out what chart versions match for + * @param charts The list of possible helm charts that `release` could be of + */ +export type RequestVersionsOfHelmChart = (release: HelmRelease, charts: HelmChart[]) => Promise; + +const requestVersionsOfHelmChartInjectable = getInjectable({ + id: "request-versions-of-helm-chart-for-helm-release-from-list-of-charts", + instantiate: (di): RequestVersionsOfHelmChart => { + const requestHelmChartVersions = di.inject(requestHelmChartVersionsInjectable); + + return async (release, charts) => { + const rawVersions = await Promise.all(( + charts + .filter(chart => chart.getName() === release.getChart()) + .map(chart => chart.getRepository()) + .map(repo => requestHelmChartVersions(repo, release.getChart())) + )); + + return sortBySemverVersion(rawVersions.flat()); + }; + }, +}); + +export default requestVersionsOfHelmChartInjectable; diff --git a/src/renderer/components/+helm-charts/helm-charts/request-versions.injectable.ts b/src/renderer/components/+helm-charts/helm-charts/request-versions.injectable.ts new file mode 100644 index 0000000000..1dbe685617 --- /dev/null +++ b/src/renderer/components/+helm-charts/helm-charts/request-versions.injectable.ts @@ -0,0 +1,28 @@ +/** + * 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 requestHelmChartsInjectable from "../../../../common/k8s-api/endpoints/helm-charts.api/request-charts.injectable"; +import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; +import requestVersionsOfHelmChartInjectable from "./request-versions-of-chart-for-release.injectable"; +import type { HelmChartVersion } from "./versions"; + +export type RequestVersionsOfHelmChartFor = (release: HelmRelease) => Promise; + +const requestVersionsOfHelmChartForInjectable = getInjectable({ + id: "request-versions-of-helm-chart-for", + instantiate: (di): RequestVersionsOfHelmChartFor => { + const requestHelmCharts = di.inject(requestHelmChartsInjectable); + const requestVersionsOfHelmChart = di.inject(requestVersionsOfHelmChartInjectable); + + return async (release) => { + const charts = await requestHelmCharts(); + + return requestVersionsOfHelmChart(release, charts); + }; + }, +}); + +export default requestVersionsOfHelmChartForInjectable; + diff --git a/src/renderer/components/+helm-charts/helm-charts/versions.injectable.ts b/src/renderer/components/+helm-charts/helm-charts/versions.injectable.ts new file mode 100644 index 0000000000..db06423ea5 --- /dev/null +++ b/src/renderer/components/+helm-charts/helm-charts/versions.injectable.ts @@ -0,0 +1,29 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; +import { asyncComputed } from "@ogre-tools/injectable-react"; +import { when } from "mobx"; +import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; +import helmChartsInjectable from "./helm-charts.injectable"; +import requestVersionsOfHelmChartInjectable from "./request-versions-of-chart-for-release.injectable"; + +const helmChartVersionsInjectable = getInjectable({ + id: "helm-chart-versions-loader", + instantiate: (di, release) => { + const helmCharts = di.inject(helmChartsInjectable); + const requestVersionsOfHelmChart = di.inject(requestVersionsOfHelmChartInjectable); + + return asyncComputed(async () => { + await when(() => !helmCharts.pending.get()); + + return requestVersionsOfHelmChart(release, helmCharts.value.get()); + }, []); + }, + lifecycle: lifecycleEnum.keyedSingleton({ + getInstanceKey: (di, release: HelmRelease) => release.getName(), + }), +}); + +export default helmChartVersionsInjectable; diff --git a/src/renderer/components/+helm-charts/helm-charts/versions.ts b/src/renderer/components/+helm-charts/helm-charts/versions.ts new file mode 100644 index 0000000000..950a6931cb --- /dev/null +++ b/src/renderer/components/+helm-charts/helm-charts/versions.ts @@ -0,0 +1,12 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +/** + * A type for the possible versions that a helm release was made from + */ +export interface HelmChartVersion { + repo: string; + version: string; +} diff --git a/src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.global-override-for-injectable.ts b/src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.global-override-for-injectable.ts deleted file mode 100644 index 282ef22fe3..0000000000 --- a/src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.global-override-for-injectable.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import callForHelmReleasesInjectable from "./call-for-helm-releases.injectable"; -import { getGlobalOverride } from "../../../../common/test-utils/get-global-override"; - -export default getGlobalOverride( - callForHelmReleasesInjectable, - () => () => { - throw new Error( - "Tried to call for helm releases without explicit override.", - ); - }, -); diff --git a/src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.injectable.ts b/src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.injectable.ts deleted file mode 100644 index d166091352..0000000000 --- a/src/renderer/components/+helm-releases/call-for-helm-releases/call-for-helm-releases.injectable.ts +++ /dev/null @@ -1,24 +0,0 @@ -/** - * 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 type { HelmReleaseDto } from "../../../../common/k8s-api/endpoints/helm-releases.api"; - -import { apiBase } from "../../../../common/k8s-api"; -import { endpoint } from "../../../../common/k8s-api/endpoints/helm-releases.api"; - -export type CallForHelmReleases = ( - namespace?: string -) => Promise; - -const callForHelmReleasesInjectable = getInjectable({ - id: "call-for-helm-releases", - - instantiate: (): CallForHelmReleases => async (namespace) => - await apiBase.get(endpoint({ namespace })), - - causesSideEffects: true, -}); - -export default callForHelmReleasesInjectable; diff --git a/src/renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable.ts b/src/renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable.ts deleted file mode 100644 index 9e3e3800a3..0000000000 --- a/src/renderer/components/+helm-releases/create-release/call-for-create-helm-release.injectable.ts +++ /dev/null @@ -1,44 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import yaml from "js-yaml"; -import { getInjectable } from "@ogre-tools/injectable"; -import type { HelmReleaseUpdateDetails } from "../../../../common/k8s-api/endpoints/helm-releases.api"; -import { endpoint } from "../../../../common/k8s-api/endpoints/helm-releases.api"; -import { apiBase } from "../../../../common/k8s-api"; - -interface HelmReleaseCreatePayload { - name?: string; - repo: string; - chart: string; - namespace: string; - version: string; - values: string; -} - -export type CallForCreateHelmRelease = ( - payload: HelmReleaseCreatePayload -) => Promise; - -const callForCreateHelmReleaseInjectable = getInjectable({ - id: "call-for-create-helm-release", - - instantiate: (): CallForCreateHelmRelease => (payload) => { - const { repo, chart: rawChart, values: rawValues, ...data } = payload; - const chart = `${repo}/${rawChart}`; - const values = yaml.load(rawValues); - - return apiBase.post(endpoint(), { - data: { - chart, - values, - ...data, - }, - }); - }, - - causesSideEffects: true, -}); - -export default callForCreateHelmReleaseInjectable; diff --git a/src/renderer/components/+helm-releases/create-release/create-release.injectable.ts b/src/renderer/components/+helm-releases/create-release/create-release.injectable.ts index 51006266c8..515895abec 100644 --- a/src/renderer/components/+helm-releases/create-release/create-release.injectable.ts +++ b/src/renderer/components/+helm-releases/create-release/create-release.injectable.ts @@ -5,15 +5,15 @@ import { getInjectable } from "@ogre-tools/injectable"; import releasesInjectable from "../releases.injectable"; -import type { CallForCreateHelmRelease } from "./call-for-create-helm-release.injectable"; -import callForCreateHelmReleaseInjectable from "./call-for-create-helm-release.injectable"; +import type { RequestCreateHelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; +import requestCreateHelmReleaseInjectable from "../../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; const createReleaseInjectable = getInjectable({ id: "create-release", - instantiate: (di): CallForCreateHelmRelease => { + instantiate: (di): RequestCreateHelmRelease => { const releases = di.inject(releasesInjectable); - const callForCreateRelease = di.inject(callForCreateHelmReleaseInjectable); + const callForCreateRelease = di.inject(requestCreateHelmReleaseInjectable); return async (payload) => { const release = await callForCreateRelease(payload); diff --git a/src/renderer/components/+helm-releases/delete-release/delete-release.injectable.ts b/src/renderer/components/+helm-releases/delete-release/delete-release.injectable.ts index 4619ddaf1f..f84416b01a 100644 --- a/src/renderer/components/+helm-releases/delete-release/delete-release.injectable.ts +++ b/src/renderer/components/+helm-releases/delete-release/delete-release.injectable.ts @@ -3,11 +3,8 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import type { - HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; -import { - deleteRelease, -} from "../../../../common/k8s-api/endpoints/helm-releases.api"; +import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; +import requestDeleteHelmReleaseInjectable from "../../../../common/k8s-api/endpoints/helm-releases.api/request-delete.injectable"; import releasesInjectable from "../releases.injectable"; const deleteReleaseInjectable = getInjectable({ @@ -15,9 +12,10 @@ const deleteReleaseInjectable = getInjectable({ instantiate: (di) => { const releases = di.inject(releasesInjectable); + const requestDeleteHelmRelease = di.inject(requestDeleteHelmReleaseInjectable); return async (release: HelmRelease) => { - await deleteRelease(release.getName(), release.getNs()); + await requestDeleteHelmRelease(release.getName(), release.getNs()); releases.invalidate(); }; diff --git a/src/renderer/components/+helm-releases/dialog/dialog.tsx b/src/renderer/components/+helm-releases/dialog/dialog.tsx index 5655720e10..9a7c3373d4 100644 --- a/src/renderer/components/+helm-releases/dialog/dialog.tsx +++ b/src/renderer/components/+helm-releases/dialog/dialog.tsx @@ -13,20 +13,23 @@ import type { DialogProps } from "../../dialog"; import { Dialog } from "../../dialog"; import { Wizard, WizardStep } from "../../wizard"; import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; -import { getReleaseHistory, type HelmReleaseRevision } from "../../../../common/k8s-api/endpoints/helm-releases.api"; import { Select } from "../../select"; import { Notifications } from "../../notifications"; import orderBy from "lodash/orderBy"; import { withInjectables } from "@ogre-tools/injectable-react"; import releaseRollbackDialogStateInjectable from "./state.injectable"; +import type { RollbackRelease } from "../rollback-release/rollback-release.injectable"; import rollbackReleaseInjectable from "../rollback-release/rollback-release.injectable"; +import type { HelmReleaseRevision, RequestHelmReleaseHistory } from "../../../../common/k8s-api/endpoints/helm-releases.api/request-history.injectable"; +import requestHelmReleaseHistoryInjectable from "../../../../common/k8s-api/endpoints/helm-releases.api/request-history.injectable"; export interface ReleaseRollbackDialogProps extends DialogProps { } interface Dependencies { - rollbackRelease: (releaseName: string, namespace: string, revisionNumber: number) => Promise; + rollbackRelease: RollbackRelease; state: IObservableValue; + requestHelmReleaseHistory: RequestHelmReleaseHistory; } @observer @@ -48,7 +51,7 @@ class NonInjectedReleaseRollbackDialog extends React.Component { this.isLoading.set(true); - const releases = await getReleaseHistory(release.getName(), release.getNs()); + const releases = await this.props.requestHelmReleaseHistory(release.getName(), release.getNs()); runInAction(() => { this.revisions.replace(orderBy(releases, "revision", "desc")); @@ -134,14 +137,11 @@ class NonInjectedReleaseRollbackDialog extends React.Component( - NonInjectedReleaseRollbackDialog, - - { - getProps: (di, props) => ({ - rollbackRelease: di.inject(rollbackReleaseInjectable), - state: di.inject(releaseRollbackDialogStateInjectable), - ...props, - }), - }, -); +export const ReleaseRollbackDialog = withInjectables(NonInjectedReleaseRollbackDialog, { + getProps: (di, props) => ({ + ...props, + rollbackRelease: di.inject(rollbackReleaseInjectable), + state: di.inject(releaseRollbackDialogStateInjectable), + requestHelmReleaseHistory: di.inject(requestHelmReleaseHistoryInjectable), + }), +}); diff --git a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.global-override-for-injectable.ts b/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.global-override-for-injectable.ts deleted file mode 100644 index e54f980728..0000000000 --- a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.global-override-for-injectable.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import { getGlobalOverride } from "../../../../../../common/test-utils/get-global-override"; -import callForHelmReleaseConfigurationInjectable from "./call-for-helm-release-configuration.injectable"; - -export default getGlobalOverride( - callForHelmReleaseConfigurationInjectable, - () => () => { - throw new Error( - "Tried to call for helm release configuration without explicit override.", - ); - }, -); diff --git a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.injectable.ts b/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.injectable.ts deleted file mode 100644 index d0ed0fac7c..0000000000 --- a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release-configuration/call-for-helm-release-configuration.injectable.ts +++ /dev/null @@ -1,29 +0,0 @@ -/** - * 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 { apiBase } from "../../../../../../common/k8s-api"; -import { endpoint } from "../../../../../../common/k8s-api/endpoints/helm-releases.api"; - -export type CallForHelmReleaseConfiguration = ( - name: string, - namespace: string, - all: boolean -) => Promise; - -const callForHelmReleaseConfigurationInjectable = getInjectable({ - id: "call-for-helm-release-configuration", - - instantiate: - (): CallForHelmReleaseConfiguration => async (name, namespace, all: boolean) => { - const route = "values"; - const path = endpoint({ name, namespace, route }, { all }); - - return apiBase.get(path); - }, - - causesSideEffects: true, -}); - -export default callForHelmReleaseConfigurationInjectable; diff --git a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.global-override-for-injectable.ts b/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.global-override-for-injectable.ts deleted file mode 100644 index 373b7cae4f..0000000000 --- a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.global-override-for-injectable.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import { getGlobalOverride } from "../../../../../../../common/test-utils/get-global-override"; -import callForHelmReleaseDetailsInjectable from "./call-for-helm-release-details.injectable"; - -export default getGlobalOverride( - callForHelmReleaseDetailsInjectable, - () => () => { - throw new Error( - "Tried to call for helm release details without explicit override.", - ); - }, -); diff --git a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.injectable.ts b/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.injectable.ts deleted file mode 100644 index e5dccb1340..0000000000 --- a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release-details/call-for-helm-release-details.injectable.ts +++ /dev/null @@ -1,45 +0,0 @@ -/** - * 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 { apiBase } from "../../../../../../../common/k8s-api"; -import { endpoint } from "../../../../../../../common/k8s-api/endpoints/helm-releases.api"; -import type { KubeJsonApiData } from "../../../../../../../common/k8s-api/kube-json-api"; - -export interface HelmReleaseDetails { - resources: KubeJsonApiData[]; - name: string; - namespace: string; - version: string; - config: string; // release values - manifest: string; - - info: { - deleted: string; - description: string; - first_deployed: string; - last_deployed: string; - notes: string; - status: string; - }; -} - -export type CallForHelmReleaseDetails = ( - name: string, - namespace: string -) => Promise; - -const callForHelmReleaseDetailsInjectable = getInjectable({ - id: "call-for-helm-release-details", - - instantiate: (): CallForHelmReleaseDetails => async (name, namespace) => { - const path = endpoint({ name, namespace }); - - return apiBase.get(path); - }, - - causesSideEffects: true, -}); - -export default callForHelmReleaseDetailsInjectable; diff --git a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release.injectable.ts b/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release.injectable.ts deleted file mode 100644 index bfcc947d08..0000000000 --- a/src/renderer/components/+helm-releases/release-details/release-details-model/call-for-helm-release/call-for-helm-release.injectable.ts +++ /dev/null @@ -1,51 +0,0 @@ -/** - * 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 type { HelmReleaseDto } from "../../../../../../common/k8s-api/endpoints/helm-releases.api"; -import callForHelmReleasesInjectable from "../../../call-for-helm-releases/call-for-helm-releases.injectable"; -import type { HelmReleaseDetails } from "./call-for-helm-release-details/call-for-helm-release-details.injectable"; -import callForHelmReleaseDetailsInjectable from "./call-for-helm-release-details/call-for-helm-release-details.injectable"; -import type { AsyncResult } from "../../../../../../common/utils/async-result"; - -export interface DetailedHelmRelease { - release: HelmReleaseDto; - details: HelmReleaseDetails; -} - -export type CallForHelmRelease = ( - name: string, - namespace: string -) => Promise>; - -const callForHelmReleaseInjectable = getInjectable({ - id: "call-for-helm-release", - - instantiate: (di): CallForHelmRelease => { - const callForHelmReleases = di.inject(callForHelmReleasesInjectable); - const callForHelmReleaseDetails = di.inject(callForHelmReleaseDetailsInjectable); - - return async (name, namespace) => { - const [releases, details] = await Promise.all([ - callForHelmReleases(namespace), - callForHelmReleaseDetails(name, namespace), - ]); - - const release = releases.find( - (rel) => rel.name === name && rel.namespace === namespace, - ); - - if (!release) { - return { - callWasSuccessful: false, - error: `Release ${name} didn't exist in ${namespace} namespace.`, - }; - } - - return { callWasSuccessful: true, response: { release, details }}; - }; - }, -}); - -export default callForHelmReleaseInjectable; diff --git a/src/renderer/components/+helm-releases/release-details/release-details-model/release-details-model.injectable.tsx b/src/renderer/components/+helm-releases/release-details/release-details-model/release-details-model.injectable.tsx index ebedbcdcdf..66461ccd02 100644 --- a/src/renderer/components/+helm-releases/release-details/release-details-model/release-details-model.injectable.tsx +++ b/src/renderer/components/+helm-releases/release-details/release-details-model/release-details-model.injectable.tsx @@ -6,18 +6,17 @@ import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; import type { IComputedValue, IObservableValue } from "mobx"; import { runInAction, action, observable, computed } from "mobx"; import type { TargetHelmRelease } from "../target-helm-release.injectable"; -import type { CallForHelmRelease, DetailedHelmRelease } from "./call-for-helm-release/call-for-helm-release.injectable"; -import callForHelmReleaseInjectable from "./call-for-helm-release/call-for-helm-release.injectable"; +import type { RequestDetailedHelmRelease, DetailedHelmRelease } from "./request-detailed-helm-release.injectable"; +import requestDetailedHelmReleaseInjectable from "./request-detailed-helm-release.injectable"; import type { LensTheme } from "../../../../themes/store"; -import type { CallForHelmReleaseConfiguration } from "./call-for-helm-release-configuration/call-for-helm-release-configuration.injectable"; -import callForHelmReleaseConfigurationInjectable from "./call-for-helm-release-configuration/call-for-helm-release-configuration.injectable"; -import { toHelmRelease } from "../../releases.injectable"; +import type { RequestHelmReleaseConfiguration } from "../../../../../common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable"; +import requestHelmReleaseConfigurationInjectable from "../../../../../common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable"; import { pipeline } from "@ogre-tools/fp"; import { groupBy, map } from "lodash/fp"; import type { KubeJsonApiData } from "../../../../../common/k8s-api/kube-json-api"; import type { GetResourceDetailsUrl } from "./get-resource-details-url.injectable"; import getResourceDetailsUrlInjectable from "./get-resource-details-url.injectable"; -import type { CallForHelmReleaseUpdate } from "../../update-release/call-for-helm-release-update/call-for-helm-release-update.injectable"; +import type { RequestHelmReleaseUpdate } from "../../../../../common/k8s-api/endpoints/helm-releases.api/request-update.injectable"; import updateReleaseInjectable from "../../update-release/update-release.injectable"; import type { ShowCheckedErrorNotification } from "../../../notifications/show-checked-error.injectable"; import showCheckedErrorNotificationInjectable from "../../../notifications/show-checked-error.injectable"; @@ -26,35 +25,29 @@ import showSuccessNotificationInjectable from "../../../notifications/show-succe import React from "react"; import createUpgradeChartTabInjectable from "../../../dock/upgrade-chart/create-upgrade-chart-tab.injectable"; import type { HelmRelease } from "../../../../../common/k8s-api/endpoints/helm-releases.api"; +import type { NavigateToHelmReleases } from "../../../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable"; import navigateToHelmReleasesInjectable from "../../../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable"; import assert from "assert"; import activeThemeInjectable from "../../../../themes/active.injectable"; +import type { ToHelmRelease } from "../../to-helm-release.injectable"; +import toHelmReleaseInjectable from "../../to-helm-release.injectable"; const releaseDetailsModelInjectable = getInjectable({ id: "release-details-model", instantiate: async (di, targetRelease: TargetHelmRelease) => { - const callForHelmRelease = di.inject(callForHelmReleaseInjectable); - const callForHelmReleaseConfiguration = di.inject(callForHelmReleaseConfigurationInjectable); - const activeTheme = di.inject(activeThemeInjectable); - const getResourceDetailsUrl = di.inject(getResourceDetailsUrlInjectable); - const updateRelease = di.inject(updateReleaseInjectable); - const showCheckedErrorNotification = di.inject(showCheckedErrorNotificationInjectable); - const showSuccessNotification = di.inject(showSuccessNotificationInjectable); - const createUpgradeChartTab = di.inject(createUpgradeChartTabInjectable); - const navigateToHelmReleases = di.inject(navigateToHelmReleasesInjectable); - const model = new ReleaseDetailsModel({ - callForHelmRelease, + requestDetailedHelmRelease: di.inject(requestDetailedHelmReleaseInjectable), targetRelease, - activeTheme, - callForHelmReleaseConfiguration, - getResourceDetailsUrl, - updateRelease, - showCheckedErrorNotification, - showSuccessNotification, - createUpgradeChartTab, - navigateToHelmReleases, + activeTheme: di.inject(activeThemeInjectable), + requestHelmReleaseConfiguration: di.inject(requestHelmReleaseConfigurationInjectable), + getResourceDetailsUrl: di.inject(getResourceDetailsUrlInjectable), + updateRelease: di.inject(updateReleaseInjectable), + showCheckedErrorNotification: di.inject(showCheckedErrorNotificationInjectable), + showSuccessNotification: di.inject(showSuccessNotificationInjectable), + createUpgradeChartTab: di.inject(createUpgradeChartTabInjectable), + navigateToHelmReleases: di.inject(navigateToHelmReleasesInjectable), + toHelmRelease: di.inject(toHelmReleaseInjectable), }); await model.load(); @@ -85,20 +78,21 @@ export interface ConfigurationInput { interface Dependencies { readonly targetRelease: TargetHelmRelease; readonly activeTheme: IComputedValue; - callForHelmRelease: CallForHelmRelease; - callForHelmReleaseConfiguration: CallForHelmReleaseConfiguration; + requestDetailedHelmRelease: RequestDetailedHelmRelease; + requestHelmReleaseConfiguration: RequestHelmReleaseConfiguration; getResourceDetailsUrl: GetResourceDetailsUrl; - updateRelease: CallForHelmReleaseUpdate; + updateRelease: RequestHelmReleaseUpdate; showCheckedErrorNotification: ShowCheckedErrorNotification; showSuccessNotification: ShowNotification; createUpgradeChartTab: (release: HelmRelease) => string; - navigateToHelmReleases: () => void; + navigateToHelmReleases: NavigateToHelmReleases; + toHelmRelease: ToHelmRelease; } export class ReleaseDetailsModel { readonly id = `${this.dependencies.targetRelease.namespace}/${this.dependencies.targetRelease.name}`; - constructor(private readonly dependencies: Dependencies) {} + constructor(protected readonly dependencies: Dependencies) {} private readonly detailedRelease = observable.box(); @@ -171,7 +165,7 @@ export class ReleaseDetailsModel { load = async () => { const { name, namespace } = this.dependencies.targetRelease; - const result = await this.dependencies.callForHelmRelease( + const result = await this.dependencies.requestDetailedHelmRelease( name, namespace, ); @@ -199,7 +193,7 @@ export class ReleaseDetailsModel { const { name, namespace } = this.release; const configuration = - await this.dependencies.callForHelmReleaseConfiguration( + await this.dependencies.requestHelmReleaseConfiguration( name, namespace, !this.onlyUserSuppliedValuesAreShown.value.get(), @@ -216,7 +210,7 @@ export class ReleaseDetailsModel { assert(detailedRelease, "Tried to access release before load"); - return toHelmRelease(detailedRelease.release); + return this.dependencies.toHelmRelease(detailedRelease.release); } @computed private get details() { diff --git a/src/renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable.ts b/src/renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable.ts new file mode 100644 index 0000000000..6c7da31f97 --- /dev/null +++ b/src/renderer/components/+helm-releases/release-details/release-details-model/request-detailed-helm-release.injectable.ts @@ -0,0 +1,51 @@ +/** + * 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 type { HelmReleaseDto } from "../../../../../common/k8s-api/endpoints/helm-releases.api"; +import requestHelmReleasesInjectable from "../../../../../common/k8s-api/endpoints/helm-releases.api/request-releases.injectable"; +import type { HelmReleaseDetails } from "../../../../../common/k8s-api/endpoints/helm-releases.api/request-details.injectable"; +import requestHelmReleaseDetailsInjectable from "../../../../../common/k8s-api/endpoints/helm-releases.api/request-details.injectable"; +import type { AsyncResult } from "../../../../../common/utils/async-result"; + +export interface DetailedHelmRelease { + release: HelmReleaseDto; + details: HelmReleaseDetails; +} + +export type RequestDetailedHelmRelease = ( + name: string, + namespace: string +) => Promise>; + +const requestDetailedHelmReleaseInjectable = getInjectable({ + id: "request-detailed-helm-release", + + instantiate: (di): RequestDetailedHelmRelease => { + const requestHelmReleases = di.inject(requestHelmReleasesInjectable); + const requestHelmReleaseDetails = di.inject(requestHelmReleaseDetailsInjectable); + + return async (name, namespace) => { + const [releases, details] = await Promise.all([ + requestHelmReleases(namespace), + requestHelmReleaseDetails(name, namespace), + ]); + + const release = releases.find( + (rel) => rel.name === name && rel.namespace === namespace, + ); + + if (!release) { + return { + callWasSuccessful: false, + error: `Release ${name} didn't exist in ${namespace} namespace.`, + }; + } + + return { callWasSuccessful: true, response: { release, details }}; + }; + }, +}); + +export default requestDetailedHelmReleaseInjectable; diff --git a/src/renderer/components/+helm-releases/release-menu.tsx b/src/renderer/components/+helm-releases/release-menu.tsx index a53c59a682..694dd69b3c 100644 --- a/src/renderer/components/+helm-releases/release-menu.tsx +++ b/src/renderer/components/+helm-releases/release-menu.tsx @@ -61,7 +61,10 @@ class NonInjectedHelmReleaseMenu extends React.ComponentRollback )} - + { const clusterContext = di.inject(clusterFrameContextInjectable); - const namespaceStore = di.inject(namespaceStoreInjectable); const releaseSecrets = di.inject(releaseSecretsInjectable); - const callForHelmReleases = di.inject(callForHelmReleasesInjectable); + const requestHelmReleases = di.inject(requestHelmReleasesInjectable); + const toHelmRelease = di.inject(toHelmReleaseInjectable); return asyncComputed(async () => { - const contextNamespaces = namespaceStore.contextNamespaces || []; - void releaseSecrets.get(); - const isLoadingAll = - clusterContext.allNamespaces?.length > 1 && - clusterContext.cluster?.accessibleNamespaces.length === 0 && - clusterContext.allNamespaces.every((namespace) => - contextNamespaces.includes(namespace), - ); - - const releaseArrays = await (isLoadingAll ? callForHelmReleases() : Promise.all( - contextNamespaces.map((namespace) => - callForHelmReleases(namespace), - ), - )); + const releaseArrays = await (clusterContext.hasSelectedAll + ? requestHelmReleases() + : Promise.all(clusterContext.contextNamespaces.map(namespace => requestHelmReleases(namespace))) + ); return releaseArrays.flat().map(toHelmRelease); }, []); }, }); -export const toHelmRelease = (release: HelmReleaseDto) : HelmRelease => ({ - ...release, - - getId() { - return `${this.namespace}/${this.name}`; - }, - - getName() { - return this.name; - }, - - getNs() { - return this.namespace; - }, - - getChart(withVersion = false) { - let chart = this.chart; - - if (!withVersion && this.getVersion() != "") { - const search = new RegExp(`-${this.getVersion()}`); - - chart = chart.replace(search, ""); - } - - return chart; - }, - - getRevision() { - return parseInt(this.revision, 10); - }, - - getStatus() { - return capitalize(this.status); - }, - - getVersion() { - const versions = this.chart.match(/(?<=-)(v?\d+)[^-].*$/); - - return versions?.[0] ?? ""; - }, - - getUpdated(humanize = true, compact = true) { - const updated = this.updated.replace(/\s\w*$/, ""); // 2019-11-26 10:58:09 +0300 MSK -> 2019-11-26 10:58:09 +0300 to pass into Date() - const updatedDate = new Date(updated).getTime(); - const diff = Date.now() - updatedDate; - - if (humanize) { - return formatDuration(diff, compact); - } - - return diff; - }, - - // Helm does not store from what repository the release is installed, - // so we have to try to guess it by searching charts - async getRepo() { - const chartName = this.getChart(); - const version = this.getVersion(); - const versions = await helmChartStore.getVersions(chartName); - const chartVersion = versions.find( - (chartVersion) => chartVersion.version === version, - ); - - return chartVersion ? chartVersion.repo : ""; - }, -}); - export default releasesInjectable; diff --git a/src/renderer/components/+helm-releases/rollback-release/rollback-release.injectable.ts b/src/renderer/components/+helm-releases/rollback-release/rollback-release.injectable.ts index c7ace21e06..fabac39316 100644 --- a/src/renderer/components/+helm-releases/rollback-release/rollback-release.injectable.ts +++ b/src/renderer/components/+helm-releases/rollback-release/rollback-release.injectable.ts @@ -3,17 +3,20 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import { rollbackRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; +import requestHelmReleaseRollbackInjectable from "../../../../common/k8s-api/endpoints/helm-releases.api/request-rollback.injectable"; import releasesInjectable from "../releases.injectable"; +export type RollbackRelease = (name: string, namespace: string, revision: number) => Promise; + const rollbackReleaseInjectable = getInjectable({ id: "rollback-release", - instantiate: (di) => { + instantiate: (di): RollbackRelease => { const releases = di.inject(releasesInjectable); + const requestHelmReleaseRollback = di.inject(requestHelmReleaseRollbackInjectable); - return async (name: string, namespace: string, revision: number) => { - await rollbackRelease(name, namespace, revision); + return async (name, namespace, revision) => { + await requestHelmReleaseRollback(name, namespace, revision); releases.invalidate(); }; diff --git a/src/renderer/components/+helm-releases/to-helm-release.injectable.ts b/src/renderer/components/+helm-releases/to-helm-release.injectable.ts new file mode 100644 index 0000000000..d8b27625e6 --- /dev/null +++ b/src/renderer/components/+helm-releases/to-helm-release.injectable.ts @@ -0,0 +1,90 @@ +/** + * 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 { capitalize } from "lodash"; +import { when } from "mobx"; +import helmChartVersionsInjectable from "../+helm-charts/helm-charts/versions.injectable"; +import type { HelmRelease, HelmReleaseDto } from "../../../common/k8s-api/endpoints/helm-releases.api"; +import { getMillisecondsFromUnixEpoch } from "../../../common/utils/date/get-current-date-time"; +import { formatDuration } from "../../utils"; + +export type ToHelmRelease = (release: HelmReleaseDto) => HelmRelease; + +const toHelmReleaseInjectable = getInjectable({ + id: "to-helm-release", + instantiate: (di): ToHelmRelease => { + const helmChartVersions = (release: HelmRelease) => di.inject(helmChartVersionsInjectable, release); + + return (release) => ({ + ...release, + + getId() { + return `${this.namespace}/${this.name}`; + }, + + getName() { + return this.name; + }, + + getNs() { + return this.namespace; + }, + + getChart(withVersion = false) { + let chart = this.chart; + + if (!withVersion && this.getVersion() != "") { + const search = new RegExp(`-${this.getVersion()}`); + + chart = chart.replace(search, ""); + } + + return chart; + }, + + getRevision() { + return parseInt(this.revision, 10); + }, + + getStatus() { + return capitalize(this.status); + }, + + getVersion() { + const versions = this.chart.match(/(?<=-)(v?\d+)[^-].*$/); + + return versions?.[0] ?? ""; + }, + + getUpdated(humanize = true, compact = true) { + const updated = this.updated.replace(/\s\w*$/, ""); // 2019-11-26 10:58:09 +0300 MSK -> 2019-11-26 10:58:09 +0300 to pass into Date() + const updatedDate = new Date(updated).getTime(); + const diff = getMillisecondsFromUnixEpoch() - updatedDate; + + if (humanize) { + return formatDuration(diff, compact); + } + + return diff; + }, + + // Helm does not store from what repository the release is installed, + // so we have to try to guess it by searching charts + async getRepo() { + const versionsComputed = helmChartVersions(this); + const version = this.getVersion(); + + await when(() => !versionsComputed.pending.get()); + + return versionsComputed.value + .get() + .find((chartVersion) => chartVersion.version === version)?.repo + ?? ""; + }, + }); + }, +}); + +export default toHelmReleaseInjectable; diff --git a/src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.global-override-for-injectable.ts b/src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.global-override-for-injectable.ts deleted file mode 100644 index 34cc147e8d..0000000000 --- a/src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.global-override-for-injectable.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import { getGlobalOverride } from "../../../../../common/test-utils/get-global-override"; -import callForHelmReleaseUpdateInjectable from "./call-for-helm-release-update.injectable"; - -export default getGlobalOverride( - callForHelmReleaseUpdateInjectable, - () => () => { - throw new Error( - "Tried to call for helm release update without explicit override.", - ); - }, -); diff --git a/src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.injectable.ts b/src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.injectable.ts deleted file mode 100644 index b3cc590163..0000000000 --- a/src/renderer/components/+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.injectable.ts +++ /dev/null @@ -1,50 +0,0 @@ -/** - * 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 { apiBase } from "../../../../../common/k8s-api"; -import { endpoint } from "../../../../../common/k8s-api/endpoints/helm-releases.api"; -import yaml from "js-yaml"; - -interface HelmReleaseUpdatePayload { - repo: string; - chart: string; - version: string; - values: string; -} - -export type CallForHelmReleaseUpdate = ( - name: string, - namespace: string, - payload: HelmReleaseUpdatePayload -) => Promise<{ updateWasSuccessful: true } | { updateWasSuccessful: false; error: unknown }>; - -const callForHelmReleaseUpdateInjectable = getInjectable({ - id: "call-for-helm-release-update", - - instantiate: - (): CallForHelmReleaseUpdate => async (name, namespace, payload) => { - const { repo, chart: rawChart, values: rawValues, ...data } = payload; - const chart = `${repo}/${rawChart}`; - const values = yaml.load(rawValues); - - try { - await apiBase.put(endpoint({ name, namespace }), { - data: { - chart, - values, - ...data, - }, - }); - } catch (e) { - return { updateWasSuccessful: false, error: e }; - } - - return { updateWasSuccessful: true }; - }, - - causesSideEffects: true, -}); - -export default callForHelmReleaseUpdateInjectable; diff --git a/src/renderer/components/+helm-releases/update-release/update-release.injectable.ts b/src/renderer/components/+helm-releases/update-release/update-release.injectable.ts index dce16e2dd1..8cdcbfafe1 100644 --- a/src/renderer/components/+helm-releases/update-release/update-release.injectable.ts +++ b/src/renderer/components/+helm-releases/update-release/update-release.injectable.ts @@ -4,15 +4,15 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import releasesInjectable from "../releases.injectable"; -import type { CallForHelmReleaseUpdate } from "./call-for-helm-release-update/call-for-helm-release-update.injectable"; -import callForHelmReleaseUpdateInjectable from "./call-for-helm-release-update/call-for-helm-release-update.injectable"; +import type { RequestHelmReleaseUpdate } from "../../../../common/k8s-api/endpoints/helm-releases.api/request-update.injectable"; +import requestHelmReleaseUpdateInjectable from "../../../../common/k8s-api/endpoints/helm-releases.api/request-update.injectable"; const updateReleaseInjectable = getInjectable({ id: "update-release", - instantiate: (di): CallForHelmReleaseUpdate => { + instantiate: (di): RequestHelmReleaseUpdate => { const releases = di.inject(releasesInjectable); - const callForHelmReleaseUpdate = di.inject(callForHelmReleaseUpdateInjectable); + const callForHelmReleaseUpdate = di.inject(requestHelmReleaseUpdateInjectable); return async ( name, diff --git a/src/renderer/components/+namespaces/namespace-details.tsx b/src/renderer/components/+namespaces/namespace-details.tsx index 12bb7a4208..a11d7f26a5 100644 --- a/src/renderer/components/+namespaces/namespace-details.tsx +++ b/src/renderer/components/+namespaces/namespace-details.tsx @@ -10,7 +10,7 @@ import { computed, makeObservable, observable, reaction } from "mobx"; import { disposeOnUnmount, observer } from "mobx-react"; import { DrawerItem } from "../drawer"; import { cssNames } from "../../utils"; -import { getMetricsForNamespace, type PodMetricData, Namespace } from "../../../common/k8s-api/endpoints"; +import { Namespace } from "../../../common/k8s-api/endpoints"; import type { KubeObjectDetailsProps } from "../kube-object-details"; import { Link } from "react-router-dom"; import { Spinner } from "../spinner"; @@ -31,6 +31,8 @@ import getActiveClusterEntityInjectable from "../../api/catalog/entity/get-activ import getDetailsUrlInjectable from "../kube-detail-params/get-details-url.injectable"; import limitRangeStoreInjectable from "../+config-limit-ranges/store.injectable"; import resourceQuotaStoreInjectable from "../+config-resource-quotas/store.injectable"; +import type { PodMetricInNamespaceData, RequestPodMetricsInNamespace } from "../../../common/k8s-api/endpoints/metrics.api/request-pod-metrics-in-namespace.injectable"; +import requestPodMetricsInNamespaceInjectable from "../../../common/k8s-api/endpoints/metrics.api/request-pod-metrics-in-namespace.injectable"; export interface NamespaceDetailsProps extends KubeObjectDetailsProps { } @@ -41,11 +43,12 @@ interface Dependencies { getDetailsUrl: GetDetailsUrl; resourceQuotaStore: ResourceQuotaStore; limitRangeStore: LimitRangeStore; + requestPodMetricsInNamespace: RequestPodMetricsInNamespace; } @observer class NonInjectedNamespaceDetails extends React.Component { - @observable metrics: PodMetricData | null = null; + @observable metrics: PodMetricInNamespaceData | null = null; constructor(props: NamespaceDetailsProps & Dependencies) { super(props); @@ -78,7 +81,7 @@ class NonInjectedNamespaceDetails extends React.Component { - this.metrics = await getMetricsForNamespace(this.props.object.getName(), ""); + this.metrics = await this.props.requestPodMetricsInNamespace(this.props.object.getName()); }; render() { @@ -144,6 +147,7 @@ export const NamespaceDetails = withInjectables { } +interface Dependencies { + requestIngressMetrics: RequestIngressMetrics; +} + @observer -export class IngressDetails extends React.Component { +class NonInjectedIngressDetails extends React.Component { @observable metrics: IngressMetricData | null = null; - constructor(props: IngressDetailsProps) { + constructor(props: IngressDetailsProps & Dependencies) { super(props); makeObservable(this); } @@ -42,9 +49,9 @@ export class IngressDetails extends React.Component { } loadMetrics = async () => { - const { object: ingress } = this.props; + const { object: ingress, requestIngressMetrics } = this.props; - this.metrics = await getMetricsForIngress(ingress.getName(), ingress.getNs()); + this.metrics = await requestIngressMetrics(ingress.getName(), ingress.getNs()); }; renderPaths(ingress: Ingress) { @@ -170,3 +177,10 @@ export class IngressDetails extends React.Component { ); } } + +export const IngressDetails = withInjectables(NonInjectedIngressDetails, { + getProps: (di, props) => ({ + ...props, + requestIngressMetrics: di.inject(requestIngressMetricsInjectable), + }), +}); diff --git a/src/renderer/components/+nodes/details.tsx b/src/renderer/components/+nodes/details.tsx index 3377bcb4a5..f71d5bfa5f 100644 --- a/src/renderer/components/+nodes/details.tsx +++ b/src/renderer/components/+nodes/details.tsx @@ -13,8 +13,7 @@ import { DrawerItem, DrawerItemLabels } from "../drawer"; import { Badge } from "../badge"; import { ResourceMetrics } from "../resource-metrics"; import type { KubeObjectDetailsProps } from "../kube-object-details"; -import type { ClusterMetricData } from "../../../common/k8s-api/endpoints"; -import { formatNodeTaint, getMetricsByNodeNames, Node } from "../../../common/k8s-api/endpoints"; +import { formatNodeTaint, Node } from "../../../common/k8s-api/endpoints"; import { NodeCharts } from "./node-charts"; import { makeObservable, observable, reaction } from "mobx"; import { PodDetailsList } from "../+workloads-pods/pod-details-list"; @@ -30,6 +29,8 @@ import type { PodStore } from "../+workloads-pods/store"; import podStoreInjectable from "../+workloads-pods/store.injectable"; import type { GetActiveClusterEntity } from "../../api/catalog/entity/get-active-cluster-entity.injectable"; import getActiveClusterEntityInjectable from "../../api/catalog/entity/get-active-cluster-entity.injectable"; +import type { ClusterMetricData, RequestClusterMetricsByNodeNames } from "../../../common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable"; +import requestClusterMetricsByNodeNamesInjectable from "../../../common/k8s-api/endpoints/metrics.api/request-cluster-metrics-by-node-names.injectable"; export interface NodeDetailsProps extends KubeObjectDetailsProps { } @@ -38,11 +39,12 @@ interface Dependencies { subscribeStores: SubscribeStores; podStore: PodStore; getActiveClusterEntity: GetActiveClusterEntity; + requestClusterMetricsByNodeNames: RequestClusterMetricsByNodeNames; } @observer class NonInjectedNodeDetails extends React.Component { - @observable metrics: Partial | null = null; + @observable metrics: ClusterMetricData | null = null; constructor(props: NodeDetailsProps & Dependencies) { super(props); @@ -62,9 +64,9 @@ class NonInjectedNodeDetails extends React.Component { - const { object: node } = this.props; + const { object: node, requestClusterMetricsByNodeNames } = this.props; - this.metrics = await getMetricsByNodeNames([node.getName()]); + this.metrics = await requestClusterMetricsByNodeNames([node.getName()]); }; render() { @@ -196,6 +198,7 @@ export const NodeDetails = withInjectables(NonIn subscribeStores: di.inject(subscribeStoresInjectable), podStore: di.inject(podStoreInjectable), getActiveClusterEntity: di.inject(getActiveClusterEntityInjectable), + requestClusterMetricsByNodeNames: di.inject(requestClusterMetricsByNodeNamesInjectable), }), }); diff --git a/src/renderer/components/+nodes/route.tsx b/src/renderer/components/+nodes/route.tsx index 782d4808e6..a868dda39b 100644 --- a/src/renderer/components/+nodes/route.tsx +++ b/src/renderer/components/+nodes/route.tsx @@ -8,10 +8,9 @@ import React from "react"; import { observer } from "mobx-react"; import { cssNames, interval } from "../../utils"; import { TabLayout } from "../layout/tab-layout-2"; -import { nodeStore } from "./legacy-store"; import { KubeObjectListLayout } from "../kube-object-list-layout"; -import type { NodeMetricData, Node } from "../../../common/k8s-api/endpoints/node.api"; -import { formatNodeTaint, getMetricsForAllNodes } from "../../../common/k8s-api/endpoints/node.api"; +import type { Node } from "../../../common/k8s-api/endpoints/node.api"; +import { formatNodeTaint } from "../../../common/k8s-api/endpoints/node.api"; import { LineProgress } from "../line-progress"; import { bytesToUnits } from "../../../common/utils/convertMemory"; import { Tooltip, TooltipPosition } from "../tooltip"; @@ -19,10 +18,15 @@ import kebabCase from "lodash/kebabCase"; import upperFirst from "lodash/upperFirst"; import { KubeObjectStatusIcon } from "../kube-object-status-icon"; import { Badge } from "../badge/badge"; -import { eventStore } from "../+events/legacy-store"; import { makeObservable, observable } from "mobx"; -import isEmpty from "lodash/isEmpty"; import { KubeObjectAge } from "../kube-object/age"; +import type { NodeMetricData, RequestAllNodeMetrics } from "../../../common/k8s-api/endpoints/metrics.api/request-metrics-for-all-nodes.injectable"; +import type { NodeStore } from "./store"; +import { withInjectables } from "@ogre-tools/injectable-react"; +import nodeStoreInjectable from "./store.injectable"; +import requestAllNodeMetricsInjectable from "../../../common/k8s-api/endpoints/metrics.api/request-metrics-for-all-nodes.injectable"; +import eventStoreInjectable from "../+events/store.injectable"; +import type { EventStore } from "../+events/store"; enum columnId { name = "name", @@ -42,16 +46,23 @@ type MetricsTooltipFormatter = (metrics: [number, number]) => string; interface UsageArgs { node: Node; title: string; - metricNames: [string, string]; + metricNames: [keyof NodeMetricData, keyof NodeMetricData]; formatters: MetricsTooltipFormatter[]; } -@observer -export class NodesRoute extends React.Component { - @observable.ref metrics: Partial = {}; - private metricsWatcher = interval(30, async () => this.metrics = await getMetricsForAllNodes()); +interface Dependencies { + requestAllNodeMetrics: RequestAllNodeMetrics; + nodeStore: NodeStore; + eventStore: EventStore; +} - constructor(props: any) { +@observer +class NonInjectedNodesRoute extends React.Component { + @observable metrics: NodeMetricData | null = null; + + private metricsWatcher = interval(30, async () => this.metrics = await this.props.requestAllNodeMetrics()); + + constructor(props: Dependencies) { super(props); makeObservable(this); } @@ -64,8 +75,8 @@ export class NodesRoute extends React.Component { this.metricsWatcher.stop(); } - getLastMetricValues(node: Node, metricNames: string[]): number[] { - if (isEmpty(this.metrics)) { + getLastMetricValues(node: Node, metricNames: (keyof NodeMetricData)[]): number[] { + if (!this.metrics) { return []; } @@ -73,7 +84,7 @@ export class NodesRoute extends React.Component { return metricNames.map(metricName => { try { - const metric = this.metrics[metricName]; + const metric = this.metrics?.[metricName]; const result = metric?.data.result.find(({ metric: { node, instance, kubernetes_node }}) => ( nodeName === node || nodeName === instance @@ -175,6 +186,8 @@ export class NodesRoute extends React.Component { } render() { + const { nodeStore, eventStore } = this.props; + return ( (NonInjectedNodesRoute, { + getProps: (di, props) => ({ + ...props, + nodeStore: di.inject(nodeStoreInjectable), + eventStore: di.inject(eventStoreInjectable), + requestAllNodeMetrics: di.inject(requestAllNodeMetricsInjectable), + }), +}); diff --git a/src/renderer/components/+storage-volume-claims/volume-claim-details.tsx b/src/renderer/components/+storage-volume-claims/volume-claim-details.tsx index cd4bd5e0a6..4cb013e5d6 100644 --- a/src/renderer/components/+storage-volume-claims/volume-claim-details.tsx +++ b/src/renderer/components/+storage-volume-claims/volume-claim-details.tsx @@ -10,26 +10,39 @@ import { makeObservable, observable, reaction } from "mobx"; import { disposeOnUnmount, observer } from "mobx-react"; import { DrawerItem, DrawerTitle } from "../drawer"; import { Badge } from "../badge"; -import { podStore } from "../+workloads-pods/legacy-store"; import { Link } from "react-router-dom"; import { ResourceMetrics } from "../resource-metrics"; import { VolumeClaimDiskChart } from "./volume-claim-disk-chart"; import type { KubeObjectDetailsProps } from "../kube-object-details"; -import { getMetricsForPvc, type PersistentVolumeClaimMetricData, PersistentVolumeClaim } from "../../../common/k8s-api/endpoints"; -import { getActiveClusterEntity } from "../../api/catalog/entity/legacy-globals"; +import { PersistentVolumeClaim } from "../../../common/k8s-api/endpoints"; import { ClusterMetricsResourceType } from "../../../common/cluster-types"; import { KubeObjectMeta } from "../kube-object-meta"; -import { getDetailsUrl } from "../kube-detail-params"; import logger from "../../../common/logger"; +import type { PersistentVolumeClaimMetricData, RequestPersistentVolumeClaimMetrics } from "../../../common/k8s-api/endpoints/metrics.api/request-persistent-volume-claim-metrics.injectable"; +import { withInjectables } from "@ogre-tools/injectable-react"; +import requestPersistentVolumeClaimMetricsInjectable from "../../../common/k8s-api/endpoints/metrics.api/request-persistent-volume-claim-metrics.injectable"; +import type { GetActiveClusterEntity } from "../../api/catalog/entity/get-active-cluster-entity.injectable"; +import type { GetDetailsUrl } from "../kube-detail-params/get-details-url.injectable"; +import type { PodStore } from "../+workloads-pods/store"; +import getActiveClusterEntityInjectable from "../../api/catalog/entity/get-active-cluster-entity.injectable"; +import getDetailsUrlInjectable from "../kube-detail-params/get-details-url.injectable"; +import podStoreInjectable from "../+workloads-pods/store.injectable"; export interface PersistentVolumeClaimDetailsProps extends KubeObjectDetailsProps { } +interface Dependencies { + requestPersistentVolumeClaimMetrics: RequestPersistentVolumeClaimMetrics; + getActiveClusterEntity: GetActiveClusterEntity; + getDetailsUrl: GetDetailsUrl; + podStore: PodStore; +} + @observer -export class PersistentVolumeClaimDetails extends React.Component { +class NonInjectedPersistentVolumeClaimDetails extends React.Component { @observable metrics: PersistentVolumeClaimMetricData | null = null; - constructor(props: PersistentVolumeClaimDetailsProps) { + constructor(props: PersistentVolumeClaimDetailsProps & Dependencies) { super(props); makeObservable(this); } @@ -43,13 +56,13 @@ export class PersistentVolumeClaimDetails extends React.Component { - const { object: volumeClaim } = this.props; + const { object: volumeClaim, requestPersistentVolumeClaimMetrics } = this.props; - this.metrics = await getMetricsForPvc(volumeClaim); + this.metrics = await requestPersistentVolumeClaimMetrics(volumeClaim); }; render() { - const { object: volumeClaim } = this.props; + const { object: volumeClaim, getActiveClusterEntity, podStore, getDetailsUrl } = this.props; if (!volumeClaim) { return null; @@ -119,3 +132,13 @@ export class PersistentVolumeClaimDetails extends React.Component(NonInjectedPersistentVolumeClaimDetails, { + getProps: (di, props) => ({ + ...props, + requestPersistentVolumeClaimMetrics: di.inject(requestPersistentVolumeClaimMetricsInjectable), + getActiveClusterEntity: di.inject(getActiveClusterEntityInjectable), + getDetailsUrl: di.inject(getDetailsUrlInjectable), + podStore: di.inject(podStoreInjectable), + }), +}); diff --git a/src/renderer/components/+user-management/+service-accounts/service-account-menu.tsx b/src/renderer/components/+user-management/+service-accounts/service-account-menu.tsx index 23540ce3ea..63b1d89a20 100644 --- a/src/renderer/components/+user-management/+service-accounts/service-account-menu.tsx +++ b/src/renderer/components/+user-management/+service-accounts/service-account-menu.tsx @@ -7,20 +7,33 @@ import React from "react"; import type { KubeObjectMenuProps } from "../../kube-object-menu"; import type { ServiceAccount } from "../../../../common/k8s-api/endpoints"; import { MenuItem } from "../../menu"; -import { openServiceAccountKubeConfig } from "../../kubeconfig-dialog"; import { Icon } from "../../icon"; +import type { OpenServiceAccountKubeConfigDialog } from "../../kubeconfig-dialog/open-service-account-kube-config-dialog.injectable"; +import { withInjectables } from "@ogre-tools/injectable-react"; +import openServiceAccountKubeConfigDialogInjectable from "../../kubeconfig-dialog/open-service-account-kube-config-dialog.injectable"; -export function ServiceAccountMenu(props: KubeObjectMenuProps) { - const { object, toolbar } = props; +interface Dependencies { + openServiceAccountKubeConfigDialog: OpenServiceAccountKubeConfigDialog; +} + +function NonInjectedServiceAccountMenu(props: KubeObjectMenuProps & Dependencies) { + const { object, toolbar, openServiceAccountKubeConfigDialog } = props; return ( - openServiceAccountKubeConfig(object)}> + openServiceAccountKubeConfigDialog(object)}> Kubeconfig ); } + +export const ServiceAccountMenu = withInjectables>(NonInjectedServiceAccountMenu, { + getProps: (di, props) => ({ + ...props, + openServiceAccountKubeConfigDialog: di.inject(openServiceAccountKubeConfigDialogInjectable), + }), +}); diff --git a/src/renderer/components/+workloads-daemonsets/daemonset-details.tsx b/src/renderer/components/+workloads-daemonsets/daemonset-details.tsx index 0cc16ff6f6..40c6026659 100644 --- a/src/renderer/components/+workloads-daemonsets/daemonset-details.tsx +++ b/src/renderer/components/+workloads-daemonsets/daemonset-details.tsx @@ -15,7 +15,7 @@ import { PodDetailsAffinities } from "../+workloads-pods/pod-details-affinities" import type { DaemonSetStore } from "./store"; import type { PodStore } from "../+workloads-pods/store"; import type { KubeObjectDetailsProps } from "../kube-object-details"; -import { DaemonSet, getMetricsForDaemonSets, type PodMetricData } from "../../../common/k8s-api/endpoints"; +import { DaemonSet } from "../../../common/k8s-api/endpoints"; import { ResourceMetrics, ResourceMetricsText } from "../resource-metrics"; import { PodCharts, podMetricTabs } from "../+workloads-pods/pod-charts"; import { makeObservable, observable, reaction } from "mobx"; @@ -30,6 +30,8 @@ import daemonSetStoreInjectable from "./store.injectable"; import podStoreInjectable from "../+workloads-pods/store.injectable"; import type { GetActiveClusterEntity } from "../../api/catalog/entity/get-active-cluster-entity.injectable"; import getActiveClusterEntityInjectable from "../../api/catalog/entity/get-active-cluster-entity.injectable"; +import type { DaemonSetPodMetricData, RequestPodMetricsForDaemonSets } from "../../../common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-daemon-sets.injectable"; +import requestPodMetricsForDaemonSetsInjectable from "../../../common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-daemon-sets.injectable"; export interface DaemonSetDetailsProps extends KubeObjectDetailsProps { } @@ -39,11 +41,12 @@ interface Dependencies { daemonSetStore: DaemonSetStore; podStore: PodStore; getActiveClusterEntity: GetActiveClusterEntity; + requestPodMetricsForDaemonSets: RequestPodMetricsForDaemonSets; } @observer class NonInjectedDaemonSetDetails extends React.Component { - @observable metrics: PodMetricData | null = null; + @observable metrics: DaemonSetPodMetricData | null = null; constructor(props: DaemonSetDetailsProps & Dependencies) { super(props); @@ -62,9 +65,9 @@ class NonInjectedDaemonSetDetails extends React.Component { - const { object: daemonSet } = this.props; + const { object: daemonSet, requestPodMetricsForDaemonSets } = this.props; - this.metrics = await getMetricsForDaemonSets([daemonSet], daemonSet.getNs(), ""); + this.metrics = await requestPodMetricsForDaemonSets([daemonSet], daemonSet.getNs()); }; render() { @@ -143,5 +146,6 @@ export const DaemonSetDetails = withInjectables { } @@ -44,11 +45,12 @@ interface Dependencies { replicaSetStore: ReplicaSetStore; deploymentStore: DeploymentStore; getActiveClusterEntity: GetActiveClusterEntity; + requestPodMetricsForDeployments: RequestPodMetricsForDeployments; } @observer class NonInjectedDeploymentDetails extends React.Component { - @observable metrics: PodMetricData | null = null; + @observable metrics: DeploymentPodMetricData | null = null; constructor(props: DeploymentDetailsProps & Dependencies) { super(props); @@ -69,9 +71,9 @@ class NonInjectedDeploymentDetails extends React.Component { - const { object: deployment } = this.props; + const { object: deployment, requestPodMetricsForDeployments } = this.props; - this.metrics = await getMetricsForDeployments([deployment], deployment.getNs(), ""); + this.metrics = await requestPodMetricsForDeployments([deployment], deployment.getNs()); }; render() { @@ -173,6 +175,7 @@ export const DeploymentDetails = withInjectables { } @@ -40,11 +42,12 @@ interface Dependencies { podStore: PodStore; jobStore: JobStore; getActiveClusterEntity: GetActiveClusterEntity; + requestPodMetricsForJobs: RequestPodMetricsForJobs; } @observer class NonInjectedJobDetails extends React.Component { - @observable metrics: PodMetricData | null = null; + @observable metrics: JobPodMetricData | null = null; constructor(props: JobDetailsProps & Dependencies) { super(props); @@ -63,9 +66,9 @@ class NonInjectedJobDetails extends React.Component { - const { object: job } = this.props; + const { object: job, requestPodMetricsForJobs } = this.props; - this.metrics = await getMetricsForJobs([job], job.getNs(), ""); + this.metrics = await requestPodMetricsForJobs([job], job.getNs(), ""); }; render() { @@ -159,6 +162,7 @@ export const JobDetails = withInjectables(NonInje podStore: di.inject(podStoreInjectable), jobStore: di.inject(jobStoreInjectable), getActiveClusterEntity: di.inject(getActiveClusterEntityInjectable), + requestPodMetricsForJobs: di.inject(requestPodMetricsForJobsInjectable), }), }); diff --git a/src/renderer/components/+workloads-pods/pod-details-container.tsx b/src/renderer/components/+workloads-pods/pod-details-container.tsx index 263192473c..947dec01ac 100644 --- a/src/renderer/components/+workloads-pods/pod-details-container.tsx +++ b/src/renderer/components/+workloads-pods/pod-details-container.tsx @@ -105,7 +105,7 @@ class NonInjectedPodDetailsContainer extends React.Component {name}
    - {!isMetricHidden && !isInitContainer && ( + {(!isMetricHidden && !isInitContainer && metrics) && ( { } +interface Dependencies { + requestPodMetrics: RequestPodMetrics; + getActiveClusterEntity: GetActiveClusterEntity; + getDetailsUrl: GetDetailsUrl; + nodeApi: NodeApi; +} + @observer -export class PodDetails extends React.Component { +class NonInjectedPodDetails extends React.Component { @observable metrics: PodMetricData | null = null; @observable containerMetrics: PodMetricData | null = null; - constructor(props: PodDetailsProps) { + constructor(props: PodDetailsProps & Dependencies) { super(props); makeObservable(this); } @@ -53,14 +66,14 @@ export class PodDetails extends React.Component { } loadMetrics = async () => { - const { object: pod } = this.props; + const { object: pod, requestPodMetrics } = this.props; - this.metrics = await getMetricsForPods([pod], pod.getNs()); - this.containerMetrics = await getMetricsForPods([pod], pod.getNs(), "container, namespace"); + this.metrics = await requestPodMetrics([pod], pod.getNs()); + this.containerMetrics = await requestPodMetrics([pod], pod.getNs(), "container, namespace"); }; render() { - const { object: pod } = this.props; + const { object: pod, getActiveClusterEntity, getDetailsUrl, nodeApi } = this.props; if (!pod) { return null; @@ -183,3 +196,13 @@ export class PodDetails extends React.Component { ); } } + +export const PodDetails = withInjectables(NonInjectedPodDetails, { + getProps: (di, props) => ({ + ...props, + requestPodMetrics: di.inject(requestPodMetricsInjectable), + getActiveClusterEntity: di.inject(getActiveClusterEntityInjectable), + getDetailsUrl: di.inject(getDetailsUrlInjectable), + nodeApi: di.inject(nodeApiInjectable), + }), +}); diff --git a/src/renderer/components/+workloads-replicasets/replicaset-details.tsx b/src/renderer/components/+workloads-replicasets/replicaset-details.tsx index 6f239f3dbb..cf92b7976c 100644 --- a/src/renderer/components/+workloads-replicasets/replicaset-details.tsx +++ b/src/renderer/components/+workloads-replicasets/replicaset-details.tsx @@ -13,8 +13,7 @@ import { PodDetailsTolerations } from "../+workloads-pods/pod-details-toleration import { PodDetailsAffinities } from "../+workloads-pods/pod-details-affinities"; import { disposeOnUnmount, observer } from "mobx-react"; import type { KubeObjectDetailsProps } from "../kube-object-details"; -import type { PodMetricData } from "../../../common/k8s-api/endpoints"; -import { getMetricsForReplicaSets, ReplicaSet } from "../../../common/k8s-api/endpoints"; +import { ReplicaSet } from "../../../common/k8s-api/endpoints"; import { ResourceMetrics, ResourceMetricsText } from "../resource-metrics"; import { PodCharts, podMetricTabs } from "../+workloads-pods/pod-charts"; import { PodDetailsList } from "../+workloads-pods/pod-details-list"; @@ -30,6 +29,8 @@ import type { ReplicaSetStore } from "./store"; import replicaSetStoreInjectable from "./store.injectable"; import type { GetActiveClusterEntity } from "../../api/catalog/entity/get-active-cluster-entity.injectable"; import getActiveClusterEntityInjectable from "../../api/catalog/entity/get-active-cluster-entity.injectable"; +import type { ReplicaSetPodMetricData, RequestPodMetricsForReplicaSets } from "../../../common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-replica-sets.injectable"; +import requestPodMetricsForReplicaSetsInjectable from "../../../common/k8s-api/endpoints/metrics.api/request-pod-metrics-for-replica-sets.injectable"; export interface ReplicaSetDetailsProps extends KubeObjectDetailsProps { } @@ -39,11 +40,12 @@ interface Dependencies { podStore: PodStore; replicaSetStore: ReplicaSetStore; getActiveClusterEntity: GetActiveClusterEntity; + requestPodMetricsForReplicaSets: RequestPodMetricsForReplicaSets; } @observer class NonInjectedReplicaSetDetails extends React.Component { - @observable metrics: PodMetricData | null = null; + @observable metrics: ReplicaSetPodMetricData | null = null; constructor(props: ReplicaSetDetailsProps & Dependencies) { super(props); @@ -63,9 +65,9 @@ class NonInjectedReplicaSetDetails extends React.Component { - const { object: replicaSet } = this.props; + const { object: replicaSet, requestPodMetricsForReplicaSets } = this.props; - this.metrics = await getMetricsForReplicaSets([replicaSet], replicaSet.getNs(), ""); + this.metrics = await requestPodMetricsForReplicaSets([replicaSet], replicaSet.getNs()); }; render() { @@ -144,5 +146,6 @@ export const ReplicaSetDetails = withInjectables { } @@ -40,11 +41,12 @@ interface Dependencies { podStore: PodStore; statefulSetStore: StatefulSetStore; getActiveClusterEntity: GetActiveClusterEntity; + requestPodMetricsForStatefulSets: RequestPodMetricsForStatefulSets; } @observer class NonInjectedStatefulSetDetails extends React.Component { - @observable metrics: PodMetricData | null = null; + @observable metrics: StatefulSetPodMetricData | null = null; constructor(props: StatefulSetDetailsProps & Dependencies) { super(props); @@ -64,9 +66,9 @@ class NonInjectedStatefulSetDetails extends React.Component { - const { object: statefulSet } = this.props; + const { object: statefulSet, requestPodMetricsForStatefulSets } = this.props; - this.metrics = await getMetricsForStatefulSets([statefulSet], statefulSet.getNs(), ""); + this.metrics = await requestPodMetricsForStatefulSets([statefulSet], statefulSet.getNs()); }; render() { @@ -143,6 +145,7 @@ export const StatefulSetDetails = withInjectables void) => void; + requestAnimationFrame: RequestAnimationFrame; + defaultEnterDuration: number; + defaultLeaveDuration: number; } -@observer -class DefaultedAnimate extends React.Component { - static defaultProps = { - name: "opacity", - enter: true, - onEnter: noop, - onLeave: noop, - enterDuration: 100, - leaveDuration: 100, - }; +const NonInjectedAnimate = (propsAndDeps: AnimateProps & Dependencies) => { + const { + requestAnimationFrame, + defaultEnterDuration, + defaultLeaveDuration, + ...props + } = propsAndDeps; + const { + children, + enter = true, + enterDuration = defaultEnterDuration, + leaveDuration = defaultLeaveDuration, + name = "opacity", + onEnter: onEnterHandler = noop<[]>, + onLeave: onLeaveHandler = noop<[]>, + } = props; - @observable isVisible = !!this.props.enter; - @observable statusClassName = { - enter: false, - leave: false, - }; + const [isVisible, setIsVisible] = useState(false); + const [showClassNameEnter, setShowClassNameEnter] = useState(false); + const [showClassNameLeave, setShowClassNameLeave] = useState(false); - constructor(props: AnimateProps & Dependencies & typeof DefaultedAnimate.defaultProps) { - super(props); - makeObservable(this); - } + const contentElem = React.Children.only(children) as React.ReactElement>; + const classNames = cssNames("Animate", name, contentElem.props.className, { + enter: showClassNameEnter, + leave: showClassNameLeave, + }); - get contentElem() { - return React.Children.only(this.props.children) as React.ReactElement>; - } - - private toggle(enter: boolean) { + useEffect(() => { if (enter) { - this.enter(); - } else { - this.leave(); - } - } + setIsVisible(true); - componentDidMount() { - this.toggle(this.props.enter); - } + requestAnimationFrame(() => { + setShowClassNameEnter(true); + onEnterHandler(); + }); - componentDidUpdate(prevProps: Readonly): void { - const { enter } = this.props; + return noop; + } else if (isVisible) { + setShowClassNameLeave(true); + onLeaveHandler(); - if (prevProps.enter !== enter) { - this.toggle(enter); - } - } + // Cleanup after duration + const handle = setTimeout(() => { + setIsVisible(false); + setShowClassNameEnter(false); + setShowClassNameLeave(false); + }, leaveDuration); - enter() { - this.isVisible = true; // triggers render() to apply css-animation in existing dom - - this.props.requestAnimationFrame(() => { - this.statusClassName.enter = true; - this.props.onEnter(); - }); - } - - leave() { - if (!this.isVisible) return; - this.statusClassName.leave = true; - this.props.onLeave(); - this.resetAfterLeaveDuration(); - } - - resetAfterLeaveDuration() { - setTimeout(() => this.reset(), this.props.leaveDuration); - } - - reset() { - this.isVisible = false; - this.statusClassName.enter = false; - this.statusClassName.leave = false; - } - - render() { - if (!this.isVisible) { - return null; + return () => clearTimeout(handle); } - const { name, enterDuration, leaveDuration } = this.props; - const contentElem = this.contentElem; - const cssVarsForAnimation = { - "--enter-duration": `${enterDuration}ms`, - "--leave-duration": `${leaveDuration}ms`, - } as React.CSSProperties; + return noop; + }, [enter]); - return React.cloneElement(contentElem, { - className: cssNames("Animate", name, contentElem.props.className, this.statusClassName), - children: contentElem.props.children, - style: { - ...contentElem.props.style, - ...cssVarsForAnimation, - }, - }); + if (!isVisible) { + return null; } -} -export const NonInjectedAnimate = (props: AnimateProps & Dependencies) => ; - -export const Animate = withInjectables( - NonInjectedAnimate, - - { - getProps: (di, props) => ({ - requestAnimationFrame: di.inject(requestAnimationFrameInjectable), - ...props, - }), - }, -); + const cssVarsForAnimation = { + "--enter-duration": `${enterDuration}ms`, + "--leave-duration": `${leaveDuration}ms`, + } as React.CSSProperties; + return React.cloneElement(contentElem, { + className: classNames, + children: contentElem.props.children, + style: { + ...contentElem.props.style, + ...cssVarsForAnimation, + }, + }); +}; +export const Animate = withInjectables(NonInjectedAnimate, { + getProps: (di, props) => ({ + ...props, + requestAnimationFrame: di.inject(requestAnimationFrameInjectable), + defaultEnterDuration: di.inject(defaultEnterDurationForAnimatedInjectable), + defaultLeaveDuration: di.inject(defaultLeaveDurationForAnimatedInjectable), + }), +}); diff --git a/src/renderer/components/animate/default-enter-duration.injectable.ts b/src/renderer/components/animate/default-enter-duration.injectable.ts new file mode 100644 index 0000000000..c28f8a3346 --- /dev/null +++ b/src/renderer/components/animate/default-enter-duration.injectable.ts @@ -0,0 +1,12 @@ +/** + * 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"; + +const defaultEnterDurationForAnimatedInjectable = getInjectable({ + id: "default-enter-duration-for-animated", + instantiate: () => 100, +}); + +export default defaultEnterDurationForAnimatedInjectable; diff --git a/src/renderer/components/animate/default-leave-duration.injectable.ts b/src/renderer/components/animate/default-leave-duration.injectable.ts new file mode 100644 index 0000000000..01193151ab --- /dev/null +++ b/src/renderer/components/animate/default-leave-duration.injectable.ts @@ -0,0 +1,12 @@ +/** + * 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"; + +const defaultLeaveDurationForAnimatedInjectable = getInjectable({ + id: "default-leave-duration-for-animated", + instantiate: () => 100, +}); + +export default defaultLeaveDurationForAnimatedInjectable; diff --git a/src/renderer/components/animate/request-animation-frame.injectable.ts b/src/renderer/components/animate/request-animation-frame.injectable.ts index f61b2ae874..c04fa3a72e 100644 --- a/src/renderer/components/animate/request-animation-frame.injectable.ts +++ b/src/renderer/components/animate/request-animation-frame.injectable.ts @@ -4,9 +4,12 @@ */ import { getInjectable } from "@ogre-tools/injectable"; +export type RequestAnimationFrame = (callback: () => void) => void; + const requestAnimationFrameInjectable = getInjectable({ id: "request-animation-frame", - instantiate: () => (callback: () => void) => requestAnimationFrame(callback), + // NOTE: this cannot be simplified to just `=> requestAnimationFrame` else an Illegal Invocation error will be thrown + instantiate: (): RequestAnimationFrame => (callback) => requestAnimationFrame(callback), causesSideEffects: true, }); diff --git a/src/renderer/components/cluster-settings/components/cluster-local-terminal-settings.tsx b/src/renderer/components/cluster-settings/components/cluster-local-terminal-settings.tsx index 3a5c1c4d2d..228b9caeec 100644 --- a/src/renderer/components/cluster-settings/components/cluster-local-terminal-settings.tsx +++ b/src/renderer/components/cluster-settings/components/cluster-local-terminal-settings.tsx @@ -9,7 +9,6 @@ import type { Cluster } from "../../../../common/cluster/cluster"; import { Input } from "../../input"; import { SubTitle } from "../../layout/sub-title"; import type { ShowNotification } from "../../notifications"; -import { resolveTilde } from "../../../utils"; import { Icon } from "../../icon"; import { PathPicker } from "../../path-picker"; import { isWindows } from "../../../../common/vars"; @@ -17,6 +16,8 @@ import { withInjectables } from "@ogre-tools/injectable-react"; import showErrorNotificationInjectable from "../../notifications/show-error-notification.injectable"; import type { ValidateDirectory } from "../../../../common/fs/validate-directory.injectable"; import validateDirectoryInjectable from "../../../../common/fs/validate-directory.injectable"; +import type { ResolveTilde } from "../../../../common/path/resolve-tilde.injectable"; +import resolveTildeInjectable from "../../../../common/path/resolve-tilde.injectable"; export interface ClusterLocalTerminalSettingProps { cluster: Cluster; @@ -24,9 +25,15 @@ export interface ClusterLocalTerminalSettingProps { interface Dependencies { showErrorNotification: ShowNotification; validateDirectory: ValidateDirectory; + resolveTilde: ResolveTilde; } -const NonInjectedClusterLocalTerminalSetting = observer(({ cluster, showErrorNotification, validateDirectory }: Dependencies & ClusterLocalTerminalSettingProps) => { +const NonInjectedClusterLocalTerminalSetting = observer(({ + cluster, + showErrorNotification, + validateDirectory, + resolveTilde, +}: Dependencies & ClusterLocalTerminalSettingProps) => { if (!cluster) { return null; } @@ -150,15 +157,11 @@ const NonInjectedClusterLocalTerminalSetting = observer(({ cluster, showErrorNot ); }); -export const ClusterLocalTerminalSetting = withInjectables( - NonInjectedClusterLocalTerminalSetting, - - { - getProps: (di, props) => ({ - showErrorNotification: di.inject(showErrorNotificationInjectable), - validateDirectory: di.inject(validateDirectoryInjectable), - ...props, - }), - }, -); - +export const ClusterLocalTerminalSetting = withInjectables(NonInjectedClusterLocalTerminalSetting, { + getProps: (di, props) => ({ + ...props, + showErrorNotification: di.inject(showErrorNotificationInjectable), + validateDirectory: di.inject(validateDirectoryInjectable), + resolveTilde: di.inject(resolveTildeInjectable), + }), +}); diff --git a/src/renderer/components/cluster-settings/components/cluster-prometheus-setting.tsx b/src/renderer/components/cluster-settings/components/cluster-prometheus-setting.tsx index c4f689bb58..0a07aa030a 100644 --- a/src/renderer/components/cluster-settings/components/cluster-prometheus-setting.tsx +++ b/src/renderer/components/cluster-settings/components/cluster-prometheus-setting.tsx @@ -11,10 +11,10 @@ import type { SelectOption } from "../../select"; import { Select } from "../../select"; import { Input } from "../../input"; import { observable, computed, autorun, makeObservable } from "mobx"; -import type { MetricProviderInfo } from "../../../../common/k8s-api/endpoints/metrics.api"; -import { metricsApi } from "../../../../common/k8s-api/endpoints/metrics.api"; import { Spinner } from "../../spinner"; +import type { MetricProviderInfo, RequestMetricsProviders } from "../../../../common/k8s-api/endpoints/metrics.api/request-providers.injectable"; import { withInjectables } from "@ogre-tools/injectable-react"; +import requestMetricsProvidersInjectable from "../../../../common/k8s-api/endpoints/metrics.api/request-providers.injectable"; import productNameInjectable from "../../../../common/vars/product-name.injectable"; export interface ClusterPrometheusSettingProps { @@ -27,6 +27,7 @@ type ProviderValue = typeof autoDetectPrometheus | string; interface Dependencies { productName: string; + requestMetricsProviders: RequestMetricsProviders; } @observer @@ -85,8 +86,7 @@ class NonInjectedClusterPrometheusSetting extends React.Component { this.loading = false; this.loadedOptions.replace(values.map(provider => [provider.id, provider])); @@ -174,5 +174,6 @@ export const ClusterPrometheusSetting = withInjectables ({ ...props, productName: di.inject(productNameInjectable), + requestMetricsProviders: di.inject(requestMetricsProvidersInjectable), }), }); diff --git a/src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx b/src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx deleted file mode 100644 index ad810ef2dd..0000000000 --- a/src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx +++ /dev/null @@ -1,275 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ -import "@testing-library/jest-dom/extend-expect"; -import { KubeConfig } from "@kubernetes/client-node"; -import { fireEvent } from "@testing-library/react"; -import type { RenderResult } from "@testing-library/react"; -import * as selectEvent from "react-select-event"; -import type { CreateCluster } from "../../../../common/cluster/create-cluster-injection-token"; -import { createClusterInjectionToken } from "../../../../common/cluster/create-cluster-injection-token"; -import createContextHandlerInjectable from "../../../../main/context-handler/create-context-handler.injectable"; -import storesAndApisCanBeCreatedInjectable from "../../../stores-apis-can-be-created.injectable"; -import createKubeconfigManagerInjectable from "../../../../main/kubeconfig-manager/create-kubeconfig-manager.injectable"; -import type { ApplicationBuilder } from "../../test-utils/get-application-builder"; -import { getApplicationBuilder } from "../../test-utils/get-application-builder"; -import normalizedPlatformInjectable from "../../../../common/vars/normalized-platform.injectable"; -import kubectlBinaryNameInjectable from "../../../../main/kubectl/binary-name.injectable"; -import kubectlDownloadingNormalizedArchInjectable from "../../../../main/kubectl/normalized-arch.injectable"; -import type { OpenDeleteClusterDialog } from "../open.injectable"; -import openDeleteClusterDialogInjectable from "../open.injectable"; - -const currentClusterServerUrl = "https://localhost"; -const nonCurrentClusterServerUrl = "http://localhost"; -const multiClusterConfig = ` -apiVersion: v1 -clusters: -- cluster: - server: ${currentClusterServerUrl} - name: some-current-context-cluster -- cluster: - server: ${nonCurrentClusterServerUrl} - name: some-non-current-context-cluster -contexts: -- context: - cluster: some-current-context-cluster - user: some-user - name: some-current-context -- context: - cluster: some-non-current-context-cluster - user: some-user - name: some-non-current-context -current-context: some-current-context -kind: Config -preferences: {} -users: -- name: some-user - user: - token: kubeconfig-user-q4lm4:xxxyyyy -`; - -const singleClusterServerUrl = "http://localhost"; -const singleClusterConfig = ` -apiVersion: v1 -clusters: -- cluster: - server: ${singleClusterServerUrl} - name: some-cluster -contexts: -- context: - cluster: some-cluster - user: some-user - name: some-context -current-context: some-context -kind: Config -preferences: {} -users: -- name: some-user - user: - token: kubeconfig-user-q4lm4:xxxyyyy -`; - -describe("", () => { - let builder: ApplicationBuilder; - - beforeEach(() => { - builder = getApplicationBuilder(); - - builder.beforeApplicationStart((mainDi) => { - mainDi.override(createContextHandlerInjectable, () => () => undefined as never); - mainDi.override(createKubeconfigManagerInjectable, () => () => undefined as never); - mainDi.override(kubectlBinaryNameInjectable, () => "kubectl"); - mainDi.override(kubectlDownloadingNormalizedArchInjectable, () => "amd64"); - mainDi.override(normalizedPlatformInjectable, () => "darwin"); - }); - - builder.beforeWindowStart((windowDi) => { - windowDi.override(storesAndApisCanBeCreatedInjectable, () => true); - }); - }); - - it("shows context switcher when deleting current cluster", async () => { - const config = new KubeConfig(); - - config.loadFromString(multiClusterConfig); - - const rendered = await builder.render(); - - const windowDi = builder.applicationWindow.only.di; - - const createCluster = windowDi.inject(createClusterInjectionToken); - - const cluster = createCluster({ - id: "some-current-context-cluster", - contextName: "some-current-context", - preferences: { - clusterName: "some-current-context-cluster", - }, - kubeConfigPath: "./temp-kube-config", - }, { - clusterServerUrl: currentClusterServerUrl, - }); - - const openDeleteClusterDialog = windowDi.inject(openDeleteClusterDialogInjectable); - - openDeleteClusterDialog({ cluster, config }); - - const { getByText } = rendered; - - const menu = getByText("Select new context..."); - - expect(menu).toBeInTheDocument(); - selectEvent.openMenu(menu); - - expect(getByText("some-current-context")).toBeInTheDocument(); - expect(getByText("some-non-current-context")).toBeInTheDocument(); - }); - - describe("Kubeconfig with different clusters", () => { - let rendered: RenderResult; - let openDeleteClusterDialog: OpenDeleteClusterDialog; - let createCluster: CreateCluster; - let config: KubeConfig; - - beforeEach(async () => { - config = new KubeConfig(); - - config.loadFromString(multiClusterConfig); - - rendered = await builder.render(); - - const windowDi = builder.applicationWindow.only.di; - - openDeleteClusterDialog = windowDi.inject(openDeleteClusterDialogInjectable); - createCluster = windowDi.inject(createClusterInjectionToken); - }); - - it("renders w/o errors", () => { - expect(rendered.container).toBeInstanceOf(HTMLElement); - }); - - it("shows warning when deleting non-current-context cluster", () => { - const cluster = createCluster({ - id: "some-non-current-context-cluster", - contextName: "some-non-current-context", - preferences: { - clusterName: "minikube", - }, - kubeConfigPath: "./temp-kube-config", - }, { - clusterServerUrl: nonCurrentClusterServerUrl, - }); - - openDeleteClusterDialog({ cluster, config }); - - const message = "The contents of kubeconfig file will be changed!"; - - expect(rendered.getByText(message)).toBeInstanceOf(HTMLElement); - }); - - it("shows warning when deleting current-context cluster", () => { - const cluster = createCluster({ - id: "some-current-context-cluster", - contextName: "some-current-context", - preferences: { - clusterName: "some-current-context-cluster", - }, - kubeConfigPath: "./temp-kube-config", - }, { - clusterServerUrl: currentClusterServerUrl, - }); - - openDeleteClusterDialog({ cluster, config }); - - expect(rendered.getByTestId("current-context-warning")).toBeInstanceOf(HTMLElement); - }); - - it("shows context switcher after checkbox click", () => { - const cluster = createCluster({ - id: "some-current-context-cluster", - contextName: "some-current-context", - preferences: { - clusterName: "some-current-context-cluster", - }, - kubeConfigPath: "./temp-kube-config", - }, { - clusterServerUrl: currentClusterServerUrl, - }); - - openDeleteClusterDialog({ cluster, config }); - - const { getByText, getByTestId } = rendered; - const link = getByTestId("context-switch"); - - expect(link).toBeInstanceOf(HTMLElement); - fireEvent.click(link); - - const menu = getByText("Select new context..."); - - expect(menu).toBeInTheDocument(); - selectEvent.openMenu(menu); - - expect(getByText("some-current-context")).toBeInTheDocument(); - expect(getByText("some-non-current-context")).toBeInTheDocument(); - }); - - it("given cluster in internal kubeconfig, when deleting cluster outside of current context, shows warning for internal kubeconfig cluster", () => { - const cluster = createCluster({ - id: "some-non-current-context-cluster", - contextName: "some-non-current-context", - preferences: { - clusterName: "some-non-current-context-cluster", - }, - kubeConfigPath: "./temp-kube-config", - }, { - clusterServerUrl: nonCurrentClusterServerUrl, - }); - - const spy = jest.spyOn(cluster, "isInLocalKubeconfig").mockImplementation(() => true); - - openDeleteClusterDialog({ cluster, config }); - - expect(rendered.getByTestId("internal-kubeconfig-warning")).toBeInstanceOf(HTMLElement); - - spy.mockRestore(); - }); - }); - - describe("Kubeconfig with single cluster", () => { - let rendered: RenderResult; - let openDeleteClusterDialog: OpenDeleteClusterDialog; - let createCluster: CreateCluster; - let config: KubeConfig; - - beforeEach(async () => { - config = new KubeConfig(); - - config.loadFromString(singleClusterConfig); - - rendered = await builder.render(); - - const windowDi = builder.applicationWindow.only.di; - - openDeleteClusterDialog = windowDi.inject(openDeleteClusterDialogInjectable); - createCluster = windowDi.inject(createClusterInjectionToken); - }); - - it("shows warning if no other contexts left", () => { - const cluster = createCluster({ - id: "some-cluster", - contextName: "some-context", - preferences: { - clusterName: "some-cluster", - }, - kubeConfigPath: "./temp-kube-config", - }, { - clusterServerUrl: singleClusterServerUrl, - }); - - openDeleteClusterDialog({ cluster, config }); - - expect(rendered.getByTestId("no-more-contexts-warning")).toBeInstanceOf(HTMLElement); - }); - }); -}); diff --git a/src/renderer/components/delete-cluster-dialog/delete-cluster-dialog-cluster-frame-child-component.injectable.ts b/src/renderer/components/delete-cluster-dialog/delete-cluster-dialog-cluster-frame-child-component.injectable.ts index ed91967d39..e427768ae9 100644 --- a/src/renderer/components/delete-cluster-dialog/delete-cluster-dialog-cluster-frame-child-component.injectable.ts +++ b/src/renderer/components/delete-cluster-dialog/delete-cluster-dialog-cluster-frame-child-component.injectable.ts @@ -17,8 +17,6 @@ const deleteClusterDialogClusterFrameChildComponentInjectable = getInjectable({ }), injectionToken: clusterFrameChildComponentInjectionToken, - - causesSideEffects: true, }); export default deleteClusterDialogClusterFrameChildComponentInjectable; diff --git a/src/renderer/components/delete-cluster-dialog/save-config.ts b/src/renderer/components/delete-cluster-dialog/save-config.ts deleted file mode 100644 index 6037470c60..0000000000 --- a/src/renderer/components/delete-cluster-dialog/save-config.ts +++ /dev/null @@ -1,21 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import type { KubeConfig } from "@kubernetes/client-node"; -import { dumpYaml } from "@kubernetes/client-node"; -import fs from "fs"; -import * as lockFile from "proper-lockfile"; - -export async function saveKubeconfig(config: KubeConfig, path: string) { - try { - const release = await lockFile.lock(path); - const contents = dumpYaml(JSON.parse(config.exportConfig())); - - await fs.promises.writeFile(path, contents); - await release(); - } catch (e) { - throw new Error(`Failed to acquire lock file.\n${e}`); - } -} diff --git a/src/renderer/components/delete-cluster-dialog/save-kubeconfig.global-override-for-injectable.ts b/src/renderer/components/delete-cluster-dialog/save-kubeconfig.global-override-for-injectable.ts new file mode 100644 index 0000000000..6fca6db49b --- /dev/null +++ b/src/renderer/components/delete-cluster-dialog/save-kubeconfig.global-override-for-injectable.ts @@ -0,0 +1,11 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../../../common/test-utils/get-global-override"; +import saveKubeconfigInjectable from "./save-kubeconfig.injectable"; + +export default getGlobalOverride(saveKubeconfigInjectable, () => async () => { + throw new Error("tried to save a mondified kubeconfig without override"); +}); diff --git a/src/renderer/components/delete-cluster-dialog/save-kubeconfig.injectable.ts b/src/renderer/components/delete-cluster-dialog/save-kubeconfig.injectable.ts new file mode 100644 index 0000000000..b264a2fd30 --- /dev/null +++ b/src/renderer/components/delete-cluster-dialog/save-kubeconfig.injectable.ts @@ -0,0 +1,35 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import type { KubeConfig } from "@kubernetes/client-node"; +import { dumpYaml } from "@kubernetes/client-node"; +import * as lockFile from "proper-lockfile"; +import { getInjectable } from "@ogre-tools/injectable"; +import writeFileInjectable from "../../../common/fs/write-file.injectable"; + +export type SaveKubeconfig = (config: KubeConfig, path: string) => Promise; + +const saveKubeconfigInjectable = getInjectable({ + id: "save-kubeconfig", + instantiate: (di): SaveKubeconfig => { + const writeFile = di.inject(writeFileInjectable); + + return async (config, filePath) => { + const release = await lockFile.lock(filePath); + + try { + const contents = dumpYaml(JSON.parse(config.exportConfig())); + + await writeFile(filePath, contents); + } finally { + await release(); + } + }; + }, + causesSideEffects: true, +}); + +export default saveKubeconfigInjectable; + diff --git a/src/renderer/components/delete-cluster-dialog/view.tsx b/src/renderer/components/delete-cluster-dialog/view.tsx index 3d86bae4a9..69b3bc1612 100644 --- a/src/renderer/components/delete-cluster-dialog/view.tsx +++ b/src/renderer/components/delete-cluster-dialog/view.tsx @@ -10,22 +10,34 @@ import { observer } from "mobx-react"; import React from "react"; import { Button } from "../button"; -import { saveKubeconfig } from "./save-config"; -import { Notifications } from "../notifications"; +import type { ShowNotification } from "../notifications"; import { Dialog } from "../dialog"; import { Icon } from "../icon"; import { Select } from "../select"; import { Checkbox } from "../checkbox"; -import { requestClearClusterAsDeleting, requestDeleteCluster, requestSetClusterAsDeleting } from "../../ipc"; import type { HotbarStore } from "../../../common/hotbars/store"; import { withInjectables } from "@ogre-tools/injectable-react"; import hotbarStoreInjectable from "../../../common/hotbars/store.injectable"; import type { DeleteClusterDialogState } from "./state.injectable"; import deleteClusterDialogStateInjectable from "./state.injectable"; +import type { RequestSetClusterAsDeleting } from "../../../features/cluster/delete-dialog/renderer/request-set-as-deleting.injectable"; +import requestSetClusterAsDeletingInjectable from "../../../features/cluster/delete-dialog/renderer/request-set-as-deleting.injectable"; +import type { RequestClearClusterAsDeleting } from "../../../features/cluster/delete-dialog/renderer/request-clear-as-deleting.injectable"; +import requestClearClusterAsDeletingInjectable from "../../../features/cluster/delete-dialog/renderer/request-clear-as-deleting.injectable"; +import type { RequestDeleteCluster } from "../../../features/cluster/delete-dialog/renderer/request-delete.injectable"; +import requestDeleteClusterInjectable from "../../../features/cluster/delete-dialog/renderer/request-delete.injectable"; +import type { SaveKubeconfig } from "./save-kubeconfig.injectable"; +import saveKubeconfigInjectable from "./save-kubeconfig.injectable"; +import showErrorNotificationInjectable from "../notifications/show-error-notification.injectable"; -export interface Dependencies { +interface Dependencies { state: IObservableValue; hotbarStore: HotbarStore; + requestSetClusterAsDeleting: RequestSetClusterAsDeleting; + requestDeleteCluster: RequestDeleteCluster; + requestClearClusterAsDeleting: RequestClearClusterAsDeleting; + showErrorNotification: ShowNotification; + saveKubeconfig: SaveKubeconfig; } @observer @@ -61,18 +73,18 @@ class NonInjectedDeleteClusterDialog extends React.Component { async onDelete(state: DeleteClusterDialogState) { const { cluster, config } = state; - await requestSetClusterAsDeleting(cluster.id); + await this.props.requestSetClusterAsDeleting(cluster.id); this.removeContext(state); this.changeCurrentContext(state); try { - await saveKubeconfig(config, cluster.kubeConfigPath); + await this.props.saveKubeconfig(config, cluster.kubeConfigPath); this.props.hotbarStore.removeAllHotbarItems(cluster.id); - await requestDeleteCluster(cluster.id); + await this.props.requestDeleteCluster(cluster.id); } catch(error) { - Notifications.error(`Cannot remove cluster, failed to process config file. ${error}`); + this.props.showErrorNotification(`Cannot remove cluster, failed to process config file. ${error}`); } finally { - await requestClearClusterAsDeleting(cluster.id); + await this.props.requestClearClusterAsDeleting(cluster.id); } this.onClose(); @@ -155,6 +167,14 @@ class NonInjectedDeleteClusterDialog extends React.Component { } getWarningMessage({ cluster, config }: DeleteClusterDialogState) { + if (cluster.isInLocalKubeconfig()) { + return ( +

    + Are you sure you want to delete it? It can be re-added through the copy/paste mechanism. +

    + ); + } + const contexts = config.contexts.filter(context => context.name !== cluster.contextName); if (!contexts.length) { @@ -173,14 +193,6 @@ class NonInjectedDeleteClusterDialog extends React.Component { ); } - if (cluster.isInLocalKubeconfig()) { - return ( -

    - Are you sure you want to delete it? It can be re-added through the copy/paste mechanism. -

    - ); - } - return (

    The contents of kubeconfig file will be changed!

    ); @@ -209,7 +221,7 @@ class NonInjectedDeleteClusterDialog extends React.Component {
    Select current-context @@ -255,6 +267,7 @@ class NonInjectedDeleteClusterDialog extends React.Component { close={this.close} onClose={this.onClose} onOpen={state && (() => this.onOpen(state))} + data-testid={state ? "delete-cluster-dialog" : undefined} > {state && this.renderContents(state)} @@ -266,5 +279,10 @@ export const DeleteClusterDialog = withInjectables(NonInjectedDele getProps: (di) => ({ hotbarStore: di.inject(hotbarStoreInjectable), state: di.inject(deleteClusterDialogStateInjectable), + requestSetClusterAsDeleting: di.inject(requestSetClusterAsDeletingInjectable), + requestClearClusterAsDeleting: di.inject(requestClearClusterAsDeletingInjectable), + requestDeleteCluster: di.inject(requestDeleteClusterInjectable), + saveKubeconfig: di.inject(saveKubeconfigInjectable), + showErrorNotification: di.inject(showErrorNotificationInjectable), }), }); diff --git a/src/renderer/components/dialog/dialog.tsx b/src/renderer/components/dialog/dialog.tsx index a8f8c93bdc..0d7bfb24c7 100644 --- a/src/renderer/components/dialog/dialog.tsx +++ b/src/renderer/components/dialog/dialog.tsx @@ -146,13 +146,11 @@ class NonInjectedDialog extends React.PureComponent Promise; - readFile: (filePath: string) => Promise; - getAbsolutePath: GetAbsolutePath; - staticFilesDirectory: string; -} - -async function getTemplates({ readDir, readFile, getAbsolutePath, staticFilesDirectory }: Dependencies) { - const templatesFolder = getAbsolutePath(staticFilesDirectory, "../templates/create-resource"); - - /** - * Mapping between file names and their contents - */ - const templates: [file: string, contents: string][] = []; - - for (const dirEntry of await readDir(templatesFolder)) { - if (hasCorrectExtension(dirEntry)) { - templates.push([path.parse(dirEntry).name, await readFile(path.join(templatesFolder, dirEntry))]); - } - } - - return templates; -} +import joinPathsInjectable from "../../../../common/path/join-paths.injectable"; +import parsePathInjectable from "../../../../common/path/parse.injectable"; const lensCreateResourceTemplatesInjectable = getInjectable({ id: "lens-create-resource-templates", instantiate: async (di): Promise => { - const templates = await getTemplates({ - readFile: di.inject(readFileInjectable), - readDir: di.inject(readDirInjectable), - getAbsolutePath: di.inject(getAbsolutePathInjectable), - staticFilesDirectory: di.inject(staticFilesDirectoryInjectable), - }); + const readFile = di.inject(readFileInjectable); + const readDir = di.inject(readDirectoryInjectable); + const joinPaths = di.inject(joinPathsInjectable); + const staticFilesDirectory = di.inject(staticFilesDirectoryInjectable); + const parsePath = di.inject(parsePathInjectable); + + /** + * Mapping between file names and their contents + */ + const templates: [file: string, contents: string][] = []; + const templatesFolder = joinPaths(staticFilesDirectory, "../templates/create-resource"); + + for (const dirEntry of await readDir(templatesFolder)) { + if (hasCorrectExtension(dirEntry)) { + templates.push([parsePath(dirEntry).name, await readFile(joinPaths(templatesFolder, dirEntry))]); + } + } return ["lens", templates]; }, diff --git a/src/renderer/components/dock/create-resource/user-templates.injectable.ts b/src/renderer/components/dock/create-resource/user-templates.injectable.ts index 524dad3d86..65b896f95d 100644 --- a/src/renderer/components/dock/create-resource/user-templates.injectable.ts +++ b/src/renderer/components/dock/create-resource/user-templates.injectable.ts @@ -3,101 +3,108 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import type { IComputedValue } from "mobx"; import { computed, observable } from "mobx"; -import path from "path"; -import os from "os"; import { delay, getOrInsert, isErrnoException, waitForPath } from "../../../utils"; -import { watch } from "chokidar"; import { readFile } from "fs/promises"; -import logger from "../../../../common/logger"; import { hasCorrectExtension } from "./has-correct-extension"; import type { RawTemplates } from "./create-resource-templates.injectable"; - -const userTemplatesFolder = path.join(os.homedir(), ".k8slens", "templates"); - -function groupTemplates(templates: Map): RawTemplates[] { - const res = new Map(); - - for (const [filePath, contents] of templates) { - const rawRelative = path.dirname(path.relative(userTemplatesFolder, filePath)); - const title = rawRelative === "." - ? "ungrouped" - : rawRelative; - - getOrInsert(res, title, []).push([path.parse(filePath).name, contents]); - } - - return [...res.entries()]; -} - -function watchUserCreateResourceTemplates(): IComputedValue { - /** - * Map between filePaths and template contents - */ - const templates = observable.map(); - - const onAddOrChange = async (filePath: string) => { - if (!hasCorrectExtension(filePath)) { - // ignore non yaml or json files - return; - } - - try { - const contents = await readFile(filePath, "utf-8"); - - templates.set(filePath, contents); - } catch (error) { - if (isErrnoException(error) && error.code === "ENOENT") { - // ignore, file disappeared - } else { - logger.warn(`[USER-CREATE-RESOURCE-TEMPLATES]: encountered error while reading ${filePath}`, error); - } - } - }; - const onUnlink = (filePath: string) => { - templates.delete(filePath); - }; - - (async () => { - for (let i = 1;; i *= 2) { - try { - await waitForPath(userTemplatesFolder); - break; - } catch (error) { - logger.warn(`[USER-CREATE-RESOURCE-TEMPLATES]: encountered error while waiting for ${userTemplatesFolder} to exist, waiting and trying again`, error); - await delay(i * 1000); // exponential backoff in seconds - } - } - - /** - * NOTE: There is technically a race condition here of the form "time-of-check to time-of-use" - */ - watch(userTemplatesFolder, { - disableGlobbing: true, - ignorePermissionErrors: true, - usePolling: false, - awaitWriteFinish: { - pollInterval: 100, - stabilityThreshold: 1000, - }, - ignoreInitial: false, - atomic: 150, // for "atomic writes" - }) - .on("add", onAddOrChange) - .on("change", onAddOrChange) - .on("unlink", onUnlink) - .on("error", error => { - logger.warn(`[USER-CREATE-RESOURCE-TEMPLATES]: encountered error while watching files under ${userTemplatesFolder}`, error); - }); - })(); - - return computed(() => groupTemplates(templates)); -} +import joinPathsInjectable from "../../../../common/path/join-paths.injectable"; +import watchInjectable from "../../../../common/fs/watch/watch.injectable"; +import getRelativePathInjectable from "../../../../common/path/get-relative-path.injectable"; +import homeDirectoryPathInjectable from "../../../../common/os/home-directory-path.injectable"; +import getDirnameOfPathInjectable from "../../../../common/path/get-dirname.injectable"; +import loggerInjectable from "../../../../common/logger.injectable"; +import parsePathInjectable from "../../../../common/path/parse.injectable"; const userCreateResourceTemplatesInjectable = getInjectable({ id: "user-create-resource-templates", - instantiate: () => watchUserCreateResourceTemplates(), + instantiate: (di) => { + const joinPaths = di.inject(joinPathsInjectable); + const watch = di.inject(watchInjectable); + const getRelativePath = di.inject(getRelativePathInjectable); + const homeDirectoryPath = di.inject(homeDirectoryPathInjectable); + const getDirnameOfPath = di.inject(getDirnameOfPathInjectable); + const logger = di.inject(loggerInjectable); + const parsePath = di.inject(parsePathInjectable); + + const userTemplatesFolder = joinPaths(homeDirectoryPath, ".k8slens", "templates"); + const groupTemplates = (templates: Map): RawTemplates[] => { + const res = new Map(); + + for (const [filePath, contents] of templates) { + const rawRelative = getDirnameOfPath(getRelativePath(userTemplatesFolder, filePath)); + const title = rawRelative === "." + ? "ungrouped" + : rawRelative; + + getOrInsert(res, title, []).push([parsePath(filePath).name, contents]); + } + + return [...res.entries()]; + }; + + /** + * Map between filePaths and template contents + */ + const templates = observable.map(); + + const onAddOrChange = async (filePath: string) => { + if (!hasCorrectExtension(filePath)) { + // ignore non yaml or json files + return; + } + + try { + const contents = await readFile(filePath, "utf-8"); + + templates.set(filePath, contents); + } catch (error) { + if (isErrnoException(error) && error.code === "ENOENT") { + // ignore, file disappeared + } else { + logger.warn(`[USER-CREATE-RESOURCE-TEMPLATES]: encountered error while reading ${filePath}`, error); + } + } + }; + const onUnlink = (filePath: string) => { + templates.delete(filePath); + }; + + (async () => { + for (let i = 1;; i *= 2) { + try { + await waitForPath(userTemplatesFolder); + break; + } catch (error) { + logger.warn(`[USER-CREATE-RESOURCE-TEMPLATES]: encountered error while waiting for ${userTemplatesFolder} to exist, waiting and trying again`, error); + await delay(i * 1000); // exponential backoff in seconds + } + } + + /** + * NOTE: There is technically a race condition here of the form "time-of-check to time-of-use" + */ + watch(userTemplatesFolder, { + disableGlobbing: true, + ignorePermissionErrors: true, + usePolling: false, + awaitWriteFinish: { + pollInterval: 100, + stabilityThreshold: 1000, + }, + ignoreInitial: false, + atomic: 150, // for "atomic writes" + }) + .on("add", onAddOrChange) + .on("change", onAddOrChange) + .on("unlink", onUnlink) + .on("error", error => { + logger.warn(`[USER-CREATE-RESOURCE-TEMPLATES]: encountered error while watching files under ${userTemplatesFolder}`, error); + }); + })(); + + return computed(() => groupTemplates(templates)); + }, }); export default userCreateResourceTemplatesInjectable; diff --git a/src/renderer/components/dock/create-resource/view.tsx b/src/renderer/components/dock/create-resource/view.tsx index a9245e4494..d84a823259 100644 --- a/src/renderer/components/dock/create-resource/view.tsx +++ b/src/renderer/components/dock/create-resource/view.tsx @@ -6,14 +6,13 @@ import React from "react"; import type { SelectOption } from "../../select"; import { Select } from "../../select"; -import yaml from "js-yaml"; +import yaml, { dump } from "js-yaml"; import type { IComputedValue } from "mobx"; import { makeObservable, observable } from "mobx"; import { observer } from "mobx-react"; import type { CreateResourceTabStore } from "./store"; import { EditorPanel } from "../editor-panel"; import { InfoPanel } from "../info-panel"; -import * as resourceApplierApi from "../../../../common/k8s-api/endpoints/resource-applier.api"; import { Notifications } from "../../notifications"; import logger from "../../../../common/logger"; import type { ApiManager } from "../../../../common/k8s-api/api-manager"; @@ -28,6 +27,8 @@ import type { GetDetailsUrl } from "../../kube-detail-params/get-details-url.inj import apiManagerInjectable from "../../../../common/k8s-api/api-manager/manager.injectable"; import getDetailsUrlInjectable from "../../kube-detail-params/get-details-url.injectable"; import navigateInjectable from "../../../navigation/navigate.injectable"; +import type { RequestKubeObjectCreation } from "../../../../common/k8s-api/endpoints/resource-applier.api/request-update.injectable"; +import requestKubeObjectCreationInjectable from "../../../../common/k8s-api/endpoints/resource-applier.api/request-update.injectable"; export interface CreateResourceProps { tabId: string; @@ -39,6 +40,7 @@ interface Dependencies { apiManager: ApiManager; navigate: Navigate; getDetailsUrl: GetDetailsUrl; + requestKubeObjectCreation: RequestKubeObjectCreation; } @observer @@ -68,7 +70,7 @@ class NonInjectedCreateResource extends React.Component => { - const { apiManager, getDetailsUrl, navigate } = this.props; + const { apiManager, getDetailsUrl, navigate, requestKubeObjectCreation } = this.props; if (this.error || !this.data?.trim()) { // do not save when field is empty or there is an error @@ -84,7 +86,7 @@ class NonInjectedCreateResource extends React.Component { try { - const data = await resourceApplierApi.update(resource); + const data = await requestKubeObjectCreation(dump(resource)); const { kind, apiVersion, metadata: { name, namespace }} = data; const showDetails = () => { @@ -168,5 +170,6 @@ export const CreateResource = withInjectables apiManager: di.inject(apiManagerInjectable), getDetailsUrl: di.inject(getDetailsUrlInjectable), navigate: di.inject(navigateInjectable), + requestKubeObjectCreation: di.inject(requestKubeObjectCreationInjectable), }), }); diff --git a/src/renderer/components/dock/dock-tab.tsx b/src/renderer/components/dock/dock-tab.tsx index df578675fd..5a672e2fb3 100644 --- a/src/renderer/components/dock/dock-tab.tsx +++ b/src/renderer/components/dock/dock-tab.tsx @@ -103,6 +103,7 @@ class NonInjectedDockTab extends React.Component { material="close" tooltip={`Close ${this.props.isMac ? "⌘+W" : "Ctrl+W"}`} onClick={close} + data-testid={`dock-tab-close-for-${id}`} />
    )} diff --git a/src/renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable.ts b/src/renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable.ts deleted file mode 100644 index 1c379b56e5..0000000000 --- a/src/renderer/components/dock/install-chart/chart-data/call-for-helm-chart-values.injectable.ts +++ /dev/null @@ -1,20 +0,0 @@ -/** - * 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 { getChartValues } from "../../../../../common/k8s-api/endpoints/helm-charts.api"; - -export type CallForHelmChartValues = ( - repo: string, - name: string, - version: string -) => Promise; - -const callForHelmChartValuesInjectable = getInjectable({ - id: "call-for-helm-chart-values", - instantiate: (): CallForHelmChartValues => getChartValues, - causesSideEffects: true, -}); - -export default callForHelmChartValuesInjectable; diff --git a/src/renderer/components/dock/install-chart/install-chart-model.injectable.tsx b/src/renderer/components/dock/install-chart/install-chart-model.injectable.tsx index 64f2e27e12..0db94fbd59 100644 --- a/src/renderer/components/dock/install-chart/install-chart-model.injectable.tsx +++ b/src/renderer/components/dock/install-chart/install-chart-model.injectable.tsx @@ -5,36 +5,31 @@ import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; import installChartTabStoreInjectable from "./store.injectable"; import { waitUntilDefined } from "../../../../common/utils"; -import type { CallForHelmChartValues } from "./chart-data/call-for-helm-chart-values.injectable"; -import callForHelmChartValuesInjectable from "./chart-data/call-for-helm-chart-values.injectable"; import type { IChartInstallData, InstallChartTabStore } from "./store"; import type { HelmChart } from "../../../../common/k8s-api/endpoints/helm-charts.api"; import React from "react"; -import { - action, - computed, - observable, - runInAction, -} from "mobx"; +import { action, computed, observable, runInAction } from "mobx"; import assert from "assert"; -import type { CallForCreateHelmRelease } from "../../+helm-releases/create-release/call-for-create-helm-release.injectable"; -import callForCreateHelmReleaseInjectable from "../../+helm-releases/create-release/call-for-create-helm-release.injectable"; +import type { RequestCreateHelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; +import requestCreateHelmReleaseInjectable from "../../../../common/k8s-api/endpoints/helm-releases.api/request-create.injectable"; import type { HelmReleaseUpdateDetails } from "../../../../common/k8s-api/endpoints/helm-releases.api"; import dockStoreInjectable from "../dock/store.injectable"; import type { NavigateToHelmReleases } from "../../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable"; import navigateToHelmReleasesInjectable from "../../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable"; import type { SingleValue } from "react-select"; -import type { CallForHelmChartVersions } from "../../+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; -import callForHelmChartVersionsInjectable from "../../+helm-charts/details/versions/call-for-helm-chart-versions.injectable"; +import type { RequestHelmChartValues } from "../../../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; +import requestHelmChartValuesInjectable from "../../../../common/k8s-api/endpoints/helm-charts.api/request-values.injectable"; +import type { RequestHelmChartVersions } from "../../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; +import requestHelmChartVersionsInjectable from "../../../../common/k8s-api/endpoints/helm-charts.api/request-versions.injectable"; const installChartModelInjectable = getInjectable({ id: "install-chart-model", instantiate: async (di, tabId: string) => { const store = di.inject(installChartTabStoreInjectable); - const callForHelmChartValues = di.inject(callForHelmChartValuesInjectable); - const callForHelmChartVersions = di.inject(callForHelmChartVersionsInjectable); - const callForCreateHelmRelease = di.inject(callForCreateHelmReleaseInjectable); + const requestHelmChartValues = di.inject(requestHelmChartValuesInjectable); + const requestHelmChartVersions = di.inject(requestHelmChartVersionsInjectable); + const callForCreateHelmRelease = di.inject(requestCreateHelmReleaseInjectable); const dockStore = di.inject(dockStoreInjectable); const navigateToHelmReleases = di.inject(navigateToHelmReleasesInjectable); const closeTab = () => dockStore.closeTab(tabId); @@ -49,8 +44,8 @@ const installChartModelInjectable = getInjectable({ callForCreateHelmRelease, closeTab, navigateToHelmReleases, - callForHelmChartValues, - callForHelmChartVersions, + requestHelmChartValues, + requestHelmChartVersions, store, }); @@ -71,9 +66,9 @@ interface Dependencies { closeTab: () => void; navigateToHelmReleases: NavigateToHelmReleases; waitForChart: () => Promise; - callForCreateHelmRelease: CallForCreateHelmRelease; - callForHelmChartValues: CallForHelmChartValues; - callForHelmChartVersions: CallForHelmChartVersions; + callForCreateHelmRelease: RequestCreateHelmRelease; + requestHelmChartValues: RequestHelmChartValues; + requestHelmChartVersions: RequestHelmChartVersions; store: InstallChartTabStore; } @@ -127,7 +122,7 @@ export class InstallChartModel { this.configuration.isLoading.set(true); }); - const configuration = await this.dependencies.callForHelmChartValues( + const configuration = await this.dependencies.requestHelmChartValues( this.chart.repo, this.chart.name, version, @@ -193,13 +188,13 @@ export class InstallChartModel { await this.dependencies.waitForChart(); const [defaultConfiguration, versions] = await Promise.all([ - this.dependencies.callForHelmChartValues( + this.dependencies.requestHelmChartValues( this.chart.repo, this.chart.name, this.chart.version, ), - this.dependencies.callForHelmChartVersions( + this.dependencies.requestHelmChartVersions( this.chart.repo, this.chart.name, ), diff --git a/src/renderer/components/dock/upgrade-chart/create-upgrade-chart-tab.injectable.ts b/src/renderer/components/dock/upgrade-chart/create-upgrade-chart-tab.injectable.ts index 3233d08cb5..7bf390da02 100644 --- a/src/renderer/components/dock/upgrade-chart/create-upgrade-chart-tab.injectable.ts +++ b/src/renderer/components/dock/upgrade-chart/create-upgrade-chart-tab.injectable.ts @@ -3,23 +3,27 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; +import type { IChartUpgradeData } from "./store.injectable"; import upgradeChartTabStoreInjectable from "./store.injectable"; import dockStoreInjectable from "../dock/store.injectable"; import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; import type { DockStore, DockTabCreateSpecific, TabId } from "../dock/store"; import { TabKind } from "../dock/store"; -import type { UpgradeChartTabStore } from "./store"; import { runInAction } from "mobx"; import getRandomUpgradeChartTabIdInjectable from "./get-random-upgrade-chart-tab-id.injectable"; +import type { DockTabStore } from "../dock-tab-store/dock-tab.store"; interface Dependencies { - upgradeChartStore: UpgradeChartTabStore; + upgradeChartStore: DockTabStore; dockStore: DockStore; getRandomId: () => string; } const createUpgradeChartTab = ({ upgradeChartStore, dockStore, getRandomId }: Dependencies) => (release: HelmRelease, tabParams: DockTabCreateSpecific = {}): TabId => { - const tabId = upgradeChartStore.getTabIdByRelease(release.getName()); + const tabId = upgradeChartStore.findTabIdFromData(val => ( + val.releaseName === release.getName() + && val.releaseNamespace === release.getNs() + )); if (tabId) { dockStore.open(); diff --git a/src/renderer/components/dock/upgrade-chart/store.injectable.ts b/src/renderer/components/dock/upgrade-chart/store.injectable.ts index 29a53c41d3..8884f5935c 100644 --- a/src/renderer/components/dock/upgrade-chart/store.injectable.ts +++ b/src/renderer/components/dock/upgrade-chart/store.injectable.ts @@ -3,9 +3,12 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import { UpgradeChartTabStore } from "./store"; import createDockTabStoreInjectable from "../dock-tab-store/create-dock-tab-store.injectable"; -import createStorageInjectable from "../../../utils/create-storage/create-storage.injectable"; + +export interface IChartUpgradeData { + releaseName: string; + releaseNamespace: string; +} const upgradeChartTabStoreInjectable = getInjectable({ id: "upgrade-chart-tab-store", @@ -13,9 +16,8 @@ const upgradeChartTabStoreInjectable = getInjectable({ instantiate: (di) => { const createDockTabStore = di.inject(createDockTabStoreInjectable); - return new UpgradeChartTabStore({ - createStorage: di.inject(createStorageInjectable), - valuesStore: createDockTabStore(), + return createDockTabStore({ + storageKey: "chart_releases", }); }, }); diff --git a/src/renderer/components/dock/upgrade-chart/store.ts b/src/renderer/components/dock/upgrade-chart/store.ts deleted file mode 100644 index 3e699c01b1..0000000000 --- a/src/renderer/components/dock/upgrade-chart/store.ts +++ /dev/null @@ -1,55 +0,0 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import { action, computed, makeObservable } from "mobx"; -import type { TabId } from "../dock/store"; -import type { DockTabStoreDependencies } from "../dock-tab-store/dock-tab.store"; -import { DockTabStore } from "../dock-tab-store/dock-tab.store"; -import { getReleaseValues } from "../../../../common/k8s-api/endpoints/helm-releases.api"; -import assert from "assert"; - -export interface IChartUpgradeData { - releaseName: string; - releaseNamespace: string; -} - -export interface UpgradeChartTabStoreDependencies extends DockTabStoreDependencies { - valuesStore: DockTabStore; -} - -export class UpgradeChartTabStore extends DockTabStore { - @computed private get releaseNameReverseLookup(): Map { - return new Map(this.getAllData().map(([id, { releaseName }]) => [releaseName, id])); - } - - get values() { - return this.dependencies.valuesStore; - } - - constructor(protected readonly dependencies: UpgradeChartTabStoreDependencies) { - super(dependencies, { - storageKey: "chart_releases", - }); - - makeObservable(this); - } - - @action - async reloadValues(tabId: TabId) { - this.values.clearData(tabId); // reset - const data = this.getData(tabId); - - assert(data, "cannot reload values if no data"); - - const { releaseName, releaseNamespace } = data; - const values = await getReleaseValues(releaseName, releaseNamespace, true); - - this.values.setData(tabId, values); - } - - getTabIdByRelease(releaseName: string) { - return this.releaseNameReverseLookup.get(releaseName); - } -} diff --git a/src/renderer/components/dock/upgrade-chart/tab-data.injectable.ts b/src/renderer/components/dock/upgrade-chart/tab-data.injectable.ts new file mode 100644 index 0000000000..0189ecf6a7 --- /dev/null +++ b/src/renderer/components/dock/upgrade-chart/tab-data.injectable.ts @@ -0,0 +1,21 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; +import { waitUntilDefined } from "../../../utils"; +import upgradeChartTabStoreInjectable from "./store.injectable"; + +const upgradeChartTabDataInjectable = getInjectable({ + id: "upgrade-chart-tab-data", + instantiate: (di, tabId) => { + const upgradeChartTabStore = di.inject(upgradeChartTabStoreInjectable); + + return waitUntilDefined(() => upgradeChartTabStore.getData(tabId)); + }, + lifecycle: lifecycleEnum.keyedSingleton({ + getInstanceKey: (di, tabId: string) => tabId, + }), +}); + +export default upgradeChartTabDataInjectable; diff --git a/src/renderer/components/dock/upgrade-chart/upgrade-chart-model.injectable.ts b/src/renderer/components/dock/upgrade-chart/upgrade-chart-model.injectable.ts new file mode 100644 index 0000000000..41d414be25 --- /dev/null +++ b/src/renderer/components/dock/upgrade-chart/upgrade-chart-model.injectable.ts @@ -0,0 +1,129 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ +import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable"; +import { asyncComputed } from "@ogre-tools/injectable-react"; +import type { IComputedValue } from "mobx"; +import { action, computed, observable, when } from "mobx"; +import type { SingleValue } from "react-select"; +import type { HelmChartVersion } from "../../+helm-charts/helm-charts/versions"; +import helmChartVersionsInjectable from "../../+helm-charts/helm-charts/versions.injectable"; +import releasesInjectable from "../../+helm-releases/releases.injectable"; +import updateReleaseInjectable from "../../+helm-releases/update-release/update-release.injectable"; +import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; +import requestHelmReleaseConfigurationInjectable from "../../../../common/k8s-api/endpoints/helm-releases.api/request-configuration.injectable"; +import { waitUntilDefined } from "../../../utils"; +import type { SelectOption } from "../../select"; +import type { DockTab } from "../dock/store"; +import upgradeChartTabDataInjectable from "./tab-data.injectable"; + +export interface UpgradeChartModel { + readonly release: HelmRelease; + readonly versionOptions: IComputedValue[]>; + readonly configration: { + readonly value: IComputedValue; + set: (value: string) => void; + readonly error: IComputedValue; + setError: (error: unknown) => void; + }; + readonly version: { + readonly value: IComputedValue; + set: (value: SingleValue>) => void; + }; + submit: () => Promise; +} + +export interface UpgradeChartSubmitResult { + completedSuccessfully: boolean; +} + +const upgradeChartModelInjectable = getInjectable({ + id: "upgrade-chart-model", + instantiate: async (di, tab): Promise => { + const releases = di.inject(releasesInjectable); + const requestHelmReleaseConfiguration = di.inject(requestHelmReleaseConfigurationInjectable); + const updateRelease = di.inject(updateReleaseInjectable); + const tabData = await di.inject(upgradeChartTabDataInjectable, tab.id); + + const release = await waitUntilDefined(() => ( + releases.value + .get() + .find(release => ( + release.getName() === tabData.releaseName + && release.getNs() === tabData.releaseNamespace + )) + )); + const versions = di.inject(helmChartVersionsInjectable, release); + const storedConfiguration = asyncComputed(() => requestHelmReleaseConfiguration( + release.getName(), + release.getNs(), + true, + ), ""); + + await when(() => !versions.pending.get()); + + const configrationValue = observable.box(); + const configrationEditError = observable.box(); + const configration: UpgradeChartModel["configration"] = { + value: computed(() => configrationValue.get() ?? storedConfiguration.value.get()), + set: action((value) => { + configrationValue.set(value); + configrationEditError.set(undefined); + }), + error: computed(() => configrationEditError.get()), + setError: action((error) => configrationEditError.set(String(error))), + }; + const versionValue = observable.box(undefined, { + deep: false, + }); + const version: UpgradeChartModel["version"] = { + value: computed(() => versionValue.get() ?? versions.value.get()[0]), + set: action((option) => versionValue.set(option?.value)), + }; + const versionOptions = computed(() => ( + versions.value + .get() + .map(version => ({ + value: version, + label: `${version.repo}/${release.getChart()}-${version.version}`, + })) + )); + + return { + release, + versionOptions, + configration, + version, + submit: async () => { + const selectedVersion = version.value.get(); + + if (!selectedVersion || configrationEditError.get()) { + return { + completedSuccessfully: false, + }; + } + + await updateRelease( + release.getName(), + release.getNs(), + { + chart: release.getChart(), + values: configration.value.get(), + ...selectedVersion, + }, + ); + storedConfiguration.invalidate(); + + return { + completedSuccessfully: true, + }; + }, + }; + }, + lifecycle: lifecycleEnum.keyedSingleton({ + getInstanceKey: (di, tab: DockTab) => tab.id, + }), +}); + +export default upgradeChartModelInjectable; diff --git a/src/renderer/components/dock/upgrade-chart/view.tsx b/src/renderer/components/dock/upgrade-chart/view.tsx index 11d60b6c87..2a3fe59996 100644 --- a/src/renderer/components/dock/upgrade-chart/view.tsx +++ b/src/renderer/components/dock/upgrade-chart/view.tsx @@ -6,26 +6,19 @@ import "./upgrade-chart.scss"; import React from "react"; -import { action, makeObservable, observable, reaction } from "mobx"; -import { disposeOnUnmount, observer } from "mobx-react"; +import { observer } from "mobx-react"; import { cssNames } from "../../../utils"; import type { DockTab } from "../dock/store"; import { InfoPanel } from "../info-panel"; -import type { UpgradeChartTabStore } from "./store"; import { Spinner } from "../../spinner"; import { Badge } from "../../badge"; import { EditorPanel } from "../editor-panel"; -import { helmChartStore, type ChartVersion } from "../../+helm-charts/helm-chart.store"; -import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api"; import type { SelectOption } from "../../select"; import { Select } from "../../select"; -import type { IAsyncComputed } from "@ogre-tools/injectable-react"; import { withInjectables } from "@ogre-tools/injectable-react"; -import upgradeChartTabStoreInjectable from "./store.injectable"; -import updateReleaseInjectable from "../../+helm-releases/update-release/update-release.injectable"; -import releasesInjectable from "../../+helm-releases/releases.injectable"; -import type { CallForHelmReleaseUpdate } from "../../+helm-releases/update-release/call-for-helm-release-update/call-for-helm-release-update.injectable"; -import { first } from "lodash/fp"; +import type { UpgradeChartModel } from "./upgrade-chart-model.injectable"; +import upgradeChartModelInjectable from "./upgrade-chart-model.injectable"; +import type { HelmChartVersion } from "../../+helm-charts/helm-charts/versions"; export interface UpgradeChartProps { className?: string; @@ -33,159 +26,74 @@ export interface UpgradeChartProps { } interface Dependencies { - releases: IAsyncComputed; - upgradeChartTabStore: UpgradeChartTabStore; - updateRelease: CallForHelmReleaseUpdate; + model: UpgradeChartModel; } @observer export class NonInjectedUpgradeChart extends React.Component { - @observable error?: string; - @observable versions = observable.array(); - @observable version: ChartVersion | undefined = undefined; - - constructor(props: UpgradeChartProps & Dependencies) { - super(props); - makeObservable(this); - } - - componentDidMount() { - disposeOnUnmount(this, [ - reaction( - () => this.release, - release => this.reloadVersions(release), - { - fireImmediately: true, - }, - ), - reaction( - () => this.release?.getRevision(), - () => this.reloadValues(), - { - fireImmediately: true, - }, - ), - ]); - } - - get tabId() { - return this.props.tab.id; - } - - get release() { - const tabData = this.props.upgradeChartTabStore.getData(this.tabId); - - if (!tabData) return null; - - return this.props.releases.value.get().find(release => release.getName() === tabData.releaseName); - } - - get value() { - return this.props.upgradeChartTabStore.values.getData(this.tabId); - } - - async reloadValues() { - this.props.upgradeChartTabStore.reloadValues(this.props.tab.id); - } - - async reloadVersions(release: HelmRelease | null | undefined) { - if (!release) { - return; - } - - this.version = undefined; - this.versions.clear(); - const versions = await helmChartStore.getVersions(release.getChart()); - - this.versions.replace(versions); - this.version = first(this.versions); - } - - onChange = action((value: string) => { - this.error = ""; - this.props.upgradeChartTabStore.values.setData(this.tabId, value); - }); - - onError = action((error: Error | string) => { - this.error = error.toString(); - }); - upgrade = async () => { - if (this.error || !this.release || !this.version || !this.value) { - return null; + const { model } = this.props; + const { completedSuccessfully } = await model.submit(); + + if (completedSuccessfully) { + return ( +

    + {"Release "} + {model.release.getName()} + {" successfully upgraded to version "} + {model.version.value.get()} +

    + ); } - const { version, repo } = this.version; - const releaseName = this.release.getName(); - const releaseNs = this.release.getNs(); - - await this.props.updateRelease(releaseName, releaseNs, { - chart: this.release.getChart(), - values: this.value, - repo, version, - }); - - return ( -

    - {"Release "} - {releaseName} - {" successfully upgraded to version "} - {version} -

    - ); + return null; }; render() { - const { tabId, release, value, error, onChange, onError, upgrade, versions, version } = this; - const { className } = this.props; - - if (!release || !this.props.upgradeChartTabStore.isReady(tabId) || !version) { - return ; - } - const currentVersion = release.getVersion(); - const versionOptions = versions.map(version => ({ - value: version, - label: `${version.repo}/${release.getChart()}-${version.version}`, - })); - const controlsAndInfo = ( -
    - Release - {" "} - - Namespace - {" "} - - Version - {" "} - - Upgrade version - , false> - id="char-version-input" - className="chart-version" - menuPlacement="top" - themeName="outlined" - value={version} - options={versionOptions} - onChange={option => this.version = option?.value} - /> -
    - ); + const { model, className, tab } = this.props; + const tabId = tab.id; + const { release } = model; return ( -
    +
    + Release + {" "} + + Namespace + {" "} + + Version + {" "} + + Upgrade version + , false> + id="char-version-input" + className="chart-version" + menuPlacement="top" + themeName="outlined" + value={model.version.value.get()} + options={model.versionOptions.get()} + onChange={model.version.set} + /> +
    + )} />
    ); @@ -193,10 +101,9 @@ export class NonInjectedUpgradeChart extends React.Component(NonInjectedUpgradeChart, { - getProps: (di, props) => ({ - releases: di.inject(releasesInjectable), - updateRelease: di.inject(updateReleaseInjectable), - upgradeChartTabStore: di.inject(upgradeChartTabStoreInjectable), + getPlaceholder: () => , + getProps: async (di, props) => ({ ...props, + model: await di.inject(upgradeChartModelInjectable, props.tab), }), }); diff --git a/src/renderer/components/kubeconfig-dialog/kubeconfig-dialog.tsx b/src/renderer/components/kubeconfig-dialog/kubeconfig-dialog.tsx index 3028faa902..fd497c9c35 100644 --- a/src/renderer/components/kubeconfig-dialog/kubeconfig-dialog.tsx +++ b/src/renderer/components/kubeconfig-dialog/kubeconfig-dialog.tsx @@ -5,121 +5,95 @@ import styles from "./kubeconfig-dialog.module.scss"; import React from "react"; -import { makeObservable, observable } from "mobx"; +import type { IObservableValue } from "mobx"; import { observer } from "mobx-react"; -import yaml from "js-yaml"; -import type { ServiceAccount } from "../../../common/k8s-api/endpoints"; import { cssNames, saveFileDialog } from "../../utils"; import { Button } from "../button"; import type { DialogProps } from "../dialog"; import { Dialog } from "../dialog"; import { Icon } from "../icon"; -import { Notifications } from "../notifications"; +import type { ShowNotification } from "../notifications"; import { Wizard, WizardStep } from "../wizard"; -import { apiBase } from "../../api"; import { MonacoEditor } from "../monaco-editor"; import { clipboard } from "electron"; +import { withInjectables } from "@ogre-tools/injectable-react"; +import showSuccessNotificationInjectable from "../notifications/show-success-notification.injectable"; +import kubeconfigDialogStateInjectable from "./state.injectable"; export interface KubeconfigDialogData { title?: React.ReactNode; - loader: () => Promise; + config: string; } export interface KubeConfigDialogProps extends Partial { } -const dialogState = observable.box(); +interface Dependencies { + state: IObservableValue; + showSuccessNotification: ShowNotification; +} @observer -export class KubeConfigDialog extends React.Component { - @observable config = ""; // parsed kubeconfig in yaml format - - constructor(props: KubeConfigDialogProps) { +class NonInjectedKubeConfigDialog extends React.Component { + constructor(props: KubeConfigDialogProps & Dependencies) { super(props); - makeObservable(this); - } - - static open(data: KubeconfigDialogData) { - dialogState.set(data); - } - - static close() { - dialogState.set(undefined); } close = () => { - KubeConfigDialog.close(); + this.props.state.set(undefined); }; - onOpen = (data: KubeconfigDialogData) => { - this.loadConfig(data); + copyToClipboard = (config: string) => { + clipboard.writeText(config); + this.props.showSuccessNotification("Config copied to clipboard"); }; - async loadConfig(data: KubeconfigDialogData) { - const config = await data.loader().catch(err => { - Notifications.error(err); - this.close(); - }); - - this.config = config ? yaml.dump(config) : ""; - } - - copyToClipboard = () => { - clipboard.writeText(this.config); - Notifications.ok("Config copied to clipboard"); + download = (config: string) => { + saveFileDialog("config", config, "text/yaml"); }; - download = () => { - saveFileDialog("config", this.config, "text/yaml"); - }; - - renderContents(data: KubeconfigDialogData) { - const yamlConfig = this.config; - - return ( - {data.title || "Kubeconfig File"}}> - - - - -
    - )} - prev={this.close} - > - - - - ); - } + renderContents = (data: KubeconfigDialogData) => ( + { data.title || "Kubeconfig File" }}> + + + + +
    + ) } + prev={this.close} + > + + + + ); render() { - const { className, ...dialogProps } = this.props; - const data = dialogState.get(); + const { className, state, ...dialogProps } = this.props; + const data = state.get(); return ( this.onOpen(data))} + isOpen={!!data} close={this.close} > {data && this.renderContents(data)} @@ -128,12 +102,10 @@ export class KubeConfigDialog extends React.Component { } } -export function openServiceAccountKubeConfig(account: ServiceAccount) { - const accountName = account.getName(); - const namespace = account.getNs(); - - KubeConfigDialog.open({ - title: `${accountName} kubeconfig`, - loader: () => apiBase.get(`/kubeconfig/service-account/${namespace}/${accountName}`), - }); -} +export const KubeConfigDialog = withInjectables(NonInjectedKubeConfigDialog, { + getProps: (di, props) => ({ + ...props, + showSuccessNotification: di.inject(showSuccessNotificationInjectable), + state: di.inject(kubeconfigDialogStateInjectable), + }), +}); diff --git a/src/renderer/components/kubeconfig-dialog/open-service-account-kube-config-dialog.injectable.ts b/src/renderer/components/kubeconfig-dialog/open-service-account-kube-config-dialog.injectable.ts new file mode 100644 index 0000000000..3a612dec2e --- /dev/null +++ b/src/renderer/components/kubeconfig-dialog/open-service-account-kube-config-dialog.injectable.ts @@ -0,0 +1,31 @@ +/** + * 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 type { ServiceAccount } from "../../../common/k8s-api/endpoints"; +import { urlBuilderFor } from "../../../common/utils/buildUrl"; +import apiBaseInjectable from "../../k8s/api-base.injectable"; +import openKubeconfigDialogInjectable from "./open.injectable"; + +export type OpenServiceAccountKubeConfigDialog = (account: ServiceAccount) => void; + +const serviceAccountConfigEndpoint = urlBuilderFor("/kubeconfig/service-account/:namespace/:name"); + +const openServiceAccountKubeConfigDialogInjectable = getInjectable({ + id: "open-service-account-kube-config-dialog", + instantiate: (di): OpenServiceAccountKubeConfigDialog => { + const apiBase = di.inject(apiBaseInjectable); + const openKubeconfigDialog = di.inject(openKubeconfigDialogInjectable); + + return (account) => openKubeconfigDialog({ + title: `${account.getName()} kubeconfig`, + loader: () => apiBase.get(serviceAccountConfigEndpoint.compile({ + name: account.getName(), + namespace: account.getNs(), + })), + }); + }, +}); + +export default openServiceAccountKubeConfigDialogInjectable; diff --git a/src/renderer/components/kubeconfig-dialog/open.injectable.ts b/src/renderer/components/kubeconfig-dialog/open.injectable.ts new file mode 100644 index 0000000000..c3a0d7f87f --- /dev/null +++ b/src/renderer/components/kubeconfig-dialog/open.injectable.ts @@ -0,0 +1,40 @@ +/** + * 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 type React from "react"; +import loggerInjectable from "../../../common/logger.injectable"; +import showCheckedErrorNotificationInjectable from "../notifications/show-checked-error.injectable"; +import kubeconfigDialogStateInjectable from "./state.injectable"; + +export interface OpenKubeconfigDialogArgs { + title?: React.ReactNode; + loader: () => Promise; +} + +export type OpenKubeconfigDialog = (openArgs: OpenKubeconfigDialogArgs) => void; + +const openKubeconfigDialogInjectable = getInjectable({ + id: "open-kubeconfig-dialog", + instantiate: (di): OpenKubeconfigDialog => { + const state = di.inject(kubeconfigDialogStateInjectable); + const showCheckedErrorNotification = di.inject(showCheckedErrorNotificationInjectable); + const logger = di.inject(loggerInjectable); + + return ({ title, loader }) => { + (async () => { + try { + const config = await loader(); + + state.set({ title, config }); + } catch (error) { + showCheckedErrorNotification(error, "Failed to retrive config for dialog"); + logger.warn("[KUBEOCONFIG-DIALOG]: failed to retrived config for dialog", error); + } + })(); + }; + }, +}); + +export default openKubeconfigDialogInjectable; diff --git a/src/renderer/components/kubeconfig-dialog/state.injectable.ts b/src/renderer/components/kubeconfig-dialog/state.injectable.ts new file mode 100644 index 0000000000..e85271cda6 --- /dev/null +++ b/src/renderer/components/kubeconfig-dialog/state.injectable.ts @@ -0,0 +1,14 @@ +/** + * 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 { observable } from "mobx"; +import type { KubeconfigDialogData } from "./kubeconfig-dialog"; + +const kubeconfigDialogStateInjectable = getInjectable({ + id: "kubeconfig-dialog-state", + instantiate: () => observable.box(), +}); + +export default kubeconfigDialogStateInjectable; diff --git a/src/renderer/components/menu/menu.tsx b/src/renderer/components/menu/menu.tsx index 582ad37af4..b43f3a497b 100644 --- a/src/renderer/components/menu/menu.tsx +++ b/src/renderer/components/menu/menu.tsx @@ -13,9 +13,15 @@ import { Animate } from "../animate"; import type { IconProps } from "../icon"; import { Icon } from "../icon"; import isEqual from "lodash/isEqual"; +import type { RequestAnimationFrame } from "../animate/request-animation-frame.injectable"; +import { withInjectables } from "@ogre-tools/injectable-react"; +import requestAnimationFrameInjectable from "../animate/request-animation-frame.injectable"; export const MenuContext = React.createContext(null); -export type MenuContextValue = Menu; +export interface MenuContextValue { + readonly props: Readonly; + close: () => void; +} export interface MenuPosition { left?: boolean; @@ -62,10 +68,14 @@ const defaultPropsMenu: Partial = { animated: true, }; -export class Menu extends React.Component { +interface Dependencies { + requestAnimationFrame: RequestAnimationFrame; +} + +class NonInjectedMenu extends React.Component { static defaultProps = defaultPropsMenu as object; - constructor(props: MenuProps) { + constructor(props: MenuProps & Dependencies) { super(props); autoBind(this); } @@ -372,6 +382,13 @@ export class Menu extends React.Component { } } +export const Menu = withInjectables(NonInjectedMenu, { + getProps: (di, props) => ({ + ...props, + requestAnimationFrame: di.inject(requestAnimationFrameInjectable), + }), +}); + export function SubMenu(props: Partial) { const { className, ...menuProps } = props; diff --git a/src/renderer/components/render-delay/__tests__/__snapshots__/render-delay.test.tsx.snap b/src/renderer/components/render-delay/__tests__/__snapshots__/render-delay.test.tsx.snap new file mode 100644 index 0000000000..1591010403 --- /dev/null +++ b/src/renderer/components/render-delay/__tests__/__snapshots__/render-delay.test.tsx.snap @@ -0,0 +1,37 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[` when rendered with placeholder renders 1`] = ` + +
    +
    +
    + +`; + +exports[` when rendered with placeholder when the idle callback is called renders 1`] = ` + +
    +
    +
    + +`; + +exports[` when rendered without placeholder renders 1`] = ` + +
    + +`; + +exports[` when rendered without placeholder when the idle callback is called renders 1`] = ` + +
    +
    +
    + +`; diff --git a/src/renderer/components/render-delay/__tests__/render-delay.test.tsx b/src/renderer/components/render-delay/__tests__/render-delay.test.tsx index 444b024df3..c189e3f38e 100644 --- a/src/renderer/components/render-delay/__tests__/render-delay.test.tsx +++ b/src/renderer/components/render-delay/__tests__/render-delay.test.tsx @@ -3,23 +3,106 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import React from "react"; -import "@testing-library/jest-dom/extend-expect"; -import { render } from "@testing-library/react"; import { RenderDelay } from "../render-delay"; -import { mockWindow } from "../../../../../__mocks__/windowMock"; - -mockWindow(); +import type { DiRender } from "../../test-utils/renderFor"; +import { renderFor } from "../../test-utils/renderFor"; +import { getDiForUnitTesting } from "../../../getDiForUnitTesting"; +import { advanceFakeTime, useFakeTime } from "../../../../common/test-utils/use-fake-time"; +import cancelIdleCallbackInjectable from "../cancel-idle-callback.injectable"; +import requestIdleCallbackInjectable from "../request-idle-callback.injectable"; +import type { RenderResult } from "@testing-library/react"; +import idleCallbackTimeoutInjectable from "../idle-callback-timeout.injectable"; describe("", () => { - it("renders w/o errors", () => { - const { container } = render(); + let render: DiRender; - expect(container).toBeInstanceOf(HTMLElement); + beforeEach(() => { + const di = getDiForUnitTesting({ doGeneralOverrides: true }); + + render = renderFor(di); + + useFakeTime("2020-01-17 12:18:19"); + + di.override(cancelIdleCallbackInjectable, () => clearTimeout); + di.override(requestIdleCallbackInjectable, () => (callback, opts) => setTimeout(callback, opts.timeout) as any); + di.override(idleCallbackTimeoutInjectable, () => 5); }); - it("renders it's child", () => { - const { getByText } = render(); + describe("when rendered without placeholder", () => { + let result: RenderResult; - expect(getByText("My button")).toBeInTheDocument(); + beforeEach(() => { + result = render(( + +
    + + )); + }); + + it("renders", () => { + expect(result.baseElement).toMatchSnapshot(); + }); + + it("does not show the children yet", () => { + expect(result.queryByTestId("child")).not.toBeInTheDocument(); + }); + + describe("when the idle callback is called", () => { + beforeEach(() => { + advanceFakeTime(5); + }); + + it("renders", () => { + expect(result.baseElement).toMatchSnapshot(); + }); + + it("shows the children", () => { + expect(result.queryByTestId("child")).toBeInTheDocument(); + }); + }); + }); + + describe("when rendered with placeholder", () => { + let result: RenderResult; + + beforeEach(() => { + result = render(( +
    } + > +
    + + )); + }); + + it("renders", () => { + expect(result.baseElement).toMatchSnapshot(); + }); + + it("does not show the children yet", () => { + expect(result.queryByTestId("child")).not.toBeInTheDocument(); + }); + + it("shows the placeholder", () => { + expect(result.queryByTestId("placeholder")).toBeInTheDocument(); + }); + + describe("when the idle callback is called", () => { + beforeEach(() => { + advanceFakeTime(5); + }); + + it("renders", () => { + expect(result.baseElement).toMatchSnapshot(); + }); + + it("shows the children", () => { + expect(result.queryByTestId("child")).toBeInTheDocument(); + }); + + it("does not show the placeholder", () => { + expect(result.queryByTestId("placeholder")).not.toBeInTheDocument(); + }); + }); }); }); diff --git a/src/renderer/components/render-delay/cancel-idle-callback.global-override-for-injectable.ts b/src/renderer/components/render-delay/cancel-idle-callback.global-override-for-injectable.ts new file mode 100644 index 0000000000..2bd7d0047f --- /dev/null +++ b/src/renderer/components/render-delay/cancel-idle-callback.global-override-for-injectable.ts @@ -0,0 +1,9 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../../../common/test-utils/get-global-override"; +import cancelIdleCallbackInjectable from "./cancel-idle-callback.injectable"; + +export default getGlobalOverride(cancelIdleCallbackInjectable, () => () => {}); diff --git a/src/renderer/components/render-delay/cancel-idle-callback.injectable.ts b/src/renderer/components/render-delay/cancel-idle-callback.injectable.ts new file mode 100644 index 0000000000..c18d9dfa88 --- /dev/null +++ b/src/renderer/components/render-delay/cancel-idle-callback.injectable.ts @@ -0,0 +1,15 @@ +/** + * 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"; + +export type CancelIdleCallback = (handle: number) => void; + +const cancelIdleCallbackInjectable = getInjectable({ + id: "cancel-idle-callback", + instantiate: (): CancelIdleCallback => window.cancelIdleCallback, + causesSideEffects: true, +}); + +export default cancelIdleCallbackInjectable; diff --git a/src/renderer/components/render-delay/idle-callback-timeout.injectable.ts b/src/renderer/components/render-delay/idle-callback-timeout.injectable.ts new file mode 100644 index 0000000000..e40657e55c --- /dev/null +++ b/src/renderer/components/render-delay/idle-callback-timeout.injectable.ts @@ -0,0 +1,12 @@ +/** + * 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"; + +const idleCallbackTimeoutInjectable = getInjectable({ + id: "idle-callback-timeout", + instantiate: () => 1000, +}); + +export default idleCallbackTimeoutInjectable; diff --git a/src/renderer/components/render-delay/render-delay.tsx b/src/renderer/components/render-delay/render-delay.tsx index 2ccdaff693..5951babe6d 100644 --- a/src/renderer/components/render-delay/render-delay.tsx +++ b/src/renderer/components/render-delay/render-delay.tsx @@ -3,42 +3,58 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ -import React from "react"; -import { makeObservable, observable } from "mobx"; -import { observer } from "mobx-react"; +import React, { useEffect, useState } from "react"; import type { SingleOrMany } from "../../utils"; +import type { RequestIdleCallback } from "./request-idle-callback.injectable"; +import type { CancelIdleCallback } from "./cancel-idle-callback.injectable"; +import { withInjectables } from "@ogre-tools/injectable-react"; +import cancelIdleCallbackInjectable from "./cancel-idle-callback.injectable"; +import requestIdleCallbackInjectable from "./request-idle-callback.injectable"; +import idleCallbackTimeoutInjectable from "./idle-callback-timeout.injectable"; export interface RenderDelayProps { placeholder?: React.ReactNode; children: SingleOrMany; } -@observer -export class RenderDelay extends React.Component { - @observable isVisible = false; - - constructor(props: RenderDelayProps) { - super(props); - makeObservable(this); - } - - componentDidMount() { - const guaranteedFireTime = 1000; - - window.requestIdleCallback(this.showContents, { timeout: guaranteedFireTime }); - } - - componentWillUnmount() { - window.cancelIdleCallback(this.showContents); - } - - showContents = () => this.isVisible = true; - - render() { - if (!this.isVisible) { - return this.props.placeholder || null; - } - - return this.props.children; - } +interface Dependencies { + requestIdleCallback: RequestIdleCallback; + cancelIdleCallback: CancelIdleCallback; + idleCallbackTimeout: number; } + +const NonInjectedRenderDelay = (props: RenderDelayProps & Dependencies) => { + const { + cancelIdleCallback, + requestIdleCallback, + children, + placeholder, + idleCallbackTimeout, + } = props; + const [isVisible, setIsVisible] = useState(false); + + useEffect(() => { + const handle = requestIdleCallback(() => setIsVisible(true), { timeout: idleCallbackTimeout }); + + return () => cancelIdleCallback(handle); + }, []); + + return ( + <> + { + isVisible + ? children + : placeholder + } + + ); +}; + +export const RenderDelay = withInjectables(NonInjectedRenderDelay, { + getProps: (di, props) => ({ + ...props, + cancelIdleCallback: di.inject(cancelIdleCallbackInjectable), + requestIdleCallback: di.inject(requestIdleCallbackInjectable), + idleCallbackTimeout: di.inject(idleCallbackTimeoutInjectable), + }), +}); diff --git a/src/renderer/components/render-delay/request-idle-callback.global-override-for-injectable.ts b/src/renderer/components/render-delay/request-idle-callback.global-override-for-injectable.ts new file mode 100644 index 0000000000..5dc3d7d916 --- /dev/null +++ b/src/renderer/components/render-delay/request-idle-callback.global-override-for-injectable.ts @@ -0,0 +1,13 @@ +/** + * Copyright (c) OpenLens Authors. All rights reserved. + * Licensed under MIT License. See LICENSE in root directory for more information. + */ + +import { getGlobalOverride } from "../../../common/test-utils/get-global-override"; +import requestIdleCallbackInjectable from "./request-idle-callback.injectable"; + +export default getGlobalOverride(requestIdleCallbackInjectable, () => (callback) => { + callback(); + + return 0; +}); diff --git a/src/renderer/components/render-delay/request-idle-callback.injectable.ts b/src/renderer/components/render-delay/request-idle-callback.injectable.ts new file mode 100644 index 0000000000..fd58bcc851 --- /dev/null +++ b/src/renderer/components/render-delay/request-idle-callback.injectable.ts @@ -0,0 +1,15 @@ +/** + * 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"; + +export type RequestIdleCallback = (callback: () => void, options: { timeout: number }) => number; + +const requestIdleCallbackInjectable = getInjectable({ + id: "request-idle-callback", + instantiate: (): RequestIdleCallback => window.requestIdleCallback, + causesSideEffects: true, +}); + +export default requestIdleCallbackInjectable; diff --git a/src/renderer/components/resource-metrics/resource-metrics-text.tsx b/src/renderer/components/resource-metrics/resource-metrics-text.tsx index cedf0d136f..2e10596dd3 100644 --- a/src/renderer/components/resource-metrics/resource-metrics-text.tsx +++ b/src/renderer/components/resource-metrics/resource-metrics-text.tsx @@ -4,14 +4,23 @@ */ import React from "react"; -import type { PodMetricData } from "../../../common/k8s-api/endpoints"; +import type { MetricData } from "../../../common/k8s-api/endpoints/metrics.api"; import { getMetricLastPoints } from "../../../common/k8s-api/endpoints/metrics.api"; import { bytesToUnits } from "../../utils"; import { Badge } from "../badge"; import { DrawerItem } from "../drawer"; +export interface ResourceMetricsTextMetrics { + cpuUsage?: MetricData; + cpuRequests?: MetricData; + cpuLimits?: MetricData; + memoryUsage?: MetricData; + memoryRequests?: MetricData; + memoryLimits?: MetricData; +} + export interface ResourceMetricsTextProps { - metrics: PodMetricData | null | undefined; + metrics: ResourceMetricsTextMetrics | null | undefined; } export function ResourceMetricsText({ metrics }: ResourceMetricsTextProps) { @@ -19,7 +28,10 @@ export function ResourceMetricsText({ metrics }: ResourceMetricsTextProps) { return null; } - const { cpuUsage, memoryUsage } = getMetricLastPoints(metrics); + const { + cpuUsage = 0, + memoryUsage = 0, + } = getMetricLastPoints(metrics); return ( <> diff --git a/src/renderer/components/resource-metrics/resource-metrics.tsx b/src/renderer/components/resource-metrics/resource-metrics.tsx index 0080491727..b845d8a4c1 100644 --- a/src/renderer/components/resource-metrics/resource-metrics.tsx +++ b/src/renderer/components/resource-metrics/resource-metrics.tsx @@ -16,13 +16,14 @@ import type { MetricData } from "../../../common/k8s-api/endpoints/metrics.api"; export type AtLeastOneMetricTab = [MetricsTab, ...MetricsTab[]]; -export interface ResourceMetricsProps extends React.HTMLProps { +export interface ResourceMetricsProps { tabs: AtLeastOneMetricTab; object: KubeObject; loader?: () => void; interval?: number; className?: string; - metrics: Partial> | null | undefined; + metrics: Partial> | null | undefined; + children: React.ReactChild | React.ReactChild[]; } export interface ResourceMetricsValue { @@ -33,7 +34,7 @@ export interface ResourceMetricsValue { export const ResourceMetricsContext = createContext(null); -export function ResourceMetrics({ object, loader = noop, interval = 60, tabs, children, className, metrics }: ResourceMetricsProps) { +export function ResourceMetrics({ object, loader = noop, interval = 60, tabs, children, className, metrics }: ResourceMetricsProps) { const [tab, setTab] = useState(tabs[0]); // This is done just incase `loader` is actually something like `() => Promise` diff --git a/src/renderer/components/test-utils/get-application-builder.tsx b/src/renderer/components/test-utils/get-application-builder.tsx index f7e28c7b81..7d6630be82 100644 --- a/src/renderer/components/test-utils/get-application-builder.tsx +++ b/src/renderer/components/test-utils/get-application-builder.tsx @@ -6,7 +6,7 @@ import type { LensRendererExtension } from "../../../extensions/lens-renderer-ex import rendererExtensionsInjectable from "../../../extensions/renderer-extensions.injectable"; import currentlyInClusterFrameInjectable from "../../routes/currently-in-cluster-frame.injectable"; import type { IComputedValue, ObservableMap } from "mobx"; -import { computed, observable, runInAction } from "mobx"; +import { action, computed, observable, runInAction } from "mobx"; import React from "react"; import { Router } from "react-router"; import allowedResourcesInjectable from "../../cluster-frame-context/allowed-resources.injectable"; @@ -66,11 +66,27 @@ import closeAllWindowsInjectable from "../../../main/start-main-application/lens import type { LensWindow } from "../../../main/start-main-application/lens-window/application-window/create-lens-window.injectable"; import type { FakeExtensionOptions } from "./get-extension-fake"; import { getExtensionFakeForMain, getExtensionFakeForRenderer } from "./get-extension-fake"; +import namespaceApiInjectable from "../../../common/k8s-api/endpoints/namespace.api.injectable"; +import { Namespace } from "../../../common/k8s-api/endpoints"; +import { overrideFsWithFakes } from "../../../test-utils/override-fs-with-fakes"; type Callback = (di: DiContainer) => void | Promise; type LensWindowWithHelpers = LensWindow & { rendered: RenderResult; di: DiContainer }; +const createNamespacesFor = (namespaces: Set): Namespace[] => ( + Array.from(namespaces, (namespace) => new Namespace({ + apiVersion: "v1", + kind: "Namespace", + metadata: { + name: namespace, + resourceVersion: "1", + selfLink: `/api/v1/namespaces/${namespace}`, + uid: `namespace-${namespace}`, + }, + })) +); + export interface ApplicationBuilder { mainDi: DiContainer; setEnvironmentToClusterFrame: () => ApplicationBuilder; @@ -99,6 +115,7 @@ export interface ApplicationBuilder { allowKubeResource: (resourceName: KubeResource) => ApplicationBuilder; beforeApplicationStart: (callback: Callback) => ApplicationBuilder; beforeWindowStart: (callback: Callback) => ApplicationBuilder; + afterWindowStart: (callback: Callback) => ApplicationBuilder; startHidden: () => Promise; render: () => Promise; @@ -112,7 +129,6 @@ export interface ApplicationBuilder { applicationMenu: { click: (path: string) => void; }; - preferences: { close: () => void; navigate: () => void; @@ -121,7 +137,10 @@ export interface ApplicationBuilder { click: (id: string) => void; }; }; - + namespaces: { + add: (namespace: string) => void; + select: (namespace: string) => void; + }; helmCharts: { navigate: NavigateToHelmCharts; }; @@ -151,6 +170,11 @@ export const getApplicationBuilder = () => { const beforeApplicationStartCallbacks: Callback[] = []; const beforeWindowStartCallbacks: Callback[] = []; + const afterWindowStartCallbacks: Callback[] = []; + + const fsState = new Map(); + + overrideFsWithFakes(mainDi, fsState); let environment = environments.application; @@ -185,6 +209,7 @@ export const getApplicationBuilder = () => { const windowDi = getRendererDi({ doGeneralOverrides: true }); overrideChannelsForWindow(windowDi, windowId); + overrideFsWithFakes(windowDi, fsState); runInAction(() => { windowDi.register(rendererExtensionsStateInjectable); @@ -218,6 +243,10 @@ export const getApplicationBuilder = () => { await startFrame(); + for (const callback of afterWindowStartCallbacks) { + await callback(windowDi); + } + const history = windowDi.inject(historyInjectable); const render = renderFor(windowDi); @@ -245,9 +274,12 @@ export const getApplicationBuilder = () => { let applicationHasStarted = false; + const namespaces = observable.set(); + const namespaceItems = observable.array(); + const selectedNamespaces = observable.set(); + const builder: ApplicationBuilder = { mainDi, - applicationWindow: { closeAll: () => { const closeAll = mainDi.inject(closeAllWindowsInjectable); @@ -306,7 +338,13 @@ export const getApplicationBuilder = () => { return builder.applicationWindow.get(id); }, }, - + namespaces: { + add: action((namespace) => { + namespaces.add(namespace); + namespaceItems.replace(createNamespacesFor(namespaces)); + }), + select: action((namespace) => selectedNamespaces.add(namespace)), + }, applicationMenu: { click: (path: string) => { const applicationMenuItems = mainDi.inject( @@ -461,6 +499,7 @@ export const getApplicationBuilder = () => { ); const clusterStub = { + id: "some-cluster-id", accessibleNamespaces: [], isAllowedResource: isAllowedResource(allowedResourcesState), } as unknown as Cluster; @@ -469,21 +508,26 @@ export const getApplicationBuilder = () => { computed(() => catalogEntityFromCluster(clusterStub)), ); + windowDi.override(hostedClusterIdInjectable, () => clusterStub.id); + // TODO: Figure out a way to remove this stub. const namespaceStoreStub = { isLoaded: true, - contextNamespaces: [], - contextItems: [], - api: { - kind: "Namespace", + get contextNamespaces() { + return Array.from(selectedNamespaces); }, - items: [], + get allowedNamespaces() { + return Array.from(namespaces); + }, + contextItems: namespaceItems, + api: windowDi.inject(namespaceApiInjectable), + items: namespaceItems, selectNamespaces: () => {}, getByPath: () => undefined, pickOnlySelected: () => [], isSelectedAll: () => false, - getTotalCount: () => 0, - } as unknown as NamespaceStore; + getTotalCount: () => namespaceItems.length, + } as Partial as NamespaceStore; const clusterFrameContextFake = new ClusterFrameContext( clusterStub, @@ -495,7 +539,6 @@ export const getApplicationBuilder = () => { windowDi.override(namespaceStoreInjectable, () => namespaceStoreStub); windowDi.override(hostedClusterInjectable, () => clusterStub); - windowDi.override(hostedClusterIdInjectable, () => "irrelevant-hosted-cluster-id"); windowDi.override(clusterFrameContextInjectable, () => clusterFrameContextFake); // Todo: get rid of global state. @@ -615,6 +658,18 @@ export const getApplicationBuilder = () => { return builder; }, + afterWindowStart(callback) { + const alreadyRenderedWindows = builder.applicationWindow.getAll(); + + alreadyRenderedWindows.forEach((window) => { + callback(window.di); + }); + + afterWindowStartCallbacks.push(callback); + + return builder; + }, + startHidden: async () => { mainDi.inject(lensProxyPortInjectable).set(42); diff --git a/src/renderer/create-cluster/create-cluster.injectable.ts b/src/renderer/create-cluster/create-cluster.injectable.ts index af64873fad..0c73eb82fa 100644 --- a/src/renderer/create-cluster/create-cluster.injectable.ts +++ b/src/renderer/create-cluster/create-cluster.injectable.ts @@ -9,6 +9,7 @@ import directoryForKubeConfigsInjectable from "../../common/app-paths/directory- import { createClusterInjectionToken } from "../../common/cluster/create-cluster-injection-token"; import loggerInjectable from "../../common/logger.injectable"; import broadcastMessageInjectable from "../../common/ipc/broadcast-message.injectable"; +import loadConfigfromFileInjectable from "../../common/kube-helpers/load-config-from-file.injectable"; const createClusterInjectable = getInjectable({ id: "create-cluster", @@ -18,6 +19,7 @@ const createClusterInjectable = getInjectable({ directoryForKubeConfigs: di.inject(directoryForKubeConfigsInjectable), logger: di.inject(loggerInjectable), broadcastMessage: di.inject(broadcastMessageInjectable), + loadConfigfromFile: di.inject(loadConfigfromFileInjectable), // TODO: Dismantle wrong abstraction // Note: "as never" to get around strictness in unnatural scenario diff --git a/src/renderer/frames/cluster-frame/__snapshots__/cluster-frame.test.tsx.snap b/src/renderer/frames/cluster-frame/__snapshots__/cluster-frame.test.tsx.snap index c491c391ae..d629d85798 100644 --- a/src/renderer/frames/cluster-frame/__snapshots__/cluster-frame.test.tsx.snap +++ b/src/renderer/frames/cluster-frame/__snapshots__/cluster-frame.test.tsx.snap @@ -383,6 +383,7 @@ exports[` given cluster with list nodes and namespaces permissio > given cluster with list nodes and namespaces permissio close -
    +
    Close ⌘+W
    @@ -849,6 +852,7 @@ exports[` given cluster with list nodes and namespaces permissio > given cluster with list nodes and namespaces permissio close -
    +
    Close ⌘+W
    @@ -1379,6 +1385,7 @@ exports[` given cluster without list nodes, but with namespaces > given cluster without list nodes, but with namespaces close -
    +
    Close ⌘+W
    diff --git a/src/renderer/frames/cluster-frame/cluster-frame.test.tsx b/src/renderer/frames/cluster-frame/cluster-frame.test.tsx index 5ec0d0894f..bee7d3a415 100644 --- a/src/renderer/frames/cluster-frame/cluster-frame.test.tsx +++ b/src/renderer/frames/cluster-frame/cluster-frame.test.tsx @@ -24,6 +24,7 @@ import currentRouteComponentInjectable from "../../routes/current-route-componen import allowedResourcesInjectable from "../../cluster-frame-context/allowed-resources.injectable"; import hostedClusterIdInjectable from "../../cluster-frame-context/hosted-cluster-id.injectable"; import hostedClusterInjectable from "../../cluster-frame-context/hosted-cluster.injectable"; +import { useFakeTime } from "../../../common/test-utils/use-fake-time"; describe("", () => { let render: () => RenderResult; @@ -45,6 +46,8 @@ describe("", () => { di.override(directoryForUserDataInjectable, () => "/some/irrelavent/path"); di.override(storesAndApisCanBeCreatedInjectable, () => true); + useFakeTime("2000-01-01 12:00:00am"); + const createCluster = di.inject(createClusterInjectable); cluster = createCluster( diff --git a/src/renderer/getDiForUnitTesting.tsx b/src/renderer/getDiForUnitTesting.tsx index aa146ad385..70e579adb9 100644 --- a/src/renderer/getDiForUnitTesting.tsx +++ b/src/renderer/getDiForUnitTesting.tsx @@ -20,10 +20,6 @@ import fileSystemProvisionerStoreInjectable from "../extensions/extension-loader import type { FileSystemProvisionerStore } from "../extensions/extension-loader/file-system-provisioner-store/file-system-provisioner-store"; import userStoreInjectable from "../common/user-store/user-store.injectable"; import type { UserStore } from "../common/user-store"; -import getAbsolutePathInjectable from "../common/path/get-absolute-path.injectable"; -import { getAbsolutePathFake } from "../common/test-utils/get-absolute-path-fake"; -import joinPathsInjectable from "../common/path/join-paths.injectable"; -import { joinPathsFake } from "../common/test-utils/join-paths-fake"; import hotbarStoreInjectable from "../common/hotbars/store.injectable"; import terminalSpawningPoolInjectable from "./components/dock/terminal/terminal-spawning-pool.injectable"; import hostedClusterIdInjectable from "./cluster-frame-context/hosted-cluster-id.injectable"; @@ -32,7 +28,6 @@ import { ApiManager } from "../common/k8s-api/api-manager"; import lensResourcesDirInjectable from "../common/vars/lens-resources-dir.injectable"; import broadcastMessageInjectable from "../common/ipc/broadcast-message.injectable"; import apiManagerInjectable from "../common/k8s-api/api-manager/manager.injectable"; -import setupOnApiErrorListenersInjectable from "./api/setup-on-api-errors.injectable"; import { observable, computed, runInAction } from "mobx"; import defaultShellInjectable from "./components/+preferences/default-shell.injectable"; import requestAnimationFrameInjectable from "./components/animate/request-animation-frame.injectable"; @@ -54,7 +49,6 @@ import cronJobTriggerDialogClusterFrameChildComponentInjectable from "./componen import deploymentScaleDialogClusterFrameChildComponentInjectable from "./components/+workloads-deployments/scale/deployment-scale-dialog-cluster-frame-child-component.injectable"; import replicasetScaleDialogClusterFrameChildComponentInjectable from "./components/+workloads-replicasets/scale-dialog/replicaset-scale-dialog-cluster-frame-child-component.injectable"; import statefulsetScaleDialogClusterFrameChildComponentInjectable from "./components/+workloads-statefulsets/scale/statefulset-scale-dialog-cluster-frame-child-component.injectable"; -import deleteClusterDialogClusterFrameChildComponentInjectable from "./components/delete-cluster-dialog/delete-cluster-dialog-cluster-frame-child-component.injectable"; import kubeObjectDetailsClusterFrameChildComponentInjectable from "./components/kube-object-details/kube-object-details-cluster-frame-child-component.injectable"; import kubeconfigDialogClusterFrameChildComponentInjectable from "./components/kubeconfig-dialog/kubeconfig-dialog-cluster-frame-child-component.injectable"; import portForwardDialogClusterFrameChildComponentInjectable from "./port-forward/port-forward-dialog-cluster-frame-child-component.injectable"; @@ -65,6 +59,7 @@ import forceUpdateModalRootFrameComponentInjectable from "./application-update/f import legacyOnChannelListenInjectable from "./ipc/legacy-channel-listen.injectable"; import getEntitySettingCommandsInjectable from "./components/command-palette/registered-commands/get-entity-setting-commands.injectable"; import storageSaveDelayInjectable from "./utils/create-storage/storage-save-delay.injectable"; +import environmentVariablesInjectable from "../common/utils/environment-variables.injectable"; import type { GlobalOverride } from "../common/test-utils/get-global-override"; import type { PartialDeep } from "type-fest"; @@ -108,7 +103,6 @@ export const getDiForUnitTesting = ( [ startTopbarStateSyncInjectable, setupSystemCaInjectable, - setupOnApiErrorListenersInjectable, ].forEach((injectable) => { di.override(injectable, () => ({ id: injectable.id, @@ -119,9 +113,6 @@ export const getDiForUnitTesting = ( di.override(terminalSpawningPoolInjectable, () => document.createElement("div")); di.override(hostedClusterIdInjectable, () => undefined); - di.override(getAbsolutePathInjectable, () => getAbsolutePathFake); - di.override(joinPathsInjectable, () => joinPathsFake); - di.override(historyInjectable, () => createMemoryHistory()); di.override(legacyOnChannelListenInjectable, () => () => noop); @@ -150,7 +141,6 @@ export const getDiForUnitTesting = ( deploymentScaleDialogClusterFrameChildComponentInjectable, replicasetScaleDialogClusterFrameChildComponentInjectable, statefulsetScaleDialogClusterFrameChildComponentInjectable, - deleteClusterDialogClusterFrameChildComponentInjectable, kubeObjectDetailsClusterFrameChildComponentInjectable, kubeconfigDialogClusterFrameChildComponentInjectable, portForwardDialogClusterFrameChildComponentInjectable, @@ -164,6 +154,7 @@ export const getDiForUnitTesting = ( })); }); + di.override(environmentVariablesInjectable, () => ({})); di.override(watchHistoryStateInjectable, () => () => () => {}); di.override(openAppContextMenuInjectable, () => () => {}); di.override(goBackInjectable, () => () => {}); @@ -187,7 +178,6 @@ export const getDiForUnitTesting = ( }) as unknown as HotbarStore); di.override(fileSystemProvisionerStoreInjectable, () => ({}) as FileSystemProvisionerStore); - di.override(defaultShellInjectable, () => "some-default-shell"); di.override(userStoreInjectable, () => ({ diff --git a/src/renderer/ipc/index.ts b/src/renderer/ipc/index.ts index 48a005d536..5c0cd13c4e 100644 --- a/src/renderer/ipc/index.ts +++ b/src/renderer/ipc/index.ts @@ -4,7 +4,7 @@ */ import type { OpenDialogOptions } from "electron"; -import { clusterActivateHandler, clusterClearDeletingHandler, clusterDeleteHandler, clusterDisconnectHandler, clusterKubectlApplyAllHandler, clusterKubectlDeleteAllHandler, clusterSetDeletingHandler, clusterSetFrameIdHandler, clusterStates } from "../../common/ipc/cluster"; +import { clusterActivateHandler, clusterDisconnectHandler, clusterKubectlApplyAllHandler, clusterKubectlDeleteAllHandler, clusterSetFrameIdHandler, clusterStates } from "../../common/ipc/cluster"; import type { ClusterId, ClusterState } from "../../common/cluster-types"; import { windowActionHandleChannel, windowLocationChangedChannel, windowOpenAppMenuAsContextMenuChannel, type WindowAction } from "../../common/ipc/window"; import { openFilePickingDialogChannel } from "../../common/ipc/dialog"; @@ -60,18 +60,6 @@ export function requestClusterDisconnection(clusterId: ClusterId, force?: boolea return requestMain(clusterDisconnectHandler, clusterId, force); } -export function requestSetClusterAsDeleting(clusterId: ClusterId): Promise { - return requestMain(clusterSetDeletingHandler, clusterId); -} - -export function requestClearClusterAsDeleting(clusterId: ClusterId): Promise { - return requestMain(clusterClearDeletingHandler, clusterId); -} - -export function requestDeleteCluster(clusterId: ClusterId): Promise { - return requestMain(clusterDeleteHandler, clusterId); -} - export function requestInitialClusterStates(): Promise<{ id: string; state: ClusterState }[]> { return requestMain(clusterStates); } diff --git a/src/renderer/ipc/list-namespaces-forbidden-handler.injectable.tsx b/src/renderer/ipc/list-namespaces-forbidden-handler.injectable.tsx index 22434df1b6..6ee14d7857 100644 --- a/src/renderer/ipc/list-namespaces-forbidden-handler.injectable.tsx +++ b/src/renderer/ipc/list-namespaces-forbidden-handler.injectable.tsx @@ -11,6 +11,7 @@ import { Button } from "../components/button"; import type { IpcRendererEvent } from "electron"; import React from "react"; import notificationsStoreInjectable from "../components/notifications/notifications-store.injectable"; +import { getMillisecondsFromUnixEpoch } from "../../common/utils/date/get-current-date-time"; const listNamespacesForbiddenHandlerInjectable = getInjectable({ id: "list-namespaces-forbidden-handler", @@ -18,7 +19,6 @@ const listNamespacesForbiddenHandlerInjectable = getInjectable({ instantiate: (di) => { const navigateToEntitySettings = di.inject(navigateToEntitySettingsInjectable); const notificationsStore = di.inject(notificationsStoreInjectable); - const notificationLastDisplayedAt = new Map(); const intervalBetweenNotifications = 1000 * 60; // 60s @@ -27,7 +27,7 @@ const listNamespacesForbiddenHandlerInjectable = getInjectable({ ...[clusterId]: ListNamespaceForbiddenArgs ): void => { const lastDisplayedAt = notificationLastDisplayedAt.get(clusterId); - const now = Date.now(); + const now = getMillisecondsFromUnixEpoch(); if ( typeof lastDisplayedAt !== "number" || @@ -74,7 +74,7 @@ const listNamespacesForbiddenHandlerInjectable = getInjectable({ * Set the time when the notification is closed as well so that there is at * least a minute between closing the notification as seeing it again */ - onClose: () => notificationLastDisplayedAt.set(clusterId, Date.now()), + onClose: () => notificationLastDisplayedAt.set(clusterId, getMillisecondsFromUnixEpoch()), }, ); }; diff --git a/src/renderer/k8s/api-base.injectable.ts b/src/renderer/k8s/api-base.injectable.ts new file mode 100644 index 0000000000..9ce5ab5f98 --- /dev/null +++ b/src/renderer/k8s/api-base.injectable.ts @@ -0,0 +1,36 @@ +/** + * 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 createJsonApiInjectable from "../../common/k8s-api/create-json-api.injectable"; +import windowLocationInjectable from "../../common/k8s-api/window-location.injectable"; +import { apiPrefix } from "../../common/vars"; +import isDebuggingInjectable from "../../common/vars/is-debugging.injectable"; +import isDevelopmentInjectable from "../../common/vars/is-development.injectable"; + +const apiBaseInjectable = getInjectable({ + id: "api-base", + instantiate: (di) => { + const createJsonApi = di.inject(createJsonApiInjectable); + const isDebugging = di.inject(isDebuggingInjectable); + const { port, host } = di.inject(windowLocationInjectable); + + return createJsonApi( + { + serverAddress: `http://127.0.0.1:${port}`, + apiBase: apiPrefix, + debug: di.inject(isDevelopmentInjectable) || isDebugging, + }, + { + headers: { + "Host": host, + }, + }, + ); + }, + injectionToken: apiBaseInjectionToken, +}); + +export default apiBaseInjectable; diff --git a/src/renderer/k8s/api-kube.injectable.ts b/src/renderer/k8s/api-kube.injectable.ts index f617a10ce6..c7c87194a5 100644 --- a/src/renderer/k8s/api-kube.injectable.ts +++ b/src/renderer/k8s/api-kube.injectable.ts @@ -4,28 +4,41 @@ */ import { getInjectable } from "@ogre-tools/injectable"; import assert from "assert"; -import { onApiError } from "../api/on-api-error"; -import { apiKubePrefix, isDevelopment } from "../../common/vars"; +import { apiKubePrefix } from "../../common/vars"; import { apiKubeInjectionToken } from "../../common/k8s-api/api-kube"; import { storesAndApisCanBeCreatedInjectionToken } from "../../common/k8s-api/stores-apis-can-be-created.token"; -import { KubeJsonApi } from "../../common/k8s-api/kube-json-api"; +import createKubeJsonApiInjectable from "../../common/k8s-api/create-kube-json-api.injectable"; +import isDevelopmentInjectable from "../../common/vars/is-development.injectable"; +import showErrorNotificationInjectable from "../components/notifications/show-error-notification.injectable"; +import windowLocationInjectable from "../../common/k8s-api/window-location.injectable"; const apiKubeInjectable = getInjectable({ id: "api-kube", instantiate: (di) => { assert(di.inject(storesAndApisCanBeCreatedInjectionToken), "apiKube is only available in certain environments"); + const createKubeJsonApi = di.inject(createKubeJsonApiInjectable); + const isDevelopment = di.inject(isDevelopmentInjectable); + const showErrorNotification = di.inject(showErrorNotificationInjectable); + const { port, host } = di.inject(windowLocationInjectable); - const apiKube = new KubeJsonApi({ - serverAddress: `http://127.0.0.1:${window.location.port}`, + const apiKube = createKubeJsonApi({ + serverAddress: `http://127.0.0.1:${port}`, apiBase: apiKubePrefix, debug: isDevelopment, }, { headers: { - "Host": window.location.host, + "Host": host, }, }); - apiKube.onError.addListener(onApiError); + apiKube.onError.addListener((error, res) => { + switch (res.status) { + case 403: + error.isUsedForNotification = true; + showErrorNotification(error); + break; + } + }); return apiKube; }, diff --git a/src/renderer/port-forward/port-forward-store/port-forward-store.injectable.ts b/src/renderer/port-forward/port-forward-store/port-forward-store.injectable.ts index 4e834d0650..5339a3e4e7 100644 --- a/src/renderer/port-forward/port-forward-store/port-forward-store.injectable.ts +++ b/src/renderer/port-forward/port-forward-store/port-forward-store.injectable.ts @@ -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( - "port_forwards", - undefined, - ); - return new PortForwardStore({ - storage, + storage: createStorage( + "port_forwards", + undefined, + ), notifyErrorPortForwarding: di.inject(notifyErrorPortForwardingInjectable), + apiBase: di.inject(apiBaseInjectionToken), + requestActivePortForward: di.inject(requestActivePortForwardInjectable), }); }, }); diff --git a/src/renderer/port-forward/port-forward-store/port-forward-store.ts b/src/renderer/port-forward/port-forward-store/port-forward-store.ts index 542996e00b..179dd2f39c 100644 --- a/src/renderer/port-forward/port-forward-store/port-forward-store.ts +++ b/src/renderer/port-forward/port-forward-store/port-forward-store.ts @@ -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; + readonly storage: StorageLayer; notifyErrorPortForwarding: (message: string) => void; + readonly apiBase: JsonApi; // TODO: replace with individual dependencies + requestActivePortForward: RequestActivePortForward; } export class PortForwardStore extends ItemStore { @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 { 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 { } const { port, forwardPort } = pf; - let response: PortForwardResult; + let response: { port: number }; try { - response = await apiBase.post( + 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 { 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 { }; } -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 { - const { port, forwardPort } = portForward; - let response: PortForwardResult; - - try { - response = await apiBase.get(`/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; -} diff --git a/src/renderer/port-forward/port-forward-store/request-active-port-forward.injectable.ts b/src/renderer/port-forward/port-forward-store/request-active-port-forward.injectable.ts new file mode 100644 index 0000000000..4939f4d955 --- /dev/null +++ b/src/renderer/port-forward/port-forward-store/request-active-port-forward.injectable.ts @@ -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; + +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; diff --git a/src/renderer/utils/create-storage/create-storage.injectable.ts b/src/renderer/utils/create-storage/create-storage.injectable.ts index b40eef738c..2d295b802b 100644 --- a/src/renderer/utils/create-storage/create-storage.injectable.ts +++ b/src/renderer/utils/create-storage/create-storage.injectable.ts @@ -9,9 +9,9 @@ import readJsonFileInjectable from "../../../common/fs/read-json-file.injectable import writeJsonFileInjectable from "../../../common/fs/write-json-file.injectable"; import { observable } from "mobx"; import loggerInjectable from "../../../common/logger.injectable"; -import getAbsolutePathInjectable from "../../../common/path/get-absolute-path.injectable"; import hostedClusterIdInjectable from "../../cluster-frame-context/hosted-cluster-id.injectable"; import storageSaveDelayInjectable from "./storage-save-delay.injectable"; +import joinPathsInjectable from "../../../common/path/join-paths.injectable"; const createStorageInjectable = getInjectable({ id: "create-storage", @@ -26,7 +26,7 @@ const createStorageInjectable = getInjectable({ writeJsonFile: di.inject(writeJsonFileInjectable), logger: di.inject(loggerInjectable), directoryForLensLocalStorage: di.inject(directoryForLensLocalStorageInjectable), - getAbsolutePath: di.inject(getAbsolutePathInjectable), + joinPaths: di.inject(joinPathsInjectable), hostedClusterId: di.inject(hostedClusterIdInjectable), saveDelay: di.inject(storageSaveDelayInjectable), }), diff --git a/src/renderer/utils/create-storage/create-storage.ts b/src/renderer/utils/create-storage/create-storage.ts index 501e425161..1149d479cc 100755 --- a/src/renderer/utils/create-storage/create-storage.ts +++ b/src/renderer/utils/create-storage/create-storage.ts @@ -8,10 +8,9 @@ import { comparer, reaction, toJS, when } from "mobx"; import type { StorageLayer } from "../storageHelper"; import { StorageHelper } from "../storageHelper"; -import { isTestEnv } from "../../../common/vars"; import type { JsonObject, JsonValue } from "type-fest"; import type { Logger } from "../../../common/logger"; -import type { GetAbsolutePath } from "../../../common/path/get-absolute-path.injectable"; +import type { JoinPaths } from "../../../common/path/join-paths.injectable"; interface Dependencies { storage: { initialized: boolean; loaded: boolean; data: Record }; @@ -19,7 +18,7 @@ interface Dependencies { directoryForLensLocalStorage: string; readJsonFile: (filePath: string) => Promise; writeJsonFile: (filePath: string, contentObject: JsonObject) => Promise; - getAbsolutePath: GetAbsolutePath; + joinPaths: JoinPaths; hostedClusterId: string | undefined; saveDelay: number; } @@ -31,7 +30,7 @@ export type CreateStorage = (key: string, defaultValue: T) => StorageLayer */ export const createStorage = ({ storage, - getAbsolutePath, + joinPaths, logger, directoryForLensLocalStorage, readJsonFile, @@ -45,17 +44,14 @@ export const createStorage = ({ storage.initialized = true; (async () => { - const filePath = getAbsolutePath(directoryForLensLocalStorage, `${hostedClusterId || "app"}.json`); + const filePath = joinPaths(directoryForLensLocalStorage, `${hostedClusterId || "app"}.json`); try { storage.data = (await readJsonFile(filePath)) as JsonObject; } catch { // do nothing } finally { - if (!isTestEnv) { - logger.info(`${logPrefix} loading finished for ${filePath}`); - } - + logger.info(`${logPrefix} loading finished for ${filePath}`); storage.loaded = true; } diff --git a/src/test-utils/override-fs-with-fakes.ts b/src/test-utils/override-fs-with-fakes.ts index 1064a36d27..9269eab04e 100644 --- a/src/test-utils/override-fs-with-fakes.ts +++ b/src/test-utils/override-fs-with-fakes.ts @@ -7,10 +7,9 @@ import readFileInjectable from "../common/fs/read-file.injectable"; import writeJsonFileInjectable from "../common/fs/write-json-file.injectable"; import readJsonFileInjectable from "../common/fs/read-json-file.injectable"; import pathExistsInjectable from "../common/fs/path-exists.injectable"; +import deleteFileInjectable from "../common/fs/delete-file.injectable"; -export const overrideFsWithFakes = (di: DiContainer) => { - const state = new Map(); - +export const overrideFsWithFakes = (di: DiContainer, state = new Map()) => { const readFile = readFileFor(state); di.override(readFileInjectable, () => readFile); @@ -25,6 +24,9 @@ export const overrideFsWithFakes = (di: DiContainer) => { di.override(pathExistsInjectable, () => ( (filePath: string) => Promise.resolve(state.has(filePath)) )); + di.override(deleteFileInjectable, () => async (filePath: string) => { + state.delete(filePath); + }); }; const readFileFor = (state: Map) => (filePath: string) => { diff --git a/types/dom.d.ts b/types/dom.d.ts index 0e3e1bcb43..04e99babcd 100644 --- a/types/dom.d.ts +++ b/types/dom.d.ts @@ -8,9 +8,4 @@ declare global { interface Element { scrollIntoViewIfNeeded?(opt_center?: boolean): void; } - - interface Window { - requestIdleCallback(callback: () => void, options: { timeout: number }); - cancelIdleCallback(callback: () => void); - } } diff --git a/yarn.lock b/yarn.lock index 4b8d99255c..52b0b64ce6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2250,13 +2250,6 @@ resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.5.tgz#1001cc5e6a3704b83c236027e77f2f58ea010f40" integrity sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ== -"@types/minipass@*": - version "3.1.2" - resolved "https://registry.yarnpkg.com/@types/minipass/-/minipass-3.1.2.tgz#e2d7f9df0698aff421dcf145b4fc05b8183b9030" - integrity sha512-foLGjgrJkUjLG/o2t2ymlZGEoBNBa/TfoUZ7oCTkOjP1T43UGBJspovJou/l3ZuHvye2ewR5cZNtp2zyWgILMA== - dependencies: - "@types/node" "*" - "@types/mkdirp@^1.0.0": version "1.0.2" resolved "https://registry.yarnpkg.com/@types/mkdirp/-/mkdirp-1.0.2.tgz#8d0bad7aa793abe551860be1f7ae7f3198c16666" @@ -2561,13 +2554,13 @@ dependencies: "@types/node" "*" -"@types/tar@^4.0.5": - version "4.0.5" - resolved "https://registry.yarnpkg.com/@types/tar/-/tar-4.0.5.tgz#5f953f183e36a15c6ce3f336568f6051b7b183f3" - integrity sha512-cgwPhNEabHaZcYIy5xeMtux2EmYBitfqEceBUi2t5+ETy4dW6kswt6WX4+HqLeiiKOo42EXbGiDmVJ2x+vi37Q== +"@types/tar@^6.1.2": + version "6.1.2" + resolved "https://registry.yarnpkg.com/@types/tar/-/tar-6.1.2.tgz#e60108a7d1b08cc91bf2faf1286cc08fdad48bbe" + integrity sha512-bnX3RRm70/n1WMwmevdOAeDU4YP7f5JSubgnuU+yrO+xQQjwDboJj3u2NTJI5ngCQhXihqVVAH5h5J8YpdpEvg== dependencies: - "@types/minipass" "*" "@types/node" "*" + minipass "^3.3.5" "@types/tcp-port-used@^1.0.1": version "1.0.1" @@ -4516,13 +4509,6 @@ create-require@^1.1.0: resolved "https://registry.yarnpkg.com/create-require/-/create-require-1.1.1.tgz#c1d7e8f1e5f6cfc9ff65f9cd352d37348756c333" integrity sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ== -cross-fetch@^3.0.4: - version "3.1.5" - resolved "https://registry.yarnpkg.com/cross-fetch/-/cross-fetch-3.1.5.tgz#e1389f44d9e7ba767907f7af8454787952ab534f" - integrity sha512-lvb1SBsI0Z7GDwmuid+mU3kWVBwTVUbe7S0H52yaaAdQOXq2YktTCZdlAcNKFzE6QtRz0snpw9bNiPeOIkkQvw== - dependencies: - node-fetch "2.6.7" - cross-spawn@^6.0.0: version "6.0.5" resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-6.0.5.tgz#4a5ec7c64dfae22c3a14124dbacdee846d80cbc4" @@ -7748,14 +7734,6 @@ jest-environment-node@^28.1.3: jest-mock "^28.1.3" jest-util "^28.1.3" -jest-fetch-mock@^3.0.3: - version "3.0.3" - resolved "https://registry.yarnpkg.com/jest-fetch-mock/-/jest-fetch-mock-3.0.3.tgz#31749c456ae27b8919d69824f1c2bd85fe0a1f3b" - integrity sha512-Ux1nWprtLrdrH4XwE7O7InRY6psIi3GOsqNESJgMJ+M5cv4A8Lh7SN9d2V2kKRZ8ebAfcd1LNyZguAOb6JiDqw== - dependencies: - cross-fetch "^3.0.4" - promise-polyfill "^8.1.3" - jest-get-type@^28.0.2: version "28.0.2" resolved "https://registry.yarnpkg.com/jest-get-type/-/jest-get-type-28.0.2.tgz#34622e628e4fdcd793d46db8a242227901fcf203" @@ -9123,6 +9101,13 @@ minipass@^3.0.0, minipass@^3.1.0, minipass@^3.1.1, minipass@^3.1.3, minipass@^3. dependencies: yallist "^4.0.0" +minipass@^3.3.5: + version "3.3.5" + resolved "https://registry.yarnpkg.com/minipass/-/minipass-3.3.5.tgz#6da7e53a48db8a856eeb9153d85b230a2119e819" + integrity sha512-rQ/p+KfKBkeNwo04U15i+hOwoVBVmekmm/HcfTkTN2t9pbQKCMm4eN5gFeqgrrSp/kH/7BYYhTIHOxGqzbBPaA== + dependencies: + yallist "^4.0.0" + minizlib@^2.0.0, minizlib@^2.1.1, minizlib@^2.1.2: version "2.1.2" resolved "https://registry.yarnpkg.com/minizlib/-/minizlib-2.1.2.tgz#e90d3466ba209b932451508a11ce3d3632145931" @@ -9341,7 +9326,7 @@ node-addon-api@^5.0.0: resolved "https://registry.yarnpkg.com/node-addon-api/-/node-addon-api-5.0.0.tgz#7d7e6f9ef89043befdb20c1989c905ebde18c501" integrity sha512-CvkDw2OEnme7ybCykJpVcKH+uAOLV2qLqiyla128dN9TkEWfrYmxG6C2boDe5KcNQqZF3orkqzGgOMvZ/JNekA== -node-fetch@2.6.7, node-fetch@^2.6.7: +node-fetch@^2.6.7: version "2.6.7" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad" integrity sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ== @@ -10453,11 +10438,6 @@ promise-inflight@^1.0.1: resolved "https://registry.yarnpkg.com/promise-inflight/-/promise-inflight-1.0.1.tgz#98472870bf228132fcbdd868129bad12c3c029e3" integrity sha1-mEcocL8igTL8vdhoEputEsPAKeM= -promise-polyfill@^8.1.3: - version "8.2.3" - resolved "https://registry.yarnpkg.com/promise-polyfill/-/promise-polyfill-8.2.3.tgz#2edc7e4b81aff781c88a0d577e5fe9da822107c6" - integrity sha512-Og0+jCRQetV84U8wVjMNccfGCnMQ9mGs9Hv78QFe+pSDD3gWTpz0y+1QCuxy5d/vBFuZ3iwP2eycAkvqIMPmWg== - promise-retry@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/promise-retry/-/promise-retry-2.0.1.tgz#ff747a13620ab57ba688f5fc67855410c370da22"