Support notification_id in notify.persistent_notification

[KevinCathcart]

Breaking change

Proposed change

Adds support for notification_id as a data field. As discussed in issue #68811, this is relevant in some scenarios such as when using the Alert integration, which you would prefer to update the existing notification instead of potentially creating a large number of persistent_notification entities.

Code wise this is pretty straightforward. Rather than updating the voluptuous schema for this service, I've just used the existing notify schema to make this act the same as the real platform implementations.

Type of change

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

Additional information

• This PR fixes or closes issue: fixes Notifications created by notify.persistent_notification can't be dismissed programmatically as they lack a notification_id #68811
• This PR is related to issue:
• Link to documentation pull request: Document use of Persistent Notification as a notifier home-assistant.io#23336

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Black (black --fast homeassistant tests)
• 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

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[probot-home-assistant]

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (notify) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

[oxc]

Still relevant.

[ScottG489]

@KevinCathcart Could you resolve the merge conflicts in this PR? Anything to help increase the chance of this getting reviewed and merged.

[ScottG489]

So now that I have some core dev experience, I think I'm able to follow what the code in this PR is doing and can provide an informed review.

So the appropriate data field is added to the services.yaml definition to have this notify service align with a notify interface (as documented here).

In the code itself, we check to see if the data field was included on the notify service call, and if it is we pull the notification_id off of it and use it along with the other fields to create the persistent notification. Additionally, when the notify service is registered, we correctly use a schema representative of a notify service (it seems like this schema should be centralized for all notification services to share to avoid situations like this where we have notification services that don't adhere to the interface).

Finally, the test to me looks pretty good. It's creating 2 persistent notifications via the notify.persistent_notification service with the same notification_id. It's then validating that there is only 1 persistent notification, which there should be since the second notification will overwrite the first. The test is also verifying that the notification has the message and title from the second notification, further showing that it overwrites the first.

[ScottG489]

I just realized a potential issue with the tests in this PR. When validating the created persistent notifications, we are getting an entity from states. However, with recent changes, persistent notifications will no longer be stored in states.

I'll try to find out the proper way to fetch persistent notification information.

[ScottG489]

Ok I think the answer actually lies with test changes that would be present if this PR were to be synced with dev. I'm going to suggest some changes.

[ScottG489]

Tested these changes locally. Tests passing with 100% cover to applicable files.

While I was at it I also spun this up with hass and I can confirm it's working as expected. The service has a data field now and when notification_id is specified it will replace existing notifications with that id and calling persistent_notification.dismiss with that id will remove it.

[ScottG489]

🙏🙏🙏