Fix schedule split template amounts #4077

jfdoming · 2025-01-02T21:42:08Z

#2652 was accidentally reverted due to an incorrect argument type. This PR fixes the issue and adds Typescript types to attempt to prevent regressions in the future.

netlify · 2025-01-02T21:42:30Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`5184296`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/67770a944a581600081ff4a4
😎 Deploy Preview	https://deploy-preview-4077.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-01-02T21:44:07Z

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.64 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/AppliedFilters.js	10.24 kB	0%
static/js/useAccountPreviewTransactions.js	1.63 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/workbox-window.prod.es5.js	5.69 kB	0%
static/js/narrow.js	83.36 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/wide.js	104.11 kB	0%
static/js/ReportRouter.js	1.58 MB	0%
static/js/index.js	3.71 MB	0%

github-actions · 2025-01-02T21:44:08Z

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/goaltemplates.ts`	📈 +44 B (+0.57%)	7.56 kB → 7.6 kB
`packages/loot-core/src/server/budget/goalsSchedule.ts`	📈 +18 B (+0.24%)	7.45 kB → 7.47 kB
`packages/loot-core/src/server/budget/categoryTemplate.ts`	📉 -6 B (-0.03%)	18.47 kB → 18.46 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-01-02T21:45:34Z

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

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.

Walkthrough

This pull request introduces significant changes to budget-related files in the loot-core package, focusing on improving type safety and refactoring category handling. The modifications primarily affect the CategoryTemplate class, goalsSchedule functions, and goaltemplates module. The changes involve transitioning from string-based category identifiers to using full CategoryEntity objects, updating method signatures with explicit type annotations, and enhancing the overall structure of category-related operations. These updates aim to improve code clarity, type safety, and maintainability across budget calculation and template processing components.

Possibly related PRs

[Goals] fix how goal values are calculated #3817: Changes related to budgeting calculations and limit handling in the CategoryTemplate class
[Goals] fix remainder goal #3822: Modifications to CategoryTemplate class initialization and budget amount handling
[Goals] fix limits #3829: Enhancements to budget limit application within CategoryTemplate
[Goals]: fix repeating spend templates #4066: Updates to date handling for repeated spend templates
[Goals]: Fix applying templates in tracking budget #4010: Logic improvements for template application in tracking budget

Suggested labels

Merged

Suggested reviewers

youngcw
MikesGlitch

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 928260c and 07e4fab.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (4)

packages/loot-core/src/server/budget/categoryTemplate.ts (10 hunks)
packages/loot-core/src/server/budget/goalsSchedule.test.ts (2 hunks)
packages/loot-core/src/server/budget/goalsSchedule.ts (3 hunks)
packages/loot-core/src/server/budget/goaltemplates.ts (5 hunks)

🔇 Additional comments (22)

packages/loot-core/src/server/budget/goaltemplates.ts (5)

4-4: Good introduction of CategoryEntity import.
Helps maintain type safety and clarity by explicitly referencing the model type.

50-50: Great explicit return type on getCategories().
This clarifies the expected data and increases maintainability.

154-155: Clean destructuring for category object.
In addition to improving readability, this ensures consistent usage of the category object if more properties are needed in the future.

167-167: Excellent use of the updated CategoryTemplate.init().
Passing the entire category object rather than the ID alone fosters better type safety and improves clarity about which properties are used.

235-237: Consistent usage of category.id in the budgetList and goalList.
Using the destructured category object throughout the codebase standardizes the approach and helps prevent ID mismatches.

packages/loot-core/src/server/budget/goalsSchedule.ts (5)

4-4: Approved new import of CategoryEntity.
This maintains uniform data definitions throughout.

13-13: Good addition of ScheduleTemplate and Template interfaces.
Expanding the codebase with these type definitions is a solid step toward improved readability and maintainability.

15-19: Enhanced type annotations for createScheduleList().
Enhancing type definitions prevents ambiguous usage and clarifies the function’s parameters.

195-203: Comprehensive typed signature for goalsSchedule().
Explicit parameter definitions help with code clarity and reduce the risk of runtime errors.

207-214: Appropriate filtering and passing of schedule templates in goalsSchedule().
Using template_lines.filter(t => t.type === 'schedule') is concise, and passing them to createScheduleList with the typed category fosters consistency.

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

5-5: Consistent import of CategoryEntity.
Improves code reuse across modules.

33-33: Changed init signature to accept CategoryEntity.
This is a good practice that promotes data consistency and clearer usage.

40-44: Referencing leftover and carryover using category.id.
Aligns perfectly with the updated signature and ensures relevant data is correctly mapped.

56-56: Private constructor call with CategoryEntity.
Creates a more robust foundation for category-based logic and data validation.

130-130: Consistent usage of this.category.id in leftover lookups.
Strengthens the object-oriented approach and fosters better maintainability.

141-141: Passing this.category to goalsSchedule().
Ensures that scheduling logic has access to the full category details, not just the ID.

207-207: Introducing readonly category: CategoryEntity.
Makes the class both strongly typed and less prone to accidental reassignments.

227-231: Refactored constructor to store the CategoryEntity.
Provides clarity to all subsequent methods concerning which category is in scope and encourages cohesive design.

428-428: Replacing references to budget with this.category.id.
Continues the pattern of referencing the entire object for more consistent data management.

476-480: Handling sums, leftovers, and budgets with this.category.id.
Streamlines the codebase by consistently applying object-based references, mitigating ID errors.

Also applies to: 487-487, 540-540

packages/loot-core/src/server/budget/goalsSchedule.test.ts (2)

25-31: Accurate test setup for schedule lines and category object.
Incorporating directive supports the new approach to typed templates, and matching the category structure aligns with the updated code.

Also applies to: 38-38

95-101: Fixing category ID type in test to a string.
This ensures the test aligns with the main code’s expectation of string-based IDs, avoiding confusion.

Also applies to: 108-108

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.

youngcw

Looks good. Thanks for fixing my bug

jfdoming · 2025-01-02T23:01:11Z

Looks good. Thanks for fixing my bug

Team effort! The classes made this way easier 😅

youngcw · 2025-01-02T23:06:16Z

Looks good. Thanks for fixing my bug

Team effort! The classes made this way easier 😅

That was the hope. That any future additions didn't have to dig through every step just to figure out one small change.

jfdoming added 2 commits January 2, 2025 16:41

Fix incorrect argument to goals schedule function

2dcf2ea

Add argument types to prevent similar issues

7e58775

actual-github-bot bot added the 🚧 WIP label Jan 2, 2025

Add release notes

c4d5822

jfdoming marked this pull request as ready for review January 2, 2025 21:43

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

Fix test types

07e4fab

jfdoming added this to the v25.1.0 milestone Jan 2, 2025

jfdoming requested a review from youngcw January 2, 2025 21:50

Merge branch 'master' into jfdoming/fix-schedule-split-template-amounts

5184296

youngcw approved these changes Jan 2, 2025

View reviewed changes

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

jfdoming merged commit 832fd1e into actualbudget:master Jan 2, 2025
20 checks passed

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Jan 2, 2025

jfdoming deleted the jfdoming/fix-schedule-split-template-amounts branch January 2, 2025 23:01

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

Fix schedule split template amounts #4077

Fix schedule split template amounts #4077

jfdoming commented Jan 2, 2025

netlify bot commented Jan 2, 2025 •

edited

Loading

github-actions bot commented Jan 2, 2025 •

edited

Loading

github-actions bot commented Jan 2, 2025 •

edited

Loading

coderabbitai bot commented Jan 2, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

youngcw left a comment

jfdoming commented Jan 2, 2025

youngcw commented Jan 2, 2025

Fix schedule split template amounts #4077

Fix schedule split template amounts #4077

Conversation

jfdoming commented Jan 2, 2025

netlify bot commented Jan 2, 2025 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Jan 2, 2025 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Jan 2, 2025 • edited Loading

Bundle Stats — loot-core

coderabbitai bot commented Jan 2, 2025 • 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

youngcw left a comment

Choose a reason for hiding this comment

jfdoming commented Jan 2, 2025

youngcw commented Jan 2, 2025

netlify bot commented Jan 2, 2025 •

edited

Loading

github-actions bot commented Jan 2, 2025 •

edited

Loading

github-actions bot commented Jan 2, 2025 •

edited

Loading

coderabbitai bot commented Jan 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)