fix: change payee rule not working #3702

[UnderKoen]

No description provided.

[netlify]

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	5e5020e
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/6717e64c364c6c00082d234e
😎 Deploy Preview	https://deploy-preview-3704.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[github-actions]

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
9	5.32 MB	0%

Changeset

No files were changed

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/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/narrow.js	82.57 kB	0%
static/js/usePreviewTransactions.js	1.64 kB	0%
static/js/AppliedFilters.js	21.3 kB	0%
static/js/wide.js	232.12 kB	0%
static/js/ReportRouter.js	1.51 MB	0%
static/js/index.js	3.33 MB	0%

[github-actions]

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
1	1.27 MB → 1.27 MB (+63 B)	+0.00%

Changeset

File	Δ	Size
packages/loot-core/src/server/accounts/rules.ts	📈 +114 B (+0.35%)	31.75 kB → 31.86 kB
packages/loot-core/src/server/accounts/transaction-rules.ts	📈 +83 B (+0.28%)	28.97 kB → 29.05 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
kcab.worker.js	1.27 MB → 1.27 MB (+63 B)	+0.00%

Smaller

No assets were smaller

Unchanged

No assets were unchanged

[coderabbitai]

Walkthrough

This pull request introduces modifications to two files within the packages/loot-core/src/server/accounts directory: rules.ts and transaction-rules.ts. In rules.ts, the exec method of the Action class is updated to include a new conditional block that sets the payee property of an object to the string 'new' when the field is 'payee_name'. This change affects how actions related to the payee_name field are executed. In transaction-rules.ts, the finalizeTransactionForRules function is modified to alter the logic for setting the payee property of a transaction. The new logic checks if trans.payee equals 'new' and, if so, evaluates the trans.payee_name to either retrieve an existing payee ID or insert a new payee. If trans.payee_name is not defined, trans.payee is set to null. Minor formatting adjustments, such as the addition of a newline, are also included but do not impact functionality.

Possibly related PRs

• refactor: fill in basic types in rules.ts #3365: Modifies the rules.ts file, enhancing type safety and structure in the same file as the main PR.
• feat: templating on payee_name #3619: Adds functionality related to the payee_name in rules.ts, relevant to the new logic in the exec method.
• recalculateSplit one last time to clear any erroneous errors #3624: Modifies the execActions function in rules.ts, closely related to the changes in the exec method of the Action class.
• Clarify logic to generate splits from rules #3641: Enhances transaction handling in rules.ts, relevant to the changes regarding payee_name handling in the main PR.

Suggested labels

sparkles: Merged

Suggested reviewers

• MikesGlitch
• youngcw

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 715bc00 and a99952b.

⛔ Files ignored due to path filters (1)

• upcoming-release-notes/3704.md is excluded by !**/*.md

📒 Files selected for processing (2)

• packages/loot-core/src/server/accounts/rules.ts (1 hunks)
• packages/loot-core/src/server/accounts/transaction-rules.ts (1 hunks)

🧰 Additional context used

📓 Learnings (1)

packages/loot-core/src/server/accounts/transaction-rules.ts (2)

Learnt from: UnderKoen
PR: actualbudget/actual#3619
File: packages/loot-core/src/server/accounts/transaction-rules.ts:795-801
Timestamp: 2024-10-09T20:30:39.127Z
Learning: In the `finalizeTransactionForRules` function within `packages/loot-core/src/server/accounts/transaction-rules.ts`, potential race conditions when inserting payees are handled in the method that calls this function, so additional safeguards within `finalizeTransactionForRules` are unnecessary.

Learnt from: UnderKoen
PR: actualbudget/actual#3619
File: packages/loot-core/src/server/accounts/transaction-rules.ts:551-0
Timestamp: 2024-10-09T20:17:46.493Z
Learning: When finalizing transactions that involve inserting or retrieving payees, avoid using `Promise.all` as it may result in duplicate payees due to concurrent operations. Sequential processing ensures payees are correctly handled without duplication.

🔇 Additional comments (2)

packages/loot-core/src/server/accounts/transaction-rules.ts (1)

795-805: LGTM! New payee handling logic looks good.

The changes introduce a clear and concise way to handle new payees:

1. It checks if trans.payee is set to 'new'.
2. If trans.payee_name is provided, it either retrieves an existing payee or inserts a new one.
3. If trans.payee_name is not provided, it sets trans.payee to null.

This approach ensures that new payees are correctly processed and set in the transaction.

packages/loot-core/src/server/accounts/rules.ts (1)

628-631: Consider updating related code for consistency

The addition of this code block is a good step towards handling the payee_name field correctly. However, there are a few points to consider:

1. This change sets the payee field to 'new' when payee_name is set, which aligns with the changes made in the finalizeTransactionForRules function (as mentioned in the AI summary for another file).

2. It's worth noting that this change might have implications for other parts of the codebase that deal with payee-related logic. Ensure that this new behavior is consistent with the overall payee handling strategy.

3. The string 'new' is used as a magic value. Consider defining this as a constant at the module level for better maintainability.

To ensure consistency across the codebase, let's check for other occurrences of payee-related logic:

✅ Verification successful

Verified payee-related logic consistency

Only two instances found where payee is set to 'new'. No additional inconsistencies detected.

Consider defining 'NEW_PAYEE_VALUE' as a constant for better maintainability.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for payee-related logic in the codebase
rg -i "payee.*=.*['\"](new|null)" --type ts

Length of output: 223

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[youngcw]

hook test

[youngcw]

test again

[youngcw]

test again

[matt-fidd]

Thanks for this!