/* * QQQ - Low-code Application Framework for Engineers. * Copyright (C) 2021-2022. Kingsrook, LLC * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States * contact@kingsrook.com * https://github.com/Kingsrook/ * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ import {QFieldType} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QFieldType"; import {QProcessMetaData} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QProcessMetaData"; import {QTableMetaData} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QTableMetaData"; import {QRecord} from "@kingsrook/qqq-frontend-core/lib/model/QRecord"; import {QFilterCriteria} from "@kingsrook/qqq-frontend-core/lib/model/query/QFilterCriteria"; import {QFilterOrderBy} from "@kingsrook/qqq-frontend-core/lib/model/query/QFilterOrderBy"; import {QQueryFilter} from "@kingsrook/qqq-frontend-core/lib/model/query/QQueryFilter"; import {Alert, TablePagination} from "@mui/material"; import Button from "@mui/material/Button"; import Card from "@mui/material/Card"; import Icon from "@mui/material/Icon"; import LinearProgress from "@mui/material/LinearProgress"; import Menu from "@mui/material/Menu"; import MenuItem from "@mui/material/MenuItem"; import {DataGridPro, GridCallbackDetails, GridColDef, GridColumnOrderChangeParams, GridColumnVisibilityModel, GridFilterModel, GridRowId, GridRowParams, GridRowsProp, GridSelectionModel, GridSortItem, GridSortModel, GridToolbarColumnsButton, GridToolbarContainer, GridToolbarDensitySelector, GridToolbarExportContainer, GridToolbarFilterButton, GridExportMenuItemProps, MuiEvent} from "@mui/x-data-grid-pro"; import React, {useCallback, useEffect, useReducer, useRef, useState} from "react"; import {Link, useNavigate, useParams, useSearchParams} from "react-router-dom"; import DashboardLayout from "qqq/components/DashboardLayout"; import Footer from "qqq/components/Footer"; import Navbar from "qqq/components/Navbar"; import {QActionsMenuButton, QCreateNewButton} from "qqq/components/QButtons"; import MDAlert from "qqq/components/Temporary/MDAlert"; import MDBox from "qqq/components/Temporary/MDBox"; import QClient from "qqq/utils/QClient"; import QFilterUtils from "qqq/utils/QFilterUtils"; import QProcessUtils from "qqq/utils/QProcessUtils"; import QValueUtils from "qqq/utils/QValueUtils"; const COLUMN_VISIBILITY_LOCAL_STORAGE_KEY_ROOT = "qqq.columnVisibility"; const COLUMN_SORT_LOCAL_STORAGE_KEY_ROOT = "qqq.columnSort"; const FILTER_LOCAL_STORAGE_KEY_ROOT = "qqq.filter"; interface Props { table?: QTableMetaData; } /******************************************************************************* ** Get the default filter to use on the page - either from query string, or ** local storage, or a default (empty). *******************************************************************************/ function getDefaultFilter(tableMetaData: QTableMetaData, searchParams: URLSearchParams, filterLocalStorageKey: string): GridFilterModel { if (tableMetaData.fields !== undefined) { if (searchParams.has("filter")) { try { const qQueryFilter = JSON.parse(searchParams.get("filter")) as QQueryFilter; ////////////////////////////////////////////////////////////////// // translate from a qqq-style filter to one that the grid wants // ////////////////////////////////////////////////////////////////// const defaultFilter = {items: []} as GridFilterModel; let id = 1; qQueryFilter.criteria.forEach((criteria) => { const fieldType = tableMetaData.fields.get(criteria.fieldName).type; defaultFilter.items.push({ columnField: criteria.fieldName, operatorValue: QFilterUtils.qqqCriteriaOperatorToGrid(criteria.operator, fieldType), value: QFilterUtils.qqqCriteriaValuesToGrid(criteria.operator, criteria.values), id: id++, // not sure what this id is!! }); }); return (defaultFilter); } catch (e) { console.warn("Error parsing filter from query string", e); } } if (localStorage.getItem(filterLocalStorageKey)) { const defaultFilter = JSON.parse(localStorage.getItem(filterLocalStorageKey)); console.log(`Got default from LS: ${JSON.stringify(defaultFilter)}`); return (defaultFilter); } } return ({items: []}); } function EntityList({table}: Props): JSX.Element { const tableNameParam = useParams().tableName; const tableName = table === null ? tableNameParam : table.name; const [searchParams] = useSearchParams(); const qController = QClient.getInstance(); //////////////////////////////////////////// // look for defaults in the local storage // //////////////////////////////////////////// const sortLocalStorageKey = `${COLUMN_SORT_LOCAL_STORAGE_KEY_ROOT}.${tableName}`; const columnVisibilityLocalStorageKey = `${COLUMN_VISIBILITY_LOCAL_STORAGE_KEY_ROOT}.${tableName}`; const filterLocalStorageKey = `${FILTER_LOCAL_STORAGE_KEY_ROOT}.${tableName}`; let defaultSort = [] as GridSortItem[]; let defaultVisibility = {}; if (localStorage.getItem(sortLocalStorageKey)) { defaultSort = JSON.parse(localStorage.getItem(sortLocalStorageKey)); } if (localStorage.getItem(columnVisibilityLocalStorageKey)) { defaultVisibility = JSON.parse(localStorage.getItem(columnVisibilityLocalStorageKey)); } const [filterModel, setFilterModel] = useState({items: []} as GridFilterModel); const [columnSortModel, setColumnSortModel] = useState(defaultSort); const [columnVisibilityModel, setColumnVisibilityModel] = useState(defaultVisibility); /////////////////////////////////////////////////////////////////////////////////////////////// // for some reason, if we set the filterModel to what is in local storage, an onChange event // // fires on the grid anyway with an empty filter, so be aware of the first onchange, and // // when that happens put the default back - it needs to be in state // // const [defaultFilter1] = useState(defaultFilter); // /////////////////////////////////////////////////////////////////////////////////////////////// const [defaultFilter] = useState({items: []} as GridFilterModel); const [tableState, setTableState] = useState(""); const [tableMetaData, setTableMetaData] = useState(null as QTableMetaData); const [defaultFilterLoaded, setDefaultFilterLoaded] = useState(false); const [, setFiltersMenu] = useState(null); const [actionsMenu, setActionsMenu] = useState(null); const [tableProcesses, setTableProcesses] = useState([] as QProcessMetaData[]); const [pageNumber, setPageNumber] = useState(0); const [totalRecords, setTotalRecords] = useState(0); const [rowsPerPage, setRowsPerPage] = useState(10); const [selectedIds, setSelectedIds] = useState([] as string[]); const [selectFullFilterState, setSelectFullFilterState] = useState("n/a" as "n/a" | "checked" | "filter"); const [columns, setColumns] = useState([] as GridColDef[]); const [rows, setRows] = useState([] as GridRowsProp[]); const [loading, setLoading] = useState(true); const [alertContent, setAlertContent] = useState(""); const [tableLabel, setTableLabel] = useState(""); const [gridMouseDownX, setGridMouseDownX] = useState(0); const [gridMouseDownY, setGridMouseDownY] = useState(0); const [pinnedColumns, setPinnedColumns] = useState({left: ["__check__", "id"]}); const instance = useRef({timer: null}); //////////////////////////////////////////////////////////////////////////////////////////////////////////////// // use all these states to avoid showing results from an "old" query, that finishes loading after a newer one // //////////////////////////////////////////////////////////////////////////////////////////////////////////////// const [latestQueryId, setLatestQueryId] = useState(0); const [countResults, setCountResults] = useState({} as any); const [receivedCountTimestamp, setReceivedCountTimestamp] = useState(new Date()); const [queryResults, setQueryResults] = useState({} as any); const [receivedQueryTimestamp, setReceivedQueryTimestamp] = useState(new Date()); const [queryErrors, setQueryErrors] = useState({} as any); const [receivedQueryErrorTimestamp, setReceivedQueryErrorTimestamp] = useState(new Date()); const [, forceUpdate] = useReducer((x) => x + 1, 0); const openActionsMenu = (event: any) => setActionsMenu(event.currentTarget); const closeActionsMenu = () => setActionsMenu(null); const buildQFilter = () => { const qFilter = new QQueryFilter(); if (columnSortModel) { columnSortModel.forEach((gridSortItem) => { qFilter.addOrderBy(new QFilterOrderBy(gridSortItem.field, gridSortItem.sort === "asc")); }); } if (filterModel) { filterModel.items.forEach((item) => { const operator = QFilterUtils.gridCriteriaOperatorToQQQ(item.operatorValue); const values = QFilterUtils.gridCriteriaValueToQQQ(operator, item.value); qFilter.addCriteria(new QFilterCriteria(item.columnField, operator, values)); }); } return qFilter; }; const updateTable = () => { setLoading(true); setRows([]); (async () => { const tableMetaData = await qController.loadTableMetaData(tableName); //////////////////////////////////////////////////////////////////////////////////////////////// // we need the table meta data to look up the default filter (if it comes from query string), // // because we need to know field types to translate qqq filter to material filter // // return here ane wait for the next 'turn' to allow doing the actual query // //////////////////////////////////////////////////////////////////////////////////////////////// if (!defaultFilterLoaded) { setDefaultFilterLoaded(true); setFilterModel(getDefaultFilter(tableMetaData, searchParams, filterLocalStorageKey)); return; } setTableMetaData(tableMetaData); setTableLabel(tableMetaData.label); if (columnSortModel.length === 0) { columnSortModel.push({ field: tableMetaData.primaryKeyField, sort: "desc", }); setColumnSortModel(columnSortModel); } setPinnedColumns({left: ["__check__", tableMetaData.primaryKeyField]}); const qFilter = buildQFilter(); ////////////////////////////////////////////////////////////////////////////////////////////////// // assign a new query id to the query being issued here. then run both the count & query async // // and when they load, store their results associated with this id. // ////////////////////////////////////////////////////////////////////////////////////////////////// const thisQueryId = latestQueryId + 1 setLatestQueryId(thisQueryId); console.log(`Issuing query: ${thisQueryId}`); qController.count(tableName, qFilter).then((count) => { countResults[thisQueryId] = count; setCountResults(countResults); setReceivedCountTimestamp(new Date()); }); qController.query(tableName, qFilter, rowsPerPage, pageNumber * rowsPerPage).then((results) => { console.log(`Received results for query ${thisQueryId}`); queryResults[thisQueryId] = results; setQueryResults(queryResults); setReceivedQueryTimestamp(new Date()); }) .catch((error) => { console.log(`Received error for query ${thisQueryId}`); console.log(error); var errorMessage; if (error && error.message) { errorMessage = error.message; } else if(error && error.response && error.response.data && error.response.data.error) { errorMessage = error.response.data.error; } else { errorMessage = "Unexpected error running query"; } queryErrors[thisQueryId] = errorMessage; setQueryErrors(queryErrors); setReceivedQueryErrorTimestamp(new Date()); throw error; }); })(); } /////////////////////////// // display count results // /////////////////////////// useEffect(() => { if (countResults[latestQueryId] === null) { /////////////////////////////////////////////// // see same idea in displaying query results // /////////////////////////////////////////////// console.log(`No count results for id ${latestQueryId}...`); return; } setTotalRecords(countResults[latestQueryId]); delete countResults[latestQueryId]; }, [receivedCountTimestamp]); /////////////////////////// // display query results // /////////////////////////// useEffect(() => { if(!queryResults[latestQueryId]) { /////////////////////////////////////////////////////////////////////////////////////////// // to avoid showing results from an "older" query (e.g., one that was slow, and returned // // AFTER a newer one) only ever show results here for the latestQueryId that was issued. // /////////////////////////////////////////////////////////////////////////////////////////// console.log(`No query results for id ${latestQueryId}...`); return; } console.log(`Outputting results for query ${latestQueryId}...`); const results = queryResults[latestQueryId]; delete queryResults[latestQueryId]; const fields = [...tableMetaData.fields.values()]; const rows = [] as any[]; results.forEach((record: QRecord) => { const row: any = {}; fields.forEach((field) => { row[field.name] = QValueUtils.getDisplayValue(field, record); }); rows.push(row); }); const sortedKeys: string[] = []; for (let i = 0; i < tableMetaData.sections.length; i++) { const section = tableMetaData.sections[i]; for (let j = 0; j < section.fieldNames.length; j++) { sortedKeys.push(section.fieldNames[j]); } } const columns = [] as GridColDef[]; sortedKeys.forEach((key) => { const field = tableMetaData.fields.get(key); let columnType = "string"; let columnWidth = 200; if (!field.possibleValueSourceName) { switch (field.type) { case QFieldType.DECIMAL: case QFieldType.INTEGER: columnType = "number"; columnWidth = 100; if (key === tableMetaData.primaryKeyField && field.label.length < 3) { columnWidth = 75; } break; case QFieldType.DATE: columnType = "date"; columnWidth = 100; break; case QFieldType.DATE_TIME: columnType = "dateTime"; columnWidth = 200; break; case QFieldType.BOOLEAN: columnType = "boolean"; columnWidth = 75; break; default: // noop - leave as string } } const column = { field: field.name, type: columnType, headerName: field.label, width: columnWidth, renderCell: null as any, }; if (key === tableMetaData.primaryKeyField) { columns.splice(0, 0, column); column.renderCell = (cellValues: any) => ( {cellValues.value} ); } else { columns.push(column); } }); setColumns(columns); setRows(rows); setLoading(false); setAlertContent(null); forceUpdate(); }, [receivedQueryTimestamp]); ///////////////////////// // display query error // ///////////////////////// useEffect(() => { if (!queryErrors[latestQueryId]) { /////////////////////////////// // same logic as for success // /////////////////////////////// console.log(`No query error for id ${latestQueryId}...`); return; } console.log(`Outputting error for query ${latestQueryId}...`); const errorMessage = queryErrors[latestQueryId]; delete queryErrors[latestQueryId]; setLoading(false); setAlertContent(errorMessage); }, [receivedQueryErrorTimestamp]); const handlePageChange = (page: number) => { setPageNumber(page); }; const handleRowsPerPageChange = (size: number) => { setRowsPerPage(size); }; const navigate = useNavigate(); const handleRowClick = (params: GridRowParams, event: MuiEvent, details: GridCallbackDetails) => { /////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // strategy for when to trigger or not trigger a row click: // // To avoid a drag-event that highlighted text in a cell: // // - we capture the x & y upon mouse-down - then compare them in this method (which fires when the mouse is up) // // if they are more than 5 pixels away from the mouse-down, then assume it's a drag, not a click. // // - avoid clicking the row upon double-click, by setting a 500ms timer here - and in the onDoubleClick handler, // // cancelling the timer. // // - also avoid a click, then click-again-and-start-dragging, by always cancelling the timer in mouse-down. // // All in, these seem to have good results - the only downside being the half-second delay... // /////////////////////////////////////////////////////////////////////////////////////////////////////////////////// navigate(`${params.id}`); /* const diff = Math.max(Math.abs(event.clientX - gridMouseDownX), Math.abs(event.clientY - gridMouseDownY)); if (diff < 5) { clearTimeout(instance.current.timer); instance.current.timer = setTimeout(() => { navigate(`${params.id}`); }, 500); } else { console.log(`row-click mouse-up happened ${diff} x or y pixels away from the mouse-down - so not considering it a click.`); } */ }; const handleGridMouseDown = useCallback((event: any) => { setGridMouseDownX(event.clientX); setGridMouseDownY(event.clientY); clearTimeout(instance.current.timer); }, []); const handleGridDoubleClick = useCallback((event: any) => { clearTimeout(instance.current.timer); }, []); const selectionChanged = (selectionModel: GridSelectionModel, details: GridCallbackDetails) => { const newSelectedIds: string[] = []; selectionModel.forEach((value: GridRowId) => { newSelectedIds.push(value as string); }); setSelectedIds(newSelectedIds); if (newSelectedIds.length === rowsPerPage) { setSelectFullFilterState("checked"); } else { setSelectFullFilterState("n/a"); } }; const handleColumnVisibilityChange = (columnVisibilityModel: GridColumnVisibilityModel) => { setColumnVisibilityModel(columnVisibilityModel); if (columnVisibilityLocalStorageKey) { localStorage.setItem( columnVisibilityLocalStorageKey, JSON.stringify(columnVisibilityModel), ); } }; const handleColumnOrderChange = (columnOrderChangeParams: GridColumnOrderChangeParams) => { // TODO: make local storaged console.log(JSON.stringify(columns)); console.log(columnOrderChangeParams); }; const handleFilterChange = (filterModel: GridFilterModel) => { setFilterModel(filterModel); if (filterLocalStorageKey) { localStorage.setItem( filterLocalStorageKey, JSON.stringify(filterModel), ); } }; const handleSortChange = (gridSort: GridSortModel) => { if (gridSort && gridSort.length > 0) { setColumnSortModel(gridSort); localStorage.setItem(sortLocalStorageKey, JSON.stringify(gridSort)); } }; if (tableName !== tableState) { (async () => { setTableState(tableName); setFiltersMenu(null); const metaData = await qController.loadMetaData(); setTableProcesses(QProcessUtils.getProcessesForTable(metaData, tableName)); // reset rows to trigger rerender setRows([]); })(); } interface QExportMenuItemProps extends GridExportMenuItemProps<{}> { format: string; } function ExportMenuItem(props: QExportMenuItemProps) { const {format, hideMenu} = props; return ( { /////////////////////////////////////////////////////////////////////////////// // build the list of visible fields. note, not doing them in-order (in case // // the user did drag & drop), because column order model isn't right yet // // so just doing them to match columns (which were pKey, then sorted) // /////////////////////////////////////////////////////////////////////////////// const visibleFields: string[] = []; columns.forEach((gridColumn) => { const fieldName = gridColumn.field; // @ts-ignore if (columnVisibilityModel[fieldName] !== false) { visibleFields.push(fieldName); } }); /////////////////////// // zero-pad function // /////////////////////// const zp = (value: number): string => (value < 10 ? `0${value}` : `${value}`); ////////////////////////////////////// // construct the url for the export // ////////////////////////////////////// const d = new Date(); const dateString = `${d.getFullYear()}-${zp(d.getMonth())}-${zp(d.getDate())} ${zp(d.getHours())}${zp(d.getMinutes())}`; const filename = `${tableMetaData.label} Export ${dateString}.${format}`; const url = `/data/${tableMetaData.name}/export/${filename}?filter=${encodeURIComponent(JSON.stringify(buildQFilter()))}&fields=${visibleFields.join(",")}`; ////////////////////////////////////////////////////////////////////////////////////// // open a window (tab) with a little page that says the file is being generated. // // then have that page load the url for the export. // // If there's an error, it'll appear in that window. else, the file will download. // ////////////////////////////////////////////////////////////////////////////////////// const exportWindow = window.open("", "_blank"); exportWindow.document.write(` ${filename} Generating file ${filename} with ${totalRecords.toLocaleString()} records... `); /////////////////////////////////////////// // Hide the export menu after the export // /////////////////////////////////////////// hideMenu?.(); }} > Export {` ${format.toUpperCase()}`} ); } function getNoOfSelectedRecords() { if (selectFullFilterState === "filter") { return (totalRecords); } return (selectedIds.length); } function getRecordsQueryString() { if (selectFullFilterState === "filter") { return `?recordsParam=filterJSON&filterJSON=${JSON.stringify(buildQFilter())}`; } if (selectedIds.length > 0) { return `?recordsParam=recordIds&recordIds=${selectedIds.join(",")}`; } return ""; } const bulkLoadClicked = () => { navigate(`${tableName}.bulkInsert`); }; const bulkEditClicked = () => { if (getNoOfSelectedRecords() === 0) { setAlertContent("No records were selected to Bulk Edit."); return; } navigate(`${tableName}.bulkEdit${getRecordsQueryString()}`); }; const bulkDeleteClicked = () => { if (getNoOfSelectedRecords() === 0) { setAlertContent("No records were selected to Bulk Delete."); return; } navigate(`${tableName}.bulkDelete${getRecordsQueryString()}`); }; const processClicked = (process: QProcessMetaData) => { // todo - let the process specify that it needs initial rows - err if none selected. // alternatively, let a process itself have an initial screen to select rows... navigate(`${process.name}${getRecordsQueryString()}`); }; // @ts-ignore const defaultLabelDisplayedRows = ({from, to, count}) => { if(count !== null && count !== undefined) { if(count === 0) { return ("No rows"); } return (`Showing ${from.toLocaleString()} to ${to.toLocaleString()} of ${count !== -1 ? `${count.toLocaleString()} records` : `more than ${to.toLocaleString()} records`}`); } else { return ("Counting records..."); } } function CustomPagination() { return ( handlePageChange(value)} onRowsPerPageChange={(event) => handleRowsPerPageChange(Number(event.target.value))} labelDisplayedRows={defaultLabelDisplayedRows} /> ); } function Loading() { return ( ); } function CustomToolbar() { return (
{ selectFullFilterState === "checked" && (
The {` ${selectedIds.length.toLocaleString()} `} records on this page are selected.
) } { selectFullFilterState === "filter" && (
All {` ${totalRecords.toLocaleString()} `} records matching this query are selected.
) }
); } const renderActionsMenu = ( Bulk Load Bulk Edit Bulk Delete {tableProcesses.length > 0 && } {tableProcesses.map((process) => ( processClicked(process)}>{process.label} ))} ); /////////////////////////////////////////////////////////////////////////////////////////// // for changes in table controls that don't change the count, call to update the table - // // but without clearing out totalRecords (so pagination doesn't flash) // /////////////////////////////////////////////////////////////////////////////////////////// useEffect(() => { updateTable(); }, [pageNumber, rowsPerPage, columnSortModel]); /////////////////////////////////////////////////////////////////////////////////////////////////////////////// // for state changes that DO change the filter, call to update the table - and DO clear out the totalRecords // /////////////////////////////////////////////////////////////////////////////////////////////////////////////// useEffect(() => { setTotalRecords(null); updateTable(); }, [tableState, filterModel]); useEffect(() => { document.documentElement.scrollTop = 0; document.scrollingElement.scrollTop = 0; }, [pageNumber, rowsPerPage]); return ( {alertContent ? ( { setAlertContent(null); }} > {alertContent} ) : ( "" )} { (tableLabel && searchParams.get("deleteSuccess")) ? ( {`${tableLabel} successfully deleted`} ) : null } {renderActionsMenu} {/* with these turned on, the toolbar & pagination controls become very flaky... onMouseDown={(e) => handleGridMouseDown(e)} onDoubleClick={(e) => handleGridDoubleClick(e)} */} (params.indexRelativeToCurrentPage % 2 === 0 ? "even" : "odd")} />