Skip to content

feat: add override button to ratelimits#2950

Merged
chronark merged 2 commits intomainfrom
fix-overrides-page
Mar 12, 2025
Merged

feat: add override button to ratelimits#2950
chronark merged 2 commits intomainfrom
fix-overrides-page

Conversation

@ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Mar 12, 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

  • New Features
    • Improved identifier management: The identifier dialog now offers more flexibility by allowing the identifier field to be optional and adapting its behavior based on available data.
    • Enhanced dashboard navigation: Introduced a new CopyableIDButton for copying the namespace identifier and a button to open the identifier dialog, ensuring smoother and more intuitive user interactions.
    • Refined copy action: Adjustments to the copy button enhance event handling and visual feedback while maintaining core functionality.

@changeset-bot
Copy link

changeset-bot bot commented Mar 12, 2025

⚠️ No Changeset found

Latest commit: 21d4ca5

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 12, 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 12, 2025 11:53am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 12, 2025 11:53am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 12, 2025 11:53am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 12, 2025 11:53am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2025

📝 Walkthrough

Walkthrough

This pull request modifies the handling of the identifier prop within the IdentifierDialog component by making it optional and conditionally applying form input attributes. Additionally, the NamespaceNavbar component now includes state management to control the visibility of the dialog through new button interactions, and a new CopyableIDButton component has been introduced to facilitate copying the namespace ID. The CopyButton component has also been updated to use a forward reference and enhance event handling.

Changes

File(s) Change Summary
apps/dashboard/app/(app)/ratelimits/[namespaceId]/_components/identifier-dialog.tsx Changed the identifier property in Props from a required to an optional string. Updated the FormInput component to conditionally set readOnly and disabled attributes based on the presence of identifier.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/namespace-navbar.tsx Added a new state variable open with useState to manage the modal dialog visibility. Replaced a Badge component with a Button to open the IdentifierDialog and introduced a new CopyableIDButton for copying the namespace ID. Renders IdentifierDialog conditionally based on state.
apps/dashboard/components/dashboard/copy-button.tsx Transitioned to a forward reference export, allowing the button to accept a ref prop. Updated the onClick event handler to prevent event bubbling. Changed icons used for copy status.
apps/dashboard/components/navigation/copyable-id-button.tsx Introduced a new CopyableIDButton component that manages text selection and integrates with the CopyButton for copying functionality.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant NN as NamespaceNavbar
    participant ID as IdentifierDialog
    participant CB as CopyableIDButton
    U->>NN: Click "Open Identifier Dialog" Button
    NN->>NN: set open state to true
    NN->>ID: Render IdentifierDialog (isModalOpen = true)
    ID->>FormInput: Set readOnly & disabled based on identifier prop presence
    U->>CB: Long-press to select text
    CB->>CB: Start timer for text selection
    CB->>CB: Check if text is selected
    CB->>CopyButton: Trigger copy if no text selected
Loading

Possibly related PRs

  • feat: add input instead of suggestion for path and identifiers #2894: The changes in the main PR, which modify the identifier prop in the IdentifierDialog component, are related to the changes in the retrieved PR that refactor the IdentifiersFilter component to implement a search input for identifiers, as both involve handling identifiers in their respective components.

Suggested labels

Improvement, Needs Approval

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 12, 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: 1

🧹 Nitpick comments (2)
apps/dashboard/components/navigation/copyable-id-button.tsx (2)

10-14: Consider adding keyboard accessibility.

While the component handles mouse interactions well, it doesn't provide keyboard accessibility for the long-press text selection feature. Users who navigate with keyboards would be unable to access this functionality.

Consider adding keyboard support with something like:

export const CopyableIDButton = ({ value, className = "" }: CopyableIDButtonProps) => {
  const textRef = useRef<HTMLDivElement>(null);
  const pressTimer = useRef<NodeJS.Timeout | null>(null);
  const copyButtonRef = useRef<HTMLButtonElement>(null);
+  
+  const selectText = () => {
+    if (textRef.current) {
+      const range = document.createRange();
+      range.selectNodeContents(textRef.current);
+      const selection = window.getSelection();
+      if (selection) {
+        selection.removeAllRanges();
+        selection.addRange(range);
+      }
+    }
+  };
+
+  const handleKeyDown = (e: React.KeyboardEvent) => {
+    if (e.key === 'Enter') {
+      copyButtonRef.current?.click();
+    } else if (e.key === ' ' || e.key === 'Space') {
+      selectText();
+      e.preventDefault();
+    }
+  };

31-45: Reduce code duplication between handlers.

The code for clearing the timer is duplicated in both handleMouseUp and handleMouseLeave. Consider extracting this logic to a separate function.

  const handleMouseDown = () => {
    // Start a long-press timer
    pressTimer.current = setTimeout(() => {
      // Rest of the code...
    }, 500);
  };

+  const clearPressTimer = () => {
+    if (pressTimer.current) {
+      clearTimeout(pressTimer.current);
+      pressTimer.current = null;
+    }
+  };

  const handleMouseUp = () => {
    // Clear the timer if mouse is released before long-press threshold
-    if (pressTimer.current) {
-      clearTimeout(pressTimer.current);
-      pressTimer.current = null;
-    }
+    clearPressTimer();
  };

  const handleMouseLeave = () => {
    // Clear the timer if mouse leaves the button
-    if (pressTimer.current) {
-      clearTimeout(pressTimer.current);
-      pressTimer.current = null;
-    }
+    clearPressTimer();
  };
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3c8b8fc and 21d4ca5.

📒 Files selected for processing (3)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/namespace-navbar.tsx (3 hunks)
  • apps/dashboard/components/dashboard/copy-button.tsx (2 hunks)
  • apps/dashboard/components/navigation/copyable-id-button.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/namespace-navbar.tsx
  • apps/dashboard/components/dashboard/copy-button.tsx
⏰ Context from checks skipped due to timeout of 90000ms (18)
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Go API Local / test_agent_local
  • GitHub Check: Test Packages / Test ./packages/rbac
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test Packages / Test ./packages/api
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • GitHub Check: Test Packages / Test ./internal/id
  • GitHub Check: Test Packages / Test ./internal/keys
  • GitHub Check: Test Packages / Test ./internal/hash
  • GitHub Check: Test Packages / Test ./internal/billing
  • GitHub Check: Test Packages / Test ./internal/encryption
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Packages / Test ./internal/resend
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Build / Build
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
apps/dashboard/components/navigation/copyable-id-button.tsx (3)

1-8: Component props look good!

The component correctly defines its props with appropriate types. The className prop is optional with a default value, which provides good flexibility for styling.


47-56: Good handling of click vs. long-press behavior.

The click handler intelligently checks if text has been selected before deciding whether to trigger the copy action. This provides a good user experience.


58-80: Well-structured component with good UX considerations.

The component is well-structured and provides a good user experience:

  • Clear separation of the text and copy button
  • The select-text class on the text container ensures users can select text
  • Making the CopyButton non-interactive directly with pointer-events-none ensures the parent button's logic controls the behavior

This creates a cohesive UI element that handles both copying and text selection.

Copy link
Contributor Author

@chronark @perkinsjr can I get a quick review for that?

Copy link
Collaborator

after this call

Copy link
Collaborator

:chef_kissing_fingers_intensifies:

@chronark chronark enabled auto-merge March 12, 2025 14:10
@chronark chronark added this pull request to the merge queue Mar 12, 2025
Merged via the queue into main with commit 19e0809 Mar 12, 2025
30 checks passed
@chronark chronark deleted the fix-overrides-page branch March 12, 2025 14:13
@coderabbitai coderabbitai bot mentioned this pull request Mar 28, 2025
18 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jun 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