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

Preserve integration category filter on noop keyup #36844

Open
wants to merge 1 commit into
base: current
Choose a base branch
from

Conversation

bkrausz
Copy link

@bkrausz bkrausz commented Jan 10, 2025

Proposed change

If you follow a link to an integration category, e.g. https://www.home-assistant.io/integrations/#irrigation, press ctrl+tab, and revisit the tab, the category filter is lost. This is because the search box is auto-focused, and any keyup triggers an update. Instead, track the actual value used in the box and only update if it changes.

Also a couple of trailing space style fixes snuck in.

Type of change

(technically none of these, but by spirit of PR I'm calling this a readability improvement)

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase: N/A
  • Link to parent pull request in the Brands repository: N/A
  • This PR fixes or closes issue: fixes #N/A

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Bug Fixes

    • Improved category counting accuracy
    • Enhanced performance of search interactions
  • Performance

    • Optimized search functionality to reduce unnecessary filtering
    • Introduced tracking mechanism to apply search filters only when text changes

@home-assistant home-assistant bot added the current This PR goes into the current branch label Jan 10, 2025
Copy link

netlify bot commented Jan 10, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit b3dfc05
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6780b49c67ebb200086df67d
😎 Deploy Preview https://deploy-preview-36844--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the integrations page, specifically targeting the logic for counting components by category and enhancing the search functionality. The changes include the removal of a line that prematurely ended a conditional block, allowing for accurate increments of the components_count variable. Additionally, a new variable, lastSearchText, is introduced to track previous search input, optimizing the search process by ensuring filters are only applied when the search text changes.

Changes

File Change Summary
source/integrations/index.html - Added lastSearchText variable to track previous search input
- Refined search filtering logic to apply filters only when search text changes
- Corrected category processing logic for accurate component counting

Sequence Diagram

sequenceDiagram
    participant User
    participant SearchInput
    participant FilterLogic
    participant CategoryDisplay

    User->>SearchInput: Enter search text
    SearchInput->>FilterLogic: Check if text changed
    alt Text is different from lastSearchText
        FilterLogic->>CategoryDisplay: Apply search filter
        FilterLogic->>SearchInput: Update lastSearchText
    else Text is same
        FilterLogic->>CategoryDisplay: No action
    end
Loading

The sequence diagram illustrates the enhanced search filtering process, showing how the system now checks if the search text has changed before applying filters, which helps optimize performance and reduce unnecessary updates.


📜 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 1ab0826 and b3dfc05.

📒 Files selected for processing (1)
  • source/integrations/index.html (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/integrations/index.html (4)

70-70: LGTM: Fixed category counting logic

The removal of premature conditional block endings ensures accurate component counting for each category.

Also applies to: 101-101


211-213: Remove unrelated category filter condition

The condition comp.cat.find((c) => c.includes("#")) != undefined should be removed as:

  • There's no evidence of '#' being used in category names in the codebase
  • It would include components in search results regardless of the search term
  • It deviates from the PR's purpose of preserving category filters

312-324: LGTM: Efficient search text tracking implementation

Good implementation that:

  • Only updates the filter when the search text actually changes
  • Preserves existing debounce and sanitization
  • Effectively solves the issue of losing category filters on noop keyup events

312-324: Overall implementation feedback

The implementation effectively solves the category filter preservation issue with a clean approach. However, there's one unrelated change that should be addressed:

  1. ✅ The lastSearchText tracking is well-implemented and solves the core issue
  2. ❌ The unrelated category filter condition (lines 211-213) should be removed
  3. ✅ The category counting logic fixes are beneficial improvements

Please remove the unrelated category filter condition, and this PR will be ready to merge.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @coderabbitai title 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

@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)
source/integrations/index.html (2)

312-324: LGTM! Efficient search text tracking implementation.

Good implementation that:

  1. Prevents unnecessary filter updates
  2. Properly sanitizes input
  3. Handles empty search appropriately

Minor suggestion: Consider using strict equality operator (!==) for consistency with the rest of the codebase.

-      if (lastSearchText != text) {
+      if (lastSearchText !== text) {

Line range hint 211-324: Overall Assessment

  1. ✅ The main changes successfully fix the category filter preservation issue by tracking search text state.
  2. ❓ The search filter modification on line 211 needs review as it might cause unexpected behavior.
  3. 💡 Minor style improvement suggested for consistency.

The implementation effectively solves the reported issue, but please review the search filter logic change as it seems unrelated to the PR's objective.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cb06f83 and 1ab0826.

📒 Files selected for processing (1)
  • source/integrations/index.html (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/integrations/index.html (1)

70-70: LGTM! Code formatting improvements.

The changes maintain correct category counting logic while improving code readability.

Also applies to: 101-101

Comment on lines +211 to 213
filter = comp =>
comp.search.indexOf(search) !== -1 ||
comp.cat.find((c) => c.includes("#")) != undefined;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Remove unrelated category filter condition

The condition comp.cat.find((c) => c.includes("#")) != undefined should be removed as:

  • There's no evidence of '#' being used in category names in the codebase
  • It would include components in search results regardless of the search term
  • It deviates from the PR's purpose of preserving category filters
🔗 Analysis chain

Review search filter logic modification.

The added condition comp.cat.find((c) => c.includes("#")) != undefined will include components that have '#' in their categories, regardless of the search term. This seems unrelated to the PR's objective and could cause unexpected search results.

Let's verify the impact:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for categories containing '#' character that might affect search results
ast-grep --pattern 'cat: [$$$]' | grep -o '"[^"]*#[^"]*"'

Length of output: 59


Script:

#!/bin/bash
# Find component definitions and category patterns
echo "=== Looking for component definitions ==="
rg -l "components?\s*=\s*\[" --type html --type js

echo -e "\n=== Checking category-related code ==="
rg "cat\s*[:=]" -A 2 --type html --type js

echo -e "\n=== Looking for '#' character usage ==="
rg "#['\"]?\s*[,\]]" --type html --type js

Length of output: 4883

@bkrausz bkrausz force-pushed the integration-category-filter branch from 1ab0826 to b3dfc05 Compare January 10, 2025 05:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant