Skip to content

A local-first personal finance app

Adds balance variable to rule templates (#5925)

Stephen Brown II94332016e876
diff --git a/packages/loot-core/src/server/rules/action.ts b/packages/loot-core/src/server/rules/action.ts
index 43e82136fd..194b6b1497 100644
--- a/packages/loot-core/src/server/rules/action.ts
+++ b/packages/loot-core/src/server/rules/action.ts
@@ -83,10 +83,13 @@ export class Action {
// Handlebars always returns a string, so we need to convert
switch (this.type) {
- case 'number':
- object[this.field] = parseFloat(object[this.field]);
+ case 'number': {
+ const numValue = parseFloat(object[this.field]);
+ // If the result is NaN, default to 0 to avoid database insertion errors
+ object[this.field] = isNaN(numValue) ? 0 : numValue;
break;
- case 'date':
+ }
+ case 'date': {
const parsed = parseDate(object[this.field]);
if (parsed && dateFns.isValid(parsed)) {
object[this.field] = format(parsed, 'yyyy-MM-dd');
@@ -100,6 +103,7 @@ export class Action {
object[this.field] = '9999-12-31';
}
break;
+ }
case 'boolean':
object[this.field] = object[this.field] === 'true';
break;
diff --git a/packages/loot-core/src/server/rules/index.test.ts b/packages/loot-core/src/server/rules/index.test.ts
index 81007d0a30..13b23c4bc2 100644
--- a/packages/loot-core/src/server/rules/index.test.ts
+++ b/packages/loot-core/src/server/rules/index.test.ts
@@ -330,6 +330,15 @@ describe('Action', () => {
expect(item.notes).toBe('Hey Sarah! You just payed 10');
});
+ test('should create actions with balance math operations', () => {
+ // This test ensures the template validation doesn't fail when using balance
+ expect(() => {
+ new Action('set', 'notes', '', {
+ template: '{{ floor (div (mul balance (div 7.99 100)) 12) }}',
+ });
+ }).not.toThrow();
+ });
+
test('should not escape text', () => {
const action = new Action('set', 'notes', '', {
template: '{{notes}}',
@@ -467,6 +476,44 @@ describe('Action', () => {
testHelper('{{concat "Sarah" "Trops" 12 "Wow"}}', 'SarahTrops12Wow');
});
+ test('should have access to balance variable', () => {
+ const action = new Action('set', 'notes', '', {
+ template: 'Balance: {{balance}}, Amount: {{amount}}',
+ });
+ const item = { notes: '', amount: 5000, balance: 100000 };
+ action.exec(item);
+ expect(item.notes).toBe('Balance: 100000, Amount: 5000');
+ });
+
+ test('should allow math operations on balance', () => {
+ const action = new Action('set', 'notes', '', {
+ template: 'New balance: {{add balance amount}}',
+ });
+ const item = { notes: '', amount: 5000, balance: 100000 };
+ action.exec(item);
+ expect(item.notes).toBe('New balance: 105000');
+ });
+
+ test('should handle undefined balance gracefully in number fields', () => {
+ const action = new Action('set', 'amount', '', {
+ template: '{{ floor (div (mul balance (div 7.99 100)) 12) }}',
+ });
+ const item = { amount: 0 }; // No balance field
+ action.exec(item);
+ // Should default to 0 instead of NaN when balance is undefined
+ expect(item.amount).toBe(0);
+ });
+
+ test('should calculate with balance in number fields', () => {
+ const action = new Action('set', 'amount', '', {
+ template: '{{ floor (div (mul balance (div 7.99 100)) 12) }}',
+ });
+ const item = { amount: 0, balance: 1200 };
+ action.exec(item);
+ // (1200 * 7.99) / 12 = 7.99 -> floor = 7
+ expect(item.amount).toBe(7);
+ });
+
test('{{debug}} should log the item', () => {
const action = new Action('set', 'notes', '', {
template: '{{debug notes}}',
diff --git a/packages/loot-core/src/server/transactions/transaction-rules.ts b/packages/loot-core/src/server/transactions/transaction-rules.ts
index 0505cc0a7b..7ad5098f14 100644
--- a/packages/loot-core/src/server/transactions/transaction-rules.ts
+++ b/packages/loot-core/src/server/transactions/transaction-rules.ts
@@ -8,6 +8,7 @@ import {
parseDate,
dayFromDate,
} from '../../shared/months';
+import { q } from '../../shared/query';
import { sortNumbers, getApproxNumberThreshold } from '../../shared/rules';
import { ungroupTransaction } from '../../shared/transactions';
import { partitionByField, fastSetMerge } from '../../shared/util';
@@ -16,7 +17,7 @@ import {
type RuleActionEntity,
type RuleEntity,
} from '../../types/models';
-import { schemaConfig } from '../aql';
+import { aqlQuery, schemaConfig } from '../aql';
import * as db from '../db';
import { getPayee, getPayeeByName, insertPayee, getAccount } from '../db';
import { getMappings } from '../db/mappings';
@@ -925,6 +926,7 @@ export async function updateCategoryRules(transactions) {
export type TransactionForRules = TransactionEntity & {
payee_name?: string;
_account?: db.DbAccount;
+ balance?: number;
};
export async function prepareTransactionForRules(
@@ -939,12 +941,51 @@ export async function prepareTransactionForRules(
}
}
+ r.balance = 0;
+
if (trans.account) {
if (accounts !== null && accounts.has(trans.account)) {
r._account = accounts.get(trans.account);
} else {
r._account = await getAccount(trans.account);
}
+
+ const dateBoundary = trans.date ?? currentDay();
+ let query = q('transactions')
+ .filter({ account: trans.account, is_parent: false })
+ .options({ splits: 'inline' });
+
+ if (trans.id) {
+ query = query.filter({ id: { $ne: trans.id } });
+ }
+
+ const sameDayFilter =
+ trans.sort_order != null
+ ? {
+ $and: [
+ { date: dateBoundary },
+ { sort_order: { $lt: trans.sort_order } },
+ ],
+ }
+ : {
+ $and: [
+ { date: dateBoundary },
+ {
+ $or: [
+ { sort_order: { $ne: null } }, // ordered items come before null sort_order
+ ...(trans.id ? [{ id: { $lt: trans.id } }] : []), // among nulls, tie-break by id
+ ],
+ },
+ ],
+ };
+
+ const { data: balance } = await aqlQuery(
+ query
+ .filter({ $or: [{ date: { $lt: dateBoundary } }, sameDayFilter] })
+ .calculate({ $sum: '$amount' }),
+ );
+
+ r.balance = balance ?? 0;
}
return r;
@@ -970,5 +1011,9 @@ export async function finalizeTransactionForRules(
delete trans.payee_name;
}
+ if ('balance' in trans) {
+ delete trans.balance;
+ }
+
return trans;
}
diff --git a/upcoming-release-notes/5925.md b/upcoming-release-notes/5925.md
new file mode 100644
index 0000000000..9b5f0bd3df
--- /dev/null
+++ b/upcoming-release-notes/5925.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [StephenBrown2]
+---
+
+Enables access to the account balance within rule templates.