Skip to content
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

fix: ratelimits ui filters and logs ordering #2811

Merged
merged 2 commits into from
Jan 13, 2025
Merged

Conversation

chronark
Copy link
Collaborator

@chronark chronark commented Jan 13, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced rate limit logs filtering by adding an option to filter logs based on pass/fail status.
    • Improved date selection in the rate limit logs interface to prevent selecting future dates.
  • Bug Fixes

    • Updated button styling and interaction in the rate limit logs filter component.
  • Refactor

    • Modified date picker and filter component to use a more consistent styling approach.
    • Reformatted package.json files across multiple packages for improved consistency.

Copy link

vercel bot commented Jan 13, 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 Jan 13, 2025 3:02pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 13, 2025 3:02pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 13, 2025 3:02pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 13, 2025 3:02pm

Copy link

changeset-bot bot commented Jan 13, 2025

⚠️ No Changeset found

Latest commit: 893baea

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
Contributor

coderabbitai bot commented Jan 13, 2025

📝 Walkthrough

Walkthrough

This pull request introduces modifications to several files, notably apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx and internal/clickhouse/src/ratelimits.ts. The changes include updating the button styling in the frontend Filters component and enhancing the backend getRatelimitLogs function with an optional passed parameter to filter logs based on ratelimit success or failure. Additionally, formatting adjustments were made to the package.json files of various packages for consistency.

Changes

File Change Summary
apps/dashboard/.../filter.tsx - Updated import to include buttonVariants
- Replaced Button components with styled div elements
- Modified DateTimePicker to disable future date selection
internal/clickhouse/src/ratelimits.ts - Added optional passed parameter to getRatelimitLogsParameters
- Updated getRatelimitLogs to conditionally filter logs based on passed
- Added explicit ordering of results by time in descending order
packages/api/package.json - Reformatted keywords and files fields to single-line structure
packages/hono/package.json - Reformatted keywords and files fields to single-line structure
packages/nextjs/package.json - Reformatted keywords and files fields to single-line structure
packages/ratelimit/package.json - Reformatted keywords and files fields to single-line structure

Sequence Diagram

sequenceDiagram
    participant Frontend as Filters Component
    participant Backend as getRatelimitLogs
    
    Frontend->>Backend: Request logs with optional passed filter
    alt Passed filter defined
        Backend-->>Backend: Apply passed condition to SQL query
    end
    Backend-->>Frontend: Return filtered logs ordered by time
Loading

Possibly related PRs

  • feat: added Ratelimit to dashboard #2076: The changes in the main PR regarding the filter.tsx file and the rendering of buttons within the Filters component may relate to the overall functionality of the dashboard, which includes rate limiting features.
  • fix: Replaced clear button with reset filters button #2703: The modifications in the main PR to the filter.tsx file, particularly the reset functionality for filters, align with the changes made in this PR that replaced the "Clear" button with a "Reset Filters" button, enhancing user experience in managing filters.
  • feat: new filter logic #2804: The introduction of new filter logic in the main PR is directly related to the changes made in this PR, which aims to enhance the filtering capabilities within the application.

Suggested labels

Bug, Improvement, Needs Approval

Suggested reviewers

  • mcstepp
  • perkinsjr
  • ogzhanolguncu
  • 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 a8c978a and 893baea.

📒 Files selected for processing (4)
  • packages/api/package.json (1 hunks)
  • packages/hono/package.json (1 hunks)
  • packages/nextjs/package.json (1 hunks)
  • packages/ratelimit/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (4)
  • packages/nextjs/package.json
  • packages/hono/package.json
  • packages/ratelimit/package.json
  • packages/api/package.json
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: Test Packages / Test ./packages/rbac
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • 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/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 Packages / Test ./internal/billing
  • GitHub Check: Build / Build
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)

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. (Beta)
  • @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 Jan 13, 2025

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

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/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (1)

203-211: Consider accessibility improvements for the date picker triggers.

While the styling looks good with buttonVariants(), converting Button components to div elements might affect accessibility. Consider:

  1. Adding role="button"
  2. Including proper aria-* attributes
  3. Adding keyboard interaction handlers
 <div
   className={cn("text-xs font-medium w-full items-center gap-0", buttonVariants())}
+  role="button"
+  tabIndex={0}
+  aria-label="Open date picker"
+  onKeyDown={(e) => {
+    if (e.key === 'Enter' || e.key === ' ') {
+      e.preventDefault();
+      e.currentTarget.click();
+    }
+  }}
 >

Also applies to: 230-238

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f71b3ba and a8c978a.

📒 Files selected for processing (2)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (3 hunks)
  • internal/clickhouse/src/ratelimits.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: Test Packages / Test ./packages/rbac
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • 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/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 Packages / Test ./internal/billing
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Build / Build
  • GitHub Check: autofix
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
internal/clickhouse/src/ratelimits.ts (2)

166-166: LGTM! Good addition of the optional filter parameter.

The new optional boolean parameter allows for filtering logs based on ratelimit success/failure status.


184-185: LGTM! SQL query changes look good.

The changes properly implement:

  1. Conditional filtering based on the passed parameter
  2. Explicit DESC ordering for showing newest logs first
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (2)

196-196: LGTM! Good fix for date selection.

Disabling future dates is the correct approach for a logging interface.


Line range hint 41-49: LGTM! Good coordination between frontend and backend filtering.

The success state in the frontend properly maps to the new passed parameter in the backend, maintaining type consistency and providing a clean user experience for filtering logs.

@chronark chronark added this pull request to the merge queue Jan 13, 2025
Merged via the queue into main with commit b1be188 Jan 13, 2025
26 of 27 checks passed
@chronark chronark deleted the ratelimits-ui-filters branch January 13, 2025 15:05
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