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

ING_PL_INGBPLPW should prefer valueDate over bookingDate #493

Merged
merged 2 commits into from
Nov 9, 2024

Conversation

matt-fidd
Copy link
Contributor

Reported in Github, valueDate is more accurate for ING_PL_INGBPLPW

@actual-github-bot actual-github-bot bot changed the title ING_PL_INGBPLPW should prefer valueDate over bookingDate [WIP] ING_PL_INGBPLPW should prefer valueDate over bookingDate Nov 2, 2024
@matt-fidd matt-fidd changed the title [WIP] ING_PL_INGBPLPW should prefer valueDate over bookingDate ING_PL_INGBPLPW should prefer valueDate over bookingDate Nov 2, 2024
Copy link
Contributor

coderabbitai bot commented Nov 2, 2024

Walkthrough

The pull request introduces a modification to the normalizeTransaction method in the src/app-gocardless/banks/ing-pl-ingbplpw.js file. The key change involves the way the date property is assigned in the returned object. Previously, the assignment utilized a logical OR operator (||) to choose between transaction.bookingDate and transaction.valueDate. The updated implementation uses the nullish coalescing operator (??), which refines the fallback mechanism to only consider null or undefined values for transaction.valueDate. This change enhances the precision of the date assignment without altering the overall logic, error handling, or control flow of the method. Other functionalities within the exported object, such as account normalization, transaction sorting, and starting balance calculations, remain unchanged.

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • MikesGlitch

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)
src/app-gocardless/banks/ing-pl-ingbplpw.js (1)

30-30: Consider documenting date preference strategy

Since this change establishes a precedent for preferring valueDate over bookingDate for ING PL, consider documenting this decision in a comment or the integration's README. This could help guide similar decisions for other bank integrations.

Add a comment explaining the date preference:

+      // Prefer valueDate as it's more accurate for ING PL transactions
       date: transaction.valueDate ?? transaction.bookingDate,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b5f8aa4 and 71d13ae.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/493.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • src/app-gocardless/banks/ing-pl-ingbplpw.js (1 hunks)
🔇 Additional comments (2)
src/app-gocardless/banks/ing-pl-ingbplpw.js (2)

30-30: LGTM! Improved date selection logic

The change from || to ?? operator ensures valueDate is always preferred when present, falling back to bookingDate only when valueDate is null/undefined. This aligns with the PR objective of preferring valueDate for ING PL transactions.


30-30: Verify valueDate validation

While the change is correct, we should verify that valueDate cannot contain invalid values (like empty strings) that would previously have been caught by the || operator.

✅ Verification successful

Based on the search results, I can now generate the final response:

valueDate validation is properly handled

The codebase shows consistent handling of valueDate across bank integrations:

  • Most banks use fallback patterns (|| or ??) between bookingDate and valueDate
  • Several banks explicitly validate that a date exists and return null if neither date is present
  • Test files show valueDate consistently contains valid date strings (e.g. '2023-12-29')
  • The GoCardless API documentation referenced in comments indicates valueDate is a validated field

The change from || to ?? maintains the same validation since both operators protect against empty strings, undefined and null values. The ?? operator is actually more precise since it only falls back on null/undefined.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any valueDate validation or preprocessing in bank integrations
rg -A 5 "valueDate" --type js

# Search for similar date handling patterns in other bank integrations
ast-grep --pattern 'normalizeTransaction($params) {
  $$$
  date: $expr
  $$$
}'

Length of output: 44689

@matt-fidd matt-fidd requested a review from MatissJanis November 4, 2024 20:31
@matt-fidd matt-fidd merged commit d412590 into actualbudget:master Nov 9, 2024
8 checks passed
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