Skip to content

chore: Radar prep #3269

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.

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

Merged
merged 2 commits into from
May 18, 2025
Merged

chore: Radar prep #3269

merged 2 commits into from
May 18, 2025

Conversation

perkinsjr
Copy link
Collaborator

@perkinsjr perkinsjr commented May 18, 2025

Add a r/l to radar

What does this PR do?

Radar prep for future

Fixes # (issue)

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 rate limiting when resending authentication codes to enhance security and prevent abuse. Users exceeding the limit will receive a message instructing them to contact support.
    • Added a new error message for rate limit violations: "Limited OTP attempts".
  • Bug Fixes

    • Improved error handling when resending authentication codes, ensuring users receive clear feedback if the operation fails.

Copy link

changeset-bot bot commented May 18, 2025

⚠️ No Changeset found

Latest commit: 8776a39

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

Copy link

vercel bot commented May 18, 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 May 18, 2025 6:07am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
engineering ⬜️ Ignored (Inspect) Visit Preview May 18, 2025 6:07am

Copy link
Contributor

coderabbitai bot commented May 18, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes implement rate limiting for the resendAuthCode function using the @unkey/ratelimit package, preventing excessive resend attempts. A new error code and message for rate limiting are added to the authentication types. The useSignIn hook is updated to handle and display errors from the resend operation.

Changes

File(s) Change Summary
apps/dashboard/app/auth/actions.ts Added rate limiting to resendAuthCode using @unkey/ratelimit; updated imports; minor formatting change.
apps/dashboard/app/auth/hooks/useSignIn.ts Modified handleResendCode to handle and display errors from resendAuthCode.
apps/dashboard/lib/auth/types.ts Added RATE_ERROR to AuthErrorCode enum and corresponding message to errorMessages.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant useSignIn Hook
    participant resendAuthCode (actions.ts)
    participant Ratelimit
    participant Auth System

    User->>useSignIn Hook: Trigger handleResendCode
    useSignIn Hook->>resendAuthCode: Call with email
    resendAuthCode->>Ratelimit: Check rate limit for email
    alt Rate limit exceeded
        resendAuthCode-->>useSignIn Hook: Return failure (RATE_ERROR)
        useSignIn Hook-->>User: Display rate limit error
    else Within limit
        resendAuthCode->>Auth System: Resend auth code
        Auth System-->>resendAuthCode: Success/Failure
        resendAuthCode-->>useSignIn Hook: Return result
        useSignIn Hook-->>User: Display result or error
    end
Loading

📜 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 996c9a9 and 18ddf18.

📒 Files selected for processing (3)
  • apps/dashboard/app/auth/actions.ts (3 hunks)
  • apps/dashboard/app/auth/hooks/useSignIn.ts (1 hunks)
  • apps/dashboard/lib/auth/types.ts (2 hunks)
✨ 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.

Copy link
Contributor

github-actions bot commented May 18, 2025

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

@perkinsjr perkinsjr marked this pull request as ready for review May 18, 2025 13:18
@perkinsjr perkinsjr merged commit 03ed31f into main May 18, 2025
30 checks passed
@perkinsjr perkinsjr deleted the radar branch May 18, 2025 13:18
@coderabbitai coderabbitai bot mentioned this pull request Aug 21, 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.

1 participant