8000 fix(pool): only allow internal accounts to be added to pool by paul-nicolas · Pull Request #428 · formancehq/payments · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(pool): only allow internal accounts to be added to pool #428

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 30, 2025
Merged

fix(pool): only allow internal accounts to be added to pool #428

merged 1 commit into from
Apr 30, 2025

Conversation

paul-nicolas
Copy link
Contributor
@paul-nicolas paul-nicolas commented Apr 30, 2025 •
edited
Loading

Fixes PMNT-96

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Apr 30, 2025 •
edited
Loading

Walkthrough

The changes enhance the engine component by adding validation in both the CreatePool and AddAccountToPool methods to ensure that only accounts of type INTERNAL are associated with pools. In CreatePool, all accounts in the pool are concurrently validated for existence and type before the pool is created. In AddAccountToPool, the account is synchronously validated before addition. Errors are returned if any account is missing or not internal, preventing pool 8000 creation or account addition. Corresponding tests were added to cover error cases and successful scenarios for both methods.

Changes

File(s) Change Summary
internal/connectors/engine/engine.go Added concurrent validation of all accounts in CreatePool and synchronous validation in AddAccountToPool to ensure accounts exist and are of type INTERNAL before proceeding.
internal/connectors/engine/engine_test.go Added test contexts for CreatePool and AddAccountToPool covering validation failures, storage errors, and successful operations with internal accounts.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Engine
    participant Storage
    participant Workflow

    Caller->>Engine: CreatePool(pool)
    Engine->>Storage: GetAccount(accountID) [for each account concurrently]
    alt Any account not found or not INTERNAL
        Engine-->>Caller: Return validation error
    else All accounts INTERNAL
        Engine->>Storage: UpsertPool(pool)
        Engine->>Workflow: SendEvent(pool)
        Engine-->>Caller: Return success
    end
Loading 
sequenceDiagram
    participant Caller
    participant Engine
    participant Storage
    participant Workflow

    Caller->>Engine: AddAccountToPool(poolID, accountID)
    Engine->>Storage: GetAccount(accountID)
    alt Account not found or not INTERNAL
        Engine-->>Caller: Return validation error
    else Account INTERNAL
        Engine->>Storage: AddAccountToPool(poolID, accountID)
        alt Add fails
            Engine-->>Caller: Return add error
        else Add succeeds
            Engine->>Storage: GetPool(poolID)
            Engine->>Workflow: SendEvent(account, pool)
            Engine-->>Caller: Return success
        end
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Restrict cash pool creation to INTERNAL account types (PMNT-96) ✅

Poem

A pool for cash, but not for all,
Only INTERNAL accounts may heed the call.
With checks in place, the code stands tall,
Errors caught before they fall.
Tests now guard this rabbit’s rule,
Hopping safe in every pool! 🐇💧

📜 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 6db7ba0 and 629d99a.

📒 Files selected for processing (2)
  • internal/connectors/engine/engine.go (3 hunks)
  • internal/connectors/engine/engine_test.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • internal/connectors/engine/engine_test.go
  • internal/connectors/engine/engine.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Tests
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@paul-nicolas
Copy link
Contributor Author

@coderabbitai review

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Apr 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.

@paul-nicolas paul-nicolas force-pushed the fix/only-allow-internal-account-to-pool branch from 6db7ba0 to 629d99a Compare April 30, 2025 11:15
@paul-nicolas paul-nicolas marked this pull request as ready for review April 30, 2025 11:17
@paul-nicolas paul-nicolas requested a review from a team as a code owner April 30, 2025 11:17
@codecov Codecov
Copy link
codecov bot commented Apr 30, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 88.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 61.34%. Comparing base (0a6a47a) to head (629d99a).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
internal/connectors/engine/engine.go 88.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #428      +/-   ##
==========================================
+ Coverage   61.12%   61.34%   +0.21%     
==========================================
  Files         579      579              
  Lines       29418    29443      +25     
==========================================
+ Hits        17982    18061      +79     
+ Misses      10470    10412      -58     
- Partials      966      970       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

laouji
laouji approved these changes Apr 30, 2025
View reviewed changes
Copy link
Contributor
@laouji laouji left a comment

Choose a reason for hiding this comment

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

Nice use of errgroup 👍

@paul-nicolas paul-nicolas merged commit c177643 into main Apr 30, 2025
9 checks passed
@paul-nicolas paul-nicolas deleted the fix/only-allow-internal-account-to-pool branch April 30, 2025 11:24
paul-nicolas added a commit that referenced this pull request Apr 30, 2025
@paul-nicolas
fix(pool): only allow internal accounts to be added to pool (#428)
2513509
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laouji laouji laouji approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@paul-nicolas @laouji
0