services/workbench2/src/components/data-table/data-table.tsx

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import React from "react";
   6 import { CustomStyleRulesCallback } from 'common/custom-theme';
   7 import {
   8     Table,
   9     TableBody,
  10     TableRow,
  11     TableCell,
  12     TableHead,
  13     TableSortLabel,
  14     IconButton,
  15     Tooltip,
  16 } from "@mui/material";
  17 import { WithStyles } from '@mui/styles';
  18 import withStyles from '@mui/styles/withStyles';
  19 import classnames from "classnames";
  20 import { DataColumn, SortDirection } from "./data-column";
  21 import { DataTableDefaultView } from "../data-table-default-view/data-table-default-view";
  22 import { DataTableFilters } from "../data-table-filters/data-table-filters-tree";
  23 import { DataTableMultiselectPopover } from "../data-table-multiselect-popover/data-table-multiselect-popover";
  24 import { DataTableFiltersPopover } from "../data-table-filters/data-table-filters-popover";
  25 import { countNodes, getTreeDirty } from "models/tree";
  26 import { IconType } from "components/icon/icon";
  27 import { SvgIconProps } from "@mui/material/SvgIcon";
  28 import ArrowDownwardIcon from "@mui/icons-material/ArrowDownward";
  29 import { createTree } from "models/tree";
  30 import { DataTableMultiselectOption } from "../data-table-multiselect-popover/data-table-multiselect-popover";
  31 import { isExactlyOneSelected } from "store/multiselect/multiselect-actions";
  32 import { PendingIcon } from "components/icon/icon";
  33 import { CustomTheme, ArvadosTheme } from "common/custom-theme";
  34
  35 export type DataColumns<I, R> = Array<DataColumn<I, R>>;
  36
  37 export enum DataTableFetchMode {
  38     PAGINATED,
  39     INFINITE,
  40 }
  41
  42 export interface DataTableDataProps<I> {
  43     items: I[];
  44     columns: DataColumns<I, any>;
  45     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  46     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
  47     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  48     onSortToggle: (column: DataColumn<I, any>) => void;
  49     onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
  50     extractKey?: (item: I) => React.Key;
  51     working?: boolean;
  52     defaultViewIcon?: IconType;
  53     defaultViewMessages?: string[];
  54     toggleMSToolbar: (isVisible: boolean) => void;
  55     setCheckedListOnStore: (checkedList: TCheckedList) => void;
  56     currentRoute?: string;
  57     currentRouteUuid: string;
  58     checkedList: TCheckedList;
  59     selectedResourceUuid: string;
  60     setSelectedUuid: (uuid: string | null) => void;
  61     isNotFound?: boolean;
  62 }
  63
  64 type CssRules =
  65     | "tableBody"
  66     | "root"
  67     | "content"
  68     | "noItemsInfo"
  69     | "checkBoxHead"
  70     | "checkBoxCell"
  71     | "clickBox"
  72     | "checkBox"
  73     | "firstTableCell"
  74     | "tableCell"
  75     | "firstTableHead"
  76     | "tableHead"
  77     | "selected"
  78     | "hovered"
  79     | "arrow"
  80     | "arrowButton"
  81     | "tableCellWorkflows";
  82
  83 const styles: CustomStyleRulesCallback<CssRules> = (theme: ArvadosTheme) => ({
  84     root: {
  85         width: "100%",
  86     },
  87     content: {
  88         display: "inline-block",
  89         width: "100%",
  90     },
  91     tableBody: {
  92         background: theme.palette.background.paper,
  93         overflow: "auto",
  94     },
  95     noItemsInfo: {
  96         textAlign: "center",
  97         padding: theme.spacing(1),
  98     },
  99     checkBoxHead: {
 100         padding: "0",
 101         display: "flex",
 102         width: '2rem',
 103         height: "1.5rem",
 104         paddingLeft: '0.9rem',
 105         marginRight: '0.5rem',
 106         backgroundColor: theme.palette.background.paper,
 107     },
 108     checkBoxCell: {
 109         padding: "0",
 110         backgroundColor: theme.palette.background.paper,
 111     },
 112     clickBox: {
 113         display: 'flex',
 114         width: '1.6rem',
 115         height: "1.5rem",
 116         paddingLeft: '0.35rem',
 117         paddingTop: '0.1rem',
 118         marginLeft: '0.5rem',
 119         cursor: "pointer",
 120     },
 121     checkBox: {
 122         cursor: "pointer",
 123     },
 124     tableCell: {
 125         wordWrap: "break-word",
 126         paddingRight: "24px",
 127     },
 128     firstTableCell: {
 129         paddingLeft: "5px",
 130     },
 131     firstTableHead: {
 132         paddingLeft: "5px",
 133     },
 134     tableHead: {
 135         wordWrap: "break-word",
 136         paddingRight: "24px",
 137         color: "#737373",
 138         fontSize: "0.8125rem",
 139         backgroundColor: theme.palette.background.paper,
 140     },
 141     selected: {
 142         backgroundColor: `${CustomTheme.palette.grey['300']} !important`
 143     },
 144     hovered: {
 145         backgroundColor: `${CustomTheme.palette.grey['100']} !important`
 146     },
 147     tableCellWorkflows: {
 148         "&:nth-last-child(2)": {
 149             padding: "0px",
 150             maxWidth: "48px",
 151         },
 152         "&:last-child": {
 153             padding: "0px",
 154             paddingRight: "24px",
 155             width: "48px",
 156         },
 157     },
 158     arrow: {
 159         margin: 0,
 160     },
 161     arrowButton: {
 162         color: theme.palette.text.primary,
 163     },
 164 });
 165
 166 export type TCheckedList = Record<string, boolean>;
 167
 168 type DataTableState = {
 169     isSelected: boolean;
 170     isLoaded: boolean;
 171     hoveredIndex: number | null;
 172 };
 173
 174 type DataTableProps<T> = DataTableDataProps<T> & WithStyles<CssRules>;
 175
 176 export const DataTable = withStyles(styles)(
 177     class Component<T> extends React.Component<DataTableProps<T>> {
 178         state: DataTableState = {
 179             isSelected: false,
 180             isLoaded: false,
 181             hoveredIndex: null,
 182         };
 183
 184         componentDidMount(): void {
 185             this.initializeCheckedList([]);
 186             if((this.props.items.length > 0) && !this.state.isLoaded) {
 187                 this.setState({ isLoaded: true });
 188             }
 189         }
 190
 191         componentDidUpdate(prevProps: Readonly<DataTableProps<T>>, prevState: DataTableState) {
 192             const { items, currentRouteUuid, setCheckedListOnStore } = this.props;
 193             const { isSelected } = this.state;
 194             const singleSelected = isExactlyOneSelected(this.props.checkedList);
 195             if (prevProps.items !== items) {
 196                 if (isSelected === true) this.setState({ isSelected: false });
 197                 if (items.length) this.initializeCheckedList(items);
 198                 else setCheckedListOnStore({});
 199             }
 200             if (prevProps.currentRoute !== this.props.currentRoute) {
 201                 this.initializeCheckedList([]);
 202             }
 203             if (singleSelected && singleSelected !== isExactlyOneSelected(prevProps.checkedList)) {
 204                 this.props.setSelectedUuid(singleSelected);
 205             }
 206             if (!singleSelected && !!currentRouteUuid && !this.isAnySelected()) {
 207                 this.props.setSelectedUuid(currentRouteUuid);
 208             }
 209             if (!singleSelected && this.isAnySelected()) {
 210                 this.props.setSelectedUuid(null);
 211             }
 212             if(prevProps.working === true && this.props.working === false) {
 213                 this.setState({ isLoaded: true });
 214             }
 215             if((this.props.items.length > 0) && !this.state.isLoaded) {
 216                 this.setState({ isLoaded: true });
 217             }
 218         }
 219
 220         componentWillUnmount(): void {
 221             this.initializeCheckedList([]);
 222         }
 223
 224         checkBoxColumn: DataColumn<any, any> = {
 225             name: "checkBoxColumn",
 226             selected: true,
 227             configurable: false,
 228             filters: createTree(),
 229             render: uuid => {
 230                 const { classes, checkedList } = this.props;
 231                 return (
 232                     <div
 233                         className={classes.clickBox}
 234                         onClick={(ev) => {
 235                             ev.stopPropagation()
 236                             this.handleSelectOne(uuid)
 237                         }}
 238                         onDoubleClick={(ev) => ev.stopPropagation()}
 239                     >
 240                         <input
 241                             data-cy={`multiselect-checkbox-${uuid}`}
 242                             type='checkbox'
 243                             name={uuid}
 244                             className={classes.checkBox}
 245                             checked={checkedList && checkedList[uuid] ? checkedList[uuid] : false}
 246                             onChange={() => this.handleSelectOne(uuid)}
 247                             onDoubleClick={(ev) => ev.stopPropagation()}
 248                         ></input>
 249                     </div>
 250                 );
 251             },
 252         };
 253
 254         multiselectOptions: DataTableMultiselectOption[] = [
 255             { name: "All", fn: list => this.handleSelectAll(list) },
 256             { name: "None", fn: list => this.handleSelectNone(list) },
 257             { name: "Invert", fn: list => this.handleInvertSelect(list) },
 258         ];
 259
 260         initializeCheckedList = (uuids: any[]): void => {
 261             const newCheckedList = { ...this.props.checkedList };
 262
 263             if(Object.keys(newCheckedList).length === 0){
 264                 for(const uuid of uuids){
 265                     newCheckedList[uuid] = false
 266                 }
 267             }
 268
 269             for (const key in newCheckedList) {
 270                 if (!uuids.includes(key)) {
 271                     delete newCheckedList[key];
 272                 }
 273             }
 274             this.props.setCheckedListOnStore(newCheckedList);
 275         };
 276
 277         isAllSelected = (list: TCheckedList): boolean => {
 278             for (const key in list) {
 279                 if (list[key] === false) return false;
 280             }
 281             return true;
 282         };
 283
 284         isAnySelected = (): boolean => {
 285             const { checkedList } = this.props;
 286             if (!checkedList) return false;
 287             if (!Object.keys(checkedList).length) return false;
 288             for (const key in checkedList) {
 289                 if (checkedList[key] === true) return true;
 290             }
 291             return false;
 292         };
 293
 294         handleSelectOne = (uuid: string): void => {
 295             const { checkedList } = this.props;
 296             const newCheckedList = { ...checkedList };
 297             newCheckedList[uuid] = !checkedList[uuid];
 298             this.setState({ isSelected: this.isAllSelected(newCheckedList) });
 299             this.props.setCheckedListOnStore(newCheckedList);
 300         };
 301
 302         handleSelectorSelect = (): void => {
 303             const { checkedList } = this.props;
 304             const { isSelected } = this.state;
 305             isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
 306         };
 307
 308         handleSelectAll = (list: TCheckedList): void => {
 309             if (Object.keys(list).length) {
 310                 const newCheckedList = { ...list };
 311                 for (const key in newCheckedList) {
 312                     newCheckedList[key] = true;
 313                 }
 314                 this.setState({ isSelected: true });
 315                 this.props.setCheckedListOnStore(newCheckedList);
 316             }
 317         };
 318
 319         handleSelectNone = (list: TCheckedList): void => {
 320             const newCheckedList = { ...list };
 321             for (const key in newCheckedList) {
 322                 newCheckedList[key] = false;
 323             }
 324             this.setState({ isSelected: false });
 325             this.props.setCheckedListOnStore(newCheckedList);
 326         };
 327
 328         handleInvertSelect = (list: TCheckedList): void => {
 329             if (Object.keys(list).length) {
 330                 const newCheckedList = { ...list };
 331                 for (const key in newCheckedList) {
 332                     newCheckedList[key] = !list[key];
 333                 }
 334                 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
 335                 this.props.setCheckedListOnStore(newCheckedList);
 336             }
 337         };
 338
 339         render() {
 340             const { items, classes, columns, isNotFound } = this.props;
 341             const { isLoaded } = this.state;
 342             if (columns.length && columns[0].name === this.checkBoxColumn.name) columns.shift();
 343             columns.unshift(this.checkBoxColumn);
 344             return (
 345                 <div className={classes.root}>
 346                     <div className={classes.content}>
 347                         <Table data-cy="data-table" stickyHeader>
 348                             <TableHead>
 349                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 350                             </TableHead>
 351                             <TableBody className={classes.tableBody}>{(isLoaded && !isNotFound) && items.map(this.renderBodyRow)}</TableBody>
 352                         </Table>
 353                         {(!isLoaded || isNotFound || items.length === 0) && this.renderNoItemsPlaceholder(this.props.columns)}
 354                     </div>
 355                 </div>
 356             );
 357         }
 358
 359         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 360             const { isLoaded } = this.state;
 361             const { working, isNotFound } = this.props;
 362             const dirty = columns.some(column => getTreeDirty("")(column.filters));
 363             if (isNotFound && isLoaded) {
 364                 return (
 365                     <DataTableDefaultView
 366                         icon={this.props.defaultViewIcon}
 367                         messages={["No items found"]}
 368                     />
 369                 );
 370             } else
 371             if (isLoaded === false || working === true) {
 372                 return (
 373                     <DataTableDefaultView
 374                         icon={PendingIcon}
 375                         messages={["Loading data, please wait"]}
 376                     />
 377                 );
 378             } else {
 379                 // isLoaded && !working && !isNotFound
 380                 return (
 381                     <DataTableDefaultView
 382                         icon={this.props.defaultViewIcon}
 383                         messages={this.props.defaultViewMessages}
 384                         filtersApplied={dirty}
 385                     />
 386                 );
 387             }
 388         };
 389
 390         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 391             const { name, key, renderHeader, filters, sort } = column;
 392             const { onSortToggle, onFiltersChange, classes, checkedList } = this.props;
 393             const { isSelected } = this.state;
 394             return column.name === "checkBoxColumn" ? (
 395                 <TableCell
 396                     key={key || index}
 397                     className={classes.checkBoxCell}>
 398                     <div className={classes.checkBoxHead}>
 399                         <Tooltip title={this.state.isSelected ? "Deselect all" : "Select all"}>
 400                             <input
 401                                 type="checkbox"
 402                                 className={classes.checkBox}
 403                                 checked={isSelected}
 404                                 disabled={!this.props.items.length}
 405                                 onChange={this.handleSelectorSelect}></input>
 406                         </Tooltip>
 407                         <DataTableMultiselectPopover
 408                             name={`Options`}
 409                             disabled={!this.props.items.length}
 410                             options={this.multiselectOptions}
 411                             checkedList={checkedList}></DataTableMultiselectPopover>
 412                     </div>
 413                 </TableCell>
 414             ) : (
 415                 <TableCell
 416                     className={classnames(classes.tableHead, index === 1 ? classes.firstTableHead : '')}
 417                     key={key || index}>
 418                     {renderHeader ? (
 419                         renderHeader()
 420                     ) : countNodes(filters) > 0 ? (
 421                         <DataTableFiltersPopover
 422                             name={`${name} filters`}
 423                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 424                             onChange={filters => onFiltersChange && onFiltersChange(filters, column)}
 425                             filters={filters}>
 426                             {name}
 427                         </DataTableFiltersPopover>
 428                     ) : sort ? (
 429                         <TableSortLabel
 430                             active={sort.direction !== SortDirection.NONE}
 431                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 432                             IconComponent={this.ArrowIcon}
 433                             hideSortIcon
 434                             onClick={() => onSortToggle && onSortToggle(column)}>
 435                             {name}
 436                         </TableSortLabel>
 437                     ) : (
 438                         <span>{name}</span>
 439                     )}
 440                 </TableCell>
 441             );
 442         };
 443
 444         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 445             <IconButton
 446                 data-cy="sort-button"
 447                 component="span"
 448                 className={this.props.classes.arrowButton}
 449                 tabIndex={-1}
 450                 size="large">
 451                 <ArrowDownwardIcon
 452                     {...props}
 453                     className={classnames(className, this.props.classes.arrow)}
 454                 />
 455             </IconButton>
 456         );
 457
 458         renderBodyRow = (item: any, index: number) => {
 459             const { onRowClick, onRowDoubleClick, extractKey, classes, selectedResourceUuid, currentRoute } = this.props;
 460             const { hoveredIndex } = this.state;
 461             const isRowSelected = item === selectedResourceUuid;
 462             const getClassnames = (colIndex: number) => {
 463                 if(currentRoute === '/workflows') return classes.tableCellWorkflows;
 464                 if(colIndex === 0) return classnames(classes.checkBoxCell, isRowSelected ? classes.selected : index === hoveredIndex ? classes.hovered : "");
 465                 if(colIndex === 1) return classnames(classes.tableCell, classes.firstTableCell, isRowSelected ? classes.selected : "");
 466                 return classnames(classes.tableCell, isRowSelected ? classes.selected : "");
 467             };
 468             const handleHover = (index: number | null) => {
 469                 this.setState({ hoveredIndex: index });
 470             }
 471
 472             return (
 473                 <TableRow
 474                     data-cy={'data-table-row'}
 475                     hover
 476                     key={extractKey ? extractKey(item) : index}
 477                     onClick={event => onRowClick && onRowClick(event, item)}
 478                     onContextMenu={this.handleRowContextMenu(item)}
 479                     onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 480                     selected={isRowSelected}
 481                     className={isRowSelected ? classes.selected : ""}
 482                     onMouseEnter={()=>handleHover(index)}
 483                     onMouseLeave={()=>handleHover(null)}
 484                 >
 485                     {this.mapVisibleColumns((column, colIndex) => (
 486                         <TableCell
 487                             key={column.key || colIndex}
 488                             data-cy={column.key || colIndex}
 489                             className={getClassnames(colIndex)}>
 490                             {column.render(item)}
 491                         </TableCell>
 492                     ))}
 493                 </TableRow>
 494             );
 495         };
 496
 497         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 498             return this.props.columns.filter(column => column.selected).map(fn);
 499         };
 500
 501         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 502     }
 503 );