Skip to content

fix: prevent cancellations if the org has multiple members#3099

Merged
chronark merged 1 commit intomainfrom
prevent-cancelling-with-members
Apr 10, 2025
Merged

fix: prevent cancellations if the org has multiple members#3099
chronark merged 1 commit intomainfrom
prevent-cancelling-with-members

Conversation

@chronark
Copy link
Collaborator

@chronark chronark commented Apr 10, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced the subscription cancellation process by introducing a validation step that checks the number of organization members. Now, only organizations with a single member can successfully downgrade to a free plan. If more than one member is detected or an issue occurs during data retrieval, users will receive an error message guiding them through the proper process.

@vercel
Copy link

vercel bot commented Apr 10, 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 Apr 10, 2025 8:19am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 10, 2025 8:19am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 10, 2025 8:19am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 10, 2025 8:19am

@changeset-bot
Copy link

changeset-bot bot commented Apr 10, 2025

⚠️ No Changeset found

Latest commit: 260b8ff

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 10, 2025

📝 Walkthrough

Walkthrough

The changes update the cancellation process for subscriptions. The cancelSubscription procedure now validates the organization’s member list by retrieving it via the auth module and checking if there is only one member. If the retrieval fails, an internal server error is thrown. If more than one member exists, a precondition error is returned, preventing a downgrade to the free tier. The code continues to maintain its existing error handling for Stripe setup and identifier checks.

Changes

File Path Change Summary
apps/dashboard/lib/trpc/routers/stripe/.../cancelSubscription.ts Added an import for the auth module and integrated a membership check. Retrieves organization members via getOrganizationMemberList and throws a TRPCError for errors or if multiple members exist, before proceeding with the Stripe subscription cancellation logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant TS as cancelSubscription Procedure
    participant Auth as Auth Module
    participant Stripe as Stripe Service

    Client->>TS: Request subscription cancellation
    TS->>Auth: getOrganizationMemberList(ctx.workspace.orgId)
    alt Retrieval Error
        Auth-->>TS: Error
        TS-->>Client: Send TRPCError("INTERNAL_SERVER_ERROR")
    else Retrieval OK
        Auth-->>TS: Member List
        alt More than one member
            TS-->>Client: Send TRPCError("PRECONDITION_FAILED")
        else Single member
            TS->>Stripe: Proceed with cancellation
            Stripe-->>TS: Confirmation
            TS-->>Client: Success response
        end
    end
Loading
✨ 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 plan to trigger planning for file edits and PR creation.
  • @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 Apr 10, 2025

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

@vercel vercel bot temporarily deployed to Preview – engineering April 10, 2025 08:15 Inactive
@vercel vercel bot temporarily deployed to Preview – play April 10, 2025 08:15 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 (1)
apps/dashboard/lib/trpc/routers/stripe/cancelSubscription.ts (1)

22-28: Effectively prevents subscription cancellations for multi-member organizations.

This validation logic successfully implements the PR objective of preventing subscription cancellations when an organization has multiple members. The error message is clear and instructive, explaining that other members must be removed before downgrading to the free tier.

You might consider adding a small defensive check to ensure memberships.data exists before accessing its length property:

-    if (memberships.data.length > 1) {
+    if (memberships.data?.length > 1) {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3db88bd and 260b8ff.

📒 Files selected for processing (1)
  • apps/dashboard/lib/trpc/routers/stripe/cancelSubscription.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: Test Go API Local / Test (Shard 8/8)
  • GitHub Check: Test Go API Local / Test (Shard 5/8)
  • GitHub Check: Test Go API Local / Test (Shard 1/8)
  • GitHub Check: Test Packages / Test ./internal/resend
  • GitHub Check: Test Packages / Test ./apps/dashboard
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test Packages / Test ./packages/api
  • GitHub Check: Test Packages / Test ./internal/encryption
  • GitHub Check: Test Packages / Test ./internal/billing
  • GitHub Check: Test Packages / Test ./internal/id
  • GitHub Check: Test Packages / Test ./internal/hash
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Build / Build
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
apps/dashboard/lib/trpc/routers/stripe/cancelSubscription.ts (2)

1-1: Import for organization member validation added correctly.

The auth module import is appropriately added to enable the new organization membership check functionality.


15-21: Good error handling for organization member retrieval.

The implementation correctly retrieves the organization's member list and handles potential errors appropriately. The error is logged for debugging purposes and translated into a meaningful TRPC error with a clear message for the client.

@vercel vercel bot temporarily deployed to Preview – www April 10, 2025 08:18 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard April 10, 2025 08:19 Inactive
@chronark chronark enabled auto-merge April 10, 2025 09:33
Copy link
Member

The tRPC error is enough no?

@chronark
Copy link
Collaborator Author

The tRPC error is enough no?
it will show us that something happened, not the actual error

@chronark chronark added this pull request to the merge queue Apr 10, 2025
Merged via the queue into main with commit 3be376a Apr 10, 2025
33 of 39 checks passed
@chronark chronark deleted the prevent-cancelling-with-members branch April 10, 2025 12:32
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