8000 fix(atlar): fix payout creation and polling statuses by paul-nicolas · Pull Request #305 · formancehq/payments · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(atlar): fix payout creation and polling statuses #305

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

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

paul-nicolas
Copy link
Contributor

No description provided.

Copy link
Contributor
coderabbitai bot commented Jan 30, 2025

Walkthrough

The pull request introduces modifications across several files in the Atlar client package, focusing primarily on enhancing error handling mechanisms. The changes involve updating error wrapping strategies in various methods of the client struct, introducing more specific error types for different scenarios such as not found, bad request, and other error conditions. The modifications aim to provide more granular and precise error reporting across different client methods, with a particular emphasis on improving the classification and handling of SDK-related errors.

Changes

File Change Summary
internal/connectors/engine/workflow/create_payout.go Updated workflow references from RunPollTransfer to RunPollPayout, modified argument structure from TransferID to PayoutID
internal/connectors/engine/workflow/create_payout_test.go Updated test case to expect RunPollPayout workflow action
internal/connectors/plugins/public/atlar/client/*.go Enhanced error handling across multiple client methods by:
  • Adding ErrorCodeReader interface
  • Modifying wrapSDKErr function signature
  • Introducing specific error types for different scenarios (not found, bad request) |

Sequence Diagram

sequenceDiagram
    participant Client
    participant SDK
    participant ErrorHandler
    
    Client->>SDK: Make API Call
    SDK-->>Client: Return Response/Error
    Client->>ErrorHandler: Wrap Error
    ErrorHandler-->>Client: Classify and Return Error
Loading

Possibly related PRs

Suggested Labels

build-images

Suggested Reviewers

  • laouji

Poem

🐰 In the realm of code, where errors dance and play,
A rabbit hops through methods, finding a clearer way
With types so precise, and errors so bright,
Our SDK now handles each challenge with might!
Hop, hop, debugging done right! 🚀

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@paul-nicolas
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor
coderabbitai bot commented Jan 30, 2025
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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 (1)
internal/connectors/plugins/public/atlar/client/client.go (1)

Line range hint 76-113: LGTM! Robust error handling implementation.

The enhanced wrapSDKErr function now:

  • Properly handles both runtime.APIError and custom error types
  • Uses type assertions safely with errors.As
  • Maintains consistent error wrapping behavior

However, consider adding error message customization for better debugging:

-		return fmt.Errorf("atlar error: %w: %w", err, httpwrapper.ErrStatusCodeTooManyRequests)
+		return fmt.Errorf("atlar rate limit exceeded (code %d): %w: %w", code, err, httpwrapper.ErrStatusCodeTooManyRequests)

-		return fmt.Errorf("atlar error: %w: %w", err, httpwrapper.ErrStatusCodeClientError)
+		return fmt.Errorf("atlar client error (code %d): %w: %w", code, err, httpwrapper.ErrStatusCodeClientError)

-		return fmt.Errorf("atlar error: %w: %w", err, httpwrapper.ErrStatusCodeServerError)
+		return fmt.Errorf("atlar server error (code %d): %w: %w", code, err, httpwrapper.ErrStatusCodeServerError)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0a05349 and 5864c6b.

📒 Files selected for processing (9)
  • internal/connectors/engine/workflow/create_payout.go (1 hunks)
  • internal/connectors/engine/workflow/create_payout_test.go (1 hunks)
  • internal/connectors/plugins/public/atlar/client/accounts.go (2 hunks)
  • internal/connectors/plugins/public/atlar/client/client.go (2 hunks)
  • internal/connectors/plugins/public/atlar/client/counter_parties.go (2 hunks)
  • internal/connectors/plugins/public/atlar/client/external_accounts.go (2 hunks)
  • internal/connectors/plugins/public/atlar/client/third_parties.go (1 hunks)
  • internal/connectors/plugins/public/atlar/client/transactions.go (2 hunks)
  • internal/connectors/plugins/public/atlar/client/transfers.go (2 hunks)
🔇 Additional comments (12)
internal/connectors/engine/workflow/create_payout.go (1)

132-138: LGTM! Workflow name and arguments updated correctly.

The changes properly align the workflow name and arguments with the payout-specific functionality:

  • Workflow renamed from RunPollTransfer to RunPollPayout
  • Arguments updated to use PayoutID instead of TransferID

Let's verify that all references to the old workflow name have been updated:

✅ Verification successful

Verified: Parallel workflow implementations are correct

The codebase maintains separate, well-structured implementations for transfer and payout workflows:

  • RunPollPayout is properly defined and registered for payout operations
  • RunPollTransfer references are part of the separate transfer functionality
  • No mixing or inconsistencies found between the two workflows
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining references to RunPollTransfer
rg "RunPollTransfer"

# Search for consistency in PayoutID usage
rg "TransferID.*RunPollPayout|RunPollPayout.*TransferID"

Length of output: 1677


Script:

#!/bin/bash
# Search for RunPollPayout definition and usage
rg "RunPollPayout" -A 2

# Verify workflow registration
ast-grep --pattern 'const RunPollPayout = $_'

Length of output: 5657

internal/connectors/engine/workflow/create_payout_test.go (1)

109-109: LGTM! Test assertion updated to match implementation.

The test correctly verifies that the workflow name has been updated to RunPollPayout.

internal/connectors/plugins/public/atlar/client/third_parties.go (1)

18-18: LGTM! Consistent error handling improvement

The addition of specific NotFound error type aligns with the systematic improvement in error handling across the client package.

internal/connectors/plugins/public/atlar/client/accounts.go (1)

18-18: LGTM! Consistent error handling pattern

The changes follow the established pattern across the client package:

  • GetV1AccountsID: Uses specific NotFound error type for precise error handling
  • GetV1Accounts: Uses nil for general error handling in list operations

Also applies to: 30-30

internal/connectors/plugins/public/atlar/client/transactions.go (1)

19-19: LGTM! Maintains consistent error handling

The changes maintain the established error handling pattern:

  • GetV1TransactionsID: Uses specific NotFound error type
  • GetV1Transactions: Uses nil for list operations

Also applies to: 30-30

internal/connectors/plugins/public/atlar/client/external_accounts.go (1)

18-18: LGTM! Completes the consistent error handling improvements

These changes complete the systematic improvement in error handling across the client package:

  • GetV1ExternalAccountsID: Uses specific NotFound error type
  • GetV1ExternalAccounts: Uses nil for list operations

The entire PR demonstrates a well-thought-out approach to improving error handling granularity across all client methods.

Also applies to: 30-30

internal/connectors/plugins/public/atlar/client/transfers.go (2)

19-19: LGTM! Enhanced error handling for credit transfers.

The addition of specific error type PostV1CreditTransfersBadRequest improves error classification for failed payout creations.


30-30: LGTM! Enhanced error handling for transfer status polling.

The addition of specific error type GetV1CreditTransfersGetByExternalIDExternalIDNotFound improves error classification when polling transfer statuses.

internal/connectors/plugins/public/atlar/client/client.go (1)

70-72: LGTM! Well-designed interface for error code handling.

The ErrorCodeReader interface provides a clean abstraction for error code retrieval.

internal/connectors/plugins/public/atlar/client/counter_parties.go (3)

21-21: LGTM! Enhanced error handling for counterparty retrieval.

The addition of specific error type GetV1CounterpartiesIDNotFound improves error classification.


64-64: LGTM! Enhanced error handling for counterparty creation.

The addition of specific error type PostV1CounterpartiesBadRequest improves error classification for failed counterparty creations.


Line range hint 25-25: Address the TODO comment regarding IBAN duplication.

The comment indicates a limitation in the Atlar API v1 regarding IBAN filtering. This could lead to duplicate accounts.

Let's check if this is still an issue with the current API version:

@paul-nicolas paul-nicolas marked this pull request as ready for review January 30, 2025 16:03
@paul-nicolas paul-nicolas requested a review from a team as a code owner January 30, 2025 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0