Skip to content

fix: format apis overview numbers#2930

Merged
chronark merged 3 commits intomainfrom
format-apis-overview-numbers
Mar 3, 2025
Merged

fix: format apis overview numbers#2930
chronark merged 3 commits intomainfrom
format-apis-overview-numbers

Conversation

@ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Mar 3, 2025

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)
  • 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

  • Style
    • Simplified the responsive grid layout for a more consistent display on medium to extra-large screens.
    • Enhanced numerical stats presentation with standardized number formatting for improved readability.
    • Updated card layouts with adjusted spacing, chart sizing, and element widths to deliver a cleaner interface.

@changeset-bot
Copy link

changeset-bot bot commented Mar 3, 2025

⚠️ No Changeset found

Latest commit: ef03bef

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 3, 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 3, 2025 6:27pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 3, 2025 6:27pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 3, 2025 6:27pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 3, 2025 6:27pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 3, 2025

📝 Walkthrough

Walkthrough

This pull request refines the UI elements within the dashboard by adjusting layout and styling properties as well as enhancing the presentation of numeric data. In the RatelimitClient component, grid column classes have been simplified by removing smaller screen-specific classes in favor of a streamlined responsive design. Meanwhile, the StatsCard components now leverage a number formatting utility for count displays and undergo several layout adjustments including modified spacing, widths, and container heights.

Changes

File(s) Change Summary
apps/dashboard/app/(app)/.../ratelimits/_components/ratelimit-client.tsx Removed sm:grid-cols-2 and lg:grid-cols-3 classes; applied md:grid-cols-2, xl:grid-cols-3, and 2xl:grid-cols-4 to simplify the responsive grid layout.
apps/dashboard/components/stats-card/... MetricStats: Introduced formatNumber from @/lib/fmt to format successCount and errorCount.
StatsCard: Increased chart container height; adjusted spacing and element widths; removed flex-wrap and ml-auto classes to modify layout behavior.

Suggested labels

Bug, Improvement, Needs Approval

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr

📜 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 ad02627 and ef03bef.

📒 Files selected for processing (3)
  • apps/dashboard/app/(app)/ratelimits/_components/ratelimit-client.tsx (1 hunks)
  • apps/dashboard/components/stats-card/components/metric-stats.tsx (2 hunks)
  • apps/dashboard/components/stats-card/index.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Packages / Test ./internal/resend
  • GitHub Check: Test Packages / Test ./internal/keys
  • GitHub Check: Test Packages / Test ./internal/id
  • GitHub Check: Test Packages / Test ./internal/hash
  • GitHub Check: Test Packages / Test ./internal/encryption
  • GitHub Check: Test Go API Local / test_agent_local
  • GitHub Check: Test Packages / Test ./internal/billing
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Build / Build
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (9)
apps/dashboard/components/stats-card/components/metric-stats.tsx (2)

1-1: Good improvement to number formatting

Adding the formatNumber utility is a good approach for standardizing number formatting throughout the application.


18-18: Nice enhancement to readability

Using formatNumber for both success and error counts will improve readability, especially for large numbers that will now be properly formatted with thousand separators.

Also applies to: 25-25

apps/dashboard/app/(app)/ratelimits/_components/ratelimit-client.tsx (1)

40-40: Good simplification of responsive grid classes

Removing redundant breakpoints (sm:grid-cols-2 and lg:grid-cols-3) simplifies the responsive layout while maintaining the same functionality. This creates a more streamlined progression of layout changes across screen sizes.

apps/dashboard/components/stats-card/index.tsx (6)

28-28: Good adjustment to chart container height

Increasing the chart height from 120px to 140px provides more vertical space for data visualization, which should improve readability of the charts.


30-30: Improved spacing between elements

Changing from gap-1 to gap-2 provides better spacing between elements in the card content, which improves visual hierarchy and readability.


31-32: Better container structure

Removing flex-wrap and adjusting the flex container structure ensures content doesn't wrap unexpectedly, providing a more consistent layout across different screen sizes.


37-37: Improved text truncation handling

Increasing the width constraints for name (220px → 280px on md screens) and secondary ID (240px → 300px on md screens) provides more space for these important identifiers, reducing unnecessary truncation while still maintaining a clean layout.

Also applies to: 49-49


59-59: Cleaner alignment for right content

Removing ml-auto from the right content container in favor of the flex layout properties in the parent container creates a more consistent and maintainable spacing approach.


61-61: Better stats container layout

Adding w-full justify-between with appropriate gap spacing ensures the stats are properly distributed across the available space, and the additional mt-2 provides better vertical separation from the content above.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.

@ogzhanolguncu ogzhanolguncu changed the title Format apis overview numbers fix: format apis overview numbers Mar 3, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2025

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

@vercel vercel bot temporarily deployed to Preview – play March 3, 2025 18:23 Inactive
@vercel vercel bot temporarily deployed to Preview – engineering March 3, 2025 18:24 Inactive
@vercel vercel bot temporarily deployed to Preview – www March 3, 2025 18:25 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard March 3, 2025 18:27 Inactive
@chronark chronark added this pull request to the merge queue Mar 3, 2025
Merged via the queue into main with commit 3f1dbed Mar 3, 2025
30 checks passed
@chronark chronark deleted the format-apis-overview-numbers branch March 3, 2025 18:30
@coderabbitai coderabbitai bot mentioned this pull request Mar 18, 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