Refactor payout processing to use invoiceId only #2643

devkiran · 2025-07-14T08:51:09Z

Simplifies the payload for payout processing by removing unused fields and the shared utils file

Summary by CodeRabbit

Refactor
- Simplified the handling of payout processing by updating function parameters to accept only the invoice ID, removing unnecessary nested objects.
- Streamlined schema validation and removed unused schema and types related to charge and ACH transfer details.
Chores
- Removed obsolete code and cleaned up imports for better maintainability.

Simplifies the payload for payout processing by removing unused fields and the shared utils file

vercel · 2025-07-14T08:51:13Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
dub	✅ Ready (Inspect)	Visit Preview	Jul 14, 2025 9:02am

coderabbitai · 2025-07-14T08:51:15Z

Walkthrough

The changes refactor the payout processing flow by inlining the payload schema, simplifying function signatures for Stripe and PayPal payout handlers to accept invoiceId directly, and removing unused properties and types. The utility file defining the old schema and type is deleted, and the webhook now sends a reduced payload to the payout endpoint.

Changes

File(s)	Change Summary
.../api/cron/payouts/charge-succeeded/route.ts	Inlined `payloadSchema`, simplified request parsing, updated calls to payout functions to use `invoiceId` only.
.../api/cron/payouts/charge-succeeded/send-paypal-payouts.ts .../send-stripe-payouts.ts	Refactored function signatures to accept `{ invoiceId }` directly; removed unused `Payload` type import.
.../api/cron/payouts/charge-succeeded/utils.ts	Deleted file; removed schema and type definitions for the old payload structure.
.../api/stripe/webhook/charge-succeeded.ts	Simplified payload sent to payout endpoint; removed `chargeId` and `achCreditTransfer` from request body.

Sequence Diagram(s)

sequenceDiagram
    participant StripeWebhook
    participant PayoutAPI
    participant StripePayouts
    participant PaypalPayouts

    StripeWebhook->>PayoutAPI: POST /api/cron/payouts/charge-succeeded { invoiceId }
    PayoutAPI->>StripePayouts: sendStripePayouts({ invoiceId })
    PayoutAPI->>PaypalPayouts: sendPaypalPayouts({ invoiceId })

Possibly related PRs

Fix sendStripePayouts #2641: Refactors sendStripePayouts with internal logic and payout grouping changes, affecting the same function but with a different scope.

Suggested reviewers

steven-tey

Poem

A schema once wandered, now found in the file,
With invoiceId leading the payout style.
No more nested payloads, the code’s feeling spry,
Stripe and PayPal just wave as they pass by.
The rabbit hops on, with a streamlined cheer—
Simpler, cleaner, payouts appear!
🐇✨

📜 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 7a7949e and 148000d.

📒 Files selected for processing (5)

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/route.ts (3 hunks)
apps/web/app/(ee)/api/cron/payouts/charge-succeeded/send-paypal-payouts.ts (1 hunks)
apps/web/app/(ee)/api/cron/payouts/charge-succeeded/send-stripe-payouts.ts (1 hunks)
apps/web/app/(ee)/api/cron/payouts/charge-succeeded/utils.ts (0 hunks)
apps/web/app/(ee)/api/stripe/webhook/charge-succeeded.ts (0 hunks)

💤 Files with no reviewable changes (2)

apps/web/app/(ee)/api/stripe/webhook/charge-succeeded.ts
apps/web/app/(ee)/api/cron/payouts/charge-succeeded/utils.ts

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: devkiran
PR: dubinc/dub#2635
File: packages/prisma/schema/payout.prisma:24-25
Timestamp: 2025-07-11T16:28:55.654Z
Learning: In the Dub codebase, multiple payout records can now share the same stripeTransferId because payouts are grouped by partner and processed as single Stripe transfers. This is why the @unique constraint was removed from the stripeTransferId field in the Payout model - a single transfer can include multiple payouts for the same partner.

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-25T21:20:59.837Z
Learning: In the Dub codebase, payout limit validation uses a two-stage pattern: server actions perform quick sanity checks (payoutsUsage > payoutsLimit) for immediate user feedback, while the cron job (/cron/payouts) performs authoritative validation (payoutsUsage + payoutAmount > payoutsLimit) with actual calculated amounts before processing. This design provides fast user feedback while ensuring accurate limit enforcement at transaction time.

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-19T01:46:45.723Z
Learning: PayPal webhook verification in the Dub codebase is handled at the route level in `apps/web/app/(ee)/api/paypal/webhook/route.ts` using the `verifySignature` function. Individual webhook handlers like `payoutsItemFailed` don't need to re-verify signatures since they're only called after successful verification.

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/send-stripe-payouts.ts (1)

Learnt from: devkiran
PR: dubinc/dub#2635
File: packages/prisma/schema/payout.prisma:24-25
Timestamp: 2025-07-11T16:28:55.654Z
Learning: In the Dub codebase, multiple payout records can now share the same stripeTransferId because payouts are grouped by partner and processed as single Stripe transfers. This is why the @unique constraint was removed from the stripeTransferId field in the Payout model - a single transfer can include multiple payouts for the same partner.

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/route.ts (3)

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-19T01:46:45.723Z
Learning: PayPal webhook verification in the Dub codebase is handled at the route level in `apps/web/app/(ee)/api/paypal/webhook/route.ts` using the `verifySignature` function. Individual webhook handlers like `payoutsItemFailed` don't need to re-verify signatures since they're only called after successful verification.

Learnt from: devkiran
PR: dubinc/dub#2635
File: packages/prisma/schema/payout.prisma:24-25
Timestamp: 2025-07-11T16:28:55.654Z
Learning: In the Dub codebase, multiple payout records can now share the same stripeTransferId because payouts are grouped by partner and processed as single Stripe transfers. This is why the @unique constraint was removed from the stripeTransferId field in the Payout model - a single transfer can include multiple payouts for the same partner.

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-25T21:20:59.837Z
Learning: In the Dub codebase, payout limit validation uses a two-stage pattern: server actions perform quick sanity checks (payoutsUsage > payoutsLimit) for immediate user feedback, while the cron job (/cron/payouts) performs authoritative validation (payoutsUsage + payoutAmount > payoutsLimit) with actual calculated amounts before processing. This design provides fast user feedback while ensuring accurate limit enforcement at transaction time.

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/send-paypal-payouts.ts (1)

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-19T01:46:45.723Z
Learning: PayPal webhook verification in the Dub codebase is handled at the route level in `apps/web/app/(ee)/api/paypal/webhook/route.ts` using the `verifySignature` function. Individual webhook handlers like `payoutsItemFailed` don't need to re-verify signatures since they're only called after successful verification.

🧬 Code Graph Analysis (1)

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/route.ts (1)

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/send-paypal-payouts.ts (1)

sendPaypalPayouts (7-68)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build

🔇 Additional comments (6)

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/send-paypal-payouts.ts (1)

7-7: LGTM! Function signature simplification improves clarity.

The refactoring to accept invoiceId directly instead of a nested payload object makes the function interface cleaner and more explicit about its requirements.

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/send-stripe-payouts.ts (1)

12-12: LGTM! Consistent refactoring maintains code uniformity.

The function signature change is consistent with the PayPal payout function refactoring, ensuring uniform interfaces across the payout processing modules.

apps/web/app/(ee)/api/cron/payouts/charge-succeeded/route.ts (4)

5-5: LGTM! Proper import addition for inline schema.

The zod import is correctly added to support the inline schema definition.

11-13: LGTM! Inline schema simplification aligns with PR objectives.

The inline schema definition is appropriate for the simplified payload structure, maintaining type safety while reducing complexity.

24-24: LGTM! Direct destructuring improves readability.

The direct destructuring of invoiceId from the parsed payload is cleaner and more explicit than the previous nested approach.

58-64: LGTM! Function calls updated consistently.

The function calls are properly updated to pass invoiceId directly, maintaining consistency with the refactored function signatures in both payout modules.

✨ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

steven-tey · 2025-07-14T14:47:01Z

@CodeRabbit final review

coderabbitai · 2025-07-14T14:47:36Z

Tip

For best results, initiate chat on the files or code changes.

@steven-tey Looking good! This is a clean refactoring that successfully achieves the PR objective of simplifying payout processing to use invoiceId only.

Final Review Summary

✅ Changes are well-executed:

Simplified payload structure: Removed unused chargeId and achCreditTransfer fields
Consistent function signatures: Both sendStripePayouts and sendPaypalPayouts now accept { invoiceId } directly
Reduced complexity: Eliminated the shared utils.ts file and inlined the schema where it's used
Maintained type safety: Proper zod validation with the simplified inline schema

✅ Code quality improvements:

Direct destructuring of invoiceId improves readability
Function interfaces are more explicit about their requirements
Uniform approach across both Stripe and PayPal handlers

✅ All automated checks passed with 6 positive review comments covering:

Function signature improvements
Consistent refactoring approach
Proper import handling
Updated function calls

The refactoring maintains the same functionality while making the code more maintainable and easier to understand. Ready to merge! 🚀

🧠 Learnings used

Learnt from: devkiran
PR: dubinc/dub#2635
File: packages/prisma/schema/payout.prisma:24-25
Timestamp: 2025-07-11T16:28:55.654Z
Learning: In the Dub codebase, multiple payout records can now share the same stripeTransferId because payouts are grouped by partner and processed as single Stripe transfers. This is why the @unique constraint was removed from the stripeTransferId field in the Payout model - a single transfer can include multiple payouts for the same partner.

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-25T21:20:59.837Z
Learning: In the Dub codebase, payout limit validation uses a two-stage pattern: server actions perform quick sanity checks (payoutsUsage > payoutsLimit) for immediate user feedback, while the cron job (/cron/payouts) performs authoritative validation (payoutsUsage + payoutAmount > payoutsLimit) with actual calculated amounts before processing. This design provides fast user feedback while ensuring accurate limit enforcement at transaction time.

Refactor payout processing to use invoiceId only

148000d

Simplifies the payload for payout processing by removing unused fields and the shared utils file

devkiran requested a review from steven-tey July 14, 2025 08:52

vercel bot deployed to Preview July 14, 2025 09:02 View deployment

steven-tey approved these changes Jul 14, 2025

View reviewed changes

steven-tey merged commit 8205796 into main Jul 14, 2025
9 checks passed

steven-tey deleted the payout-cleanups branch July 14, 2025 14:48

coderabbitai bot mentioned this pull request Jul 30, 2025

Improve payout success state #2695

Merged

coderabbitai bot mentioned this pull request Sep 25, 2025

Add source_transaction to stripe.transfers.create #2888

Merged

coderabbitai bot mentioned this pull request Oct 25, 2025

Handle payouts in batches of 100 #3002

Merged

This was referenced Nov 3, 2025

Refactor Stripe payout to use QStash workflow #3037

Closed

Refactor Stripe payouts flow to use queue setup #3058

Merged

External payouts #3033

Merged

coderabbitai bot mentioned this pull request Nov 15, 2025

Filter out invalid recipients from batch email sends #3113

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor payout processing to use invoiceId only #2643

Refactor payout processing to use invoiceId only #2643

Uh oh!

devkiran commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 14, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

steven-tey commented Jul 14, 2025

Uh oh!

coderabbitai bot commented Jul 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Refactor payout processing to use invoiceId only #2643

Refactor payout processing to use invoiceId only #2643

Uh oh!

Conversation

devkiran commented Jul 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

steven-tey commented Jul 14, 2025

Uh oh!

coderabbitai bot commented Jul 14, 2025

Final Review Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

devkiran commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 14, 2025 •

edited

Loading

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)