8000 fix(pools): do not send event for deletion of not found pools by paul-nicolas · Pull Request #205 · formancehq/payments · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(pools): do not send event for deletion of not found pools #205

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 2 commits into from
Dec 16, 2024

Conversation

paul-nicolas
Copy link
Contributor

Fixes ENG-1566

@paul-nicolas paul-nicolas requested a review from a team as a code owner December 16, 2024 11:38
Copy link
Contributor < 8000 /span>
coderabbitai bot commented Dec 16, 2024

Warning

Rate limit exceeded

@paul-nicolas has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 8 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 75f9bf6 and 71c2ff9.

📒 Files selected for processing (1)
  • test/e2e/api_pools_test.go (0 hunks)

Walkthrough

The pull request modifies the PoolsDelete method across multiple files to return a boolean indicating whether a pool was successfully deleted. This change impacts the storage layer, engine, and associated test files. The primary modification allows for more precise tracking of pool deletion, ensuring that notifications are only sent when a pool is actually deleted. The changes introduce a new return signature that provides additional information about the deletion operation's outcome.

Changes

File Change Summary
internal/connectors/engine/engine.go Updated DeletePool method to conditionally execute workflow based on deletion success
internal/storage/pools.go Modified PoolsDelete method to return (bool, error) and track rows affected
internal/storage/pools_test.go Updated test cases to verify deletion status
internal/storage/storage.go Updated Storage interface method signature
internal/storage/storage_generated.go Updated mock storage method signature

Assessment against linked issues

Objective Addressed Explanation
Prevent sending notifications for non-existent pools [ENG-1566]

Poem

🐰 A Rabbit's Deletion Tale 🗑️

In the realm of pools, a change so neat,
Deletion now tracks each deleted feat
No more ghosts of pools long gone
With boolean flag, we carry on!
A cleaner path, more precise and bright 🌟


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.

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/storage/pools.go (1)

116-119: Consider potential race condition in rows affected check.

There's a small window between checking rows affected and committing the transaction where another transaction could modify the data. While this is a minor concern in this case (as we're only using it for event notification), it's worth noting.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b64ffe9 and 75f9bf6.

📒 Files selected for processing (5)
  • internal/connectors/engine/engine.go (1 hunks)
  • internal/storage/pools.go (1 hunks)
  • internal/storage/pools_test.go (2 hunks)
  • internal/storage/storage.go (1 hunks)
  • internal/storage/storage_generated.go (1 hunks)
🔇 Additional comments (5)
internal/storage/pools.go (1)

93-121: LGTM! The implementation correctly handles pool deletion status.

The changes properly track whether a pool was actually deleted by checking the rows affected, which aligns with the PR objective of preventing events for non-existent pools.

internal/storage/storage.go (1)

99-99: LGTM! Interface change properly reflects the new contract.

The updated method signature correctly specifies the new return type, maintaining consistency with the implementation.

internal/storage/pools_test.go (1)

187-189: LGTM! Comprehensive test coverage for the new functionality.

The test cases thoroughly verify both scenarios:

  1. Deletion of non-existent pool returns (false, nil)
  2. Deletion of existing pool returns (true, nil)

This ensures the new boolean return value correctly indicates whether a pool was actually deleted.

Also applies to: 198-200

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

876-903: LGTM! The changes correctly implement the desired behavior.

The modifications ensure that deletion events are only sent when a pool is actually deleted, preventing unnecessary event emissions for non-existent pools. The implementation maintains proper error handling and telemetry.

internal/storage/storage_generated.go (1)

904-909: LGTM! The mock implementation correctly reflects the interface changes.

The PoolsDelete mock method has been properly updated to return both the deletion status and error, maintaining consistency with the actual implementation.

@paul-nicolas paul-nicolas merged commit 34dfa1c into main Dec 16, 2024
7 checks passed
@paul-nicolas paul-nicolas deleted the fix/pools-events branch December 16, 2024 12:48
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