Restrict payout confirmation to workspace owners #2591

devkiran · 2025-06-30T10:05:49Z

limit the confirm payouts to workspace owners only

Summary by CodeRabbit

New Features
- Added role-based permissions for confirming payouts, restricting this action to workspace owners only.
- The "Confirm payouts" button now shows permission-related feedback in its tooltip when disabled for unauthorized users.

limit the confirm payouts to workspace owners only

vercel · 2025-06-30T10:05:54Z

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

Name	Status	Preview	Updated (UTC)
dub	✅ Ready (Inspect)	Visit Preview	Jun 30, 2025 6:18pm

coderabbitai · 2025-06-30T10:05:56Z

Walkthrough

This update implements a role-based permission system for confirming payouts. It introduces a new "payouts.write" permission, restricts payout confirmations to workspace owners, and updates UI and backend logic to enforce these checks. User roles are now surfaced more directly in context objects to support authorization.

Changes

File(s)	Change Summary
.../(dashboard)/[slug]/(ee)/program/payouts/payout-stats.tsx	Added `role` to workspace data destructuring in `PayoutStats` component.
.../ui/partners/payout-invoice-sheet.tsx	Added `role` destructure and permission check for "payouts.write" to control confirm payout UI.
.../actions/partners/confirm-payouts.ts	Added backend authorization: only "owner" role can confirm payouts; throws error otherwise.
.../actions/safe-action.ts	Added top-level `role` property on workspace context from first user’s role in `authActionClient`.
.../api/rbac/permissions.ts	Added "payouts.write" permission action and assigned it exclusively to "owner" role.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI (PayoutStats)
    participant Server (confirmPayoutsAction)
    participant Permissions

    User->>UI (PayoutStats): Attempt to confirm payouts
    UI (PayoutStats)->>Permissions: Check "payouts.write" for user role
    Permissions-->>UI (PayoutStats): Allow or deny (with error message)
    alt Permission granted
        UI (PayoutStats)->>Server (confirmPayoutsAction): Submit confirm payouts request
        Server (confirmPayoutsAction)->>Permissions: Validate user role is "owner"
        Permissions-->>Server (confirmPayoutsAction): Allow or throw error
        Server (confirmPayoutsAction)-->>UI (PayoutStats): Success or error
    else Permission denied
        UI (PayoutStats)-->>User: Show disabled button with tooltip
    end

Possibly related PRs

Fix payouts limit #2577: Related payout confirmation logic and authorization enhancements, overlapping with permission checks and limits.

Poem

🐇
In the land of payouts, permissions now rule,
Only owners may confirm—such is the new school.
Buttons grayed out for those lacking the might,
Roles checked in code, ensuring what’s right.
With a hop and a check, the system’s secure—
🐇 This bunny approves, of that you can be sure!

📜 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 0bbbfa6 and db225a0.

📒 Files selected for processing (2)

apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-stats.tsx (1 hunks)
apps/web/ui/partners/payout-invoice-sheet.tsx (5 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payout-stats.tsx

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-25T21:20:59.785Z
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/ui/partners/payout-invoice-sheet.tsx (1)

Learnt from: steven-tey
PR: dubinc/dub#0
File: :0-0
Timestamp: 2025-06-25T21:20:59.785Z
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.

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build

🔇 Additional comments (3)

apps/web/ui/partners/payout-invoice-sheet.tsx (3)

3-3: LGTM! Import statement is correct.

The import for clientAccessCheck is properly added to support the new permission checking functionality.

89-89: LGTM! Role destructuring enables permission checks.

Adding role to the destructured workspace properties provides the necessary user role information for the permission check.

360-364: LGTM! Permission check implementation is well-structured.

The clientAccessCheck implementation correctly validates the "payouts.write" permission with a clear custom description for user feedback.

✨ 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.

Restrict payout confirmation to workspace owners

3aadbee

limit the confirm payouts to workspace owners only

devkiran requested a review from steven-tey June 30, 2025 10:05

vercel bot deployed to Preview June 30, 2025 10:16 View deployment

Update safe-action.ts

0bbbfa6

vercel bot deployed to Preview June 30, 2025 13:00 View deployment

steven-tey approved these changes Jun 30, 2025

View reviewed changes

steven-tey added 2 commits June 30, 2025 10:55

Merge branch 'main' into rabc-confirmPayout

3682f9a

move clientAccessCheck to PayoutInvoiceSheet

db225a0

steven-tey approved these changes Jun 30, 2025

View reviewed changes

vercel bot deployed to Preview June 30, 2025 18:18 View deployment

steven-tey merged commit 27d1dcf into main Jun 30, 2025
8 checks passed

steven-tey deleted the rabc-confirmPayout branch June 30, 2025 18:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Restrict payout confirmation to workspace owners #2591

Restrict payout confirmation to workspace owners #2591

Uh oh!

devkiran commented Jun 30, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jun 30, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 30, 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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Restrict payout confirmation to workspace owners #2591

Restrict payout confirmation to workspace owners #2591

Uh oh!

Conversation

devkiran commented Jun 30, 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 Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jun 30, 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

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

devkiran commented Jun 30, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jun 30, 2025 •

edited

Loading

coderabbitai bot commented Jun 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)