PromucFlow_constructor/app/client/src/widgets/TableWidgetV2/component/Table.tsx
Ivan Akulov 424d2f6965
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
## Description

This PR upgrades Prettier to v2 + enforces TypeScript’s [`import
type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export)
syntax where applicable. It’s submitted as a separate PR so we can merge
it easily.

As a part of this PR, we reformat the codebase heavily:
- add `import type` everywhere where it’s required, and
- re-format the code to account for Prettier 2’s breaking changes:
https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes

This PR is submitted against `release` to make sure all new code by team
members will adhere to new formatting standards, and we’ll have fewer
conflicts when merging `bundle-optimizations` into `release`. (I’ll
merge `release` back into `bundle-optimizations` once this PR is
merged.)

### Why is this needed?

This PR is needed because, for the Lodash optimization from
7cbb12af88,
we need to use `import type`. Otherwise, `babel-plugin-lodash` complains
that `LoDashStatic` is not a lodash function.

However, just using `import type` in the current codebase will give you
this:

<img width="962" alt="Screenshot 2023-03-08 at 17 45 59"
src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png">

That’s because Prettier 1 can’t parse `import type` at all. To parse it,
we need to upgrade to Prettier 2.

### Why enforce `import type`?

Apart from just enabling `import type` support, this PR enforces
specifying `import type` everywhere it’s needed. (Developers will get
immediate TypeScript and ESLint errors when they forget to do so.)

I’m doing this because I believe `import type` improves DX and makes
refactorings easier.

Let’s say you had a few imports like below. Can you tell which of these
imports will increase the bundle size? (Tip: it’s not all of them!)

```ts
// app/client/src/workers/Linting/utils.ts
import { Position } from "codemirror";
import { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```

It’s pretty hard, right?

What about now?

```ts
// app/client/src/workers/Linting/utils.ts
import type { Position } from "codemirror";
import type { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```

Now, it’s clear that only `lodash` will be bundled.

This helps developers to see which imports are problematic, but it
_also_ helps with refactorings. Now, if you want to see where
`codemirror` is bundled, you can just grep for `import \{.*\} from
"codemirror"` – and you won’t get any type-only imports.

This also helps (some) bundlers. Upon transpiling, TypeScript erases
type-only imports completely. In some environment (not ours), this makes
the bundle smaller, as the bundler doesn’t need to bundle type-only
imports anymore.

## Type of change

- Chore (housekeeping or task changes that don't impact user perception)


## How Has This Been Tested?

This was tested to not break the build.

### Test Plan
> Add Testsmith test cases links that relate to this PR

### Issues raised during DP testing
> Link issues raised during DP testing for better visiblity and tracking
(copy link from comments dropped on this PR)


## Checklist:
### Dev activity
- [x] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] PR is being merged under a feature flag


### QA activity:
- [ ] Test plan has been approved by relevant developers
- [ ] Test plan has been peer reviewed by QA
- [ ] Cypress test cases have been added and approved by either SDET or
manual QA
- [ ] Organized project review call with relevant stakeholders after
Round 1/2 of QA
- [ ] Added Test Plan Approved label after reveiwing all Cypress test

---------

Co-authored-by: Satish Gandham <hello@satishgandham.com>
Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 17:11:47 +05:30

488 lines
17 KiB
TypeScript

import React, { useEffect, useMemo, useRef } from "react";
import { pick, reduce } from "lodash";
import type { Row as ReactTableRowType } from "react-table";
import {
useTable,
usePagination,
useBlockLayout,
useResizeColumns,
useRowSelect,
} from "react-table";
import { useSticky } from "react-table-sticky";
import {
TableWrapper,
TableHeaderWrapper,
TableHeaderInnerWrapper,
} from "./TableStyledWrappers";
import TableHeader from "./header";
import { Classes } from "@blueprintjs/core";
import type {
ReactTableColumnProps,
ReactTableFilter,
CompactMode,
AddNewRowActions,
StickyType,
} from "./Constants";
import {
TABLE_SIZES,
CompactModeTypes,
TABLE_SCROLLBAR_HEIGHT,
} from "./Constants";
import { Colors } from "constants/Colors";
import type { EventType } from "constants/AppsmithActionConstants/ActionConstants";
import type { EditableCell, TableVariant } from "../constants";
import SimpleBar from "simplebar-react";
import "simplebar-react/dist/simplebar.min.css";
import { createGlobalStyle } from "styled-components";
import { Classes as PopOver2Classes } from "@blueprintjs/popover2";
import StaticTable from "./StaticTable";
import VirtualTable from "./VirtualTable";
import fastdom from "fastdom";
const SCROLL_BAR_OFFSET = 2;
const HEADER_MENU_PORTAL_CLASS = ".header-menu-portal";
const PopoverStyles = createGlobalStyle<{
widgetId: string;
borderRadius: string;
}>`
${HEADER_MENU_PORTAL_CLASS}-${({ widgetId }) => widgetId}
{
font-family: var(--wds-font-family) !important;
& .${PopOver2Classes.POPOVER2},
.${PopOver2Classes.POPOVER2_CONTENT},
.bp3-menu {
border-radius: ${({ borderRadius }) =>
borderRadius >= `1.5rem` ? `0.375rem` : borderRadius} !important;
}
}
`;
export interface TableProps {
width: number;
height: number;
pageSize: number;
widgetId: string;
widgetName: string;
searchKey: string;
isLoading: boolean;
columnWidthMap?: { [key: string]: number };
columns: ReactTableColumnProps[];
data: Array<Record<string, unknown>>;
totalRecordsCount?: number;
editMode: boolean;
editableCell: EditableCell;
sortTableColumn: (columnIndex: number, asc: boolean) => void;
handleResizeColumn: (columnWidthMap: { [key: string]: number }) => void;
handleReorderColumn: (columnOrder: string[]) => void;
selectTableRow: (row: {
original: Record<string, unknown>;
index: number;
}) => void;
pageNo: number;
updatePageNo: (pageNo: number, event?: EventType) => void;
multiRowSelection?: boolean;
isSortable?: boolean;
nextPageClick: () => void;
prevPageClick: () => void;
serverSidePaginationEnabled: boolean;
selectedRowIndex: number;
selectedRowIndices: number[];
disableDrag: () => void;
enableDrag: () => void;
toggleAllRowSelect: (
isSelect: boolean,
pageData: ReactTableRowType<Record<string, unknown>>[],
) => void;
triggerRowSelection: boolean;
searchTableData: (searchKey: any) => void;
filters?: ReactTableFilter[];
applyFilter: (filters: ReactTableFilter[]) => void;
compactMode?: CompactMode;
isVisibleDownload?: boolean;
isVisibleFilters?: boolean;
isVisiblePagination?: boolean;
isVisibleSearch?: boolean;
delimiter: string;
accentColor: string;
borderRadius: string;
boxShadow: string;
borderWidth?: number;
borderColor?: string;
onBulkEditDiscard: () => void;
onBulkEditSave: () => void;
variant?: TableVariant;
primaryColumnId?: string;
isAddRowInProgress: boolean;
allowAddNewRow: boolean;
onAddNewRow: () => void;
onAddNewRowAction: (
type: AddNewRowActions,
onActionComplete: () => void,
) => void;
disabledAddNewRowSave: boolean;
handleColumnFreeze?: (columnName: string, sticky?: StickyType) => void;
canFreezeColumn?: boolean;
}
const defaultColumn = {
minWidth: 30,
width: 150,
};
export type HeaderComponentProps = {
enableDrag: () => void;
disableDrag: () => void;
multiRowSelection?: boolean;
handleAllRowSelectClick: (
e: React.MouseEvent<HTMLDivElement, MouseEvent>,
) => void;
handleReorderColumn: (columnOrder: string[]) => void;
columnOrder?: string[];
accentColor: string;
borderRadius: string;
headerGroups: any;
canFreezeColumn?: boolean;
editMode: boolean;
handleColumnFreeze?: (columnName: string, sticky?: StickyType) => void;
isResizingColumn: React.MutableRefObject<boolean>;
isSortable?: boolean;
sortTableColumn: (columnIndex: number, asc: boolean) => void;
columns: ReactTableColumnProps[];
width: number;
subPage: ReactTableRowType<Record<string, unknown>>[];
prepareRow: any;
headerWidth?: number;
rowSelectionState: 0 | 1 | 2 | null;
widgetId: string;
};
export function Table(props: TableProps) {
const isResizingColumn = React.useRef(false);
const handleResizeColumn = (columnWidths: Record<string, number>) => {
const columnWidthMap = {
...props.columnWidthMap,
...columnWidths,
};
for (const i in columnWidthMap) {
if (columnWidthMap[i] < 60) {
columnWidthMap[i] = 60;
} else if (columnWidthMap[i] === undefined) {
const columnCounts = props.columns.filter(
(column) => !column.isHidden,
).length;
columnWidthMap[i] = props.width / columnCounts;
}
}
props.handleResizeColumn(columnWidthMap);
};
const data = React.useMemo(() => props.data, [JSON.stringify(props.data)]);
const columnString = JSON.stringify(
pick(props, ["columns", "compactMode", "columnWidthMap"]),
);
const columns = React.useMemo(() => props.columns, [columnString]);
const tableHeadercolumns = React.useMemo(
() =>
props.columns.filter((column: ReactTableColumnProps) => {
return column.alias !== "actions";
}),
[columnString],
);
/*
For serverSidePaginationEnabled we are taking props.data.length as the page size.
As props.pageSize is being set by the visible number of rows in the table (without scrolling),
it will not give the correct count of records in the current page when query limit
is set higher/lower than the visible number of rows in the table
*/
const pageCount =
props.serverSidePaginationEnabled &&
props.totalRecordsCount &&
props.data.length
? Math.ceil(props.totalRecordsCount / props.data.length)
: Math.ceil(props.data.length / props.pageSize);
const currentPageIndex = props.pageNo < pageCount ? props.pageNo : 0;
const {
getTableBodyProps,
getTableProps,
headerGroups,
page,
pageOptions,
prepareRow,
state,
totalColumnsWidth,
} = useTable(
{
columns: columns,
data,
defaultColumn,
initialState: {
pageIndex: currentPageIndex,
pageSize: props.pageSize,
},
manualPagination: true,
pageCount,
},
useBlockLayout,
useResizeColumns,
usePagination,
useRowSelect,
useSticky,
);
//Set isResizingColumn as true when column is resizing using table state
if (state.columnResizing.isResizingColumn) {
isResizingColumn.current = true;
} else {
// We are updating column size since the drag is complete when we are changing value of isResizing from true to false
if (isResizingColumn.current) {
//update isResizingColumn in next event loop so that dragEnd event does not trigger click event.
setTimeout(function () {
isResizingColumn.current = false;
handleResizeColumn(state.columnResizing.columnWidths);
}, 0);
}
}
let startIndex = currentPageIndex * props.pageSize;
let endIndex = startIndex + props.pageSize;
if (props.serverSidePaginationEnabled) {
startIndex = 0;
endIndex = props.data.length;
}
const subPage = page.slice(startIndex, endIndex);
const selectedRowIndices = props.selectedRowIndices || [];
const tableSizes = TABLE_SIZES[props.compactMode || CompactModeTypes.DEFAULT];
const tableWrapperRef = useRef<HTMLDivElement | null>(null);
const scrollBarRef = useRef<SimpleBar | null>(null);
const tableHeaderWrapperRef = React.createRef<HTMLDivElement>();
const rowSelectionState = React.useMemo(() => {
// return : 0; no row selected | 1; all row selected | 2: some rows selected
if (!props.multiRowSelection) return null;
const selectedRowCount = reduce(
page,
(count, row) => {
return selectedRowIndices.includes(row.index) ? count + 1 : count;
},
0,
);
const result =
selectedRowCount === 0 ? 0 : selectedRowCount === page.length ? 1 : 2;
return result;
}, [selectedRowIndices, page]);
const handleAllRowSelectClick = (
e: React.MouseEvent<HTMLDivElement, MouseEvent>,
) => {
// if all / some rows are selected we remove selection on click
// else select all rows
props.toggleAllRowSelect(!Boolean(rowSelectionState), page);
// loop over subPage rows and toggleRowSelected if required
e.stopPropagation();
};
const isHeaderVisible =
props.isVisibleSearch ||
props.isVisibleFilters ||
props.isVisibleDownload ||
props.isVisiblePagination ||
props.allowAddNewRow;
const scrollContainerStyles = useMemo(() => {
return {
height: isHeaderVisible
? props.height -
tableSizes.TABLE_HEADER_HEIGHT -
TABLE_SCROLLBAR_HEIGHT -
SCROLL_BAR_OFFSET
: props.height - TABLE_SCROLLBAR_HEIGHT - SCROLL_BAR_OFFSET,
};
}, [isHeaderVisible, props.height, tableSizes.TABLE_HEADER_HEIGHT]);
const shouldUseVirtual =
props.serverSidePaginationEnabled &&
!props.columns.some(
(column) => !!column.columnProperties.allowCellWrapping,
);
useEffect(() => {
if (props.isAddRowInProgress) {
fastdom.mutate(() => {
if (scrollBarRef && scrollBarRef?.current) {
scrollBarRef.current.getScrollElement().scrollTop = 0;
}
});
}
}, [props.isAddRowInProgress]);
return (
<TableWrapper
accentColor={props.accentColor}
backgroundColor={Colors.ATHENS_GRAY_DARKER}
borderColor={props.borderColor}
borderRadius={props.borderRadius}
borderWidth={props.borderWidth}
boxShadow={props.boxShadow}
height={props.height}
id={`table${props.widgetId}`}
isAddRowInProgress={props.isAddRowInProgress}
isHeaderVisible={isHeaderVisible}
isResizingColumn={isResizingColumn.current}
multiRowSelection={props.multiRowSelection}
tableSizes={tableSizes}
triggerRowSelection={props.triggerRowSelection}
variant={props.variant}
width={props.width}
>
<PopoverStyles
borderRadius={props.borderRadius}
widgetId={props.widgetId}
/>
{isHeaderVisible && (
<SimpleBar
style={{
maxHeight: tableSizes.TABLE_HEADER_HEIGHT,
}}
>
<TableHeaderWrapper
backgroundColor={Colors.WHITE}
ref={tableHeaderWrapperRef}
serverSidePaginationEnabled={props.serverSidePaginationEnabled}
tableSizes={tableSizes}
width={props.width}
>
<TableHeaderInnerWrapper
backgroundColor={Colors.WHITE}
serverSidePaginationEnabled={props.serverSidePaginationEnabled}
tableSizes={tableSizes}
variant={props.variant}
width={props.width}
>
<TableHeader
accentColor={props.accentColor}
allowAddNewRow={props.allowAddNewRow}
applyFilter={props.applyFilter}
borderRadius={props.borderRadius}
boxShadow={props.boxShadow}
columns={tableHeadercolumns}
currentPageIndex={currentPageIndex}
delimiter={props.delimiter}
disableAddNewRow={!!props.editableCell.column}
disabledAddNewRowSave={props.disabledAddNewRowSave}
filters={props.filters}
isAddRowInProgress={props.isAddRowInProgress}
isVisibleDownload={props.isVisibleDownload}
isVisibleFilters={props.isVisibleFilters}
isVisiblePagination={props.isVisiblePagination}
isVisibleSearch={props.isVisibleSearch}
nextPageClick={props.nextPageClick}
onAddNewRow={props.onAddNewRow}
onAddNewRowAction={props.onAddNewRowAction}
pageCount={pageCount}
pageNo={props.pageNo}
pageOptions={pageOptions}
prevPageClick={props.prevPageClick}
searchKey={props.searchKey}
searchTableData={props.searchTableData}
serverSidePaginationEnabled={props.serverSidePaginationEnabled}
tableColumns={columns}
tableData={data}
tableSizes={tableSizes}
totalRecordsCount={props.totalRecordsCount}
updatePageNo={props.updatePageNo}
widgetId={props.widgetId}
widgetName={props.widgetName}
/>
</TableHeaderInnerWrapper>
</TableHeaderWrapper>
</SimpleBar>
)}
<div
className={
props.isLoading
? Classes.SKELETON
: shouldUseVirtual
? "tableWrap virtual"
: "tableWrap"
}
ref={tableWrapperRef}
>
<div {...getTableProps()} className="table column-freeze">
{!shouldUseVirtual && (
<StaticTable
accentColor={props.accentColor}
borderRadius={props.borderRadius}
canFreezeColumn={props.canFreezeColumn}
columns={props.columns}
disableDrag={props.disableDrag}
editMode={props.editMode}
enableDrag={props.enableDrag}
getTableBodyProps={getTableBodyProps}
handleAllRowSelectClick={handleAllRowSelectClick}
handleColumnFreeze={props.handleColumnFreeze}
handleReorderColumn={props.handleReorderColumn}
headerGroups={headerGroups}
height={props.height}
isAddRowInProgress={props.isAddRowInProgress}
isResizingColumn={isResizingColumn}
isSortable={props.isSortable}
multiRowSelection={props?.multiRowSelection}
pageSize={props.pageSize}
prepareRow={prepareRow}
primaryColumnId={props.primaryColumnId}
ref={scrollBarRef}
rowSelectionState={rowSelectionState}
scrollContainerStyles={scrollContainerStyles}
selectTableRow={props.selectTableRow}
selectedRowIndex={props.selectedRowIndex}
selectedRowIndices={props.selectedRowIndices}
sortTableColumn={props.sortTableColumn}
subPage={subPage}
tableSizes={tableSizes}
totalColumnsWidth={totalColumnsWidth}
useVirtual={shouldUseVirtual}
widgetId={props.widgetId}
width={props.width}
/>
)}
{shouldUseVirtual && (
<VirtualTable
accentColor={props.accentColor}
borderRadius={props.borderRadius}
canFreezeColumn={props.canFreezeColumn}
columns={props.columns}
disableDrag={props.disableDrag}
editMode={props.editMode}
enableDrag={props.enableDrag}
getTableBodyProps={getTableBodyProps}
handleAllRowSelectClick={handleAllRowSelectClick}
handleColumnFreeze={props.handleColumnFreeze}
handleReorderColumn={props.handleReorderColumn}
headerGroups={headerGroups}
height={props.height}
isAddRowInProgress={props.isAddRowInProgress}
isResizingColumn={isResizingColumn}
isSortable={props.isSortable}
multiRowSelection={props?.multiRowSelection}
pageSize={props.pageSize}
prepareRow={prepareRow}
primaryColumnId={props.primaryColumnId}
ref={scrollBarRef}
rowSelectionState={rowSelectionState}
scrollContainerStyles={scrollContainerStyles}
selectTableRow={props.selectTableRow}
selectedRowIndex={props.selectedRowIndex}
selectedRowIndices={props.selectedRowIndices}
sortTableColumn={props.sortTableColumn}
subPage={subPage}
tableSizes={tableSizes}
totalColumnsWidth={totalColumnsWidth}
useVirtual={shouldUseVirtual}
widgetId={props.widgetId}
width={props.width}
/>
)}
</div>
</div>
</TableWrapper>
);
}
export default Table;