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 paid schedules showing as upcoming in the account #4188

Merged
merged 2 commits into from
Jan 18, 2025

Conversation

matt-fidd
Copy link
Contributor

@matt-fidd matt-fidd commented Jan 18, 2025

I found an issue where if a schedule posts early the upcoming one will still show even if the schedule is "paid".

This adds the same helper function as #4180 whichever is merged first will probably cause a conflict with the other, I'll fix it.

@actual-github-bot actual-github-bot bot changed the title fix paid schedules showing as upcoming in the account [WIP] fix paid schedules showing as upcoming in the account Jan 18, 2025
Copy link

netlify bot commented Jan 18, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit c96b074
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/678c0fe45c3dee0008061a15
😎 Deploy Preview https://deploy-preview-4188.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.

@matt-fidd matt-fidd changed the title [WIP] fix paid schedules showing as upcoming in the account fix paid schedules showing as upcoming in the account Jan 18, 2025
Copy link
Contributor

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
14 6.61 MB → 6.61 MB (+208 B) +0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/shared/schedules.ts 📈 +182 B (+2.14%) 8.3 kB → 8.48 kB
home/runner/work/actual/actual/packages/loot-core/src/client/data-hooks/transactions.ts 📈 +26 B (+0.43%) 5.87 kB → 5.9 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.27 MB → 4.27 MB (+208 B) +0.00%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/en.js 97.98 kB 0%
static/js/pt-BR.js 99.8 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/en-GB.js 97.12 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/uk.js 119.92 kB 0%
static/js/AppliedFilters.js 10.21 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/narrow.js 84.68 kB 0%
static/js/wide.js 101.2 kB 0%
static/js/ReportRouter.js 1.59 MB 0%

Copy link
Contributor

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
File Δ Size
packages/loot-core/src/shared/schedules.ts 📈 +195 B (+1.66%) 11.47 kB → 11.67 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.33 MB 0%

Copy link
Contributor

coderabbitai bot commented Jan 18, 2025

Walkthrough

The pull request introduces a new function scheduleIsRecurring in the schedules.ts module, which determines whether a schedule is recurring based on its date conditions. In the transactions.ts file, this function is integrated into the usePreviewTransactions function to modify how upcoming transaction dates are generated.

The changes enhance the logic for handling scheduled transactions by clearly differentiating between recurring and non-recurring schedules. For recurring schedules, the code now generates multiple upcoming dates up to a specified period end. For non-recurring schedules, it directly adds the next date to the array. Additionally, there's a modification to handle the 'paid' schedule status by potentially removing the first date from the array.

Possibly related PRs

Suggested labels

enhancement, feature, schedules

Suggested reviewers

  • youngcw

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7cb5350 and c96b074.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4188.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/loot-core/src/client/data-hooks/transactions.ts (2 hunks)
  • packages/loot-core/src/shared/schedules.ts (1 hunks)
🧰 Additional context used
📓 Learnings (1)
packages/loot-core/src/client/data-hooks/transactions.ts (1)
Learnt from: matt-fidd
PR: actualbudget/actual#4166
File: packages/loot-core/src/client/data-hooks/transactions.ts:200-200
Timestamp: 2025-01-16T14:29:13.188Z
Learning: In the scheduled transactions implementation within `packages/loot-core/src/client/data-hooks/transactions.ts`, the `upcoming` flag is set based on `schedules.length > 0` to act as an override, where the first occurrence gets `false` and subsequent occurrences get `true`. This is intentional and should not be changed to date-based comparison.
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Functional
  • GitHub Check: Visual regression
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
🔇 Additional comments (3)
packages/loot-core/src/client/data-hooks/transactions.ts (3)

15-15: LGTM!

Clean import of the new helper function.


192-193: LGTM! Clean fix for paid schedules.

This change correctly prevents paid schedules from showing as upcoming by removing the first date when the schedule is marked as paid.


175-190: LGTM! Verify edge cases for date generation.

The logic correctly differentiates between recurring and non-recurring schedules, generating dates appropriately in each case.

Let's verify there are no edge cases where this change might affect other schedule types:

✅ Verification successful

✓ Schedule date generation logic is robust and well-tested

The implementation correctly handles both recurring and non-recurring schedules with proper date validation, parsing, and edge case handling. The code is supported by comprehensive tests covering both scenarios.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for all schedule-related test files to check edge cases
fd -e ts -e js test.*schedule

# Search for any existing schedule type checks
rg -A 3 "schedule.*type|type.*schedule"

Length of output: 10067


Script:

#!/bin/bash
# Find schedule type definitions and date handling
ast-grep --pattern 'interface $_Schedule {
  $$$
}'

# Look for date handling in schedules
rg -A 5 "next_date|date.*condition" --type ts

# Search for recurring patterns
rg -A 3 "recurring|repeat" --type ts

Length of output: 45442

Comment on lines +375 to +380
export function scheduleIsRecurring(dateCond) {
const cond = new Condition(dateCond.op, 'date', dateCond.value, null);
const value = cond.getValue();

return value.type === 'recur';
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add null safety checks to prevent runtime errors.

The function should handle cases where dateCond or its properties are undefined/null.

 export function scheduleIsRecurring(dateCond) {
+  if (!dateCond?.op || !dateCond?.value) {
+    return false;
+  }
   const cond = new Condition(dateCond.op, 'date', dateCond.value, null);
   const value = cond.getValue();

   return value.type === 'recur';
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
export function scheduleIsRecurring(dateCond) {
const cond = new Condition(dateCond.op, 'date', dateCond.value, null);
const value = cond.getValue();
return value.type === 'recur';
}
export function scheduleIsRecurring(dateCond) {
if (!dateCond?.op || !dateCond?.value) {
return false;
}
const cond = new Condition(dateCond.op, 'date', dateCond.value, null);
const value = cond.getValue();
return value.type === 'recur';
}

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.

2 participants