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 Parse for Date Range #3735

Merged
merged 4 commits into from
Oct 25, 2024
Merged

Fix Parse for Date Range #3735

merged 4 commits into from
Oct 25, 2024

Conversation

carkom
Copy link
Contributor

@carkom carkom commented Oct 25, 2024

Fix parse date in DateRange element which is causing the cards to display the wrong dates.

@actual-github-bot actual-github-bot bot changed the title Fix Parse for Date Range [WIP] Fix Parse for Date Range Oct 25, 2024
Copy link

netlify bot commented Oct 25, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 12c77cb
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/671b88569b21840008273dc7
😎 Deploy Preview https://deploy-preview-3735.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.

@carkom carkom linked an issue Oct 25, 2024 that may be closed by this pull request
2 tasks
Copy link
Contributor

github-actions bot commented Oct 25, 2024

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
9 5.32 MB → 5.32 MB (-29 B) -0.00%
Changeset
File Δ Size
src/components/reports/DateRange.tsx 📉 -29 B (-1.49%) 1.91 kB → 1.88 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/ReportRouter.js 1.5 MB → 1.5 MB (-29 B) -0.00%

Unchanged

Asset File Size % Changed
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/AppliedFilters.js 21.3 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/narrow.js 82.57 kB 0%
static/js/wide.js 232.16 kB 0%
static/js/index.js 3.33 MB 0%

Copy link
Contributor

github-actions bot commented Oct 25, 2024

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.27 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.27 MB 0%

@carkom carkom changed the title [WIP] Fix Parse for Date Range Fix Parse for Date Range Oct 25, 2024
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

Walkthrough

The pull request modifies the checkDate function in the DateRange.tsx file located in the packages/desktop-client/src/components/reports directory. The primary change involves replacing the direct instantiation of a Date object with the use of monthUtils.parseDate(date), which alters the date parsing logic. This update affects how invalid dates are processed while maintaining the function's return value, which remains a formatted date string or null for invalid dates. The overall structure and control flow of the DateRange component are unchanged, ensuring that error handling for invalid dates continues to function as before. The rendering logic associated with date ranges and types is also preserved, with no alterations to conditions or output structure. Additionally, an import statement for monthUtils has been added to facilitate the new date parsing method.

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • youngcw

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 47e9e5e and 12c77cb.

📒 Files selected for processing (1)
  • packages/desktop-client/src/components/reports/DateRange.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/desktop-client/src/components/reports/DateRange.tsx

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

🧹 Outside diff range and nitpick comments (1)
packages/desktop-client/src/components/reports/DateRange.tsx (1)

The toString() check for 'Invalid Date' is redundant and can be removed

The monthUtils.parseDate implementation is a wrapper around an internal _parse function that safely handles date parsing with proper timezone and DST considerations. The function already returns a valid Date object, making the toString() check for 'Invalid Date' redundant. The code can be simplified to:

  const dateParsed = monthUtils.parseDate(date);
- if (dateParsed.toString() !== 'Invalid Date') {
+ if (dateParsed) {
    return d.format(dateParsed, 'yyyy-MM-dd');
  } else {
    return null;
🔗 Analysis chain

Line range hint 19-23: Verify monthUtils.parseDate implementation and suggest improvements.

While the change addresses the date parsing issue, there are a few considerations:

  1. The toString() check for 'Invalid Date' might be redundant if monthUtils.parseDate has built-in validation.
  2. Consider adding explicit type annotations for better type safety.

Let's verify the monthUtils.parseDate implementation:

Consider this type-safe implementation:

 function checkDate(date: string) {
-  const dateParsed = monthUtils.parseDate(date);
-  if (dateParsed.toString() !== 'Invalid Date') {
+  const dateParsed: Date | null = monthUtils.parseDate(date);
+  if (dateParsed && dateParsed instanceof Date && !isNaN(dateParsed.getTime())) {
     return d.format(dateParsed, 'yyyy-MM-dd');
   } else {
     return null;
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check monthUtils.parseDate implementation and return type
ast-grep --pattern 'parseDate = function($_) {
  $$$
}'

# Check for existing usage patterns
rg -A 3 'monthUtils.parseDate'

Length of output: 1745


Script:

#!/bin/bash
# Let's try to find the monthUtils implementation and its parseDate function
fd monthUtils --exec cat {}

# Also search for any type definitions related to monthUtils
rg -g '*.ts' -g '*.d.ts' 'monthUtils' -B 2 -A 2

Length of output: 97903


Script:

#!/bin/bash
# Let's find the implementation of monthUtils.parseDate
cat packages/loot-core/src/shared/months.ts

Length of output: 13288

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5751d5d and 47e9e5e.

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

5-6: LGTM: Import statement is correctly placed and necessary.

The addition of monthUtils import is required for the new date parsing implementation.


Line range hint 19-23: Verify handling of edge cases in date comparisons.

The date parsing change could affect how edge cases are handled in the display logic, particularly for:

  • Year transitions (December to January)
  • Month transitions
  • Budget/average comparisons

Let's check for edge case handling:

✅ Verification successful

Based on the shell script results, I can now provide a final response:

Date parsing implementation is well-tested and handles edge cases appropriately

The codebase has comprehensive test coverage for date handling, particularly:

  • Year/month transitions are tested in rules.test.ts with specific test cases for date comparisons
  • Invalid date handling is explicitly tested with proper validation
  • Multiple date format parsing is supported and tested in ImportTransactionsModal/utils.test.ts

The current implementation in DateRange.tsx follows the established pattern of handling invalid dates by returning null, which is consistent with the rest of the codebase's date handling approach.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Look for test cases covering edge cases
rg -l 'DateRange.*test' --type ts
rg -l 'describe.*DateRange' --type ts

# Check for existing date format patterns
rg 'format\(.*date.*,' --type ts

Length of output: 1745


Script:

#!/bin/bash
# Let's check for date-related tests and edge cases in the codebase
rg -A 5 "test\(.*date" --type ts
rg -A 5 "describe\(.*date" --type ts

# Look for monthUtils implementation and usage
rg -A 10 "monthUtils = {" --type ts
rg -A 10 "export function parseDate" --type ts

# Check for date comparison logic
ast-grep --pattern 'if ($_ !== "Invalid Date") {
  $$$
}'

# Look for budget comparison code that uses dates
rg -A 5 "budget.*date" --type ts
rg -A 5 "comparison.*date" --type ts

Length of output: 19987

Copy link
Member

@youngcw youngcw left a comment

Choose a reason for hiding this comment

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

Looks like Date was automatically factoring in timezones.

@youngcw youngcw merged commit f25dc1f into actualbudget:master Oct 25, 2024
20 checks passed
@carkom carkom deleted the fixDateParse branch October 25, 2024 17:57
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]: Reports cards are showing the wrong months in the dashboard
3 participants