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 pending transaction amount sign and payee name for National Bank of Greece import #448

Merged
merged 4 commits into from
Sep 17, 2024

Conversation

mezger6
Copy link
Contributor

@mezger6 mezger6 commented Sep 6, 2024

The pending purchases retrieved from National Bank of Greece are erroneously sent as positive, and have a static unnecessary prefix ("ΑΓΟΡΑ") added to the remittance information, causing them to be added as deposits, and preventing the eventual booked transactions from being properly matched.

This fix adds the minus sign and removes the prefix for the problematic pending transactions.

Summary by CodeRabbit

  • New Features

    • Introduced a new bank entity, NbgEthngraaxxx, expanding the list of available banks.
    • Added robust data normalization and balance calculation methods for the NBG_ETHNGRAAXXX bank integration.
  • Bug Fixes

    • Resolved issues with pending purchases amount sign and payee name during the import process, enhancing financial data accuracy.
  • Tests

    • Implemented a test suite for the NbgEthngraaxxx module to validate transaction normalization logic.

@actual-github-bot actual-github-bot bot changed the title Fix pending transaction amount sign and payee name for National Bank of Greece import [WIP] Fix pending transaction amount sign and payee name for National Bank of Greece import Sep 6, 2024
@mezger6 mezger6 changed the title [WIP] Fix pending transaction amount sign and payee name for National Bank of Greece import Fix pending transaction amount sign and payee name for National Bank of Greece import Sep 10, 2024
Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

The changes introduce a new bank integration for the National Bank of Greece (NBG) by adding a new bank entity and its corresponding module. The module includes methods for normalizing account and transaction data and calculating starting balances. Additionally, a test suite is created to validate the normalization logic. A bug fix is also included to ensure accurate representation of transaction amounts and payee names during the import process.

Changes

File Path Change Summary
src/app-gocardless/bank-factory.js Added NbgEthngraaxxx to the banks array.
src/app-gocardless/banks/nbg_ethngraaxxx.js Introduced a new module for NBG integration with methods for normalizing accounts and transactions, and calculating starting balances.
src/app-gocardless/banks/tests/nbg_ethngraaxxx.spec.js Added test suite for normalizeTransaction function, validating scenarios for pending and booked transactions.
upcoming-release-notes/448.md Documented a bug fix related to pending purchases amount sign and payee name during the import process.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant NbgEthngraaxxx

    User->>App: Initiate bank transaction
    App->>NbgEthngraaxxx: Normalize account data
    NbgEthngraaxxx-->>App: Return normalized account
    App->>NbgEthngraaxxx: Normalize transaction data
    NbgEthngraaxxx-->>App: Return normalized transaction
    App-->>User: Display transaction details
Loading

Poem

🐇 In the meadow where banks do play,
A new friend joins us, hip-hip-hooray!
NBG now dances in our code,
With transactions neat, on this bright road.
So let’s hop along, with joy we sing,
For every change, new wonders bring! 🌼


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9ea7bd2 and b06b860.

Files selected for processing (4)
  • src/app-gocardless/bank-factory.js (2 hunks)
  • src/app-gocardless/banks/nbg_ethngraaxxx.js (1 hunks)
  • src/app-gocardless/banks/tests/nbg_ethngraaxxx.spec.js (1 hunks)
  • upcoming-release-notes/448.md (1 hunks)
Additional context used
LanguageTool
upcoming-release-notes/448.md

[grammar] ~6-~6: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...s: [mezger6] --- Fix pending purchases amount sign and payee name for National Bank of Gre...

(PLENTY_OF_NOUNS)

Additional comments not posted (8)
upcoming-release-notes/448.md (1)

1-6: LGTM!

The release notes accurately reflect the bug fix described in the PR objectives. The metadata is correctly formatted, and the title concisely summarizes the issue and the fix.

The static analysis hint about the grammar issue can be safely ignored, as the title is not a complete sentence and does not require the use of "of" after "plenty".

Tools
LanguageTool

[grammar] ~6-~6: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...s: [mezger6] --- Fix pending purchases amount sign and payee name for National Bank of Gre...

(PLENTY_OF_NOUNS)

src/app-gocardless/banks/tests/nbg_ethngraaxxx.spec.js (1)

3-48: Excellent test coverage!

The test suite NbgEthngraaxxx thoroughly covers the normalizeTransaction function for both pending and booked transactions. The test cases align with the PR objectives and verify the expected behavior of converting the amount to negative and removing the payee name prefix for pending transactions.

The test suite is well-structured, with clear descriptions and assertions. It provides confidence in the correctness of the normalizeTransaction function.

src/app-gocardless/banks/nbg_ethngraaxxx.js (4)

14-24: LGTM!

The normalizeAccount method correctly formats the account details by generating a masked IBAN and a display name that combines the account holder's name with the IBAN. The logic is sound and the implementation looks good.


31-52: Looks good!

The normalizeTransaction method correctly handles the issues with pending transactions from the National Bank of Greece. It negates the transaction amount and removes the 'ΑΓΟΡΑ ' prefix from the remittance information for pending transactions. This ensures consistency with booked transactions and aligns with the PR objectives.


62-70: Looks good!

The calculateStartingBalance method correctly computes the starting balance by retrieving the current balance using the interimAvailable balance type and deducting the amounts of sorted transactions. This approach accurately handles the lack of available balance information after each transaction for the National Bank of Greece.


1-71: Great work on this bank integration module!

The nbg_ethngraaxxx.js file provides a comprehensive and well-structured integration for the National Bank of Greece. The code is clean, well-documented, and follows best practices. The methods for normalizing account and transaction data, as well as calculating the starting balance, effectively address the issues outlined in the PR objectives.

The fixes for pending transactions, such as correcting the amount sign and removing the 'ΑΓΟΡΑ ' prefix from remittance information, ensure consistency with booked transactions and improve the accuracy of the data.

Overall, this module enhances the integration capabilities for the NBG_ETHNGRAAXXX bank and provides a solid foundation for accurate financial tracking and reporting. Great job!

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

26-26: LGTM!

The import statement for the new NbgEthngraaxxx bank module follows the established pattern and naming convention. It aligns with the PR objective of adding support for the National Bank of Greece.


53-53: Looks good!

The addition of the NbgEthngraaxxx bank module to the banks array is necessary and consistent with the existing code structure. It completes the integration of the new bank module into the application, aligning with the PR objective.


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 generate interesting stats about this repository and render them as a table.
    -- @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
Member

@MatissJanis MatissJanis left a comment

Choose a reason for hiding this comment

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

Thanks!

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