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

Resolve kube object status texts again on re-render to make it look like it's reactive (#5875)

* Make tests for kube object status icon more realistic

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Start resolving kube object status texts on each re-render to mimic reactivity

Note: This is done due the current implementation exposed in Extension API expects it to work so. However, this is bad.

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Switch to using existing implementation for isDefined

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>
This commit is contained in:
Janne Savolainen 2022-07-27 09:21:38 +03:00 committed by GitHub
parent f61330611e
commit a12b94405a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 2903 additions and 379 deletions

View File

@ -267,6 +267,7 @@ exports[`disable kube object statuses when cluster is not relevant given extensi
> >
<i <i
class="Icon KubeObjectStatusIcon error material focusable" class="Icon KubeObjectStatusIcon error material focusable"
data-testid="kube-object-status-icon-for-some-uid"
id="tooltip_target_156" id="tooltip_target_156"
> >
<span <span

View File

@ -0,0 +1,376 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { KubeObjectStatusLevel } from "../../../common/k8s-api/kube-object-status";
import { KubeObject } from "../../../common/k8s-api/kube-object";
import React from "react";
import { useFakeTime } from "../../../common/test-utils/use-fake-time";
import type { DiContainer } from "@ogre-tools/injectable";
import { getInjectable } from "@ogre-tools/injectable";
import type { IAtom } from "mobx";
import { createAtom, computed } from "mobx";
import { frontEndRouteInjectionToken } from "../../../common/front-end-routing/front-end-route-injection-token";
import { routeSpecificComponentInjectionToken } from "../../../renderer/routes/route-specific-component-injection-token";
import type { ApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder";
import { getApplicationBuilder } from "../../../renderer/components/test-utils/get-application-builder";
import { navigateToRouteInjectionToken } from "../../../common/front-end-routing/navigate-to-route-injection-token";
import type { RenderResult } from "@testing-library/react";
import { act } from "@testing-library/react";
import { observer } from "mobx-react";
import { kubeObjectStatusTextInjectionToken } from "../../../renderer/components/kube-object-status-icon/kube-object-status-text-injection-token";
import { KubeObjectStatusIcon } from "../../../renderer/components/kube-object-status-icon";
// TODO: Make tooltips free of side effects by making it deterministic
jest.mock("../../../renderer/components/tooltip/withTooltip", () => ({
withTooltip:
(Target: any) =>
({ tooltip, ...props }: any) => {
if (tooltip) {
const testId = props["data-testid"];
return (
<>
<Target
tooltip={tooltip.children ? undefined : tooltip}
{...props}
/>
<div data-testid={testId && `tooltip-content-for-${testId}`}>
{tooltip.children || tooltip}
</div>
</>
);
}
return <Target {...props} />;
},
}));
describe("show status for a kube object", () => {
let builder: ApplicationBuilder;
let infoStatusIsShown: boolean;
let warningStatusIsShown: boolean;
let criticalStatusIsShown: boolean;
beforeEach(() => {
useFakeTime("2015-10-21T07:28:00Z");
builder = getApplicationBuilder();
const rendererDi = builder.dis.rendererDi;
infoStatusIsShown = false;
const infoStatusInjectable = getInjectable({
id: "some-info-status",
injectionToken: kubeObjectStatusTextInjectionToken,
instantiate: () => ({
apiVersions: ["some-api-version"],
kind: "some-kind",
enabled: computed(() => true),
resolve: (resource) => infoStatusIsShown ? ({
level: KubeObjectStatusLevel.INFO,
text: `Some info status for ${resource.getName()}`,
timestamp: "2015-10-19T07:28:00Z",
}) : null,
}),
});
warningStatusIsShown = false;
const warningStatusInjectable = getInjectable({
id: "some-warning-status",
injectionToken: kubeObjectStatusTextInjectionToken,
instantiate: () => ({
apiVersions: ["some-api-version"],
kind: "some-kind",
enabled: computed(() => true),
resolve: (resource) => warningStatusIsShown ? ({
level: KubeObjectStatusLevel.WARNING,
text: `Some warning status for ${resource.getName()}`,
timestamp: "2015-10-19T07:28:00Z",
}) : null,
}),
});
criticalStatusIsShown = false;
const criticalStatusInjectable = getInjectable({
id: "some-critical-status",
injectionToken: kubeObjectStatusTextInjectionToken,
instantiate: () => ({
apiVersions: ["some-api-version"],
kind: "some-kind",
enabled: computed(() => true),
resolve: (resource) => {
return criticalStatusIsShown
? {
level: KubeObjectStatusLevel.CRITICAL,
text: `Some critical status for ${resource.getName()}`,
timestamp: "2015-10-19T07:28:00Z",
}
: null;
},
}),
});
rendererDi.register(
testRouteInjectable,
testRouteComponentInjectable,
infoStatusInjectable,
warningStatusInjectable,
criticalStatusInjectable,
someAtomInjectable,
);
builder.setEnvironmentToClusterFrame();
});
describe("given application starts and in test page", () => {
let rendererDi: DiContainer;
let rendered: RenderResult;
let rerenderParent: () => void;
beforeEach(async () => {
rendered = await builder.render();
rendererDi = builder.dis.rendererDi;
const someAtom = rendererDi.inject(someAtomInjectable);
rerenderParent = rerenderParentFor(someAtom);
const navigateToRoute = rendererDi.inject(navigateToRouteInjectionToken);
const testRoute = rendererDi.inject(testRouteInjectable);
navigateToRoute(testRoute);
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("does not show any statuses yet", () => {
const status = rendered.queryByTestId(
"kube-object-status-icon-for-some-uid",
);
expect(status).not.toBeInTheDocument();
});
describe("when status for irrelevant kube object kind emerges", () => {
beforeEach(() => {
rendererDi.register(statusForIrrelevantKubeObjectKindInjectable);
rerenderParent();
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("does not show any statuses", () => {
const status = rendered.queryByTestId(
"kube-object-status-icon-for-some-uid",
);
expect(status).not.toBeInTheDocument();
});
});
describe("when status for irrelevant kube object api version emerges", () => {
beforeEach(() => {
rendererDi.register(statusForIrrelevantKubeObjectApiVersionInjectable);
rerenderParent();
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("does not show any statuses", () => {
const status = rendered.queryByTestId(
"kube-object-status-icon-for-some-uid",
);
expect(status).not.toBeInTheDocument();
});
});
describe("when info status emerges", () => {
beforeEach(() => {
infoStatusIsShown = true;
rerenderParent();
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("shows status", () => {
const status = rendered.getByTestId(
"kube-object-status-icon-for-some-uid",
);
expect(status).toBeInTheDocument();
});
it("show info status", () => {
const tooltipContent = rendered.getByTestId(
"tooltip-content-for-kube-object-status-icon-for-some-uid",
);
expect(tooltipContent).toHaveTextContent(
"Some info status for some-name",
);
});
});
describe("when warning status emerges", () => {
beforeEach(() => {
warningStatusIsShown = true;
rerenderParent();
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("show warning status", () => {
const tooltipContent = rendered.getByTestId(
"tooltip-content-for-kube-object-status-icon-for-some-uid",
);
expect(tooltipContent).toHaveTextContent(
"Some warning status for some-name",
);
});
});
describe("when critical status emerges", () => {
beforeEach(() => {
criticalStatusIsShown = true;
rerenderParent();
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("show critical status", () => {
const tooltipContent = rendered.getByTestId(
"tooltip-content-for-kube-object-status-icon-for-some-uid",
);
expect(tooltipContent).toHaveTextContent(
"Some critical status for some-name",
);
});
});
});
});
const testRouteInjectable = getInjectable({
id: "test-route",
instantiate: () => ({
path: "/test-route",
clusterFrame: true,
isEnabled: computed(() => true),
}),
injectionToken: frontEndRouteInjectionToken,
});
const rerenderParentFor = (atom: IAtom) => () => {
act(() => {
atom.reportChanged();
});
};
const TestComponent = observer(({ someAtom }: { someAtom: IAtom }) => {
void someAtom.reportObserved();
return (
<KubeObjectStatusIcon
object={getKubeObjectStub("some-kind", "some-api-version")}
/>
);
});
const testRouteComponentInjectable = getInjectable({
id: "test-route-component",
instantiate: (di) => {
const someAtom = di.inject(someAtomInjectable);
return {
route: di.inject(testRouteInjectable),
Component: () => <TestComponent someAtom={someAtom} />,
};
},
injectionToken: routeSpecificComponentInjectionToken,
});
const someAtomInjectable = getInjectable({
id: "some-atom",
instantiate: () => createAtom("some-atom"),
});
const getKubeObjectStub = (kind: string, apiVersion: string) =>
KubeObject.create({
apiVersion,
kind,
metadata: {
uid: "some-uid",
name: "some-name",
resourceVersion: "some-resource-version",
namespace: "some-namespace",
selfLink: "/foo",
},
});
const statusForIrrelevantKubeObjectKindInjectable = getInjectable({
id: "status-for-irrelevant-kube-object-kind",
injectionToken: kubeObjectStatusTextInjectionToken,
instantiate: () => ({
apiVersions: ["some-api-version"],
kind: "some-other-kind",
enabled: computed(() => true),
resolve: () => ({
level: KubeObjectStatusLevel.INFO,
text: "irrelevant",
timestamp: "2015-10-19T07:28:00Z",
}),
}),
});
const statusForIrrelevantKubeObjectApiVersionInjectable = getInjectable({
id: "status-for-irrelevant-kube-object-api-version",
injectionToken: kubeObjectStatusTextInjectionToken,
instantiate: () => ({
apiVersions: ["some-other-api-version"],
kind: "some-kind",
enabled: computed(() => true),
resolve: () => ({
level: KubeObjectStatusLevel.INFO,
text: "irrelevant",
timestamp: "2015-10-19T07:28:00Z",
}),
}),
});

View File

@ -1,116 +0,0 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`kube-object-status-icon given info and warning statuses are present, when rendered, renders with statuses 1`] = `
<body>
<div>
<i
class="Icon KubeObjectStatusIcon warning material focusable"
id="tooltip_target_5"
>
<span
class="icon"
data-icon-name="warning"
>
warning
</span>
<div />
</i>
</div>
</body>
`;
exports[`kube-object-status-icon given level "critical" status, when rendered, renders with status 1`] = `
<body>
<div>
<i
class="Icon KubeObjectStatusIcon error material focusable"
id="tooltip_target_1"
>
<span
class="icon"
data-icon-name="error"
>
error
</span>
<div />
</i>
</div>
</body>
`;
exports[`kube-object-status-icon given level "info" status, when rendered, renders with status 1`] = `
<body>
<div>
<i
class="Icon KubeObjectStatusIcon info material focusable"
id="tooltip_target_2"
>
<span
class="icon"
data-icon-name="info"
>
info
</span>
<div />
</i>
</div>
</body>
`;
exports[`kube-object-status-icon given level "warning" status, when rendered, renders with status 1`] = `
<body>
<div>
<i
class="Icon KubeObjectStatusIcon warning material focusable"
id="tooltip_target_3"
>
<span
class="icon"
data-icon-name="warning"
>
warning
</span>
<div />
</i>
</div>
</body>
`;
exports[`kube-object-status-icon given no statuses, when rendered, renders as empty 1`] = `<div />`;
exports[`kube-object-status-icon given registration for wrong api version, when rendered, renders as empty 1`] = `
<body>
<div />
</body>
`;
exports[`kube-object-status-icon given registration for wrong kind, when rendered, renders as empty 1`] = `
<body>
<div />
</body>
`;
exports[`kube-object-status-icon given registration without status for exact kube object, when rendered, renders as empty 1`] = `
<body>
<div />
</body>
`;
exports[`kube-object-status-icon given status for all levels is present, when rendered, renders with statuses 1`] = `
<body>
<div>
<i
class="Icon KubeObjectStatusIcon error material focusable"
id="tooltip_target_4"
>
<span
class="icon"
data-icon-name="error"
>
error
</span>
<div />
</i>
</div>
</body>
`;

View File

@ -1,251 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getDiForUnitTesting } from "../../getDiForUnitTesting";
import type { DiRender } from "../test-utils/renderFor";
import { renderFor } from "../test-utils/renderFor";
import type { KubeObjectStatus } from "../../../common/k8s-api/kube-object-status";
import { KubeObjectStatusLevel } from "../../../common/k8s-api/kube-object-status";
import { KubeObject } from "../../../common/k8s-api/kube-object";
import { KubeObjectStatusIcon } from "./kube-object-status-icon";
import React from "react";
import { useFakeTime } from "../../../common/test-utils/use-fake-time";
import { getInjectable } from "@ogre-tools/injectable";
import type { DiContainer } from "@ogre-tools/injectable";
import { kubeObjectStatusTextInjectionToken } from "./kube-object-status-text-injection-token";
import { computed } from "mobx";
describe("kube-object-status-icon", () => {
let render: DiRender;
let di: DiContainer;
beforeEach(() => {
useFakeTime("2015-10-21T07:28:00Z");
di = getDiForUnitTesting({ doGeneralOverrides: true });
render = renderFor(di);
});
it("given no statuses, when rendered, renders as empty", () => {
const kubeObject = getKubeObjectStub("irrelevant", "irrelevant");
const { container } = render(<KubeObjectStatusIcon object={kubeObject} />);
expect(container).toMatchSnapshot();
});
it('given level "critical" status, when rendered, renders with status', () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"critical",
"some-kind",
["some-api-version"],
);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
it('given level "info" status, when rendered, renders with status', () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.INFO,
"info",
"some-kind",
["some-api-version"],
);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
it('given level "warning" status, when rendered, renders with status', () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.WARNING,
"warning",
"some-kind",
["some-api-version"],
);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
it("given status for all levels is present, when rendered, renders with statuses", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const criticalStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"critical",
"some-kind",
["some-api-version"],
);
const warningStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.WARNING,
"warning",
"some-kind",
["some-api-version"],
);
const infoStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.INFO,
"info",
"some-kind",
["some-api-version"],
);
di.register(
criticalStatusTextInjectable,
warningStatusTextInjectable,
infoStatusTextInjectable,
);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
it("given info and warning statuses are present, when rendered, renders with statuses", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const warningStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.WARNING,
"warning",
"some-kind",
["some-api-version"],
);
const infoStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.INFO,
"info",
"some-kind",
["some-api-version"],
);
di.register(warningStatusTextInjectable, infoStatusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
it("given registration for wrong api version, when rendered, renders as empty", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"irrelevant",
"some-kind",
["some-other-api-version"],
);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
it("given registration for wrong kind, when rendered, renders as empty", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"irrelevant",
"some-other-kind",
["some-api-version"],
);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
it("given registration without status for exact kube object, when rendered, renders as empty", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusTextInjectable = getInjectable({
id: "some-id",
instantiate: () => ({
apiVersions: ["some-api-version"],
kind: "some-kind",
resolve: () => { return undefined as unknown as KubeObjectStatus; },
enabled: computed(() => true),
}),
injectionToken: kubeObjectStatusTextInjectionToken,
});
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
});
const getKubeObjectStub = (kind: string, apiVersion: string) => KubeObject.create({
apiVersion,
kind,
metadata: {
uid: "some-uid",
name: "some-name",
resourceVersion: "some-resource-version",
namespace: "some-namespace",
selfLink: "/foo",
},
});
const getStatusTextInjectable = (level: KubeObjectStatusLevel, title: string, kind: string, apiVersions: string[]) => getInjectable({
id: title,
instantiate: () => ({
apiVersions,
kind,
resolve: (kubeObject: KubeObject) => ({
level,
text: `Some ${title} status for ${kubeObject.getName()}`,
timestamp: "2015-10-19T07:28:00Z",
}),
enabled: computed(() => true),
}),
injectionToken: kubeObjectStatusTextInjectionToken,
});

View File

@ -7,7 +7,7 @@ import "./kube-object-status-icon.scss";
import React from "react"; import React from "react";
import { Icon } from "../icon"; import { Icon } from "../icon";
import { cssNames, formatDuration, getOrInsert } from "../../utils"; import { cssNames, formatDuration, getOrInsert, isDefined } from "../../utils";
import { withInjectables } from "@ogre-tools/injectable-react"; import { withInjectables } from "@ogre-tools/injectable-react";
import kubeObjectStatusTextsForObjectInjectable from "./kube-object-status-texts-for-object.injectable"; import kubeObjectStatusTextsForObjectInjectable from "./kube-object-status-texts-for-object.injectable";
import type { KubeObject } from "../../../common/k8s-api/kube-object"; import type { KubeObject } from "../../../common/k8s-api/kube-object";
@ -15,6 +15,7 @@ import type { KubeObjectStatus } from "../../../common/k8s-api/kube-object-statu
import { KubeObjectStatusLevel } from "../../../common/k8s-api/kube-object-status"; import { KubeObjectStatusLevel } from "../../../common/k8s-api/kube-object-status";
import type { IComputedValue } from "mobx"; import type { IComputedValue } from "mobx";
import { observer } from "mobx-react"; import { observer } from "mobx-react";
import type { KubeObjectStatusText } from "./kube-object-status-text-injection-token";
function statusClassName(level: KubeObjectStatusLevel): string { function statusClassName(level: KubeObjectStatusLevel): string {
switch (level) { switch (level) {
@ -78,7 +79,7 @@ export interface KubeObjectStatusIconProps {
} }
interface Dependencies { interface Dependencies {
statuses: IComputedValue<KubeObjectStatus[]>; statuses: IComputedValue<KubeObjectStatusText[]>;
} }
@observer @observer
@ -107,7 +108,11 @@ class NonInjectedKubeObjectStatusIcon extends React.Component<KubeObjectStatusIc
} }
render() { render() {
const statuses = this.props.statuses.get(); const statusTexts = this.props.statuses.get();
const statuses = statusTexts
.map((statusText) => statusText.resolve(this.props.object))
.filter(isDefined);
if (statuses.length === 0) { if (statuses.length === 0) {
return null; return null;
@ -119,6 +124,7 @@ class NonInjectedKubeObjectStatusIcon extends React.Component<KubeObjectStatusIc
<Icon <Icon
material={maxLevel} material={maxLevel}
className={cssNames("KubeObjectStatusIcon", maxLevel)} className={cssNames("KubeObjectStatusIcon", maxLevel)}
data-testid={`kube-object-status-icon-for-${this.props.object.getId()}`}
tooltip={{ tooltip={{
children: ( children: (
<div className="KubeObjectStatusTooltip"> <div className="KubeObjectStatusTooltip">

View File

@ -10,7 +10,7 @@ import type { IComputedValue } from "mobx";
export interface KubeObjectStatusText { export interface KubeObjectStatusText {
kind: string; kind: string;
apiVersions: string[]; apiVersions: string[];
resolve: (object: KubeObject) => KubeObjectStatus; resolve: (object: KubeObject) => KubeObjectStatus | null;
enabled: IComputedValue<boolean>; enabled: IComputedValue<boolean>;
} }

View File

@ -6,7 +6,6 @@ import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
import kubeObjectStatusTextsInjectable from "./kube-object-status-texts.injectable"; import kubeObjectStatusTextsInjectable from "./kube-object-status-texts.injectable";
import type { KubeObject } from "../../../common/k8s-api/kube-object"; import type { KubeObject } from "../../../common/k8s-api/kube-object";
import { conforms, eq, includes } from "lodash/fp"; import { conforms, eq, includes } from "lodash/fp";
import type { KubeObjectStatusRegistration } from "./kube-object-status-registration";
import { computed } from "mobx"; import { computed } from "mobx";
const kubeObjectStatusTextsForObjectInjectable = getInjectable({ const kubeObjectStatusTextsForObjectInjectable = getInjectable({
@ -18,9 +17,7 @@ const kubeObjectStatusTextsForObjectInjectable = getInjectable({
return computed(() => return computed(() =>
allStatusTexts allStatusTexts
.get() .get()
.filter(toKubeObjectRelated(kubeObject)) .filter(toKubeObjectRelated(kubeObject)),
.map(toStatus(kubeObject))
.filter(Boolean),
); );
}, },
@ -35,8 +32,4 @@ const toKubeObjectRelated = (kubeObject: KubeObject) =>
apiVersions: includes(kubeObject.apiVersion), apiVersions: includes(kubeObject.apiVersion),
}); });
const toStatus =
(kubeObject: KubeObject) => (item: KubeObjectStatusRegistration) =>
item.resolve(kubeObject);
export default kubeObjectStatusTextsForObjectInjectable; export default kubeObjectStatusTextsForObjectInjectable;