Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Fix react-hooks/exhaustive-deps error on TransactionsTable.jsx #4268

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+149 −98
Open

[WIP] Fix react-hooks/exhaustive-deps error on TransactionsTable.jsx #4268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c74d5e8
Fix react-hooks/exhaustive-deps error on TransactionsTable.jsx
joel-jeremy Jan 30, 2025
475c5b4
Release notes
joel-jeremy Jan 30, 2025
c339c4a
Fix lint
joel-jeremy Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,8 +794,6 @@ export default [
'packages/desktop-client/src/components/transactions/SelectedTransactions.jsx',
'packages/desktop-client/src/components/transactions/SimpleTransactionsTable.jsx',
'packages/desktop-client/src/components/transactions/TransactionList.jsx',
'packages/desktop-client/src/components/transactions/TransactionsTable.jsx',
'packages/desktop-client/src/components/transactions/TransactionsTable.test.jsx',
'packages/desktop-client/src/hooks/useAccounts.ts',
'packages/desktop-client/src/hooks/useCategories.ts',
'packages/desktop-client/src/hooks/usePayees.ts',
Expand Down
228 changes: 137 additions & 91 deletions packages/desktop-client/src/components/transactions/TransactionsTable.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import React, {
useRef,
useMemo,
useCallback,
useLayoutEffect,
useEffect,
} from 'react';
import { useHotkeys } from 'react-hotkeys-hook';
Expand Down Expand Up @@ -1855,28 +1854,35 @@ function TransactionTableInner({
setScrollWidth(!width ? 0 : width);
}

const {
onCloseAddTransaction: onCloseAddTransactionProp,
onNavigateToTransferAccount: onNavigateToTransferAccountProp,
onNavigateToSchedule: onNavigateToScheduleProp,
onNotesTagClick: onNotesTagClickProp,
} = props;

const onNavigateToTransferAccount = useCallback(
accountId => {
props.onCloseAddTransaction();
props.onNavigateToTransferAccount(accountId);
onCloseAddTransactionProp();
onNavigateToTransferAccountProp(accountId);
},
[props.onCloseAddTransaction, props.onNavigateToTransferAccount],
[onCloseAddTransactionProp, onNavigateToTransferAccountProp],
);

const onNavigateToSchedule = useCallback(
scheduleId => {
props.onCloseAddTransaction();
props.onNavigateToSchedule(scheduleId);
onCloseAddTransactionProp();
onNavigateToScheduleProp(scheduleId);
},
[props.onCloseAddTransaction, props.onNavigateToSchedule],
[onCloseAddTransactionProp, onNavigateToScheduleProp],
);

const onNotesTagClick = useCallback(
noteTag => {
props.onCloseAddTransaction();
props.onNotesTagClick(noteTag);
onCloseAddTransactionProp();
onNotesTagClickProp(noteTag);
},
[props.onCloseAddTransaction, props.onNotesTagClick],
[onCloseAddTransactionProp, onNotesTagClickProp],
);

useEffect(() => {
Expand Down Expand Up @@ -2112,6 +2118,7 @@ export const TransactionTable = forwardRef((props, ref) => {
const [newTransactions, setNewTransactions] = useState(null);
const [prevIsAdding, setPrevIsAdding] = useState(false);
const splitsExpanded = useSplitsExpanded();
const splitsExpandedDispatch = splitsExpanded.dispatch;
const prevSplitsExpanded = useRef(null);

const tableRef = useRef(null);
Expand Down Expand Up @@ -2190,6 +2197,8 @@ export const TransactionTable = forwardRef((props, ref) => {
);
}, [props.transactions, props.payees, props.accounts]);

const hasPrevSplitsExpanded = prevSplitsExpanded.current;

useEffect(() => {
// If it's anchored that means we've also disabled animations. To
// reduce the chance for side effect collision, only do this if
Expand All @@ -2198,7 +2207,7 @@ export const TransactionTable = forwardRef((props, ref) => {
tableRef.current.unanchor();
tableRef.current.setRowAnimation(true);
}
}, [prevSplitsExpanded.current]);
}, [hasPrevSplitsExpanded]);

const newNavigator = useTableNavigator(
newTransactions,
Expand All @@ -2216,14 +2225,12 @@ export const TransactionTable = forwardRef((props, ref) => {
const [_, forceRerender] = useState({});
const selectedItems = useSelectedItems();

useLayoutEffect(() => {
latestState.current = {
newTransactions,
newNavigator,
tableNavigator,
transactions: props.transactions,
};
});
latestState.current = {
newTransactions,
newNavigator,
tableNavigator,
transactions: props.transactions,
};

// Derive new transactions from the `isAdding` prop
if (prevIsAdding !== props.isAdding) {
Expand All @@ -2238,32 +2245,30 @@ export const TransactionTable = forwardRef((props, ref) => {
setPrevIsAdding(props.isAdding);
}

useEffect(() => {
if (shouldAdd.current) {
if (newTransactions[0].account == null) {
dispatch(
addNotification({
type: 'error',
message: 'Account is a required field',
}),
);
newNavigator.onEdit('temp', 'account');
} else {
const transactions = latestState.current.newTransactions;
const lastDate = transactions.length > 0 ? transactions[0].date : null;
setNewTransactions(
makeTemporaryTransactions(
props.currentAccountId,
props.currentCategoryId,
lastDate,
),
);
newNavigator.onEdit('temp', 'date');
props.onAdd(transactions);
}
shouldAdd.current = false;
if (shouldAdd.current) {
if (newTransactions[0].account == null) {
dispatch(
addNotification({
type: 'error',
message: 'Account is a required field',
}),
);
newNavigator.onEdit('temp', 'account');
} else {
const transactions = latestState.current.newTransactions;
const lastDate = transactions.length > 0 ? transactions[0].date : null;
setNewTransactions(
makeTemporaryTransactions(
props.currentAccountId,
props.currentCategoryId,
lastDate,
),
);
newNavigator.onEdit('temp', 'date');
props.onAdd(transactions);
}
});
shouldAdd.current = false;
}

useEffect(() => {
if (savePending.current && afterSaveFunc.current) {
Expand All @@ -2272,7 +2277,7 @@ export const TransactionTable = forwardRef((props, ref) => {
}

savePending.current = false;
}, [newTransactions, props.transactions]);
}, [newTransactions, props, props.transactions]);

function getFieldsNewTransaction(item) {
const fields = [
Expand Down Expand Up @@ -2409,7 +2414,20 @@ export const TransactionTable = forwardRef((props, ref) => {
// effect we want to run. We have to wait for all updates to be
// committed (the input could still be saving a value).
forceRerender({});
}, [props.onAdd, newNavigator.onEdit]);
}, []);

const {
onSave: onSaveProp,
onApplyRules: onApplyRulesProp,
onBatchDelete,
onBatchDuplicate,
onBatchLinkSchedule,
onBatchUnlinkSchedule,
onCreateRule: onCreateRuleProp,
onScheduleAction: onScheduleActionProp,
onMakeAsNonSplitTransactions: onMakeAsNonSplitTransactionsProp,
onSplit: onSplitProp,
} = props;

const onSave = useCallback(
async (transaction, subtransactions = null, updatedFieldName = null) => {
Expand All @@ -2420,8 +2438,8 @@ export const TransactionTable = forwardRef((props, ref) => {
: transaction;

if (isTemporaryId(transaction.id)) {
if (props.onApplyRules) {
groupedTransaction = await props.onApplyRules(
if (onApplyRulesProp) {
groupedTransaction = await onApplyRulesProp(
groupedTransaction,
updatedFieldName,
);
Expand All @@ -2436,48 +2454,69 @@ export const TransactionTable = forwardRef((props, ref) => {
),
);
} else {
props.onSave(groupedTransaction);
onSaveProp(groupedTransaction);
}
},
[props.onSave],
[onSaveProp, onApplyRulesProp],
);

const onDelete = useCallback(id => {
const temporary = isTemporaryId(id);
const onDelete = useCallback(
id => {
const temporary = isTemporaryId(id);

if (temporary) {
const newTrans = latestState.current.newTransactions;
if (temporary) {
const newTrans = latestState.current.newTransactions;

if (id === newTrans[0].id) {
// You can never delete the parent new transaction
return;
}
if (id === newTrans[0].id) {
// You can never delete the parent new transaction
return;
}

setNewTransactions(deleteTransaction(newTrans, id).data);
} else {
props.onBatchDelete([id]);
}
}, []);
setNewTransactions(deleteTransaction(newTrans, id).data);
} else {
onBatchDelete([id]);
}
},
[onBatchDelete],
);

const onDuplicate = useCallback(id => {
props.onBatchDuplicate([id]);
}, []);
const onDuplicate = useCallback(
id => {
onBatchDuplicate([id]);
},
[onBatchDuplicate],
);

const onLinkSchedule = useCallback(id => {
props.onBatchLinkSchedule([id]);
}, []);
const onUnlinkSchedule = useCallback(id => {
props.onBatchUnlinkSchedule([id]);
}, []);
const onCreateRule = useCallback(id => {
props.onCreateRule([id]);
}, []);
const onScheduleAction = useCallback((action, id) => {
props.onScheduleAction(action, [id]);
}, []);
const onMakeAsNonSplitTransactions = useCallback(id => {
props.onMakeAsNonSplitTransactions([id]);
}, []);
const onLinkSchedule = useCallback(
id => {
onBatchLinkSchedule([id]);
},
[onBatchLinkSchedule],
);
const onUnlinkSchedule = useCallback(
id => {
onBatchUnlinkSchedule([id]);
},
[onBatchUnlinkSchedule],
);
const onCreateRule = useCallback(
id => {
onCreateRuleProp([id]);
},
[onCreateRuleProp],
);
const onScheduleAction = useCallback(
(action, id) => {
onScheduleActionProp(action, [id]);
},
[onScheduleActionProp],
);
const onMakeAsNonSplitTransactions = useCallback(
id => {
onMakeAsNonSplitTransactionsProp([id]);
},
[onMakeAsNonSplitTransactionsProp],
);

const onSplit = useMemo(() => {
return id => {
Expand All @@ -2500,9 +2539,9 @@ export const TransactionTable = forwardRef((props, ref) => {
}
} else {
const trans = latestState.current.transactions.find(t => t.id === id);
const newId = props.onSplit(id);
const newId = onSplitProp(id);

splitsExpanded.dispatch({ type: 'open-split', id: trans.id });
splitsExpandedDispatch({ type: 'open-split', id: trans.id });

const { tableNavigator } = latestState.current;
if (trans.amount === null) {
Expand All @@ -2512,32 +2551,39 @@ export const TransactionTable = forwardRef((props, ref) => {
}
}
};
}, [props.onSplit, splitsExpanded.dispatch]);
}, [onSplitProp, splitsExpandedDispatch]);

const { onAddSplit: onAddSplitProp } = props;

const onAddSplit = useCallback(
id => {
const {
tableNavigator,
newNavigator,
newTransactions: newTrans,
} = latestState.current;

if (isTemporaryId(id)) {
const newTrans = latestState.current.newTransactions;
const { data, diff } = addSplitTransaction(newTrans, id);
setNewTransactions(data);
newNavigator.onEdit(
diff.added[0].id,
latestState.current.newNavigator.focusedField,
);
} else {
const newId = props.onAddSplit(id);
const newId = onAddSplitProp(id);
tableNavigator.onEdit(
newId,
latestState.current.tableNavigator.focusedField,
);
}
},
[props.onAddSplit],
[onAddSplitProp],
);

const onDistributeRemainder = useCallback(
async id => {
const { transactions, tableNavigator, newTransactions } =
const { transactions, newNavigator, tableNavigator, newTransactions } =
latestState.current;

const targetTransactions = isTemporaryId(id)
Expand Down Expand Up @@ -2591,7 +2637,7 @@ export const TransactionTable = forwardRef((props, ref) => {
});
}
},
[latestState],
[onSave],
);

function onCloseAddTransaction() {
Expand All @@ -2605,8 +2651,8 @@ export const TransactionTable = forwardRef((props, ref) => {
}

const onToggleSplit = useCallback(
id => splitsExpanded.dispatch({ type: 'toggle-split', id }),
[splitsExpanded.dispatch],
id => splitsExpandedDispatch({ type: 'toggle-split', id }),
[splitsExpandedDispatch],
);

return (
Expand Down
Loading