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 support for LHV_LHVBEE22 #542

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

Conversation

lnagel
Copy link
Contributor

@lnagel lnagel commented Jan 8, 2025

Add GoCardless formatter for LHV Estonia (LHV_LHVBEE22).

This extracts bookingDate and creditorName for card transactions where creditorName is not provided originally (null) and bookingDate delayed until the card transaction clears a few days later. The current mainline version simply falls back to setting the payeeName to remittanceInformationUnstructured and this is not good, since the values are long and unique every time.

For example:

remittanceInformationUnstructured = '(..1234) 2025-01-02 09:32 CrustumOU\Poordi 3\Tallinn\10156     ESTEST'

will now yield these values

bookingDate = '2025-01-02'
creditorName = 'CrustumOU'

I tried to follow the pattern used by other bank integrations here and add a few test cases as well. I have been running this code on my server for a bit and seems to work correctly.

I also noticed #541 and tried to follow the pattern suggested there. If it gets merged before, I can do a rebase.

@lnagel lnagel marked this pull request as ready for review January 9, 2025 08:11
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request introduces a new bank module for LHV (LhvLhvbee22) to the GoCardless application. Changes include adding a new bank import in the bank-factory.js file and creating a new module lhv-lhvbee22.js that extends the Fallback module. This new module features a normalizeTransaction method designed to process card transactions by extracting specific information such as creditorName and bookingDate using a regular expression. Additionally, a test suite is included to validate the functionality of the new bank module, covering various scenarios for both booked and pending card transactions.

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • UnderKoen

📜 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 9175afd and 908f57b.

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

Finishing Touches

  • 📝 Generate Docstrings

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

🧹 Nitpick comments (2)
src/app-gocardless/banks/lhv-lhvbee22.js (1)

16-17: Consider making the regex pattern more specific for merchant info.

The current pattern (.+)$ is too permissive and might capture unexpected data. Consider restricting the merchant info format.

-      /^\(\.\.(\d{4})\) (\d{4}-\d{2}-\d{2}) (\d{2}:\d{2}) (.+)$/g;
+      /^\(\.\.(\d{4})\) (\d{4}-\d{2}-\d{2}) (\d{2}:\d{2}) ([^\\]+)(?:\\.*)?$/g;
src/app-gocardless/banks/tests/lhv-lhvbee22.spec.js (1)

36-49: Add more edge cases to the test suite.

Consider adding test cases for:

  • Merchant names containing backslashes
  • Invalid date formats
  • Special characters in merchant names
   it.each([
     ['regular text', 'Some info'],
     ['partial card text', 'PIRKUMS xxx'],
     ['null value', null],
+    ['merchant with backslash', '(..1234) 2025-01-02 09:32 Merchant\\Name\\City'],
+    ['special characters', '(..1234) 2025-01-02 09:32 Café & Bar\\Address'],
+    ['invalid date', '(..1234) 2025-13-45 09:32 Merchant\\Address'],
   ])('normalizes non-card transaction with %s', (_, remittanceInfo) => {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0637b1d and 9175afd.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/542.md is excluded by !**/*.md
📒 Files selected for processing (3)
  • src/app-gocardless/bank-factory.js (2 hunks)
  • src/app-gocardless/banks/lhv-lhvbee22.js (1 hunks)
  • src/app-gocardless/banks/tests/lhv-lhvbee22.spec.js (1 hunks)
🧰 Additional context used
📓 Learnings (1)
src/app-gocardless/banks/lhv-lhvbee22.js (1)
Learnt from: matt-fidd
PR: actualbudget/actual-server#490
File: src/app-gocardless/banks/swedbank-habalv22.js:21-28
Timestamp: 2024-11-10T16:45:31.225Z
Learning: `Fallback.normalizeTransaction` handles error handling for date parsing.
🔇 Additional comments (2)
src/app-gocardless/banks/lhv-lhvbee22.js (1)

23-26: Handle potential edge cases with backslashes in merchant names.

The current implementation assumes the first part before a backslash is the merchant name. This might not always be true.

src/app-gocardless/bank-factory.js (1)

23-23: LGTM!

The integration of LhvLhvbee22 follows the established pattern for bank imports and registration.

Also applies to: 62-62

src/app-gocardless/banks/lhv-lhvbee22.js Outdated Show resolved Hide resolved
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