formancehq / stack

Open Source Infrastructure for the Financial Internet
https://www.formance.com
Other
359 stars 50 forks source link

feat(payments): v3 http wrapper #1688

Closed laouji closed 1 month ago

laouji commented 2 months ago

As proposed in ENG-1370

Reducing repetition by adding http wrapper which separates business logic from http boilerplate

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce a new httpwrapper package across various components in the payments module to standardize and streamline HTTP request handling. This includes refactoring existing HTTP client implementations to utilize the new wrapper, which encapsulates error handling and response parsing, thereby reducing code duplication and improving maintainability. Additionally, several methods across different clients have been updated to enhance error management and response processing.

Changes

Files Change Summary
components/payments/internal/connectors/httpwrapper/* Introduced httpwrapper package, including Client interface and NewClient function for structured HTTP interactions, error handling, and response unmarshaling.
components/payments/internal/connectors/plugins/public/bankingcircle/client/* Refactored HTTP request handling in various methods to use httpwrapper, simplifying error handling and response processing.
components/payments/internal/connectors/plugins/public/currencycloud/client/* Updated HTTP request handling in multiple methods to utilize httpwrapper, enhancing error management and reducing boilerplate code.
components/payments/internal/connectors/plugins/public/mangopay/client/* Refactored to use httpwrapper for HTTP requests and responses, improving clarity and maintainability by centralizing error handling.
components/payments/internal/connectors/plugins/public/modulr/client/* Updated client methods to leverage httpwrapper, streamlining error handling and response processing.
components/payments/internal/connectors/plugins/public/moneycorp/client/* Refactored to utilize httpwrapper, enhancing error handling and simplifying HTTP request logic.
components/payments/internal/connectors/plugins/public/wise/client/* Refactored to integrate httpwrapper, improving error handling and response management across various methods.
components/payments/internal/connectors/plugins/public/wise/plugin.go Updated client initialization in the Install function to include error handling during client creation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant HTTPWrapper
    participant Server

    Client->>HTTPWrapper: Create request
    HTTPWrapper->>Server: Send request
    Server-->>HTTPWrapper: Response
    HTTPWrapper->>Client: Return response or error

Assessment against linked issues

Objective Addressed Explanation
Add HTTP wrapper for all connectors to avoid code duplication (ENG-1370) βœ…

πŸ‡ "In the meadow, the code does play,
With wrappers now, it’s a brighter day!
Errors handled with grace and ease,
Simplified calls bring us to our knees.
Hopping through functions, oh what a sight,
Our code is tidy, and everything's right!" πŸ‡


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
laouji commented 1 month ago

@coderabbitai summary

coderabbitai[bot] commented 1 month ago
Actions performed Summary regeneration triggered.