fix: helpers with empty or undefined values #4356

UnderKoen · 2025-02-11T19:19:07Z

To check if the template is correct we do an compile with empty context so all helpers should work with empty fields

netlify · 2025-02-11T19:19:33Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`afb2d59`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/67aba3ddfef2ab0008c3791b
😎 Deploy Preview	https://deploy-preview-4356.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-11T19:20:46Z

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.84 MB → 6.84 MB (-224 B)	-0.00%

Changeset

File	Δ	Size
`home/runner/work/actual/actual/packages/loot-core/src/server/accounts/rules.ts`	📈 +13 B (+0.09%)	13.74 kB → 13.75 kB
`node_modules/define-data-property/index.js`	📉 -9 B (-0.39%)	2.25 kB → 2.24 kB
`node_modules/call-bind/index.js`	📉 -9 B (-0.84%)	1.05 kB → 1.04 kB
`node_modules/has-property-descriptors/index.js`	📉 -9 B (-1.55%)	582 B → 573 B
`node_modules/es-define-property/index.js`	📉 -210 B (-37.50%)	560 B → 350 B

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

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

Unchanged

Asset	File Size	% Changed
static/js/nl.js	94.83 kB	0%
static/js/en.js	99.43 kB	0%
static/js/de.js	110.85 kB	0%
static/js/en-GB.js	99.33 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
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/uk.js	111.11 kB	0%
static/js/pt-BR.js	106.43 kB	0%
static/js/AppliedFilters.js	10.52 kB	0%
static/js/useAccountPreviewTransactions.js	1.69 kB	0%
static/js/narrow.js	85.08 kB	0%
static/js/wide.js	102.8 kB	0%
static/js/ReportRouter.js	1.59 MB	0%

github-actions · 2025-02-11T19:20:47Z

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 (-3 B)	-0.00%

Changeset

File	Δ	Size
`packages/loot-core/src/server/accounts/rules.ts`	📈 +18 B (+0.05%)	34.56 kB → 34.58 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

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

Unchanged

No assets were unchanged

coderabbitai · 2025-02-11T19:24:38Z

Walkthrough

This pull request introduces additional test cases for date helper functions within the rules.test.ts file. The new tests validate that functions such as {{day}}, {{month}}, {{year}}, and others return an empty string when invoked without arguments. Existing tests for the setDay function are maintained to check correct date adjustments. In addition, modifications in the main code (rules.ts) adjust the error handling in Handlebars helpers. The changes include retaining all arguments passed into mathHelper and enhancing conditional checks in date manipulation functions (e.g., addDays, subDays, addMonths, and others) to ensure that both the date and numeric parameter are defined before proceeding. The helper for concatenation has been simplified, and comments have been added to clarify the handling of the options object.

Possibly related PRs

enhance: add more action rule templating helpers #4243: Modifies and enhances date manipulation functions (e.g., addDays, subDays, etc.), which directly relates to the changes here.
fix: date handlebar functions #3749: Focuses on tests and enhancements for date helper functions, aligning with the improvements made to handle undefined inputs in this PR.

Suggested labels

sparkles: Merged

Suggested reviewers

youngcw

📜 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 679b94a and afb2d59.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (2)

packages/loot-core/src/server/accounts/rules.test.ts (1 hunks)
packages/loot-core/src/server/accounts/rules.ts (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

packages/loot-core/src/server/accounts/rules.test.ts (1)

Learnt from: jfdoming
PR: actualbudget/actual#3641
File: packages/loot-core/src/server/accounts/rules.test.ts:524-536
Timestamp: 2024-11-10T16:45:25.627Z
Learning: In `packages/loot-core/src/server/accounts/rules.test.ts`, prefer explicit action definitions over refactoring similar actions into loops or helper functions, even when actions are similar.

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

GitHub Check: Functional
GitHub Check: Visual regression
GitHub Check: build (windows-latest)
GitHub Check: build (ubuntu-latest)

🔇 Additional comments (6)

packages/loot-core/src/server/accounts/rules.ts (3)

111-113: LGTM! Improved error handling for date helper functions.

The changes enhance robustness by checking both the date and numeric parameters before performing operations. This aligns with the PR objectives by ensuring proper handling of empty or undefined values.

Also applies to: 115-117, 119-121, 123-125, 127-129, 131-133, 135-137, 139-141

151-151: LGTM! Simplified concat helper implementation.

The concat helper now uses a straightforward join operation, which inherently handles empty or undefined values through JavaScript's type coercion.

154-158: LGTM! Clear handling of Handlebars options object.

The comment clarifies that the last argument is the Handlebars options object, improving code readability and maintainability.

packages/loot-core/src/server/accounts/rules.test.ts (3)

429-432: LGTM! Added test coverage for empty date helper inputs.

New test cases verify that {{day}}, {{month}}, and {{year}} return an empty string when called without arguments, improving test coverage for edge cases.

433-434: LGTM! Added test coverage for empty format helper input.

New test case verifies that {{format}} returns an empty string when called without arguments.

435-450: LGTM! Added test coverage for empty date manipulation helper inputs.

New test cases verify that all date manipulation helpers (addDays, subDays, addMonths, subMonths, addYears, subYears, addWeeks, subWeeks, setDay) return an empty string when called without arguments.

Also applies to: 453-453

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

matt-fidd

LGTM

fix: helpers with empty or undefined values

ebc9fe3

actual-github-bot bot changed the title ~~fix: helpers with empty or undefined values~~ [WIP] fix: helpers with empty or undefined values Feb 11, 2025

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

chore: note

afb2d59

UnderKoen changed the title ~~[WIP] fix: helpers with empty or undefined values~~ fix: helpers with empty or undefined values Feb 11, 2025

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

UnderKoen mentioned this pull request Feb 11, 2025

[Feedback] Rule action templating #3606

Open

matt-fidd approved these changes Feb 11, 2025

View reviewed changes

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

UnderKoen merged commit dbdc5af into master Feb 11, 2025
21 checks passed

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

UnderKoen deleted the Underkoen/fix-handlebars-with-undefined branch February 11, 2025 20:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: helpers with empty or undefined values #4356

fix: helpers with empty or undefined values #4356

UnderKoen commented Feb 11, 2025 •

edited

Loading

netlify bot commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 11, 2025 •

edited

Loading

coderabbitai bot commented Feb 11, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

matt-fidd left a comment

fix: helpers with empty or undefined values #4356

fix: helpers with empty or undefined values #4356

Conversation

UnderKoen commented Feb 11, 2025 • edited Loading

netlify bot commented Feb 11, 2025 • edited Loading

✅ Deploy Preview for actualbudget ready!

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

Bundle Stats — desktop-client

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

Bundle Stats — loot-core

coderabbitai bot commented Feb 11, 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

matt-fidd left a comment

Choose a reason for hiding this comment

UnderKoen commented Feb 11, 2025 •

edited

Loading

netlify bot commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 11, 2025 •

edited

Loading

coderabbitai bot commented Feb 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)