Skip to content

A local-first personal finance app

enhance: add ability to control category learning per payee and globally (#4081)

Bruno Ribeiroe70dc4efb006
diff --git a/packages/desktop-client/src/components/Modals.tsx b/packages/desktop-client/src/components/Modals.tsx
index 4c1ac33c48..897a711d68 100644
--- a/packages/desktop-client/src/components/Modals.tsx
+++ b/packages/desktop-client/src/components/Modals.tsx
@@ -70,6 +70,7 @@ import { TrackingBudgetMonthMenuModal } from './modals/TrackingBudgetMonthMenuMo
import { TrackingBudgetSummaryModal } from './modals/TrackingBudgetSummaryModal';
import { TransferModal } from './modals/TransferModal';
import { TransferOwnership } from './modals/TransferOwnership';
+import { CategoryLearning } from './payees/CategoryLearning';
import { DiscoverSchedules } from './schedules/DiscoverSchedules';
import { PostsOfflineNotification } from './schedules/PostsOfflineNotification';
import { ScheduleDetails } from './schedules/ScheduleDetails';
@@ -289,6 +290,9 @@ export function Modals() {
/>
);
+ case 'payee-category-learning':
+ return <CategoryLearning key={name} />;
+
case 'new-category':
return (
<SingleInputModal
diff --git a/packages/desktop-client/src/components/payees/CategoryLearning.tsx b/packages/desktop-client/src/components/payees/CategoryLearning.tsx
new file mode 100644
index 0000000000..ac1b8851c1
--- /dev/null
+++ b/packages/desktop-client/src/components/payees/CategoryLearning.tsx
@@ -0,0 +1,64 @@
+import React from 'react';
+import { Trans, useTranslation } from 'react-i18next';
+
+import { useSyncedPref } from '../../hooks/useSyncedPref';
+import { Button } from '../common/Button2';
+import { Link } from '../common/Link';
+import { Modal, ModalCloseButton, ModalHeader } from '../common/Modal';
+import { Paragraph } from '../common/Paragraph';
+
+export function CategoryLearning() {
+ const { t } = useTranslation();
+ const [learnCategories = 'true', setLearnCategories] =
+ useSyncedPref('learn-categories');
+ const isLearnCategoriesEnabled = String(learnCategories) === 'true';
+
+ return (
+ <Modal
+ name="payee-category-learning"
+ containerProps={{ style: { width: 600 } }}
+ >
+ {({ state: { close } }) => (
+ <>
+ <ModalHeader
+ title={t('Category Learning')}
+ rightContent={<ModalCloseButton onPress={close} />}
+ />
+ <Paragraph>
+ <Trans>
+ <strong>Category Learning</strong> will automatically determine
+ the best category for a transaction and create a rule that sets
+ the category for the payee.{' '}
+ <Link
+ variant="external"
+ to="https://actualbudget.org/docs/budgeting/rules/#automatic-rules"
+ linkColor="purple"
+ >
+ Learn more
+ </Link>
+ </Trans>
+ </Paragraph>
+ <Paragraph>
+ <Trans>
+ Disabling Category Learning will not delete any existing rules but
+ will prevent new rules from being created automatically on a
+ global level.
+ </Trans>
+ </Paragraph>
+ <Button
+ onPress={() =>
+ setLearnCategories(String(!isLearnCategoriesEnabled))
+ }
+ variant={isLearnCategoriesEnabled ? 'normal' : 'primary'}
+ >
+ {isLearnCategoriesEnabled ? (
+ <Trans>Disable category learning</Trans>
+ ) : (
+ <Trans>Enable category learning</Trans>
+ )}
+ </Button>
+ </>
+ )}
+ </Modal>
+ );
+}
diff --git a/packages/desktop-client/src/components/payees/ManagePayees.tsx b/packages/desktop-client/src/components/payees/ManagePayees.tsx
index 7bc630a1f9..abf3be012a 100644
--- a/packages/desktop-client/src/components/payees/ManagePayees.tsx
+++ b/packages/desktop-client/src/components/payees/ManagePayees.tsx
@@ -5,10 +5,11 @@ import {
useCallback,
type ComponentProps,
} from 'react';
-import { useTranslation } from 'react-i18next';
+import { Trans, useTranslation } from 'react-i18next';
import memoizeOne from 'memoize-one';
+import { pushModal } from 'loot-core/client/actions';
import { getNormalisedString } from 'loot-core/src/shared/normalisation';
import { type Diff, groupById } from 'loot-core/src/shared/util';
import { type PayeeEntity } from 'loot-core/types/models';
@@ -20,6 +21,7 @@ import {
useSelectedItems,
} from '../../hooks/useSelected';
import { SvgExpandArrow } from '../../icons/v0';
+import { useDispatch } from '../../redux';
import { theme } from '../../style';
import { Button } from '../common/Button2';
import { Popover } from '../common/Popover';
@@ -91,6 +93,7 @@ export const ManagePayees = ({
const triggerRef = useRef(null);
const [orphanedOnly, setOrphanedOnly] = useState(false);
const { t } = useTranslation();
+ const dispatch = useDispatch();
const filteredPayees = useMemo(() => {
let filtered = payees;
@@ -116,7 +119,7 @@ export const ManagePayees = ({
}
const onUpdate = useCallback(
- <T extends 'name' | 'favorite'>(
+ <T extends 'name' | 'favorite' | 'learn_categories'>(
id: PayeeEntity['id'],
name: T,
value: PayeeEntity[T],
@@ -168,6 +171,26 @@ export const ManagePayees = ({
selected.dispatch({ type: 'select-none' });
}
+ function onLearn() {
+ const allLearnCategories = [...selected.items]
+ .map(id => payeesById[id].learn_categories)
+ .every(f => f === 1);
+ if (allLearnCategories) {
+ onBatchChange({
+ updated: [...selected.items].map(id => ({ id, learn_categories: 0 })),
+ added: [],
+ deleted: [],
+ });
+ } else {
+ onBatchChange({
+ updated: [...selected.items].map(id => ({ id, learn_categories: 1 })),
+ added: [],
+ deleted: [],
+ });
+ }
+ selected.dispatch({ type: 'select-none' });
+ }
+
async function onMerge() {
const ids = [...selected.items];
await props.onMerge(ids);
@@ -175,6 +198,10 @@ export const ManagePayees = ({
selected.dispatch({ type: 'select-none' });
}
+ const onChangeCategoryLearning = useCallback(() => {
+ dispatch(pushModal('payee-category-learning'));
+ }, [dispatch]);
+
const buttonsDisabled = selected.items.size === 0;
const payeesById = getPayeesById(payees);
@@ -220,6 +247,7 @@ export const ManagePayees = ({
onDelete={onDelete}
onMerge={onMerge}
onFavorite={onFavorite}
+ onLearn={onLearn}
/>
</Popover>
</View>
@@ -290,6 +318,31 @@ export const ManagePayees = ({
)}
</View>
</SelectedProvider>
+
+ <View
+ style={{
+ flexDirection: 'row',
+ justifyContent: 'space-between',
+ margin: '20px 0',
+ flexShrink: 0,
+ }}
+ >
+ <View
+ style={{
+ flexDirection: 'row',
+ alignItems: 'center',
+ gap: '1em',
+ }}
+ >
+ <Button
+ aria-label={t('Category learning settings')}
+ variant="normal"
+ onPress={onChangeCategoryLearning}
+ >
+ <Trans>Category learning settings</Trans>
+ </Button>
+ </View>
+ </View>
</View>
);
};
diff --git a/packages/desktop-client/src/components/payees/PayeeMenu.tsx b/packages/desktop-client/src/components/payees/PayeeMenu.tsx
index 21f23fe8fd..919f808181 100644
--- a/packages/desktop-client/src/components/payees/PayeeMenu.tsx
+++ b/packages/desktop-client/src/components/payees/PayeeMenu.tsx
@@ -2,10 +2,11 @@ import { useTranslation, Trans } from 'react-i18next';
import { type PayeeEntity } from 'loot-core/src/types/models';
+import { useSyncedPref } from '../../hooks/useSyncedPref';
import { SvgDelete, SvgMerge } from '../../icons/v0';
-import { SvgBookmark } from '../../icons/v1';
+import { SvgBookmark, SvgLightBulb } from '../../icons/v1';
import { theme } from '../../style';
-import { Menu } from '../common/Menu';
+import { Menu, type MenuItem } from '../common/Menu';
import { View } from '../common/View';
type PayeeMenuProps = {
@@ -14,6 +15,7 @@ type PayeeMenuProps = {
onDelete: () => void;
onMerge: () => Promise<void>;
onFavorite: () => void;
+ onLearn: () => void;
onClose: () => void;
};
@@ -23,9 +25,12 @@ export function PayeeMenu({
onDelete,
onMerge,
onFavorite,
+ onLearn,
onClose,
}: PayeeMenuProps) {
const { t } = useTranslation();
+ const [learnCategories = 'true'] = useSyncedPref('learn-categories');
+ const isLearnCategoriesEnabled = String(learnCategories) === 'true';
// Transfer accounts are never editable
const isDisabled = [...selectedPayees].some(
@@ -37,6 +42,41 @@ export function PayeeMenu({
.map(id => payeesById[id].name)
.join(', ');
+ const items: MenuItem[] = [
+ {
+ icon: SvgDelete,
+ name: 'delete',
+ text: t('Delete'),
+ disabled: isDisabled,
+ },
+ {
+ icon: SvgBookmark,
+ iconSize: 9,
+ name: 'favorite',
+ text: t('Favorite'),
+ disabled: isDisabled,
+ },
+ {
+ icon: SvgMerge,
+ iconSize: 9,
+ name: 'merge',
+ text: t('Merge'),
+ disabled: isDisabled || selectedPayees.size < 2,
+ },
+ ];
+
+ if (isLearnCategoriesEnabled) {
+ items.push({
+ icon: SvgLightBulb,
+ iconSize: 9,
+ name: 'learn',
+ text: t('Category Learning'),
+ disabled: isDisabled,
+ });
+ }
+
+ items.push(Menu.line);
+
return (
<Menu
onMenuSelect={type => {
@@ -51,6 +91,9 @@ export function PayeeMenu({
case 'favorite':
onFavorite();
break;
+ case 'learn':
+ onLearn();
+ break;
default:
}
}}
@@ -70,29 +113,7 @@ export function PayeeMenu({
)}
</View>
}
- items={[
- {
- icon: SvgDelete,
- name: 'delete',
- text: t('Delete'),
- disabled: isDisabled,
- },
- {
- icon: SvgBookmark,
- iconSize: 9,
- name: 'favorite',
- text: t('Favorite'),
- disabled: isDisabled,
- },
- {
- icon: SvgMerge,
- iconSize: 9,
- name: 'merge',
- text: t('Merge'),
- disabled: isDisabled || selectedPayees.size < 2,
- },
- Menu.line,
- ]}
+ items={items}
/>
);
}
diff --git a/packages/desktop-client/src/components/payees/PayeeTableRow.tsx b/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
index 5392c1a435..01ec9f3bf1 100644
--- a/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
+++ b/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
@@ -6,11 +6,13 @@ import { type PayeeEntity } from 'loot-core/src/types/models';
import { useContextMenu } from '../../hooks/useContextMenu';
import { useSelectedDispatch } from '../../hooks/useSelected';
-import { SvgArrowThinRight, SvgBookmark } from '../../icons/v1';
+import { useSyncedPref } from '../../hooks/useSyncedPref';
+import { SvgArrowThinRight, SvgBookmark, SvgLightBulb } from '../../icons/v1';
import { theme } from '../../style';
import { Menu } from '../common/Menu';
import { Popover } from '../common/Popover';
import { Text } from '../common/Text';
+import { Tooltip } from '../common/Tooltip';
import {
Cell,
CellButton,
@@ -63,7 +65,10 @@ function RuleButton({ ruleCount, focused, onEdit, onClick }: RuleButtonProps) {
);
}
-type EditablePayeeFields = keyof Pick<PayeeEntity, 'name' | 'favorite'>;
+type EditablePayeeFields = keyof Pick<
+ PayeeEntity,
+ 'name' | 'favorite' | 'learn_categories'
+>;
type PayeeTableRowProps = {
payee: PayeeEntity;
@@ -107,6 +112,8 @@ export const PayeeTableRow = memo(
? theme.tableBorderSelected
: theme.tableBorder;
const backgroundFocus = hovered || focusedField === 'select';
+ const [learnCategories = 'true'] = useSyncedPref('learn-categories');
+ const isLearnCategoriesEnabled = String(learnCategories) === 'true';
const { t } = useTranslation();
@@ -158,6 +165,13 @@ export const PayeeTableRow = memo(
},
ruleCount > 0 && { name: 'view-rules', text: t('View rules') },
{ name: 'create-rule', text: t('Create rule') },
+ isLearnCategoriesEnabled &&
+ (payee.learn_categories
+ ? {
+ name: 'learn',
+ text: t('Disable learning'),
+ }
+ : { name: 'learn', text: t('Enable learning') }),
]}
onMenuSelect={name => {
switch (name) {
@@ -167,6 +181,13 @@ export const PayeeTableRow = memo(
case 'favorite':
onUpdate(id, 'favorite', payee.favorite ? 0 : 1);
break;
+ case 'learn':
+ onUpdate(
+ id,
+ 'learn_categories',
+ payee.learn_categories ? 0 : 1,
+ );
+ break;
case 'view-rules':
onViewRules(id);
break;
@@ -198,18 +219,29 @@ export const PayeeTableRow = memo(
}}
/>
<CustomCell
- width={10}
+ width={20}
exposed={!payee.transfer_acct}
onBlur={() => {}}
onUpdate={() => {}}
onClick={() => {}}
+ style={{
+ display: 'flex',
+ justifyContent: 'center',
+ alignItems: 'center',
+ flexDirection: 'row',
+ }}
>
{() => {
- if (payee.favorite) {
- return <SvgBookmark />;
- } else {
- return;
- }
+ return (
+ <>
+ {payee.favorite ? <SvgBookmark style={{ width: 10 }} /> : null}
+ {isLearnCategoriesEnabled && !payee.learn_categories && (
+ <Tooltip content={t('Category learning disabled')}>
+ <SvgLightBulb style={{ color: 'red', width: 10 }} />
+ </Tooltip>
+ )}
+ </>
+ );
}}
</CustomCell>
<InputCell
diff --git a/packages/desktop-client/src/components/transactions/TransactionList.jsx b/packages/desktop-client/src/components/transactions/TransactionList.jsx
index 7e39f76272..6d06f7c9f8 100644
--- a/packages/desktop-client/src/components/transactions/TransactionList.jsx
+++ b/packages/desktop-client/src/components/transactions/TransactionList.jsx
@@ -12,6 +12,7 @@ import {
import { getChangedValues, applyChanges } from 'loot-core/src/shared/util';
import { useNavigate } from '../../hooks/useNavigate';
+import { useSyncedPref } from '../../hooks/useSyncedPref';
import { useDispatch } from '../../redux';
import { theme } from '../../style';
@@ -37,19 +38,20 @@ import { TransactionTable } from './TransactionsTable';
// differently than a full refresh. It's up to you to decide which
// one to use when doing updates.
-async function saveDiff(diff) {
+async function saveDiff(diff, learnCategories) {
const remoteUpdates = await send('transactions-batch-update', {
...diff,
- learnCategories: true,
+ learnCategories,
});
+
if (remoteUpdates.length > 0) {
return { updates: remoteUpdates };
}
return {};
}
-async function saveDiffAndApply(diff, changes, onChange) {
- const remoteDiff = await saveDiff(diff);
+async function saveDiffAndApply(diff, changes, onChange, learnCategories) {
+ const remoteDiff = await saveDiff(diff, learnCategories);
onChange(
applyTransactionDiff(changes.newTransaction, remoteDiff),
applyChanges(remoteDiff, changes.data),
@@ -100,6 +102,8 @@ export function TransactionList({
const dispatch = useDispatch();
const transactionsLatest = useRef();
const navigate = useNavigate();
+ const [learnCategories = 'true'] = useSyncedPref('learn-categories');
+ const isLearnCategoriesEnabled = String(learnCategories) === 'true';
useLayoutEffect(() => {
transactionsLatest.current = transactions;
@@ -108,7 +112,7 @@ export function TransactionList({
const onAdd = useCallback(async newTransactions => {
newTransactions = realizeTempTransactions(newTransactions);
- await saveDiff({ added: newTransactions });
+ await saveDiff({ added: newTransactions }, isLearnCategoriesEnabled);
onRefetch();
}, []);
@@ -122,11 +126,16 @@ export function TransactionList({
// Make sure it stays at the top of the list of transactions
// for that date
changes.diff.updated[0].sort_order = Date.now();
- await saveDiff(changes.diff);
+ await saveDiff(changes.diff, isLearnCategoriesEnabled);
onRefetch();
} else {
onChange(changes.newTransaction, changes.data);
- saveDiffAndApply(changes.diff, changes, onChange);
+ saveDiffAndApply(
+ changes.diff,
+ changes,
+ onChange,
+ isLearnCategoriesEnabled,
+ );
}
}
}, []);
@@ -134,14 +143,14 @@ export function TransactionList({
const onAddSplit = useCallback(id => {
const changes = addSplitTransaction(transactionsLatest.current, id);
onChange(changes.newTransaction, changes.data);
- saveDiffAndApply(changes.diff, changes, onChange);
+ saveDiffAndApply(changes.diff, changes, onChange, isLearnCategoriesEnabled);
return changes.diff.added[0].id;
}, []);
const onSplit = useCallback(id => {
const changes = splitTransaction(transactionsLatest.current, id);
onChange(changes.newTransaction, changes.data);
- saveDiffAndApply(changes.diff, changes, onChange);
+ saveDiffAndApply(changes.diff, changes, onChange, isLearnCategoriesEnabled);
return changes.diff.added[0].id;
}, []);
diff --git a/packages/loot-core/migrations/1737158400000_add_learn_categories_to_payees.sql b/packages/loot-core/migrations/1737158400000_add_learn_categories_to_payees.sql
new file mode 100644
index 0000000000..c43c291ba2
--- /dev/null
+++ b/packages/loot-core/migrations/1737158400000_add_learn_categories_to_payees.sql
@@ -0,0 +1,5 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE payees ADD COLUMN learn_categories BOOLEAN DEFAULT 1;
+
+COMMIT;
diff --git a/packages/loot-core/src/client/state-types/modals.d.ts b/packages/loot-core/src/client/state-types/modals.d.ts
index 19ff499522..04065adada 100644
--- a/packages/loot-core/src/client/state-types/modals.d.ts
+++ b/packages/loot-core/src/client/state-types/modals.d.ts
@@ -164,6 +164,8 @@ type FinanceModals = {
onClose?: () => void;
};
+ 'payee-category-learning': null;
+
'budget-summary': {
month: string;
};
diff --git a/packages/loot-core/src/server/accounts/transaction-rules.test.ts b/packages/loot-core/src/server/accounts/transaction-rules.test.ts
index 37fe3e238f..5004ebb5c3 100644
--- a/packages/loot-core/src/server/accounts/transaction-rules.test.ts
+++ b/packages/loot-core/src/server/accounts/transaction-rules.test.ts
@@ -869,6 +869,29 @@ describe('Learning categories', () => {
expect(getRules().length).toBe(0);
});
+ test('avoids remembering categories for payees specified by the user', async () => {
+ await loadData();
+
+ expect(getRules().length).toBe(0);
+ await db.insertPayee({
+ id: 'supermarket_id',
+ name: 'supermarket',
+ learn_categories: 0,
+ });
+
+ const trans = {
+ date: '2016-12-01',
+ account: 'acct',
+ payee: 'supermarket_id',
+ category: 'food',
+ };
+ await db.insertTransaction({ ...trans, id: 'one' });
+ await db.insertTransaction({ ...trans, id: 'two' });
+ await db.insertTransaction({ ...trans, id: 'three' });
+ await updateCategoryRules([{ ...trans, id: 'three' }]);
+ expect(getRules().length).toBe(0);
+ });
+
test('adding transaction with `null` payee never changes rules', async () => {
await loadData();
diff --git a/packages/loot-core/src/server/accounts/transaction-rules.ts b/packages/loot-core/src/server/accounts/transaction-rules.ts
index 8a8d52c72b..9d4baf72d6 100644
--- a/packages/loot-core/src/server/accounts/transaction-rules.ts
+++ b/packages/loot-core/src/server/accounts/transaction-rules.ts
@@ -801,7 +801,8 @@ export async function updateCategoryRules(transactions) {
const register: TransactionEntity[] = await db.all(
`SELECT t.* FROM v_transactions t
LEFT JOIN accounts a ON a.id = t.account
- WHERE date >= ? AND date <= ? AND is_parent = 0 AND a.closed = 0
+ LEFT JOIN payees p ON p.id = t.payee
+ WHERE date >= ? AND date <= ? AND is_parent = 0 AND a.closed = 0 AND p.learn_categories = 1
ORDER BY date DESC`,
[toDateRepr(oldestDate), toDateRepr(addDays(currentDay(), 180))],
);
diff --git a/packages/loot-core/src/types/models/payee.d.ts b/packages/loot-core/src/types/models/payee.d.ts
index 37e3f77bb0..7b9d0cd429 100644
--- a/packages/loot-core/src/types/models/payee.d.ts
+++ b/packages/loot-core/src/types/models/payee.d.ts
@@ -5,5 +5,6 @@ export interface PayeeEntity {
name: string;
transfer_acct?: AccountEntity['id'];
favorite?: 1 | 0;
+ learn_categories?: 1 | 0;
tombstone?: boolean;
}
diff --git a/packages/loot-core/src/types/prefs.d.ts b/packages/loot-core/src/types/prefs.d.ts
index ea397a6764..30500300aa 100644
--- a/packages/loot-core/src/types/prefs.d.ts
+++ b/packages/loot-core/src/types/prefs.d.ts
@@ -31,7 +31,8 @@ export type SyncedPrefs = Partial<
| `csv-has-header-${string}`
| `ofx-fallback-missing-payee-${string}`
| `flip-amount-${string}-${'csv' | 'qif'}`
- | `flags.${FeatureFlag}`,
+ | `flags.${FeatureFlag}`
+ | `learn-categories`,
string
>
>;
diff --git a/upcoming-release-notes/4081.md b/upcoming-release-notes/4081.md
new file mode 100644
index 0000000000..e0101a5b5e
--- /dev/null
+++ b/upcoming-release-notes/4081.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [NullScope]
+---
+
+Added ability to control category learning per payee and globally