Skip to content

fix: wording and style issues#3235

Merged
chronark merged 3 commits intomainfrom
bug-fixes-keys
May 9, 2025
Merged

fix: wording and style issues#3235
chronark merged 3 commits intomainfrom
bug-fixes-keys

Conversation

@ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented May 8, 2025

What does this PR do?

  • Fixes plural/singular wording issue for key deletion
  • Removes toast for success key creation, because we are already showing a success dialog.
  • Fixes scroll and overflow issues for small screen for our key creation and update dialogs
  • Changes external Id to bold instead of identity Id, because people are searching for external not identity Id.
    image

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?

  • Check external Id creation or update screen to see if External Ids are more prominent than Identity Ids.
  • Check dialogs scrolls in smaller screens for key creation, key edits or dialogs in general(They all use the same component).
  • Create a key then see if it throws a toast. It shouldn't now.
  • When keys are deleted depending on singularity messages will prompt correctly. If its single it will say A key has been deleted bla bla if its plural it will say X keys have been

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

  • Bug Fixes

    • Improved dialog and container behavior by adding maximum height constraints and enabling vertical scrolling, ensuring better accessibility for overflowing content.
    • Updated visual styling for identity labels in dropdown options for clearer distinction and improved readability.
  • Enhancements

    • Success and error notifications for key deletion now provide clear, plural-aware feedback and warnings for partial deletions.
    • Removed the success toast notification when creating a new key for a less intrusive user experience.
  • Style

    • Adjusted layout and overflow styles for dialogs and containers to enhance usability and content visibility.
    • Removed fixed height and scroll constraints from the ratelimit fields container to allow natural expansion.

@changeset-bot
Copy link

changeset-bot bot commented May 8, 2025

⚠️ No Changeset found

Latest commit: 9c71117

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 May 8, 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 9, 2025 9:51am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
engineering ⬜️ Ignored (Inspect) Visit Preview May 9, 2025 9:51am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 8, 2025

📝 Walkthrough

Walkthrough

This update modifies the visual behavior and user feedback for dialogs and key management actions in the dashboard application. It adjusts dialog container heights and scrolling, updates toast notifications for key deletion and creation, and refines the styling of identity option labels. No changes are made to exported function signatures.

Changes

Files / File Groups Change Summary
apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/components/ratelimit-setup.tsx Removed fixed max height and vertical scroll CSS classes from the ratelimit fields container, allowing it to expand without scroll constraints.
apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/hooks/use-create-key.tsx Removed the success toast notification after key creation; only cache invalidation and callback remain on success.
apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/hooks/use-fetch-identities/create-identity-options.tsx Updated CSS classes for identity labels in the identity options UI, changing text colors and font weights for improved visual distinction; no logic changes.
apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/index.tsx Added max-h-[90vh] and overflow-y-auto classes to the dialog, constraining its height to 90% of the viewport and enabling vertical scrolling within the dialog.
apps/dashboard/components/dialog-container/dialog-container.tsx Replaced overflow-hidden with max-h-[90vh] overflow-y-auto for dialog content, enabling scrolling and height constraint instead of hiding overflow.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/_components/components/table/components/actions/components/hooks/use-delete-key.ts Enhanced deletion mutation to provide plural-aware toast notifications for both success and error states, with warnings for partial deletions; error messages now reflect the number of keys affected.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DashboardUI
    participant DialogContainer
    participant ToastSystem

    User->>DashboardUI: Initiate key creation/deletion or open dialog

    alt Key Creation Success
        DashboardUI->>DashboardUI: Invalidate keys cache, call onSuccess
        Note right of DashboardUI: No success toast shown (toast removed)
    end

    alt Key Deletion Success
        DashboardUI->>ToastSystem: Show success toast (singular/plural)
        alt Partial Deletion
            DashboardUI->>ToastSystem: Show warning toast for missing keys
        end
        DashboardUI->>DashboardUI: Invalidate keys cache, call onSuccess
    end

    alt Key Deletion Error
        DashboardUI->>ToastSystem: Show error toast (singular/plural)
    end

    User->>DialogContainer: Open dialog
    DialogContainer->>DialogContainer: Apply max height and scrolling
Loading

Possibly related PRs

  • feat: Show keyId after creating a new key #2107: Both PRs modify the user feedback mechanism after key creation, one by removing the toast notification and the other by adding a persistent UI element to display the key ID, indicating a shared focus on key creation feedback.

Suggested labels

Bug, Needs Approval

Suggested reviewers

  • perkinsjr
  • chronark
  • mcstepp

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 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 2f4765e and 9c71117.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/hooks/use-fetch-identities/create-identity-options.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/hooks/use-fetch-identities/create-identity-options.tsx
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Packages / Test ./internal/resend
  • GitHub Check: Analyze (javascript-typescript)
✨ 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.

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.

@github-actions
Copy link
Contributor

github-actions bot commented May 8, 2025

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

@chronark
Copy link
Collaborator

chronark commented May 9, 2025

@ogzhanolguncu sorry that's on me, I wanted to also switch the order but didn't say that.

currently it is:
CleanShot 2025-05-09 at 11 29 44@2x

but I wanted

[ (icon) user_123 id_123 ]

rest looks nice

Copy link
Contributor Author

lemme see

Copy link
Contributor Author

ahh no big deal i'll do it in 5

@chronark chronark self-assigned this May 9, 2025
@chronark chronark added this pull request to the merge queue May 9, 2025
Merged via the queue into main with commit 633fe19 May 9, 2025
31 checks passed
@chronark chronark deleted the bug-fixes-keys branch May 9, 2025 09:57
@coderabbitai coderabbitai bot mentioned this pull request May 13, 2025
18 tasks
@coderabbitai coderabbitai bot mentioned this pull request May 29, 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