fix: navbar-popover active state

[ogzhanolguncu]

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
  • Added a new "Requests" link to both the API and namespace dashboards, ensuring quick access to relevant requests.
  • Enhanced the navigation menu to automatically highlight the active item based on the current page, improving overall usability.

[linear]

ENG-1692 Fix active state to trpc_read

[changeset-bot]

⚠️ No Changeset found

Latest commit: 13fab29

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]

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	Apr 7, 2025 9:06am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 7, 2025 9:06am
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 7, 2025 9:06am
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 7, 2025 9:06am

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the navigation components by adding a “Requests” link to the navigation items in both the API and namespace navigation bars. In addition, the popover component has been refactored to use a new hook for retrieving the current pathname and to determine the active navigation item dynamically. The overall modifications improve how the focused navigation item is identified based on the current route.

Changes

File(s)	Change Summary
apps/dashboard/app/(app)/apis/[apiId]/api-id-navbar.tsx apps/dashboard/app/(app)/ratelimits/[namespaceId]/namespace-navbar.tsx	Added a new "Requests" link to the QuickNavPopover items array, linking dynamically using the respective API or namespace id.
apps/dashboard/components/.../navbar-popover.tsx	Replaced usage of useRouter with usePathname; added findActiveItemIndex and checkIsActive functions; updated PopoverItem to accept an isActive prop for dynamic styling.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant NP as NavbarPopover
    participant UP as usePathname
    participant FA as findActiveItemIndex
    participant CI as checkIsActive
    participant PI as PopoverItem

    U->>NP: Open QuickNavPopover
    NP->>UP: Get current pathname
    NP->>FA: Determine active item index
    loop For each nav item
        FA->>CI: Compare item href with current pathname
    end
    NP->>NP: Set focused index based on result
    NP->>PI: Render item with isActive state

Loading

Possibly related PRs

• feat: add override button to ratelimits #2950: Involves similar modifications to the QuickNavPopover by adding a "Requests" link in navigation components.

Suggested labels

Bug

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 9b763d9 and acb7a1a.

📒 Files selected for processing (3)

• apps/dashboard/app/(app)/apis/[apiId]/api-id-navbar.tsx (1 hunks)
• apps/dashboard/app/(app)/ratelimits/[namespaceId]/namespace-navbar.tsx (1 hunks)
• apps/dashboard/components/navbar-popover.tsx (10 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: Test Go API Local / Test (Shard 5/8)
• GitHub Check: Test Packages / Test ./packages/cache
• GitHub Check: Test API / API Test Local
• GitHub Check: Test Packages / Test ./internal/resend
• GitHub Check: Test Packages / Test ./internal/encryption
• GitHub Check: Test Agent Local / test_agent_local
• GitHub Check: Build / Build
• GitHub Check: autofix
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (13)

apps/dashboard/app/(app)/ratelimits/[namespaceId]/namespace-navbar.tsx (1)

57-61: LGTM! The "Requests" navigation item is a welcome addition.

Adding the "Requests" navigation item provides a consistent navigation experience across the application. This change correctly includes the necessary properties (id, label, href) with proper URL construction using the namespace ID.

apps/dashboard/app/(app)/apis/[apiId]/api-id-navbar.tsx (1)

49-53: LGTM! The "Requests" navigation item enhances user navigation options.

This addition maintains consistency with the similar change made in the namespace-navbar component. The implementation correctly includes all required properties with proper URL construction.

apps/dashboard/components/navbar-popover.tsx (11)

9-10: LGTM! New imports support active state functionality.

Added the usePathname hook from Next.js navigation and useCallback for improved performance.

---

44-45: LGTM! Added pathname retrieval.

Using usePathname() to get the current path is the correct approach for determining the active navigation item.

---

115-125: LGTM! Well-implemented active item detection.

The findActiveItemIndex function correctly identifies the active navigation item based on the current pathname. Using useCallback for memoization is a good practice to prevent unnecessary re-renders.

---

136-137: LGTM! Improved initial focus.

Setting the initial focus to the active item provides a better user experience when opening the popover.

---

140-141: LGTM! Updated dependency array.

Correctly included findActiveItemIndex in the dependency array to ensure the effect reruns when necessary.

---

176-177: LGTM! Added active state for virtualized items.

Determining the active state for each virtualized item enables proper styling.

---

190-191: LGTM! Passing active state to PopoverItem.

Correctly passing the active state to the component to enable conditional styling.

---

199-211: LGTM! Updated non-virtualized item rendering.

The implementation is consistent with the virtualized rendering path, providing a unified experience.

---

263-264: LGTM! Enhanced styling condition.

Adding isActive to the background styling condition properly highlights the active navigation item.

---

280-283: LGTM! Improved icon styling based on active state.

The conditional styling for the CaretRight icon provides better visual feedback for the active item.

---

290-305: LGTM! Well-implemented path matching utility.

The checkIsActive function correctly normalizes paths by removing trailing slashes before comparison, which prevents common path matching issues.

Consider enhancing this function in the future to support nested routes by checking if the current path starts with the item path, but the current exact matching implementation is sufficient for this use case.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 plan to trigger planning for file edits and PR creation.
• @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]

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

[chronark]

Either I don't understand what this PR is supposed to do, or it doesn't work

the active highlights are still wrong

[ogzhanolguncu]

This is how my local looks like after WorkOS. What you reviewed was probably old because there should be a sub menu called "Requests" see my screenshots.