[Goals]: fix stacked templates #4120
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 |
WalkthroughThe pull request modifies the Possibly related PRs
Suggested labels
Suggested reviewers
Finishing Touches
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/categoryTemplate.ts (1)
Line range hint
1-1: Consider enabling strict TypeScript checking.The file starts with
// @ts-strict-ignore. Consider enabling strict mode to catch potential type-related issues early.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
upcoming-release-notes/4120.mdis excluded by!**/*.md
📒 Files selected for processing (1)
packages/loot-core/src/server/budget/categoryTemplate.ts(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Visual regression
- GitHub Check: Functional
- GitHub Check: build (windows-latest)
- GitHub Check: build (ubuntu-latest)
🔇 Additional comments (5)
packages/loot-core/src/server/budget/categoryTemplate.ts (5)
98-98: LGTM! Good separation of concerns.The introduction of
newBudgethelps prevent the multiple counting issue by clearly separating the calculation of individual template amounts from the accumulation of the total budget.
Line range hint
101-152: LGTM! Consistent use of newBudget across all template types.The switch statement now consistently uses
newBudgetto store template amounts, making the code more maintainable and preventing accidental multiple counting.
157-158: LGTM! Correct order of budget operations.The sequence of operations is correct:
- Update available funds
- Add to total budget
This ensures accurate tracking of both the remaining funds and the accumulated budget.
Line range hint
4-4: Add tests for multiple template scenarios.To prevent regression of the multiple counting bug, consider adding test cases that specifically verify the behavior when multiple templates exist within the same category/priority.
Let's check the current test coverage:
Would you like me to help create test cases for multiple template scenarios?
144-146: Verify the schedule template fix.The fix for schedule templates looks correct, but let's verify that this change resolves the multiple counting issue for all schedule scenarios.
Run this script to analyze schedule template usage:
✅ Verification successful
Schedule template fix is correctly implemented and comprehensive.
The fix properly prevents double counting by:
- Using scheduleFlag to track processing state
- Explicitly subtracting previous toBudget values
- Maintaining proper validation and error handling
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Find and analyze schedule template usage patterns # Look for schedule templates and their priority levels ast-grep --pattern 'type: "schedule"' | rg -A 5 'priority' # Look for potential test files fd -g '*test*.ts' -x rg -l 'schedule.*template'Length of output: 108
Script:
#!/bin/bash # Search for schedule template related code rg -l "schedule.*template" --type ts # Look for schedule implementation details rg "schedule" -A 5 -B 5 --type ts packages/loot-core/src/server/budget/ # Find test files containing schedule scenarios rg -l "describe.*schedule" --type ts packages/loot-core/src/Length of output: 34322
Script:
#!/bin/bash # Find schedule template parsing and validation rg -A 5 "template.*schedule" --type ts packages/loot-core/src/ # Look for potential edge cases in template handling rg "case 'schedule'" -B 5 -A 10 --type ts # Search for schedule-related error handling rg "throw new Error.*schedule" --type tsLength of output: 5244
| break; | ||
| } | ||
| } | ||
|
|
||
| available = available - toBudget; |
There was a problem hiding this comment.
This was the problem. The toBudget value would grow with each template line run so an early template amount would get removed from the available funds amount in every successive template.
Bug discussed here https://discord.com/channels/937901803608096828/1326945284722524170
Multiple templates in a category/priority level would double/triple/etc count the amounts requested by the early templates causing the amount check to think it had overbudgeted and remove funds.