Turn on strict mode in tsconfig.json

- Add route, clusterRoute, and payloadValidatedClusterRoute helper
  functions to improve types with backend routes

- Turn on the following new lints:
  - react/jsx-first-prop-new-line
  - react/jsx-wrap-multilines
  - react/jsx-one-expression-per-line
  - react/jsx-max-props-per-line
  - react/jsx-indent
  - react/jsx-indent-props

Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
Sebastian Malton committed 2022-05-04 08:45:50 -04:00
1 parent e532b90b72
commit f594bf03f3
689 files changed
+14529 -11302

No files matched your search

@@ -9,6 +9,7 @@ import type { CatalogEntityData, CatalogEntityKindData } from "../catalog-entity
import { CatalogCategory } from "../catalog-entity";
import { KubernetesCluster, WebLink } from "../../../common/catalog-entities";
import { observable } from "mobx";
import { categoryVersion } from "../../../common/catalog";
class TestCatalogEntityRegistry extends CatalogEntityRegistry {
replaceItems(items: Array<CatalogEntityData & CatalogEntityKindData>) {
@@ -26,10 +27,7 @@ class FooBarCategory extends CatalogCategory {
public spec = {
group: "entity.k8slens.dev",
versions: [
{
name: "v1alpha1",
entityClass: WebLink,
},
categoryVersion("v1alpha1", WebLink),
],
names: {
kind: "FooBar",
+7 -3
View File
@@ -50,10 +50,14 @@ export class CatalogEntityRegistry {
}
protected getActiveEntityById() {
return this._entities.get(this.activeEntityId) || null;
if (!this.activeEntityId) {
return undefined;
}
return this._entities.get(this.activeEntityId);
}
get activeEntity(): CatalogEntity | null {
get activeEntity(): CatalogEntity | undefined {
const entity = this.getActiveEntityById();
// If the entity was not found but there are rawEntities to be processed,
@@ -68,7 +72,7 @@ export class CatalogEntityRegistry {
return entity;
}
set activeEntity(raw: CatalogEntity | string | null) {
set activeEntity(raw: CatalogEntity | string | undefined) {
if (raw) {
const id = typeof raw === "string"
? raw
@@ -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 assert from "assert";
import hostedClusterIdInjectable from "../cluster/hosted-cluster-id.injectable";
import type { TerminalApiDependencies, TerminalApiQuery } from "./terminal-api";
import { TerminalApi } from "./terminal-api";
export type CreateTerminalApi = (query: TerminalApiQuery) => TerminalApi;
const createTerminalApiInjectable = getInjectable({
id: "create-terminal-api",
instantiate: (di): CreateTerminalApi => {
const hostedClusterId = di.inject(hostedClusterIdInjectable);
assert(hostedClusterId, "Can only create terminal APIs within a cluster frame");
const dependencies: TerminalApiDependencies = {
hostedClusterId,
};
return (query) => new TerminalApi(dependencies, query);
},
});
export default createTerminalApiInjectable;
@@ -7,12 +7,15 @@ import { when } from "mobx";
import { catalogCategoryRegistry } from "../../../common/catalog";
import { catalogEntityRegistry } from "../catalog-entity-registry";
import { isActiveRoute } from "../../navigation";
import type { GeneralEntity } from "../../../common/catalog-entities";
import assert from "assert";
export async function setEntityOnRouteMatch() {
await when(() => catalogEntityRegistry.entities.size > 0);
const entities: GeneralEntity[] = catalogEntityRegistry.getItemsForCategory(catalogCategoryRegistry.getByName("General"));
const generalCategory = catalogCategoryRegistry.getByName("General");
assert(generalCategory);
const entities = catalogEntityRegistry.getItemsForCategory(generalCategory);
const activeEntity = entities.find(entity => isActiveRoute(entity.spec.path));
if (activeEntity) {
+21 -12
View File
@@ -3,7 +3,6 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getHostedClusterId } from "../utils";
import type { WebSocketEvents } from "./websocket-api";
import { WebSocketApi } from "./websocket-api";
import isEqual from "lodash/isEqual";
@@ -49,23 +48,27 @@ enum TerminalColor {
NO_COLOR = "\u001b[0m",
}
export type TerminalApiQuery = Record<string, string> & {
export interface TerminalApiQuery extends Record<string, string | undefined> {
id: string;
node?: string;
type?: string;
};
}
export interface TerminalEvents extends WebSocketEvents {
ready: () => void;
connected: () => void;
}
export interface TerminalApiDependencies {
readonly hostedClusterId: string;
}
export class TerminalApi extends WebSocketApi<TerminalEvents> {
protected size: { width: number; height: number };
protected size?: { width: number; height: number };
@observable public isReady = false;
constructor(protected query: TerminalApiQuery) {
constructor(protected readonly dependencies: TerminalApiDependencies, protected readonly query: TerminalApiQuery) {
super({
flushOnOpen: false,
pingInterval: 30,
@@ -86,7 +89,7 @@ export class TerminalApi extends WebSocketApi<TerminalEvents> {
this.emitStatus("Connecting ...");
}
const authTokenArray = await ipcRenderer.invoke("cluster:shell-api", getHostedClusterId(), this.query.id);
const authTokenArray = await ipcRenderer.invoke("cluster:shell-api", this.dependencies.hostedClusterId, this.query.id);
if (!(authTokenArray instanceof Uint8Array)) {
throw new TypeError("ShellApi token is not a Uint8Array");
@@ -114,11 +117,15 @@ export class TerminalApi extends WebSocketApi<TerminalEvents> {
// data is undefined if the event that was handled is "connected"
if (data === undefined) {
/**
* Output the last line, the makes sure that the terminal isn't completely
* empty when the user refreshes.
*/
this.emit("data", window.localStorage.getItem(`${this.query.id}:last-data`));
const lastData = window.localStorage.getItem(`${this.query.id}:last-data`);
if (lastData) {
/**
* Output the last line, the makes sure that the terminal isn't completely
* empty when the user refreshes.
*/
this.emit("data", lastData);
}
}
});
@@ -126,7 +133,9 @@ export class TerminalApi extends WebSocketApi<TerminalEvents> {
this.prependListener("connected", onReady);
super.connect(socketUrl);
this.socket.binaryType = "arraybuffer";
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
this.socket!.binaryType = "arraybuffer";
}
sendMessage(message: TerminalMessage) {
+17 -11
View File
@@ -8,6 +8,7 @@ import EventEmitter from "events";
import type TypedEventEmitter from "typed-emitter";
import type { Arguments } from "typed-emitter";
import { isDevelopment } from "../../common/vars";
import type { Defaulted } from "../utils";
interface WebsocketApiParams {
/**
@@ -62,18 +63,16 @@ export interface WebSocketEvents {
close: () => void;
}
type Defaulted<Params, DefaultParams extends keyof Params> = Required<Pick<Params, DefaultParams>> & Omit<Params, DefaultParams>;
export class WebSocketApi<Events extends WebSocketEvents> extends (EventEmitter as { new<T>(): TypedEventEmitter<T> })<Events> {
protected socket?: WebSocket | null;
protected socket: WebSocket | null = null;
protected pendingCommands: (string | ArrayBufferLike | Blob | ArrayBufferView)[] = [];
protected reconnectTimer?: any;
protected pingTimer?: any;
protected reconnectTimer?: number;
protected pingTimer?: number;
protected params: Defaulted<WebsocketApiParams, keyof typeof WebSocketApi["defaultParams"]>;
@observable readyState = WebSocketApiState.PENDING;
private static defaultParams = {
private static readonly defaultParams = {
logging: isDevelopment,
reconnectDelay: 10,
flushOnOpen: true,
@@ -83,18 +82,25 @@ export class WebSocketApi<Events extends WebSocketEvents> extends (EventEmitter
constructor(params: WebsocketApiParams) {
super();
makeObservable(this);
this.params = Object.assign({}, WebSocketApi.defaultParams, params);
this.params = {
...WebSocketApi.defaultParams,
...params,
};
const { pingInterval } = this.params;
if (pingInterval) {
this.pingTimer = setInterval(() => this.ping(), pingInterval * 1000);
this.pingTimer = window.setInterval(() => this.ping(), pingInterval * 1000);
}
}
get isConnected() {
protected getIsConnected(): this is (WebSocketApi<Events> & { socket: WebSocket }) {
return this.socket?.readyState === WebSocket.OPEN && this.isOnline;
}
get isConnected() {
return this.getIsConnected();
}
get isOnline() {
return navigator.onLine;
}
@@ -144,7 +150,7 @@ export class WebSocketApi<Events extends WebSocketEvents> extends (EventEmitter
}
send(command: string | ArrayBufferLike | Blob | ArrayBufferView) {
if (this.isConnected) {
if (this.getIsConnected()) {
this.socket.send(command);
} else {
this.pendingCommands.push(command);
@@ -186,7 +192,7 @@ export class WebSocketApi<Events extends WebSocketEvents> extends (EventEmitter
this.writeLog("will reconnect in", `${reconnectDelay}s`);
this.reconnectTimer = setTimeout(() => this.connect(url), reconnectDelay * 1000);
this.reconnectTimer = window.setTimeout(() => this.connect(url), reconnectDelay * 1000);
this.readyState = WebSocketApiState.RECONNECTING;
}
} else {
+6 -3
View File
@@ -42,7 +42,8 @@ import navigateToAddClusterInjectable from "../common/front-end-routing/routes/
import addSyncEntriesInjectable from "./initializers/add-sync-entries.injectable";
import hotbarStoreInjectable from "../common/hotbar-store.injectable";
import { bindEvents } from "./navigation/events";
import deleteClusterDialogModelInjectable from "./components/delete-cluster-dialog/delete-cluster-dialog-model/delete-cluster-dialog-model.injectable";
import assert from "assert";
import openDeleteClusterDialogInjectable from "./components/delete-cluster-dialog/open.injectable";
import { init } from "@sentry/electron/renderer";
configurePackages(); // global packages
@@ -70,6 +71,9 @@ export async function bootstrap(di: DiContainer) {
bindEvents();
const rootElem = document.getElementById("app");
assert(rootElem);
const rootNode = createRoot(rootElem);
const logPrefix = `[BOOTSTRAP-${process.isMainFrame ? "ROOT" : "CLUSTER"}-FRAME]:`;
@@ -103,7 +107,7 @@ export async function bootstrap(di: DiContainer) {
logger.info(`${logPrefix} initializing Catalog`);
initializers.initCatalog({
openCommandDialog: di.inject(commandOverlayInjectable).open,
deleteClusterDialogModel: di.inject(deleteClusterDialogModelInjectable),
openDeleteClusterDialog: di.inject(openDeleteClusterDialogInjectable),
});
const extensionLoader = di.inject(extensionLoaderInjectable);
@@ -146,7 +150,6 @@ export async function bootstrap(di: DiContainer) {
// TODO: Introduce proper architectural boundaries between root and cluster iframes
if (process.isMainFrame) {
initializeApp = di.inject(initRootFrameInjectable);
App = (await import("./frames/root-frame/root-frame")).RootFrame;
} else {
initializeApp = di.inject(initClusterFrameInjectable);
@@ -5,7 +5,8 @@
import { getInjectable } from "@ogre-tools/injectable";
import { ClusterFrameContext } from "./cluster-frame-context";
import namespaceStoreInjectable from "../components/+namespaces/namespace-store/namespace-store.injectable";
import hostedClusterInjectable from "../../common/cluster-store/hosted-cluster.injectable";
import hostedClusterInjectable from "../cluster/hosted-cluster.injectable";
import assert from "assert";
const clusterFrameContextInjectable = getInjectable({
id: "cluster-frame-context",
@@ -13,13 +14,11 @@ const clusterFrameContextInjectable = getInjectable({
instantiate: (di) => {
const cluster = di.inject(hostedClusterInjectable);
return new ClusterFrameContext(
cluster,
assert(cluster, "This can only be injected within a cluster frame");
{
namespaceStore: di.inject(namespaceStoreInjectable),
},
);
return new ClusterFrameContext(cluster, {
namespaceStore: di.inject(namespaceStoreInjectable),
});
},
});
@@ -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 { getClusterIdFromHost } from "../../common/utils";
const hostedClusterIdInjectable = getInjectable({
id: "hosted-cluster-id",
instantiate: () => getClusterIdFromHost(location.host),
causesSideEffects: true,
});
export default hostedClusterIdInjectable;
@@ -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 hostedClusterIdInjectable from "./hosted-cluster-id.injectable";
import clusterStoreInjectable from "../../common/cluster-store/cluster-store.injectable";
const hostedClusterInjectable = getInjectable({
id: "hosted-cluster",
instantiate: (di) => {
const hostedClusterId = di.inject(hostedClusterIdInjectable);
const store = di.inject(clusterStoreInjectable);
return store.getById(hostedClusterId);
},
});
export default hostedClusterInjectable;
@@ -16,7 +16,7 @@ import * as uuid from "uuid";
import { appEventBus } from "../../../common/app-event-bus/event-bus";
import { loadConfigFromString, splitConfig } from "../../../common/kube-helpers";
import { docsUrl } from "../../../common/vars";
import { iter } from "../../utils";
import { isDefined, iter } from "../../utils";
import { Button } from "../button";
import { Notifications } from "../notifications";
import { SettingLayout } from "../layout/setting-layout";
@@ -66,7 +66,7 @@ class NonInjectedAddCluster extends React.Component<Dependencies> {
return [
...this.errors,
...iter.map(this.kubeContexts.values(), ({ error }) => error),
].filter(Boolean);
].filter(isDefined);
}
readonly refreshContexts = debounce(action(() => {
@@ -106,8 +106,18 @@ class NonInjectedAddCluster extends React.Component<Dependencies> {
<SettingLayout className={styles.AddClusters} data-testid="add-cluster-page">
<h2>Add Clusters from Kubeconfig</h2>
<p>
Clusters added here are <b>not</b> merged into the <code>~/.kube/config</code> file.{" "}
<a href={`${docsUrl}/catalog/add-clusters/`} rel="noreferrer" target="_blank">Read more about adding clusters</a>.
{"Clusters added here are "}
<b>not</b>
{" merged into the "}
<code>~/.kube/config</code>
{" file. "}
<a
href={`${docsUrl}/catalog/add-clusters/`}
rel="noreferrer"
target="_blank"
>
Read more about adding clusters.
</a>
</p>
<div className="flex column">
<MonacoEditor
@@ -18,9 +18,9 @@ import hotbarStoreInjectable from "../../../../common/hotbar-store.injectable";
class TestCategory extends CatalogCategory {
apiVersion = "catalog.k8slens.dev/v1alpha1";
kind = "CatalogCategory";
metadata: {
name: "Test";
icon: "question_mark";
metadata = {
name: "Test",
icon: "question_mark",
};
spec: CatalogCategorySpec = {
group: "foo.bar.bat",
@@ -32,7 +32,10 @@ class TestCategory extends CatalogCategory {
constructor(columns?: CategoryColumnRegistration[]) {
super();
this.spec.displayColumns = columns;
this.spec = {
displayColumns: columns,
...this.spec,
};
}
}
@@ -54,19 +57,19 @@ describe("Custom Category Columns", () => {
});
it("should contain a kind column if activeCategory is falsy", () => {
expect(getCategoryColumns({ activeCategory: null }).renderTableHeader.find(elem => elem.title === "Kind")).toBeTruthy();
expect(getCategoryColumns({ activeCategory: null }).renderTableHeader.find(elem => elem?.title === "Kind")).toBeTruthy();
});
it("should not contain a kind column if activeCategory is truthy", () => {
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem.title === "Kind")).toBeFalsy();
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem?.title === "Kind")).toBeFalsy();
});
it("should include the default columns if the provided category doesn't provide any", () => {
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem.title === "Source")).toBeTruthy();
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem?.title === "Source")).toBeTruthy();
});
it("should not include the default columns if the provided category provides any", () => {
expect(getCategoryColumns({ activeCategory: new TestCategory([]) }).renderTableHeader.find(elem => elem.title === "Source")).toBeFalsy();
expect(getCategoryColumns({ activeCategory: new TestCategory([]) }).renderTableHeader.find(elem => elem?.title === "Source")).toBeFalsy();
});
it("should include the displayColumns from the provided category", () => {
@@ -80,7 +83,7 @@ describe("Custom Category Columns", () => {
},
];
expect(getCategoryColumns({ activeCategory: new TestCategory(columns) }).renderTableHeader.find(elem => elem.title === "Foo")).toBeTruthy();
expect(getCategoryColumns({ activeCategory: new TestCategory(columns) }).renderTableHeader.find(elem => elem?.title === "Foo")).toBeTruthy();
});
});
@@ -117,11 +120,11 @@ describe("Custom Category Columns", () => {
});
it("should include columns from extensions that match", () => {
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem.title === "High")).toBeTruthy();
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem?.title === "High")).toBeTruthy();
});
it("should not include columns from extensions that don't match", () => {
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem.title === "High2")).toBeFalsy();
expect(getCategoryColumns({ activeCategory: new TestCategory() }).renderTableHeader.find(elem => elem?.title === "High2")).toBeFalsy();
});
});
});
@@ -20,8 +20,8 @@ describe("Custom Category Views", () => {
});
it("should order items correctly over all extensions", () => {
const component1 = (): React.ReactElement => null;
const component2 = (): React.ReactElement => null;
const component1 = (): React.ReactNode => null;
const component2 = (): React.ReactNode => null;
di.override(rendererExtensionsInjectable, () => computed(() => [
{
@@ -51,15 +51,15 @@ describe("Custom Category Views", () => {
] as LensRendererExtension[]));
const customCategoryViews = di.inject(customCategoryViewsInjectable);
const { after } = customCategoryViews.get().get("foo").get("bar");
const { after = [] } = customCategoryViews.get().get("foo")?.get("bar") ?? {};
expect(after[0].View).toBe(component2);
expect(after[1].View).toBe(component1);
});
it("should put put priority < 50 items in before", () => {
const component1 = (): React.ReactElement => null;
const component2 = (): React.ReactElement => null;
const component1 = (): React.ReactNode => null;
const component2 = (): React.ReactNode => null;
di.override(rendererExtensionsInjectable, () => computed(() => [
{
@@ -89,7 +89,7 @@ describe("Custom Category Views", () => {
] as LensRendererExtension[]));
const customCategoryViews = di.inject(customCategoryViewsInjectable);
const { before } = customCategoryViews.get().get("foo").get("bar");
const { before = [] } = customCategoryViews.get().get("foo")?.get("bar") ?? {};
expect(before[0].View).toBe(component1);
});
@@ -114,18 +114,20 @@ export class CatalogAddButton extends React.Component<CatalogAddButtonProps> {
onClick={this.onButtonClick}
>
{this.items.map((menuItem, index) => {
return <SpeedDialAction
key={index}
icon={<Icon material={menuItem.icon}/>}
tooltipTitle={menuItem.title}
onClick={(evt) => {
evt.stopPropagation();
menuItem.onClick();
}}
TooltipClasses={{
popper: "catalogSpeedDialPopper",
}}
/>;
return (
<SpeedDialAction
key={index}
icon={<Icon material={menuItem.icon}/>}
tooltipTitle={menuItem.title}
onClick={(evt) => {
evt.stopPropagation();
menuItem.onClick();
}}
TooltipClasses={{
popper: "catalogSpeedDialPopper",
}}
/>
);
})}
</SpeedDial>
);
@@ -36,7 +36,7 @@ export class CatalogEntityDetails<T extends CatalogEntity> extends Component<Cat
const { onRun, hideDetails } = this.props;
const detailItems = CatalogEntityDetailRegistry.getInstance().getItemsForKind(entity.kind, entity.apiVersion);
const details = detailItems.map(({ components }, index) => <components.Details entity={entity} key={index} />);
const showDefaultDetails = detailItems.find((item) => item.priority > 999) === undefined;
const showDefaultDetails = detailItems.find((item) => item.priority ?? 50 > 999) === undefined;
return (
<>
@@ -7,9 +7,9 @@ import React from "react";
import { cssNames } from "../../utils";
import type { MenuActionsProps } from "../menu/menu-actions";
import { MenuActions } from "../menu/menu-actions";
import type { CatalogEntity, CatalogEntityContextMenu, CatalogEntityContextMenuContext } from "../../api/catalog-entity";
import type { CatalogEntity, CatalogEntityContextMenu } from "../../api/catalog-entity";
import { observer } from "mobx-react";
import { makeObservable, observable } from "mobx";
import { observable } from "mobx";
import { navigate } from "../../navigation";
import { MenuItem } from "../menu";
import { ConfirmDialog } from "../confirm-dialog";
@@ -22,19 +22,13 @@ export interface CatalogEntityDrawerMenuProps<T extends CatalogEntity> extends M
@observer
export class CatalogEntityDrawerMenu<T extends CatalogEntity> extends React.Component<CatalogEntityDrawerMenuProps<T>> {
@observable private contextMenu: CatalogEntityContextMenuContext;
constructor(props: CatalogEntityDrawerMenuProps<T>) {
super(props);
makeObservable(this);
}
private readonly menuItems = observable.array<CatalogEntityContextMenu>();
componentDidMount() {
this.contextMenu = {
menuItems: [],
navigate: (url: string) => navigate(url),
};
this.props.entity?.onContextMenuOpen(this.contextMenu);
this.props.entity?.onContextMenuOpen({
menuItems: this.menuItems,
navigate: (url) => navigate(url),
});
}
onMenuItemClick(menuItem: CatalogEntityContextMenu) {
@@ -61,7 +55,7 @@ export class CatalogEntityDrawerMenu<T extends CatalogEntity> extends React.Comp
const items: React.ReactChild[] = [];
for (const menuItem of this.contextMenu.menuItems) {
for (const menuItem of this.menuItems) {
if (!menuItem.icon) {
continue;
}
@@ -83,8 +77,22 @@ export class CatalogEntityDrawerMenu<T extends CatalogEntity> extends React.Comp
<HotbarToggleMenuItem
key="hotbar-toggle"
entity={entity}
addContent={<Icon material="push_pin" interactive small tooltip="Add to Hotbar"/>}
removeContent={<Icon svg="push_off" interactive small tooltip="Remove from Hotbar"/>}
addContent={(
<Icon
material="push_pin"
interactive
small
tooltip="Add to Hotbar"
/>
)}
removeContent={(
<Icon
svg="push_off"
interactive
small
tooltip="Remove from Hotbar"
/>
)}
/>,
);
@@ -94,7 +102,7 @@ export class CatalogEntityDrawerMenu<T extends CatalogEntity> extends React.Comp
render() {
const { className, entity, ...menuProps } = this.props;
if (!this.contextMenu || !entity.isEnabled()) {
if (!this.menuItems.length || !entity.isEnabled()) {
return null;
}
@@ -3,13 +3,13 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import { CatalogEntityStore } from "./catalog-entity.store";
import { catalogEntityStore } from "./catalog-entity.store";
import catalogEntityRegistryInjectable from "../../../api/catalog-entity-registry/catalog-entity-registry.injectable";
const catalogEntityStoreInjectable = getInjectable({
id: "catalog-entity-store",
instantiate: (di) => new CatalogEntityStore({
instantiate: (di) => catalogEntityStore({
registry: di.inject(catalogEntityRegistryInjectable),
}),
});
@@ -3,61 +3,78 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { computed, makeObservable, observable, reaction } from "mobx";
import type { IComputedValue, IObservableValue } from "mobx";
import { computed, observable, reaction } from "mobx";
import type { CatalogEntityRegistry } from "../../../api/catalog-entity-registry";
import type { CatalogEntity } from "../../../api/catalog-entity";
import { ItemStore } from "../../../../common/item.store";
import type { CatalogCategory } from "../../../../common/catalog";
import { catalogCategoryRegistry } from "../../../../common/catalog";
import { autoBind, disposer } from "../../../../common/utils";
import type { Disposer } from "../../../../common/utils";
import { disposer } from "../../../../common/utils";
import type { ItemListStore } from "../../item-object-list";
interface Dependencies {
registry: CatalogEntityRegistry;
}
export class CatalogEntityStore extends ItemStore<CatalogEntity> {
constructor(private dependencies: Dependencies) {
super();
makeObservable(this);
autoBind(this);
}
export type CatalogEntityStore = ItemListStore<CatalogEntity, false> & {
readonly entities: IComputedValue<CatalogEntity[]>;
readonly activeCategory: IObservableValue<CatalogCategory | undefined>;
readonly selectedItemId: IObservableValue<string | undefined>;
readonly selectedItem: IComputedValue<CatalogEntity | undefined>;
watch(): Disposer;
onRun(entity: CatalogEntity): void;
};
@observable activeCategory?: CatalogCategory;
@observable selectedItemId?: string;
export function catalogEntityStore({ registry }: Dependencies): CatalogEntityStore {
const activeCategory = observable.box<CatalogCategory | undefined>(undefined);
const selectedItemId = observable.box<string | undefined>(undefined);
const entities = computed(() => {
const category = activeCategory.get();
@computed get entities() {
if (!this.activeCategory) {
return this.dependencies.registry.filteredItems;
return category
? registry.getItemsForCategory(category, { filtered: true })
: registry.filteredItems;
});
const selectedItem = computed(() => {
const id = selectedItemId.get();
if (!id) {
return undefined;
}
return this.dependencies.registry.getItemsForCategory(this.activeCategory, { filtered: true });
}
return entities.get().find(entity => entity.getId() === id);
});
const loadAll = () => {
const category = activeCategory.get();
@computed get selectedItem() {
return this.entities.find(e => e.getId() === this.selectedItemId);
}
watch() {
return disposer(
reaction(() => this.entities, () => this.loadAll()),
reaction(() => this.activeCategory, () => this.loadAll(), { delay: 100 }),
);
}
loadAll() {
if (this.activeCategory) {
this.activeCategory.emit("load");
if (category) {
category.emit("load");
} else {
for (const category of catalogCategoryRegistry.items) {
category.emit("load");
}
}
};
// concurrency is true to fix bug if catalog filter is removed and added at the same time
return this.loadItems(() => this.entities, undefined, true);
}
onRun(entity: CatalogEntity): void {
this.dependencies.registry.onRun(entity);
}
return {
entities,
selectedItem,
activeCategory,
selectedItemId,
watch: () => disposer(
reaction(() => entities.get(), loadAll),
reaction(() => activeCategory.get(), loadAll, { delay: 100 }),
),
onRun: entity => registry.onRun(entity),
failedLoading: false,
getTotalCount: () => registry.filteredItems.length,
isLoaded: true,
isSelected: (item) => item.getId() === selectedItemId.get(),
isSelectedAll: () => false,
pickOnlySelected: () => [],
toggleSelection: () => {},
toggleSelectionAll: () => {},
removeSelectedItems: async () => {},
};
}
@@ -18,7 +18,7 @@ import { observer } from "mobx-react";
import { CatalogCategoryLabel } from "./catalog-category-label";
export interface CatalogMenuProps {
activeItem: string;
activeTab: string | undefined;
onItemClick: (id: string) => void;
}
@@ -54,9 +54,14 @@ export const CatalogMenu = observer((props: CatalogMenuProps) => {
defaultExpanded={["catalog"]}
defaultCollapseIcon={<Icon material="expand_more"/>}
defaultExpandIcon={<Icon material="chevron_right" />}
selected={props.activeItem || "browse"}
selected={props.activeTab || "browse"}
>
<Item nodeId="browse" label="Browse" data-testid="*-tab" onClick={() => props.onItemClick("*")}/>
<Item
nodeId="browse"
label="Browse"
data-testid="*-tab"
onClick={() => props.onItemClick("*")}
/>
<Item
nodeId="catalog"
label={<div className={styles.parent}>Categories</div>}
@@ -27,6 +27,7 @@ import getConfigurationFileModelInjectable from "../../../common/get-configurati
import appVersionInjectable from "../../../common/get-configuration-file-model/app-version/app-version.injectable";
import type { AppEvent } from "../../../common/app-event-bus/event-bus";
import appEventBusInjectable from "../../../common/app-event-bus/app-event-bus.injectable";
import { computed } from "mobx";
mockWindow();
jest.mock("electron", () => ({
@@ -86,6 +87,8 @@ describe("<Catalog />", () => {
let catalogEntityStore: CatalogEntityStore;
let catalogEntityRegistry: CatalogEntityRegistry;
let emitEvent: (event: AppEvent) => void;
let onRun: jest.MockedFunction<(context: CatalogEntityActionContext) => void | Promise<void>>;
let catalogEntityItem: MockCatalogEntity;
let render: DiRender;
beforeEach(async () => {
@@ -105,6 +108,8 @@ describe("<Catalog />", () => {
CatalogEntityDetailRegistry.createInstance();
render = renderFor(di);
onRun = jest.fn();
catalogEntityItem = createMockCatalogEntity(onRun);
const catalogCategoryRegistry = new CatalogCategoryRegistry();
@@ -119,6 +124,9 @@ describe("<Catalog />", () => {
}));
catalogEntityStore = di.inject(catalogEntityStoreInjectable);
jest
.spyOn(catalogEntityStore, "selectedItem", "get")
.mockImplementation(() => computed(() => catalogEntityItem));
});
afterEach(() => {
@@ -132,14 +140,6 @@ describe("<Catalog />", () => {
});
it("can use catalogEntityRegistry.addOnBeforeRun to add hooks for catalog entities", (done) => {
const onRun = jest.fn();
const catalogEntityItem = createMockCatalogEntity(onRun);
// mock as if there is a selected item > the detail panel opens
jest
.spyOn(catalogEntityStore, "selectedItem", "get")
.mockImplementation(() => catalogEntityItem);
catalogEntityRegistry.addOnBeforeRun(
(event) => {
expect(event.target.getId()).toBe("a_catalogEntity_uid");
@@ -160,14 +160,6 @@ describe("<Catalog />", () => {
});
it("onBeforeRun prevents event => onRun wont be triggered", (done) => {
const onRun = jest.fn();
const catalogEntityItem = createMockCatalogEntity(onRun);
// mock as if there is a selected item > the detail panel opens
jest
.spyOn(catalogEntityStore, "selectedItem", "get")
.mockImplementation(() => catalogEntityItem);
catalogEntityRegistry.addOnBeforeRun(
(e) => {
setTimeout(() => {
@@ -184,14 +176,6 @@ describe("<Catalog />", () => {
});
it("addOnBeforeRun throw an exception => onRun will be triggered", (done) => {
const onRun = jest.fn();
const catalogEntityItem = createMockCatalogEntity(onRun);
// mock as if there is a selected item > the detail panel opens
jest
.spyOn(catalogEntityStore, "selectedItem", "get")
.mockImplementation(() => catalogEntityItem);
catalogEntityRegistry.addOnBeforeRun(
() => {
setTimeout(() => {
@@ -209,13 +193,7 @@ describe("<Catalog />", () => {
});
it("addOnRunHook return a promise and does not prevent run event => onRun()", (done) => {
const onRun = jest.fn(() => done());
const catalogEntityItem = createMockCatalogEntity(onRun);
// mock as if there is a selected item > the detail panel opens
jest
.spyOn(catalogEntityStore, "selectedItem", "get")
.mockImplementation(() => catalogEntityItem);
onRun.mockImplementation(() => done());
catalogEntityRegistry.addOnBeforeRun(
async () => {
@@ -229,14 +207,6 @@ describe("<Catalog />", () => {
});
it("addOnRunHook return a promise and prevents event wont be triggered", (done) => {
const onRun = jest.fn();
const catalogEntityItem = createMockCatalogEntity(onRun);
// mock as if there is a selected item > the detail panel opens
jest
.spyOn(catalogEntityStore, "selectedItem", "get")
.mockImplementation(() => catalogEntityItem);
catalogEntityRegistry.addOnBeforeRun(
async (e) => {
expect(onRun).not.toBeCalled();
@@ -256,14 +226,6 @@ describe("<Catalog />", () => {
});
it("addOnRunHook return a promise and reject => onRun will be triggered", (done) => {
const onRun = jest.fn();
const catalogEntityItem = createMockCatalogEntity(onRun);
// mock as if there is a selected item > the detail panel opens
jest
.spyOn(catalogEntityStore, "selectedItem", "get")
.mockImplementation(() => catalogEntityItem);
catalogEntityRegistry.addOnBeforeRun(
async () => {
setTimeout(() => {
+56 -50
View File
@@ -13,9 +13,9 @@ import { action, computed, makeObservable, observable, reaction, runInAction, wh
import type { CatalogEntityStore } from "./catalog-entity-store/catalog-entity.store";
import { navigate } from "../../navigation";
import { MenuItem, MenuActions } from "../menu";
import type { CatalogEntityContextMenu, CatalogEntityContextMenuContext } from "../../api/catalog-entity";
import type { CatalogEntityContextMenu } from "../../api/catalog-entity";
import { ConfirmDialog } from "../confirm-dialog";
import type { CatalogEntity } from "../../../common/catalog";
import type { CatalogCategory, CatalogEntity } from "../../../common/catalog";
import { catalogCategoryRegistry } from "../../../common/catalog";
import { CatalogAddButton } from "./catalog-add-button";
import { Notifications } from "../notifications";
@@ -62,7 +62,7 @@ interface Dependencies {
@observer
class NonInjectedCatalog extends React.Component<Dependencies> {
@observable private contextMenu: CatalogEntityContextMenuContext;
private readonly menuItems = observable.array<CatalogEntityContextMenu>();
@observable activeTab?: string;
constructor(props: Dependencies) {
@@ -91,10 +91,6 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
}
async componentDidMount() {
this.contextMenu = {
menuItems: observable.array([]),
navigate: (url: string) => navigate(url),
};
disposeOnUnmount(this, [
this.props.catalogEntityStore.watch(),
reaction(() => this.routeActiveTab, async (routeTab) => {
@@ -104,24 +100,29 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
runInAction(() => {
this.activeTab = routeTab;
this.props.catalogEntityStore.activeCategory = item;
this.props.catalogEntityStore.activeCategory.set(item);
});
} catch (error) {
console.error(error);
Notifications.error(<p>Unknown category: {routeTab}</p>);
Notifications.error((
<p>
{"Unknown category: "}
{routeTab}
</p>
));
}
}, { fireImmediately: true }),
]);
// If active category is filtered out, automatically switch to the first category
disposeOnUnmount(this, reaction(() => catalogCategoryRegistry.filteredItems, () => {
if (!catalogCategoryRegistry.filteredItems.find(item => item.getId() === this.props.catalogEntityStore.activeCategory.getId())) {
if (!catalogCategoryRegistry.filteredItems.find(item => item.getId() === this.props.catalogEntityStore.activeCategory.get()?.getId())) {
const item = catalogCategoryRegistry.filteredItems[0];
runInAction(() => {
if (item) {
this.activeTab = item.getId();
this.props.catalogEntityStore.activeCategory = item;
this.props.catalogEntityStore.activeCategory.set(item);
}
});
}
@@ -143,7 +144,7 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
onDetails = (entity: CatalogEntity) => {
if (this.props.catalogEntityStore.selectedItemId) {
this.props.catalogEntityStore.selectedItemId = null;
this.props.catalogEntityStore.selectedItemId.set(undefined);
} else {
this.props.catalogEntityStore.onRun(entity);
}
@@ -190,26 +191,25 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
}
});
renderNavigation() {
return (
<CatalogMenu activeItem={this.activeTab} onItemClick={this.onTabChange} />
);
}
renderItemMenu = (entity: CatalogEntity) => {
const onOpen = () => {
this.contextMenu.menuItems = [];
entity.onContextMenuOpen(this.contextMenu);
this.menuItems.clear();
entity.onContextMenuOpen({
menuItems: this.menuItems,
navigate: (url) => navigate(url),
});
};
return (
<MenuActions onOpen={onOpen}>
<MenuItem key="open-details" onClick={() => this.props.catalogEntityStore.selectedItemId = entity.getId()}>
<MenuItem
key="open-details"
onClick={() => this.props.catalogEntityStore.selectedItemId.set(entity.getId())}
>
View Details
</MenuItem>
{
this.contextMenu.menuItems.map((menuItem, index) => (
this.menuItems.map((menuItem, index) => (
<MenuItem key={index} onClick={() => this.onMenuItemClick(menuItem)}>
{menuItem.title}
</MenuItem>
@@ -244,7 +244,6 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
<Icon
small
className={styles.pinIcon}
material={!isItemInHotbar && "push_pin"}
svg={isItemInHotbar ? "push_off" : "push_pin"}
tooltip={isItemInHotbar ? "Remove from Hotbar" : "Add to Hotbar"}
onClick={prevDefault(() => isItemInHotbar ? this.removeFromHotbar(entity) : this.addToHotbar(entity))}
@@ -253,15 +252,12 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
);
}
renderViews = () => {
const { catalogEntityStore, customCategoryViews } = this.props;
const { activeCategory } = catalogEntityStore;
renderViews = (activeCategory: CatalogCategory | undefined) => {
if (!activeCategory) {
return this.renderList();
return this.renderList(activeCategory);
}
const customViews = customCategoryViews.get()
const customViews = this.props.customCategoryViews.get()
.get(activeCategory.spec.group)
?.get(activeCategory.spec.names.kind);
const renderView = ({ View }: CustomCategoryViewComponents, index: number) => (
@@ -274,15 +270,14 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
return (
<>
{customViews?.before.map(renderView)}
{this.renderList()}
{this.renderList(activeCategory)}
{customViews?.after.map(renderView)}
</>
);
};
renderList() {
renderList(activeCategory: CatalogCategory | undefined) {
const { catalogEntityStore, getCategoryColumns } = this.props;
const { activeCategory } = catalogEntityStore;
const tableId = activeCategory
? `catalog-items-${activeCategory.metadata.name.replace(" ", "")}`
: "catalog-items";
@@ -292,14 +287,15 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
}
return (
<ItemListLayout
<ItemListLayout<CatalogEntity, false>
className={styles.Catalog}
tableId={tableId}
renderHeaderTitle={activeCategory?.metadata.name ?? "Browse All"}
isSelectable={false}
isConfigurable={true}
preloadStores={false}
store={catalogEntityStore}
getItems={() => catalogEntityStore.entities}
getItems={() => catalogEntityStore.entities.get()}
customizeTableRowProps={entity => ({
disabled: !entity.isEnabled(),
})}
@@ -315,27 +311,37 @@ class NonInjectedCatalog extends React.Component<Dependencies> {
return null;
}
const selectedEntity = this.props.catalogEntityStore.selectedItem;
const activeCategory = this.props.catalogEntityStore.activeCategory.get();
const selectedItem = this.props.catalogEntityStore.selectedItem.get();
return (
<MainLayout sidebar={this.renderNavigation()}>
<MainLayout
sidebar={(
<CatalogMenu
activeTab={this.activeTab}
onItemClick={this.onTabChange}
/>
)}
>
<div className={styles.views}>
{this.renderViews()}
{this.renderViews(activeCategory)}
</div>
{
selectedEntity
? <CatalogEntityDetails
entity={selectedEntity}
hideDetails={() => this.props.catalogEntityStore.selectedItemId = null}
onRun={() => this.props.catalogEntityStore.onRun(selectedEntity)}
/>
: (
<RenderDelay>
<CatalogAddButton
category={this.props.catalogEntityStore.activeCategory}
/>
</RenderDelay>
selectedItem
? (
<CatalogEntityDetails
entity={selectedItem}
hideDetails={() => this.props.catalogEntityStore.selectedItemId.set(undefined)}
onRun={() => this.props.catalogEntityStore.onRun(selectedItem)}
/>
)
: activeCategory
? (
<RenderDelay>
<CatalogAddButton category={activeCategory} />
</RenderDelay>
)
: null
}
</MainLayout>
);
@@ -31,15 +31,17 @@ function NonInjectedHotbarToggleMenuItem({
const [itemInHotbar, setItemInHotbar] = useState(hotbarStore.isAddedToActive(entity));
return (
<MenuItem onClick={() => {
if (itemInHotbar) {
hotbarStore.removeFromHotbar(entity.getId());
setItemInHotbar(false);
} else {
hotbarStore.addToHotbar(entity);
setItemInHotbar(true);
}
}}>
<MenuItem
onClick={() => {
if (itemInHotbar) {
hotbarStore.removeFromHotbar(entity.getId());
setItemInHotbar(false);
} else {
hotbarStore.addToHotbar(entity);
setItemInHotbar(true);
}
}}
>
{itemInHotbar ? removeContent : addContent }
</MenuItem>
);
@@ -37,7 +37,6 @@ const renderEntityName = (hotbarStore: HotbarStore) => (entity: CatalogEntity) =
<Icon
small
className={styles.pinIcon}
material={!isItemInHotbar && "push_pin"}
svg={isItemInHotbar ? "push_off" : "push_pin"}
tooltip={isItemInHotbar ? "Remove from Hotbar" : "Add to Hotbar"}
onClick={onClick}
@@ -25,9 +25,9 @@ export interface ClusterIssuesProps {
className?: string;
}
interface IWarning extends ItemObject {
interface Warning extends ItemObject {
kind: string;
message: string;
message: string | undefined;
selfLink: string;
renderAge: () => React.ReactElement;
ageMs: number;
@@ -46,7 +46,7 @@ export class ClusterIssues extends React.Component<ClusterIssuesProps> {
makeObservable(this);
}
@computed get warnings(): IWarning[] {
@computed get warnings(): Warning[] {
return [
...nodesStore.items.flatMap(node => (
node.getWarningConditions()
@@ -75,6 +75,11 @@ export class ClusterIssues extends React.Component<ClusterIssuesProps> {
getTableRow = (uid: string) => {
const { warnings } = this;
const warning = warnings.find(warn => warn.getId() == uid);
if (!warning) {
return undefined;
}
const { getId, getName, message, kind, selfLink, renderAge } = warning;
return (
@@ -85,7 +90,7 @@ export class ClusterIssues extends React.Component<ClusterIssuesProps> {
onClick={prevDefault(() => toggleDetails(selfLink))}
>
<TableCell className={styles.message}>
{message}
{message ?? "<unknown>"}
</TableCell>
<TableCell className={styles.object}>
{getName()}
@@ -112,7 +117,12 @@ export class ClusterIssues extends React.Component<ClusterIssuesProps> {
if (!warnings.length) {
return (
<div className={cssNames(styles.noIssues, "flex column box grow gaps align-center justify-center")}>
<Icon className={styles.Icon} material="check" big sticker/>
<Icon
className={styles.Icon}
material="check"
big
sticker
/>
<p className={styles.title}>No issues found</p>
<p>Everything is fine in the Cluster</p>
</div>
@@ -122,7 +132,8 @@ export class ClusterIssues extends React.Component<ClusterIssuesProps> {
return (
<>
<SubHeader className={styles.SubHeader}>
<Icon material="error_outline"/> Warnings: {warnings.length}
<Icon material="error_outline"/>
{` Warnings: ${warnings.length}`}
</SubHeader>
<Table
tableId="cluster_issues"
@@ -30,7 +30,7 @@ const NonInjectedClusterMetricSwitchers = observer(({ clusterOverviewStore }: De
asButtons
className={cssNames("RadioGroup flex gaps", { disabled: disableRoles })}
value={clusterOverviewStore.metricNodeRole}
onChange={(metric: MetricNodeRole) => clusterOverviewStore.metricNodeRole = metric}
onChange={metric => clusterOverviewStore.metricNodeRole = metric}
>
<Radio label="Master" value={MetricNodeRole.MASTER}/>
<Radio label="Worker" value={MetricNodeRole.WORKER}/>
@@ -41,7 +41,7 @@ const NonInjectedClusterMetricSwitchers = observer(({ clusterOverviewStore }: De
asButtons
className={cssNames("RadioGroup flex gaps", { disabled: disableMetrics })}
value={clusterOverviewStore.metricType}
onChange={(value: MetricType) => clusterOverviewStore.metricType = value}
onChange={value => clusterOverviewStore.metricType = value}
>
<Radio label="CPU" value={MetricType.CPU}/>
<Radio label="Memory" value={MetricType.MEMORY}/>
@@ -5,7 +5,7 @@
import styles from "./cluster-metrics.module.scss";
import React from "react";
import React, { useState } from "react";
import { observer } from "mobx-react";
import type { ChartOptions, ChartPoint } from "chart.js";
import type { ClusterOverviewStore } from "./cluster-overview-store/cluster-overview-store";
@@ -13,19 +13,19 @@ import { MetricType } from "./cluster-overview-store/cluster-overview-store";
import { BarChart } from "../chart";
import { bytesToUnits, cssNames } from "../../utils";
import { Spinner } from "../spinner";
import { ZebraStripes } from "../chart/zebra-stripes.plugin";
import { ZebraStripesPlugin } from "../chart/zebra-stripes.plugin";
import { ClusterNoMetrics } from "./cluster-no-metrics";
import { ClusterMetricSwitchers } from "./cluster-metric-switchers";
import { getMetricLastPoints } from "../../../common/k8s-api/endpoints/metrics.api";
import { withInjectables } from "@ogre-tools/injectable-react";
import clusterOverviewStoreInjectable
from "./cluster-overview-store/cluster-overview-store.injectable";
import clusterOverviewStoreInjectable from "./cluster-overview-store/cluster-overview-store.injectable";
interface Dependencies {
clusterOverviewStore: ClusterOverviewStore;
}
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 colors = { cpu: "#3D90CE", memory: "#C93DCE" };
@@ -52,9 +52,13 @@ const NonInjectedClusterMetrics = observer(({ clusterOverviewStore: { metricType
tooltips: {
callbacks: {
label: ({ index }, data) => {
const value = data.datasets[0].data[index] as ChartPoint;
if (!index) {
return "<unknown>";
}
return value.y.toString();
const value = data.datasets?.[0].data?.[index] as ChartPoint;
return value.y?.toString() ?? "<unknown>";
},
},
},
@@ -71,7 +75,11 @@ const NonInjectedClusterMetrics = observer(({ clusterOverviewStore: { metricType
tooltips: {
callbacks: {
label: ({ index }, data) => {
const value = data.datasets[0].data[index] as ChartPoint;
if (!index) {
return "<unknown>";
}
const value = data.datasets?.[0].data?.[index] as ChartPoint;
return bytesToUnits(parseInt(value.y as string), { precision: 3 });
},
@@ -96,7 +104,7 @@ const NonInjectedClusterMetrics = observer(({ clusterOverviewStore: { metricType
data={{ datasets }}
timeLabelStep={5}
showLegend={false}
plugins={[ZebraStripes]}
plugins={plugins}
className={styles.chart}
/>
);
@@ -12,6 +12,7 @@ import {
} from "./cluster-overview-store";
import createStorageInjectable from "../../../utils/create-storage/create-storage.injectable";
import apiManagerInjectable from "../../kube-object-menu/dependencies/api-manager.injectable";
import { clusterApi } from "../../../../common/k8s-api/endpoints";
const clusterOverviewStoreInjectable = getInjectable({
id: "cluster-overview-store",
@@ -29,7 +30,7 @@ const clusterOverviewStoreInjectable = getInjectable({
const store = new ClusterOverviewStore({
storage,
});
}, clusterApi);
const apiManager = di.inject(apiManagerInjectable);
@@ -5,8 +5,8 @@
import { action, observable, reaction, when, makeObservable } from "mobx";
import { KubeObjectStore } from "../../../../common/k8s-api/kube-object.store";
import type { Cluster } from "../../../../common/k8s-api/endpoints";
import { clusterApi, getMetricsByNodeNames, type IClusterMetrics } from "../../../../common/k8s-api/endpoints";
import type { Cluster, ClusterApi } from "../../../../common/k8s-api/endpoints";
import { getMetricsByNodeNames, type ClusterMetricData } from "../../../../common/k8s-api/endpoints";
import type { StorageHelper } from "../../../utils";
import { autoBind } from "../../../utils";
import { type IMetricsReqParams, normalizeMetrics } from "../../../../common/k8s-api/endpoints/metrics.api";
@@ -31,10 +31,8 @@ interface Dependencies {
storage: StorageHelper<ClusterOverviewStorageState>;
}
export class ClusterOverviewStore extends KubeObjectStore<Cluster> implements ClusterOverviewStorageState {
api = clusterApi;
@observable metrics: Partial<IClusterMetrics> = {};
export class ClusterOverviewStore extends KubeObjectStore<Cluster, ClusterApi> implements ClusterOverviewStorageState {
@observable metrics: Partial<ClusterMetricData> = {};
@observable metricsLoaded = false;
get metricType(): MetricType {
@@ -53,8 +51,8 @@ export class ClusterOverviewStore extends KubeObjectStore<Cluster> implements Cl
this.dependencies.storage.merge({ metricNodeRole: value });
}
constructor(private dependencies: Dependencies ) {
super();
constructor(protected readonly dependencies: Dependencies, api: ClusterApi) {
super(api);
makeObservable(this);
autoBind(this);
@@ -89,7 +87,7 @@ export class ClusterOverviewStore extends KubeObjectStore<Cluster> implements Cl
this.metricsLoaded = true;
}
getMetricsValues(source: Partial<IClusterMetrics>): [number, string][] {
getMetricsValues(source: Partial<ClusterMetricData>): [number, string][] {
switch (this.metricType) {
case MetricType.CPU:
return normalizeMetrics(source.cpuUsage).data.result[0].values;
@@ -10,9 +10,8 @@ import { reaction } from "mobx";
import { disposeOnUnmount, observer } from "mobx-react";
import { nodesStore } from "../+nodes/nodes.store";
import { podsStore } from "../+workloads-pods/pods.store";
import type { Disposer } from "../../utils";
import { getHostedClusterId, interval } from "../../utils";
import { TabLayout } from "../layout/tab-layout-2";
import { interval } from "../../utils";
import { TabLayout } from "../layout/tab-layout";
import { Spinner } from "../spinner";
import { ClusterIssues } from "./cluster-issues";
import { ClusterMetrics } from "./cluster-metrics";
@@ -20,17 +19,19 @@ import type { ClusterOverviewStore } from "./cluster-overview-store/cluster-over
import { ClusterPieCharts } from "./cluster-pie-charts";
import { getActiveClusterEntity } from "../../api/catalog-entity-registry";
import { ClusterMetricsResourceType } from "../../../common/cluster-types";
import { ClusterStore } from "../../../common/cluster-store/cluster-store";
import { eventStore } from "../+events/event.store";
import { withInjectables } from "@ogre-tools/injectable-react";
import kubeWatchApiInjectable from "../../kube-watch-api/kube-watch-api.injectable";
import type { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
import clusterOverviewStoreInjectable from "./cluster-overview-store/cluster-overview-store.injectable";
import type { SubscribeStores } from "../../kube-watch-api/kube-watch-api";
import type { Cluster } from "../../../common/cluster/cluster";
import hostedClusterInjectable from "../../cluster/hosted-cluster.injectable";
import assert from "assert";
interface Dependencies {
subscribeStores: (stores: KubeObjectStore<KubeObject>[]) => Disposer;
subscribeStores: SubscribeStores;
clusterOverviewStore: ClusterOverviewStore;
hostedCluster: Cluster;
}
@observer
@@ -38,9 +39,7 @@ class NonInjectedClusterOverview extends React.Component<Dependencies> {
private metricPoller = interval(60, () => this.loadMetrics());
loadMetrics() {
const cluster = ClusterStore.getInstance().getById(getHostedClusterId());
if (cluster.available) {
if (this.props.hostedCluster.available) {
this.props.clusterOverviewStore.loadMetrics();
}
}
@@ -66,7 +65,7 @@ class NonInjectedClusterOverview extends React.Component<Dependencies> {
this.metricPoller.stop();
}
renderMetrics(isMetricsHidden: boolean) {
renderMetrics(isMetricsHidden?: boolean) {
if (isMetricsHidden) {
return null;
}
@@ -79,7 +78,7 @@ class NonInjectedClusterOverview extends React.Component<Dependencies> {
);
}
renderClusterOverview(isLoaded: boolean, isMetricsHidden: boolean) {
renderClusterOverview(isLoaded: boolean, isMetricsHidden?: boolean) {
if (!isLoaded) {
return <Spinner center/>;
}
@@ -106,13 +105,16 @@ class NonInjectedClusterOverview extends React.Component<Dependencies> {
}
}
export const ClusterOverview = withInjectables<Dependencies>(
NonInjectedClusterOverview,
export const ClusterOverview = withInjectables<Dependencies>(NonInjectedClusterOverview, {
getProps: (di) => {
const hostedCluster = di.inject(hostedClusterInjectable);
{
getProps: (di) => ({
assert(hostedCluster, "Only allowed to renderer ClusterOverview within cluster frame");
return {
subscribeStores: di.inject(kubeWatchApiInjectable).subscribeStores,
clusterOverviewStore: di.inject(clusterOverviewStoreInjectable),
}),
hostedCluster,
};
},
);
});
@@ -12,7 +12,7 @@ import { DrawerItem, DrawerTitle } from "../drawer";
import { Badge } from "../badge";
import type { KubeObjectDetailsProps } from "../kube-object-details";
import { cssNames } from "../../utils";
import type { IHpaMetric } from "../../../common/k8s-api/endpoints/hpa.api";
import type { HorizontalPodAutoscalerMetricSpec, HorizontalPodAutoscalerMetricTarget } from "../../../common/k8s-api/endpoints/hpa.api";
import { HorizontalPodAutoscaler, HpaMetricType } from "../../../common/k8s-api/endpoints/hpa.api";
import { Table, TableCell, TableHead, TableRow } from "../table";
import { apiManager } from "../../../common/k8s-api/api-manager";
@@ -25,38 +25,75 @@ export interface HpaDetailsProps extends KubeObjectDetailsProps<HorizontalPodAut
@observer
export class HpaDetails extends React.Component<HpaDetailsProps> {
private renderTargetLink(target: HorizontalPodAutoscalerMetricTarget | undefined) {
if (!target) {
return null;
}
const { object: hpa } = this.props;
const { kind, name } = target;
const objectUrl = getDetailsUrl(apiManager.lookupApiLink(target, hpa));
return (
<>
on
<Link to={objectUrl}>
{`${kind}/${name}`}
</Link>
</>
);
}
renderMetrics() {
const { object: hpa } = this.props;
const renderName = (metric: IHpaMetric) => {
const renderName = (metric: HorizontalPodAutoscalerMetricSpec) => {
switch (metric.type) {
case HpaMetricType.ContainerResource:
// fallthrough
case HpaMetricType.Resource: {
const addition = metric.resource.targetAverageUtilization
const metricSpec = metric.resource ?? metric.containerResource;
const addition = metricSpec.targetAverageUtilization
? "(as a percentage of request)"
: "";
return <>Resource {metric.resource.name} on Pods {addition}</>;
}
case HpaMetricType.Pods:
return <>{metric.pods.metricName} on Pods</>;
case HpaMetricType.Object: {
const { target } = metric.object;
const { kind, name } = target;
const objectUrl = getDetailsUrl(apiManager.lookupApiLink(target, hpa));
return (
<>
{metric.object.metricName} on{" "}
<Link to={objectUrl}>{kind}/{name}</Link>
Resource
{metricSpec.name}
{" "}
on Pods
{addition}
</>
);
}
case HpaMetricType.Pods:
return (
<>
{metric.pods.metricName}
{" "}
on Pods
</>
);
case HpaMetricType.Object: {
return (
<>
{metric.object.metricName}
{" "}
{this.renderTargetLink(metric.object.target)}
</>
);
}
case HpaMetricType.External:
return (
<>
{metric.external.metricName} on{" "}
{JSON.stringify(metric.external.selector)}
{metric.external.metricName}
{" "}
on
{" "}
{JSON.stringify(metric.external.metricSelector)}
</>
);
}
@@ -103,7 +140,9 @@ export class HpaDetails extends React.Component<HpaDetailsProps> {
<DrawerItem name="Reference">
{scaleTargetRef && (
<Link to={getDetailsUrl(apiManager.lookupApiLink(scaleTargetRef, hpa))}>
{scaleTargetRef.kind}/{scaleTargetRef.name}
{scaleTargetRef.kind}
/
{scaleTargetRef.name}
</Link>
)}
</DrawerItem>
@@ -120,19 +159,20 @@ export class HpaDetails extends React.Component<HpaDetailsProps> {
{hpa.getReplicas()}
</DrawerItem>
<DrawerItem name="Status" className="status" labelsOnly>
{hpa.getConditions().map(({ type, tooltip, isReady }) => {
if (!isReady) return null;
return (
<DrawerItem
name="Status"
className="status"
labelsOnly
>
{hpa.getReadyConditions()
.map(({ type, tooltip, isReady }) => (
<Badge
key={type}
label={type}
tooltip={tooltip}
className={cssNames({ [type.toLowerCase()]: isReady })}
/>
);
})}
))}
</DrawerItem>
<DrawerTitle>Metrics</DrawerTitle>
@@ -4,13 +4,18 @@
*/
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { HorizontalPodAutoscaler } from "../../../common/k8s-api/endpoints/hpa.api";
import { hpaApi } from "../../../common/k8s-api/endpoints/hpa.api";
import type { HorizontalPodAutoscaler, HorizontalPodAutoscalerApi } from "../../../common/k8s-api/endpoints/hpa.api";
import { horizontalPodAutoscalerApi } from "../../../common/k8s-api/endpoints/hpa.api";
import { apiManager } from "../../../common/k8s-api/api-manager";
import { isClusterPageContext } from "../../utils";
export class HPAStore extends KubeObjectStore<HorizontalPodAutoscaler> {
api = hpaApi;
export class HorizontalPodAutoscalerStore extends KubeObjectStore<HorizontalPodAutoscaler, HorizontalPodAutoscalerApi> {
}
export const hpaStore = new HPAStore();
apiManager.registerStore(hpaStore);
export const hpaStore = isClusterPageContext()
? new HorizontalPodAutoscalerStore(horizontalPodAutoscalerApi)
: undefined as never;
if (isClusterPageContext()) {
apiManager.registerStore(hpaStore);
}
@@ -38,7 +38,13 @@ export class HorizontalPodAutoscalers extends React.Component {
const metricsRemain = metrics.length > 1 ? `+${metrics.length - 1} more...` : "";
return <p>{hpa.getMetricValues(metrics[0])} {metricsRemain}</p>;
return (
<p>
{hpa.getMetricValues(metrics[0])}
{" "}
{metricsRemain}
</p>
);
}
render() {
@@ -75,27 +75,27 @@ export class LimitRangeDetails extends React.Component<LimitRangeDetailsProps> {
<div className="LimitRangeDetails">
<KubeObjectMeta object={limitRange}/>
{containerLimits.length > 0 &&
<DrawerItem name="Container Limits" labelsOnly>
{
renderLimitDetails(containerLimits, [Resource.CPU, Resource.MEMORY, Resource.EPHEMERAL_STORAGE])
}
</DrawerItem>
}
{podLimits.length > 0 &&
<DrawerItem name="Pod Limits" labelsOnly>
{
renderLimitDetails(podLimits, [Resource.CPU, Resource.MEMORY, Resource.EPHEMERAL_STORAGE])
}
</DrawerItem>
}
{pvcLimits.length > 0 &&
<DrawerItem name="Persistent Volume Claim Limits" labelsOnly>
{
renderLimitDetails(pvcLimits, [Resource.STORAGE])
}
</DrawerItem>
}
{containerLimits.length > 0 && (
<DrawerItem name="Container Limits" labelsOnly>
{
renderLimitDetails(containerLimits, [Resource.CPU, Resource.MEMORY, Resource.EPHEMERAL_STORAGE])
}
</DrawerItem>
)}
{podLimits.length > 0 && (
<DrawerItem name="Pod Limits" labelsOnly>
{
renderLimitDetails(podLimits, [Resource.CPU, Resource.MEMORY, Resource.EPHEMERAL_STORAGE])
}
</DrawerItem>
)}
{pvcLimits.length > 0 && (
<DrawerItem name="Persistent Volume Claim Limits" labelsOnly>
{
renderLimitDetails(pvcLimits, [Resource.STORAGE])
}
</DrawerItem>
)}
</div>
);
}
@@ -5,12 +5,17 @@
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import { apiManager } from "../../../common/k8s-api/api-manager";
import type { LimitRange } from "../../../common/k8s-api/endpoints/limit-range.api";
import type { LimitRange, LimitRangeApi } from "../../../common/k8s-api/endpoints/limit-range.api";
import { limitRangeApi } from "../../../common/k8s-api/endpoints/limit-range.api";
import { isClusterPageContext } from "../../utils";
export class LimitRangesStore extends KubeObjectStore<LimitRange> {
api = limitRangeApi;
export class LimitRangeStore extends KubeObjectStore<LimitRange, LimitRangeApi> {
}
export const limitRangeStore = new LimitRangesStore();
apiManager.registerStore(limitRangeStore);
export const limitRangeStore = isClusterPageContext()
? new LimitRangeStore(limitRangeApi)
: undefined as never;
if (isClusterPageContext()) {
apiManager.registerStore(limitRangeStore);
}
@@ -12,7 +12,7 @@ import { DrawerTitle } from "../drawer";
import { Notifications } from "../notifications";
import { Input } from "../input";
import { Button } from "../button";
import { configMapsStore } from "./config-maps.store";
import { configMapStore } from "./config-maps.store";
import type { KubeObjectDetailsProps } from "../kube-object-details";
import { ConfigMap } from "../../../common/k8s-api/endpoints";
import { KubeObjectMeta } from "../kube-object-meta";
@@ -24,7 +24,7 @@ export interface ConfigMapDetailsProps extends KubeObjectDetailsProps<ConfigMap>
@observer
export class ConfigMapDetails extends React.Component<ConfigMapDetailsProps> {
@observable isSaving = false;
@observable data = observable.map<string, string>();
@observable data = observable.map<string, string | undefined>();
constructor(props: ConfigMapDetailsProps) {
super(props);
@@ -48,15 +48,17 @@ export class ConfigMapDetails extends React.Component<ConfigMapDetailsProps> {
try {
this.isSaving = true;
await configMapsStore.update(configMap, {
await configMapStore.update(configMap, {
...configMap,
data: Object.fromEntries(this.data),
});
Notifications.ok(
Notifications.ok((
<p>
<>ConfigMap <b>{configMap.getName()}</b> successfully updated.</>
</p>,
);
{"ConfigMap "}
<b>{configMap.getName()}</b>
{" successfully updated."}
</p>
));
} catch (error) {
Notifications.error(`Failed to save config map: ${error}`);
} finally {
@@ -104,7 +106,8 @@ export class ConfigMapDetails extends React.Component<ConfigMapDetailsProps> {
}
<Button
primary
label="Save" waiting={this.isSaving}
label="Save"
waiting={this.isSaving}
className="save-btn"
onClick={this.save}
/>
@@ -4,13 +4,18 @@
*/
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { ConfigMap } from "../../../common/k8s-api/endpoints/configmap.api";
import type { ConfigMap, ConfigMapApi, ConfigMapData } from "../../../common/k8s-api/endpoints/configmap.api";
import { configMapApi } from "../../../common/k8s-api/endpoints/configmap.api";
import { apiManager } from "../../../common/k8s-api/api-manager";
import { isClusterPageContext } from "../../utils";
export class ConfigMapsStore extends KubeObjectStore<ConfigMap> {
api = configMapApi;
export class ConfigMapStore extends KubeObjectStore<ConfigMap, ConfigMapApi, ConfigMapData> {
}
export const configMapsStore = new ConfigMapsStore();
apiManager.registerStore(configMapsStore);
export const configMapStore = isClusterPageContext()
? new ConfigMapStore(configMapApi)
: undefined as never;
if (isClusterPageContext()) {
apiManager.registerStore(configMapStore);
}
@@ -7,7 +7,7 @@ import "./config-maps.scss";
import React from "react";
import { observer } from "mobx-react";
import { configMapsStore } from "./config-maps.store";
import { configMapStore } from "./config-maps.store";
import { KubeObjectListLayout } from "../kube-object-list-layout";
import { KubeObjectStatusIcon } from "../kube-object-status-icon";
import { SiblingsInTabLayout } from "../layout/siblings-in-tab-layout";
@@ -29,7 +29,7 @@ export class ConfigMaps extends React.Component {
isConfigurable
tableId="configuration_configmaps"
className="ConfigMaps"
store={configMapsStore}
store={configMapStore}
sortingCallbacks={{
[columnId.name]: configMap => configMap.getName(),
[columnId.namespace]: configMap => configMap.getNs(),
@@ -39,13 +39,13 @@ export class PodDisruptionBudgetDetails extends React.Component<PodDisruptionBud
<div className="PdbDetails">
<KubeObjectMeta object={pdb}/>
{selectors.length > 0 &&
{selectors.length > 0 && (
<DrawerItem name="Selector" labelsOnly>
{
selectors.map(label => <Badge key={label} label={label}/>)
}
</DrawerItem>
}
)}
<DrawerItem name="Min Available">
{pdb.getMinAvailable()}
@@ -4,13 +4,18 @@
*/
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { PodDisruptionBudget } from "../../../common/k8s-api/endpoints/poddisruptionbudget.api";
import { pdbApi } from "../../../common/k8s-api/endpoints/poddisruptionbudget.api";
import type { PodDisruptionBudget, PodDisruptionBudgetApi } from "../../../common/k8s-api/endpoints/poddisruptionbudget.api";
import { podDisruptionBudgetApi } from "../../../common/k8s-api/endpoints/poddisruptionbudget.api";
import { apiManager } from "../../../common/k8s-api/api-manager";
import { isClusterPageContext } from "../../utils";
export class PodDisruptionBudgetsStore extends KubeObjectStore<PodDisruptionBudget> {
api = pdbApi;
export class PodDisruptionBudgetStore extends KubeObjectStore<PodDisruptionBudget, PodDisruptionBudgetApi> {
}
export const podDisruptionBudgetsStore = new PodDisruptionBudgetsStore();
apiManager.registerStore(podDisruptionBudgetsStore);
export const podDisruptionBudgetsStore = isClusterPageContext()
? new PodDisruptionBudgetStore(podDisruptionBudgetApi)
: undefined as never;
if (isClusterPageContext()) {
apiManager.registerStore(podDisruptionBudgetsStore);
}
@@ -55,9 +55,9 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
public defaultNamespace = "default";
@observable quotaName = "";
@observable quotaSelectValue = "";
@observable quotaSelectValue: string | null = null;
@observable quotaInputValue = "";
@observable namespace = this.defaultNamespace;
@observable namespace: string | null = this.defaultNamespace;
@observable quotas = AddQuotaDialog.defaultQuotas;
constructor(props: AddQuotaDialogProps) {
@@ -75,23 +75,39 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
@computed get quotaEntries() {
return Object.entries(this.quotas)
.filter(([, value]) => !!value.trim());
.filter(([, value]) => !!value?.trim());
}
@computed get quotaOptions() {
return Object.keys(this.quotas).map(quota => {
const isCompute = quota.endsWith(".cpu") || quota.endsWith(".memory");
const isStorage = quota.endsWith(".storage") || quota === "persistentvolumeclaims";
const isCount = quota.startsWith("count/");
const icon = isCompute ? "memory" : isStorage ? "storage" : isCount ? "looks_one" : "";
private getQuotaOptionLabelIconMaterial(quota: string) {
if (quota.endsWith(".cpu") || quota.endsWith(".memory")) {
return "memory";
}
return {
label: icon ? <span className="nobr"><Icon material={icon} /> {quota}</span> : quota,
value: quota,
};
});
if (quota.endsWith(".storage") || quota === "persistentvolumeclaims") {
return "storage";
}
if (quota.startsWith("count/")) {
return "looks_one";
}
return undefined;
}
private formatQuotaOptionLabel = (quota: string) => {
const iconMaterial = this.getQuotaOptionLabelIconMaterial(quota);
return iconMaterial
? (
<span className="nobr">
<Icon material={iconMaterial} />
{" "}
{quota}
</span>
)
: quota;
};
setQuota = () => {
if (!this.quotaSelectValue) return;
this.quotas[this.quotaSelectValue] = this.quotaInputValue;
@@ -111,13 +127,14 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
};
addQuota = async () => {
try {
const { quotaName, namespace } = this;
const quotas = this.quotaEntries.reduce<IResourceQuotaValues>((quotas, [name, value]) => {
quotas[name] = value;
const { quotaName, namespace } = this;
return quotas;
}, {});
if (!quotaName || !namespace) {
return;
}
try {
const quotas = Object.fromEntries(this.quotaEntries);
await resourceQuotaApi.create({ namespace, name: quotaName }, {
spec: {
@@ -126,7 +143,7 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
});
this.close();
} catch (err) {
Notifications.error(err);
Notifications.checkedError(err, "Unknown error occured while creating ResourceQuota");
}
};
@@ -153,17 +170,19 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
<Wizard header={header} done={this.close}>
<WizardStep
contentClass="flex gaps column"
disabledNext={!this.namespace}
disabledNext={!this.namespace || !this.quotaName}
nextLabel="Create"
next={this.addQuota}
>
<div className="flex gaps">
<Input
required autoFocus
required
autoFocus
placeholder="ResourceQuota name"
trim
validators={systemName}
value={this.quotaName} onChange={v => this.quotaName = v.toLowerCase()}
value={this.quotaName}
onChange={v => this.quotaName = v.toLowerCase()}
className="box grow"
/>
</div>
@@ -175,7 +194,7 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
placeholder="Namespace"
themeName="light"
className="box grow"
onChange={({ value }) => this.namespace = value}
onChange={value => this.namespace = value}
/>
<SubTitle title="Values" />
@@ -185,9 +204,11 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
className="quota-select"
themeName="light"
placeholder="Select a quota.."
options={this.quotaOptions}
options={Object.keys(this.quotas)}
isMulti={false}
value={this.quotaSelectValue}
onChange={({ value }) => this.quotaSelectValue = value}
onChange={value => this.quotaSelectValue = value}
formatOptionLabel={this.formatQuotaOptionLabel}
/>
<Input
maxLength={10}
@@ -197,23 +218,25 @@ export class AddQuotaDialog extends React.Component<AddQuotaDialogProps> {
onKeyDown={this.onInputQuota}
className="box grow"
/>
<Button round primary onClick={this.setQuota}>
<Button
round
primary
onClick={this.setQuota}
>
<Icon
material={this.quotas[this.quotaSelectValue] ? "edit" : "add"}
material={this.quotaSelectValue && this.quotas[this.quotaSelectValue] ? "edit" : "add"}
tooltip="Set quota"
/>
</Button>
</div>
<div className="quota-entries">
{this.quotaEntries.map(([quota, value]) => {
return (
<div key={quota} className="quota gaps inline align-center">
<div className="name">{quota}</div>
<div className="value">{value}</div>
<Icon material="clear" onClick={() => this.quotas[quota] = ""} />
</div>
);
})}
{this.quotaEntries.map(([quota, value]) => (
<div key={quota} className="quota gaps inline align-center">
<div className="name">{quota}</div>
<div className="value">{value}</div>
<Icon material="clear" onClick={() => this.quotas[quota] = ""} />
</div>
))}
</div>
</WizardStep>
</Wizard>
@@ -8,7 +8,7 @@ import React from "react";
import kebabCase from "lodash/kebabCase";
import { observer } from "mobx-react";
import { DrawerItem, DrawerTitle } from "../drawer";
import { cpuUnitsToNumber, cssNames, unitsToBytes, metricUnitsToNumber } from "../../utils";
import { cpuUnitsToNumber, cssNames, unitsToBytes, metricUnitsToNumber, object, hasDefinedTupleValue } from "../../utils";
import type { KubeObjectDetailsProps } from "../kube-object-details";
import { ResourceQuota } from "../../../common/k8s-api/endpoints/resource-quota.api";
import { LineProgress } from "../line-progress";
@@ -32,25 +32,29 @@ function transformUnit(name: string, value: string): number {
}
function renderQuotas(quota: ResourceQuota): JSX.Element[] {
const { hard = {}, used = {}} = quota.status;
const { hard = {}, used = {}} = quota.status ?? {};
return Object.entries(hard)
.filter(([name]) => used[name])
return object.entries(hard)
.filter(hasDefinedTupleValue)
.map(([name, value]) => {
const current = transformUnit(name, used[name]);
const current = transformUnit(name, value);
const max = transformUnit(name, value);
const usage = max === 0 ? 100 : Math.ceil(current / max * 100); // special case 0 max as always 100% usage
return (
<div key={name} className={cssNames("param", kebabCase(name))}>
<span className="title">{name}</span>
<span className="value">{used[name]} / {value}</span>
<span className="value">
{`${used[name]} / ${value}`}
</span>
<LineProgress
max={max}
value={current}
tooltip={
<p>Set: {value}. Usage: {`${usage}%`}</p>
}
tooltip={(
<p>
{`Set: ${value}. Usage: ${usage}%`}
</p>
)}
/>
</div>
);
@@ -4,13 +4,18 @@
*/
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { ResourceQuota } from "../../../common/k8s-api/endpoints/resource-quota.api";
import type { ResourceQuota, ResourceQuotaApi } from "../../../common/k8s-api/endpoints/resource-quota.api";
import { resourceQuotaApi } from "../../../common/k8s-api/endpoints/resource-quota.api";
import { apiManager } from "../../../common/k8s-api/api-manager";
import { isClusterPageContext } from "../../utils";
export class ResourceQuotasStore extends KubeObjectStore<ResourceQuota> {
api = resourceQuotaApi;
export class ResourceQuotaStore extends KubeObjectStore<ResourceQuota, ResourceQuotaApi> {
}
export const resourceQuotaStore = new ResourceQuotasStore();
apiManager.registerStore(resourceQuotaStore);
export const resourceQuotaStore = isClusterPageContext()
? new ResourceQuotaStore(resourceQuotaApi)
: undefined as never;
if (isClusterPageContext()) {
apiManager.registerStore(resourceQuotaStore);
}
@@ -20,6 +20,8 @@ describe("SecretDetails tests", () => {
name: "test",
resourceVersion: "1",
uid: "uid",
namespace: "default",
selfLink: "/api/v1/secrets/default/test",
},
data: {
foobar: "",
@@ -13,18 +13,16 @@ import { Dialog } from "../dialog";
import { Wizard, WizardStep } from "../wizard";
import { Input } from "../input";
import { systemName } from "../input/input_validators";
import type { Secret } from "../../../common/k8s-api/endpoints";
import { secretsApi, SecretType } from "../../../common/k8s-api/endpoints";
import { secretApi, SecretType } from "../../../common/k8s-api/endpoints";
import { SubTitle } from "../layout/sub-title";
import { NamespaceSelect } from "../+namespaces/namespace-select";
import type { SelectOption } from "../select";
import { Select } from "../select";
import { Icon } from "../icon";
import type { KubeObjectMetadata } from "../../../common/k8s-api/kube-object";
import { base64 } from "../../utils";
import { base64, iter } from "../../utils";
import { Notifications } from "../notifications";
import upperFirst from "lodash/upperFirst";
import { showDetails } from "../kube-detail-params";
import { fromEntries } from "../../../common/utils/objects";
export interface AddSecretDialogProps extends Partial<DialogProps> {
}
@@ -36,7 +34,7 @@ interface ISecretTemplateField {
}
interface ISecretTemplate {
[field: string]: ISecretTemplateField[];
[field: string]: ISecretTemplateField[] | undefined;
annotations?: ISecretTemplateField[];
labels?: ISecretTemplateField[];
data?: ISecretTemplateField[];
@@ -63,7 +61,7 @@ export class AddSecretDialog extends React.Component<AddSecretDialogProps> {
dialogState.isOpen = false;
}
private secretTemplate: { [p: string]: ISecretTemplate } = {
private secretTemplate: Partial<Record<SecretType, ISecretTemplate>> = {
[SecretType.Opaque]: {},
[SecretType.ServiceAccountToken]: {
annotations: [
@@ -91,61 +89,59 @@ export class AddSecretDialog extends React.Component<AddSecretDialogProps> {
AddSecretDialog.close();
};
private getDataFromFields = (fields: ISecretTemplateField[] = [], processValue?: (val: string) => string) => {
return fields.reduce<any>((data, field) => {
const { key, value } = field;
if (key) {
data[key] = processValue ? processValue(value) : value;
}
return data;
}, {});
private getDataFromFields = (fields: ISecretTemplateField[] = [], processValue: (val: string) => string = (val => val)) => {
return iter.pipeline(fields)
.filterMap(({ key, value }) => (
value
? [key, processValue(value)] as const
: undefined
))
.collect(fromEntries);
};
createSecret = async () => {
const { name, namespace, type } = this;
const { data = [], labels = [], annotations = [] } = this.secret[type];
const secret: Partial<Secret> = {
type,
data: this.getDataFromFields(data, val => val ? base64.encode(val) : ""),
metadata: {
name,
namespace,
annotations: this.getDataFromFields(annotations),
labels: this.getDataFromFields(labels),
} as KubeObjectMetadata,
};
const { data = [], labels = [], annotations = [] } = this.secret[type] ?? {};
try {
const newSecret = await secretsApi.create({ namespace, name }, secret);
const newSecret = await secretApi.create({ namespace, name }, {
type,
data: this.getDataFromFields(data, val => val ? base64.encode(val) : ""),
metadata: {
name,
namespace,
annotations: this.getDataFromFields(annotations),
labels: this.getDataFromFields(labels),
},
});
showDetails(newSecret.selfLink);
showDetails(newSecret?.selfLink);
this.close();
} catch (err) {
Notifications.error(err);
Notifications.checkedError(err, "Unknown error occured while creating a Secret");
}
};
addField = (field: ISecretField) => {
const fields = this.secret[this.type][field] || [];
private getFields(field: ISecretField) {
return (this.secret[this.type] ??= {})[field] ??= [];
}
fields.push({ key: "", value: "" });
this.secret[this.type][field] = fields;
addField = (field: ISecretField) => {
this.getFields(field).push({ key: "", value: "" });
};
removeField = (field: ISecretField, index: number) => {
const fields = this.secret[this.type][field] || [];
fields.splice(index, 1);
this.getFields(field).splice(index, 1);
};
renderFields(field: ISecretField) {
const fields = this.secret[this.type][field] || [];
return (
<>
<SubTitle compact className="fields-title" title={upperFirst(field.toString())}>
<SubTitle
compact
className="fields-title"
title={upperFirst(field.toString())}
>
<Icon
small
tooltip="Add field"
@@ -154,37 +150,37 @@ export class AddSecretDialog extends React.Component<AddSecretDialogProps> {
/>
</SubTitle>
<div className="secret-fields">
{fields.map((item, index) => {
const { key = "", value = "", required } = item;
return (
{this.getFields(field)
.map((item, index) => (
<div key={index} className="secret-field flex gaps auto align-center">
<Input
className="key"
placeholder="Name"
title={key}
tabIndex={required ? -1 : 0}
readOnly={required}
value={key} onChange={v => item.key = v}
title={item.key}
tabIndex={item.required ? -1 : 0}
readOnly={item.required}
value={item.key}
onChange={v => item.key = v}
/>
<Input
multiLine maxRows={5}
required={required}
multiLine
maxRows={5}
required={item.required}
className="value"
placeholder="Value"
value={value} onChange={v => item.value = v}
value={item.value}
onChange={v => item.value = v}
/>
<Icon
small
disabled={required}
tooltip={required ? "Required field" : "Remove field"}
disabled={item.required}
tooltip={item.required ? "Required field" : "Remove field"}
className="remove-icon"
material="remove_circle_outline"
onClick={() => this.removeField(field, index)}
onClick={() => this.removeField(field, index)}
/>
</div>
);
})}
))}
</div>
</>
);
@@ -204,15 +200,21 @@ export class AddSecretDialog extends React.Component<AddSecretDialogProps> {
close={this.close}
>
<Wizard header={header} done={this.close}>
<WizardStep contentClass="flow column" nextLabel="Create" next={this.createSecret}>
<WizardStep
contentClass="flow column"
nextLabel="Create"
next={this.createSecret}
>
<div className="secret-name">
<SubTitle title="Secret name" />
<Input
autoFocus required
autoFocus
required
placeholder="Name"
trim
validators={systemName}
value={name} onChange={v => this.name = v}
value={name}
onChange={v => this.name = v}
/>
</div>
<div className="flex auto gaps">
@@ -222,7 +224,7 @@ export class AddSecretDialog extends React.Component<AddSecretDialogProps> {
id="secret-namespace-input"
themeName="light"
value={namespace}
onChange={({ value }) => this.namespace = value}
onChange={value => this.namespace = value ?? "default"}
/>
</div>
<div className="secret-type">
@@ -231,7 +233,8 @@ export class AddSecretDialog extends React.Component<AddSecretDialogProps> {
id="secret-input"
themeName="light"
options={this.types}
value={type} onChange={({ value }: SelectOption) => this.type = value}
value={type}
onChange={value => this.type = value ?? SecretType.Opaque}
/>
</div>
</div>
@@ -14,7 +14,7 @@ import { Button } from "../button";
import { Notifications } from "../notifications";
import { base64, toggle } from "../../utils";
import { Icon } from "../icon";
import { secretsStore } from "./secrets.store";
import { secretStore } from "./secrets.store";
import type { KubeObjectDetailsProps } from "../kube-object-details";
import { Secret } from "../../../common/k8s-api/endpoints";
import { KubeObjectMeta } from "../kube-object-meta";
@@ -26,7 +26,7 @@ export interface SecretDetailsProps extends KubeObjectDetailsProps<Secret> {
@observer
export class SecretDetails extends React.Component<SecretDetailsProps> {
@observable isSaving = false;
@observable data: { [name: string]: string } = {};
@observable data: Partial<Record<string, string>> = {};
@observable revealSecret = observable.set<string>();
constructor(props: SecretDetailsProps) {
@@ -53,10 +53,10 @@ export class SecretDetails extends React.Component<SecretDetailsProps> {
this.isSaving = true;
try {
await secretsStore.update(secret, { ...secret, data: this.data });
await secretStore.update(secret, { ...secret, data: this.data });
Notifications.ok("Secret successfully updated.");
} catch (err) {
Notifications.error(err);
Notifications.checkedError(err, "Unknown error occured while updating the secret");
}
this.isSaving = false;
};
@@ -65,11 +65,11 @@ export class SecretDetails extends React.Component<SecretDetailsProps> {
this.data[name] = encoded ? value : base64.encode(value);
};
renderSecret = ([name, value]: [string, string]) => {
renderSecret = ([name, value]: [string, string | undefined]) => {
let decodedVal: string | undefined;
try {
decodedVal = base64.decode(value);
decodedVal = value ? base64.decode(value) : undefined;
} catch {
/**
* The value failed to be decoded, so don't show the visibility
@@ -85,7 +85,11 @@ export class SecretDetails extends React.Component<SecretDetailsProps> {
}
return (
<div key={name} className="data" data-testid={`${name}-secret-entry`}>
<div
key={name}
className="data"
data-testid={`${name}-secret-entry`}
>
<div className="name">{name}</div>
<div className="flex gaps align-center">
<Input
@@ -120,7 +124,8 @@ export class SecretDetails extends React.Component<SecretDetailsProps> {
{secrets.map(this.renderSecret)}
<Button
primary
label="Save" waiting={this.isSaving}
label="Save"
waiting={this.isSaving}
className="save-btn"
onClick={this.saveSecret}
/>
@@ -4,13 +4,18 @@
*/
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { Secret } from "../../../common/k8s-api/endpoints";
import { secretsApi } from "../../../common/k8s-api/endpoints";
import type { Secret, SecretApi, SecretData } from "../../../common/k8s-api/endpoints";
import { secretApi } from "../../../common/k8s-api/endpoints";
import { apiManager } from "../../../common/k8s-api/api-manager";
import { isClusterPageContext } from "../../utils";
export class SecretsStore extends KubeObjectStore<Secret> {
api = secretsApi;
export class SecretStore extends KubeObjectStore<Secret, SecretApi, SecretData> {
}
export const secretsStore = new SecretsStore();
apiManager.registerStore(secretsStore);
export const secretStore = isClusterPageContext()
? new SecretStore(secretApi)
: undefined as never;
if (isClusterPageContext()) {
apiManager.registerStore(secretStore);
}
@@ -10,7 +10,7 @@ import { observer } from "mobx-react";
import { AddSecretDialog } from "./add-secret-dialog";
import { KubeObjectListLayout } from "../kube-object-list-layout";
import { Badge } from "../badge";
import { secretsStore } from "./secrets.store";
import { secretStore } from "./secrets.store";
import { KubeObjectStatusIcon } from "../kube-object-status-icon";
import { SiblingsInTabLayout } from "../layout/siblings-in-tab-layout";
import { KubeObjectAge } from "../kube-object/age";
@@ -33,7 +33,7 @@ export class Secrets extends React.Component {
isConfigurable
tableId="configuration_secrets"
className="Secrets"
store={secretsStore}
store={secretStore}
sortingCallbacks={{
[columnId.name]: secret => secret.getName(),
[columnId.namespace]: secret => secret.getNs(),
@@ -60,7 +60,14 @@ export class Secrets extends React.Component {
secret.getName(),
<KubeObjectStatusIcon key="icon" object={secret} />,
secret.getNs(),
secret.getLabels().map(label => <Badge scrollable key={label} label={label} expandable={false}/>),
secret.getLabels().map(label => (
<Badge
scrollable
key={label}
label={label}
expandable={false}
/>
)),
secret.getKeys().join(", "),
secret.type,
<KubeObjectAge key="age" object={secret} />,
@@ -70,7 +70,11 @@ export class CRDDetails extends React.Component<CRDDetailsProps> {
readOnly
/>
</DrawerItem>
<DrawerItem name="Conditions" className="conditions" labelsOnly>
<DrawerItem
name="Conditions"
className="conditions"
labelsOnly
>
{
crd.getConditions().map(condition => {
const { type, message, lastTransitionTime, status } = condition;
@@ -84,7 +88,10 @@ export class CRDDetails extends React.Component<CRDDetailsProps> {
tooltip={(
<>
<p>{message}</p>
<p>Last transition time: {lastTransitionTime}</p>
<p>
Last transition time:
{lastTransitionTime}
</p>
</>
)}
/>
@@ -107,7 +114,7 @@ export class CRDDetails extends React.Component<CRDDetailsProps> {
<TableCell>{listKind}</TableCell>
</TableRow>
</Table>
{printerColumns.length > 0 &&
{printerColumns.length > 0 && (
<>
<DrawerTitle>Additional Printer Columns</DrawerTitle>
<Table selectable className="printer-columns box grow">
@@ -133,8 +140,8 @@ export class CRDDetails extends React.Component<CRDDetailsProps> {
}
</Table>
</>
}
{validation &&
)}
{validation && (
<>
<DrawerTitle>Validation</DrawerTitle>
<MonacoEditor
@@ -143,7 +150,7 @@ export class CRDDetails extends React.Component<CRDDetailsProps> {
style={{ height: 400 }}
/>
</>
}
)}
</div>
);
}
@@ -6,13 +6,12 @@
import "./crd-list.scss";
import React from "react";
import { computed, makeObservable } from "mobx";
import { computed, makeObservable, observable } from "mobx";
import { observer } from "mobx-react";
import { Link } from "react-router-dom";
import { stopPropagation } from "../../utils";
import { iter, stopPropagation } from "../../utils";
import { KubeObjectListLayout } from "../kube-object-list-layout";
import { crdStore } from "./crd.store";
import type { SelectOption } from "../select";
import { Select } from "../select";
import { createPageParam } from "../../navigation";
import { Icon } from "../icon";
@@ -34,32 +33,36 @@ enum columnId {
@observer
export class CustomResourceDefinitions extends React.Component {
private readonly selectedGroups = observable.set(crdGroupsUrlParam.get());
constructor(props: {}) {
super(props);
makeObservable(this);
}
get selectedGroups(): string[] {
return crdGroupsUrlParam.get();
}
@computed get items() {
if (this.selectedGroups.length) {
return crdStore.items.filter(item => this.selectedGroups.includes(item.getGroup()));
if (this.selectedGroups.size) {
return crdStore.items.filter(item => this.selectedGroups.has(item.getGroup()));
}
return crdStore.items; // show all by default
}
toggleSelection(group: string) {
const groups = new Set(crdGroupsUrlParam.get());
if (groups.has(group)) {
groups.delete(group);
} else {
groups.add(group);
}
toggleSelection = (groups: readonly string[]) => {
this.selectedGroups.replace(groups);
crdGroupsUrlParam.set([...groups]);
};
private getPlaceholder() {
if (this.selectedGroups.size === 0) {
return "All groups";
}
const prefix = this.selectedGroups.size === 1
? "Group"
: "Groups";
return `${prefix}: ${iter.join(this.selectedGroups, ", ")}`;
}
render() {
@@ -90,42 +93,38 @@ export class CustomResourceDefinitions extends React.Component {
crd => -crd.getCreationTimestamp(),
]}
renderHeaderTitle="Custom Resources"
customizeHeader={({ filters, ...headerPlaceholders }) => {
let placeholder = <>All groups</>;
if (selectedGroups.length == 1) placeholder = <>Group: {selectedGroups[0]}</>;
if (selectedGroups.length >= 2) placeholder = <>Groups: {selectedGroups.join(", ")}</>;
return {
// todo: move to global filters
filters: (
<>
{filters}
<Select
id="crd-input"
className="group-select"
placeholder={placeholder}
options={Object.keys(crdStore.groups)}
onChange={({ value: group }: SelectOption) => this.toggleSelection(group)}
closeMenuOnSelect={false}
controlShouldRenderValue={false}
formatOptionLabel={({ value: group }: SelectOption) => {
const isSelected = selectedGroups.includes(group);
return (
<div className="flex gaps align-center">
<Icon small material="folder"/>
<span>{group}</span>
{isSelected && <Icon small material="check" className="box right"/>}
</div>
);
}}
/>
</>
),
...headerPlaceholders,
};
}}
customizeHeader={({ filters, ...headerPlaceholders }) => ({
// todo: move to global filters
filters: (
<>
{filters}
<Select
className="group-select"
placeholder={this.getPlaceholder()}
options={Object.keys(crdStore.groups)}
onChange={this.toggleSelection}
closeMenuOnSelect={false}
controlShouldRenderValue={false}
isOptionSelected={opt => this.selectedGroups.has(opt)}
isMulti={true}
formatOptionLabel={(group) => (
<div className="flex gaps align-center">
<Icon small material="folder" />
<span>{group}</span>
{selectedGroups.has(group) && (
<Icon
small
material="check"
className="box right"
/>
)}
</div>
)}
/>
</>
),
...headerPlaceholders,
})}
renderTableHeader={[
{ title: "Resource", className: "kind", sortBy: columnId.kind, id: columnId.kind },
{ title: "Group", className: "group", sortBy: columnId.group, id: columnId.group },
@@ -134,7 +133,11 @@ export class CustomResourceDefinitions extends React.Component {
{ title: "Age", className: "age", sortBy: columnId.age, id: columnId.age },
]}
renderTableContents={crd => [
<Link key="link" to={crd.getResourceUrl()} onClick={stopPropagation}>
<Link
key="link"
to={crd.getResourceUrl()}
onClick={stopPropagation}
>
{crd.getResourceKind()}
</Link>,
crd.getGroup(),
@@ -16,7 +16,7 @@ import { Input } from "../input";
import type { AdditionalPrinterColumnsV1 } from "../../../common/k8s-api/endpoints/crd.api";
import { CustomResourceDefinition } from "../../../common/k8s-api/endpoints/crd.api";
import { convertKubectlJsonPathToNodeJsonPath } from "../../utils/jsonPath";
import type { KubeObjectMetadata, KubeObjectStatus } from "../../../common/k8s-api/kube-object";
import type { KubeObjectStatus } from "../../../common/k8s-api/kube-object";
import { KubeObject } from "../../../common/k8s-api/kube-object";
import logger from "../../../common/logger";
import { JSONPath } from "@astronautlabs/jsonpath";
@@ -49,25 +49,34 @@ function convertSpecValue(value: any): any {
export class CustomResourceDetails extends React.Component<CustomResourceDetailsProps> {
renderAdditionalColumns(resource: KubeObject, columns: AdditionalPrinterColumnsV1[]) {
return columns.map(({ name, jsonPath }) => (
<DrawerItem key={name} name={name} renderBoolean>
<DrawerItem
key={name}
name={name}
renderBoolean
>
{convertSpecValue(JSONPath.query(resource, convertKubectlJsonPathToNodeJsonPath(jsonPath)))}
</DrawerItem>
));
}
renderStatus(customResource: KubeObject<KubeObjectMetadata, KubeObjectStatus, any>, columns: AdditionalPrinterColumnsV1[]) {
renderStatus(customResource: KubeObject<KubeObjectStatus, unknown>, columns: AdditionalPrinterColumnsV1[]) {
const showStatus = !columns.find(column => column.name == "Status") && Array.isArray(customResource.status?.conditions);
if (!showStatus) {
return null;
}
const conditions = customResource.status.conditions
.filter(({ type, reason }) => type || reason)
.map(({ type, reason, message, status }) => ({ kind: type || reason, message, status }))
const conditions = customResource.status?.conditions
?.filter(({ type, reason }) => type || reason)
.map(({ type, reason, message, status }) => ({
kind: type || reason || "<unknown>",
message,
status,
}))
.map(({ kind, message, status }, index) => (
<Badge
key={kind + index} label={kind}
key={kind + index}
label={kind}
disabled={status === "False"}
className={kind.toLowerCase()}
tooltip={message}
@@ -75,7 +84,11 @@ export class CustomResourceDetails extends React.Component<CustomResourceDetails
));
return (
<DrawerItem name="Status" className="status" labelsOnly>
<DrawerItem
name="Status"
className="status"
labelsOnly
>
{conditions}
</DrawerItem>
);
@@ -7,7 +7,7 @@ import type { KubeApi } from "../../../common/k8s-api/kube-api";
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
export class CRDResourceStore<K extends KubeObject> extends KubeObjectStore<K> {
export class CRDResourceStore<K extends KubeObject> extends KubeObjectStore<K, KubeApi<K>> {
constructor(api: KubeApi<K>) {
super(api);
}
@@ -47,7 +47,7 @@ class NonInjectedCrdResources extends React.Component<Dependencies> {
render() {
const { crd, store } = this;
if (!crd) {
if (!crd || !store) {
return null;
}
@@ -85,7 +85,9 @@ class NonInjectedCrdResources extends React.Component<Dependencies> {
})}
renderTableHeader={[
{ title: "Name", className: "name", sortBy: columnId.name, id: columnId.name },
isNamespaced && { title: "Namespace", className: "namespace", sortBy: columnId.namespace, id: columnId.namespace },
isNamespaced
? { title: "Namespace", className: "namespace", sortBy: columnId.namespace, id: columnId.namespace }
: undefined,
...extraColumns.map(({ name }) => ({
title: name,
className: name.toLowerCase(),
@@ -102,9 +104,13 @@ class NonInjectedCrdResources extends React.Component<Dependencies> {
]}
failedToLoadMessage={(
<>
<p>Failed to load {crd.getPluralName()}</p>
<p>
{`Failed to load ${crd.getPluralName()}`}
</p>
{!version.served && (
<p>Prefered version ({crd.getGroup()}/{version.name}) is not served</p>
<p>
{`Prefered version (${crd.getGroup()}/${version.name}) is not served`}
</p>
)}
</>
)}
@@ -6,7 +6,7 @@
import { computed, reaction, makeObservable } from "mobx";
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import { autoBind } from "../../utils";
import type { CustomResourceDefinition } from "../../../common/k8s-api/endpoints/crd.api";
import type { CustomResourceDefinition, CustomResourceDefinitionApi } from "../../../common/k8s-api/endpoints/crd.api";
import { crdApi } from "../../../common/k8s-api/endpoints/crd.api";
import { apiManager } from "../../../common/k8s-api/api-manager";
import { KubeApi } from "../../../common/k8s-api/kube-api";
@@ -28,11 +28,9 @@ function initStore(crd: CustomResourceDefinition) {
}
}
export class CRDStore extends KubeObjectStore<CustomResourceDefinition> {
api = crdApi;
export class CRDStore extends KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi> {
constructor() {
super();
super(crdApi);
makeObservable(this);
autoBind(this);
@@ -3,7 +3,7 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import { noop, some } from "lodash/fp";
import { noop } from "lodash/fp";
import { computed } from "mobx";
import type {
@@ -55,7 +55,7 @@ const customResourceSidebarItemsInjectable = getInjectable({
title: "Custom Resources",
getIcon: () => <Icon material="extension" />,
onClick: noop,
isVisible: computed(() => some(item => item.isVisible.get(), childrenAndGrandChildren)),
isVisible: computed(() => childrenAndGrandChildren.some(item => item.isVisible?.get())),
orderNumber: 110,
};
@@ -27,7 +27,7 @@ interface Dependencies {
@observer
class NonInjectedEntitySettings extends React.Component<Dependencies> {
@observable activeTab: string;
@observable activeTab?: string;
constructor(props: Dependencies) {
super(props);
@@ -94,7 +94,12 @@ class NonInjectedEntitySettings extends React.Component<Dependencies> {
{this.entity.getName()}
</div>
</div>
<Tabs className="flex column" scrollable={false} onChange={this.onTabChange} value={this.activeTab}>
<Tabs
className="flex column"
scrollable={false}
onChange={this.onTabChange}
value={this.activeTab}
>
{ groups.map((group, groupIndex) => (
<React.Fragment key={`group-${groupIndex}`}>
<hr/>
@@ -0,0 +1,27 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import React from "react";
import { ReactiveDuration } from "../duration/reactive-duration";
import { LocaleDate } from "../locale-date";
export interface DurationAbsoluteTimestampProps {
timestamp: string | undefined;
}
export const DurationAbsoluteTimestamp = ({ timestamp }: DurationAbsoluteTimestampProps) => {
if (!timestamp) {
return <>{"<unknown>"}</>;
}
return (
<>
<ReactiveDuration timestamp={timestamp} />
{" ago "}
(
<LocaleDate date={timestamp} />
)
</>
);
};
@@ -14,11 +14,10 @@ import type { KubeObjectDetailsProps } from "../kube-object-details";
import { KubeEvent } from "../../../common/k8s-api/endpoints/events.api";
import { KubeObjectMeta } from "../kube-object-meta";
import { Table, TableCell, TableHead, TableRow } from "../table";
import { LocaleDate } from "../locale-date";
import { getDetailsUrl } from "../kube-detail-params";
import { apiManager } from "../../../common/k8s-api/api-manager";
import logger from "../../../common/logger";
import { ReactiveDuration } from "../duration/reactive-duration";
import { DurationAbsoluteTimestamp } from "./duration-absolute";
export interface EventDetailsProps extends KubeObjectDetailsProps<KubeEvent> {
}
@@ -55,14 +54,10 @@ export class EventDetails extends React.Component<EventDetailsProps> {
{event.getSource()}
</DrawerItem>
<DrawerItem name="First seen">
<ReactiveDuration timestamp={event.firstTimestamp} />
{" ago "}
(<LocaleDate date={event.firstTimestamp} />)
<DurationAbsoluteTimestamp timestamp={event.firstTimestamp} />
</DrawerItem>
<DrawerItem name="Last seen">
<ReactiveDuration timestamp={event.lastTimestamp} />
{" ago "}
(<LocaleDate date={event.lastTimestamp} />)
<DurationAbsoluteTimestamp timestamp={event.lastTimestamp} />
</DrawerItem>
<DrawerItem name="Count">
{count}
+13 -12
View File
@@ -6,21 +6,17 @@
import groupBy from "lodash/groupBy";
import compact from "lodash/compact";
import { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import { autoBind } from "../../utils";
import type { KubeEvent } from "../../../common/k8s-api/endpoints/events.api";
import { autoBind, isClusterPageContext } from "../../utils";
import type { KubeEvent, KubeEventApi } from "../../../common/k8s-api/endpoints/events.api";
import { eventApi } from "../../../common/k8s-api/endpoints/events.api";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
import { Pod } from "../../../common/k8s-api/endpoints/pods.api";
import { podsStore } from "../+workloads-pods/pods.store";
import { apiManager } from "../../../common/k8s-api/api-manager";
export class EventStore extends KubeObjectStore<KubeEvent> {
api = eventApi;
limit = 1000;
saveLimit = 50000;
constructor() {
super();
export class EventStore extends KubeObjectStore<KubeEvent, KubeEventApi> {
constructor(api: KubeEventApi) {
super(api, { limit: 1000 });
autoBind(this);
}
@@ -54,7 +50,7 @@ export class EventStore extends KubeObjectStore<KubeEvent> {
if (kind == Pod.kind) { // Wipe out running pods
const pod = podsStore.items.find(pod => pod.getId() == uid);
if (!pod || (!pod.hasIssues() && pod.spec.priority < 500000)) return undefined;
if (!pod || (!pod.hasIssues() && (pod.spec?.priority ?? 0) < 500000)) return undefined;
}
return recent;
@@ -68,5 +64,10 @@ export class EventStore extends KubeObjectStore<KubeEvent> {
}
}
export const eventStore = new EventStore();
apiManager.registerStore(eventStore);
export const eventStore = isClusterPageContext()
? new EventStore(eventApi)
: undefined as never;
if (isClusterPageContext()) {
apiManager.registerStore(eventStore);
}
+36 -20
View File
@@ -5,7 +5,7 @@
import "./events.scss";
import React, { Fragment } from "react";
import React from "react";
import { computed, observable, makeObservable } from "mobx";
import { observer } from "mobx-react";
import { orderBy } from "lodash";
@@ -14,7 +14,7 @@ import type { EventStore } from "./event.store";
import { eventStore } from "./event.store";
import type { KubeObjectListLayoutProps } from "../kube-object-list-layout";
import { KubeObjectListLayout } from "../kube-object-list-layout";
import type { KubeEvent } from "../../../common/k8s-api/endpoints/events.api";
import type { KubeEvent, KubeEventApi, KubeEventData } from "../../../common/k8s-api/endpoints/events.api";
import type { TableSortCallbacks, TableSortParams } from "../table";
import type { HeaderCustomizer } from "../item-object-list";
import { Tooltip } from "../tooltip";
@@ -40,7 +40,7 @@ enum columnId {
lastSeen = "last-seen",
}
export interface EventsProps extends Partial<KubeObjectListLayoutProps<KubeEvent>> {
export interface EventsProps extends Partial<KubeObjectListLayoutProps<KubeEvent, KubeEventApi, KubeEventData>> {
className?: IClassName;
compact?: boolean;
compactLimit?: number;
@@ -69,7 +69,7 @@ class NonInjectedEvents extends React.Component<Dependencies & EventsProps> {
[columnId.object]: event => event.involvedObject.name,
[columnId.count]: event => event.count,
[columnId.age]: event => -event.getCreationTimestamp(),
[columnId.lastSeen]: event => -new Date(event.lastTimestamp).getTime(),
[columnId.lastSeen]: event => event.lastTimestamp ? -new Date(event.lastTimestamp).getTime() : 0,
};
constructor(props: Dependencies & EventsProps) {
@@ -87,7 +87,7 @@ class NonInjectedEvents extends React.Component<Dependencies & EventsProps> {
// we must sort items before passing to "KubeObjectListLayout -> Table"
// to make it work with "compact=true" (proper table sorting actions + initial items)
return orderBy(items, this.sortingCallbacks[sortBy], order as any);
return orderBy(items, this.sortingCallbacks[sortBy], order);
}
@computed get visibleItems(): KubeEvent[] {
@@ -113,20 +113,30 @@ class NonInjectedEvents extends React.Component<Dependencies & EventsProps> {
return {
title,
info: <span> ({visibleItems.length} of <a onClick={this.props.navigateToEvents}>{items.length}</a>)</span>,
info: (
<span>
{"("}
{visibleItems.length}
{" of "}
<a onClick={this.props.navigateToEvents}>{items.length}</a>
{")"}
</span>
),
};
}
return {
info: <>
{info}
<Icon
small
material="help_outline"
className="help-icon"
tooltip={`Limited to ${store.limit}`}
/>
</>,
info: (
<>
{info}
<Icon
small
material="help_outline"
className="help-icon"
tooltip={`Limited to ${store.limit}`}
/>
</>
),
title,
...headerPlaceholders,
};
@@ -180,22 +190,28 @@ class NonInjectedEvents extends React.Component<Dependencies & EventsProps> {
{
className: { warning: isWarning },
title: (
<Fragment>
<>
<span id={tooltipId}>{message}</span>
<Tooltip targetId={tooltipId} formatters={{ narrow: true, warning: isWarning }}>
{message}
</Tooltip>
</Fragment>
</>
),
},
event.getNs(),
<Link key="link" to={getDetailsUrl(apiManager.lookupApiLink(involvedObject, event))} onClick={stopPropagation}>
{involvedObject.kind}: {involvedObject.name}
<Link
key="link"
to={getDetailsUrl(apiManager.lookupApiLink(involvedObject, event))}
onClick={stopPropagation}
>
{`${involvedObject.kind}: ${involvedObject.name}`}
</Link>,
event.getSource(),
event.count,
<KubeObjectAge key="age" object={event} />,
<ReactiveDuration key="last-seen" timestamp={event.lastTimestamp} />,
event.lastTimestamp
? <ReactiveDuration key="last-seen" timestamp={event.lastTimestamp} />
: "<unknown>",
];
}}
/>
@@ -9,22 +9,21 @@ import React from "react";
import { disposeOnUnmount, observer } from "mobx-react";
import { KubeObject } from "../../../common/k8s-api/kube-object";
import { DrawerItem, DrawerTitle } from "../drawer";
import type { Disposer } from "../../utils";
import { cssNames } from "../../utils";
import { LocaleDate } from "../locale-date";
import { eventStore } from "./event.store";
import logger from "../../../common/logger";
import type { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import { withInjectables } from "@ogre-tools/injectable-react";
import kubeWatchApiInjectable
from "../../kube-watch-api/kube-watch-api.injectable";
import type { SubscribeStores } from "../../kube-watch-api/kube-watch-api";
export interface KubeEventDetailsProps {
object: KubeObject;
}
interface Dependencies {
subscribeStores: (stores: KubeObjectStore<KubeObject>[]) => Disposer;
subscribeStores: SubscribeStores;
}
@observer
@@ -73,9 +72,11 @@ class NonInjectedKubeEventDetails extends React.Component<KubeEventDetailsProps
<DrawerItem name="Sub-object">
{event.involvedObject.fieldPath}
</DrawerItem>
<DrawerItem name="Last seen">
<LocaleDate date={event.lastTimestamp} />
</DrawerItem>
{event.lastTimestamp && (
<DrawerItem name="Last seen">
<LocaleDate date={event.lastTimestamp} />
</DrawerItem>
)}
</div>
))}
</div>
@@ -21,10 +21,9 @@ 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 appVersionInjectable
from "../../../../common/get-configuration-file-model/app-version/app-version.injectable";
import getConfigurationFileModelInjectable from "../../../../common/get-configuration-file-model/get-configuration-file-model.injectable";
import appVersionInjectable from "../../../../common/get-configuration-file-model/app-version/app-version.injectable";
import assert from "assert";
mockWindow();
@@ -98,10 +97,17 @@ describe("Extensions", () => {
it("disables uninstall and disable buttons while uninstalling", async () => {
extensionDiscovery.isLoaded = true;
const res = render(<><Extensions /><ConfirmDialog /></>);
const res = render((
<>
<Extensions />
<ConfirmDialog />
</>
));
const table = res.getByTestId("extensions-table");
const menuTrigger = table.querySelector("div[role=row]:first-of-type .actions .Icon");
assert(menuTrigger);
fireEvent.click(menuTrigger);
expect(res.getByText("Disable")).toHaveAttribute("aria-disabled", "false");
@@ -125,7 +131,7 @@ describe("Extensions", () => {
it("disables install button while installing", async () => {
const res = render(<Extensions />);
(fse.unlink as jest.MockedFunction<typeof fse.unlink>).mockReturnValue(Promise.resolve() as any);
(fse.unlink as jest.MockedFunction<typeof fse.unlink>).mockReturnValue(Promise.resolve());
fireEvent.change(res.getByPlaceholderText("File path or URL", {
exact: false,
@@ -66,8 +66,11 @@ export const attemptInstallByInfo = ({ attemptInstall, getBaseRegistryUrl, exten
} else {
Notifications.error(
<p>
The <em>{name}</em> extension does not have a version or tag{" "}
<code>{version}</code>.
{"The "}
<em>{name}</em>
{" extension does not have a version or tag "}
<code>{version}</code>
.
</p>,
);
@@ -82,20 +85,24 @@ export const attemptInstallByInfo = ({ attemptInstall, getBaseRegistryUrl, exten
)
// ignore pre-releases for auto picking the version
.filter(version => version.prerelease.length === 0);
const latestVersion = lodash.reduce(versions, (prev, curr) => prev.compareMain(curr) === -1 ? curr : prev);
version = lodash.reduce(versions, (prev, curr) =>
prev.compareMain(curr) === -1 ? curr : prev,
).format();
if (!latestVersion) {
console.error("No versions supplied for that extension", { name });
Notifications.error(`No versions found for ${name}`);
return disposer();
}
version = latestVersion.format();
}
if (requireConfirmation) {
const proceed = await ConfirmDialog.confirm({
message: (
<p>
Are you sure you want to install{" "}
<b>
{name}@{version}
</b>
{"Are you sure you want to install "}
<b>{`${name}@${version}`}</b>
?
</p>
),
@@ -108,7 +115,8 @@ export const attemptInstallByInfo = ({ attemptInstall, getBaseRegistryUrl, exten
}
}
const url = json.versions[version].dist.tarball;
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const url = json.versions[version!].dist.tarball;
const fileName = path.basename(url);
const { promise: dataP } = downloadFile({ url, timeout: 10 * 60 * 1000 });
@@ -74,7 +74,9 @@ export const attemptInstall =
<div className="flex column gaps">
<b>Extension Install Collision:</b>
<p>
The <em>{name}</em> extension is currently {curState.toLowerCase()}.
{"The "}
<em>{name}</em>
{` extension is currently ${curState.toLowerCase()}.`}
</p>
<p>Will not proceed with this current install request.</p>
</div>,
@@ -92,21 +94,20 @@ export const attemptInstall =
<div className="InstallingExtensionNotification flex gaps align-center">
<div className="flex column gaps">
<p>
Install extension{" "}
<b>
{name}@{version}
</b>
?
{"Install extension "}
<b>{`${name}@${version}`}</b>
?
</p>
<p>
Description: <em>{description}</em>
{"Description: "}
<em>{description}</em>
</p>
<div
className="remove-folder-warning"
onClick={() => shell.openPath(extensionFolder)}
>
<b>Warning:</b> {name}@{oldVersion} will be removed before
installation.
<b>Warning:</b>
{` ${name}@${oldVersion} will be removed before installation.`}
</div>
</div>
<Button
@@ -73,10 +73,13 @@ export const createTempFilesAndValidate =
Notifications.error(
<div className="flex column gaps">
<p>
Installing <em>{fileName}</em> has failed, skipping.
{"Installing "}
<em>{fileName}</em>
{" has failed, skipping."}
</p>
<p>
Reason: <em>{message}</em>
{"Reason: "}
<em>{message}</em>
</p>
</div>,
);
@@ -75,7 +75,9 @@ export const unpackExtension =
Notifications.ok(
<p>
Extension <b>{displayName}</b> successfully installed!
{"Extension "}
<b>{displayName}</b>
{" successfully installed!"}
</p>,
);
} catch (error) {
@@ -87,7 +89,9 @@ export const unpackExtension =
);
Notifications.error(
<p>
Installing extension <b>{displayName}</b> has failed:{" "}
{"Installing extension "}
<b>{displayName}</b>
{" has failed: "}
<em>{message}</em>
</p>,
);
@@ -3,7 +3,7 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import type { LensExtensionManifest } from "../../../../../extensions/lens-extension";
import { listTarEntries, readFileFromTar } from "../../../../../common/utils";
import { hasTypedProperty, isObject, isString, listTarEntries, readFileFromTar } from "../../../../../common/utils";
import { manifestFilename } from "../../../../../extensions/extension-discovery/extension-discovery";
import path from "path";
@@ -31,17 +31,21 @@ export const validatePackage = async (
throw new Error(`invalid extension bundle, ${manifestFilename} not found`);
}
const manifest = await readFileFromTar<LensExtensionManifest>({
const manifest = await readFileFromTar({
tarPath: filePath,
filePath: manifestLocation,
parseJson: true,
});
if (!manifest.main && !manifest.renderer) {
throw new Error(
`${manifestFilename} must specify "main" and/or "renderer" fields`,
);
if (
isObject(manifest)
&& (
hasTypedProperty(manifest, "main", isString)
|| hasTypedProperty(manifest, "renderer", isString)
)
) {
return manifest as unknown as LensExtensionManifest;
}
return manifest;
throw new Error(`${manifestFilename} must specify "main" and/or "renderer" fields`);
};
@@ -22,7 +22,9 @@ export const confirmUninstallExtension =
const confirmed = await ConfirmDialog.confirm({
message: (
<p>
Are you sure you want to uninstall extension <b>{displayName}</b>?
{"Are you sure you want to uninstall extension "}
<b>{displayName}</b>
?
</p>
),
labelOk: "Yes",
@@ -72,15 +72,33 @@ class NonInjectedExtensions extends React.Component<Dependencies> {
return (
<DropFileInput onDropFiles={this.props.installOnDrop}>
<SettingLayout className="Extensions" contentGaps={false} data-testid="extensions-page">
<SettingLayout
className="Extensions"
contentGaps={false}
data-testid="extensions-page"
>
<section>
<h1>Extensions</h1>
<Notice className="mb-14 mt-3">
<p>
Add new features via Lens Extensions.{" "}
Check out <a href={`${docsUrl}/extensions/`} target="_blank" rel="noreferrer">docs</a>{" "}
and list of <a href="https://github.com/lensapp/lens-extensions/blob/main/README.md" target="_blank" rel="noreferrer">available extensions</a>.
{"Add new features via Lens Extensions. Check out the "}
<a
href={`${docsUrl}/extensions/`}
target="_blank"
rel="noreferrer"
>
docs
</a>
{" and list of "}
<a
href="https://github.com/lensapp/lens-extensions/blob/main/README.md"
target="_blank"
rel="noreferrer"
>
available extensions
</a>
.
</p>
</Notice>
@@ -5,7 +5,7 @@
import React from "react";
import type { ExtensionRegistry } from "../../../../common/user-store/preferences-helpers";
import { defaultExtensionRegistryUrl, ExtensionRegistryLocation } from "../../../../common/user-store/preferences-helpers";
import { defaultExtensionRegistryUrl } from "../../../../common/user-store/preferences-helpers";
import { promiseExecFile } from "../../../utils";
import { Notifications } from "../../notifications";
@@ -17,10 +17,10 @@ export const getBaseRegistryUrl = ({ getRegistryUrlPreference }: Dependencies) =
const extensionRegistryUrl = getRegistryUrlPreference();
switch (extensionRegistryUrl.location) {
case ExtensionRegistryLocation.CUSTOM:
case "custom":
return extensionRegistryUrl.customUrl;
case ExtensionRegistryLocation.NPMRC: {
case "npmrc": {
try {
const filteredEnv = Object.fromEntries(
Object.entries(process.env)
@@ -30,13 +30,20 @@ export const getBaseRegistryUrl = ({ getRegistryUrlPreference }: Dependencies) =
return stdout.trim();
} catch (error) {
Notifications.error(<p>Failed to get configured registry from <code>.npmrc</code>. Falling back to default registry</p>);
Notifications.error((
<p>
Failed to get configured registry from
<code>.npmrc</code>
. Falling back to default registry.
</p>
));
console.warn("[EXTENSIONS]: failed to get configured registry from .npmrc", error);
}
// fallthrough
}
// fallthrough
default:
case ExtensionRegistryLocation.DEFAULT:
case "default":
return defaultExtensionRegistryUrl;
}
};
@@ -2,16 +2,19 @@
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
export function getMessageFromError(error: any): string {
import { hasTypedProperty, isDefined } from "../../../utils";
export function getMessageFromError(error: unknown): string {
if (!error || typeof error !== "object") {
return "an error has occurred";
}
if (error.message) {
return String(error.message);
if (error instanceof Error) {
return error.message;
}
if (error.err) {
if (hasTypedProperty(error, "err", isDefined)) {
return String(error.err);
}
@@ -14,6 +14,7 @@ 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/attempt-install-by-info";
import type { ExtensionInstallationStateStore } from "../../../../extensions/extension-installation-state-store/extension-installation-state-store";
import { AsyncInputValidationError } from "../../input/input_validators";
interface Dependencies {
attemptInstall: (request: InstallRequest, disposer?: ExtendableDisposer) => Promise<void>;
@@ -21,34 +22,59 @@ interface Dependencies {
extensionInstallationStateStore: ExtensionInstallationStateStore;
}
export const installFromInput = ({ attemptInstall, attemptInstallByInfo, extensionInstallationStateStore }: Dependencies) => async (input: string) => {
let disposer: ExtendableDisposer | undefined = undefined;
export const installFromInput = ({
attemptInstall,
attemptInstallByInfo,
extensionInstallationStateStore,
}: Dependencies) => (
async (input: string): Promise<void> => {
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);
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);
await attemptInstall({ fileName, dataP: promise }, disposer);
} else if (InputValidators.isPath.validate(input)) {
// install from system path
const fileName = path.basename(input);
return await attemptInstall({ fileName, dataP: promise }, disposer);
}
await attemptInstall({ fileName, dataP: readFileNotify(input) });
} else if (InputValidators.isExtensionNameInstall.validate(input)) {
const [{ groups: { name, version }}] = [...input.matchAll(InputValidators.isExtensionNameInstallRegex)];
try {
await InputValidators.isPath.validate(input, {});
await attemptInstallByInfo({ name, version });
// install from system path
const fileName = path.basename(input);
return await attemptInstall({ fileName, dataP: readFileNotify(input) });
} catch (error) {
if (error instanceof AsyncInputValidationError) {
const extNameCaptures = InputValidators.isExtensionNameInstallRegex.captures(input);
if (extNameCaptures) {
const { name, version } = extNameCaptures;
return await attemptInstallByInfo({ name, version });
}
} else {
throw error;
}
}
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((
<p>
{"Installation has failed: "}
<b>{message}</b>
</p>
));
} finally {
disposer?.();
}
} catch (error) {
const message = getMessageFromError(error);
logger.info(`[EXTENSION-INSTALL]: installation has failed: ${message}`, { error, installPath: input });
Notifications.error(<p>Installation has failed: <b>{message}</b></p>);
} finally {
disposer?.();
}
};
);
@@ -9,7 +9,6 @@ import { prevDefault } from "../../utils";
import { Button } from "../button";
import { Icon } from "../icon";
import { observer } from "mobx-react";
import type { InputValidator } from "../input";
import { Input, InputValidators } from "../input";
import { SubTitle } from "../layout/sub-title";
import { TooltipPosition } from "../tooltip";
@@ -17,6 +16,7 @@ import type { ExtensionInstallationStateStore } from "../../../extensions/extens
import extensionInstallationStateStoreInjectable
from "../../../extensions/extension-installation-state-store/extension-installation-state-store.injectable";
import { withInjectables } from "@ogre-tools/injectable-react";
import { inputValidator } from "../input/input_validators";
export interface InstallProps {
installPath: string;
@@ -36,12 +36,12 @@ const installInputValidators = [
InputValidators.isExtensionNameInstall,
];
const installInputValidator: InputValidator = {
const installInputValidator = inputValidator({
message: "Invalid URL, absolute path, or extension name",
validate: (value: string) => (
installInputValidators.some(({ validate }) => validate(value))
validate: (value: string, props) => (
installInputValidators.some(({ validate }) => validate(value, props))
),
};
});
const NonInjectedInstall: React.FC<Dependencies & InstallProps> = ({
installPath,
@@ -71,14 +71,14 @@ const NonInjectedInstall: React.FC<Dependencies & InstallProps> = ({
value={installPath}
onChange={onChange}
onSubmit={installFromInput}
iconRight={
iconRight={(
<Icon
className={styles.icon}
material="folder_open"
onClick={prevDefault(installFromSelectFileDialog)}
tooltip="Browse"
/>
}
)}
/>
</div>
<div className="flex-initial">
@@ -95,7 +95,8 @@ const NonInjectedInstall: React.FC<Dependencies & InstallProps> = ({
</div>
</div>
<small className="mt-3">
<b>Pro-Tip</b>: you can drag-n-drop tarball-file to this area
<b>Pro-Tip</b>
: you can drag-n-drop tarball-file to this area
</small>
</section>
);
@@ -46,12 +46,6 @@ function getStatus(extension: InstalledExtension) {
}
const NonInjectedInstalledExtensions = observer(({ extensionDiscovery, extensionInstallationStateStore, extensions, uninstall, enable, disable }: Dependencies & InstalledExtensionsProps) => {
const filters = [
(extension: InstalledExtension) => extension.manifest.name,
(extension: InstalledExtension) => getStatus(extension),
(extension: InstalledExtension) => extension.manifest.version,
];
const columns = useMemo(
() => [
{
@@ -169,7 +163,11 @@ const NonInjectedInstalledExtensions = observer(({ extensionDiscovery, extension
columns={columns}
data={data}
items={extensions}
filters={filters}
filters={[
(extension) => extension.manifest.name,
(extension) => getStatus(extension),
(extension) => extension.manifest.version,
]}
/>
</section>
);
@@ -19,45 +19,61 @@ interface Dependencies {
extensionInstallationStateStore: ExtensionInstallationStateStore;
}
export const uninstallExtension =
({ extensionLoader, extensionDiscovery, extensionInstallationStateStore }: Dependencies) =>
async (extensionId: LensExtensionId): Promise<boolean> => {
const { manifest } = extensionLoader.getExtension(extensionId);
const displayName = extensionDisplayName(manifest.name, manifest.version);
export const uninstallExtension = ({
extensionLoader,
extensionDiscovery,
extensionInstallationStateStore,
}: Dependencies) => (
async (extensionId: LensExtensionId): Promise<boolean> => {
const ext = extensionLoader.getExtension(extensionId);
try {
logger.debug(`[EXTENSIONS]: trying to uninstall ${extensionId}`);
extensionInstallationStateStore.setUninstalling(extensionId);
if (!ext) {
logger.debug(`[EXTENSIONS]: cannot uninstall ${extensionId}, was not installed`);
await extensionDiscovery.uninstallExtension(extensionId);
return true;
}
// wait for the ExtensionLoader to actually uninstall the extension
await when(() => !extensionLoader.userExtensions.has(extensionId));
const { manifest } = ext;
const displayName = extensionDisplayName(manifest.name, manifest.version);
Notifications.ok(
<p>
Extension <b>{displayName}</b> successfully uninstalled!
</p>,
);
try {
logger.debug(`[EXTENSIONS]: trying to uninstall ${extensionId}`);
extensionInstallationStateStore.setUninstalling(extensionId);
return true;
} catch (error) {
const message = getMessageFromError(error);
await extensionDiscovery.uninstallExtension(extensionId);
logger.info(
`[EXTENSION-UNINSTALL]: uninstalling ${displayName} has failed: ${error}`,
{ error },
);
Notifications.error(
<p>
Uninstalling extension <b>{displayName}</b> has failed:{" "}
<em>{message}</em>
</p>,
);
// wait for the ExtensionLoader to actually uninstall the extension
await when(() => !extensionLoader.userExtensions.has(extensionId));
return false;
} finally {
Notifications.ok(
<p>
{"Extension "}
<b>{displayName}</b>
{" successfully uninstalled!"}
</p>,
);
return true;
} catch (error) {
const message = getMessageFromError(error);
logger.info(
`[EXTENSION-UNINSTALL]: uninstalling ${displayName} has failed: ${error}`,
{ error },
);
Notifications.error(
<p>
{"Uninstalling extension "}
<b>{displayName}</b>
{" has failed: "}
<em>{message}</em>
</p>,
);
return false;
} finally {
// Remove uninstall state on uninstall failure
extensionInstallationStateStore.clearUninstalling(extensionId);
}
};
extensionInstallationStateStore.clearUninstalling(extensionId);
}
}
);
@@ -8,14 +8,14 @@ import "./helm-chart-details.scss";
import React, { Component } from "react";
import type { HelmChart } from "../../../common/k8s-api/endpoints/helm-charts.api";
import { getChartDetails } from "../../../common/k8s-api/endpoints/helm-charts.api";
import { observable, makeObservable, reaction } from "mobx";
import { observable, reaction, runInAction } from "mobx";
import { disposeOnUnmount, observer } from "mobx-react";
import { Drawer, DrawerItem } from "../drawer";
import { autoBind, stopPropagation } from "../../utils";
import { MarkdownViewer } from "../markdown-viewer";
import { Spinner } from "../spinner";
import { Button } from "../button";
import { Select, type SelectOption } from "../select";
import { Select } from "../select";
import { Badge } from "../badge";
import { Tooltip, withStyles } from "@material-ui/core";
import { withInjectables } from "@ogre-tools/injectable-react";
@@ -39,11 +39,11 @@ interface Dependencies {
@observer
class NonInjectedHelmChartDetails extends Component<HelmChartDetailsProps & Dependencies> {
@observable chartVersions: HelmChart[];
@observable selectedChart?: HelmChart;
@observable readme?: string;
readonly chartVersions = observable.array<HelmChart>();
readonly selectedChart = observable.box<HelmChart | undefined>();
readonly readme = observable.box<string | undefined>(undefined);
private abortController?: AbortController;
private abortController = new AbortController();
constructor(props: HelmChartDetailsProps & Dependencies) {
super(props);
@@ -52,25 +52,28 @@ class NonInjectedHelmChartDetails extends Component<HelmChartDetailsProps & Depe
}
componentWillUnmount() {
this.abortController?.abort();
this.abortController.abort();
}
componentDidMount() {
disposeOnUnmount(this, [
reaction(() => this.props.chart, async ({ name, repo, version }) => {
try {
this.selectedChart = undefined;
this.chartVersions = undefined;
this.readme = undefined;
runInAction(() => {
this.selectedChart.set(undefined);
this.chartVersions.clear();
this.readme.set("");
});
try {
const { readme, versions } = await getChartDetails(repo, name, { version });
this.readme = readme;
this.chartVersions = versions;
this.selectedChart = versions[0];
runInAction(() => {
this.readme.set(readme);
this.chartVersions.replace(versions);
this.selectedChart.set(versions[0]);
});
} catch (error) {
Notifications.error(error);
this.selectedChart = null;
Notifications.checkedError(error, "Unknown error occured while getting chart details");
}
}, {
fireImmediately: true,
@@ -78,29 +81,33 @@ class NonInjectedHelmChartDetails extends Component<HelmChartDetailsProps & Depe
]);
}
async onVersionChange({ value: chart }: SelectOption<HelmChart>) {
this.selectedChart = chart;
this.readme = null;
async onVersionChange(c: HelmChart | null | undefined) {
const chart = c ?? this.chartVersions[0];
runInAction(() => {
this.selectedChart.set(chart ?? undefined);
this.readme.set(undefined);
});
try {
this.abortController?.abort();
this.abortController.abort();
this.abortController = new AbortController();
const { chart: { name, repo }} = this.props;
const { readme } = await getChartDetails(repo, name, { version: chart.version, reqInit: { signal: this.abortController.signal }});
this.readme = readme;
this.readme.set(readme);
} catch (error) {
Notifications.error(error);
Notifications.checkedError(error, "Unknown error occured while getting chart details");
}
}
install() {
this.props.createInstallChartTab(this.selectedChart);
install(selectedChart: HelmChart) {
this.props.createInstallChartTab(selectedChart);
this.props.hideDetails();
}
renderIntroduction() {
const { selectedChart, chartVersions, onVersionChange } = this;
renderIntroduction(selectedChart: HelmChart) {
const { chartVersions, onVersionChange } = this;
const placeholder = require("./helm-placeholder.svg");
return (
@@ -113,37 +120,57 @@ class NonInjectedHelmChartDetails extends Component<HelmChartDetailsProps & Depe
<div className="intro-contents box grow">
<div className="description flex align-center justify-space-between">
{selectedChart.getDescription()}
<Button primary label="Install" onClick={this.install} />
<Button
primary
label="Install"
onClick={() => this.install(selectedChart)}
/>
</div>
<DrawerItem name="Version" className="version" onClick={stopPropagation}>
<DrawerItem
name="Version"
className="version"
onClick={stopPropagation}
>
<Select
id="chart-version-input"
themeName="outlined"
menuPortalTarget={null}
options={chartVersions.map(chart => ({
label: (
chart.deprecated
? (
<LargeTooltip title="Deprecated" placement="left">
<span className="deprecated">{chart.version}</span>
</LargeTooltip>
)
: chart.version
),
value: chart,
}))}
isOptionDisabled={({ value: chart }) => chart.deprecated}
options={chartVersions.slice()}
getOptionLabel={chart => chart.version}
formatOptionLabel={chart => (
chart.deprecated
? (
<LargeTooltip title="Deprecated" placement="left">
<span className="deprecated">{chart.version}</span>
</LargeTooltip>
)
: chart.version
)}
isOptionDisabled={chart => chart.deprecated}
value={selectedChart}
onChange={onVersionChange}
/>
</DrawerItem>
<DrawerItem name="Home">
<a href={selectedChart.getHome()} target="_blank" rel="noreferrer">{selectedChart.getHome()}</a>
<a
href={selectedChart.getHome()}
target="_blank"
rel="noreferrer"
>
{selectedChart.getHome()}
</a>
</DrawerItem>
<DrawerItem name="Maintainers" className="maintainers">
{selectedChart.getMaintainers().map(({ name, email, url }) =>
<a key={name} href={url || `mailto:${email}`} target="_blank" rel="noreferrer">{name}</a>,
)}
{selectedChart.getMaintainers().map(({ name, email, url }) => (
<a
key={name}
href={url || `mailto:${email}`}
target="_blank"
rel="noreferrer"
>
{name}
</a>
))}
</DrawerItem>
{selectedChart.getKeywords().length > 0 && (
<DrawerItem name="Keywords" labelsOnly>
@@ -156,25 +183,29 @@ class NonInjectedHelmChartDetails extends Component<HelmChartDetailsProps & Depe
}
renderReadme() {
if (this.readme === null) {
const readme = this.readme.get();
if (readme === undefined) {
return <Spinner center />;
}
return (
<div className="chart-description">
<MarkdownViewer markdown={this.readme} />
<MarkdownViewer markdown={readme} />
</div>
);
}
renderContent() {
if (!this.selectedChart) {
const selectedChart = this.selectedChart.get();
if (!selectedChart) {
return <Spinner center />;
}
return (
<div className="box grow">
{this.renderIntroduction()}
{this.renderIntroduction(selectedChart)}
{this.renderReadme()}
</div>
);
@@ -182,14 +213,13 @@ class NonInjectedHelmChartDetails extends Component<HelmChartDetailsProps & Depe
render() {
const { chart, hideDetails } = this.props;
const title = chart ? `Chart: ${chart.getFullName()}` : "";
return (
<Drawer
className="HelmChartDetails"
usePortal={true}
open={!!chart}
title={title}
title={chart ? `Chart: ${chart.getFullName()}` : ""}
onClose={hideDetails}
>
{this.renderContent()}
@@ -40,7 +40,16 @@ export class HelmChartStore extends ItemStore<HelmChart> {
}
}
getByName(name: string, repo: string) {
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);
}
@@ -52,7 +61,7 @@ export class HelmChartStore extends ItemStore<HelmChart> {
};
async getVersions(chartName: string, force?: boolean): Promise<IChartVersion[]> {
let versions = this.versions.get(chartName);
const versions = this.versions.get(chartName);
if (versions && !force) {
return versions;
@@ -74,19 +83,26 @@ export class HelmChartStore extends ItemStore<HelmChart> {
.filter(chart => chart.getName() === chartName)
.map(chart => chart.getRepository());
versions = await Promise.all(repos.map(loadVersions))
const newVersions = await Promise.all(repos.map(loadVersions))
.then(flatten)
.then(this.sortVersions);
this.versions.set(chartName, versions);
this.versions.set(chartName, newVersions);
return versions;
return newVersions;
}
reset() {
super.reset();
this.versions.clear();
}
/**
* @deprecated Not supported
*/
removeItems(): Promise<void> {
throw new Error("removeItems is not supported");
}
}
export const helmChartStore = new HelmChartStore();
@@ -42,9 +42,14 @@ class NonInjectedHelmCharts extends Component<Dependencies> {
}
get selectedChart() {
const { chartName, repo } = this.props.routeParameters;
const chartName = this.props.routeParameters.chartName.get();
const repo = this.props.routeParameters.repo.get();
return helmChartStore.getByName(chartName.get(), repo.get());
if (!chartName || !repo) {
return undefined;
}
return helmChartStore.getByName(chartName, repo);
}
onDetails = (chart: HelmChart) => {
@@ -55,7 +60,7 @@ class NonInjectedHelmCharts extends Component<Dependencies> {
}
};
showDetails = (chart: HelmChart) => {
showDetails = (chart: HelmChart | null) => {
if (!chart) {
this.props.navigateToHelmCharts();
}
@@ -3,8 +3,9 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import type {
IReleaseCreatePayload } from "../../../../common/k8s-api/endpoints/helm-releases.api";
HelmReleaseCreatePayload } from "../../../../common/k8s-api/endpoints/helm-releases.api";
import {
createRelease,
} from "../../../../common/k8s-api/endpoints/helm-releases.api";
@@ -16,7 +17,7 @@ const createReleaseInjectable = getInjectable({
instantiate: (di) => {
const releases = di.inject(releasesInjectable);
return async (payload: IReleaseCreatePayload) => {
return async (payload: HelmReleaseCreatePayload) => {
const release = await createRelease(payload);
releases.invalidate();
@@ -0,0 +1,141 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import "./dialog.scss";
import React from "react";
import type { IObservableValue } from "mobx";
import { observable, runInAction } from "mobx";
import { observer } from "mobx-react";
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 rollbackReleaseInjectable from "../rollback-release/rollback-release.injectable";
export interface ReleaseRollbackDialogProps extends DialogProps {
}
interface Dependencies {
rollbackRelease: (releaseName: string, namespace: string, revisionNumber: number) => Promise<void>;
state: IObservableValue<HelmRelease | undefined>;
}
@observer
class NonInjectedReleaseRollbackDialog extends React.Component<ReleaseRollbackDialogProps & Dependencies> {
readonly isLoading = observable.box(false);
readonly revision = observable.box<HelmReleaseRevision | undefined>();
readonly revisions = observable.array<HelmReleaseRevision>();
close = () => {
this.props.state.set(undefined);
};
onOpen = async (release: HelmRelease) => {
this.isLoading.set(true);
const releases = await getReleaseHistory(release.getName(), release.getNs());
runInAction(() => {
this.revisions.replace(orderBy(releases, "revision", "desc"));
this.revision.set(this.revisions[0]);
this.isLoading.set(false);
});
};
rollback = async (release: HelmRelease) => {
const revision = this.revision.get();
if (!revision) {
return;
}
try {
await this.props.rollbackRelease(release.getName(), release.getNs(), revision.revision);
this.close();
} catch (err) {
Notifications.checkedError(err, "Unknown error occured while rolling back release");
}
};
renderRevisionContent() {
const revision = this.revision.get();
if (!revision) {
return <p>No revisions to rollback.</p>;
}
return (
<div className="flex gaps align-center">
<b>Revision</b>
<Select
themeName="light"
value={revision}
options={this.revisions}
formatOptionLabel={value => `${value.revision} - ${value.chart} - ${value.app_version}, updated: ${new Date(value.updated).toLocaleString()}`}
onChange={value => this.revision.set(value ?? undefined)}
/>
</div>
);
}
renderContent(release: HelmRelease) {
return (
<Wizard
header={(
<h5>
Rollback
<b>{release.getName()}</b>
</h5>
)}
done={this.close}
>
<WizardStep
scrollable={false}
nextLabel="Rollback"
next={() => this.rollback(release)}
loading={this.isLoading.get()}
>
{this.renderRevisionContent()}
</WizardStep>
</Wizard>
);
}
render() {
const { state, ...dialogProps } = this.props;
const release = state.get();
return (
<Dialog
{...dialogProps}
className="ReleaseRollbackDialog"
isOpen={Boolean(release)}
onOpen={release ? (() => this.onOpen(release)) : undefined}
close={this.close}
>
{release && this.renderContent(release)}
</Dialog>
);
}
}
export const ReleaseRollbackDialog = withInjectables<Dependencies, ReleaseRollbackDialogProps>(
NonInjectedReleaseRollbackDialog,
{
getProps: (di, props) => ({
rollbackRelease: di.inject(rollbackReleaseInjectable),
state: di.inject(releaseRollbackDialogStateInjectable),
...props,
}),
},
);
@@ -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 type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api";
import releaseRollbackDialogStateInjectable from "./state.injectable";
export type OpenHelmReleaseRollbackDialog = (release: HelmRelease) => void;
const openHelmReleaseRollbackDialogInjectable = getInjectable({
id: "open-helm-release-dialog",
instantiate: (di): OpenHelmReleaseRollbackDialog => {
const state = di.inject(releaseRollbackDialogStateInjectable);
return release => state.set(release);
},
});
export default openHelmReleaseRollbackDialogInjectable;
@@ -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 { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api";
const releaseRollbackDialogStateInjectable = getInjectable({
id: "release-rollback-dialog-state",
instantiate: () => observable.box<HelmRelease | undefined>(undefined),
});
export default releaseRollbackDialogStateInjectable;
@@ -6,16 +6,19 @@ import { getInjectable } from "@ogre-tools/injectable";
import { getRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api";
import { asyncComputed } from "@ogre-tools/injectable-react";
import releaseInjectable from "./release.injectable";
import { waitUntilDefinied } from "../../../utils";
const releaseDetailsInjectable = getInjectable({
id: "release-details",
instantiate: (di) =>
asyncComputed(async () => {
const release = di.inject(releaseInjectable).get();
instantiate: (di) => {
const releaseComputed = di.inject(releaseInjectable);
return await getRelease(release.name, release.namespace);
}),
return asyncComputed(async () => {
const release = await waitUntilDefinied(releaseComputed);
return getRelease(release.name, release.namespace);
});},
});
export default releaseDetailsInjectable;
@@ -11,7 +11,7 @@ import type { IComputedValue } from "mobx";
import { computed, makeObservable, observable } from "mobx";
import { Link } from "react-router-dom";
import kebabCase from "lodash/kebabCase";
import type { HelmRelease, IReleaseDetails, IReleaseUpdateDetails, IReleaseUpdatePayload } from "../../../../common/k8s-api/endpoints/helm-releases.api";
import type { HelmRelease, HelmReleaseDetails, HelmReleaseUpdateDetails, HelmReleaseUpdatePayload } from "../../../../common/k8s-api/endpoints/helm-releases.api";
import { HelmReleaseMenu } from "../release-menu";
import { Drawer, DrawerItem, DrawerTitle } from "../../drawer";
import { Badge } from "../../badge";
@@ -35,18 +35,19 @@ import releaseInjectable from "./release.injectable";
import releaseDetailsInjectable from "./release-details.injectable";
import releaseValuesInjectable from "./release-values.injectable";
import userSuppliedValuesAreShownInjectable from "./user-supplied-values-are-shown.injectable";
import type { KubeObject } from "../../../../common/k8s-api/kube-object";
import { KubeObjectAge } from "../../kube-object/age";
import type { KubeJsonApiData } from "../../../../common/k8s-api/kube-json-api";
import { entries } from "../../../../common/utils/objects";
export interface ReleaseDetailsProps {
hideDetails(): void;
}
interface Dependencies {
release: IComputedValue<HelmRelease>;
releaseDetails: IAsyncComputed<IReleaseDetails>;
release: IComputedValue<HelmRelease | null | undefined>;
releaseDetails: IAsyncComputed<HelmReleaseDetails>;
releaseValues: IAsyncComputed<string>;
updateRelease: (name: string, namespace: string, payload: IReleaseUpdatePayload) => Promise<IReleaseUpdateDetails>;
updateRelease: (name: string, namespace: string, payload: HelmReleaseUpdatePayload) => Promise<HelmReleaseUpdateDetails>;
createUpgradeChartTab: (release: HelmRelease) => void;
userSuppliedValuesAreShown: { toggle: () => void; value: boolean };
}
@@ -55,28 +56,24 @@ interface Dependencies {
class NonInjectedReleaseDetails extends Component<ReleaseDetailsProps & Dependencies> {
@observable saving = false;
private nonSavedValues: string;
private nonSavedValues = "";
constructor(props: ReleaseDetailsProps & Dependencies) {
super(props);
makeObservable(this);
}
@computed get release() {
return this.props.release.get();
}
@computed get details() {
return this.props.releaseDetails.value.get();
}
updateValues = async () => {
const name = this.release.getName();
const namespace = this.release.getNs();
updateValues = async (release: HelmRelease) => {
const name = release.getName();
const namespace = release.getNs();
const data = {
chart: this.release.getChart(),
repo: await this.release.getRepo(),
version: this.release.getVersion(),
chart: release.getChart(),
repo: await release.getRepo(),
version: release.getVersion(),
values: this.nonSavedValues,
};
@@ -85,24 +82,28 @@ class NonInjectedReleaseDetails extends Component<ReleaseDetailsProps & Dependen
try {
await this.props.updateRelease(name, namespace, data);
Notifications.ok(
<p>Release <b>{name}</b> successfully updated!</p>,
<p>
Release
<b>{name}</b>
{" successfully updated!"}
</p>,
);
this.props.releaseValues.invalidate();
} catch (err) {
Notifications.error(err);
Notifications.checkedError(err, "Unknown error occured while updating release");
}
this.saving = false;
};
upgradeVersion = () => {
const { hideDetails } = this.props;
upgradeVersion = (release: HelmRelease) => {
const { hideDetails, createUpgradeChartTab } = this.props;
this.props.createUpgradeChartTab(this.release);
createUpgradeChartTab(release);
hideDetails();
};
renderValues() {
renderValues(release: HelmRelease) {
return (
<Observer>
{() => {
@@ -133,7 +134,7 @@ class NonInjectedReleaseDetails extends Component<ReleaseDetailsProps & Dependen
label="Save"
waiting={saving}
disabled={releaseValuesArePending}
onClick={this.updateValues}
onClick={() => this.updateValues(release)}
/>
</div>
</div>
@@ -154,28 +155,27 @@ class NonInjectedReleaseDetails extends Component<ReleaseDetailsProps & Dependen
);
}
renderResources(resources: KubeObject[]) {
renderResources(resources: KubeJsonApiData[]) {
return (
<div className="resources">
{
Object.entries(groupBy(resources, item => item.kind))
entries(groupBy(resources, item => item.kind))
.map(([kind, items]) => (
<React.Fragment key={kind}>
<SubTitle title={kind} />
<Table scrollable={false}>
<TableHead sticky={false}>
<TableCell className="name">Name</TableCell>
{items[0].getNs() && <TableCell className="namespace">Namespace</TableCell>}
{items[0].metadata.namespace && <TableCell className="namespace">Namespace</TableCell>}
<TableCell className="age">Age</TableCell>
</TableHead>
{items.map(item => {
const name = item.getName();
const namespace = item.getNs();
const { name, namespace, uid } = item.metadata;
const api = apiManager.getApi(api => api.kind === kind && api.apiVersionWithGroup == item.apiVersion);
const detailsUrl = api ? getDetailsUrl(api.getUrl({ name, namespace })) : "";
return (
<TableRow key={item.getId()}>
<TableRow key={uid}>
<TableCell className="name">
{detailsUrl ? <Link to={detailsUrl}>{name}</Link> : name}
</TableCell>
@@ -198,9 +198,7 @@ class NonInjectedReleaseDetails extends Component<ReleaseDetailsProps & Dependen
);
}
renderContent() {
if (!this.release) return null;
renderContent(release: HelmRelease) {
if (!this.details) {
return <Spinner center/>;
}
@@ -211,35 +209,40 @@ class NonInjectedReleaseDetails extends Component<ReleaseDetailsProps & Dependen
<div>
<DrawerItem name="Chart" className="chart">
<div className="flex gaps align-center">
<span>{this.release.getChart()}</span>
<span>{release.getChart()}</span>
<Button
primary
label="Upgrade"
className="box right upgrade"
onClick={this.upgradeVersion}
onClick={() => this.upgradeVersion(release)}
/>
</div>
</DrawerItem>
<DrawerItem name="Updated">
{this.release.getUpdated()} ago ({this.release.updated})
{release.getUpdated()}
{` ago (${release.updated})`}
</DrawerItem>
<DrawerItem name="Namespace">
{this.release.getNs()}
{release.getNs()}
</DrawerItem>
<DrawerItem name="Version" onClick={stopPropagation}>
<div className="version flex gaps align-center">
<span>
{this.release.getVersion()}
{release.getVersion()}
</span>
</div>
</DrawerItem>
<DrawerItem name="Status" className="status" labelsOnly>
<DrawerItem
name="Status"
className="status"
labelsOnly
>
<Badge
label={this.release.getStatus()}
className={kebabCase(this.release.getStatus())}
label={release.getStatus()}
className={kebabCase(release.getStatus())}
/>
</DrawerItem>
{this.renderValues()}
{this.renderValues(release)}
<DrawerTitle>Notes</DrawerTitle>
{this.renderNotes()}
<DrawerTitle>Resources</DrawerTitle>
@@ -250,38 +253,37 @@ class NonInjectedReleaseDetails extends Component<ReleaseDetailsProps & Dependen
render() {
const { hideDetails } = this.props;
const title = this.release ? `Release: ${this.release.getName()}` : "";
const toolbar = <HelmReleaseMenu release={this.release} toolbar hideDetails={hideDetails}/>;
const release = this.props.release.get();
return (
<Drawer
className={cssNames("ReleaseDetails", ThemeStore.getInstance().activeTheme.type)}
usePortal={true}
open={!!this.release}
title={title}
open={Boolean(release)}
title={release ? `Release: ${release.getName()}` : ""}
onClose={hideDetails}
toolbar={toolbar}
toolbar={release && (
<HelmReleaseMenu
release={release}
toolbar
hideDetails={hideDetails}
/>
)}
>
{this.renderContent()}
{release && this.renderContent(release)}
</Drawer>
);
}
}
export const ReleaseDetails = withInjectables<Dependencies, ReleaseDetailsProps>(
NonInjectedReleaseDetails,
{
getProps: (di, props) => ({
release: di.inject(releaseInjectable),
releaseDetails: di.inject(releaseDetailsInjectable),
releaseValues: di.inject(releaseValuesInjectable),
userSuppliedValuesAreShown: di.inject(userSuppliedValuesAreShownInjectable),
updateRelease: di.inject(updateReleaseInjectable),
createUpgradeChartTab: di.inject(createUpgradeChartTabInjectable),
...props,
}),
},
);
export const ReleaseDetails = withInjectables<Dependencies, ReleaseDetailsProps>(NonInjectedReleaseDetails, {
getProps: (di, props) => ({
...props,
release: di.inject(releaseInjectable),
releaseDetails: di.inject(releaseDetailsInjectable),
releaseValues: di.inject(releaseValuesInjectable),
userSuppliedValuesAreShown: di.inject(userSuppliedValuesAreShownInjectable),
updateRelease: di.inject(updateReleaseInjectable),
createUpgradeChartTab: di.inject(createUpgradeChartTabInjectable),
}),
});
@@ -12,8 +12,9 @@ import { MenuItem } from "../menu";
import { Icon } from "../icon";
import { withInjectables } from "@ogre-tools/injectable-react";
import createUpgradeChartTabInjectable from "../dock/upgrade-chart/create-upgrade-chart-tab.injectable";
import releaseRollbackDialogModelInjectable from "./release-rollback-dialog-model/release-rollback-dialog-model.injectable";
import deleteReleaseInjectable from "./delete-release/delete-release.injectable";
import type { OpenHelmReleaseRollbackDialog } from "./dialog/open.injectable";
import openHelmReleaseRollbackDialogInjectable from "./dialog/open.injectable";
export interface HelmReleaseMenuProps extends MenuActionsProps {
release: HelmRelease;
@@ -23,7 +24,7 @@ export interface HelmReleaseMenuProps extends MenuActionsProps {
interface Dependencies {
deleteRelease: (release: HelmRelease) => Promise<any>;
createUpgradeChartTab: (release: HelmRelease) => void;
openRollbackDialog: (release: HelmRelease) => void;
openRollbackDialog: OpenHelmReleaseRollbackDialog;
}
class NonInjectedHelmReleaseMenu extends React.Component<HelmReleaseMenuProps & Dependencies> {
@@ -52,12 +53,20 @@ class NonInjectedHelmReleaseMenu extends React.Component<HelmReleaseMenuProps &
<>
{hasRollback && (
<MenuItem onClick={this.rollback}>
<Icon material="history" interactive={toolbar} tooltip="Rollback"/>
<Icon
material="history"
interactive={toolbar}
tooltip="Rollback"
/>
<span className="title">Rollback</span>
</MenuItem>
)}
<MenuItem onClick={this.upgrade}>
<Icon material="refresh" interactive={toolbar} tooltip="Upgrade"/>
<Icon
material="refresh"
interactive={toolbar}
tooltip="Upgrade"
/>
<span className="title">Upgrade</span>
</MenuItem>
</>
@@ -72,7 +81,13 @@ class NonInjectedHelmReleaseMenu extends React.Component<HelmReleaseMenuProps &
{...menuProps}
className={cssNames("HelmReleaseMenu", className)}
removeAction={this.remove}
removeConfirmationMessage={() => <p>Remove Helm Release <b>{release.name}</b>?</p>}
removeConfirmationMessage={() => (
<p>
Remove Helm Release
<b>{release.name}</b>
?
</p>
)}
>
{this.renderContent()}
</MenuActions>
@@ -80,16 +95,11 @@ class NonInjectedHelmReleaseMenu extends React.Component<HelmReleaseMenuProps &
}
}
export const HelmReleaseMenu = withInjectables<Dependencies, HelmReleaseMenuProps>(
NonInjectedHelmReleaseMenu,
{
getProps: (di, props) => ({
deleteRelease: di.inject(deleteReleaseInjectable),
createUpgradeChartTab: di.inject(createUpgradeChartTabInjectable),
openRollbackDialog: di.inject(releaseRollbackDialogModelInjectable).open,
...props,
}),
},
);
export const HelmReleaseMenu = withInjectables<Dependencies, HelmReleaseMenuProps>(NonInjectedHelmReleaseMenu, {
getProps: (di, props) => ({
...props,
deleteRelease: di.inject(deleteReleaseInjectable),
createUpgradeChartTab: di.inject(createUpgradeChartTabInjectable),
openRollbackDialog: di.inject(openHelmReleaseRollbackDialogInjectable),
}),
});
@@ -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 { ReleaseRollbackDialogModel } from "./release-rollback-dialog-model";
const releaseRollbackDialogModelInjectable = getInjectable({
id: "release-rollback-dialog-model",
instantiate: () => new ReleaseRollbackDialogModel(),
});
export default releaseRollbackDialogModelInjectable;
@@ -1,31 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { computed, observable, makeObservable, action } from "mobx";
import type { HelmRelease } from "../../../../common/k8s-api/endpoints/helm-releases.api";
export class ReleaseRollbackDialogModel {
release: HelmRelease | null = null;
constructor() {
makeObservable(this, {
isOpen: computed,
release: observable,
open: action,
close: action,
});
}
get isOpen() {
return !!this.release;
}
open = (release: HelmRelease) => {
this.release = release;
};
close = () => {
this.release = null;
};
}
@@ -1,131 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import "./release-rollback-dialog.scss";
import React from "react";
import { observable, makeObservable } from "mobx";
import { observer } from "mobx-react";
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 IReleaseRevision } from "../../../common/k8s-api/endpoints/helm-releases.api";
import type { SelectOption } from "../select";
import { Select } from "../select";
import { Notifications } from "../notifications";
import orderBy from "lodash/orderBy";
import { withInjectables } from "@ogre-tools/injectable-react";
import releaseRollbackDialogModelInjectable
from "./release-rollback-dialog-model/release-rollback-dialog-model.injectable";
import type { ReleaseRollbackDialogModel } from "./release-rollback-dialog-model/release-rollback-dialog-model";
import rollbackReleaseInjectable from "./rollback-release/rollback-release.injectable";
export interface ReleaseRollbackDialogProps extends DialogProps {
}
interface Dependencies {
rollbackRelease: (releaseName: string, namespace: string, revisionNumber: number) => Promise<void>;
model: ReleaseRollbackDialogModel;
}
@observer
class NonInjectedReleaseRollbackDialog extends React.Component<ReleaseRollbackDialogProps & Dependencies> {
@observable isLoading = false;
@observable revision: IReleaseRevision;
@observable revisions = observable.array<IReleaseRevision>();
constructor(props: ReleaseRollbackDialogProps & Dependencies) {
super(props);
makeObservable(this);
}
get release(): HelmRelease {
return this.props.model.release;
}
onOpen = async () => {
this.isLoading = true;
let releases = await getReleaseHistory(this.release.getName(), this.release.getNs());
releases = orderBy(releases, "revision", "desc"); // sort
this.revisions.replace(releases);
this.revision = this.revisions[0];
this.isLoading = false;
};
rollback = async () => {
const revisionNumber = this.revision.revision;
try {
await this.props.rollbackRelease(this.release.getName(), this.release.getNs(), revisionNumber);
this.props.model.close();
} catch (err) {
Notifications.error(err);
}
};
renderContent() {
const { revision, revisions } = this;
if (!revision) {
return <p>No revisions to rollback.</p>;
}
return (
<div className="flex gaps align-center">
<b>Revision</b>
<Select
id="revision-input"
themeName="light"
value={revision}
options={revisions}
formatOptionLabel={({ value }: SelectOption<IReleaseRevision>) => `${value.revision} - ${value.chart}
- ${value.app_version}, updated: ${new Date(value.updated).toLocaleString()}`}
onChange={({ value }: SelectOption<IReleaseRevision>) => this.revision = value}
/>
</div>
);
}
render() {
const { ...dialogProps } = this.props;
const releaseName = this.release ? this.release.getName() : "";
const header = <h5>Rollback <b>{releaseName}</b></h5>;
return (
<Dialog
{...dialogProps}
className="ReleaseRollbackDialog"
isOpen={this.props.model.isOpen}
onOpen={this.onOpen}
close={this.props.model.close}
>
<Wizard header={header} done={this.props.model.close}>
<WizardStep
scrollable={false}
nextLabel="Rollback"
next={this.rollback}
loading={this.isLoading}
>
{this.renderContent()}
</WizardStep>
</Wizard>
</Dialog>
);
}
}
export const ReleaseRollbackDialog = withInjectables<Dependencies, ReleaseRollbackDialogProps>(
NonInjectedReleaseRollbackDialog,
{
getProps: (di, props) => ({
rollbackRelease: di.inject(rollbackReleaseInjectable),
model: di.inject(releaseRollbackDialogModelInjectable),
...props,
}),
},
);
@@ -21,7 +21,7 @@ const releasesInjectable = getInjectable({
const isLoadingAll =
clusterContext.allNamespaces?.length > 1 &&
clusterContext.cluster.accessibleNamespaces.length === 0 &&
clusterContext.cluster?.accessibleNamespaces.length === 0 &&
clusterContext.allNamespaces.every((namespace) =>
contextNamespaces.includes(namespace),
);
@@ -10,12 +10,12 @@ import React, { Component } from "react";
import type { HelmRelease } from "../../../common/k8s-api/endpoints/helm-releases.api";
import { withInjectables } from "@ogre-tools/injectable-react";
import namespaceStoreInjectable from "../+namespaces/namespace-store/namespace-store.injectable";
import type { ItemListStore } from "../item-object-list";
import { ItemListLayout } from "../item-object-list";
import { NamespaceSelectFilter } from "../+namespaces/namespace-select-filter";
import { kebabCase } from "lodash/fp";
import { HelmReleaseMenu } from "./release-menu";
import type { ItemStore } from "../../../common/item.store";
import { ReleaseRollbackDialog } from "./release-rollback-dialog";
import { ReleaseRollbackDialog } from "./dialog/dialog";
import { ReleaseDetails } from "./release-details/release-details";
import removableReleasesInjectable from "./removable-releases.injectable";
import type { RemovableHelmRelease } from "./removable-releases";
@@ -75,7 +75,11 @@ class NonInjectedHelmReleases extends Component<Dependencies> {
return (
<div>
<>Remove <b>{releaseNames}</b>?</>
<>
Remove
<b>{releaseNames}</b>
?
</>
<p className="warning">
Note: StatefulSet Volumes won&apos;t be deleted automatically
</p>
@@ -88,13 +92,7 @@ class NonInjectedHelmReleases extends Component<Dependencies> {
const releasesArePending = this.props.releasesArePending;
// TODO: Implement ItemListLayout without stateful stores
const legacyReleaseStore = {
get items() {
return releases.get();
},
loadAll: () => Promise.resolve(),
const legacyReleaseStore: ItemListStore<RemovableHelmRelease, false> = {
get isLoaded() {
return !releasesArePending.get();
},
@@ -103,49 +101,45 @@ class NonInjectedHelmReleases extends Component<Dependencies> {
getTotalCount: () => releases.get().length,
toggleSelection: (item) => {
item.toggle();
},
toggleSelection: (release) => release.toggle(),
isSelectedAll: (visibleItems: RemovableHelmRelease[]) => (
visibleItems.length > 0
&& visibleItems.every((release) => release.isSelected)
isSelectedAll: (releases) => (
releases.length > 0
&& releases.every((release) => release.isSelected)
),
toggleSelectionAll: (visibleItems: RemovableHelmRelease[]) => {
toggleSelectionAll: (releases) => {
let selected = false;
if (!legacyReleaseStore.isSelectedAll(visibleItems)) {
if (!legacyReleaseStore.isSelectedAll(releases)) {
selected = true;
}
visibleItems.forEach((release) => {
for (const release of releases) {
if (release.isSelected !== selected) {
release.toggle();
}
});
}
},
isSelected: (item) => item.isSelected,
isSelected: (release) => release.isSelected,
get selectedItems() {
return releases.get().filter((release) => release.isSelected);
removeSelectedItems: async () => {
await Promise.all(
releases.get()
.filter((release) => release.isSelected)
.map(release => release.delete()),
);
},
pickOnlySelected: (releases) => {
return releases.filter(release => release.isSelected);
},
removeItems: async (releases) => {
await Promise.all(releases.map(release => release.delete()));
},
} as ItemStore<RemovableHelmRelease>;
pickOnlySelected: (releases) => releases.filter(release => release.isSelected),
};
return (
<SiblingsInTabLayout>
<ItemListLayout
<ItemListLayout<RemovableHelmRelease, false>
store={legacyReleaseStore}
getItems={() => legacyReleaseStore.items}
getItems={() => releases.get()}
preloadStores={false}
isConfigurable
tableId="helm_releases"
@@ -3,8 +3,9 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import type {
IReleaseUpdatePayload } from "../../../../common/k8s-api/endpoints/helm-releases.api";
HelmReleaseUpdatePayload } from "../../../../common/k8s-api/endpoints/helm-releases.api";
import {
updateRelease,
} from "../../../../common/k8s-api/endpoints/helm-releases.api";
@@ -19,7 +20,7 @@ const updateReleaseInjectable = getInjectable({
return async (
name: string,
namespace: string,
payload: IReleaseUpdatePayload,
payload: HelmReleaseUpdatePayload,
) => {
const result = await updateRelease(name, namespace, payload);
@@ -24,7 +24,7 @@ import type { NamespaceStore } from "./namespace-store/namespace.store";
export interface AddNamespaceDialogProps extends DialogProps {
onSuccess?(ns: Namespace): void;
onError?(error: any): void;
onError?(error: unknown): void;
}
interface Dependencies {
@@ -55,7 +55,7 @@ class NonInjectedAddNamespaceDialog extends React.Component<AddNamespaceDialogPr
onSuccess?.(created);
this.props.model.close();
} catch (err) {
Notifications.error(err);
Notifications.checkedError(err, "Unknown error occured while creating the namespace");
onError?.(err);
}
};
@@ -80,12 +80,14 @@ class NonInjectedAddNamespaceDialog extends React.Component<AddNamespaceDialogPr
next={this.addNamespace}
>
<Input
required autoFocus
required
autoFocus
iconLeft="layers"
placeholder="Namespace"
trim
validators={systemName}
value={namespace} onChange={v => this.namespace = v.toLowerCase()}
value={namespace}
onChange={v => this.namespace = v.toLowerCase()}
/>
</WizardStep>
</Wizard>
@@ -9,9 +9,8 @@ import React from "react";
import { computed, makeObservable, observable, reaction } from "mobx";
import { disposeOnUnmount, observer } from "mobx-react";
import { DrawerItem } from "../drawer";
import type { Disposer } from "../../utils";
import { cssNames } from "../../utils";
import { getMetricsForNamespace, type IPodMetrics, Namespace } from "../../../common/k8s-api/endpoints";
import { cssNames } from "../../utils";
import { getMetricsForNamespace, type PodMetricData, Namespace } from "../../../common/k8s-api/endpoints";
import type { KubeObjectDetailsProps } from "../kube-object-details";
import { Link } from "react-router-dom";
import { Spinner } from "../spinner";
@@ -24,22 +23,21 @@ import { ClusterMetricsResourceType } from "../../../common/cluster-types";
import { getActiveClusterEntity } from "../../api/catalog-entity-registry";
import { getDetailsUrl } from "../kube-detail-params";
import logger from "../../../common/logger";
import type { KubeObjectStore } from "../../../common/k8s-api/kube-object.store";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
import { withInjectables } from "@ogre-tools/injectable-react";
import kubeWatchApiInjectable
from "../../kube-watch-api/kube-watch-api.injectable";
import type { SubscribeStores } from "../../kube-watch-api/kube-watch-api";
export interface NamespaceDetailsProps extends KubeObjectDetailsProps<Namespace> {
}
interface Dependencies {
subscribeStores: (stores: KubeObjectStore<KubeObject>[]) => Disposer;
subscribeStores: SubscribeStores;
}
@observer
class NonInjectedNamespaceDetails extends React.Component<NamespaceDetailsProps & Dependencies> {
@observable metrics: IPodMetrics = null;
@observable metrics: PodMetricData | null = null;
constructor(props: NamespaceDetailsProps & Dependencies) {
super(props);
@@ -96,7 +94,9 @@ class NonInjectedNamespaceDetails extends React.Component<NamespaceDetailsProps
{!isMetricHidden && (
<ResourceMetrics
loader={this.loadMetrics}
tabs={podMetricTabs} object={namespace} params={{ metrics: this.metrics }}
tabs={podMetricTabs}
object={namespace}
metrics={this.metrics}
>
<PodCharts />
</ResourceMetrics>
@@ -110,7 +110,7 @@ class NonInjectedNamespaceDetails extends React.Component<NamespaceDetailsProps
<DrawerItem name="Resource Quotas" className="quotas flex align-center">
{!this.quotas && resourceQuotaStore.isLoading && <Spinner/>}
{this.quotas.map(quota => {
return (
return quota.selfLink && (
<Link key={quota.getId()} to={getDetailsUrl(quota.selfLink)}>
{quota.getName()}
</Link>
@@ -120,7 +120,7 @@ class NonInjectedNamespaceDetails extends React.Component<NamespaceDetailsProps
<DrawerItem name="Limit Ranges">
{!this.limitranges && limitRangeStore.isLoading && <Spinner/>}
{this.limitranges.map(limitrange => {
return (
return limitrange.selfLink && (
<Link key={limitrange.getId()} to={getDetailsUrl(limitrange.selfLink)}>
{limitrange.getName()}
</Link>
@@ -1,95 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { observable, makeObservable, action, untracked } from "mobx";
import type { NamespaceStore } from "../namespace-store/namespace.store";
import type { SelectOption } from "../../select";
import { isMac } from "../../../../common/vars";
interface Dependencies {
namespaceStore: NamespaceStore;
}
export class NamespaceSelectFilterModel {
constructor(private dependencies: Dependencies) {
makeObservable(this, {
menuIsOpen: observable,
closeMenu: action,
openMenu: action,
reset: action,
});
}
menuIsOpen = false;
closeMenu = () => {
this.menuIsOpen = false;
};
openMenu = () => {
this.menuIsOpen = true;
};
get selectedNames() {
return untracked(() => this.dependencies.namespaceStore.selectedNames);
}
isSelected = (namespace: string | string[]) =>
this.dependencies.namespaceStore.hasContext(namespace);
selectSingle = (namespace: string) => {
this.dependencies.namespaceStore.selectSingle(namespace);
};
selectAll = () => {
this.dependencies.namespaceStore.selectAll();
};
onChange = ([{ value: namespace }]: SelectOption[]) => {
if (namespace) {
if (this.isMultiSelection) {
this.dependencies.namespaceStore.toggleSingle(namespace);
} else {
this.dependencies.namespaceStore.selectSingle(namespace);
}
} else {
this.dependencies.namespaceStore.selectAll();
}
};
onClick = () => {
if (!this.menuIsOpen) {
this.openMenu();
} else if (!this.isMultiSelection) {
this.closeMenu();
}
};
private isMultiSelection = false;
onKeyDown = (event: React.KeyboardEvent) => {
if (isSelectionKey(event)) {
this.isMultiSelection = true;
}
};
onKeyUp = (event: React.KeyboardEvent) => {
if (isSelectionKey(event)) {
this.isMultiSelection = false;
}
};
reset = () => {
this.isMultiSelection = false;
this.closeMenu();
};
}
const isSelectionKey = (event: React.KeyboardEvent): boolean => {
if (isMac) {
return event.key === "Meta";
}
return event.key === "Control"; // windows or linux
};
@@ -0,0 +1,155 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import React from "react";
import { observable, makeObservable, action, untracked, computed } from "mobx";
import type { NamespaceStore } from "../namespace-store/namespace.store";
import { isMac } from "../../../../common/vars";
import type { ActionMeta } from "react-select";
import { Icon } from "../../icon";
interface Dependencies {
readonly namespaceStore: NamespaceStore;
}
export const selectAllNamespaces = Symbol("all-namespaces-selected");
export type SelectAllNamespaces = typeof selectAllNamespaces;
export class NamespaceSelectFilterModel {
constructor(private readonly dependencies: Dependencies) {
makeObservable(this, {
menuIsOpen: observable,
closeMenu: action,
openMenu: action,
reset: action,
});
}
readonly options = computed(() => {
const baseOptions = this.dependencies.namespaceStore.items.map(ns => ns.getName());
baseOptions.sort((
(left, right) =>
+this.selectedNames.has(right)
- +this.selectedNames.has(left)
));
return [selectAllNamespaces, ...baseOptions] as const;
});
formatOptionLabel = (option: string | SelectAllNamespaces) => {
if (option === selectAllNamespaces) {
return "All Namespaces";
}
const isSelected = this.isSelected(option);
return (
<div className="flex gaps align-center">
<Icon small material="layers" />
<span>{option}</span>
{isSelected && (
<Icon
small
material="check"
className="box right"
/>
)}
</div>
);
};
getOptionLabel = (option: string | SelectAllNamespaces) => {
if (option === selectAllNamespaces) {
return "All Namespaces";
}
return option;
};
menuIsOpen = false;
closeMenu = () => {
this.menuIsOpen = false;
};
openMenu = () => {
this.menuIsOpen = true;
};
get selectedNames() {
return untracked(() => this.dependencies.namespaceStore.selectedNames);
}
isSelected = (namespace: string | string[]) =>
this.dependencies.namespaceStore.hasContext(namespace);
selectSingle = (namespace: string) => {
this.dependencies.namespaceStore.selectSingle(namespace);
};
selectAll = () => {
this.dependencies.namespaceStore.selectAll();
};
onChange = (namespace: unknown, action: ActionMeta<string | SelectAllNamespaces>) => {
switch (action.action) {
case "clear":
this.dependencies.namespaceStore.selectAll();
break;
case "deselect-option":
if (typeof action.option === "string") {
this.dependencies.namespaceStore.toggleSingle(action.option);
}
break;
case "select-option":
if (action.option === selectAllNamespaces) {
this.dependencies.namespaceStore.selectAll();
} else if (action.option) {
if (this.isMultiSelection) {
this.dependencies.namespaceStore.toggleSingle(action.option);
} else {
this.dependencies.namespaceStore.selectSingle(action.option);
}
}
break;
}
};
onClick = () => {
if (!this.menuIsOpen) {
this.openMenu();
} else if (!this.isMultiSelection) {
this.closeMenu();
}
};
private isMultiSelection = false;
onKeyDown = (event: React.KeyboardEvent) => {
if (isSelectionKey(event)) {
this.isMultiSelection = true;
}
};
onKeyUp = (event: React.KeyboardEvent) => {
if (isSelectionKey(event)) {
this.isMultiSelection = false;
}
};
reset = () => {
this.isMultiSelection = false;
this.closeMenu();
};
}
const isSelectionKey = (event: React.KeyboardEvent): boolean => {
if (isMac) {
return event.key === "Meta";
}
return event.key === "Control"; // windows or linux
};
@@ -7,77 +7,58 @@ import "./namespace-select-filter.scss";
import React from "react";
import { observer } from "mobx-react";
import { components, type PlaceholderProps } from "react-select";
import { Icon } from "../icon";
import { NamespaceSelect } from "./namespace-select";
import type { PlaceholderProps } from "react-select";
import { components } from "react-select";
import type { NamespaceStore } from "./namespace-store/namespace.store";
import type { SelectOption, SelectProps } from "../select";
import { Select } from "../select";
import { withInjectables } from "@ogre-tools/injectable-react";
import type { NamespaceSelectFilterModel } from "./namespace-select-filter-model/namespace-select-filter-model";
import type { NamespaceSelectFilterModel, SelectAllNamespaces } from "./namespace-select-filter-model/namespace-select-filter-model";
import namespaceSelectFilterModelInjectable from "./namespace-select-filter-model/namespace-select-filter-model.injectable";
import namespaceStoreInjectable from "./namespace-store/namespace-store.injectable";
interface NamespaceSelectFilterProps {
id: string;
}
interface Dependencies {
model: NamespaceSelectFilterModel;
}
const NonInjectedNamespaceSelectFilter = observer(({ model }: SelectProps & Dependencies) => (
<div
onKeyUp={model.onKeyUp}
onKeyDown={model.onKeyDown}
onClick={model.onClick}
>
<NamespaceSelect
id="namespace-select-filter-input"
isMulti={true}
menuIsOpen={model.menuIsOpen}
components={{ Placeholder }}
showAllNamespacesOption={true}
closeMenuOnSelect={false}
controlShouldRenderValue={false}
placeholder={""}
onChange={model.onChange}
onBlur={model.reset}
formatOptionLabel={formatOptionLabelFor(model)}
className="NamespaceSelectFilter"
menuClass="NamespaceSelectFilterMenu"
sort={(left, right) =>
+model.selectedNames.has(right.value)
- +model.selectedNames.has(left.value)
}
/>
</div>
));
const NonInjectedNamespaceSelectFilter = observer(({ model, id }: Dependencies & NamespaceSelectFilterProps) => {
return (
<div
onKeyUp={model.onKeyUp}
onKeyDown={model.onKeyDown}
onClick={model.onClick}
>
<Select<string | SelectAllNamespaces, true>
id={id}
isMulti={true}
isClearable={false}
menuIsOpen={model.menuIsOpen}
components={{ Placeholder }}
closeMenuOnSelect={false}
controlShouldRenderValue={false}
onChange={model.onChange}
onBlur={model.reset}
formatOptionLabel={model.formatOptionLabel}
getOptionLabel={model.getOptionLabel}
options={model.options.get()}
className="NamespaceSelect NamespaceSelectFilter"
menuClass="NamespaceSelectFilterMenu"
/>
</div>
);
});
const formatOptionLabelFor =
(model: NamespaceSelectFilterModel) =>
({ value: namespace, label }: SelectOption) => {
if (namespace) {
const isSelected = model.isSelected(namespace);
return (
<div className="flex gaps align-center">
<Icon small material="layers" />
<span>{namespace}</span>
{isSelected && <Icon small material="check" className="box right" />}
</div>
);
}
return label;
};
export const NamespaceSelectFilter = withInjectables<Dependencies, SelectProps>(NonInjectedNamespaceSelectFilter, {
export const NamespaceSelectFilter = withInjectables<Dependencies, NamespaceSelectFilterProps>(NonInjectedNamespaceSelectFilter, {
getProps: (di, props) => ({
model: di.inject(namespaceSelectFilterModelInjectable),
...props,
}),
});
export interface CustomPlaceholderProps extends PlaceholderProps {}
export interface CustomPlaceholderProps extends PlaceholderProps<string | SelectAllNamespaces, boolean> {}
interface PlaceholderDependencies {
namespaceStore: NamespaceStore;
@@ -103,8 +84,7 @@ const NonInjectedPlaceholder = observer(({ namespaceStore, ...props }: CustomPla
{getPlaceholder()}
</components.Placeholder>
);
},
);
});
const Placeholder = withInjectables<PlaceholderDependencies, CustomPlaceholderProps>( NonInjectedPlaceholder, {
getProps: (di, props) => ({
@@ -5,10 +5,10 @@
import "./namespace-select.scss";
import React from "react";
import { computed, makeObservable } from "mobx";
import React, { useEffect, useState } from "react";
import { computed } from "mobx";
import { observer } from "mobx-react";
import type { SelectOption, SelectProps } from "../select";
import type { SelectProps } from "../select";
import { Select } from "../select";
import { cssNames } from "../../utils";
import { Icon } from "../icon";
@@ -16,87 +16,69 @@ import type { NamespaceStore } from "./namespace-store/namespace.store";
import { withInjectables } from "@ogre-tools/injectable-react";
import namespaceStoreInjectable from "./namespace-store/namespace-store.injectable";
export interface NamespaceSelectProps extends SelectProps {
showIcons?: boolean;
sort?: (a: SelectOption<string>, b: SelectOption<string>) => number;
showAllNamespacesOption?: boolean; // show "All namespaces" option on the top (default: false)
customizeOptions?(options: SelectOption[]): SelectOption[];
}
export type NamespaceSelectSort = (left: string, right: string) => number;
const defaultProps: Partial<NamespaceSelectProps> = {
showIcons: true,
};
export interface NamespaceSelectProps<IsMulti extends boolean> extends SelectProps<string, IsMulti> {
showIcons?: boolean;
sort?: NamespaceSelectSort;
options?: undefined;
}
interface Dependencies {
namespaceStore: NamespaceStore;
}
@observer
class NonInjectedNamespaceSelect extends React.Component<NamespaceSelectProps & Dependencies> {
static defaultProps = defaultProps as object;
constructor(props: NamespaceSelectProps & Dependencies) {
super(props);
makeObservable(this);
}
// No subscribe here because the subscribe is in <App /> (the cluster frame root component)
@computed.struct get options(): SelectOption[] {
const { customizeOptions, showAllNamespacesOption, sort } = this.props;
let options: SelectOption[] = this.props.namespaceStore.items.map(ns => ({ value: ns.getName() }));
if (sort) {
options.sort(sort);
}
if (showAllNamespacesOption) {
options.unshift({ label: "All Namespaces", value: "" });
}
if (customizeOptions) {
options = customizeOptions(options);
}
return options;
}
formatOptionLabel = (option: SelectOption) => {
const { showIcons } = this.props;
const { value, label } = option;
return label || (
<>
{showIcons && <Icon small material="layers"/>}
{value}
</>
);
};
render() {
const { className, showIcons, customizeOptions, components = {}, namespaceStore, ...selectProps } = this.props;
return (
<Select
id="namespace-input"
className={cssNames("NamespaceSelect", className)}
menuClass="NamespaceSelectMenu"
formatOptionLabel={this.formatOptionLabel}
options={this.options}
components={components}
{...selectProps}
/>
);
}
export function formatNamespaceOptionWithIcon(namespace: string) {
return (
<>
<Icon small material="layers" />
{namespace}
</>
);
}
export const NamespaceSelect = withInjectables<Dependencies, NamespaceSelectProps>(
NonInjectedNamespaceSelect,
function getOptions(namespaceStore: NamespaceStore, sort: NamespaceSelectSort | undefined) {
return computed(() => {
const baseOptions = namespaceStore.items.map(ns => ns.getName());
{
getProps: (di, props) => ({
namespaceStore: di.inject(namespaceStoreInjectable),
...props,
}),
},
);
if (sort) {
baseOptions.sort(sort);
}
return baseOptions;
});
}
const NonInjectedNamespaceSelect = observer(({
namespaceStore,
showIcons,
formatOptionLabel,
sort,
className,
...selectProps
}: Dependencies & NamespaceSelectProps<boolean>) => {
const [baseOptions, setBaseOptions] = useState(getOptions(namespaceStore, sort));
useEffect(() => setBaseOptions(getOptions(namespaceStore, sort)), [sort]);
return (
<Select
className={cssNames("NamespaceSelect", className)}
menuClass="NamespaceSelectMenu"
formatOptionLabel={showIcons ? formatNamespaceOptionWithIcon : undefined}
options={baseOptions.get()}
{...selectProps}
/>
);
});
const InjectedNamespaceSelect = withInjectables<Dependencies, NamespaceSelectProps<boolean>>(NonInjectedNamespaceSelect, {
getProps: (di, props) => ({
...props,
namespaceStore: di.inject(namespaceStoreInjectable),
}),
});
export function NamespaceSelect<IsMulti extends boolean = false>(props: NamespaceSelectProps<IsMulti>): JSX.Element {
return <InjectedNamespaceSelect {...(props as never)} />;
}
@@ -6,6 +6,7 @@ import { getInjectable } from "@ogre-tools/injectable";
import { NamespaceStore } from "./namespace.store";
import apiManagerInjectable from "../../kube-object-menu/dependencies/api-manager.injectable";
import createStorageInjectable from "../../../utils/create-storage/create-storage.injectable";
import { namespacesApi } from "../../../../common/k8s-api/endpoints";
const namespaceStoreInjectable = getInjectable({
id: "namespace-store",
@@ -20,7 +21,7 @@ const namespaceStoreInjectable = getInjectable({
const namespaceStore = new NamespaceStore({
storage,
});
}, namespacesApi);
const apiManager = di.inject(apiManagerInjectable);
@@ -9,17 +9,16 @@ import type { StorageHelper } from "../../../utils";
import { autoBind, noop, toggle } from "../../../utils";
import type { KubeObjectStoreLoadingParams } from "../../../../common/k8s-api/kube-object.store";
import { KubeObjectStore } from "../../../../common/k8s-api/kube-object.store";
import { Namespace, namespacesApi } from "../../../../common/k8s-api/endpoints/namespaces.api";
import type { NamespaceApi } from "../../../../common/k8s-api/endpoints/namespaces.api";
import { Namespace } from "../../../../common/k8s-api/endpoints/namespaces.api";
interface Dependencies {
storage: StorageHelper<string[] | undefined>;
}
export class NamespaceStore extends KubeObjectStore<Namespace> {
api = namespacesApi;
constructor(private dependencies: Dependencies) {
super();
export class NamespaceStore extends KubeObjectStore<Namespace, NamespaceApi> {
constructor(protected readonly dependencies: Dependencies, api: NamespaceApi) {
super(api);
makeObservable(this);
autoBind(this);
@@ -115,7 +114,7 @@ export class NamespaceStore extends KubeObjectStore<Namespace> {
* if user has given static list of namespaces let's not start watches
* because watch adds stuff that's not wanted or will just fail
*/
if (this.context?.cluster.accessibleNamespaces.length > 0) {
if (!this.context?.cluster?.accessibleNamespaces.length) {
return noop;
}
@@ -146,7 +145,7 @@ export class NamespaceStore extends KubeObjectStore<Namespace> {
clearSelected(namespaces?: string | string[]) {
if (namespaces) {
const resettingNamespaces = [namespaces].flat();
const newNamespaces = this.dependencies.storage.get().filter(ns => !resettingNamespaces.includes(ns));
const newNamespaces = this.dependencies.storage.get()?.filter(ns => !resettingNamespaces.includes(ns));
this.dependencies.storage.set(newNamespaces);
} else {
@@ -6,7 +6,7 @@
import "./namespaces.scss";
import React from "react";
import { NamespaceStatus } from "../../../common/k8s-api/endpoints";
import { NamespaceStatusKind } from "../../../common/k8s-api/endpoints";
import { AddNamespaceDialog } from "./add-namespace-dialog";
import { TabLayout } from "../layout/tab-layout-2";
import { Badge } from "../badge";
@@ -58,7 +58,13 @@ export const NonInjectedNamespacesRoute = ({ namespaceStore, openAddNamespaceDia
renderTableContents={namespace => [
namespace.getName(),
<KubeObjectStatusIcon key="icon" object={namespace} />,
namespace.getLabels().map(label => <Badge scrollable key={label} label={label}/>),
namespace.getLabels().map(label => (
<Badge
scrollable
key={label}
label={label}
/>
)),
<KubeObjectAge key="age" object={namespace} />,
{ title: namespace.getStatus(), className: namespace.getStatus().toLowerCase() },
]}
@@ -67,7 +73,7 @@ export const NonInjectedNamespacesRoute = ({ namespaceStore, openAddNamespaceDia
onAdd: openAddNamespaceDialog,
}}
customizeTableRowProps={item => ({
disabled: item.getStatus() === NamespaceStatus.TERMINATING,
disabled: item.getStatus() === NamespaceStatusKind.TERMINATING,
})}
/>
<AddNamespaceDialog/>
Loaded 100 of 689 files, more files were not shown because too many files have changed in this diff. Show more