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

fix: use default sorting for <Events/> as on "timeline" (fresh on top)

Signed-off-by: Roman <ixrock@gmail.com>
This commit is contained in:
Roman 2021-02-12 15:39:05 +02:00
parent 317c4cf072
commit e611a75b6d
8 changed files with 82 additions and 40 deletions

View File

@ -122,12 +122,15 @@ export class KubeObject implements ItemObject {
return this.metadata.namespace || undefined; return this.metadata.namespace || undefined;
} }
// todo: refactor with named arguments getTimeDiffFromNow(): number {
return new Date().getTime() - new Date(this.metadata.creationTimestamp).getTime();
}
getAge(humanize = true, compact = true, fromNow = false) { getAge(humanize = true, compact = true, fromNow = false) {
if (fromNow) { if (fromNow) {
return moment(this.metadata.creationTimestamp).fromNow(); return moment(this.metadata.creationTimestamp).fromNow(); // "string"
} }
const diff = new Date().getTime() - new Date(this.metadata.creationTimestamp).getTime(); const diff = this.getTimeDiffFromNow();
if (humanize) { if (humanize) {
return formatDuration(diff, compact); return formatDuration(diff, compact);

View File

@ -20,8 +20,8 @@ export class EventStore extends KubeObjectStore<KubeEvent> {
protected sortItems(items: KubeEvent[]) { protected sortItems(items: KubeEvent[]) {
return super.sortItems(items, [ return super.sortItems(items, [
event => event.metadata.creationTimestamp event => event.getTimeDiffFromNow(), // keep events order as timeline ("fresh" on top)
], "desc"); ], "asc");
} }
getEventsByObject(obj: KubeObject): KubeEvent[] { getEventsByObject(obj: KubeObject): KubeEvent[] {

View File

@ -1,4 +1,10 @@
.Events { .Events {
h5.title {
.events-count {
font-size: $font-size;
}
}
.Table { .Table {
.TableCell { .TableCell {
&.message { &.message {

View File

@ -1,11 +1,14 @@
import "./events.scss"; import "./events.scss";
import React, { Fragment } from "react"; import React, { Fragment } from "react";
import { computed, observable } from "mobx";
import { observer } from "mobx-react"; import { observer } from "mobx-react";
import { orderBy } from "lodash";
import { TabLayout } from "../layout/tab-layout"; import { TabLayout } from "../layout/tab-layout";
import { eventStore } from "./event.store"; import { EventStore, eventStore } from "./event.store";
import { getDetailsUrl, KubeObjectListLayout, KubeObjectListLayoutProps } from "../kube-object"; import { getDetailsUrl, KubeObjectListLayout, KubeObjectListLayoutProps } from "../kube-object";
import { KubeEvent } from "../../api/endpoints/events.api"; import { KubeEvent } from "../../api/endpoints/events.api";
import { TableSortCallbacks, TableSortParams } from "../table";
import { Tooltip } from "../tooltip"; import { Tooltip } from "../tooltip";
import { Link } from "react-router-dom"; import { Link } from "react-router-dom";
import { cssNames, IClassName, stopPropagation } from "../../utils"; import { cssNames, IClassName, stopPropagation } from "../../utils";
@ -37,23 +40,60 @@ const defaultProps: Partial<Props> = {
export class Events extends React.Component<Props> { export class Events extends React.Component<Props> {
static defaultProps = defaultProps as object; static defaultProps = defaultProps as object;
get store() { private sortingCallbacks: TableSortCallbacks = {
[columnId.namespace]: (event: KubeEvent) => event.getNs(),
[columnId.type]: (event: KubeEvent) => event.type,
[columnId.object]: (event: KubeEvent) => event.involvedObject.name,
[columnId.count]: (event: KubeEvent) => event.count,
[columnId.age]: (event: KubeEvent) => event.getTimeDiffFromNow(),
};
@observable sorting: TableSortParams = {
sortBy: columnId.age,
orderBy: "asc",
};
get store(): EventStore {
return eventStore; return eventStore;
} }
get items() { @computed get items(): KubeEvent[] {
return eventStore.contextItems; const items = this.store.contextItems;
const { sortBy, orderBy: order } = this.sorting;
// 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);
}
@computed get visibleItems(): KubeEvent[] {
const { compact, compactLimit } = this.props;
if (compact) {
return this.items.slice(0, compactLimit);
}
return this.items;
}
@computed get header(): React.ReactNode {
const { items, visibleItems } = this;
const allEventsAreShown = visibleItems.length === items.length;
if (this.props.compact && !allEventsAreShown) {
return <>
Events <span className="events-count">
({visibleItems.length} of <Link to={eventsURL()}>{items.length}</Link>)
</span>
</>;
}
return <>Events</>;
} }
render() { render() {
const { store, items } = this; const { store, visibleItems, header, sortingCallbacks, sorting } = this;
const { compact, compactLimit, className, ...layoutProps } = this.props; const { compact, compactLimit, className, ...layoutProps } = this.props;
const visibleItems = compact ? items.slice(0, compactLimit) : items;
const allEventsAreShown = visibleItems.length === items.length;
const compactModeHeader = <>
Events <small>({visibleItems.length} of <Link to={eventsURL()}>{items.length}</Link>)</small>
</>;
const events = ( const events = (
<KubeObjectListLayout <KubeObjectListLayout
@ -65,20 +105,12 @@ export class Events extends React.Component<Props> {
isSelectable={false} isSelectable={false}
items={visibleItems} items={visibleItems}
virtual={!compact} virtual={!compact}
renderHeaderTitle={compact && !allEventsAreShown ? compactModeHeader : "Events"} renderHeaderTitle={header}
sortingCallbacks={sortingCallbacks}
tableProps={{ tableProps={{
sortSyncWithUrl: false, sortSyncWithUrl: false,
sortByDefault: { sortByDefault: sorting,
sortBy: columnId.type, onSort: params => this.sorting = params,
orderBy: "desc", // show "Warning" events at the top
},
}}
sortingCallbacks={{
[columnId.namespace]: (event: KubeEvent) => event.getNs(),
[columnId.type]: (event: KubeEvent) => event.type,
[columnId.object]: (event: KubeEvent) => event.involvedObject.name,
[columnId.count]: (event: KubeEvent) => event.count,
[columnId.age]: (event: KubeEvent) => event.metadata.creationTimestamp,
}} }}
searchFilters={[ searchFilters={[
(event: KubeEvent) => event.getSearchFields(), (event: KubeEvent) => event.getSearchFields(),

View File

@ -4,9 +4,9 @@ import "@testing-library/jest-dom/extend-expect";
import { DeploymentScaleDialog } from "./deployment-scale-dialog"; import { DeploymentScaleDialog } from "./deployment-scale-dialog";
jest.mock("../../api/endpoints"); jest.mock("../../api/endpoints");
import { deploymentApi } from "../../api/endpoints"; import { Deployment, deploymentApi } from "../../api/endpoints";
const dummyDeployment = { const dummyDeployment: Deployment = {
apiVersion: "v1", apiVersion: "v1",
kind: "dummy", kind: "dummy",
metadata: { metadata: {
@ -83,6 +83,7 @@ const dummyDeployment = {
getName: jest.fn(), getName: jest.fn(),
getNs: jest.fn(), getNs: jest.fn(),
getAge: jest.fn(), getAge: jest.fn(),
getTimeDiffFromNow: jest.fn(),
getFinalizers: jest.fn(), getFinalizers: jest.fn(),
getLabels: jest.fn(), getLabels: jest.fn(),
getAnnotations: jest.fn(), getAnnotations: jest.fn(),

View File

@ -4,9 +4,9 @@ jest.mock("../../api/endpoints");
import { ReplicaSetScaleDialog } from "./replicaset-scale-dialog"; import { ReplicaSetScaleDialog } from "./replicaset-scale-dialog";
import { render, waitFor, fireEvent } from "@testing-library/react"; import { render, waitFor, fireEvent } from "@testing-library/react";
import React from "react"; import React from "react";
import { replicaSetApi } from "../../api/endpoints/replica-set.api"; import { ReplicaSet, replicaSetApi } from "../../api/endpoints/replica-set.api";
const dummyReplicaSet = { const dummyReplicaSet: ReplicaSet = {
apiVersion: "v1", apiVersion: "v1",
kind: "dummy", kind: "dummy",
metadata: { metadata: {
@ -67,7 +67,6 @@ const dummyReplicaSet = {
getCurrent: jest.fn(), getCurrent: jest.fn(),
getReady: jest.fn(), getReady: jest.fn(),
getImages: jest.fn(), getImages: jest.fn(),
getReplicas: jest.fn(),
getSelectors: jest.fn(), getSelectors: jest.fn(),
getTemplateLabels: jest.fn(), getTemplateLabels: jest.fn(),
getAffinity: jest.fn(), getAffinity: jest.fn(),
@ -79,6 +78,7 @@ const dummyReplicaSet = {
getName: jest.fn(), getName: jest.fn(),
getNs: jest.fn(), getNs: jest.fn(),
getAge: jest.fn(), getAge: jest.fn(),
getTimeDiffFromNow: jest.fn(),
getFinalizers: jest.fn(), getFinalizers: jest.fn(),
getLabels: jest.fn(), getLabels: jest.fn(),
getAnnotations: jest.fn(), getAnnotations: jest.fn(),

View File

@ -1,12 +1,12 @@
import "@testing-library/jest-dom/extend-expect"; import "@testing-library/jest-dom/extend-expect";
jest.mock("../../api/endpoints"); jest.mock("../../api/endpoints");
import { statefulSetApi } from "../../api/endpoints"; import { StatefulSet, statefulSetApi } from "../../api/endpoints";
import { StatefulSetScaleDialog } from "./statefulset-scale-dialog"; import { StatefulSetScaleDialog } from "./statefulset-scale-dialog";
import { render, waitFor, fireEvent } from "@testing-library/react"; import { render, waitFor, fireEvent } from "@testing-library/react";
import React from "react"; import React from "react";
const dummyStatefulSet = { const dummyStatefulSet: StatefulSet = {
apiVersion: "v1", apiVersion: "v1",
kind: "dummy", kind: "dummy",
metadata: { metadata: {
@ -88,6 +88,7 @@ const dummyStatefulSet = {
getName: jest.fn(), getName: jest.fn(),
getNs: jest.fn(), getNs: jest.fn(),
getAge: jest.fn(), getAge: jest.fn(),
getTimeDiffFromNow: jest.fn(),
getFinalizers: jest.fn(), getFinalizers: jest.fn(),
getLabels: jest.fn(), getLabels: jest.fn(),
getAnnotations: jest.fn(), getAnnotations: jest.fn(),

View File

@ -16,6 +16,7 @@ export type TableSortBy = string;
export type TableOrderBy = "asc" | "desc" | string; export type TableOrderBy = "asc" | "desc" | string;
export type TableSortParams = { sortBy: TableSortBy; orderBy: TableOrderBy }; export type TableSortParams = { sortBy: TableSortBy; orderBy: TableOrderBy };
export type TableSortCallback<D = any> = (data: D) => string | number | (string | number)[]; export type TableSortCallback<D = any> = (data: D) => string | number | (string | number)[];
export type TableSortCallbacks = { [columnId: string]: TableSortCallback };
export interface TableProps extends React.DOMAttributes<HTMLDivElement> { export interface TableProps extends React.DOMAttributes<HTMLDivElement> {
items?: ItemObject[]; // Raw items data items?: ItemObject[]; // Raw items data
@ -24,11 +25,9 @@ export interface TableProps extends React.DOMAttributes<HTMLDivElement> {
selectable?: boolean; // Highlight rows on hover selectable?: boolean; // Highlight rows on hover
scrollable?: boolean; // Use scrollbar if content is bigger than parent's height scrollable?: boolean; // Use scrollbar if content is bigger than parent's height
storageKey?: string; // Keep some data in localStorage & restore on page reload, e.g sorting params storageKey?: string; // Keep some data in localStorage & restore on page reload, e.g sorting params
sortable?: { // Define sortable callbacks for every column in <TableHead><TableCell sortBy="someCol"><TableHead>
// Define sortable callbacks for every column in <TableHead><TableCell sortBy="someCol"><TableHead> // @sortItem argument in the callback is an object, provided in <TableRow sortItem={someColDataItem}/>
// @sortItem argument in the callback is an object, provided in <TableRow sortItem={someColDataItem}/> sortable?: TableSortCallbacks;
[sortBy: string]: TableSortCallback;
};
sortSyncWithUrl?: boolean; // sorting state is managed globally from url params sortSyncWithUrl?: boolean; // sorting state is managed globally from url params
sortByDefault?: Partial<TableSortParams>; // default sorting params sortByDefault?: Partial<TableSortParams>; // default sorting params
onSort?: (params: TableSortParams) => void; // callback on sort change, default: global sync with url onSort?: (params: TableSortParams) => void; // callback on sort change, default: global sync with url