Skip to content

Commit 858f2f8

Browse files
MikaKermanMikaKerman
committed
Refactor alert message formatting to improve clarity
* Updated the AlertMessageBuilder to conditionally format the display of owners and subscribers, ensuring a consistent use of separators. * Adjusted test cases and fixture files to reflect the new formatting, enhancing the clarity of alert messages. * Modified the logic for subscriber handling to ensure proper display based on the presence of owners.
1 parent 17622c9 commit 858f2f8

15 files changed

Lines changed: 140 additions & 137 deletions

File tree

‎elementary/monitor/alerts/alert_messages/builder.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -427,9 +427,12 @@ def _get_alert_list_line(
427427
inlines.append(TextBlock(text="Owners:"))
428428
inlines.append(MentionLineBlock(*owners))
429429

430-
if subscribers := list(set(alert.subscribers)):
431-
if self.config.alert_groups_subscribers:
432-
inlines.append(TextBlock(text="-"))
430+
if self.config.alert_groups_subscribers:
431+
if subscribers := list(set(alert.subscribers)):
432+
if owners:
433+
inlines.append(TextBlock(text=" | "))
434+
else:
435+
inlines.append(TextBlock(text="-"))
433436
subscribers.sort()
434437
inlines.append(TextBlock(text="Subscribers:"))
435438
inlines.append(MentionLineBlock(*subscribers))

‎elementary/monitor/dbt_project/package-lock.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
packages:
22
- package: dbt-labs/dbt_utils
33
version: 0.8.6
4-
- git: https://github.com/elementary-data/dbt-data-reliability.git
5-
revision: cc226bf865f922d6c4c5c6d65b2a142540e222f8
6-
sha1_hash: a838112140dab39e15226f415d0b0bcbfbe311ff
4+
- package: elementary-data/elementary
5+
version: 0.18.2
6+
sha1_hash: 0e32f8128c729542efc1b5c8e2c4fbe6f6534369

‎tests/unit/alerts/alert_messages/fixtures/adaptive_card/alerts_group_model-errors-False_test-failures-False_test-warnings-True_test-errors-True_link-False_env-False_subscribers-True.json‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,47 +41,47 @@
4141
},
4242
{
4343
"type": "TextBlock",
44-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_2** - Owners: owner1 - Subscribers: subscriber1",
44+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_2** - Owners: owner1 | Subscribers: subscriber1",
4545
"wrap": true
4646
},
4747
{
4848
"type": "TextBlock",
49-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
49+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 | Subscribers: subscriber1, subscriber2",
5050
"wrap": true
5151
},
5252
{
5353
"type": "TextBlock",
54-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_4**",
54+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_4** - Subscribers: subscriber1, subscriber2",
5555
"wrap": true
5656
},
5757
{
5858
"type": "TextBlock",
59-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_5** - Owners: owner1 - Subscribers: subscriber1",
59+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_5** - Owners: owner1",
6060
"wrap": true
6161
},
6262
{
6363
"type": "TextBlock",
64-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
64+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 | Subscribers: subscriber1",
6565
"wrap": true
6666
},
6767
{
6868
"type": "TextBlock",
69-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_7**",
69+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_7** - Subscribers: subscriber1, subscriber2",
7070
"wrap": true
7171
},
7272
{
7373
"type": "TextBlock",
74-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_8** - Owners: owner1 - Subscribers: subscriber1",
74+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_8** - Owners: owner1 | Subscribers: subscriber1, subscriber2",
7575
"wrap": true
7676
},
7777
{
7878
"type": "TextBlock",
79-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
79+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2",
8080
"wrap": true
8181
},
8282
{
8383
"type": "TextBlock",
84-
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_10**",
84+
"text": "\u26a0\ufe0f **\"test_short_name\" test failed on test_table_10** - Subscribers: subscriber1",
8585
"wrap": true
8686
}
8787
]
@@ -102,47 +102,47 @@
102102
},
103103
{
104104
"type": "TextBlock",
105-
"text": "\u2757 **\"test_short_name\" test failed on test_table_2** - Owners: owner1 - Subscribers: subscriber1",
105+
"text": "\u2757 **\"test_short_name\" test failed on test_table_2** - Owners: owner1 | Subscribers: subscriber1",
106106
"wrap": true
107107
},
108108
{
109109
"type": "TextBlock",
110-
"text": "\u2757 **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
110+
"text": "\u2757 **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 | Subscribers: subscriber1, subscriber2",
111111
"wrap": true
112112
},
113113
{
114114
"type": "TextBlock",
115-
"text": "\u2757 **\"test_short_name\" test failed on test_table_4**",
115+
"text": "\u2757 **\"test_short_name\" test failed on test_table_4** - Subscribers: subscriber1, subscriber2",
116116
"wrap": true
117117
},
118118
{
119119
"type": "TextBlock",
120-
"text": "\u2757 **\"test_short_name\" test failed on test_table_5** - Owners: owner1 - Subscribers: subscriber1",
120+
"text": "\u2757 **\"test_short_name\" test failed on test_table_5** - Owners: owner1",
121121
"wrap": true
122122
},
123123
{
124124
"type": "TextBlock",
125-
"text": "\u2757 **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
125+
"text": "\u2757 **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 | Subscribers: subscriber1",
126126
"wrap": true
127127
},
128128
{
129129
"type": "TextBlock",
130-
"text": "\u2757 **\"test_short_name\" test failed on test_table_7**",
130+
"text": "\u2757 **\"test_short_name\" test failed on test_table_7** - Subscribers: subscriber1, subscriber2",
131131
"wrap": true
132132
},
133133
{
134134
"type": "TextBlock",
135-
"text": "\u2757 **\"test_short_name\" test failed on test_table_8** - Owners: owner1 - Subscribers: subscriber1",
135+
"text": "\u2757 **\"test_short_name\" test failed on test_table_8** - Owners: owner1 | Subscribers: subscriber1, subscriber2",
136136
"wrap": true
137137
},
138138
{
139139
"type": "TextBlock",
140-
"text": "\u2757 **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
140+
"text": "\u2757 **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2",
141141
"wrap": true
142142
},
143143
{
144144
"type": "TextBlock",
145-
"text": "\u2757 **\"test_short_name\" test failed on test_table_10**",
145+
"text": "\u2757 **\"test_short_name\" test failed on test_table_10** - Subscribers: subscriber1",
146146
"wrap": true
147147
}
148148
]

‎tests/unit/alerts/alert_messages/fixtures/adaptive_card/alerts_group_model-errors-False_test-failures-True_test-warnings-False_test-errors-False_link-False_env-False_subscribers-True.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,47 +41,47 @@
4141
},
4242
{
4343
"type": "TextBlock",
44-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_2** - Owners: owner1 - Subscribers: subscriber1",
44+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_2** - Owners: owner1 | Subscribers: subscriber1",
4545
"wrap": true
4646
},
4747
{
4848
"type": "TextBlock",
49-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
49+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 | Subscribers: subscriber1, subscriber2",
5050
"wrap": true
5151
},
5252
{
5353
"type": "TextBlock",
54-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_4**",
54+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_4** - Subscribers: subscriber1, subscriber2",
5555
"wrap": true
5656
},
5757
{
5858
"type": "TextBlock",
59-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_5** - Owners: owner1 - Subscribers: subscriber1",
59+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_5** - Owners: owner1",
6060
"wrap": true
6161
},
6262
{
6363
"type": "TextBlock",
64-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
64+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 | Subscribers: subscriber1",
6565
"wrap": true
6666
},
6767
{
6868
"type": "TextBlock",
69-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_7**",
69+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_7** - Subscribers: subscriber1, subscriber2",
7070
"wrap": true
7171
},
7272
{
7373
"type": "TextBlock",
74-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_8** - Owners: owner1 - Subscribers: subscriber1",
74+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_8** - Owners: owner1 | Subscribers: subscriber1, subscriber2",
7575
"wrap": true
7676
},
7777
{
7878
"type": "TextBlock",
79-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
79+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2",
8080
"wrap": true
8181
},
8282
{
8383
"type": "TextBlock",
84-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_10**",
84+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_10** - Subscribers: subscriber1",
8585
"wrap": true
8686
}
8787
]

‎tests/unit/alerts/alert_messages/fixtures/adaptive_card/alerts_group_model-errors-False_test-failures-True_test-warnings-False_test-errors-True_link-False_env-False_subscribers-True.json‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,47 +41,47 @@
4141
},
4242
{
4343
"type": "TextBlock",
44-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_2** - Owners: owner1 - Subscribers: subscriber1",
44+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_2** - Owners: owner1 | Subscribers: subscriber1",
4545
"wrap": true
4646
},
4747
{
4848
"type": "TextBlock",
49-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
49+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 | Subscribers: subscriber1, subscriber2",
5050
"wrap": true
5151
},
5252
{
5353
"type": "TextBlock",
54-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_4**",
54+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_4** - Subscribers: subscriber1, subscriber2",
5555
"wrap": true
5656
},
5757
{
5858
"type": "TextBlock",
59-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_5** - Owners: owner1 - Subscribers: subscriber1",
59+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_5** - Owners: owner1",
6060
"wrap": true
6161
},
6262
{
6363
"type": "TextBlock",
64-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
64+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 | Subscribers: subscriber1",
6565
"wrap": true
6666
},
6767
{
6868
"type": "TextBlock",
69-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_7**",
69+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_7** - Subscribers: subscriber1, subscriber2",
7070
"wrap": true
7171
},
7272
{
7373
"type": "TextBlock",
74-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_8** - Owners: owner1 - Subscribers: subscriber1",
74+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_8** - Owners: owner1 | Subscribers: subscriber1, subscriber2",
7575
"wrap": true
7676
},
7777
{
7878
"type": "TextBlock",
79-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
79+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2",
8080
"wrap": true
8181
},
8282
{
8383
"type": "TextBlock",
84-
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_10**",
84+
"text": "\ud83d\udd3a **\"test_short_name\" test failed on test_table_10** - Subscribers: subscriber1",
8585
"wrap": true
8686
}
8787
]
@@ -102,47 +102,47 @@
102102
},
103103
{
104104
"type": "TextBlock",
105-
"text": "\u2757 **\"test_short_name\" test failed on test_table_2** - Owners: owner1 - Subscribers: subscriber1",
105+
"text": "\u2757 **\"test_short_name\" test failed on test_table_2** - Owners: owner1 | Subscribers: subscriber1",
106106
"wrap": true
107107
},
108108
{
109109
"type": "TextBlock",
110-
"text": "\u2757 **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
110+
"text": "\u2757 **\"test_short_name\" test failed on test_table_3** - Owners: owner1, owner2 | Subscribers: subscriber1, subscriber2",
111111
"wrap": true
112112
},
113113
{
114114
"type": "TextBlock",
115-
"text": "\u2757 **\"test_short_name\" test failed on test_table_4**",
115+
"text": "\u2757 **\"test_short_name\" test failed on test_table_4** - Subscribers: subscriber1, subscriber2",
116116
"wrap": true
117117
},
118118
{
119119
"type": "TextBlock",
120-
"text": "\u2757 **\"test_short_name\" test failed on test_table_5** - Owners: owner1 - Subscribers: subscriber1",
120+
"text": "\u2757 **\"test_short_name\" test failed on test_table_5** - Owners: owner1",
121121
"wrap": true
122122
},
123123
{
124124
"type": "TextBlock",
125-
"text": "\u2757 **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
125+
"text": "\u2757 **\"test_short_name\" test failed on test_table_6** - Owners: owner1, owner2 | Subscribers: subscriber1",
126126
"wrap": true
127127
},
128128
{
129129
"type": "TextBlock",
130-
"text": "\u2757 **\"test_short_name\" test failed on test_table_7**",
130+
"text": "\u2757 **\"test_short_name\" test failed on test_table_7** - Subscribers: subscriber1, subscriber2",
131131
"wrap": true
132132
},
133133
{
134134
"type": "TextBlock",
135-
"text": "\u2757 **\"test_short_name\" test failed on test_table_8** - Owners: owner1 - Subscribers: subscriber1",
135+
"text": "\u2757 **\"test_short_name\" test failed on test_table_8** - Owners: owner1 | Subscribers: subscriber1, subscriber2",
136136
"wrap": true
137137
},
138138
{
139139
"type": "TextBlock",
140-
"text": "\u2757 **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2 - Subscribers: subscriber1, subscriber2",
140+
"text": "\u2757 **\"test_short_name\" test failed on test_table_9** - Owners: owner1, owner2",
141141
"wrap": true
142142
},
143143
{
144144
"type": "TextBlock",
145-
"text": "\u2757 **\"test_short_name\" test failed on test_table_10**",
145+
"text": "\u2757 **\"test_short_name\" test failed on test_table_10** - Subscribers: subscriber1",
146146
"wrap": true
147147
}
148148
]

0 commit comments

Comments
 (0)