[Goals] fix how goal values are calculated #3817

youngcw · 2024-11-10T23:27:38Z

I had messed up how the template goal values were calculated in the recent rewrite.

I had to change the following:

add a variable to track what the full template amount is compared to the amount that will be budgeted.
Remove the breaks on negative available. That stopped the templates running early and calculating the full goal as was requested by the templates. I was trying to be efficient, but all the processing is needed and I should have realized that.

netlify · 2024-11-10T23:27:52Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`3e3d85d`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/6731424842f0f3000848a546
😎 Deploy Preview	https://deploy-preview-3817.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 · 2024-11-10T23:28:56Z

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
10	5.34 MB → 5.34 MB (-101 B)	-0.00%

Changeset

File	Δ	Size
`node_modules/clsx/dist/clsx.mjs`	🆕 +368 B	0 B → 368 B
`node_modules/clsx/dist/clsx.mjs?commonjs-proxy`	🆕 +64 B	0 B → 64 B
`node_modules/react-grid-layout/build/components/WidthProvider.js`	📈 +1 B (+0.02%)	5.22 kB → 5.22 kB
`node_modules/react-grid-layout/build/GridItem.js`	📈 +1 B (+0.00%)	21.49 kB → 21.49 kB
`node_modules/react-grid-layout/build/ReactGridLayout.js`	📈 +1 B (+0.00%)	24.96 kB → 24.96 kB
`node_modules/clsx/dist/clsx.js`	🔥 -509 B (-100%)	509 B → 0 B
`node_modules/clsx/dist/clsx.js?commonjs-module`	🔥 -27 B (-100%)	27 B → 0 B

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
static/js/ReportRouter.js	1.5 MB → 1.5 MB (+67 B)	+0.00%

Smaller

Asset	File Size	% Changed
static/js/index.js	3.35 MB → 3.35 MB (-168 B)	-0.00%

Unchanged

Asset	File Size	% Changed
static/js/workbox-window.prod.es5.js	5.69 kB	0%
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/AppliedFilters.js	21.3 kB	0%
static/js/usePreviewTransactions.js	1.64 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/narrow.js	82.57 kB	0%
static/js/wide.js	239.81 kB	0%

github-actions · 2024-11-10T23:28:57Z

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/budget/categoryTemplate.ts`	📈 +162 B (+0.92%)	17.2 kB → 17.36 kB
`packages/loot-core/src/server/budget/goaltemplates.ts`	📉 -111 B (-1.41%)	7.71 kB → 7.6 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 · 2024-11-10T23:33:28Z

Walkthrough

The pull request introduces significant modifications to the budgeting logic within the CategoryTemplate class in categoryTemplate.ts and the processTemplate function in goaltemplates.ts. In categoryTemplate.ts, the runTemplatesForPriority method has been updated to enhance how budgets are calculated when the available budget is negative, allowing for a more nuanced adjustment of budgeted amounts. The applyLimit method now resets fullAmount to zero upon reaching the limit and adjusts it to toBudgetAmount when exceeded. Additionally, the runGoal method has been revised to set goalAmount to fullAmount. In goaltemplates.ts, the processTemplate function has had conditional checks removed, allowing processing to continue even when the available budget is exhausted. These changes aim to improve the control flow and error handling in budget calculations and limit applications, with an emphasis on accurate tracking of budgeted amounts.

Possibly related PRs

Add goal info to the prewarm list #3514: Changes in goaltemplates.ts regarding budget processing logic may relate to the overall budgeting calculations and limits discussed in the main PR, as both involve budget management and template application.
[Goals]: fix no messages #1507 #3721: Modifications to the applyBudgetAction function in queries.ts for handling notifications after applying goal templates could be relevant, as they both deal with the application of templates and budget management.

Suggested labels

::sparkles: Merged

Suggested reviewers

joel-jeremy

Warning

There were issues while running the following tools:

🔧 eslint

packages/loot-core/src/server/budget/categoryTemplate.ts

Oops! 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:

npm install eslint-plugin-eslint-plugin@latest --save-dev

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.

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

🪧 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.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

packages/loot-core/src/server/budget/categoryTemplate.ts (3)

140-148: Consider adding comments to clarify the use of fullAmount

In the runTemplatesForPriority method, this.fullAmount is updated with toBudget before any adjustment is made to toBudget in the if block (lines 142–143). This suggests that fullAmount represents the total requested amount before any budget adjustments. To improve code readability, please add comments to clarify this logic.

158-160: Review the reset of fullAmount in applyLimit

When the limit hold condition is met and the limit amount has been reached, this.fullAmount is reset to zero (line 158). Since fullAmount tracks the total requested amount, resetting it to zero may affect the accuracy of goal calculations. Please verify that this behavior aligns with the intended functionality.

165-165: Confirm the assignment of fullAmount after applying limit

At line 165, this.fullAmount is assigned the value of this.toBudgetAmount after adjusting toBudgetAmount due to exceeding the limit. Since fullAmount is intended to represent the total requested amount before limits are applied, consider whether this assignment accurately reflects the desired behavior.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2b72b2f and 3e3d85d.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (2)

packages/loot-core/src/server/budget/categoryTemplate.ts (4 hunks)
packages/loot-core/src/server/budget/goaltemplates.ts (0 hunks)

💤 Files with no reviewable changes (1)

packages/loot-core/src/server/budget/goaltemplates.ts

🔇 Additional comments (1)

packages/loot-core/src/server/budget/categoryTemplate.ts (1)

271-271: Use fullAmount for goalAmount to reflect total requested amount

By setting this.goalAmount = this.fullAmount; at line 271, the goal now represents the total requested amount before any budget adjustments. This change aligns with the intent to accurately track goal values.

deathblade666 · 2024-11-10T23:42:54Z

seems when using priority it doesnt calculate properly on a non up to template. example below

when setting the template to #template-1 150 repeat every week starting 2024-11-01 the goal amount is set as the current budgeted amount, if you add a currency denominator it says the goal is 0 and that its overbudgeted if you allocate funds. seems to work fine without the priority

youngcw · 2024-11-10T23:47:02Z

seems when using priority it doesnt calculate properly on a non up to template. example below

when setting the template to #template-1 150 repeat every week starting 2024-11-01 the goal amount is set as the current budgeted amount, if you add a currency denominator it says the goal is 0 and that its overbudgeted if you allocate funds. seems to work fine without the priority

@deathblade666 Im seeing 750 as the goal amount no matter the priority, or if I include $ or not.

deathblade666 · 2024-11-10T23:51:16Z

seems when using priority it doesnt calculate properly on a non up to template. example below
when setting the template to #template-1 150 repeat every week starting 2024-11-01 the goal amount is set as the current budgeted amount, if you add a currency denominator it says the goal is 0 and that its overbudgeted if you allocate funds. seems to work fine without the priority

@deathblade666 Im seeing 750 as the goal amount no matter the priority, or if I include $ or not.

maybe im not understanding correctly then, this is what im seeing with the priority. i would expect the goal to indicate the total amount to be budgeted per the template. if thats not how it works then i've missunderstood. To be clear this is on my personal instance not the build associated with this PR

youngcw · 2024-11-10T23:54:33Z

@deathblade666 and that is using exactly the template you stated above? Are you sure you are using the PR build? I copied your template example directly into a test budget and always got 750 as the goal.

deathblade666 · 2024-11-10T23:55:48Z

@youngcw that screenshot was from my personal instance, testing the PR build now

deathblade666 · 2024-11-10T23:57:12Z

yep appears to be good in the PR build

matt-fidd

LGTM, tested with the method reported on Discord

fix how goals are calculated

e2cf718

actual-github-bot bot changed the title ~~[Goals] fix how goal values are calculated~~ [WIP] [Goals] fix how goal values are calculated Nov 10, 2024

actual-github-bot bot added the 🚧 WIP label Nov 10, 2024

youngcw changed the title ~~[WIP] [Goals] fix how goal values are calculated~~ [Goals] fix how goal values are calculated Nov 10, 2024

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Nov 10, 2024

youngcw added 2 commits November 10, 2024 16:30

lint, note

4eec410

note

3e3d85d

coderabbitai bot reviewed Nov 10, 2024

View reviewed changes

matt-fidd approved these changes Nov 11, 2024

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Nov 11, 2024

youngcw merged commit 57ac062 into master Nov 11, 2024
20 checks passed

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Nov 11, 2024

youngcw deleted the youngcw/fix-template-goals branch November 11, 2024 14:46

This was referenced Nov 11, 2024

[Goals] fix remainder goal #3822

Merged

[Goals] fix limits #3829

Merged

🐛 Fix translations failing #3830

Merged

coderabbitai bot mentioned this pull request Dec 19, 2024

[Goals]: Fix applying templates in tracking budget #4010

Merged

coderabbitai bot mentioned this pull request Dec 23, 2024

enhance: allow negatives in the budget template #4028

Merged

This was referenced Jan 1, 2025

[Goals]: fix repeating spend templates #4066

Merged

Fix schedule split template amounts #4077

Merged

coderabbitai bot mentioned this pull request Jan 9, 2025

[Goals]: fix stacked templates #4120

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Goals] fix how goal values are calculated #3817

[Goals] fix how goal values are calculated #3817

youngcw commented Nov 10, 2024

netlify bot commented Nov 10, 2024 •

edited

Loading

github-actions bot commented Nov 10, 2024 •

edited

Loading

github-actions bot commented Nov 10, 2024 •

edited

Loading

coderabbitai bot commented Nov 10, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

deathblade666 commented Nov 10, 2024

youngcw commented Nov 10, 2024 •

edited

Loading

deathblade666 commented Nov 10, 2024 •

edited

Loading

youngcw commented Nov 10, 2024

deathblade666 commented Nov 10, 2024

deathblade666 commented Nov 10, 2024

matt-fidd left a comment

[Goals] fix how goal values are calculated #3817

[Goals] fix how goal values are calculated #3817

Conversation

youngcw commented Nov 10, 2024

netlify bot commented Nov 10, 2024 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Nov 10, 2024 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Nov 10, 2024 • edited Loading

Bundle Stats — loot-core

coderabbitai bot commented Nov 10, 2024 • edited Loading

Walkthrough

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

deathblade666 commented Nov 10, 2024

youngcw commented Nov 10, 2024 • edited Loading

deathblade666 commented Nov 10, 2024 • edited Loading

youngcw commented Nov 10, 2024

deathblade666 commented Nov 10, 2024

deathblade666 commented Nov 10, 2024

matt-fidd left a comment

Choose a reason for hiding this comment

netlify bot commented Nov 10, 2024 •

edited

Loading

github-actions bot commented Nov 10, 2024 •

edited

Loading

github-actions bot commented Nov 10, 2024 •

edited

Loading

coderabbitai bot commented Nov 10, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

youngcw commented Nov 10, 2024 •

edited

Loading

deathblade666 commented Nov 10, 2024 •

edited

Loading