Fix persistent notification count on server restart

[karwosts]

Proposed change

When hass reconnects after a disconnect (e.g. server restart), drop the persistent notifications subscription and resubscribe to get a fresh count. Otherwise we will be holding stale notifications that no longer exist.

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 Persistent Notification Count on Restart #17137
• 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
  • Improved handling of persistent notifications in the sidebar, ensuring they are properly subscribed and updated based on connection status.

[coderabbitai]

Walkthrough

Walkthrough

The primary changes to the HaSidebar class in ha-sidebar.ts involve enhancing the handling of persistent notifications. Specifically, a new private property _unsubPersistentNotifications and a method subscribePersistentNotifications have been introduced. The shouldUpdate method now checks for changes in hass.connected, and both firstUpdated and updated methods ensure that persistent notifications are correctly subscribed to, even after reconnections.

Changes

File	Change Summary
src/components/ha-sidebar.ts	Added _unsubPersistentNotifications property and subscribePersistentNotifications method. Updated firstUpdated and updated methods to manage persistent notifications subscription based on connection state.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HaSidebar
    participant HA

    User->>HA: Restart Home Assistant
    HA->>HaSidebar: Disconnect Notification
    HaSidebar->>HaSidebar: `hass.connected` becomes false
    User->>HA: Home Assistant Restart Completed
    HA->>HaSidebar: Reconnect Notification
    HaSidebar->>HaSidebar: `hass.connected` becomes true
    HaSidebar->>HaSidebar: Call `subscribePersistentNotifications`
    HaSidebar->>HA: Get Persistent Notifications
    HA->>HaSidebar: Return Persistent Notifications
    HaSidebar->>HaSidebar: Update Notification Count

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Persistent Notification Count on Restart (Issue #17137)	✅

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f40698a and a2dc60d.

Files selected for processing (1)

• src/components/ha-sidebar.ts (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/components/ha-sidebar.ts

---

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 Configration 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.

[coderabbitai]

Actionable comments posted: 1

[silamon]

Your PR did reveal though that the subscription wasn't unsubscribed at all when the ha-sidebar is disconnected. But since the ha-sidebar is only disconnected upon logout, it's something that doesn't really need to be addressed. A subscription is removed anyway from the backend when the websocket connection is cut off (when you lose network, restart home assistant or close the browser window)..