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, DataColumns, 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";
  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 enum DataTableFetchMode {
  36     PAGINATED,
  37     INFINITE,
  38 }
  39
  40 export interface DataTableDataProps<I> {
  41     items: I[];
  42     columns: DataColumns<I, any>;
  43     onRowClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  44     onContextMenu: (event: React.MouseEvent<HTMLElement>, item: I) => void;
  45     onRowDoubleClick: (event: React.MouseEvent<HTMLTableRowElement>, item: I) => void;
  46     onSortToggle: (column: DataColumn<I, any>) => void;
  47     onFiltersChange: (filters: DataTableFilters, column: DataColumn<I, any>) => void;
  48     extractKey?: (item: I) => React.Key;
  49     working?: boolean;
  50     defaultViewIcon?: IconType;
  51     defaultViewMessages?: string[];
  52     toggleMSToolbar: (isVisible: boolean) => void;
  53     setCheckedListOnStore: (checkedList: TCheckedList) => void;
  54     currentRoute?: string;
  55     currentRouteUuid: string;
  56     checkedList: TCheckedList;
  57     selectedResourceUuid: string;
  58     setSelectedUuid: (uuid: string | null) => void;
  59     isNotFound?: boolean;
  60     detailsPanelResourceUuid?: string;
  61     loadDetailsPanel: (uuid: string) => void;
  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             if(this.props.detailsPanelResourceUuid !== this.props.selectedResourceUuid) {
 219                 this.props.loadDetailsPanel(this.props.selectedResourceUuid);
 220             }
 221         }
 222
 223         componentWillUnmount(): void {
 224             this.initializeCheckedList([]);
 225         }
 226
 227         checkBoxColumn: DataColumn<any, any> = {
 228             name: "checkBoxColumn",
 229             selected: true,
 230             configurable: false,
 231             filters: createTree(),
 232             render: uuid => {
 233                 const { classes, checkedList } = this.props;
 234                 return (
 235                     <div
 236                         className={classes.clickBox}
 237                         onClick={(ev) => {
 238                             ev.stopPropagation()
 239                             this.handleSelectOne(uuid)
 240                         }}
 241                         onDoubleClick={(ev) => ev.stopPropagation()}
 242                     >
 243                         <input
 244                             data-cy={`multiselect-checkbox-${uuid}`}
 245                             type='checkbox'
 246                             name={uuid}
 247                             className={classes.checkBox}
 248                             checked={checkedList && checkedList[uuid] ? checkedList[uuid] : false}
 249                             onChange={() => this.handleSelectOne(uuid)}
 250                             onDoubleClick={(ev) => ev.stopPropagation()}
 251                         ></input>
 252                     </div>
 253                 );
 254             },
 255         };
 256
 257         multiselectOptions: DataTableMultiselectOption[] = [
 258             { name: "All", fn: list => this.handleSelectAll(list) },
 259             { name: "None", fn: list => this.handleSelectNone(list) },
 260             { name: "Invert", fn: list => this.handleInvertSelect(list) },
 261         ];
 262
 263         initializeCheckedList = (uuids: any[]): void => {
 264             const newCheckedList = { ...this.props.checkedList };
 265
 266             if(Object.keys(newCheckedList).length === 0){
 267                 for(const uuid of uuids){
 268                     newCheckedList[uuid] = false
 269                 }
 270             }
 271
 272             for (const key in newCheckedList) {
 273                 if (!uuids.includes(key)) {
 274                     delete newCheckedList[key];
 275                 }
 276             }
 277             this.props.setCheckedListOnStore(newCheckedList);
 278         };
 279
 280         isAllSelected = (list: TCheckedList): boolean => {
 281             for (const key in list) {
 282                 if (list[key] === false) return false;
 283             }
 284             return true;
 285         };
 286
 287         isAnySelected = (): boolean => {
 288             const { checkedList } = this.props;
 289             if (!checkedList) return false;
 290             if (!Object.keys(checkedList).length) return false;
 291             for (const key in checkedList) {
 292                 if (checkedList[key] === true) return true;
 293             }
 294             return false;
 295         };
 296
 297         handleSelectOne = (uuid: string): void => {
 298             const { checkedList } = this.props;
 299             const newCheckedList = { ...checkedList };
 300             newCheckedList[uuid] = !checkedList[uuid];
 301             this.setState({ isSelected: this.isAllSelected(newCheckedList) });
 302             this.props.setCheckedListOnStore(newCheckedList);
 303         };
 304
 305         handleSelectorSelect = (): void => {
 306             const { checkedList } = this.props;
 307             const { isSelected } = this.state;
 308             isSelected ? this.handleSelectNone(checkedList) : this.handleSelectAll(checkedList);
 309         };
 310
 311         handleSelectAll = (list: TCheckedList): void => {
 312             if (Object.keys(list).length) {
 313                 const newCheckedList = { ...list };
 314                 for (const key in newCheckedList) {
 315                     newCheckedList[key] = true;
 316                 }
 317                 this.setState({ isSelected: true });
 318                 this.props.setCheckedListOnStore(newCheckedList);
 319             }
 320         };
 321
 322         handleSelectNone = (list: TCheckedList): void => {
 323             const newCheckedList = { ...list };
 324             for (const key in newCheckedList) {
 325                 newCheckedList[key] = false;
 326             }
 327             this.setState({ isSelected: false });
 328             this.props.setCheckedListOnStore(newCheckedList);
 329         };
 330
 331         handleInvertSelect = (list: TCheckedList): void => {
 332             if (Object.keys(list).length) {
 333                 const newCheckedList = { ...list };
 334                 for (const key in newCheckedList) {
 335                     newCheckedList[key] = !list[key];
 336                 }
 337                 this.setState({ isSelected: this.isAllSelected(newCheckedList) });
 338                 this.props.setCheckedListOnStore(newCheckedList);
 339             }
 340         };
 341
 342         render() {
 343             const { items, classes, columns, isNotFound } = this.props;
 344             const { isLoaded } = this.state;
 345             if (columns.length && columns[0].name === this.checkBoxColumn.name) columns.shift();
 346             columns.unshift(this.checkBoxColumn);
 347             return (
 348                 <div className={classes.root}>
 349                     <div className={classes.content}>
 350                         <Table data-cy="data-table" stickyHeader>
 351                             <TableHead>
 352                                 <TableRow>{this.mapVisibleColumns(this.renderHeadCell)}</TableRow>
 353                             </TableHead>
 354                             <TableBody className={classes.tableBody}>{(isLoaded && !isNotFound) && items.map(this.renderBodyRow)}</TableBody>
 355                         </Table>
 356                         {(!isLoaded || isNotFound || items.length === 0) && this.renderNoItemsPlaceholder(this.props.columns)}
 357                     </div>
 358                 </div>
 359             );
 360         }
 361
 362         renderNoItemsPlaceholder = (columns: DataColumns<T, any>) => {
 363             const { isLoaded } = this.state;
 364             const { working, isNotFound } = this.props;
 365             const dirty = columns.some(column => getTreeDirty("")(column.filters));
 366             if (isNotFound && isLoaded) {
 367                 return (
 368                     <DataTableDefaultView
 369                         icon={this.props.defaultViewIcon}
 370                         messages={["No items found"]}
 371                     />
 372                 );
 373             } else
 374             if (isLoaded === false || working === true) {
 375                 return (
 376                     <DataTableDefaultView
 377                         icon={PendingIcon}
 378                         messages={["Loading data, please wait"]}
 379                     />
 380                 );
 381             } else {
 382                 // isLoaded && !working && !isNotFound
 383                 return (
 384                     <DataTableDefaultView
 385                         icon={this.props.defaultViewIcon}
 386                         messages={this.props.defaultViewMessages}
 387                         filtersApplied={dirty}
 388                     />
 389                 );
 390             }
 391         };
 392
 393         renderHeadCell = (column: DataColumn<T, any>, index: number) => {
 394             const { name, key, renderHeader, filters, sort } = column;
 395             const { onSortToggle, onFiltersChange, classes, checkedList } = this.props;
 396             const { isSelected } = this.state;
 397             return column.name === "checkBoxColumn" ? (
 398                 <TableCell
 399                     key={key || index}
 400                     className={classes.checkBoxCell}>
 401                     <div className={classes.checkBoxHead}>
 402                         <Tooltip title={this.state.isSelected ? "Deselect all" : "Select all"}>
 403                             <input
 404                                 type="checkbox"
 405                                 className={classes.checkBox}
 406                                 checked={isSelected}
 407                                 disabled={!this.props.items.length}
 408                                 onChange={this.handleSelectorSelect}></input>
 409                         </Tooltip>
 410                         <DataTableMultiselectPopover
 411                             name={`Options`}
 412                             disabled={!this.props.items.length}
 413                             options={this.multiselectOptions}
 414                             checkedList={checkedList}></DataTableMultiselectPopover>
 415                     </div>
 416                 </TableCell>
 417             ) : (
 418                 <TableCell
 419                     className={classnames(classes.tableHead, index === 1 ? classes.firstTableHead : '')}
 420                     key={key || index}>
 421                     {renderHeader ? (
 422                         renderHeader()
 423                     ) : countNodes(filters) > 0 ? (
 424                         <DataTableFiltersPopover
 425                             name={`${name} filters`}
 426                             mutuallyExclusive={column.mutuallyExclusiveFilters}
 427                             onChange={filters => onFiltersChange && onFiltersChange(filters, column)}
 428                             filters={filters}>
 429                             {name}
 430                         </DataTableFiltersPopover>
 431                     ) : sort ? (
 432                         <TableSortLabel
 433                             active={sort.direction !== SortDirection.NONE}
 434                             direction={sort.direction !== SortDirection.NONE ? sort.direction : undefined}
 435                             IconComponent={this.ArrowIcon}
 436                             hideSortIcon
 437                             onClick={() => onSortToggle && onSortToggle(column)}>
 438                             {name}
 439                         </TableSortLabel>
 440                     ) : (
 441                         <span>{name}</span>
 442                     )}
 443                 </TableCell>
 444             );
 445         };
 446
 447         ArrowIcon = ({ className, ...props }: SvgIconProps) => (
 448             <IconButton
 449                 data-cy="sort-button"
 450                 component="span"
 451                 className={this.props.classes.arrowButton}
 452                 tabIndex={-1}
 453                 size="large">
 454                 <ArrowDownwardIcon
 455                     {...props}
 456                     className={classnames(className, this.props.classes.arrow)}
 457                 />
 458             </IconButton>
 459         );
 460
 461         renderBodyRow = (item: any, index: number) => {
 462             const { onRowClick, onRowDoubleClick, extractKey, classes, selectedResourceUuid, currentRoute } = this.props;
 463             const { hoveredIndex } = this.state;
 464             const isRowSelected = item === selectedResourceUuid;
 465             const getClassnames = (colIndex: number) => {
 466                 if(currentRoute === '/workflows') return classes.tableCellWorkflows;
 467                 if(colIndex === 0) return classnames(classes.checkBoxCell, isRowSelected ? classes.selected : index === hoveredIndex ? classes.hovered : "");
 468                 if(colIndex === 1) return classnames(classes.tableCell, classes.firstTableCell, isRowSelected ? classes.selected : "");
 469                 return classnames(classes.tableCell, isRowSelected ? classes.selected : "");
 470             };
 471             const handleHover = (index: number | null) => {
 472                 this.setState({ hoveredIndex: index });
 473             }
 474
 475             return (
 476                 <TableRow
 477                     data-cy={'data-table-row'}
 478                     hover
 479                     key={extractKey ? extractKey(item) : index}
 480                     onClick={event => onRowClick && onRowClick(event, item)}
 481                     onContextMenu={this.handleRowContextMenu(item)}
 482                     onDoubleClick={event => onRowDoubleClick && onRowDoubleClick(event, item)}
 483                     selected={isRowSelected}
 484                     className={isRowSelected ? classes.selected : ""}
 485                     onMouseEnter={()=>handleHover(index)}
 486                     onMouseLeave={()=>handleHover(null)}
 487                 >
 488                     {this.mapVisibleColumns((column, colIndex) => (
 489                         <TableCell
 490                             key={column.key || colIndex}
 491                             data-cy={column.key || colIndex}
 492                             className={getClassnames(colIndex)}>
 493                             {column.render(item)}
 494                         </TableCell>
 495                     ))}
 496                 </TableRow>
 497             );
 498         };
 499
 500         mapVisibleColumns = (fn: (column: DataColumn<T, any>, index: number) => React.ReactElement<any>) => {
 501             return this.props.columns.filter(column => column.selected).map(fn);
 502         };
 503
 504         handleRowContextMenu = (item: T) => (event: React.MouseEvent<HTMLElement>) => this.props.onContextMenu(event, item);
 505     }
 506 );