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

Corner case transaction for GoCardLess adapater (ING Romania) #535

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

spideraxal
Copy link
Contributor

Hello,

I am updating my adapter for ING Romania. It seems there is a special transaction type (insurance provided by the bank itself for example), which does not have the remittanceInformationUnstructured field, only the proprietaryBankTransactionCode one.

This led to a Cannot read properties of undefined (reading 'toLowerCase') error, so no new transactions were synced. This commit fixes the issue.

image

@actual-github-bot actual-github-bot bot changed the title Corner case transaction for GoCardLess adapater (ING Romania) [WIP] Corner case transaction for GoCardLess adapater (ING Romania) Jan 5, 2025
@spideraxal spideraxal changed the title [WIP] Corner case transaction for GoCardLess adapater (ING Romania) Corner case transaction for GoCardLess adapater (ING Romania) Jan 5, 2025
Copy link
Contributor

coderabbitai bot commented Jan 5, 2025

Walkthrough

The pull request introduces modifications to the normalizeTransaction method in the ING bank transaction processing module. The changes focus on improving transaction data handling, specifically for the proprietaryBankTransactionCode and remittanceInformationUnstructured fields.

The updates implement new logic to populate remittanceInformationUnstructured with proprietaryBankTransactionCode when it is not already set. For booked and pending transactions, the code adds specific handling for transactions containing 'card no:' in the unstructured information. This includes adjusting the creditorName extraction and managing how transaction details are processed.

The modifications aim to enhance the accuracy and consistency of transaction data processing for ING bank transactions, with particular attention to edge cases involving transaction codes and unstructured information.


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 (3)
src/app-gocardless/banks/ing-ingbrobu.js (3)

22-29: Broaden the check for empty or whitespace remittanceInformationUnstructured
Currently, the assignment happens only when remittanceInformationUnstructured is not set, which might neglect cases where remittanceInformationUnstructured is present but only contains whitespace. Consider refining the condition to handle empty values more robustly.

 if (
   transaction.proprietaryBankTransactionCode &&
-  !transaction.remittanceInformationUnstructured
+  (!transaction.remittanceInformationUnstructured ||
+    !transaction.remittanceInformationUnstructured.trim())
 ) {
   transaction.remittanceInformationUnstructured =
     transaction.proprietaryBankTransactionCode;
 }

31-31: Future-proof the detection key for 'card no:'
Using a literal check for 'card no:' is acceptable here, but if the format changes or additional data is appended, it might fail. It can be beneficial to isolate 'card no:' in a dedicated constant or configuration file to improve maintainability and handle potential variants more easily.

🧰 Tools
🪛 Biome (1.9.4)

[error] 31-34: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)


46-52: Prevent duplication of logic for the proprietary bank transaction code
You repeat the same logic in both the booked and unbooked branches. Consider extracting this block into a helper function, reducing duplication and improving clarity.

 // Example approach
-function copyProprietaryCodeIfEmpty(transaction) {
-  if (transaction.proprietaryBankTransactionCode && !transaction.remittanceInformationUnstructured) {
-    transaction.remittanceInformationUnstructured = transaction.proprietaryBankTransactionCode;
-  }
-}

+function copyProprietaryCodeIfEmpty(transaction) {
+  if (
+    transaction.proprietaryBankTransactionCode &&
+    (!transaction.remittanceInformationUnstructured ||
+      !transaction.remittanceInformationUnstructured.trim())
+  ) {
+    transaction.remittanceInformationUnstructured = transaction.proprietaryBankTransactionCode;
+  }
+}

// Then call copyProprietaryCodeIfEmpty(transaction) in each branch
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2005c1b and 87f9341.

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

54-54: Ensure consistent obfuscation logic
You're replacing four consecutive 'x' characters with 'Xxxx ', but the original account string may vary across providers. Confirm this pattern is guaranteed, or at least degrade gracefully if the transaction has a different format (e.g., fewer or more 'x' characters). If necessary, you can further expand the matching or fallback logic.

🧰 Tools
🪛 Biome (1.9.4)

[error] 54-57: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

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.

1 participant