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 Calendar Widget tracking transfers as income and expense #4143

Conversation

AntoineTA
Copy link
Contributor

Fixes #4136

When fetching transactions for the calendar widget, ignore transactions that are transfers by only getting transactions whose transfer_id is null.

Copy link

netlify bot commented Jan 14, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 0e83603
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/6785b7315b33eb0008a01d9e
😎 Deploy Preview https://deploy-preview-4143.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 Jan 14, 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
21 5.96 MB → 5.96 MB (+170 B) +0.00%
Changeset
File Δ Size
src/components/reports/spreadsheets/calendar-spreadsheet.ts 📈 +80 B (+1.36%) 5.74 kB → 5.82 kB
src/components/reports/reports/Calendar.tsx 📈 +90 B (+0.34%) 26.07 kB → 26.16 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/ReportRouter.js 1.59 MB → 1.59 MB (+170 B) +0.01%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/cy.js 17 B 0%
static/js/ta.js 17 B 0%
static/js/nb-NO.js 19 B 0%
static/js/pl.js 17 B 0%
static/js/pt-BR.js 19 B 0%
static/js/de.js 4.59 kB 0%
static/js/fr.js 13.11 kB 0%
static/js/es.js 3.45 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/zh-Hant.js 10.13 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/en.js 96.72 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/uk.js 120.47 kB 0%
static/js/narrow.js 84.3 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/AppliedFilters.js 10.21 kB 0%
static/js/wide.js 106.04 kB 0%
static/js/index.js 3.78 MB 0%

Copy link
Contributor

github-actions bot commented Jan 14, 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.33 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
kcab.worker.js 1.33 MB 0%

@AntoineTA AntoineTA changed the title [WIP] Fix Calendar Widget tracks transfers as income and expense Fix Calendar Widget tracking transfers as income and expense Jan 14, 2025
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Walkthrough

The pull request introduces a modification to the transaction filtering logic in two components: the Calendar component and the calendar spreadsheet function. In both cases, a new filter condition is added to exclude transactions with a transfer_id of null. This change specifically targets how transfers are handled in the calendar view, ensuring that transfer transactions are not counted as income or expenses. The modification is implemented consistently across the desktop client's reporting components, maintaining the existing query structure while refining the data retrieval process.

Assessment against linked issues

Objective Addressed Explanation
Prevent transfers from being tracked as income/expense [#4136]
Reproduce issue in Calendar widget

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • matt-fidd

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/desktop-client/src/components/reports/reports/Calendar.tsx (1)

206-206: LGTM! Consider adding a test case.

The filter condition is correctly implemented and consistent with the spreadsheet implementation. To ensure the change is properly tested:

Would you like me to generate a test case that verifies transfer transactions are excluded from the calendar widget calculations?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6573a52 and 0e83603.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4143.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/src/components/reports/reports/Calendar.tsx (1 hunks)
  • packages/desktop-client/src/components/reports/spreadsheets/calendar-spreadsheet.ts (1 hunks)
🔇 Additional comments (1)
packages/desktop-client/src/components/reports/spreadsheets/calendar-spreadsheet.ts (1)

83-83: LGTM! Verify the impact on transfer transactions.

The filter condition correctly excludes transfer transactions from income and expense calculations. Let's verify the implementation:

✅ Verification successful

Implementation verified - transfer filtering is consistent

The filter condition { transfer_id: { $eq: null } } follows the established pattern used throughout the codebase for excluding transfer transactions from reports. This implementation is consistent with:

  • Other reporting components (Calendar.tsx)
  • Transaction rule handling
  • Core transfer management logic
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that transfer transactions are properly excluded.

# Test: Check if there are any transfer transactions that might still be counted.
# Expect: No results as transfer transactions should be excluded.
rg -A 5 "transfer_id.*null.*amount.*sum" .

Length of output: 44


Script:

#!/bin/bash
# Check the full query structure and transfer handling
ast-grep --pattern 'makeRootQuery($$$) {
  $$$
}'

# Look for similar transfer filtering patterns
rg -B 3 -A 3 'transfer_id.*null' .

# Check for other query-related functions in the file
rg -B 2 -A 5 'function.*Query' packages/desktop-client/src/components/reports/spreadsheets/calendar-spreadsheet.ts

Length of output: 12297

@matt-fidd
Copy link
Contributor

matt-fidd commented Jan 14, 2025

👋 Hi! Thank you for the contribution!

Sorry I didn't see this issue earlier before your change, but it's better if we retain the maximum functionality of the calendar report. Some people might use it to track when money is leaving and entering their budget as a whole and would quite like to see transfers in there.

I've put a comment on the original issue explaining how you/others in the future can customise the calendar report to exclude transfers if that's what you'd like on your reports page.

We'd welcome more contributions, and if you're interested on carrying on within the report code then there are plenty of issues open in that area https://github.com/actualbudget/actual/issues?q=is%3Aissue+is%3Aopen+label%3Areports

Sorry again for stepping on this one - especially as it's your first contribution.

@AntoineTA
Copy link
Contributor Author

No worry, I totally understand. It's not like I spent a lot of time on it, and it allowed me to get started with the project which was the main goal anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Calendar Widget tracks transfers as income and expense
2 participants