[Goals]: Handle tracking budget income categories #4300

youngcw · 2025-02-05T22:51:33Z

netlify · 2025-02-05T22:52:06Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`2354bd1`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/67a3ec1436ea5300086efcd5
😎 Deploy Preview	https://deploy-preview-4300.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 · 2025-02-05T22:52:59Z

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
16	6.79 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/workbox-window.prod.es5.js	5.69 kB	0%
static/js/en.js	99.34 kB	0%
static/js/AppliedFilters.js	10.52 kB	0%
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/useAccountPreviewTransactions.js	1.69 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/pt-BR.js	103.29 kB	0%
static/js/en-GB.js	99.33 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/de.js	78.37 kB	0%
static/js/narrow.js	84.94 kB	0%
static/js/uk.js	111.11 kB	0%
static/js/nl.js	83.87 kB	0%
static/js/wide.js	102.8 kB	0%
static/js/ReportRouter.js	1.59 MB	0%
static/js/index.js	4.29 MB	0%

github-actions · 2025-02-05T22:53:00Z

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.33 MB → 1.33 MB (+14 B)	+0.00%

Changeset

File	Δ	Size
`packages/loot-core/src/server/budget/categoryTemplate.ts`	📈 +72 B (+0.38%)	18.66 kB → 18.73 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

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

Smaller

No assets were smaller

Unchanged

No assets were unchanged

coderabbitai · 2025-02-05T22:57:40Z

Walkthrough

The pull request updates the init method of the CategoryTemplate class within the budgeting module. The modification introduces a conditional check that determines if a category is marked as income. When the category is income, the method sets the fromLastMonth value explicitly to 0, thereby preventing any carryover from the previous month. This change ensures that income categories do not include outdated balances in their budget calculations, while maintaining the overall structure of the method.

Assessment against linked issues

Objective	Addressed	Explanation
Fix income schedule templates bug by removing carryover for income categories (#4299)	✅

Possibly related PRs

[Goals] fix how goal values are calculated #3817: Alters budgeting logic in runTemplatesForPriority and applyLimit methods in the CategoryTemplate class.
[Goals] fix remainder goal #3822: Modifies the initialization of properties in the CategoryTemplate class, directly impacting budgeting computations.

Suggested labels

:sparkles: Merged

Suggested reviewers

matt-fidd

Tip

🌐 Web search-backed reviews and chat

We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
You can disable this feature by setting web_search: false in the knowledge_base settings.
Please share any feedback in the Discord discussion.

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
@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 comments (1)

packages/loot-core/src/server/budget/categoryTemplate.ts (1)
525-532: Add error handling for undefined income category.

The runPercentage method might throw an unclear runtime error if the income category is not found. Consider adding explicit error handling:
       const incomeCat = (await db.getCategories()).find(
         c => c.is_income && c.name.toLowerCase() === cat,
       );
+      if (!incomeCat) {
+        throw new Error(`Income category "${cat}" not found`);
+      }
       monthlyIncome = await getSheetValue(
         sheetName,
         `sum-amount-${incomeCat.id}`,
       );

🧹 Nitpick comments (1)

packages/loot-core/src/server/budget/categoryTemplate.ts (1)
49-50: LGTM! Consider adding a comment explaining the income category handling.

The change correctly prevents income categories from carrying over balances from previous months, which aligns with budgeting best practices.

Consider adding a comment explaining why income categories don't carry over:
    } else if (category.is_income) {
+     // Income categories don't carry over balances as they represent new income each month
      fromLastMonth = 0;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6a5de96 and 2354bd1.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: build (macos-latest)
GitHub Check: Wait for Netlify build to finish
GitHub Check: build (windows-latest)
GitHub Check: build (ubuntu-latest)

🔇 Additional comments (1)

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

131-131: Integration with existing methods looks good!

The change to set fromLastMonth = 0 for income categories integrates well with all methods that use this value. All calculations handle zero values correctly.

Also applies to: 388-388, 569-569

matt-fidd

Tested with the repro file from the issue

handle tracking income categories

6467e49

actual-github-bot bot changed the title ~~[Goals]: Handle tracking budget income categories~~ [WIP] [Goals]: Handle tracking budget income categories Feb 5, 2025

actual-github-bot bot added the 🚧 WIP label Feb 5, 2025

youngcw mentioned this pull request Feb 5, 2025

[Bug]: Income schedule templates issue w/ tracking budgets #4299

Closed

1 task

note

2354bd1

youngcw changed the title ~~[WIP] [Goals]: Handle tracking budget income categories~~ [Goals]: Handle tracking budget income categories Feb 5, 2025

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Feb 5, 2025

coderabbitai bot reviewed Feb 5, 2025

View reviewed changes

matt-fidd approved these changes Feb 5, 2025

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Feb 5, 2025

youngcw merged commit a23a285 into master Feb 6, 2025
20 checks passed

youngcw deleted the youngcw/fix-tracking-income-templates branch February 6, 2025 00:49

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Feb 6, 2025

coderabbitai bot mentioned this pull request Feb 24, 2025

Extract budget category related server handlers from main.ts to server/budget/app.ts #4442

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Goals]: Handle tracking budget income categories #4300

[Goals]: Handle tracking budget income categories #4300

youngcw commented Feb 5, 2025

netlify bot commented Feb 5, 2025 •

edited

Loading

github-actions bot commented Feb 5, 2025 •

edited

Loading

github-actions bot commented Feb 5, 2025 •

edited

Loading

coderabbitai bot commented Feb 5, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

matt-fidd left a comment

[Goals]: Handle tracking budget income categories #4300

[Goals]: Handle tracking budget income categories #4300

Conversation

youngcw commented Feb 5, 2025

netlify bot commented Feb 5, 2025 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Feb 5, 2025 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Feb 5, 2025 • edited Loading

Bundle Stats — loot-core

coderabbitai bot commented Feb 5, 2025

Walkthrough

Assessment against linked issues

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

matt-fidd left a comment

Choose a reason for hiding this comment

netlify bot commented Feb 5, 2025 •

edited

Loading

github-actions bot commented Feb 5, 2025 •

edited

Loading

github-actions bot commented Feb 5, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)