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 first occurrence of some schedules moved after the weekend not showing in preview #4256

Merged
merged 4 commits into from
Feb 3, 2025

Conversation

matt-fidd
Copy link
Contributor

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

Testing:
If you upload this to edge you'll see the schedule preview doesn't show in the account, but it does in the preview build.

schedules_test.zip

@actual-github-bot actual-github-bot bot changed the title fix first occurrence of some schedules moved after the weekend not showing in preview [WIP] fix first occurrence of some schedules moved after the weekend not showing in preview Jan 29, 2025
Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 7cbdbfe
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/679fc078cf87e600080707fb
😎 Deploy Preview https://deploy-preview-4256.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 first occurrence of some schedules moved after the weekend not showing in preview fix first occurrence of some schedules moved after the weekend not showing in preview Jan 29, 2025
@matt-fidd matt-fidd added this to the v25.2.0 milestone Jan 29, 2025
Copy link
Contributor

github-actions bot commented Jan 29, 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
15 6.71 MB → 6.71 MB (-29 B) -0.00%
Changeset
File Δ Size
home/runner/work/actual/actual/packages/loot-core/src/client/data-hooks/transactions.ts 📉 -29 B (-0.47%) 6.05 kB → 6.02 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
static/js/index.js 4.29 MB → 4.29 MB (-29 B) -0.00%

Unchanged

Asset File Size % Changed
static/js/en-GB.js 99.33 kB 0%
static/js/en.js 99.34 kB 0%
static/js/nl.js 83.87 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/BackgroundImage.js 122.29 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/AppliedFilters.js 10.52 kB 0%
static/js/pt-BR.js 103.29 kB 0%
static/js/useAccountPreviewTransactions.js 1.69 kB 0%
static/js/narrow.js 84.94 kB 0%
static/js/uk.js 111.11 kB 0%
static/js/wide.js 102.8 kB 0%
static/js/ReportRouter.js 1.59 MB 0%

Copy link
Contributor

github-actions bot commented Jan 29, 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%

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request modifies the usePreviewTransactions function in the transactions.ts file by changing the initialization of the dates array to start with the next_date of the schedule. The line initializing dates has been updated from an empty array to include the next_date. This adjustment impacts how upcoming transaction dates are calculated within the function, as the initial value of dates now influences the logic for determining future transaction dates. Additionally, the logic for pushing the next date into the dates array has been altered, removing the previous condition for non-recurring schedules. The forceUpcoming property logic has also been updated to reflect changes in how the current date is processed. The overall structure and logic of the function remain intact.

Possibly related PRs

  • fix mobile schedule status #4172: The changes in the main PR are related to the modifications of the forceUpcoming property in the usePreviewTransactions function, which directly connects to the introduction of the same property in the TransactionEntity interface and its usage in the TransactionListItem component in the retrieved PR.
  • make one month schedule upcoming length dynamic and add current month option #4168: The changes in the main PR are related to the modifications in the usePreviewTransactions function, specifically regarding the handling of dates, which directly connects to the changes made in the getUpcomingDays function introduced in the retrieved PR.
  • fix paid schedules showing as upcoming in the account #4188: The changes in the main PR directly modify the logic of the usePreviewTransactions function, which is also altered in the retrieved PR to enhance the handling of scheduled transactions, indicating a strong relationship between the two.

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 81c2f1c and 7cbdbfe.

📒 Files selected for processing (1)
  • packages/loot-core/src/client/data-hooks/transactions.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/loot-core/src/client/data-hooks/transactions.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (windows-latest)
  • GitHub Check: Analyze
  • GitHub Check: build (ubuntu-latest)

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.

@youngcw
Copy link
Member

youngcw commented Jan 30, 2025

Do you have steps to test this?

@matt-fidd
Copy link
Contributor Author

matt-fidd commented Jan 30, 2025

Do you have steps to test this?

Yep, sorry. If you upload this to edge you'll see the schedule preview doesn't show in the account, but it does in the preview build.

schedules_test.zip

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.

This almost seems to work, but if I set my computer's time to Tuesday and check the linked test, the date on the schedule is 'March 3' even though it's missed and should show 'Feb 2' per the schedules page. I'd imagine we need to take the next date and "un-move" it after the weekend, somehow (or just get the base next date directly).

Separately, any chance you could write some unit tests for this file? The logic is looking pretty complex and I think it would help give more confidence about edge cases like this

@matt-fidd
Copy link
Contributor Author

matt-fidd commented Feb 2, 2025

This almost seems to work, but if I set my computer's time to Tuesday and check the linked test, the date on the schedule is 'March 3' even though it's missed and should show 'Feb 2' per the schedules page. I'd imagine we need to take the next date and "un-move" it after the weekend, somehow (or just get the base next date directly).

I think this is a bug outside of this PR. I can see the same behaviour on edge where if the date is moved by 2 days because it hits a weekend that date is skipped entirely.

Screen.Recording.2025-02-02.at.17.45.50.mov

Separately, any chance you could write some unit tests for this file? The logic is looking pretty complex and I think it would help give more confidence about edge cases like this

Yes, good idea. I don't know if I'll be able to before release but I'll look into how's best.

@matt-fidd
Copy link
Contributor Author

I'll look into the bug above when I get a chance but for now I've altered the logic here to always include the next date, regardless, and then calculate the others. That should alleviate all bugs where the next date is missed because of getNextDate weirdness.

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

🔭 Outside diff range comments (1)
packages/loot-core/src/client/data-hooks/transactions.ts (1)

177-195: Add unit tests for weekend schedule scenarios.

As suggested in the PR comments, we should add unit tests to cover weekend schedule scenarios, especially edge cases where schedules are moved after weekends.

Would you like me to help generate unit tests that cover:

  1. Regular weekday schedules
  2. Schedules that fall on weekends
  3. Edge cases for schedules moved after weekends
🧰 Tools
🪛 ESLint

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

(prettier/prettier)

🪛 GitHub Check: lint

[failure] 177-177:
Replace ·schedule.next_date· with schedule.next_date

🪛 GitHub Actions: Test

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

🧹 Nitpick comments (1)
packages/loot-core/src/client/data-hooks/transactions.ts (1)

177-177: Fix formatting issue.

Remove extra spaces around schedule.next_date.

-        const dates: string[] = [ schedule.next_date ];
+        const dates: string[] = [schedule.next_date];
🧰 Tools
🪛 ESLint

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

(prettier/prettier)

🪛 GitHub Check: lint

[failure] 177-177:
Replace ·schedule.next_date· with schedule.next_date

🪛 GitHub Actions: Test

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ab75b1e and ebc079a.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4256.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/loot-core/src/client/data-hooks/transactions.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.
🪛 ESLint
packages/loot-core/src/client/data-hooks/transactions.ts

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

(prettier/prettier)

🪛 GitHub Check: lint
packages/loot-core/src/client/data-hooks/transactions.ts

[failure] 177-177:
Replace ·schedule.next_date· with schedule.next_date

🪛 GitHub Actions: Test
packages/loot-core/src/client/data-hooks/transactions.ts

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Visual regression
  • GitHub Check: Functional
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze
🔇 Additional comments (1)
packages/loot-core/src/client/data-hooks/transactions.ts (1)

177-195: Verify weekend schedule handling.

The fix ensures first occurrences are included by initializing dates with schedule.next_date. However, based on the PR comments about dates being incorrectly moved after weekends (showing March 3 instead of Feb 2), we should verify the weekend adjustment logic.

Let's verify the weekend adjustment behavior:

✅ Verification successful

Weekend Schedule Handling Verification Confirmed

The weekend adjustment behavior is implemented through the centralized logic in getDateWithSkippedWeekend (in packages/loot-core/src/shared/schedules.ts), which correctly handles solving weekend dates based on the weekendSolveMode configuration. The schedules and tests (as seen in various files like goalsSchedule.test.ts and settings mocks) consistently reference and use these configurations. In the transactions hook, initializing dates with schedule.next_date ensures that the first occurrence (whether adjusted or not) is preserved, and subsequent dates are computed using getNextDate that relies on the existing weekend adjustment logic.

  • The weekend adjustment implementation in getDateWithSkippedWeekend properly returns the next Monday when using 'after' or the previous Friday for 'before' modes.
  • Related tests and configurations in the codebase (across schedules, reports, and mocks) confirm that weekend handling is in place and working as intended.
  • The logic in transactions.ts correctly preserves the starting date and computes subsequent dates without inadvertently shifting them.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for weekend adjustment logic in schedules
# Expected: Find code that handles weekend date adjustments

# Search for weekend-related date adjustments
rg -A 5 -i "weekend|saturday|sunday" --type ts

# Search for getNextDate implementations
ast-grep --pattern 'function getNextDate($_) {
  $$$
}'

Length of output: 23416

🧰 Tools
🪛 ESLint

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

(prettier/prettier)

🪛 GitHub Check: lint

[failure] 177-177:
Replace ·schedule.next_date· with schedule.next_date

🪛 GitHub Actions: Test

[error] 177-177: Replace ·schedule.next_date· with schedule.next_date

@matt-fidd
Copy link
Contributor Author

/update-vrt

jfdoming
jfdoming previously approved these changes Feb 2, 2025
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.

Nice workaround, can still imagine there are edge cases but this should at least catch the two situations you and I found

@matt-fidd
Copy link
Contributor Author

@jfdoming VRT was failing because non-recurring schedules were added twice, fixed now.

@matt-fidd matt-fidd requested a review from jfdoming February 2, 2025 19:00
@matt-fidd matt-fidd merged commit ed91fb1 into actualbudget:master Feb 3, 2025
20 checks passed
@matt-fidd matt-fidd deleted the schedules-fix branch February 3, 2025 00:08
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.

3 participants