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

fix negative amount parsing #4489

Merged
merged 2 commits into from
Mar 1, 2025

Conversation

matt-fidd
Copy link
Contributor

Fixes a regression caused by #4383

Fixes #4487

@actual-github-bot actual-github-bot bot changed the title fix negative amount parsing [WIP] fix negative amount parsing Mar 1, 2025
Copy link

netlify bot commented Mar 1, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 0e2fe6b
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67c27f64eea93d00081e13fa
😎 Deploy Preview https://deploy-preview-4489.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

@jfdoming jfdoming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question, otherwise LGTM

Copy link
Contributor

github-actions bot commented Mar 1, 2025

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
18 7.07 MB → 7.07 MB (+8 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/shared/util.ts 📈 +8 B (+0.11%) 6.92 kB → 6.92 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 4.35 MB → 4.35 MB (+8 B) +0.00%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/en-GB.js 98.67 kB 0%
static/js/de.js 114.35 kB 0%
static/js/en.js 103.18 kB 0%
static/js/es.js 60.58 kB 0%
static/js/fr.js 90.64 kB 0%
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/uk.js 111.11 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/narrow.js 86.23 kB 0%
static/js/AppliedFilters.js 10.8 kB 0%
static/js/pt-BR.js 112.83 kB 0%
static/js/wide.js 102.9 kB 0%
static/js/useAccountPreviewTransactions.js 1.69 kB 0%
static/js/nl.js 97.78 kB 0%
static/js/ReportRouter.js 1.59 MB 0%

Copy link
Contributor

github-actions bot commented Mar 1, 2025

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.34 MB 0%
Changeset
File Δ Size
packages/loot-core/src/shared/util.ts 📈 +8 B (+0.07%) 11.06 kB → 11.07 kB
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
kcab.worker.js 1.34 MB 0%

@matt-fidd matt-fidd changed the title [WIP] fix negative amount parsing fix negative amount parsing Mar 1, 2025
Copy link
Contributor

coderabbitai bot commented Mar 1, 2025

Walkthrough

This PR updates the currencyToAmount function by modifying the regular expression used to extract the integer part from a currency string. The original regex \D, which excluded non-digit characters, is replaced with [^\d-] so that negative signs are preserved during conversion. The change ensures that negative monetary values are accurately processed while leaving the fractional extraction logic and overall function structure intact.

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • joel-jeremy

📜 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 e91f8e7 and 0e2fe6b.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4489.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/loot-core/src/shared/util.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Functional
  • GitHub Check: Visual regression
  • GitHub Check: build (windows-latest)
🔇 Additional comments (1)
packages/loot-core/src/shared/util.ts (1)

402-404: The fix for negative amount parsing looks good.

The replacement of \D with [^\d-] correctly preserves the negative sign during currency parsing, fixing the issue with negative amounts. This change aligns with the PR objective to address the regression in negative amount parsing.

In response to the previous question about supporting +: If you want to also handle explicit positive signs (e.g., '+123.45'), you might consider using [^\d+-] instead, but it's perfectly fine to leave it as-is if that's not a requirement.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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
Copy link
Contributor Author

@coderabbitai can you open a tracking issue, we really need to add tests for this file

Copy link
Contributor

coderabbitai bot commented Mar 1, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the content of the file to understand what it does
cat packages/loot-core/src/shared/util.ts

Length of output: 12196


🏁 Script executed:

#!/bin/bash
# Let's first check the PR that caused the regression to understand the issue better
gh pr view 4383 --json title,body,url

# And let's check the issue that this PR is fixing
gh issue view 4487 --json title,body,url

# Let's also check if there are any existing tests for this file
fd "util.test" packages/loot-core/src/shared/

Length of output: 3123


🏁 Script executed:

#!/bin/bash
# Let's check the existing test file
cat packages/loot-core/src/shared/util.test.ts

# Let's also see the changes made in the current PR
git show --diff-filter=M packages/loot-core/src/shared/util.ts

# Let's also check if there are unit tests for this specific function
grep -A 20 "currencyToAmount" packages/loot-core/src/shared/util.test.ts

Length of output: 5211


🏁 Script executed:

#!/bin/bash
# Let's create a tracking issue for adding tests for the currencyToAmount function
# First, let's check the PR changes in more detail to understand what was fixed
git diff packages/loot-core/src/shared/util.ts

# Now, let's create the tracking issue
gh issue create \
  --title "Add comprehensive tests for currencyToAmount in util.ts" \
  --body "## Background
The \`currencyToAmount\` function in \`packages/loot-core/src/shared/util.ts\` has been the source of several bugs recently:

- PR #4383 fixed an issue where the function expected a string in the current number format
- PR #4489 fixed a regression related to parsing negative amounts

Currently, there are tests for \`looselyParseAmount\` and number formatting functions in \`util.test.ts\`, but none specifically for \`currencyToAmount\`. This is a critical utility function that handles currency string parsing throughout the application.

## Objective
Add comprehensive unit tests for the \`currencyToAmount\` function covering:

- Handling of different number formats (comma-dot, dot-comma, space-comma, apostrophe-dot, comma-dot-in)
- Proper parsing of negative amounts (both with minus sign and parentheses)
- Edge cases like leading zeros, only decimal part, etc.
- Handling of invalid inputs

## Related PRs and Issues
- https://github.com/actualbudget/actual/pull/4383 - Original fix for currency conversion
- https://github.com/actualbudget/actual/pull/4489 - Fix for negative amount parsing
- https://github.com/actualbudget/actual/issues/4487 - Issue that revealed the negative amount parsing bug

## Suggested Test Cases
Test cases should include but not be limited to:
- Basic positive amounts with various formats
- Negative amounts (both with minus sign and parentheses)
- Amount strings with no decimal part
- Amount strings with only decimal part (e.g., \`.45\`)
- Strings with incorrect format (e.g., using dot in dot-comma format)
- Invalid inputs (non-numeric strings)

This will help prevent regressions and ensure consistent behavior across the application." \
  --assignee "matt-fidd"

Length of output: 1894


@matt-fidd I've created a tracking issue for adding tests to the currencyToAmount function in util.ts. The issue is now available at: #4490.

The tracking issue includes:

  • Background on recent bugs and fixes related to the function
  • Objectives for comprehensive test coverage
  • References to related PRs and issues
  • Suggested test cases covering different number formats, negative amounts, and edge cases

I've assigned the issue to you as requested.

@matt-fidd matt-fidd merged commit 6db52ca into actualbudget:master Mar 1, 2025
21 checks passed
@matt-fidd matt-fidd deleted the fix-negative-amount branch March 1, 2025 03:50
jfdoming pushed a commit that referenced this pull request Mar 1, 2025
* fix negative amount parsing

* note
jfdoming added a commit that referenced this pull request Mar 3, 2025
* fix negative amount parsing (#4489)

* fix negative amount parsing

* note

* Remove used release notes

* Empty commit to bump ci

* Fix number input on mobile with hidden decimals (#4503)

* Fix number input on mobile with hidden decimals

* Add release notes

* Remove used release notes

* Empty commit to bump ci

* Bump non-server versions

* Bump sync-server

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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]: Reconciling Loan Account Taking Negative Balance as Positive
2 participants