Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use async qute templating for email notifications #1969

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Use async qute templating for email notifications #1969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 28 additions & 25 deletions horreum-backend/src/main/java/io/hyperfoil/tools/horreum/notification/EmailPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.hyperfoil.tools.horreum.notification;

import static java.nio.charset.StandardCharsets.UTF_8;

import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.time.Duration;
import java.time.Instant;
Expand All @@ -11,11 +13,11 @@
import jakarta.inject.Inject;

import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;

import io.hyperfoil.tools.horreum.events.DatasetChanges;
import io.hyperfoil.tools.horreum.svc.MissingValuesEvent;
import io.hyperfoil.tools.horreum.svc.ServiceException;
import io.quarkus.logging.Log;
import io.quarkus.mailer.Mail;
import io.quarkus.mailer.reactive.ReactiveMailer;
import io.quarkus.qute.Location;
Expand Down Expand Up @@ -47,7 +49,7 @@ public class EmailPlugin implements NotificationPlugin {
@Inject
ReactiveMailer mailer;

private final Logger log = Logger.getLogger(getClass());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why you switched from a custom logger in favor of the default io.quarkus.logging.Log?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@barreiro please can you answer this question?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quarkus simplified logging is the idiomatic (and recommended) way to log in quarkus.

It does not change the functionality: the Logger will be created for you and the static calls will be routed to that instance.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, then I think we can convert all the other loggers to this one to be consistent across the whole codebase. I will create a "good first issue" to keep track of this :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created #1993

private final DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

@Override
public String method() {
Expand Down Expand Up @@ -77,26 +79,26 @@ protected EmailNotification(String username, String data) {
@Override
public void notifyChanges(DatasetChanges event) {
String subject = subjectPrefix + " Change in " + event.testName;
String content = changeNotificationEmail
changeNotificationEmail
.data("username", username)
.data("testName", event.testName)
.data("fingerprint",
URLEncoder.encode(event.fingerprint != null ? event.fingerprint : "", StandardCharsets.UTF_8))
.data("fingerprint", URLEncoder.encode(event.fingerprint != null ? event.fingerprint : "", UTF_8))
.data("baseUrl", baseUrl)
.data("testId", String.valueOf(event.dataset.testId))
.data("runId", event.dataset.runId)
.data("datasetOrdinal", event.dataset.ordinal)
.data("changes", event.changes())
.render();
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
log.debug("Sending mail: " + content);
.createUni().subscribe().with(content -> {
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
Log.debug("Sending mail: " + content);
});
}

@Override
public void notifyMissingDataset(String testName, int testId, String ruleName, long maxStaleness,
Instant lastTimestamp) {
String subject = String.format("%s Missing expected data for %s/%s", subjectPrefix, testName, ruleName);
String content = missingDatasetNotificationEmail
missingDatasetNotificationEmail
.data("username", username)
.data("testName", testName)
.data("testId", String.valueOf(testId))
Expand All @@ -106,19 +108,18 @@ public void notifyMissingDataset(String testName, int testId, String ruleName, l
.data("currentStaleness",
lastTimestamp == null ? "yet"
: "in " + prettyPrintTime(System.currentTimeMillis() - lastTimestamp.toEpochMilli()))
.data("lastTimestamp",
lastTimestamp == null ? null
: new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(Date.from(lastTimestamp)))
.render();
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
log.debug("Sending mail: " + content);
.data("lastTimestamp", lastTimestamp == null ? null : dateFormat.format(Date.from(lastTimestamp)))
.createUni().subscribe().with(content -> {
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
Log.debug("Sending mail: " + content);
});
}

@Override
public void notifyMissingValues(String testName, String fingerprint, MissingValuesEvent event) {
String subject = String.format("%s Missing change detection values in test %s, dataset %d#%d",
subjectPrefix, testName, event.dataset.runId, event.dataset.ordinal + 1);
String content = missingValuesNotificationEmail
missingValuesNotificationEmail
.data("username", username)
.data("testName", testName)
.data("testId", String.valueOf(event.dataset.testId))
Expand All @@ -127,25 +128,27 @@ public void notifyMissingValues(String testName, String fingerprint, MissingValu
.data("runId", event.dataset.runId)
.data("datasetOrdinal", event.dataset.ordinal)
.data("variables", event.variables)
.render();
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
log.debug("Sending mail: " + content);
.createUni().subscribe().with(content -> {
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
Log.debug("Sending mail: " + content);
});
}

@Override
public void notifyExpectedRun(String testName, int testId, long before, String expectedBy, String backlink) {
String subject = subjectPrefix + " Missing expected run for " + testName;
String content = expectedRunNotificationEmail
expectedRunNotificationEmail
.data("username", username)
.data("testName", testName)
.data("testId", String.valueOf(testId))
.data("baseUrl", baseUrl)
.data("before", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(before)))
.data("before", dateFormat.format(new Date(before)))
.data("expectedBy", expectedBy)
.data("backlink", backlink)
.render();
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
log.debug("Sending mail: " + content);
.createUni().subscribe().with(content -> {
mailer.send(Mail.withHtml(data, subject, content)).await().atMost(sendMailTimeout);
Log.debug("Sending mail: " + content);
});
}
}

Expand Down
Loading