unkey icon indicating copy to clipboard operation
unkey copied to clipboard

chore: ratelimit overview tooltip move to unkey ui and renamed

Open MichaelUnkey opened this issue 7 months ago • 8 comments

What does this PR do?

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)
  • [x] 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?

  • All previous <RatelimitOverviewTooltip /> uses still function with <OverviewTooltip />
  • Docs read well and convey how the component can be used.

Checklist

Required

  • [x] Filled out the "How to test" section in this PR
  • [x] Read Contributing Guide
  • [x] Self-reviewed my own code
  • [x] Commented on my code in hard-to-understand areas
  • [x] Ran pnpm build
  • [x] Ran pnpm fmt
  • [x] Checked for warnings, there are none
  • [x] Removed all console.logs
  • [x] Merged the latest changes from main onto my branch with git pull origin main
  • [x] 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 new OverviewTooltip component with enhanced positioning and styling options.
    • Added documentation and usage examples for the OverviewTooltip component.
  • Refactor

    • Replaced previous tooltip implementations with the new OverviewTooltip across the dashboard, simplifying tooltip usage while maintaining existing content and behavior.
  • Documentation

    • Added comprehensive documentation detailing the features and usage of the OverviewTooltip component.

MichaelUnkey avatar Apr 30 '25 13:04 MichaelUnkey

⚠️ No Changeset found

Latest commit: bfda6c20ad9270f23c75f445c9322994a40f07ca

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

changeset-bot[bot] avatar Apr 30 '25 13:04 changeset-bot[bot]

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 30, 2025 4:09pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
engineering ⬜️ Ignored (Inspect) Visit Preview May 30, 2025 4:09pm

vercel[bot] avatar Apr 30 '25 13:04 vercel[bot]

📝 Walkthrough

"""

Walkthrough

This change introduces a unified InfoTooltip component, replacing various previous tooltip implementations (including RatelimitOverviewTooltip and multi-component tooltips) throughout the codebase. The update standardizes tooltip usage, updates associated imports, and adjusts some tooltip styling. Documentation and example usage for InfoTooltip are also added. Additionally, several action buttons receive title attributes for improved accessibility.

Changes

Files/Paths (grouped) Change Summary
internal/ui/src/components/info-tooltip.tsx, internal/ui/src/index.ts Adds new InfoTooltip component and exports it from the UI library.
apps/engineering/content/design/components/info-tooltip.example.tsx, apps/engineering/content/design/components/info-tooltip.mdx Adds example usage and documentation for the new InfoTooltip component.
apps/dashboard/app/(app)/..., apps/dashboard/components/..., internal/ui/src/components/id.tsx Refactors all tooltip usages to use InfoTooltip instead of RatelimitOverviewTooltip or multi-component tooltips; updates imports and JSX accordingly.
internal/ui/src/components/tooltip.tsx Updates styling for base tooltip content (background, text color, padding, border radius, etc.).
apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/hooks/use-fetch-identities/create-identity-options.tsx, internal/ui/src/components/settings-card.tsx, internal/ui/src/components/date-time/components/time-split.tsx, apps/dashboard/components/stats-card/components/chart/stats-chart.tsx, internal/ui/src/components/timestamp-info.tsx Updates border and background color classes for tooltips and related components for improved visual consistency.
apps/dashboard/app/(app)/apis/_components/create-api-button.tsx, apps/dashboard/app/(app)/ratelimits/_components/create-namespace-button.tsx, apps/dashboard/app/(app)/ratelimits/[namespaceId]/namespace-navbar.tsx, apps/dashboard/app/(app)/authorization/roles/[roleId]/navigation.tsx, apps/dashboard/app/(app)/authorization/permissions/[permissionId]/navigation.tsx, apps/dashboard/app/(app)/apis/[apiId]/_components/create-key/index.tsx Adds title attributes to action buttons to improve accessibility and native tooltip support.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UIComponent
    participant InfoTooltip

    User->>UIComponent: Hover or focus on trigger element
    UIComponent->>InfoTooltip: Render with props (content, position, variant, etc.)
    InfoTooltip-->>User: Displays tooltip with specified content and styling
    User->>InfoTooltip: (Optional) Interact (e.g., click, copy)
    InfoTooltip-->>UIComponent: Handles tooltip visibility and disables if needed

Possibly related PRs

  • unkeyed/unkey#2697: Introduces an Id component that internally uses the new InfoTooltip, directly related to the tooltip refactor in this PR.

Suggested labels

🕹️ oss.gg

Suggested reviewers

  • perkinsjr
  • mcstepp
  • MichaelUnkey
  • chronark """

📜 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 e867ac6470e935efdb68226340d2e58ef2774972 and bfda6c20ad9270f23c75f445c9322994a40f07ca.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/_components/components/table/components/status-cell/index.tsx (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/_components/components/table/components/status-cell/index.tsx
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: Test Go API Local / Test (Shard 3/8)
  • GitHub Check: Test Go API Local / Test (Shard 6/8)
  • GitHub Check: Test Go API Local / Test (Shard 8/8)
  • GitHub Check: Test Go API Local / Test (Shard 4/8)
  • GitHub Check: Test Go API Local / Test (Shard 1/8)
  • GitHub Check: Test Go API Local / Test (Shard 5/8)
  • GitHub Check: Test Go API Local / Test (Shard 2/8)
  • GitHub Check: Test Go API Local / Test (Shard 7/8)
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Build / Build
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test Packages / Test ./packages/api
  • GitHub Check: autofix
  • 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.
    • 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.

coderabbitai[bot] avatar Apr 30 '25 13:04 coderabbitai[bot]

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

github-actions[bot] avatar Apr 30 '25 13:04 github-actions[bot]

@MichaelUnkey we have similar component in the dashboard scattered around. Can you quickly check them out? you the same className to search for similar items

ogzhanolguncu avatar Apr 30 '25 13:04 ogzhanolguncu

FYI my session refresh stuff (with the change to getOrgId => getAuth is about to be merged, so you'll have to pull from main and rebase soon

mcstepp avatar Apr 30 '25 14:04 mcstepp

Rebase away everyone it is in main.

perkinsjr avatar Apr 30 '25 14:04 perkinsjr

I think we should work on that name. The reason why it's called RatelimitOverview was because that's being used for Overview of Ratelimit requests.

I think those two are better options:

InfoTooltip DetailTooltip

wdyt?

ogzhanolguncu avatar May 01 '25 21:05 ogzhanolguncu

Dashboard looks okay. The only thing that bothers me is this file internal/ui/src/components/tooltip.tsx. I'm not sure if we've discussed that before, but can you compare padding and border changes against prod? Then lemme know so we can merge it today

ogzhanolguncu avatar May 30 '25 16:05 ogzhanolguncu