Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for controlling entity settings visibility during runtime #7816

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Add support for controlling entity settings visibility during runtime #7816

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e81824e
Add support for controlling entity settings visibility during runtime
jweak Jun 1, 2023
0b70957
Merge branch 'master' into add-entity-settings-visibility
jweak Jun 1, 2023
9911449
Merge branch 'master' into add-entity-settings-visibility
jweak Jun 1, 2023
de3db05
Add unit test to entity settings visibility
jweak Jun 1, 2023
053a5d7
Merge branch 'master' into add-entity-settings-visibility
jweak Jun 2, 2023
f91e360
Merge branch 'master' into add-entity-settings-visibility
jweak Jun 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/core/src/renderer/components/entity-settings/extension-registrator.injectable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import { extensionRegistratorInjectionToken } from "../../../extensions/extensio
import type { LensRendererExtension } from "../../../extensions/lens-renderer-extension";
import type { CatalogEntity } from "../../api/catalog-entity";
import { entitySettingInjectionToken } from "./token";
import type { IComputedValue } from "mobx";
import { computed } from "mobx";

export interface EntitySettingViewProps {
entity: CatalogEntity;
Expand All @@ -25,6 +27,7 @@ export interface EntitySettingRegistration {
id?: string;
priority?: number;
group?: string;
visible?: IComputedValue<boolean>;
}

export interface RegisteredEntitySetting {
Expand All @@ -36,6 +39,7 @@ export interface RegisteredEntitySetting {
components: EntitySettingComponents;
source?: string;
group: string;
isShown: IComputedValue<boolean>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not call this also visible?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to replicate the existing behavior that was implemented with AppPreferenceTabRegistration. I think it's a convention in this code base for Showable and such

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this should be optional to not break something..

Copy link
Contributor Author

@jweak jweak Jun 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The EntitySettingRegistration from extension has optional visible. When the extension settings are read the extension settings are converted to RegisteredEntitySetting and then we can make this not optional which is nicer for the users of RegisteredEntitySetting. We default to visible then if the visible property is not set

}

const entitySettingExtensionRegistratorInjectable = getInjectable({
Expand All @@ -59,6 +63,7 @@ const getInjectableForEntitySettingRegistrationFor = (extension: LensRendererExt
id = btoa(title),
priority,
source,
visible,
}: EntitySettingRegistration) => getInjectable({
id: `${extension.manifest.name}:${group}/${kind}:${id}`,
instantiate: () => ({
Expand All @@ -70,6 +75,7 @@ const getInjectableForEntitySettingRegistrationFor = (extension: LensRendererExt
title,
group,
source,
isShown: computed(() => visible?.get() ?? true),
}),
injectionToken: entitySettingInjectionToken,
});
2 changes: 2 additions & 0 deletions ...er/components/entity-settings/internal-kubernetes-cluster/general-settings.injectable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { ClusterKubeconfig } from "../../cluster-settings/kubeconfig";
import { ClusterNameSetting } from "../../cluster-settings/name-setting";
import type { EntitySettingViewProps } from "../extension-registrator.injectable";
import { entitySettingInjectionToken } from "../token";
import { computed } from "mobx";

interface Dependencies {
getClusterById: GetClusterById;
Expand Down Expand Up @@ -64,6 +65,7 @@ const generalKubernetesClusterEntitySettingsInjectable = getInjectable({
components: {
View: GeneralKubernetesClusterSettings,
},
isShown: computed(() => true),
}),
injectionToken: entitySettingInjectionToken,
});
Expand Down
2 changes: 2 additions & 0 deletions ...er/components/entity-settings/internal-kubernetes-cluster/metrics-settings.injectable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { ClusterPrometheusSetting } from "../../cluster-settings/prometheus-sett
import { ShowMetricsSetting } from "../../cluster-settings/show-metrics";
import type { EntitySettingViewProps } from "../extension-registrator.injectable";
import { entitySettingInjectionToken } from "../token";
import { computed } from "mobx";

interface Dependencies {
getClusterById: GetClusterById;
Expand Down Expand Up @@ -57,6 +58,7 @@ const metricsKubernetesClusterEntitySettingsInjectable = getInjectable({
components: {
View: MetricsKubernetesClusterSettings,
},
isShown: computed(() => true),
}),
injectionToken: entitySettingInjectionToken,
});
Expand Down
2 changes: 2 additions & 0 deletions .../components/entity-settings/internal-kubernetes-cluster/namespace-settings.injectable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import getClusterByIdInjectable from "../../../../features/cluster/storage/commo
import { ClusterAccessibleNamespaces } from "../../cluster-settings/accessible-namespaces";
import type { EntitySettingViewProps } from "../extension-registrator.injectable";
import { entitySettingInjectionToken } from "../token";
import { computed } from "mobx";

interface Dependencies {
getClusterById: GetClusterById;
Expand Down Expand Up @@ -48,6 +49,7 @@ const namespaceKubernetesClusterEntitySettingsInjectable = getInjectable({
components: {
View: NamespaceKubernetesClusterSettings,
},
isShown: computed(() => true),
}),
injectionToken: entitySettingInjectionToken,
});
Expand Down
2 changes: 2 additions & 0 deletions ...components/entity-settings/internal-kubernetes-cluster/node-shell-settings.injectable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import getClusterByIdInjectable from "../../../../features/cluster/storage/commo
import { ClusterNodeShellSetting } from "../../cluster-settings/node-shell-setting";
import type { EntitySettingViewProps } from "../extension-registrator.injectable";
import { entitySettingInjectionToken } from "../token";
import { computed } from "mobx";

interface Dependencies {
getClusterById: GetClusterById;
Expand Down Expand Up @@ -48,6 +49,7 @@ const nodeShellKubernetesClusterEntitySettingsInjectable = getInjectable({
components: {
View: NodeShellKubernetesClusterSettings,
},
isShown: computed(() => true),
}),
injectionToken: entitySettingInjectionToken,
});
Expand Down
2 changes: 2 additions & 0 deletions ...erer/components/entity-settings/internal-kubernetes-cluster/proxy-settings.injectable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import getClusterByIdInjectable from "../../../../features/cluster/storage/commo
import { ClusterProxySetting } from "../../cluster-settings/proxy-setting";
import type { EntitySettingViewProps } from "../extension-registrator.injectable";
import { entitySettingInjectionToken } from "../token";
import { computed } from "mobx";

interface Dependencies {
getClusterById: GetClusterById;
Expand Down Expand Up @@ -48,6 +49,7 @@ const proxyKubernetesClusterEntitySettingsInjectable = getInjectable({
components: {
View: ProxyKubernetesClusterSettings,
},
isShown: computed(() => true),
}),
injectionToken: entitySettingInjectionToken,
});
Expand Down
2 changes: 2 additions & 0 deletions ...r/components/entity-settings/internal-kubernetes-cluster/terminal-settings.injectable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import getClusterByIdInjectable from "../../../../features/cluster/storage/commo
import { ClusterLocalTerminalSetting } from "../../cluster-settings/local-terminal-settings";
import type { EntitySettingViewProps } from "../extension-registrator.injectable";
import { entitySettingInjectionToken } from "../token";
import { computed } from "mobx";

interface Dependencies {
getClusterById: GetClusterById;
Expand Down Expand Up @@ -48,6 +49,7 @@ const terminalKubernetesClusterEntitySettingsInjectable = getInjectable({
components: {
View: TerminalKubernetesClusterSettings,
},
isShown: computed(() => true),
}),
injectionToken: entitySettingInjectionToken,
});
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/renderer/components/entity-settings/settings.injectable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const catalogEntitySettingItemsInjectable = getInjectable({
item.apiVersions.has(entity.apiVersion)
&& item.kind === entity.kind
&& (!item.source || item.source === entity.metadata.source)
&& item.isShown.get()
))
.sort(byOrderNumber)
));
Expand Down