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: ratelimit date input and time display logs #2717

Merged
merged 4 commits into from
Dec 7, 2024

Conversation

ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Dec 6, 2024

What does this PR do?

Fixes how we display dates on logs page, improves how we display date on ratelimit logs table

Fixes #2715, #2706

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?

  • Go to /ratelimits/xxxxxx/logs
  • Play around with dates

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

Release Notes

  • New Features

    • Introduced a new DateTimePicker component for enhanced date and time selection.
    • Updated filter UI for improved usability with new date range selection capabilities.
  • Improvements

    • Enhanced responsiveness of filter controls with refined state management.
    • Replaced timestamp display with a more structured TimestampInfo component in the audit log.
  • Bug Fixes

    • Streamlined filter reset and date selection processes for better user experience.

Improve ratelimits filter date pickers and how we display times on
ratelimit logs
Copy link

vercel bot commented Dec 6, 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 6, 2024 7:40pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 7:40pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 7:40pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 7:40pm

Copy link

changeset-bot bot commented Dec 6, 2024

⚠️ No Changeset found

Latest commit: 75819ef

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

Warning

Rate limit exceeded

@ogzhanolguncu has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 47 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 551948b and 75819ef.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces significant updates to the filter.tsx, page.tsx, and a new date-time-picker.tsx component. Key changes include the restructuring of import statements, state management improvements, and the implementation of a new DateTimePicker for date selection. The rendering logic for timestamps in the AuditLogTable has also been modified to utilize the new TimestampInfo component. These changes aim to enhance the user interface and improve the modularity of the code.

Changes

File Path Change Summary
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx Updated import statements, modified state management for date filters, refactored rendering logic to use DateTimePicker, and streamlined button interactions for filter reset and state updates.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx Added import for TimestampInfo, modified timestamp rendering to use TimestampInfo instead of a <span>, and adjusted class names for styling.
apps/dashboard/components/date-time-picker.tsx Introduced new DateTimePicker component for selecting date and time, including state management and user interaction handling.

Assessment against linked issues

Objective Addressed Explanation
Correctly format date/time input and allow selection for 'from' and 'until' dates (#2715)

Possibly related PRs

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 150 points, hacktoberfest

Suggested reviewers

  • chronark
  • mcstepp
  • perkinsjr

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

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

@github-actions github-actions bot added Bug Something isn't working Needs Approval Needs approval from Unkey labels Dec 6, 2024
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: 3

🧹 Outside diff range and nitpick comments (4)
apps/dashboard/components/date-time-picker.tsx (2)

9-17: Consider enhancing type safety for date props

The props interface could be improved to ensure better type safety and validation:

  • Consider adding validation for the date prop to ensure it's not null
  • Add JSDoc comments to document the expected format and behavior
 type DateTimePickerProps = {
+  /** The currently selected date. Must be a valid Date object */
   date: Date;
+  /** Callback fired when the date changes. Provides the new Date value */
   onDateChange: (date: Date) => void;
   calendarProps?: React.ComponentProps<typeof Calendar>;
   timeInputProps?: React.ComponentProps<typeof Input>;
   popoverContentProps?: React.ComponentProps<typeof PopoverContent>;
   timeInputLabel?: string;
   disabled?: boolean;
 };

31-40: Improve null date handling in handleSelect

The early return for null dates could be more explicit about why the selection was invalid.

 const handleSelect = (selected: Date) => {
   if (!selected) {
-    return;
+    console.warn('Date selection was cancelled or invalid');
+    return;
   }
   const hours = selectedDateTime.getHours();
   const minutes = selectedDateTime.getMinutes();
   const newDate = setMinutes(setHours(selected, hours), minutes);
   setSelectedDateTime(newDate);
   setDate(newDate);
 };
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (2)

62-79: Consider combining state updates for better consistency

The separate state updates for after and before could lead to temporary inconsistencies. Consider combining them into a single update when appropriate.

- const [after, setAfter] = useQueryState(
-   "after",
-   parseAsTimestamp.withOptions({
-     history: "push",
-     shallow: false,
-     clearOnDefault: true,
-   }),
- );
- 
- const [before, setBefore] = useQueryState(
-   "before",
-   parseAsTimestamp.withOptions({
-     history: "push",
-     shallow: false,
-     clearOnDefault: true,
-   }),
- );

+ const [dateRange, setDateRange] = useQueryState(
+   ["after", "before"],
+   parseAsTimestamp.withOptions({
+     history: "push",
+     shallow: false,
+     clearOnDefault: true,
+   }),
+ );

Line range hint 244-254: Optimize reset functionality

The reset functionality could be more efficient by combining the state updates and removing the empty transition callback.

 <Button
   className="flex-shrink-0"
   size="icon"
   variant="secondary"
   onClick={() => {
-    setTimeRangeVisible(false);
-    setAfter(null);
-    setBefore(null);
-    startTransition(() => {});
+    startTransition(() => {
+      setTimeRangeVisible(false);
+      setAfter(null);
+      setBefore(null);
+    });
   }}
 >
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bca5871 and 551948b.

📒 Files selected for processing (3)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (6 hunks)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx (2 hunks)
  • apps/dashboard/components/date-time-picker.tsx (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
apps/dashboard/components/date-time-picker.tsx

[error] 68-68: A form label must be associated with an input.

Consider adding a for or htmlFor attribute to the label element or moving the input element to inside the label element.

(lint/a11y/noLabelWithoutControl)

🔇 Additional comments (1)
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx (1)

163-165: LGTM: Improved timestamp display

The use of TimestampInfo component provides a consistent and user-friendly way to display timestamps. The hover effect and formatting improvements enhance the user experience.

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.

Ratelimit Logs: Time filter not properly formated / cant choose until date
2 participants