Merge pull request #1580 from crazy-max/discord-renderembeds

notif(discord): add renderEmbeds option

Author: crazy-max

docs/notif/discord.md

@@ -15,6 +15,7 @@ Allow sending notifications to your Discord channel.
           - "<@124>"
           - "<@125>"
           - "<@&200>"
+        renderEmbeds: true
         renderFields: true
         timeout: 10s
         templateBody: |
@@ -26,14 +27,16 @@ Allow sending notifications to your Discord channel.
 | `webhookURL`       |                                    | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
 | `webhookURLFile`   |                                    | Use content of secret file as webhook URL if `webhookURL` is not defined                                  |
 | `mentions`         |                                    | List of users or roles to notify                                                                          |
-| `renderFields`     | `true`                             | Render [field objects](https://discordjs.guide/popular-topics/embeds.html)                                |
+| `renderEmbeds`     | `true`                             | Render [message embeds](https://discordjs.guide/legacy/popular-topics/embeds)                             |
+| `renderFields`     | `true`                             | Render [field objects](https://discordjs.guide/legacy/popular-topics/embeds) in message embeds            |
 | `timeout`          | `10s`                              | Timeout specifies a time limit for the request to be made                                                 |
 | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body                                 |
 
 !!! abstract "Environment variables"
     * `DIUN_NOTIF_DISCORD_WEBHOOKURL`
     * `DIUN_NOTIF_DISCORD_WEBHOOKURLFILE`
     * `DIUN_NOTIF_DISCORD_MENTIONS` (comma separated)
+    * `DIUN_NOTIF_DISCORD_RENDEREMBEDS`
     * `DIUN_NOTIF_DISCORD_RENDERFIELDS`
     * `DIUN_NOTIF_DISCORD_TIMEOUT`
     * `DIUN_NOTIF_DISCORD_TEMPLATEBODY`

internal/config/config_test.go

@@ -90,6 +90,7 @@ func TestLoadFile(t *testing.T) {
 							"<@125>",
 							"<@&200>",
 						},
+						RenderEmbeds: utl.NewTrue(),
 						RenderFields: utl.NewTrue(),
 						Timeout:      utl.NewDuration(10 * time.Second),
 						TemplateBody: model.NotifDefaultTemplateBody,

internal/model/notif_discord.go

@@ -11,6 +11,7 @@ type NotifDiscord struct {
 	WebhookURL     string         `yaml:"webhookURL,omitempty" json:"webhookURL,omitempty" validate:"omitempty"`
 	WebhookURLFile string         `yaml:"webhookURLFile,omitempty" json:"webhookURLFile,omitempty" validate:"omitempty,file"`
 	Mentions       []string       `yaml:"mentions,omitempty" json:"mentions,omitempty"`
+	RenderEmbeds   *bool          `yaml:"renderEmbeds,omitempty" json:"renderEmbeds,omitempty" validate:"required"`
 	RenderFields   *bool          `yaml:"renderFields,omitempty" json:"renderFields,omitempty" validate:"required"`
 	Timeout        *time.Duration `yaml:"timeout,omitempty" json:"timeout,omitempty" validate:"required"`
 	TemplateBody   string         `yaml:"templateBody,omitempty" json:"templateBody,omitempty" validate:"required"`
@@ -25,6 +26,7 @@ func (s *NotifDiscord) GetDefaults() *NotifDiscord {
 
 // SetDefaults sets the default values
 func (s *NotifDiscord) SetDefaults() {
+	s.RenderEmbeds = utl.NewTrue()
 	s.RenderFields = utl.NewTrue()
 	s.Timeout = utl.NewDuration(10 * time.Second)
 	s.TemplateBody = NotifDefaultTemplateBody

internal/notif/discord/client.go

@@ -69,44 +69,40 @@ func (c *Client) Send(entry model.NotifEntry) error {
 	}
 	content.WriteString(string(body))
 
-	var fields []EmbedField
-	if *c.cfg.RenderFields {
-		fields = []EmbedField{
-			{
-				Name:  "Hostname",
-				Value: c.meta.Hostname,
-			},
-			{
-				Name:  "Provider",
-				Value: entry.Provider,
-			},
-			{
-				Name:  "Created",
-				Value: entry.Manifest.Created.Format("Jan 02, 2006 15:04:05 UTC"),
-			},
-			{
-				Name:  "Digest",
-				Value: entry.Manifest.Digest.String(),
-			},
-			{
-				Name:  "Platform",
-				Value: entry.Manifest.Platform,
-			},
-		}
-		if len(entry.Image.HubLink) > 0 {
-			fields = append(fields, EmbedField{
-				Name:  "HubLink",
-				Value: entry.Image.HubLink,
-			})
+	var embeds []Embed
+	if *c.cfg.RenderEmbeds {
+		var fields []EmbedField
+		if *c.cfg.RenderFields {
+			fields = []EmbedField{
+				{
+					Name:  "Hostname",
+					Value: c.meta.Hostname,
+				},
+				{
+					Name:  "Provider",
+					Value: entry.Provider,
+				},
+				{
+					Name:  "Created",
+					Value: entry.Manifest.Created.Format("Jan 02, 2006 15:04:05 UTC"),
+				},
+				{
+					Name:  "Digest",
+					Value: entry.Manifest.Digest.String(),
+				},
+				{
+					Name:  "Platform",
+					Value: entry.Manifest.Platform,
+				},
+			}
+			if len(entry.Image.HubLink) > 0 {
+				fields = append(fields, EmbedField{
+					Name:  "HubLink",
+					Value: entry.Image.HubLink,
+				})
+			}
 		}
-	}
-
-	dataBuf := new(bytes.Buffer)
-	if err := json.NewEncoder(dataBuf).Encode(Message{
-		Content:   content.String(),
-		Username:  c.meta.Name,
-		AvatarURL: c.meta.Logo,
-		Embeds: []Embed{
+		embeds = []Embed{
 			{
 				Author: EmbedAuthor{
 					Name:    c.meta.Name,
@@ -118,7 +114,15 @@ func (c *Client) Send(entry model.NotifEntry) error {
 					Text: fmt.Sprintf("%s © %d %s %s", c.meta.Author, time.Now().Year(), c.meta.Name, c.meta.Version),
 				},
 			},
-		},
+		}
+	}
+
+	dataBuf := new(bytes.Buffer)
+	if err := json.NewEncoder(dataBuf).Encode(Message{
+		Content:   content.String(),
+		Username:  c.meta.Name,
+		AvatarURL: c.meta.Logo,
+		Embeds:    embeds,
 	}); err != nil {
 		return err
 	}