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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.notification;
import com.google.common.annotations.VisibleForTesting;
import com.yahoo.config.provision.Environment;
import com.yahoo.config.provision.TenantName;
import com.yahoo.restapi.UriBuilder;
import com.yahoo.text.Text;
import com.yahoo.vespa.flags.FetchVector;
import com.yahoo.vespa.flags.FlagSource;
import com.yahoo.vespa.flags.PermanentFlags;
import com.yahoo.vespa.hosted.controller.api.integration.organization.Mail;
import com.yahoo.vespa.hosted.controller.api.integration.organization.Mailer;
import com.yahoo.vespa.hosted.controller.api.integration.organization.MailerException;
import com.yahoo.vespa.hosted.controller.api.integration.zone.ZoneRegistry;
import com.yahoo.vespa.hosted.controller.persistence.CuratorDb;
import com.yahoo.vespa.hosted.controller.tenant.CloudTenant;
import com.yahoo.vespa.hosted.controller.tenant.TenantContacts;
import com.yahoo.yolean.Exceptions;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.runtime.resource.loader.StringResourceLoader;
import org.apache.velocity.runtime.resource.util.StringResourceRepository;
import org.apache.velocity.tools.generic.EscapeTool;
import java.io.StringWriter;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
/**
* Notifier is responsible for dispatching user notifications to their chosen Contact points.
*
* @author enygaard
*/
public class Notifier {
private final CuratorDb curatorDb;
private final Mailer mailer;
private final FlagSource flagSource;
private final NotificationFormatter formatter;
private final URI dashboardUri;
private final VelocityEngine velocity;
private static final Logger log = Logger.getLogger(Notifier.class.getName());
// Minimal url pattern matcher to detect hardcoded URLs in Notification messages
private static final Pattern urlPattern = Pattern.compile("https://[\\w\\d./]+");
public Notifier(CuratorDb curatorDb, ZoneRegistry zoneRegistry, Mailer mailer, FlagSource flagSource) {
this.curatorDb = Objects.requireNonNull(curatorDb);
this.mailer = Objects.requireNonNull(mailer);
this.flagSource = Objects.requireNonNull(flagSource);
this.formatter = new NotificationFormatter(zoneRegistry);
this.dashboardUri = zoneRegistry.dashboardUrl();
this.velocity = createTemplateEngine();
}
private static VelocityEngine createTemplateEngine() {
var v = new VelocityEngine();
v.setProperty(Velocity.RESOURCE_LOADERS, "string");
v.setProperty(Velocity.RESOURCE_LOADER + ".string.class", StringResourceLoader.class.getName());
v.setProperty(Velocity.RESOURCE_LOADER + ".string.repository.static", "false");
v.init();
var repo = (StringResourceRepository) v.getApplicationAttribute(StringResourceLoader.REPOSITORY_NAME_DEFAULT);
registerTemplate(repo, "mail");
registerTemplate(repo, "default-mail-content");
registerTemplate(repo, "notification-message");
return v;
}
private static void registerTemplate(StringResourceRepository repo, String name) {
var templateStr = Exceptions.uncheck(() -> {
var in = Notifier.class.getResourceAsStream("/mail/%s.vm".formatted(name));
return new String(in.readAllBytes());
});
repo.putStringResource(name, templateStr);
}
public void dispatch(List<Notification> notifications, NotificationSource source) {
if (!dispatchEnabled(source) || skipSource(source)) {
return;
}
if (notifications.isEmpty()) {
return;
}
var tenant = curatorDb.readTenant(source.tenant());
tenant.stream().forEach(t -> {
if (t instanceof CloudTenant ct) {
ct.info().contacts().all().stream()
.filter(c -> c.audiences().contains(TenantContacts.Audience.NOTIFICATIONS))
.collect(Collectors.groupingBy(TenantContacts.Contact::type, Collectors.toList()))
.forEach((type, contacts) -> notifications.forEach(n -> dispatch(n, type, contacts)));
}
});
}
public void dispatch(Notification notification) {
dispatch(List.of(notification), notification.source());
}
private boolean dispatchEnabled(NotificationSource source) {
return PermanentFlags.NOTIFICATION_DISPATCH_FLAG.bindTo(flagSource)
.with(FetchVector.Dimension.TENANT_ID, source.tenant().value())
.value();
}
private boolean skipSource(NotificationSource source) {
// Do not dispatch notification for dev and perf environments
return source.zoneId()
.map(z -> z.environment())
.map(e -> e == Environment.dev || e == Environment.perf)
.orElse(false);
}
private void dispatch(Notification notification, TenantContacts.Type type, Collection<? extends TenantContacts.Contact> contacts) {
switch (type) {
case EMAIL -> dispatch(notification, contacts.stream().map(c -> (TenantContacts.EmailContact) c).toList());
default -> throw new IllegalArgumentException("Unknown TenantContacts type " + type.name());
}
}
private void dispatch(Notification notification, Collection<TenantContacts.EmailContact> contacts) {
try {
log.fine(() -> "Sending notification " + notification + " to " +
contacts.stream().map(c -> c.email().getEmailAddress()).toList());
var content = formatter.format(notification);
mailer.send(mailOf(content, contacts.stream()
.filter(c -> c.email().isVerified())
.map(c -> c.email().getEmailAddress())
.toList()));
} catch (MailerException e) {
log.log(Level.SEVERE, "Failed sending email", e);
} catch (MissingOptionalException e) {
log.log(Level.WARNING, "Missing value in required field '" + e.field() + "' for notification type: " + notification.type(), e);
}
}
public Mail mailOf(FormattedNotification content, Collection<String> recipients) {
var notification = content.notification();
var subject = content.notification().mailContent().flatMap(Notification.MailContent::subject)
.orElseGet(() -> Text.format(
"[%s] %s Vespa Notification for %s", notification.level().toString().toUpperCase(),
content.prettyType(), applicationIdSource(notification.source())));
var html = generateHtml(content);
return new Mail(recipients, subject, "", html);
}
private String generateHtml(FormattedNotification content) {
var esc = new EscapeTool();
var mailContent = content.notification().mailContent().orElseGet(() -> generateContentFromMessages(content, esc));
var ctx = new VelocityContext();
ctx.put("esc", esc);
ctx.put("accountNotificationLink", accountNotificationsUri(content.notification().source().tenant()));
ctx.put("privacyPolicyLink", "https://legal.yahoo.com/xw/en/yahoo/privacy/topic/b2bprivacypolicy/index.html");
ctx.put("termsOfServiceLink", consoleUri("terms-of-service-trial.html"));
ctx.put("supportLink", consoleUri("support"));
ctx.put("mailBodyTemplate", mailContent.template());
mailContent.values().forEach(ctx::put);
var writer = new StringWriter();
// Ignoring return value - implementation either returns 'true' or throws, never 'false'
velocity.mergeTemplate("mail", StandardCharsets.UTF_8.name(), ctx, writer);
return writer.toString();
}
private Notification.MailContent generateContentFromMessages(FormattedNotification f, EscapeTool esc) {
var items = f.notification().messages().stream().map(m -> capitalise(linkify(esc.html(m)))).toList();
return Notification.MailContent.fromTemplate("default-mail-content")
.with("mailMessageTemplate", "notification-message")
.with("mailTitle", "Vespa Cloud Notifications")
.with("notificationHeader", f.messagePrefix())
.with("notificationItems", items)
.with("consoleLink", notificationLink(f.notification().source()))
.build();
}
@VisibleForTesting
static String linkify(String text) {
return urlPattern.matcher(text).replaceAll((res) -> String.format("<a href=\"%s\">%s</a>", res.group(), res.group()));
}
private String applicationIdSource(NotificationSource source) {
StringBuilder sb = new StringBuilder();
sb.append(source.tenant().value());
source.application().ifPresent(applicationName -> sb.append(".").append(applicationName.value()));
source.instance().ifPresent(instanceName -> sb.append(".").append(instanceName.value()));
return sb.toString();
}
private String accountNotificationsUri(TenantName tenant) {
return new UriBuilder(dashboardUri)
.append("tenant/")
.append(tenant.value())
.append("account/notifications")
.toString();
}
private String consoleUri(String path) {
return new UriBuilder(dashboardUri).append(path).toString();
}
private String notificationLink(NotificationSource source) {
var uri = new UriBuilder(dashboardUri);
uri = uri.append("tenant").append(source.tenant().value());
if (source.application().isPresent())
uri = uri.append("application").append(source.application().get().value());
if (source.isProduction()) {
uri = uri.append("prod/instance");
if (source.jobType().isPresent()) {
uri = uri.append(source.instance().get().value());
}
}
else {
uri = uri.append("dev/instance/").append(source.instance().get().value());
}
if (source.jobType().isPresent()) {
uri = uri.append("job").append(source.jobType().get().jobName()).append("run").append(String.valueOf(source.runNumber().getAsLong()));
}
return uri.toString();
}
private static String capitalise(String m) {
return m.substring(0, 1).toUpperCase() + m.substring(1);
}
}
|
