Fix: Sidebar filter produces duplicate results

[nikolasrieble]

🔗 Relevant links

• Preview link 🔎
• Asana task 🎟️

🗒️ What

This PR:

• add tests to a helper that did not have any
• fixes a bug in the helper function
• Boy Scout rule: Leave the campsite better and do minor improvements (listed below)

In the first commit, I only add tests and specifically add a test to reproduce the bug.
In the second I fix the bug.

And while I am already here, I decided to propose a few opinionated changes:

• Use 'routes' in item rather than item.hasOwnProperty('routes'), because it allows for Typescript narrowing, and enables us to remove all casts ("as")
• Switched the traversal from items.forEach to a for...of loop so we can rely on continue instead of early returns inside a callback. Clearer control flow and no extra closure per iteration.
• Added the small includesFilter helper to centralize the lowercase/undefined guard logic, so both title and alias comparisons share a single, type-safe code path.

🤷 Why

@l2fprod found a bug:

and created a ticket for us to fix it. https://hashicorp.atlassian.net/browse/TF-32415

🛠️ How

📸 Design Screenshots

🧪 Testing

This PR adds unit tests for the helper function.

💭 Anything else?

PCI review checklist

• I have documented a clear reason for, and description of, the change I am making.

• If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.

• If applicable, I've documented the impact of any changes to security controls.

  Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
dev-portal	Ready	Preview	Comment	Nov 26, 2025 8:20pm

[Copilot]

Pull request overview

This PR fixes a bug where items matching a filter by both title and alias were being duplicated in the filtered navigation results. The fix adds test coverage for the getFilteredNavItems helper function and refactors the implementation to use modern JavaScript patterns like in operator for type narrowing and for...of loops for clearer control flow.

Key changes:

• Adds comprehensive unit tests for the getFilteredNavItems helper
• Fixes duplication bug by using continue to prevent items from being added twice when both title and alias match
• Refactors to use in operator instead of hasOwnProperty for better type safety

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/components/sidebar/helpers/get-filtered-nav-items.ts	Refactored filtering logic to prevent duplicate items and improved code maintainability with clearer control flow
src/components/sidebar/helpers/tests/get-filtered-nav-items.test.ts	Added comprehensive test suite covering edge cases including the title+alias duplication bug

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

This PR introduced no changes to the javascript bundle 🙌

[RubenSandwich]

Looks good, thanks for adding tests.