Skip to content

fix: Add a check for teams so free users can't invite users... #3021

Merged
chronark merged 2 commits intomainfrom
workos-auth-migrator
Mar 22, 2025
Merged

fix: Add a check for teams so free users can't invite users... #3021
chronark merged 2 commits intomainfrom
workos-auth-migrator

Conversation

@perkinsjr
Copy link
Member

@perkinsjr perkinsjr commented Mar 21, 2025

What does this PR do?

Stops users from being able to invite users without being on a trial or paid tier.

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive team management interface with dynamic displays for members and pending invitations.
    • Enabled admin-specific actions, such as inviting new members and modifying user roles, with visual feedback for updates.
  • Refactor

    • Streamlined the team settings page to improve data fetching and simplify the display logic for a smoother user experience.

@changeset-bot
Copy link

changeset-bot bot commented Mar 21, 2025

⚠️ No Changeset found

Latest commit: 9f64655

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Mar 21, 2025

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 21, 2025 11:12pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 21, 2025 11:12pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 21, 2025 11:12pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 21, 2025 11:12pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 21, 2025

📝 Walkthrough

Walkthrough

This pull request introduces a new React component file for managing team settings and revises the related page component. The new file defines multiple components such as TeamPage, Members, Invitations, RoleSwitcher, and StatusBadge to handle different aspects of team management including role assignment, invitation handling, and conditional UI rendering based on user organization status. The existing page component is refactored to an asynchronous function, now named SettingsKeysPage, that retrieves team-related data before rendering the TeamPage.

Changes

File(s) Summary
apps/dashboard/app/(app)/settings/team/client.tsx Added new React components: TeamPage, Members, Invitations, RoleSwitcher, and StatusBadge for handling team settings, role management, and invitations, with conditional UI rendering based on user organization and workspace tier.
apps/dashboard/app/(app)/settings/team/page.tsx Refactored the existing team page by replacing the previous TeamPage component with an async SettingsKeysPage function. This function fetches the tenant ID and workspace, retrieves the team quota, and passes it as a prop to the TeamPage, simplifying the UI logic.

Sequence Diagram(s)

sequenceDiagram
  participant U as User
  participant SP as SettingsKeysPage
  participant DB as Database
  participant TP as TeamPage
  participant UI as Additional UI Components

  U->>SP: Request team settings page
  SP->>DB: Call getTenantId() and query workspace data
  DB-->>SP: Return tenant and workspace (team quota) data
  SP->>TP: Render TeamPage with team prop
  TP->>UI: Conditionally render Members, Invitations, RoleSwitcher, and StatusBadge
  UI-->>TP: Provide role updates, invitation management feedbacks
  TP-->>U: Display complete team management interface
Loading

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 150 points, hacktoberfest

Suggested reviewers

  • mcstepp
  • chronark
  • ogzhanolguncu
✨ 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.
    • 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.
  • @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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 21, 2025

Thank you for following the naming conventions for pull request titles! 🙏

@perkinsjr perkinsjr changed the title fix: Add a check for teams so free users can't create them... fix: Add a check for teams so free users can't invite users... Mar 21, 2025
@vercel vercel bot temporarily deployed to Preview – play March 21, 2025 23:08 Inactive
@vercel vercel bot temporarily deployed to Preview – www March 21, 2025 23:08 Inactive
@vercel vercel bot temporarily deployed to Preview – engineering March 21, 2025 23:09 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard March 21, 2025 23:12 Inactive
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 (3)
apps/dashboard/app/(app)/settings/team/page.tsx (1)

7-13: Consider handling missing workspace scenarios.

If no workspace is found, the code defaults ws to undefined. Downstream, this simply sets team to false. While functionally correct, you might improve user feedback by returning a clear message or redirect if there's no workspace.

apps/dashboard/app/(app)/settings/team/client.tsx (2)

213-275: Consider confirming invitation revocations.

Currently, invitation revocations happen immediately upon button click. Adding a confirmation step would be a nice UX enhancement and help prevent accidental revocations.

Here’s a sample diff to demonstrate adding a simple confirmation dialog:

<Button
  variant="destructive"
- onClick={async () => {
-   await invitation.revoke();
-   toast.success("Invitation revoked");
- }}
+ onClick={async () => {
+   if (confirm("Are you sure you want to revoke this invitation?")) {
+     await invitation.revoke();
+     toast.success("Invitation revoked");
+   }
+ }}
>
  Revoke
</Button>

276-328: RoleSwitcher logic is clear; consider more detailed user-facing error messages.

Currently, errors show only the raw exception message. You might want a more user-friendly fallback if the server returns unexpected errors.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 97703d2 and 9f64655.

📒 Files selected for processing (2)
  • apps/dashboard/app/(app)/settings/team/client.tsx (1 hunks)
  • apps/dashboard/app/(app)/settings/team/page.tsx (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
apps/dashboard/app/(app)/settings/team/page.tsx (1)
apps/dashboard/app/(app)/settings/team/client.tsx (1) (1)
  • TeamPage (48-140)
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: Test Go API Local / Test (Shard 6/8)
  • GitHub Check: Test Go API Local / Test (Shard 3/8)
  • GitHub Check: Test Go API Local / Test (Shard 7/8)
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Go API Local / Test (Shard 1/8)
  • GitHub Check: Test Go API Local / Test (Shard 2/8)
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test Packages / Test ./internal/keys
  • GitHub Check: Build / Build
🔇 Additional comments (9)
apps/dashboard/app/(app)/settings/team/page.tsx (4)

1-3: Imports look good.

These imports cleanly bring in required modules to fetch and render team data.


5-5: No-revalidate strategy is acceptable.

Disabling revalidation ensures fresh data on every request. Verify if dynamic real-time updates or caching might be beneficial in other scenarios.

Would you like to confirm if other pages or routes in your application need a similar no-revalidate approach for consistency?


15-15: Graceful fallback for team field is consistent.

Using the nullish coalescing to default to false is an elegant approach. No issues noted.


19-19: Clean integration with the TeamPage component.

The direct handoff of the team prop is straightforward for maintaining separate concerns between data fetching and UI rendering.

apps/dashboard/app/(app)/settings/team/client.tsx (5)

1-8: Client file creation looks good.

This file centralizes team-related UI and logic. The imports from external and internal libraries are well-organized.


49-73: Conditional checks align with the free-tier gating logic.

These conditions block invitations for free-tier or no-organization scenarios. This fulfills the PR objective of preventing free/workspace-less users from inviting members. No apparent logical issues.


98-126: Role-based UI actions are properly safeguarded.

The isAdmin check for revealing the invitations tab and invite button is a good practice. No concerns here.


142-211: Members listing and removal logic is efficient.

You handle loading states properly and confirm membership removal. The usage of Confirm for destructive actions is a commendable practice.


330-343: StatusBadge rendering meets the intended workflow.

The straightforward switch statement clarifies each invitation status. No issues noted.

@chronark chronark added this pull request to the merge queue Mar 22, 2025
Merged via the queue into main with commit c69db9e Mar 22, 2025
37 of 38 checks passed
@chronark chronark deleted the workos-auth-migrator branch March 22, 2025 13:29
@coderabbitai coderabbitai bot mentioned this pull request Apr 28, 2025
18 tasks
@coderabbitai coderabbitai bot mentioned this pull request May 28, 2025
18 tasks
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