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: Ensure last ratelimit usage is shown #2721

Merged
merged 7 commits into from
Dec 10, 2024

Conversation

Flo4604
Copy link
Contributor

@Flo4604 Flo4604 commented Dec 8, 2024

What does this PR do?

Fixes #2720

Cleanups go.mod and go.sum for the chproxy

Removes a file that wasn't in use and threw an error as the @unkey/clickhouse-zod package does not 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?

Send a ratelimit request, check the last change time, wait a minute and send new requests.
Check that the limit does not update.

With this branch the correct last time is shown

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

    • Enhanced the LastUsed component to retrieve only the most recent entry for specified identifiers.
    • Updated the RatelimitNamespacePage to fetch the latest ratelimit data with a limit of 1.
    • Modified the RatelimitCard component to fetch the latest ratelimit data with a limit of 1.
  • Bug Fixes

    • Improved data handling for ratelimitEvents, ensuring correct structure for rendering.
  • Chores

    • Removed several indirect dependencies to streamline the module's requirements.
    • Deleted the last_used.ts file, which contained unused functionality.

Copy link

changeset-bot bot commented Dec 8, 2024

⚠️ No Changeset found

Latest commit: 31c28e6

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 Dec 8, 2024

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 Dec 10, 2024 9:14am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 10, 2024 9:14am

Copy link

vercel bot commented Dec 8, 2024

@Flo4604 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Dec 8, 2024

📝 Walkthrough

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on the go.mod file where several indirect dependencies were removed. Additionally, modifications were made to the LastUsed component and the RatelimitNamespacePage component to include a limit parameter in their respective clickhouse.ratelimits.latest method calls, enhancing data retrieval specificity. A function for retrieving the last used timestamp from Clickhouse was deleted, and adjustments were made to the getRatelimitLastUsed function to incorporate a limit on the number of results returned.

Changes

File Path Change Summary
apps/chproxy/go.mod Removed indirect dependencies: tdigest, intern, easyjson, vegeta, x/net, x/text.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/overrides/table.tsx Added limit parameter to clickhouse.ratelimits.latest function call in LastUsed component.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/page.tsx Added limit parameter to clickhouse.ratelimits.latest method in RatelimitNamespacePage component.
internal/clickhouse/src/last_used.ts Deleted the getLastUsed function that retrieved the last used timestamp from Clickhouse.
internal/clickhouse/src/ratelimits.ts Updated getRatelimitLastUsed function to include a limit parameter in its query.

Assessment against linked issues

Objective Addressed Explanation
Ensure last used timestamp reflects the latest time (#[2720])
Add an ORDER BY time DESC in the query for retrieving last used time (#[2720])
Incorporate a limit expression in the query to optimize data retrieval (#[2720])

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • ogzhanolguncu

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. (Experiment)
  • @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 github-actions bot added Bug Something isn't working Needs Approval Needs approval from Unkey labels Dec 8, 2024
Copy link
Contributor

github-actions bot commented Dec 8, 2024

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

@Flo4604 Flo4604 changed the title Fix/ratelimit last used fix: Ensure last ratelimit usage is shown Dec 8, 2024
@Flo4604
Copy link
Contributor Author

Flo4604 commented Dec 9, 2024

Missed a place where I didn't pass in limit sorry

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

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/ratelimits/card.tsx (1)

Line range hint 71-73: Replace hardcoded datetime with dynamic value

The time element contains a hardcoded datetime value "2024-03-11T19:38:06.192Z" which should be replaced with the actual lastUsed timestamp.

Apply this diff to fix the issue:

-              <time dateTime="2024-03-11T19:38:06.192Z" title="20:38:06 CET">
+              <time dateTime={new Date(lastUsed).toISOString()} title={new Date(lastUsed).toLocaleTimeString()}>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ecf8e84 and fb32106.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/ratelimits/card.tsx (1 hunks)
🔇 Additional comments (1)
apps/dashboard/app/(app)/ratelimits/card.tsx (1)

29-33: LGTM! The bug fix implementation looks correct.

The addition of limit: 1 parameter ensures we fetch only the most recent entry, fixing the issue where the last used timestamp was incorrectly showing the first entry instead of the most recent one.

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fb32106 and 31c28e6.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/page.tsx (1 hunks)

Comment on lines +80 to +84
.latest({
workspaceId: namespace.workspaceId,
namespaceId: namespace.id,
limit: 1,
})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Inconsistent usage of limit parameter across .latest() calls needs attention

The verification reveals that the limit: 1 parameter is only used in ratelimit-related components:

  • apps/dashboard/app/(app)/ratelimits/card.tsx
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/page.tsx

Other components using .latest() either:

  1. Don't use the limit parameter and rely on array access (.at(0)) to get the latest entry
  2. Have different parameter requirements (like the overrides table)

This inconsistency in implementation could lead to similar timestamp-related issues in other components.

🔗 Analysis chain

LGTM! The fix correctly implements the last used timestamp retrieval.

The addition of limit: 1 ensures we get only the most recent entry from the ratelimits table, fixing the bug where the first timestamp was being shown instead of the last used time.

Let's verify that this change is consistently implemented across all components that use the latest method:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if all components using clickhouse.ratelimits.latest include the limit parameter

# Search for all usages of the latest method
rg -A 3 "clickhouse\.ratelimits\.latest\(" --type ts --type tsx

Length of output: 93


Script:

#!/bin/bash
# Search for all usages of the latest method without file type restrictions
rg -A 3 "\.latest\(" 

Length of output: 2563

@chronark chronark merged commit c6dfe2d into unkeyed:main Dec 10, 2024
5 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Needs Approval Needs approval from Unkey
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Ratelimit Last used uses first used time instead of last
3 participants