enhance: allow negatives in the budget template #4028
Conversation
actual-github-bot
bot
changed the title
✅ Deploy Preview for actualbudget ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Bundle Stats — desktop-clientHey 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
Changeset No files were changed View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
Bundle Stats — loot-coreHey 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
Changeset
View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger
Smaller No assets were smaller Unchanged No assets were unchanged |
UnderKoen
changed the title
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
packages/loot-core/src/server/budget/template-notes.test.tsOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the plugin "eslint-plugin-eslint-plugin". (The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".) It's likely that the plugin isn't installed correctly. Try reinstalling by running the following: The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js". If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team. WalkthroughThe pull request introduces changes to the budget template parsing grammar and adds a corresponding test case. In the Possibly related PRs
Suggested labels
Suggested reviewers
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/loot-core/src/server/budget/template-notes.test.ts (1)
56-75: Excellent addition of negative test coverage—consider edge cases.This new test scenario effectively verifies that negative values (e.g., “-103.23”) are stored correctly. Consider adding boundary tests to confirm correct handling of large negative amounts or values like “-0.01.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
upcoming-release-notes/4028.mdis excluded by!**/*.md
📒 Files selected for processing (2)
packages/loot-core/src/server/budget/goal-template.pegjs(1 hunks)packages/loot-core/src/server/budget/template-notes.test.ts(1 hunks)
🧰 Additional context used
📓 Learnings (1)
packages/loot-core/src/server/budget/goal-template.pegjs (2)
Learnt from: youngcw
PR: actualbudget/actual#3754
File: packages/loot-core/src/server/budget/goal-template.pegjs:38-43
Timestamp: 2024-11-10T16:45:25.627Z
Learning: Validations for limit rules, such as checking start date validity and ensuring amounts are positive, are performed during template processing, not in the parser defined in `goal-template.pegjs`.
Learnt from: youngcw
PR: actualbudget/actual#3754
File: packages/loot-core/src/server/budget/goal-template.pegjs:38-43
Timestamp: 2024-11-10T16:45:25.627Z
Learning: In `packages/loot-core/src/server/budget/goal-template.pegjs`, within the `limit` rule, the optional space `_?` is always placed before the `hold` option, ensuring consistency.
🔇 Additional comments (1)
packages/loot-core/src/server/budget/goal-template.pegjs (1)
73-73: Allowing negative amounts is now supported—please confirm no conflicts with downstream code.
The grammar update for the “amount” rule now parses an optional '-' sign. Since prior validations for positivity were performed outside the parser (as noted in previous learnings), this change is consistent. Ensure that any business rules expecting only positive amounts are updated if needed.
✅ Verification successful
Let me search for any code that might be affected by allowing negative amounts in the grammar.
Let me also check for any direct usage of the goal template parser:
And let's look for any test files that might give us insights into the expected behavior:
Let's examine the test files and the app.ts that uses the goal template parser to understand how amounts are handled:
Let's check the goal templates implementation and actions to see how amounts are processed:
Based on the code review, I can now provide a final response:
Support for negative amounts in the grammar is safe and consistent with existing code
The codebase already handles negative amounts throughout the budget system:
- Test cases explicitly verify negative template amounts (e.g.,
#template -103.23in template-notes.test.ts) - The goalsSchedule.test.ts shows negative amounts being processed (
amount: -10000, -12000) - The actions.ts contains logic that works with both positive and negative amounts, including proper sign handling for income vs. expense categories
- No explicit validation restricting amounts to positive values was found
🏁 Scripts executed
The following scripts were executed for the analysis:
Error: No shell scripts found
Script:
#!/bin/bash
# Search for references to amount validation or processing in the budget-related code
rg -l "amount" --type js packages/loot-core/src/server/budget/
# Look for potential validation logic
rg "amount.*[<>]=?\s*0|amount.*positive|validateAmount" packages/loot-core/src/server/budget/
Length of output: 283
Script:
# Find files that import or use the goal template parser
rg -l "goal-template|goalTemplate" packages/loot-core/src/
Length of output: 359
Script:
# Search for test files related to goals or amounts
fd ".*\.(test|spec)\.(js|ts)" packages/loot-core/src/server/budget/
Length of output: 238
Script:
#!/bin/bash
# Check the test files for amount-related test cases
cat packages/loot-core/src/server/budget/goalsSchedule.test.ts
cat packages/loot-core/src/server/budget/template-notes.test.ts
# Look at the main application code that uses the parser
cat packages/loot-core/src/server/budget/app.ts
# Check for any validation or processing of amounts
ast-grep --pattern 'function $FUNC($_) {
$$$
amount
$$$
}'
Length of output: 12297
Script:
#!/bin/bash
# Check the goal templates implementation
cat packages/loot-core/src/server/budget/goaltemplates.ts
# Look for amount validation in actions
cat packages/loot-core/src/server/budget/actions.ts
# Check if there are any amount-related validations in the handlers
rg -A 5 "amount.*validate|validateAmount" packages/loot-core/src/server/budget/
Length of output: 20494
|
Ive tested with my test budget and this doesn't seem to have broken any existing things which is good. I also ran some tests and so far they all work fine in the new cases. |
|
Since this is for an experimental feature and small I cleared this for merge. |
Allow the budget template
#template -20