Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add optional description field to commission creation #2724

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.

Sign up for GitHub

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

Jump to bottom
Merged
steven-tey merged 1 commit into from
Aug 7, 2025
Merged

Add optional description field to commission creation #2724

steven-tey merged 1 commit into from
Aug 7, 2025

Conversation

@devkiran
Copy link
Collaborator

@devkiran devkiran commented Aug 7, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Added an optional "description" field to the custom commission sheet form, with a 190-character limit, live character count, and error styling.
  • Enhancements
    • The "description" field now supports empty values and improved handling for null or empty input.

@vercel
Copy link
Contributor

vercel bot commented Aug 7, 2025 •
edited
Loading

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

Name Status Preview Updated (UTC)
dub ✅ Ready (Inspect) Visit Preview Aug 7, 2025 6:13am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 7, 2025 •
edited
Loading

Walkthrough

A new optional "description" field has been introduced to the custom commission creation flow. This includes updating the frontend form to accept and display the field, modifying backend action handlers to process it, and updating the relevant function signature to allow null values for the description.

Changes

Cohort / File(s) Change Summary
Frontend Form Update
apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/create-commission-sheet.tsx		 Added a "description" textarea to the custom commission form, supporting max 190 characters, live character count, and error styling.
Backend Action Handling
apps/web/lib/actions/partners/create-commission.ts		 Extended the action handler to extract and forward the new description field when creating a custom commission.
Function Signature Update
apps/web/lib/partners/create-partner-commission.ts		 Updated createPartnerCommission to accept description as `string

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend (Form)
    participant Backend Action
    participant Commission Service

    User->>Frontend (Form): Fill out commission form (incl. description)
    Frontend (Form)->>Backend Action: Submit form data (incl. description)
    Backend Action->>Commission Service: createPartnerCommission(..., description)
    Commission Service-->>Backend Action: Commission created
    Backend Action-->>Frontend (Form): Response
    Frontend (Form)-->>User: Show result
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • Manual commissions #2517: Refactors the commission sheet UI and state management, affecting overlapping files but not specifically the "description" field.

Suggested reviewers

  • steven-tey

Poem

In the garden of forms, a field now grows,
A place for thoughts, where description flows.
With character counts and a gentle touch,
Rabbits code onward—never too much!
Hop, hop, hooray for details anew,
Commission sheets now feel fresh as dew! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 28a08ed and 230c209.

📒 Files selected for processing (3)
  • apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/create-commission-sheet.tsx (3 hunks)
  • apps/web/lib/actions/partners/create-commission.ts (2 hunks)
  • apps/web/lib/partners/create-partner-commission.ts (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: in apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx, the form schema uses partial condition ob... 
Learnt from: TWilson023
PR: dubinc/dub#2673
File: apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx:56-66
Timestamp: 2025-07-30T15:25:13.936Z
Learning: In apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx, the form schema uses partial condition objects to allow users to add empty/unconfigured condition fields without type errors, while submission validation uses strict schemas to ensure data integrity. This two-stage validation pattern improves UX by allowing progressive completion of complex forms.

Applied to files:

  • apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/create-commission-sheet.tsx
📚 Learning: in apps/web/ui/partners/rewards/rewards-logic.tsx, when setting the entity field in a reward conditi... 
Learnt from: TWilson023
PR: dubinc/dub#2673
File: apps/web/ui/partners/rewards/rewards-logic.tsx:268-275
Timestamp: 2025-07-30T15:29:54.131Z
Learning: In apps/web/ui/partners/rewards/rewards-logic.tsx, when setting the entity field in a reward condition, dependent fields (attribute, operator, value) should be reset rather than preserved because different entities (customer vs sale) have different available attributes. Maintaining existing fields when the entity changes would create invalid state combinations and confusing UX.

Applied to files:

  • apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/create-commission-sheet.tsx
  • apps/web/lib/actions/partners/create-commission.ts
⏰ 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/lib/actions/partners/create-commission.ts (2)

37-37: LGTM!

The addition of the description field to the destructuring pattern is correct and follows the existing code structure.

67-67: LGTM!

The description parameter is correctly passed to createPartnerCommission for custom commission creation. The placement within the conditional branch is appropriate.

apps/web/lib/partners/create-partner-commission.ts (1)

50-50: LGTM!

The type update to include null is correct and aligns with the frontend form logic that converts empty strings to null. This ensures type compatibility across the commission creation flow.

apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/commissions/create-commission-sheet.tsx (3)

78-78: LGTM!

The addition of description to the watch array and destructuring follows the established pattern for form field monitoring.

Also applies to: 88-88

371-404: LGTM!

The description textarea implementation is well-designed with:

  • Clear labeling indicating the field is optional
  • Live character count feedback (0/190)
  • Proper error styling and validation
  • Correct form registration with empty string to null conversion
  • Reasonable 190 character limit

The implementation follows established UI patterns and integrates properly with the form validation system.

302-408: Good integration scope for custom commissions only.

The description field is appropriately scoped to appear only for custom commission types. The field correctly doesn't affect form submission validation since it's optional, and no special transformation is needed in the onSubmit handler.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch create-commission-add-description

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

Support

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

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 generate unit tests to generate unit tests for 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.

@devkiran devkiran requested a review from steven-tey August 7, 2025 06:08
@steven-tey steven-tey merged commit 8cb187a into main Aug 7, 2025
9 checks passed
@steven-tey steven-tey deleted the create-commission-add-description branch August 7, 2025 16:00
@coderabbitai coderabbitai bot mentioned this pull request Aug 29, 2025
Merged
This was referenced Sep 11, 2025
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 8, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@steven-tey steven-tey steven-tey approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@devkiran @steven-tey