Skip to content

A local-first personal finance app

[AI] fix(api): translate default rule stage at API boundary (#8689)

cakenid5aef429ec56
diff --git a/packages/api/methods.ts b/packages/api/methods.ts
index a9c8736069..1ad394bb50 100644
--- a/packages/api/methods.ts
+++ b/packages/api/methods.ts
@@ -5,6 +5,7 @@ import type {
APICategoryGroupEntity,
APIFileEntity,
APIPayeeEntity,
+ APIRuleEntity,
APIScheduleEntity,
APITagEntity,
} from '@actual-app/core/server/api-models';
@@ -362,11 +363,11 @@ export function getPayeeRules(id: RuleEntity['id']) {
return send('api/payee-rules-get', { id });
}
-export function createRule(rule: Omit<RuleEntity, 'id'>) {
+export function createRule(rule: Omit<APIRuleEntity, 'id'>) {
return send('api/rule-create', { rule });
}
-export function updateRule(rule: RuleEntity) {
+export function updateRule(rule: APIRuleEntity) {
return send('api/rule-update', { rule });
}
diff --git a/packages/loot-core/src/server/api-models.ts b/packages/loot-core/src/server/api-models.ts
index 6a022d1398..b2c791965f 100644
--- a/packages/loot-core/src/server/api-models.ts
+++ b/packages/loot-core/src/server/api-models.ts
@@ -3,7 +3,9 @@ import type {
AccountEntity,
CategoryEntity,
CategoryGroupEntity,
+ NewRuleEntity,
PayeeEntity,
+ RuleEntity,
ScheduleEntity,
TagEntity,
} from '#types/models';
@@ -123,6 +125,23 @@ export const payeeModel = {
},
};
+export type APIRuleEntity = Omit<RuleEntity, 'stage'> & {
+ stage: RuleEntity['stage'] | 'default';
+};
+
+function fromExternalRule(rule: APIRuleEntity): RuleEntity;
+function fromExternalRule(rule: Omit<APIRuleEntity, 'id'>): NewRuleEntity;
+function fromExternalRule(rule: Omit<APIRuleEntity, 'id'> | APIRuleEntity) {
+ return {
+ ...rule,
+ stage: rule.stage === 'default' ? null : rule.stage,
+ };
+}
+
+export const ruleModel = {
+ fromExternal: fromExternalRule,
+};
+
export type APITagEntity = Pick<
TagEntity,
'id' | 'tag' | 'color' | 'description'
diff --git a/packages/loot-core/src/server/api.test.ts b/packages/loot-core/src/server/api.test.ts
index 1561442435..7e371df7ee 100644
--- a/packages/loot-core/src/server/api.test.ts
+++ b/packages/loot-core/src/server/api.test.ts
@@ -138,4 +138,65 @@ describe('API handlers', () => {
expect(group?.categories?.[0]).toHaveProperty('carryover', false);
});
});
+
+ describe('api/rule-create', () => {
+ beforeEach(global.emptyDatabase());
+
+ beforeEach(async () => {
+ await prefs.loadPrefs();
+ });
+
+ test.each(['default', null, 'pre', 'post'] as const)(
+ 'normalizes %s input at the API boundary',
+ async stage => {
+ const rule = {
+ stage,
+ conditionsOp: 'and' as const,
+ conditions: [],
+ actions: [],
+ };
+ const internalRule = {
+ id: 'rule-id',
+ ...rule,
+ stage: stage === 'default' ? null : stage,
+ };
+
+ handlers['rule-add'] = vi.fn().mockResolvedValue(internalRule);
+
+ await expect(handlers['api/rule-create']({ rule })).resolves.toEqual(
+ internalRule,
+ );
+ expect(handlers['rule-add']).toHaveBeenCalledWith({
+ ...rule,
+ stage: internalRule.stage,
+ });
+ },
+ );
+ });
+
+ describe('api/rule-update', () => {
+ beforeEach(global.emptyDatabase());
+
+ beforeEach(async () => {
+ await prefs.loadPrefs();
+ });
+
+ test('normalizes default input at the API boundary', async () => {
+ const rule = {
+ id: 'rule-id',
+ stage: 'default' as const,
+ conditionsOp: 'and' as const,
+ conditions: [],
+ actions: [],
+ };
+ const internalRule = { ...rule, stage: null };
+
+ handlers['rule-update'] = vi.fn().mockResolvedValue(internalRule);
+
+ await expect(handlers['api/rule-update']({ rule })).resolves.toEqual(
+ internalRule,
+ );
+ expect(handlers['rule-update']).toHaveBeenCalledWith(internalRule);
+ });
+ });
});
diff --git a/packages/loot-core/src/server/api.ts b/packages/loot-core/src/server/api.ts
index 0701df1c84..8c7389e93a 100644
--- a/packages/loot-core/src/server/api.ts
+++ b/packages/loot-core/src/server/api.ts
@@ -33,6 +33,7 @@ import {
categoryModel,
payeeModel,
remoteFileModel,
+ ruleModel,
scheduleModel,
tagModel,
} from './api-models';
@@ -862,7 +863,7 @@ handlers['api/payee-rules-get'] = async function ({ id }) {
handlers['api/rule-create'] = withMutation(async function ({ rule }) {
checkFileOpen();
- const addedRule = await handlers['rule-add'](rule);
+ const addedRule = await handlers['rule-add'](ruleModel.fromExternal(rule));
if ('error' in addedRule) {
throw APIError('Failed creating a new rule', addedRule.error);
@@ -873,7 +874,9 @@ handlers['api/rule-create'] = withMutation(async function ({ rule }) {
handlers['api/rule-update'] = withMutation(async function ({ rule }) {
checkFileOpen();
- const updatedRule = await handlers['rule-update'](rule);
+ const updatedRule = await handlers['rule-update'](
+ ruleModel.fromExternal(rule),
+ );
if ('error' in updatedRule) {
throw APIError('Failed updating the rule', updatedRule.error);
diff --git a/packages/loot-core/src/types/api-handlers.ts b/packages/loot-core/src/types/api-handlers.ts
index 54baacdd24..84a23be64a 100644
--- a/packages/loot-core/src/types/api-handlers.ts
+++ b/packages/loot-core/src/types/api-handlers.ts
@@ -6,6 +6,7 @@ import type {
APICategoryGroupEntity,
APIFileEntity,
APIPayeeEntity,
+ APIRuleEntity,
APIScheduleEntity,
APITagEntity,
} from '#server/api-models';
@@ -18,7 +19,6 @@ import type {
CategoryGroupEntity,
ImportTransactionEntity,
NearbyPayeeEntity,
- NewRuleEntity,
NoteEntity,
PayeeEntity,
PayeeLocationEntity,
@@ -261,9 +261,11 @@ export type ApiHandlers = {
id: APIPayeeEntity['id'];
}) => Promise<RuleEntity[]>;
- 'api/rule-create': (arg: { rule: NewRuleEntity }) => Promise<RuleEntity>;
+ 'api/rule-create': (arg: {
+ rule: Omit<APIRuleEntity, 'id'>;
+ }) => Promise<RuleEntity>;
- 'api/rule-update': (arg: { rule: RuleEntity }) => Promise<RuleEntity>;
+ 'api/rule-update': (arg: { rule: APIRuleEntity }) => Promise<RuleEntity>;
'api/rule-delete': (id: RuleEntity['id']) => Promise<boolean>;
diff --git a/upcoming-release-notes/8689.md b/upcoming-release-notes/8689.md
new file mode 100644
index 0000000000..048f0cabf1
--- /dev/null
+++ b/upcoming-release-notes/8689.md
@@ -0,0 +1,6 @@
+---
+category: Bugfix
+authors: [cakeni]
+---
+
+Fix the Rule API default stage handling.