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

Add GoCardless integration for ABNAMRO_ABNANL2A #513

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

Conversation

nsulzer
Copy link

@nsulzer nsulzer commented Dec 1, 2024

Add GoCardless integration for ABNAMRO_ABNANL2A, with just a bit of added cleanup:

  • extract a payee from remittance information
  • clean up remittance information that will become the notes.

@actual-github-bot actual-github-bot bot changed the title Add GoCardless integration for ABNAMRO_ABNANL2A [WIP] Add GoCardless integration for ABNAMRO_ABNANL2A Dec 1, 2024
@nsulzer nsulzer changed the title [WIP] Add GoCardless integration for ABNAMRO_ABNANL2A Add GoCardless integration for ABNAMRO_ABNANL2A Dec 2, 2024
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

This pull request introduces a new bank module named AbnamroAbnanl2a to the application. The module is imported into src/app-gocardless/bank-factory.js and added to the existing banks array, which consolidates various bank modules for processing. The new module implements the IBank interface and includes functionalities for account and transaction normalization, such as methods for normalizing account data, processing transactions, sorting transactions, and calculating starting balances. Key properties include institution identifiers and access validity. The addition does not alter existing logic related to bank identification or error handling, ensuring that the core functionality remains intact. Additionally, a test suite is created in src/app-gocardless/banks/tests/abnamro_abnanl2a.spec.js to validate the normalizeTransaction method's functionality, confirming that it correctly formats transaction data.

Possibly related PRs

Suggested labels

✨ Merged

Suggested reviewers

  • jfdoming
  • matt-fidd

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 785a7fe and 2636fa2.

📒 Files selected for processing (1)
  • src/app-gocardless/bank-factory.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/app-gocardless/bank-factory.js

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. (Experiment)
  • @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: 2

🧹 Outside diff range and nitpick comments (3)
src/app-gocardless/banks/abnamro_abnanl2a.js (2)

34-36: Simplify extraction of 'payeeName'

The replace(/.+\*/, '') in matches[1].replace(/.+\*/, '').trim() may be unnecessary if the remittance information does not contain a '*' character. Simplifying the code can improve readability without affecting functionality.

Apply this diff to simplify the code:

 const payeeName = matches
-  ? matches[1].replace(/.+\*/,'').trim()
+  ? matches[1].trim()
   : undefined;

40-41: Correct typographical errors in comments

There are minor typographical errors in the comments:

  • Line 40: 'anumber' should be 'a number'.
  • Line 41: 'aboid' should be 'avoid'.

Apply this diff to correct the typos:

 // There are anumber of superfluous keywords in the remittanceInformation.
+// There are a number of superfluous keywords in the remittanceInformation.

 // Remove them to aboid clutter in notes.
+// Remove them to avoid clutter in notes.
src/app-gocardless/banks/tests/abnamro_abnanl2a.spec.js (1)

5-5: Correct test description for clarity

The test description contains a redundant word 'and'. Removing it improves clarity.

Apply this diff to fix the test description:

-it('correctly extracts the payee and when not provided', () => {
+it('correctly extracts the payee when not provided', () => {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4842111 and 785a7fe.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/513.md is excluded by !**/*.md
📒 Files selected for processing (3)
  • src/app-gocardless/bank-factory.js (2 hunks)
  • src/app-gocardless/banks/abnamro_abnanl2a.js (1 hunks)
  • src/app-gocardless/banks/tests/abnamro_abnanl2a.spec.js (1 hunks)
🔇 Additional comments (1)
src/app-gocardless/bank-factory.js (1)

Line range hint 2-35: Integration of new bank module is correct

The addition of AbnamroAbnanl2a to the imports and the banks array is correctly implemented.

Comment on lines +27 to +28
let remittanceInformationUnstructured =
transaction.remittanceInformationUnstructuredArray.join(' ');
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add error handling for missing 'remittanceInformationUnstructuredArray'

If transaction.remittanceInformationUnstructuredArray is undefined, calling .join(' ') will result in a runtime error. Consider providing a default empty array to prevent this issue.

Apply this diff to add a default value:

 let remittanceInformationUnstructured =
-  transaction.remittanceInformationUnstructuredArray.join(' ');
+  (transaction.remittanceInformationUnstructuredArray || []).join(' ');
📝 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
let remittanceInformationUnstructured =
transaction.remittanceInformationUnstructuredArray.join(' ');
let remittanceInformationUnstructured =
(transaction.remittanceInformationUnstructuredArray || []).join(' ');

Comment on lines +73 to +77
return amountToInteger(
balances.find((balance) => 'interimBooked' === balance.balanceType)
.balanceAmount.amount,
);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Handle cases where 'interimBooked' balance is not found

If no balance with balanceType equal to 'interimBooked' is found, balances.find(...) will return undefined, and accessing .balanceAmount.amount will throw an error. Adding error handling ensures robustness.

Apply this diff to add error handling:

 } else {
+  const interimBalance = balances.find(
+    (balance) => 'interimBooked' === balance.balanceType,
+  );
+  if (!interimBalance) {
+    // Handle the case where no interimBooked balance is found
+    throw new Error('No interimBooked balance found');
+  }
   return amountToInteger(
-    balances.find((balance) => 'interimBooked' === balance.balanceType)
-      .balanceAmount.amount,
+    interimBalance.balanceAmount.amount,
   );
 }

Committable suggestion skipped: line range outside the PR's diff.

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