Fix discord embed class initialization

[cheng2wei]

Proposed change

Changeset #66540 broke the discord notification integration when trying to use the 'embed'/'thumbnail'/'author' fields. This is due to a breaking change in the constructor of the Embed class when moving from discord.py 1.7.3 to nextcord. The proposed change creates an Embed class using the new constructor.

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)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

I created a custom component that overrides the default discord integration and validated that I was getting discord notifications with the example embedded YAML configuration mentioned in the documentation.

service: notify.discord
data:
message: ""
target: ["1234567890", "0987654321"]
data:
embed:
title: 'title'
description: 'description'
url: 'https://www.home-assistant.io/'
color: 199363
author:
name: 'Author Home Assistant'
url: 'https://www.home-assistant.io/'
icon_url: 'https://www.home-assistant.io/images/favicon-192x192-full.png'
footer:
text: 'Footer Text'
icon_url: 'https://www.home-assistant.io/'
thumbnail:
url: 'https://www.home-assistant.io/images/favicon-192x192-full.png'
fields:
- name: 'fieldname1'
value: 'valuename1'
inline: false
- name: 'fieldname2'
value: 'valuename2'
- name: 'fieldname3'
value: 'valuename3'
- name: 'fieldname4'
value: 'valuename4'
inline: false

• This PR fixes or closes issue: fixes Discord notification unable to add thumbnails or fields in 2022.3 #67679
• This PR is related to issue: Discord notification unable to add thumbnails or fields in 2022.3 #67679
• Link to documentation pull request:

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.

[homeassistant]

Hi @cheng2wei,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[allenporter]

I see there is also Embed.from_dict which looks like it may do exactly what we want?
https://nextcord.readthedocs.io/en/latest/api.html#nextcord.Embed.from_dict
and reading the implementation it seems to do exactly what this function is doing:
https://github.com/nextcord/nextcord/blob/408862e24c11bf7d7a95a56d2eb2532094845404/nextcord/embeds.py#L209

What do you think?

[cheng2wei]

Yea, I was looking at this as well. Functionally, from_dict works. My only concern is that there are other keys that also work in the dict that are not documented in the home assistant documentation, which would be more of a feature-add. This would mean any time the nextcord library is upgraded and introduces more fields, the documentation would need to be updated as well.

For the scope of this PR, I just wanted to align back to the previous working behavior.

[allenporter]

Agree that we don't want to be chasing documentation. It seems like we should be able to either limit to fields specified in this file, or update the docs to point to the nextcoord docs, or not worry about it.

Just to be clear i am not thrilled with how verbose this is given it can be replaced with a single line. I am also not sure that any documentation needs to be updated at all.

[cheng2wei]

That's fair. It is rather verbose.

The new keynames that would be accepted are 'video', 'provider', and 'image'. (Not sure how the image key is different from the one that exists outside of Embed). These are not documented by home assistant, and would need to be filtered out until those features are tested.

We could use from_dict and provide a dictionary that has been filtered with an allow-list of tested features. That would also work to reduce all of the embed.set_* calls.

Is this something that you want accomplished in this PR? My rationale was just to make the smallest change possible to unblock the integration from working.

[allenporter]

If I were doing this I would just add the from dict call and I wouldn't worry about the docs personally.

My second choice would add it with a one line filter by the set of allowed keys already referenced here.

I don't consider either of these very big. Though the smallest change word be to rollback the broken move to nextcoord since it didn't really work.

[allenporter]

I didn't intend for this to be a big deal as I thought it would be fast to switch to. I'll merge this and we can deal with it in a follow up.

[cheng2wei]

Hi apologies, it's not a big deal! I just don't have spare cycles at the moment to keep working on it. I can revisit this in a week or so and look into the additional features as well.

[allenporter]

Thank you for fixing this, I really appreciate it. 👍🏼