Adds throttler to config pages for state entity updates

[silamon]

Proposed change

Adds a throttler to throttle incoming state changes. This is only a problem for Home Assistant installations that do multiple state updates per second. I didn't add it everywhere hass is updated, as it needs further testing for edge cases and therefore also not for backport I guess.

This problem, better described in the issue, started with the introduction of the new tables, since they do a lot more scripting work than before. Apparently, the entity page was already slower since a few releases, since the last release the helper page is added. It slows down to the fact that lit cannot keep up rendering the bottom children of the render tree, delaying until a moment allows to render it. On those entity and helper pages, it triggers the component to recalculate the shown items and filteredItems, probably the cause of pushing the pages to lag.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (thank you!)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example configuration

Additional information

• This PR fixes or closes issue: fixes /config/helpers struggles (a lot) more than before, and won't completely load robustly #21530 fixes No entities displayed in /config/entities, and severe lag #21001
• This PR is related to issue or discussion:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

• New Features
  • Enhanced performance for handling updates to the hass property, ensuring more responsive interaction with the component.
• Bug Fixes
  • Improved conditional logic for assigning the hass instance, reducing unnecessary updates and enhancing stability.

[coderabbitai]

Walkthrough

Walkthrough

The changes to the HaPanelConfig class optimize the handling of the hass property by introducing a throttling mechanism. This reduces the frequency of updates to the hass property, enhancing performance and responsiveness, especially when rapid updates occur. The new implementation ensures that updates only happen when necessary, preventing excessive rendering issues that may arise from frequent state changes.

Changes

Files	Change Summary
src/panels/config/ha-panel-config.ts	Introduced _hassThrottler, a private throttler function to limit updates to the hass property. Updated hassSubscribe method to conditionally assign el.hass based on its current state.

Assessment against linked issues

Objective	Addressed	Explanation
Improve loading performance for /config/helpers and /config/entities pages (21530, 21001)	✅
Ensure responsiveness of the UI when many entities are present (21001)	✅
Resolve lag issues during entity filtering and display (21001)	❓	It's unclear if the throttling sufficiently addresses the reported lag.

---

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

• 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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[karwosts]

Very nice 👍

My testing install w/ 15,000 entities and hass update every 50ms was completely non-functional for entities page, but with this change it is pretty good and responsive.

[Mariusthvdb]

Can we test this at all? Would love to lay my hands on this and see what gives.
Not sure if this is planned for the patch release?

[silamon]

There's no backport planned. I'm not sure how you could test this early than before next beta.

[bramkragten]

I do not really like this, this should be handled/throttled in the data table and not at such a high level in the config page.

I'll merge it for not as it does fix an issue, and we will look at it during beta.

[silamon]

I understand. It's not the clearest way. I will look into improving.

[bramkragten]

This has been reverted as it caused issues, like missing translation updates