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

Jump to bottom

Include message with emails #849

Merged
merged 6 commits into from
Jan 28, 2016
Merged

Include message with emails #849

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
525663b
When the user modifies a request and adds an optional message, this m…
Jan 19, 2016
095f312
Changes that were accidentally not staged as part of previous commit
Jan 19, 2016
a348a4a
Changed the email logging option to happen in a central place
Jan 20, 2016
6ab9765
And changed the logging to trace
Jan 20, 2016
2a29eae
Now logs at trace level, and lists to and cc in addition to the body
Jan 20, 2016
b88a2e8
Removed extraneous newlines
Jan 20, 2016
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
2 changes: 1 addition & 1 deletion SingularityService/src/main/java/com/hubspot/singularity/helpers/RequestHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public RequestHelper(RequestManager requestManager, SingularityMailer mailer, De
}

public long unpause(SingularityRequest request, Optional<String> user, Optional<String> message, Optional<Boolean> skipHealthchecks) {
mailer.sendRequestUnpausedMail(request, user);
mailer.sendRequestUnpausedMail(request, user, message);

Optional<String> maybeDeployId = deployManager.getInUseDeployId(request.getId());

Expand Down
2 changes: 1 addition & 1 deletion SingularityService/src/main/java/com/hubspot/singularity/resources/RequestResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ public SingularityRequest deleteRequest(@ApiParam("The request ID to delete.") @

requestManager.deleteRequest(request, JavaUtils.getUserEmail(user), actionId, message);

mailer.sendRequestRemovedMail(request, JavaUtils.getUserEmail(user));
mailer.sendRequestRemovedMail(request, JavaUtils.getUserEmail(user), message);

return request;
}
Expand Down
30 changes: 21 additions & 9 deletions SingularityService/src/main/java/com/hubspot/singularity/smtp/SingularityMailer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ public SingularityEmailType getEmailType() {

}

private void sendRequestMail(final SingularityRequest request, final RequestMailType type, final Optional<String> user, final Optional<Map<String, Object>> additionalProperties) {
private void sendRequestMail(final SingularityRequest request, final RequestMailType type, final Optional<String> user, final Optional<String> message, final Optional<Map<String, Object>> additionalProperties) {
if (!maybeSmtpConfiguration.isPresent()) {
LOG.debug("Not sending request mail - no SMTP configuration is present");
return;
Expand All @@ -344,7 +344,7 @@ private void sendRequestMail(final SingularityRequest request, final RequestMail
@Override
public void run() {
try {
prepareRequestMail(request, type, user, additionalProperties);
prepareRequestMail(request, type, user, message, additionalProperties);
} catch (Throwable t) {
LOG.error("While preparing request mail for {} / {}", request, type, t);
exceptionNotifier.notify(t, ImmutableMap.of("requestId", request.getId()));
Expand All @@ -353,7 +353,7 @@ public void run() {
});
}

private void prepareRequestMail(SingularityRequest request, RequestMailType type, Optional<String> user, Optional<Map<String, Object>> additionalProperties) {
private void prepareRequestMail(SingularityRequest request, RequestMailType type, Optional<String> user, Optional<String> message, Optional<Map<String, Object>> additionalProperties) {
final List<SingularityEmailDestination> emailDestination = getDestination(request, type.getEmailType());

if (emailDestination.isEmpty()) {
Expand All @@ -371,11 +371,16 @@ private void prepareRequestMail(SingularityRequest request, RequestMailType type
templateProperties.put("requestScaled", type == RequestMailType.SCALED);
templateProperties.put("action", type.name().toLowerCase());
templateProperties.put("hasUser", user.isPresent());
templateProperties.put("hasMessage", message.isPresent());

if (user.isPresent()) {
templateProperties.put("user", user.get());
}

if (message.isPresent()) {
templateProperties.put("message", message.get());
}

if (additionalProperties.isPresent()) {
templateProperties.putAll(additionalProperties.get());
}
Expand Down Expand Up @@ -403,38 +408,45 @@ public void sendRequestPausedMail(SingularityRequest request, Optional<Singulari

Boolean killTasks = Boolean.TRUE;

Optional<String> message = Optional.absent();

if (pauseRequest.isPresent()) {
setupExpireFormat(additionalProperties, pauseRequest.get().getDurationMillis());

if (pauseRequest.get().getKillTasks().isPresent()) {
killTasks = pauseRequest.get().getKillTasks().get();
}

message = pauseRequest.get().getMessage();
}

additionalProperties.put("killTasks", killTasks);

sendRequestMail(request, RequestMailType.PAUSED, user, Optional.of(additionalProperties));
sendRequestMail(request, RequestMailType.PAUSED, user, message, Optional.of(additionalProperties));
}

public void sendRequestUnpausedMail(SingularityRequest request, Optional<String> user) {
sendRequestMail(request, RequestMailType.UNPAUSED, user, Optional.<Map<String, Object>> absent());
public void sendRequestUnpausedMail(SingularityRequest request, Optional<String> user, Optional<String> message) {
sendRequestMail(request, RequestMailType.UNPAUSED, user, message, Optional.<Map<String, Object>> absent());
}

public void sendRequestScaledMail(SingularityRequest request, Optional<SingularityScaleRequest> newScaleRequest, Optional<Integer> formerInstances, Optional<String> user) {
Map<String, Object> additionalProperties = new HashMap<>();

Optional<String> message = Optional.absent();

if (newScaleRequest.isPresent()) {
setupExpireFormat(additionalProperties, newScaleRequest.get().getDurationMillis());
message = newScaleRequest.get().getMessage();
}

additionalProperties.put("newInstances", request.getInstancesSafe());
additionalProperties.put("oldInstances", formerInstances.or(1));

sendRequestMail(request, RequestMailType.SCALED, user, Optional.of(additionalProperties));
sendRequestMail(request, RequestMailType.SCALED, user, message, Optional.of(additionalProperties));
}

public void sendRequestRemovedMail(SingularityRequest request, Optional<String> user) {
sendRequestMail(request, RequestMailType.REMOVED, user, Optional.<Map<String, Object>> absent());
public void sendRequestRemovedMail(SingularityRequest request, Optional<String> user, Optional<String> message) {
sendRequestMail(request, RequestMailType.REMOVED, user, message, Optional.<Map<String, Object>> absent());
}

public void sendRequestInCooldownMail(final SingularityRequest request) {
Expand Down
10 changes: 10 additions & 0 deletions SingularityService/src/main/java/com/hubspot/singularity/smtp/SingularitySmtpSender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,17 @@

import io.dropwizard.lifecycle.Managed;



Copy link
Member

Choose a reason for hiding this comment

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

super nit-picky, but can we get rid of these extra new lines here and down by the LOG.trace

@Singleton
public class SingularitySmtpSender implements Managed {

private static final Logger LOG = LoggerFactory.getLogger(SingularitySmtpSender.class);

/// Set this to true to log emails being sent. This allows testing locally without setting up an SMTP server
/// To find the email html, grep the logs: "grep TheMail -A 10" (change 10 depending on how many lines you need)
private static final Boolean LOG_EMAILS_FOR_DEBUG = false;

private final Optional<SMTPConfiguration> maybeSmtpConfiguration;
private final Optional<ThreadPoolExecutor> mailSenderExecutorService;
private final SingularityExceptionNotifier exceptionNotifier;
Expand Down Expand Up @@ -62,6 +68,10 @@ public void stop() {
}

public void queueMail(final List<String> toList, final List<String> ccList, final String subject, final String body) {
if (LOG_EMAILS_FOR_DEBUG) {
LOG.trace("TheMail: " + body);
Copy link
Member

Choose a reason for hiding this comment

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

We can do without the LOG_EMAILS_FOR_DEBUG. We can control the logging level for each class in the configuration for Singularity, so just putting it at trace should be enough.

Also for logging, you can so something more like this rather that using "string" + "string"

LOG.trace("Sending email: {}, to: {}, cc: {}", body, toList, ccList)

Copy link
Member

Choose a reason for hiding this comment

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

For readability I've found it to be easier to put the recipients first and the body last so you're not scrolling through a wall of HTML looking for the recipient at the end

}

if (toList.isEmpty()) {
LOG.warn("Couldn't queue email {} because no to address is present", subject);
return;
Expand Down
2 changes: 2 additions & 0 deletions SingularityService/src/main/resources/templates/request_modified.jade
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ html
h2(style="font-weight: normal; margin: 0 0 21px; line-height: 1") has been #{ action } by #{ user }
else
h2(style="font-weight: normal; margin: 0 0 21px; line-height: 1") has been #{ action }
if hasMessage
h2(style="font-weight: normal; margin: 0 0 21px; line-height: 1") Message: #{ message }
if singularityRequestLink
a(style="background: #08c; color: #fff; padding: 10px 20px; display: inline-block; text-decoration: none; font-size: 13px; letter-spacing: .08em; text-transform: uppercase; border-radius: 3px", href="#{ singularityRequestLink }") View request

Expand Down