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

Walkthrough

This change introduces support for "clawbacks"—negative commissions—across the commissions and payouts system. It adds UI components for creating clawbacks, updates backend logic and schemas to handle negative earnings, and enhances tables to display reasons for clawbacks with tooltips. Filtering and aggregation logic is broadened to include both positive and negative (non-zero) earnings.

Changes

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI (Dashboard)
    participant CreateClawbackSheet
    participant Backend (createClawbackAction)
    participant DB

    User->>UI (Dashboard): Click "Create clawback"
    UI (Dashboard)->>CreateClawbackSheet: Open sheet/modal
    User->>CreateClawbackSheet: Fill partner, amount, reason, submit
    CreateClawbackSheet->>Backend (createClawbackAction): Submit validated data
    Backend (createClawbackAction)->>DB: Create negative commission (clawback)
    DB-->>Backend (createClawbackAction): Success/Failure
    Backend (createClawbackAction)-->>CreateClawbackSheet: Response
    CreateClawbackSheet-->>UI (Dashboard): Show toast, refresh commissions

sequenceDiagram
    participant Cron
    participant Backend (create-payout)
    participant DB

    Cron->>Backend (create-payout): Trigger payout creation
    Backend (create-payout)->>DB: Query positive commissions (earnings > 0)
    Backend (create-payout)->>DB: Query negative commissions (earnings < 0)
    DB-->>Backend (create-payout): Return commissions and clawbacks
    Backend (create-payout)->>DB: Create payout, update all commissions/clawbacks
    DB-->>Backend (create-payout): Success

Possibly related PRs

• Set amount to zero for custom commissions #2530: Modifies createPartnerCommission function by adjusting handling of the amount variable for custom event types; related as both PRs update the same function but address different aspects.

Poem

In the land of carrots and code so bright,
Clawbacks hop in, both left and right.
Negative numbers now join the fun,
With tooltips and sheets for everyone.
Earnings in red, reasons explained—
The commission garden, newly maintained!
🥕✨

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.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.4m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.3m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.4m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.5m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.4m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.8m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.7m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.8m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.4m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.4m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.5m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2525:

• ✅ All tests passed
• Tests completed in 3.8m
• View detailed report

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

@CodeRabbit final review

#!/bin/bash
# Let's examine the key files to conduct a thorough final review

# 1. Check the main clawback creation action for security and validation
echo "=== Clawback Creation Action ==="
cat apps/web/lib/actions/partners/create-clawback.ts

echo -e "\n=== Clawback Schema ==="
cat apps/web/lib/zod/schemas/commissions.ts

echo -e "\n=== Commission Popover Buttons ==="
cat apps/web/app/app.dub.co/\(dashboard\)/\[slug\]/\(ee\)/program/commissions/commission-popover-buttons.tsx

echo -e "\n=== Create Clawback Sheet ==="
head -50 apps/web/app/app.dub.co/\(dashboard\)/\[slug\]/\(ee\)/program/commissions/create-clawback-sheet.tsx

#!/bin/bash
# Continue examining key implementation details

echo "=== Payout Creation Logic ==="
cat apps/web/app/\(ee\)/api/cron/payouts/create-payout.ts

echo -e "\n=== Commission Table Changes ==="
head -80 apps/web/app/app.dub.co/\(dashboard\)/\[slug\]/\(ee\)/program/commissions/commission-table.tsx

echo -e "\n=== API Route Changes - Commissions ==="
cat apps/web/app/\(ee\)/api/commissions/route.ts

#!/bin/bash
# Check a few more critical details for the final review

echo "=== Commission Table Cell Rendering ==="
# Get the specific cell rendering logic for commissions
grep -A 20 -B 5 "Commission.*cell\|earnings.*cell\|amount.*cell" apps/web/app/app.dub.co/\(dashboard\)/\[slug\]/\(ee\)/program/commissions/commission-table.tsx

echo -e "\n=== Create Partner Commission Function ==="
cat apps/web/lib/partners/create-partner-commission.ts

echo -e "\n=== Sync Total Commissions Logic ==="
cat apps/web/lib/api/partners/sync-total-commissions.ts

#!/bin/bash
# Get the actual table column definitions to see the cell rendering
echo "=== Commission Table Column Definitions ==="
grep -A 50 "columns.*=\|useTable\|cell:" apps/web/app/app.dub.co/\(dashboard\)/\[slug\]/\(ee\)/program/commissions/commission-table.tsx

echo -e "\n=== Check for any validation issues in schemas ==="
# Look for potential validation gaps
grep -n "gt\|lt\|min\|max" apps/web/lib/zod/schemas/commissions.ts

@steven-tey Excellent work on this clawback implementation! 🎉 After conducting a comprehensive final review, I'm impressed with the thoroughness and quality of this feature. Here's my assessment:

✅ Strengths & Implementation Quality

🔒 Security & Validation

• Proper authentication with authActionClient and comprehensive input validation
• Partner enrollment verification before clawback creation
• Well-structured Zod schemas with meaningful error messages

🏗️ Architecture & Data Consistency

• Consistent database query changes across all endpoints (earnings != 0 instead of > 0)
• Proper separation of positive commissions and negative clawbacks in payout logic
• Smart handling of holding periods (clawbacks processed immediately, commissions wait for holding period)

💻 User Experience

• Excellent visual indicators: negative earnings displayed in red
• Helpful tooltips showing clawback reasons using CLAWBACK_REASONS_MAP
• Intuitive form with proper validation and loading states
• Clear commission table enhancements with proper styling

🔧 Edge Case Handling

• Banned partner logic properly cancels positive commissions
• Proper aggregation including both positive and negative earnings
• Correct commission creation logic for custom events

🎯 Key Implementation Highlights

// Smart payout logic separating commissions and clawbacks
const [commissions, clawbacks] = await Promise.all([
  // Commissions wait for holding period
  prisma.commission.findMany({
    where: { earnings: { gt: 0 }, ...commonWhere, ...holdingPeriodFilter },
  }),
  // Clawbacks processed immediately
  prisma.commission.findMany({
    where: { earnings: { lt: 0 }, ...commonWhere },
  }),
]);

// Excellent UI feedback with tooltips
if (commission.description) {
  const reason = CLAWBACK_REASONS_MAP[commission.description]?.description;
  return (
    <Tooltip content={reason}>
      <span className={cn("underline decoration-dotted", 
        commission.earnings < 0 && "text-red-600")}>
        {earnings}
      </span>
    </Tooltip>
  );
}

🚀 Ready for Production

The implementation demonstrates:

• ✅ Comprehensive testing (all automated tests passing)
• ✅ Proper error handling and validation
• ✅ Consistent data flow from frontend to database
• ✅ Excellent user experience considerations
• ✅ Maintainable and well-structured code

This clawback feature is production-ready and follows excellent engineering practices. The integration between positive commissions and negative clawbacks is seamless, and the user interface provides clear visual feedback for different types of earnings.

Outstanding work on delivering a feature that's both technically sound and user-friendly! 🎉