[PR #7314] [AI] Preserve explicit fields after rules in reconcile and addTransactions #56382

Open
opened 2026-05-01 04:12:49 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/7314
Author: @pranayseela
Created: 3/28/2026
Status: 🔄 Open

Base: masterHead: fix/7171-api-rules-explicit-fields


📝 Commits (4)

  • 285cd08 [AI] Preserve explicit fields after rules in reconcile and addTransactions
  • 00244da [AI] Add release notes and expand tests for #7171 explicit fields after rules
  • bf0366e [AI] Name release notes file upcoming-release-notes/7314.md for CI
  • 7cba413 [AI] Add API tests and docs for explicit fields after rules (#7171)

📊 Changes

7 files changed (+262 additions, -10 deletions)

View changed files

📝 packages/api/methods.test.ts (+92 -0)
📝 packages/docs/docs/api/index.md (+2 -0)
📝 packages/docs/docs/api/reference.md (+6 -0)
📝 packages/docs/docs/budgeting/rules/index.md (+2 -0)
📝 packages/loot-core/src/server/accounts/sync.test.ts (+118 -0)
📝 packages/loot-core/src/server/accounts/sync.ts (+36 -10)
upcoming-release-notes/7314.md (+6 -0)

📄 Description

Summary

  • Introduce mergeExplicitFieldsOntoRuleResult and apply it after runRules in both addTransactions and matchTransactions (import/reconcile).
  • Record non-null fields on incoming rows as explicitFields during normalization; restore them after rules so explicit API/import values win over rule actions (#7171).
  • Bank sync normalized rows use explicitFields: [] so provider data remains fully rule-processed.
  • Tests cover explicit category, notes, and payee on addTransactions, and explicit category and notes on reconcile.
  • Release notes: upcoming-release-notes/7314.md.

Description

Rules were overwriting fields that callers set when adding or importing transactions (for example, a category passed through the API). We now remember which fields were non-null before runRules and copy those values back onto the transaction afterward. Bank sync uses an empty explicitFields list so institution imports behave as before.

Fixes #7171

Testing

  • From repo root with Node 22: yarn typecheck, yarn lint:fix, yarn test (or packages/loot-core: yarn exec vitest run src/server/accounts/sync.test.ts).
  • Manual: add a rule that sets category from payee; call addTransactions with a different category; confirm the transaction keeps the API category.

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 27 12.09 MB 0%
loot-core 1 4.83 MB → 4.83 MB (+307 B) +0.01%
api 4 4.06 MB → 4.06 MB (+703 B) +0.02%
cli 1 7.88 MB 0%
View detailed bundle stats

desktop-client

Total

Files count Total bundle size % Changed
27 12.09 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
static/js/index.js 3.23 MB 0%
static/js/BackgroundImage.js 119.98 kB 0%
static/js/FormulaEditor.js 846.44 kB 0%
static/js/ReportRouter.js 1.02 MB 0%
static/js/TransactionList.js 81.29 kB 0%
static/js/ca.js 182.91 kB 0%
static/js/da.js 104.66 kB 0%
static/js/de.js 174.79 kB 0%
static/js/en-GB.js 7.16 kB 0%
static/js/en.js 170.76 kB 0%
static/js/es.js 182.09 kB 0%
static/js/fr.js 177.47 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.46 kB 0%
static/js/it.js 166.25 kB 0%
static/js/narrow.js 354.27 kB 0%
static/js/nb-NO.js 152.2 kB 0%
static/js/nl.js 108.93 kB 0%
static/js/pl.js 88.34 kB 0%
static/js/pt-BR.js 177.84 kB 0%
static/js/resize-observer.js 18.03 kB 0%
static/js/sv.js 80.58 kB 0%
static/js/th.js 179.94 kB 0%
static/js/theme.js 30.68 kB 0%
static/js/uk.js 213.14 kB 0%
static/js/useTransactionBatchActions.js 4.29 MB 0%
static/js/wide.js 418 B 0%
static/js/workbox-window.prod.es5.js 7.28 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 4.83 MB → 4.83 MB (+307 B) +0.01%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/server/accounts/sync.ts 📈 +307 B (+1.34%) 22.42 kB → 22.71 kB
View detailed bundle breakdown

Added

Asset File Size % Changed
kcab.worker.CiamsFfX.js 0 B → 4.83 MB (+4.83 MB) -

Removed

Asset File Size % Changed
kcab.worker.CwpE34S5.js 4.83 MB → 0 B (-4.83 MB) -100%

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged
No assets were unchanged


api

Total

Files count Total bundle size % Changed
4 4.06 MB → 4.06 MB (+703 B) +0.02%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/server/accounts/sync.ts 📈 +703 B (+3.11%) 22.04 kB → 22.73 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
index.js 3.84 MB → 3.84 MB (+703 B) +0.02%

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
from-Bl-Hslp4.js 167.73 kB 0%
multipart-parser-BnDysoMr.js 8.1 kB 0%
src-iMkUmuwR.js 43.64 kB 0%

cli

Total

Files count Total bundle size % Changed
1 7.88 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
cli.js 7.88 MB 0%

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/7314 **Author:** [@pranayseela](https://github.com/pranayseela) **Created:** 3/28/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `fix/7171-api-rules-explicit-fields` --- ### 📝 Commits (4) - [`285cd08`](https://github.com/actualbudget/actual/commit/285cd08efdd60a84c97544d98e463319a6b0f62a) [AI] Preserve explicit fields after rules in reconcile and addTransactions - [`00244da`](https://github.com/actualbudget/actual/commit/00244daef97df1fb53f8766ff7cbadb257240480) [AI] Add release notes and expand tests for #7171 explicit fields after rules - [`bf0366e`](https://github.com/actualbudget/actual/commit/bf0366e3c8cde375c7c4db9a58a8aae8e939173b) [AI] Name release notes file upcoming-release-notes/7314.md for CI - [`7cba413`](https://github.com/actualbudget/actual/commit/7cba41385f016cccd57404dbd4ea62e5c975fbd1) [AI] Add API tests and docs for explicit fields after rules (#7171) ### 📊 Changes **7 files changed** (+262 additions, -10 deletions) <details> <summary>View changed files</summary> 📝 `packages/api/methods.test.ts` (+92 -0) 📝 `packages/docs/docs/api/index.md` (+2 -0) 📝 `packages/docs/docs/api/reference.md` (+6 -0) 📝 `packages/docs/docs/budgeting/rules/index.md` (+2 -0) 📝 `packages/loot-core/src/server/accounts/sync.test.ts` (+118 -0) 📝 `packages/loot-core/src/server/accounts/sync.ts` (+36 -10) ➕ `upcoming-release-notes/7314.md` (+6 -0) </details> ### 📄 Description ### Summary - Introduce `mergeExplicitFieldsOntoRuleResult` and apply it after `runRules` in both `addTransactions` and `matchTransactions` (import/reconcile). - Record non-null fields on incoming rows as `explicitFields` during normalization; restore them after rules so explicit API/import values win over rule actions (#7171). - Bank sync normalized rows use `explicitFields: []` so provider data remains fully rule-processed. - Tests cover explicit category, notes, and payee on `addTransactions`, and explicit category and notes on `reconcile`. - Release notes: `upcoming-release-notes/7314.md`. <!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. --> ## Description Rules were overwriting fields that callers set when adding or importing transactions (for example, a category passed through the API). We now remember which fields were non-null before `runRules` and copy those values back onto the transaction afterward. Bank sync uses an empty `explicitFields` list so institution imports behave as before. ## Related issue(s) Fixes #7171 ## Testing - From repo root with Node 22: `yarn typecheck`, `yarn lint:fix`, `yarn test` (or `packages/loot-core`: `yarn exec vitest run src/server/accounts/sync.test.ts`). - Manual: add a rule that sets category from payee; call `addTransactions` with a different category; confirm the transaction keeps the API category. ## Checklist - [x] Release notes added (see link above) - [x] No obvious regressions in affected areas - [x] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 27 | 12.09 MB | 0% loot-core | 1 | 4.83 MB → 4.83 MB (+307 B) | +0.01% api | 4 | 4.06 MB → 4.06 MB (+703 B) | +0.02% cli | 1 | 7.88 MB | 0% <details> <summary>View detailed bundle stats</summary> #### desktop-client **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 27 | 12.09 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- static/js/index.js | 3.23 MB | 0% static/js/BackgroundImage.js | 119.98 kB | 0% static/js/FormulaEditor.js | 846.44 kB | 0% static/js/ReportRouter.js | 1.02 MB | 0% static/js/TransactionList.js | 81.29 kB | 0% static/js/ca.js | 182.91 kB | 0% static/js/da.js | 104.66 kB | 0% static/js/de.js | 174.79 kB | 0% static/js/en-GB.js | 7.16 kB | 0% static/js/en.js | 170.76 kB | 0% static/js/es.js | 182.09 kB | 0% static/js/fr.js | 177.47 kB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 13.46 kB | 0% static/js/it.js | 166.25 kB | 0% static/js/narrow.js | 354.27 kB | 0% static/js/nb-NO.js | 152.2 kB | 0% static/js/nl.js | 108.93 kB | 0% static/js/pl.js | 88.34 kB | 0% static/js/pt-BR.js | 177.84 kB | 0% static/js/resize-observer.js | 18.03 kB | 0% static/js/sv.js | 80.58 kB | 0% static/js/th.js | 179.94 kB | 0% static/js/theme.js | 30.68 kB | 0% static/js/uk.js | 213.14 kB | 0% static/js/useTransactionBatchActions.js | 4.29 MB | 0% static/js/wide.js | 418 B | 0% static/js/workbox-window.prod.es5.js | 7.28 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 4.83 MB → 4.83 MB (+307 B) | +0.01% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/server/accounts/sync.ts` | 📈 +307 B (+1.34%) | 22.42 kB → 22.71 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.CiamsFfX.js | 0 B → 4.83 MB (+4.83 MB) | - **Removed** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.CwpE34S5.js | 4.83 MB → 0 B (-4.83 MB) | -100% **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** No assets were unchanged </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 4 | 4.06 MB → 4.06 MB (+703 B) | +0.02% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `home/runner/work/actual/actual/packages/loot-core/src/server/accounts/sync.ts` | 📈 +703 B (+3.11%) | 22.04 kB → 22.73 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** Asset | File Size | % Changed ----- | --------- | --------- index.js | 3.84 MB → 3.84 MB (+703 B) | +0.02% **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- from-Bl-Hslp4.js | 167.73 kB | 0% multipart-parser-BnDysoMr.js | 8.1 kB | 0% src-iMkUmuwR.js | 43.64 kB | 0% </div> </details> --- #### cli **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 7.88 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- cli.js | 7.88 MB | 0% </div> </details> </details> <!--- bundlestats-action-comment key:combined end ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-05-01 04:12:49 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#56382