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