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

feat(payments): v3 http wrapper #1688

Merged
merged 7 commits into from
Sep 19, 2024
Merged

Conversation

laouji
Copy link

@laouji laouji commented Sep 13, 2024

As proposed in ENG-1370

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

Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

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
Loading

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
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 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.

@laouji laouji changed the title [WIP] Feat/payments v3 http wrapper feat (payments): v3 http wrapper Sep 13, 2024
@laouji laouji force-pushed the feat/payments-v3-http-wrapper branch 2 times, most recently from c94c9f3 to ab2f2fb Compare September 16, 2024 12:11
@laouji laouji changed the title feat (payments): v3 http wrapper feat(payments): v3 http wrapper Sep 16, 2024
@paul-nicolas paul-nicolas force-pushed the feat/payments-v3 branch 2 times, most recently from 122713d to 4846858 Compare September 17, 2024 12:31
@laouji laouji force-pushed the feat/payments-v3-http-wrapper branch 2 times, most recently from 2b28ddd to 09dd17d Compare September 17, 2024 14:06
@laouji laouji force-pushed the feat/payments-v3-http-wrapper branch 6 times, most recently from 876375d to e812315 Compare September 19, 2024 08:51
@laouji laouji force-pushed the feat/payments-v3-http-wrapper branch from 9e565ae to bf687bf Compare September 19, 2024 14:16
@laouji laouji marked this pull request as ready for review September 19, 2024 14:27
@laouji laouji requested a review from a team as a code owner September 19, 2024 14:27
@laouji
Copy link
Author

laouji commented Sep 19, 2024

@coderabbitai summary

Copy link
Contributor

coderabbitai bot commented Sep 19, 2024

Actions performed

Summary regeneration triggered.

Copy link
Contributor

@paul-nicolas paul-nicolas left a comment

Choose a reason for hiding this comment

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

Very nice thanks !

@laouji laouji merged commit ff96ede into feat/payments-v3 Sep 19, 2024
9 checks passed
@laouji laouji deleted the feat/payments-v3-http-wrapper branch September 19, 2024 14:56
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