Added search to the Queues page

[matt-aitken]

You can now filter the Queues list by typing in the search field.

Summary by CodeRabbit

• New Features

  • Added a search filter for queues, allowing users to filter the queue list by name.
  • Introduced a search input above the queues table for easy filtering.
  • The interface now indicates when filters are active and updates messages accordingly.

• Style

  • Adjusted layout to accommodate the new search filter component.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c5a2cb5

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.

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

[coderabbitai]

Walkthrough

This change introduces a search filter for task queues by queue name in the web application. On the backend, the QueueListPresenter now accepts an optional query parameter to filter queues by a case-insensitive substring match and returns a hasFilters flag to indicate active filters. On the frontend, a new QueueFilters component is added, providing a search input that updates the URL's query parameter with throttling. The loader and UI are updated to handle and display filtered results, including conditional messaging when no queues match the filter.

Changes

File(s)	Change Summary
apps/webapp/app/presenters/v3/QueueListPresenter.server.ts	Added optional query parameter to filter queues by name; updated method signatures; added hasFilters flag.
apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.queues/route.tsx	Added QueueFilters component with search input; integrated query param into loader and UI; updated messaging.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant QueueFilters (UI)
    participant Loader (route.tsx)
    participant QueueListPresenter
    participant Database

    User->>QueueFilters (UI): Enter search text
    QueueFilters (UI)->>Loader (route.tsx): Update URL with ?query=...
    Loader (route.tsx)->>QueueListPresenter: call({ query, ... })
    QueueListPresenter->>Database: Fetch queues filtered by query
    Database-->>QueueListPresenter: Filtered queues
    QueueListPresenter-->>Loader (route.tsx): Queues + hasFilters flag
    Loader (route.tsx)-->>QueueFilters (UI): Render filtered queues

Loading

Suggested reviewers

• nicktrn
• samejr

Poem

A bunny with code on its mind,
Added a search box for you to find—
Queues by name, both near and far,
Filtered results, see how clear they are!
With a hop and a skip, the changes are done,
Now searching for queues is much more fun!
🐇🔍✨

---

📜 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 cf9460a and c5a2cb5.

📒 Files selected for processing (2)

• apps/webapp/app/presenters/v3/QueueListPresenter.server.ts (3 hunks)
• apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.queues/route.tsx (8 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.queues/route.tsx (1)

apps/webapp/app/hooks/useSearchParam.ts (1)

• useSearchParams (7-82)

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

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
• GitHub Check: typecheck / typecheck
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
• GitHub Check: units / 🧪 Unit Tests
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (10)

apps/webapp/app/presenters/v3/QueueListPresenter.server.ts (4)

19-27: Good implementation of the query filter parameter and hasFilters flag.

The addition of the optional query parameter and the hasFilters flag provides a clean way to support filtering queues by name. The flag will be useful for the UI to display appropriate messaging when filters are active.

---

34-39: Case-insensitive substring matching is appropriately implemented.

The implementation of case-insensitive substring matching is appropriate for a search feature. The mode "insensitive" ensures that users can search without worrying about case, which improves usability.

---

84-88: Proper method signature update to support filtering.

The getQueuesWithPagination method signature is correctly updated to accept the query parameter, ensuring consistent filtering through the entire flow.

---

93-98: Consistent filter implementation across methods.

You've applied the same filtering logic in both the count and pagination queries, which ensures consistency between the total count and the actual results displayed.

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.queues/route.tsx (6)

76-76: Good schema update to support the query parameter.

Adding the optional query parameter to the SearchParamsSchema ensures proper type validation for the search functionality.

---

93-93: Proper extraction of query parameter from search params.

The loader correctly extracts both page and query parameters from the URL search params using the defined schema.

---

115-115: Correctly passing query parameter to the presenter.

The query parameter is properly passed to the QueueListPresenter, connecting the UI filtering with the backend implementation.

---

304-304: Good placement of the QueueFilters component.

The QueueFilters component is well-positioned above the table, providing users with an intuitive location for the search functionality.

---

424-426: Improved user feedback for filtered results.

The conditional messaging now clearly indicates when no results match the user's filters, improving the user experience by providing appropriate context.

---

684-718: Well-implemented search filtering with throttling.

The QueueFilters component implementation is clean and effective:

1. Uses throttling to prevent excessive updates during typing (300ms is a good balance)
2. Properly resets pagination when search changes
3. Updates URL parameters to maintain state across page reloads
4. Clears both query and page parameters when search is emptied

The implementation follows best practices for search UX.

✨ 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 generate sequence diagram to generate a sequence diagram of the changes in 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.