Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Dec 22, 2024

Conversation

youngcw
Copy link
Member

@youngcw youngcw commented Dec 19, 2024

my logic was wrong and made templates not apply to the tracking budget. Fixes #4006

To test:
Add any template to a tracking budget and try to apply it. It won't do anything in current edge.

@actual-github-bot actual-github-bot bot changed the title [Goals]: Fix applying templates in tracking budget [WIP] [Goals]: Fix applying templates in tracking budget Dec 19, 2024
Copy link

netlify bot commented Dec 19, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit c0ff80c
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/676377a031aacc0008da7191
😎 Deploy Preview https://deploy-preview-4010.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

github-actions bot commented Dec 19, 2024

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.53 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/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/narrow.js 83.36 kB 0%
static/js/TransactionList.js 102.91 kB 0%
static/js/wide.js 161.25 kB 0%
static/js/ReportRouter.js 1.58 MB 0%
static/js/index.js 3.45 MB 0%

Copy link
Contributor

github-actions bot commented Dec 19, 2024

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.32 MB → 1.32 MB (+3 B) +0.00%
Changeset
File Δ Size
packages/loot-core/src/server/budget/goaltemplates.ts 📉 -1 B (-0.01%) 7.56 kB → 7.56 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

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

Smaller

No assets were smaller

Unchanged

No assets were unchanged

@youngcw youngcw changed the title [WIP] [Goals]: Fix applying templates in tracking budget [Goals]: Fix applying templates in tracking budget Dec 19, 2024
Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

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/goaltemplates.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

The pull request introduces a modification to the processTemplate function in the goaltemplates.ts file, specifically altering the conditional logic for processing budget categories. The original condition !isReflect && !c.is_income has been changed to isReflect || !c.is_income. This modification expands the criteria for category selection during template processing.

The new condition allows categories to be included in the template processing under two scenarios: when isReflect is true, or when the category is not an income category. This change broadens the scope of categories that can be processed, potentially affecting how budget templates are applied and interpreted.

The modification is focused solely on the internal logic of the processTemplate function, with no changes to function signatures or other method implementations. The alteration suggests a more inclusive approach to category selection in budget template processing.

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • matt-fidd

📜 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 4ce5e2f and c0ff80c.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4010.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/loot-core/src/server/budget/goaltemplates.ts (1 hunks)
🔇 Additional comments (2)
packages/loot-core/src/server/budget/goaltemplates.ts (2)

133-133: Logical fix for template processing in tracking budgets

The condition change from !isReflect && !c.is_income to isReflect || !c.is_income correctly fixes the template application in tracking budgets. Now:

  • For tracking budgets (isReflect = true): all categories are included
  • For regular budgets (isReflect = false): only non-income categories are included

133-133: Verify impact on both budget types

While the logic change looks correct, let's verify the behavior for both tracking and regular budgets.

✅ Verification successful

Based on the results from our verification scripts, I can now provide a final response:

Logic change is correctly handling both budget types

The code change is verified to be correct for both tracking (reflect) and regular budgets. The evidence shows:

  • The isReflectBudget() function properly checks the budget type from preferences
  • The condition isReflect || !c.is_income is consistently used across the codebase for handling income categories
  • The implementation correctly uses separate tables (reflect_budgets/zero_budgets) based on the budget type
  • Income categories are properly excluded for regular budgets but included for reflect budgets
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Analyze usage of isReflect across the codebase to understand the full impact

# Check how isReflectBudget is used in other files
echo "Checking isReflectBudget usage:"
rg "isReflectBudget" -A 5

# Look for other budget type checks that might be affected
echo "\nChecking for related budget type conditions:"
rg "is_income.*isReflect|isReflect.*is_income"

# Check for any tests related to this functionality
echo "\nChecking for related tests:"
fd -e test.ts -e test.js -x rg -l "isReflect|tracking.?budget"

Length of output: 6655


Script:

#!/bin/bash
# Let's analyze the test coverage for both budget types

# Check for test cases related to budget types
echo "Checking test cases for budget types:"
rg -A 10 "describe.*budget.*type" packages/loot-core/src/server/budget/

# Look for test assertions involving isReflect and is_income
echo "\nChecking test assertions for budget behavior:"
rg "expect.*isReflect|expect.*is_income" packages/loot-core/src/server/budget/

# Check implementation of budget type switching
echo "\nChecking budget type implementation:"
ast-grep --pattern 'function $FUNC($$$) {
  $$$
  budgetType
  $$$
}'

Length of output: 503


Script:

#!/bin/bash
# Let's analyze the actual implementation and tests more thoroughly

# Check how budget types affect category handling
echo "Checking category handling with budget types:"
rg -A 5 "budgetType.*reflect|reflect.*budget" packages/loot-core/src/server/budget/

# Look for test files specifically testing goaltemplates
echo "\nChecking goaltemplates tests:"
fd "goaltemplates.test" -x cat {}

# Check for any budget type related migrations or schema
echo "\nChecking budget type in schema and migrations:"
rg "budgetType|reflect.*budget" packages/loot-core/src/server/db/

Length of output: 1517


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.

@youngcw youngcw added this to the v25.1.0 milestone Dec 19, 2024
@youngcw youngcw merged commit cde81da into master Dec 22, 2024
20 checks passed
@youngcw youngcw deleted the youngcw/fix-tracking-templates branch December 22, 2024 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Overwrite/Apply Budget Template Not Working
2 participants