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

Fix wrong scheduled transfer payment direction on PWA #3402

Merged
merged 10 commits into from
Nov 19, 2024
Merged

Fix wrong scheduled transfer payment direction on PWA #3402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
897f040
Fix #3230
joel-jeremy Sep 9, 2024
2dcbbb1
Release notes
joel-jeremy Sep 9, 2024
c7b86ac
Rename hook function
joel-jeremy Nov 14, 2024
cc3e424
[chore] Comment
joel-jeremy Nov 14, 2024
dbcc669
Coderabbit feedback
joel-jeremy Nov 14, 2024
25c54ac
Fix loading states
joel-jeremy Nov 14, 2024
3695dd0
Code rabbit
joel-jeremy Nov 14, 2024
1e2b374
No payee text
joel-jeremy Nov 14, 2024
6aa86c6
Update VRT
github-actions[bot] Nov 19, 2024
1e01626
Update release notes
joel-jeremy Nov 14, 2024
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
Binary file modified ...dividual-account-page-and-checks-that-filtering-is-working-1-chromium-linux.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ...dividual-account-page-and-checks-that-filtering-is-working-2-chromium-linux.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ...dividual-account-page-and-checks-that-filtering-is-working-3-chromium-linux.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 28 additions & 25 deletions packages/desktop-client/src/components/accounts/Account.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import React, {
createRef,
useMemo,
type ReactElement,
useEffect,
} from 'react';
import { Trans } from 'react-i18next';
import { useSelector } from 'react-redux';
Expand All @@ -30,7 +31,6 @@ import {
import { send, listen } from 'loot-core/src/platform/client/fetch';
import { currentDay } from 'loot-core/src/shared/months';
import { q, type Query } from 'loot-core/src/shared/query';
import { getScheduledAmount } from 'loot-core/src/shared/schedules';
import {
updateTransaction,
realizeTempTransactions,
Expand All @@ -50,14 +50,14 @@ import {
type TransactionFilterEntity,
} from 'loot-core/src/types/models';

import { useAccountPreviewTransactions } from '../../hooks/useAccountPreviewTransactions';
import { useAccounts } from '../../hooks/useAccounts';
import { useActions } from '../../hooks/useActions';
import { useCategories } from '../../hooks/useCategories';
import { useDateFormat } from '../../hooks/useDateFormat';
import { useFailedAccounts } from '../../hooks/useFailedAccounts';
import { useLocalPref } from '../../hooks/useLocalPref';
import { usePayees } from '../../hooks/usePayees';
import { usePreviewTransactions } from '../../hooks/usePreviewTransactions';
import {
SelectedProviderWithItems,
type Actions,
Expand Down Expand Up @@ -147,7 +147,6 @@ type AllTransactionsProps = {
transactions: TransactionEntity[],
balances: Record<string, { balance: number }> | null,
) => ReactElement;
collapseTransactions: (ids: string[]) => void;
};

function AllTransactions({
Expand All @@ -157,14 +156,24 @@ function AllTransactions({
showBalances,
filtered,
children,
collapseTransactions,
}: AllTransactionsProps) {
const accountId = account?.id;
const prependTransactions: (TransactionEntity & { _inverse?: boolean })[] =
usePreviewTransactions(collapseTransactions).map(trans => ({
...trans,
_inverse: accountId ? accountId !== trans.account : false,
}));
const { dispatch: splitsExpandedDispatch } = useSplitsExpanded();
const { previewTransactions, isLoading: isPreviewTransactionsLoading } =
useAccountPreviewTransactions({ accountId });

useEffect(() => {
if (!isPreviewTransactionsLoading) {
splitsExpandedDispatch({
type: 'close-splits',
ids: previewTransactions.filter(t => t.is_parent).map(t => t.id),
});
}
}, [
isPreviewTransactionsLoading,
previewTransactions,
splitsExpandedDispatch,
]);

transactions ??= [];

Expand All @@ -184,29 +193,26 @@ function AllTransactions({
}

// Reverse so we can calculate from earliest upcoming schedule.
const scheduledBalances = [...prependTransactions]
const previewBalances = [...previewTransactions]
.reverse()
.map(scheduledTransaction => {
const amount =
(scheduledTransaction._inverse ? -1 : 1) *
getScheduledAmount(scheduledTransaction.amount);
.map(previewTransaction => {
return {
// TODO: fix me
// eslint-disable-next-line react-hooks/exhaustive-deps
balance: (runningBalance += amount),
id: scheduledTransaction.id,
balance: (runningBalance += previewTransaction.amount),
id: previewTransaction.id,
};
});
return groupById(scheduledBalances);
}, [showBalances, prependTransactions, runningBalance]);
return groupById(previewBalances);
}, [showBalances, previewTransactions, runningBalance]);
Comment on lines +196 to +207
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve balance calculation readability.

The current implementation uses assignment within an expression which makes the code harder to understand and maintain. This pattern can lead to subtle bugs as expressions are typically expected to be side-effect free.

Consider refactoring to make the logic more explicit:

-    const previewBalances = [...previewTransactions]
-      .reverse()
-      .map(previewTransaction => {
-        return {
-          // TODO: fix me
-          // eslint-disable-next-line react-hooks/exhaustive-deps
-          balance: (runningBalance += previewTransaction.amount),
-          id: previewTransaction.id,
-        };
-      });
+    const previewBalances = [...previewTransactions]
+      .reverse()
+      .map(previewTransaction => {
+        runningBalance += previewTransaction.amount;
+        return {
+          balance: runningBalance,
+          id: previewTransaction.id,
+        };
+      });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const previewBalances = [...previewTransactions]
.reverse()
.map(scheduledTransaction => {
const amount =
(scheduledTransaction._inverse ? -1 : 1) *
getScheduledAmount(scheduledTransaction.amount);
.map(previewTransaction => {
return {
// TODO: fix me
// eslint-disable-next-line react-hooks/exhaustive-deps
balance: (runningBalance += amount),
id: scheduledTransaction.id,
balance: (runningBalance += previewTransaction.amount),
id: previewTransaction.id,
};
});
return groupById(scheduledBalances);
}, [showBalances, prependTransactions, runningBalance]);
return groupById(previewBalances);
}, [showBalances, previewTransactions, runningBalance]);
const previewBalances = [...previewTransactions]
.reverse()
.map(previewTransaction => {
runningBalance += previewTransaction.amount;
return {
balance: runningBalance,
id: previewTransaction.id,
};
});
return groupById(previewBalances);
}, [showBalances, previewTransactions, runningBalance]);
🧰 Tools
🪛 Biome

[error] 202-202: The assignment should not be in an expression.

The use of assignments in expressions is confusing.
Expressions are often considered as side-effect free.

(lint/suspicious/noAssignInExpressions)


const allTransactions = useMemo(() => {
// Don't prepend scheduled transactions if we are filtering
if (!filtered && prependTransactions.length > 0) {
return prependTransactions.concat(transactions);
if (!filtered && previewTransactions.length > 0) {
return previewTransactions.concat(transactions);
}
return transactions;
}, [filtered, prependTransactions, transactions]);
}, [filtered, previewTransactions, transactions]);

const allBalances = useMemo(() => {
// Don't prepend scheduled transactions if we are filtering
Expand All @@ -216,7 +222,7 @@ function AllTransactions({
return balances;
}, [filtered, prependBalances, balances]);

if (!prependTransactions?.length || filtered) {
if (!previewTransactions?.length || filtered) {
return children(transactions, balances);
}
return children(allTransactions, allBalances);
Expand Down Expand Up @@ -1669,9 +1675,6 @@ class AccountInternal extends PureComponent<
balances={balances}
showBalances={showBalances}
filtered={transactionsFiltered}
collapseTransactions={ids =>
this.props.splitsExpandedDispatch({ type: 'close-splits', ids })
}
>
Comment on lines -1672 to 1678
Copy link
Contributor

@jfdoming jfdoming Sep 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the change from a callback to a useEffect, I now see a very brief flash of expanded preview transactions on desktop. It's not a big deal, but any ideas on how we can avoid that?

Repro: create test budget, update the "Fast Internet" schedule to a date in the future, and make it a splitting rule. Then view the "Bank of America" account

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fixed now :)

{(allTransactions, allBalances) => (
<SelectedProviderWithItems
Expand Down
6 changes: 4 additions & 2 deletions packages/desktop-client/src/components/mobile/accounts/AccountTransactions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import {
SchedulesProvider,
} from 'loot-core/client/data-hooks/schedules';
import {
usePreviewTransactions,
useTransactions,
useTransactionsSearch,
} from 'loot-core/client/data-hooks/transactions';
Expand All @@ -35,6 +34,7 @@ import {
type TransactionEntity,
} from 'loot-core/types/models';

import { useAccountPreviewTransactions } from '../../../hooks/useAccountPreviewTransactions';
import { useDateFormat } from '../../../hooks/useDateFormat';
import { useFailedAccounts } from '../../../hooks/useFailedAccounts';
import { useNavigate } from '../../../hooks/useNavigate';
Expand Down Expand Up @@ -239,7 +239,9 @@ function TransactionListWithPreviews({
query: transactionsQuery,
});

const { data: previewTransactions } = usePreviewTransactions();
const { previewTransactions } = useAccountPreviewTransactions({
accountId: account?.id || '',
});

const dateFormat = useDateFormat() || 'MM/dd/yyyy';
const dispatch = useDispatch();
Expand Down
54 changes: 19 additions & 35 deletions packages/desktop-client/src/components/mobile/transactions/TransactionEdit.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,25 +64,14 @@ import { MobilePageHeader, Page } from '../../Page';
import { AmountInput } from '../../util/AmountInput';
import { MobileBackButton } from '../MobileBackButton';
import { FieldLabel, TapField, InputField, ToggleField } from '../MobileForms';
import { getPrettyPayee } from '../utils';

import { FocusableAmountInput } from './FocusableAmountInput';

function getFieldName(transactionId, field) {
return `${field}-${transactionId}`;
}

export function getDescriptionPretty(transaction, payee, transferAcct) {
const { amount } = transaction;

if (transferAcct) {
return `Transfer ${amount > 0 ? 'from' : 'to'} ${transferAcct.name}`;
} else if (payee) {
return payee.name;
}

return '';
}

function serializeTransaction(transaction, dateFormat) {
const { date, amount } = transaction;
return {
Expand Down Expand Up @@ -291,7 +280,8 @@ const ChildTransactionEdit = forwardRef(
amountFocused,
amountSign,
getCategory,
getPrettyPayee,
getPayee,
getTransferAccount,
isOffBudget,
isBudgetTransfer,
onEditField,
Expand All @@ -302,6 +292,11 @@ const ChildTransactionEdit = forwardRef(
) => {
const { editingField, onRequestActiveEdit, onClearActiveEdit } =
useSingleActiveEditForm();
const prettyPayee = getPrettyPayee({
transaction,
payee: getPayee(transaction),
transferAccount: getTransferAccount(transaction),
});
return (
<View
innerRef={ref}
Expand All @@ -325,7 +320,7 @@ const ChildTransactionEdit = forwardRef(
editingField &&
editingField !== getFieldName(transaction.id, 'payee')
}
value={getPrettyPayee(transaction)}
value={prettyPayee}
onClick={() => onEditField(transaction.id, 'payee')}
data-testid={`payee-field-${transaction.id}`}
/>
Expand Down Expand Up @@ -503,32 +498,20 @@ const TransactionEditInner = memo(function TransactionEditInner({
[payeesById],
);

const getTransferAcct = useCallback(
const getTransferAccount = useCallback(
trans => {
const payee = trans && getPayee(trans);
return payee?.transfer_acct && accountsById?.[payee.transfer_acct];
},
[accountsById, getPayee],
);

const getPrettyPayee = useCallback(
trans => {
if (trans?.is_parent) {
return 'Split';
}
const transPayee = trans && getPayee(trans);
const transTransferAcct = trans && getTransferAcct(trans);
return getDescriptionPretty(trans, transPayee, transTransferAcct);
},
[getPayee, getTransferAcct],
);

const isBudgetTransfer = useCallback(
trans => {
const transferAcct = trans && getTransferAcct(trans);
const transferAcct = trans && getTransferAccount(trans);
return transferAcct && !transferAcct.offbudget;
},
[getTransferAcct],
[getTransferAccount],
);

const getCategory = useCallback(
Expand Down Expand Up @@ -759,11 +742,11 @@ const TransactionEditInner = memo(function TransactionEditInner({

const account = getAccount(transaction);
const isOffBudget = account && !!account.offbudget;
const title = getDescriptionPretty(
const title = getPrettyPayee({
transaction,
getPayee(transaction),
getTransferAcct(transaction),
);
payee: getPayee(transaction),
transferAccount: getTransferAccount(transaction),
joel-jeremy marked this conversation as resolved.
Show resolved Hide resolved
});

const transactionDate = parseDate(transaction.date, dateFormat, new Date());
const dateDefaultValue = monthUtils.dayFromDate(transactionDate);
Expand Down Expand Up @@ -834,7 +817,7 @@ const TransactionEditInner = memo(function TransactionEditInner({
fontWeight: 300,
}),
}}
value={getPrettyPayee(transaction)}
value={title}
disabled={
editingField &&
editingField !== getFieldName(transaction.id, 'payee')
Expand Down Expand Up @@ -882,7 +865,8 @@ const TransactionEditInner = memo(function TransactionEditInner({
}}
isOffBudget={isOffBudget}
getCategory={getCategory}
getPrettyPayee={getPrettyPayee}
getPayee={getPayee}
getTransferAccount={getTransferAccount}
isBudgetTransfer={isBudgetTransfer}
onUpdate={onUpdateInner}
onEditField={onEditFieldInner}
Expand Down
31 changes: 12 additions & 19 deletions packages/desktop-client/src/components/mobile/transactions/TransactionListItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
useLongPress,
} from '@react-aria/interactions';

import { getScheduledAmount } from 'loot-core/src/shared/schedules';
import { isPreviewId } from 'loot-core/src/shared/transactions';
import { integerToCurrency } from 'loot-core/src/shared/util';
import { type TransactionEntity } from 'loot-core/types/models';
Expand All @@ -32,8 +31,9 @@ import { Button } from '../../common/Button2';
import { Text } from '../../common/Text';
import { TextOneLine } from '../../common/TextOneLine';
import { View } from '../../common/View';
import { getPrettyPayee } from '../utils';

import { lookupName, getDescriptionPretty, Status } from './TransactionEdit';
import { lookupName, Status } from './TransactionEdit';

const ROW_HEIGHT = 60;

Expand All @@ -56,7 +56,7 @@ export function TransactionListItem({

const payee = usePayee(transaction?.payee || '');
const account = useAccount(transaction?.account || '');
const transferAcct = useAccount(payee?.transfer_acct || '');
const transferAccount = useAccount(payee?.transfer_acct || '');
const isPreview = isPreviewId(transaction?.id || '');

const newTransactions = useSelector(state => state.queries.newTransactions);
Expand Down Expand Up @@ -84,32 +84,25 @@ export function TransactionListItem({

const {
id,
amount: originalAmount,
amount,
category: categoryId,
cleared: isCleared,
reconciled: isReconciled,
is_parent: isParent,
is_child: isChild,
schedule,
schedule: scheduleId,
} = transaction;

const isAdded = newTransactions.includes(id);

let amount = originalAmount;
if (isPreview) {
amount = getScheduledAmount(amount);
}

const categoryName = lookupName(categories, categoryId);

const prettyDescription = getDescriptionPretty(
const prettyPayee = getPrettyPayee({
transaction,
payee,
transferAcct,
);
transferAccount,
});
const specialCategory = account?.offbudget
? 'Off Budget'
: transferAcct && !transferAcct.offbudget
: transferAccount && !transferAccount.offbudget
? 'Transfer'
: isParent
? 'Split'
Expand Down Expand Up @@ -169,7 +162,7 @@ export function TransactionListItem({
>
<View>
<View style={{ flexDirection: 'row', alignItems: 'center' }}>
{schedule && (
{scheduleId && (
<SvgArrowsSynchronize
style={{
width: 12,
Expand All @@ -183,13 +176,13 @@ export function TransactionListItem({
style={{
...textStyle,
fontWeight: isAdded ? '600' : '400',
...(prettyDescription === '' && {
...(prettyPayee === '' && {
color: theme.tableTextLight,
fontStyle: 'italic',
}),
}}
>
{prettyDescription || 'Empty'}
{prettyPayee || '(No payee)'}
</TextOneLine>
</View>
{isPreview ? (
Expand Down
Loading