8000 fix(payments): fix missing delay when scheduling in the future by paul-nicolas · Pull Request #226 · formancehq/payments · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(payments): fix missing delay when scheduling in the future #226

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
Dec 20, 2024

Conversation

paul-nicolas
Copy link
Contributor

Fixes ENG-1573

Copy link
Contributor
coderabbitai bot commented Dec 20, 2024

Walkthrough

The pull request introduces a mechanism to handle delayed payment initiations by adding a startDelay variable across multiple service methods and the engine interface. This change allows for scheduling payments in the future by calculating the time difference between the current time and the scheduled time. The modifications impact the PaymentInitiationsApprove, PaymentInitiationsCreate, and PaymentInitiationsRetry methods in the services package, as well as the CreateTransfer and CreatePayout methods in the engine connector.

Changes

File Change Summary
internal/api/services/payment_initiations_approve.go Added startDelay calculation based on ScheduledAt time
internal/api/services/payment_initiations_create.go Introduced startDelay variable for future-scheduled payments
internal/api/services/payment_initiations_retry.go Removed reversal check, added startDelay parameter
internal/connectors/engine/engine.go Updated method signatures to include startDelay parameter

Assessment against linked issues

Objective Addressed Explanation
Fix missing delay for future-scheduled payments [ENG-1573]

Possibly related PRs

Suggested reviewers

  • laouji

Poem

🐰 A rabbit's tale of payments due,
Scheduled time, now coming through!
Delay no more, the transfer waits,
With precision that never abates.
Hop along, financial friend! 🚀💸

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 paul-nicolas marked this pull request as ready for review December 20, 2024 14:01
@paul-nicolas paul-nicolas requested a review from a team as a code owner December 20, 2024 14:01
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 (5)
internal/api/services/payment_initiations_retry.go (1)

6-6: Optional improvement on import grouping.
The explicit import of "time" is acceptable, and there's no group mismatch at the moment. Just ensure it remains consistent with the project's overall import conventions.

internal/api/services/payment_initiations_approve.go (1)

42-47: Ensure no negative scheduling intervals.
The code checks if pi.ScheduledAt is after now, so negative intervals are unlikely. However, consider logging or handling edge cases if the clock changes or pi.ScheduledAt is unexpectedly set in the past.

internal/api/services/payment_initiations_create.go (1)

32-37: Validate large or negative scheduled intervals.
This logic is clear for computing startDelay when scheduled in the future. As with the other files, you might want to log or handle unexpected edge cases if the time difference is negative or extremely large.

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

485-485: Consider validating large or negative delay.
In your engine’s CreateTransfer implementation, consider logging or rejecting extreme values if the calculated delay is unexpectedly large or negative due to a data or time discrepancy.


604-604: CreatePayout admissions check.
Similarly, before scheduling a payout, consider verifying StartDelay boundaries to avoid accidental indefinite scheduling.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 079e038 and 83a08e5.

📒 Files selected for processing (4)
  • internal/api/services/payment_initiations_approve.go (2 hunks)
  • internal/api/services/payment_initiations_create.go (2 hunks)
  • internal/api/services/payment_initiations_retry.go (2 hunks)
  • internal/connectors/engine/engine.go (5 hunks)
🔇 Additional comments (13)
internal/api/services/payment_initiations_retry.go (3)

44-49: Consistency in attempts counting.
Here, attempts is incremented by one. Confirm that the logic for isReversed and the existing getAttemps function still yields the correct attempt count. Mismatching attempt counts may lead to confusing references in tasks or logs.


50-55: Aligning payout logic with transfer logic.
The new addition of startDelay for payouts is consistent with transfers. Ensure consistent usage and avoid missing checks for negative or unexpectedly large startDelay.


42-43: Potential negative delays check.
You're initializing startDelay to zero. Before setting the final value, consider validating that the derived delay is not negative if future logic (or dynamic time adjustments) modifies pi.ScheduledAt.

Would you like to verify all usage of ScheduledAt across the codebase to ensure negative intervals are never passed to StartDelay?

internal/api/services/payment_initiations_approve.go (3)

6-6: No direct concerns with the import.
The import of "time" is consistent with your usage for startDelay. No changes needed here.


50-50: Separate attempt count from delay.
Currently, you’re using a hardcoded attempt of 1. Confirm if strictly using 1 is intended or if you plan to track attempts similarly to PaymentInitiationsRetry for clarity and consistency.


56-56: Consistent usage of startDelay.
As with transfers, passing the same startDelay for payouts is consistent. Ensure the rest of the code still properly logs or surfaces the delay if debugging is necessary.

internal/api/services/payment_initiations_create.go (3)

5-5: Import usage is consistent.
Importing "time" is valid for the delayed logic. No specific suggestions here.


40-40: Maintain consistent attempts.
Here, attempts is hard-coded to 1. Confirm if you plan on tracking the attempt count or if the single attempt is always intended for newly created payment initiations.


46-46: Similar usage for payouts.
The same reasoning for maintaining consistent attempts applies to CreatePayout. Otherwise, logic is fine.

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

44-44: Method signature updated: verify usage across codebase.
The new parameter list includes startDelay. Ensure all call sites now pass the correct parameters (particularly attempt vs. startDelay).


48-48: Method signature refactor for payouts.
Similarly, confirm that all references to CreatePayout across the codebase, including test files if any, match this new signature.


512-512: Proper usage of StartDelay in client.StartWorkflowOptions.
Looks correct. Validate that the rest of the workflow logic accounts for the delay (e.g., ensuring deadlines or timeouts can handle the wait).


631-631: Consistency across workflow calls.
Again, usage of StartDelay is consistent. Ensure logs capture the delay so operators can diagnose issues if payments are not proceeding on time.

@paul-nicolas paul-nicolas merged commit 86a1073 into main Dec 20, 2024
7 checks passed
@paul-nicolas paul-nicolas deleted the fix/missing-delay branch December 20, 2024 14:13
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