Actionable Persistent Notifications

[karwosts]

Proposed change

See home-assistant/core#121689

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 #
• 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
  • Added support for action buttons to persistent notifications, enabling users to interact with notifications directly.
• Bug Fixes
  • Improved handling of notification actions to ensure seamless user interactions.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates add support for actions within persistent notifications and introduce a method to handle these actions in the HuiPersistentNotificationItem class. This enhancement allows notifications to include interactive elements, improving user engagement by enabling direct responses through the notifications interface.

Changes

File	Change Summary
src/data/persistent_notification.ts	Added an optional actions field to the PersistentNotification interface for defining notification actions.
src/dialogs/notifications/persistent-notification-item.ts	Introduced a method _handleAction in HuiPersistentNotificationItem to process notification actions via API calls.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NotificationSystem
    participant API

    User->>NotificationSystem: Interacts with Notification
    NotificationSystem->>API: Calls _handleAction with action details
    API-->>NotificationSystem: Returns result of the action
    NotificationSystem-->>User: Updates notification status based on action

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5ead5ed and 4d1d100.

Files selected for processing (2)

• src/data/persistent_notification.ts (1 hunks)
• src/dialogs/notifications/persistent-notification-item.ts (2 hunks)

Additional comments not posted (3)

src/data/persistent_notification.ts (2)

14-17: New Interface: PersistentNotificationAction

The PersistentNotificationAction interface adds structure for actions associated with persistent notifications. This is a good addition for enabling actionable notifications.

---

24-24: New Field: actions in PersistentNotification

The optional actions field in the PersistentNotification interface allows for a list of actions, enhancing the interactivity of notifications. This is a well-integrated change.

src/dialogs/notifications/persistent-notification-item.ts (1)

80-89: New Method: _handleAction

The _handleAction method correctly handles the action click event and makes the appropriate API call. The dismissal of the notification after the action is executed is a good user experience consideration.

---

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: 0

Outside diff range, codebase verification and nitpick comments (1)

src/dialogs/notifications/persistent-notification-item.ts (1)

42-51: Rendering Actions for Notifications

The code correctly maps over the actions array, rendering buttons for each action. This enhances the notification's interactivity.

Consider adding a condition to check if actions is non-empty before rendering the buttons to avoid rendering an empty slot.

- ${this.notification.actions?.map(
+ ${this.notification.actions?.length ? this.notification.actions.map(
    (a) =>
      html` <mwc-button
        slot="actions"
        @click=${this._handleAction}
        .action=${a}
        >${a.title}</mwc-button
      >`
  ) : nothing}