mirror of
https://github.com/Unleash/unleash.git
synced 2025-09-28 17:55:15 +02:00
https://linear.app/unleash/issue/2-563/fix-issue-with-useconditionallyhiddencolumns-and-react-table It seems like we should add `autoResetHiddenColumns: false` to `useTable` whenever we use `useConditionallyHiddenColumns`. Basically the thought is that, if we're controlling column visibility in our own way, we should not want other things to change that state unpredictably, otherwise this may make React go _brrrrrr_. And it can be very hard to pinpoint what exactly may be causing React to go _brrrrrr_.  First detected this issue apparently randomly while developing the new SA table. Around 10-20 page refreshes would eventually trigger it. Was not easy to find, but hopefully this fixes it permanently. At least I haven't been able to reproduce it since. Maybe someone has a better idea of where the issue could be or if this is a pretty good guess. Doesn't seem like this change hurts us anyways. I love React, `useEffect` and these very to-the-point error messages. Very fun and productive. Reference: https://react-table-v7.tanstack.com/docs/api/useTable
308 lines
10 KiB
TypeScript
308 lines
10 KiB
TypeScript
import { PageContent } from 'component/common/PageContent/PageContent';
|
|
import { PageHeader } from 'component/common/PageHeader/PageHeader';
|
|
import {
|
|
SortableTableHeader,
|
|
Table,
|
|
TableCell,
|
|
TablePlaceholder,
|
|
} from 'component/common/Table';
|
|
import { SortingRule, useSortBy, useTable } from 'react-table';
|
|
import { SearchHighlightProvider } from 'component/common/Table/SearchHighlightContext/SearchHighlightContext';
|
|
import { styled, Tab, Tabs, useMediaQuery } from '@mui/material';
|
|
import { sortTypes } from 'utils/sortTypes';
|
|
import { useEffect, useMemo, useState } from 'react';
|
|
import { ConditionallyRender } from 'component/common/ConditionallyRender/ConditionallyRender';
|
|
import { Search } from 'component/common/Search/Search';
|
|
import { featuresPlaceholder } from 'component/feature/FeatureToggleList/FeatureToggleListTable';
|
|
import theme from 'themes/theme';
|
|
import { useSearch } from 'hooks/useSearch';
|
|
import { useSearchParams } from 'react-router-dom';
|
|
import { TimeAgoCell } from 'component/common/Table/cells/TimeAgoCell/TimeAgoCell';
|
|
import { TextCell } from 'component/common/Table/cells/TextCell/TextCell';
|
|
import { ChangeRequestStatusCell } from './ChangeRequestStatusCell/ChangeRequestStatusCell';
|
|
import { AvatarCell } from './AvatarCell/AvatarCell';
|
|
import { ChangeRequestTitleCell } from './ChangeRequestTitleCell/ChangeRequestTitleCell';
|
|
import { TableBody, TableRow } from 'component/common/Table';
|
|
import { createLocalStorage } from 'utils/createLocalStorage';
|
|
import { useConditionallyHiddenColumns } from 'hooks/useConditionallyHiddenColumns';
|
|
import { useStyles } from './ChangeRequestsTabs.styles';
|
|
|
|
export interface IChangeRequestTableProps {
|
|
changeRequests: any[];
|
|
loading: boolean;
|
|
projectId: string;
|
|
}
|
|
|
|
const defaultSort: SortingRule<string> & {
|
|
columns?: string[];
|
|
} = { id: 'createdAt' };
|
|
|
|
const StyledTabContainer = styled('div')({
|
|
paddingLeft: 0,
|
|
paddingBottom: 0,
|
|
});
|
|
|
|
const StyledTabButton = styled(Tab)(({ theme }) => ({
|
|
textTransform: 'none',
|
|
width: 'auto',
|
|
fontSize: theme.fontSizes.bodySize,
|
|
[theme.breakpoints.up('md')]: {
|
|
minWidth: 160,
|
|
},
|
|
}));
|
|
|
|
export const ChangeRequestsTabs = ({
|
|
changeRequests = [],
|
|
loading,
|
|
projectId,
|
|
}: IChangeRequestTableProps) => {
|
|
const { classes } = useStyles();
|
|
const isSmallScreen = useMediaQuery(theme.breakpoints.down('md'));
|
|
const [searchParams, setSearchParams] = useSearchParams();
|
|
|
|
const [searchValue, setSearchValue] = useState(
|
|
searchParams.get('search') || ''
|
|
);
|
|
|
|
const { value: storedParams, setValue: setStoredParams } =
|
|
createLocalStorage(`${projectId}:ProjectChangeRequest`, defaultSort);
|
|
|
|
const [openChangeRequests, closedChangeRequests] = useMemo(() => {
|
|
const open = changeRequests.filter(
|
|
changeRequest =>
|
|
changeRequest.state !== 'Cancelled' &&
|
|
changeRequest.state !== 'Applied'
|
|
);
|
|
const closed = changeRequests.filter(
|
|
changeRequest =>
|
|
changeRequest.state === 'Cancelled' ||
|
|
changeRequest.state === 'Applied'
|
|
);
|
|
|
|
return [open, closed];
|
|
}, [changeRequests]);
|
|
|
|
const tabs = [
|
|
{
|
|
title: 'Change requests',
|
|
data: openChangeRequests,
|
|
},
|
|
{
|
|
title: 'Closed',
|
|
data: closedChangeRequests,
|
|
},
|
|
];
|
|
|
|
const [activeTab, setActiveTab] = useState(0);
|
|
|
|
const columns = useMemo(
|
|
() => [
|
|
{
|
|
id: 'Title',
|
|
Header: 'Title',
|
|
width: 100,
|
|
canSort: true,
|
|
accessor: 'id',
|
|
Cell: ChangeRequestTitleCell,
|
|
},
|
|
{
|
|
Header: 'By',
|
|
accessor: 'createdBy',
|
|
maxWidth: 50,
|
|
canSort: false,
|
|
Cell: AvatarCell,
|
|
align: 'center',
|
|
},
|
|
{
|
|
Header: 'Submitted',
|
|
accessor: 'createdAt',
|
|
searchable: true,
|
|
maxWidth: 100,
|
|
Cell: TimeAgoCell,
|
|
sortType: 'alphanumeric',
|
|
},
|
|
{
|
|
Header: 'Environment',
|
|
accessor: 'environment',
|
|
searchable: true,
|
|
maxWidth: 100,
|
|
Cell: TextCell,
|
|
},
|
|
{
|
|
Header: 'Status',
|
|
accessor: 'state',
|
|
searchable: true,
|
|
minWidth: 150,
|
|
width: 150,
|
|
Cell: ChangeRequestStatusCell,
|
|
},
|
|
],
|
|
//eslint-disable-next-line
|
|
[projectId]
|
|
);
|
|
|
|
const {
|
|
data: searchedData,
|
|
getSearchText,
|
|
getSearchContext,
|
|
} = useSearch(columns, searchValue, tabs[activeTab]?.data);
|
|
|
|
const data = useMemo(
|
|
() => (loading ? featuresPlaceholder : searchedData),
|
|
[searchedData, loading]
|
|
);
|
|
|
|
const [initialState] = useState(() => ({
|
|
sortBy: [
|
|
{
|
|
id: searchParams.get('sort') || storedParams.id,
|
|
desc: searchParams.has('order')
|
|
? searchParams.get('order') === 'desc'
|
|
: storedParams.desc,
|
|
},
|
|
],
|
|
hiddenColumns: [],
|
|
}));
|
|
|
|
const {
|
|
headerGroups,
|
|
rows,
|
|
state: { sortBy },
|
|
prepareRow,
|
|
setHiddenColumns,
|
|
getTableProps,
|
|
getTableBodyProps,
|
|
} = useTable(
|
|
{
|
|
columns: columns as any[], // TODO: fix after `react-table` v8 update
|
|
data,
|
|
initialState,
|
|
sortTypes,
|
|
autoResetHiddenColumns: false,
|
|
disableSortRemove: true,
|
|
autoResetSortBy: false,
|
|
defaultColumn: {
|
|
Cell: TextCell,
|
|
},
|
|
},
|
|
useSortBy
|
|
);
|
|
|
|
useConditionallyHiddenColumns(
|
|
[
|
|
{
|
|
condition: isSmallScreen,
|
|
columns: ['createdBy'],
|
|
},
|
|
],
|
|
setHiddenColumns,
|
|
columns
|
|
);
|
|
|
|
useEffect(() => {
|
|
if (loading) {
|
|
return;
|
|
}
|
|
const tableState: Record<string, string> = {};
|
|
tableState.sort = sortBy[0].id;
|
|
if (sortBy[0].desc) {
|
|
tableState.order = 'desc';
|
|
}
|
|
if (searchValue) {
|
|
tableState.search = searchValue;
|
|
}
|
|
|
|
setSearchParams(tableState, {
|
|
replace: true,
|
|
});
|
|
setStoredParams(params => ({
|
|
...params,
|
|
id: sortBy[0].id,
|
|
desc: sortBy[0].desc || false,
|
|
}));
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, [loading, sortBy, searchValue, setSearchParams]);
|
|
|
|
return (
|
|
<PageContent
|
|
isLoading={loading}
|
|
bodyClass={classes.bodyClass}
|
|
headerClass={classes.header}
|
|
header={
|
|
<PageHeader
|
|
titleElement={
|
|
<StyledTabContainer>
|
|
<Tabs
|
|
value={tabs[activeTab]?.title}
|
|
indicatorColor="primary"
|
|
textColor="primary"
|
|
variant="scrollable"
|
|
allowScrollButtonsMobile
|
|
>
|
|
{tabs.map((tab, index) => (
|
|
<StyledTabButton
|
|
key={tab.title}
|
|
label={`${tab.title} (${tab.data.length})`}
|
|
value={tab.title}
|
|
onClick={() => setActiveTab(index)}
|
|
/>
|
|
))}
|
|
</Tabs>
|
|
</StyledTabContainer>
|
|
}
|
|
actions={
|
|
<Search
|
|
initialValue={searchValue}
|
|
onChange={setSearchValue}
|
|
hasFilters
|
|
getSearchContext={getSearchContext}
|
|
/>
|
|
}
|
|
/>
|
|
}
|
|
>
|
|
<SearchHighlightProvider value={getSearchText(searchValue)}>
|
|
<Table {...getTableProps()}>
|
|
<SortableTableHeader headerGroups={headerGroups} />
|
|
<TableBody {...getTableBodyProps()}>
|
|
{rows.map(row => {
|
|
prepareRow(row);
|
|
return (
|
|
<TableRow hover {...row.getRowProps()}>
|
|
{row.cells.map(cell => (
|
|
<TableCell
|
|
{...cell.getCellProps()}
|
|
padding="none"
|
|
>
|
|
{cell.render('Cell')}
|
|
</TableCell>
|
|
))}
|
|
</TableRow>
|
|
);
|
|
})}
|
|
</TableBody>
|
|
</Table>
|
|
</SearchHighlightProvider>
|
|
<ConditionallyRender
|
|
condition={rows.length === 0}
|
|
show={() => (
|
|
<ConditionallyRender
|
|
condition={searchValue?.length > 0}
|
|
show={
|
|
<TablePlaceholder>
|
|
No changes found matching “
|
|
{searchValue}”
|
|
</TablePlaceholder>
|
|
}
|
|
elseShow={
|
|
<TablePlaceholder>
|
|
None of the changes were submitted yet.
|
|
</TablePlaceholder>
|
|
}
|
|
/>
|
|
)}
|
|
/>
|
|
</PageContent>
|
|
);
|
|
};
|