/
teams_renderer.go
145 lines (125 loc) · 4.24 KB
/
teams_renderer.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
package bot
import (
"fmt"
"strings"
"time"
cards "github.com/DanielTitkov/go-adaptive-cards"
"github.com/kubeshop/botkube/pkg/api"
"github.com/kubeshop/botkube/pkg/bot/interactive"
)
// TeamsRenderer provides functionality to render MS Teams specific messages from a generic models.
type TeamsRenderer struct {
mdFormatter interactive.MDFormatter
}
// NewTeamsRenderer return a new TeamsRenderer instance.
func NewTeamsRenderer() *TeamsRenderer {
return &TeamsRenderer{
mdFormatter: interactive.NewMDFormatter(msNewLineFormatter, interactive.MdHeaderFormatter),
}
}
// MessageToMarkdown renders message in Markdown format.
func (r *TeamsRenderer) MessageToMarkdown(in interactive.CoreMessage) string {
return interactive.RenderMessage(r.mdFormatter, in)
}
// NonInteractiveSectionToCard returns AdaptiveCard for the given message.
// Note: It cannot be used for other messages as we take into account only first message section with limited primitives:
// - TextFields
// - BulletLists
// - Timestamp
// It should be removed once we will add support for a proper message renderer.
func (r *TeamsRenderer) NonInteractiveSectionToCard(msg interactive.CoreMessage) (*cards.Card, error) {
if err := IsValidNonInteractiveSingleSection(msg); err != nil {
return nil, err
}
event := msg.Sections[0]
var nodes []cards.Node
if event.Base.Header != "" {
nodes = append(nodes, &cards.TextBlock{
Size: "Large",
Text: replaceEmojiTagsWithActualOne(event.Base.Header),
})
}
nodes = r.appendIfNotNil(nodes, r.renderTextFields(event.TextFields))
nodes = r.appendIfNotNil(nodes, r.renderBulletLists(event.BulletLists)...)
nodes = r.appendIfNotNil(nodes, r.renderTimestamp(msg.Timestamp))
card := cards.New(nodes, []cards.Node{}).
WithSchema(cards.DefaultSchema).
WithVersion(cards.Version12)
if err := card.Prepare(); err != nil {
return nil, fmt.Errorf("while preparing event card message: %w", err)
}
return card, nil
}
// the cards.Prepare() method panics on nil items, so we need to filter them out.
func (r *TeamsRenderer) appendIfNotNil(slice []cards.Node, elems ...cards.Node) []cards.Node {
for _, elem := range elems {
if elem == nil {
continue
}
slice = append(slice, elem)
}
return slice
}
func (r *TeamsRenderer) renderTextFields(item api.TextFields) cards.Node {
var facts []*cards.Fact
for _, field := range item {
if field.IsEmpty() {
continue
}
facts = append(facts, &cards.Fact{
Title: replaceEmojiTagsWithActualOne(field.Key),
Value: replaceEmojiTagsWithActualOne(field.Value),
})
}
if len(facts) == 0 {
return nil
}
return &cards.FactSet{
Facts: facts,
}
}
func (r *TeamsRenderer) renderBulletLists(in api.BulletLists) []cards.Node {
var out []cards.Node
for _, list := range in {
out = append(out, r.renderSingleBulletList(list)...)
}
return out
}
func (r *TeamsRenderer) renderSingleBulletList(item api.BulletList) []cards.Node {
return []cards.Node{
&cards.TextBlock{
Text: fmt.Sprintf("**%s**", replaceEmojiTagsWithActualOne(item.Title)),
},
&cards.TextBlock{
Text: r.bulletList(item.Items),
Wrap: cards.TruePtr(),
},
}
}
// https://learn.microsoft.com/en-us/adaptive-cards/authoring-cards/text-features#datetime-function-rules
func (r *TeamsRenderer) renderTimestamp(in time.Time) cards.Node {
if in.IsZero() {
return nil
}
timestamp := in.UTC().Format("2006-01-02T15:04:05Z")
return &cards.TextBlock{
Text: fmt.Sprintf("_{{DATE(%s, SHORT)}} at {{TIME(%s)}}_", timestamp, timestamp),
}
}
// https://learn.microsoft.com/en-us/adaptive-cards/authoring-cards/text-features#markdown-commonmark-subset
func (r *TeamsRenderer) bulletList(msgs []string) string {
for idx, item := range msgs {
// We need to change the new line encoding, otherwise it will be printed in a single line. Example use-case:
//
// spec.template.spec.containers[*].image:
// -: ghcr.io/kubeshop/botkube:v9.99.9-dev
// +: ghcr.io/kubeshop/botkube:v1.0.0
msgs[idx] = strings.ReplaceAll(item, "\n", "\n\n\t\t")
}
return replaceEmojiTagsWithActualOne(fmt.Sprintf("- %s", strings.Join(msgs, "\r- ")))
}
func msNewLineFormatter(msg string) string {
// e.g. `:rocket:` is not supported by MS Teams, so we need to replace it with actual emoji
msg = replaceEmojiTagsWithActualOne(msg)
return fmt.Sprintf("%s\n\n", msg)
}