#5772

Committed 29 Apr 2025 01:12PM UTC coverage: 79.983% (+0.5%) from 79.492%

Build # #5772

Build Type

push

Committed by

Commit Message

DT-1542: Refactor email sending service code (#2499)

Run Details

172 of 179 new or added lines in 18 files covered. (96.09%)

12 existing lines in 2 files now uncovered.

10257 of 12824 relevant lines covered (79.98%)

0.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.88

/src/main/java/org/broadinstitute/consent/http/mail/SendGridAPI.java

package org.broadinstitute.consent.http.mail;

import com.google.api.client.http.HttpStatusCodes;
import com.sendgrid.Method;
import com.sendgrid.Request;
import com.sendgrid.Response;
import com.sendgrid.SendGrid;
import com.sendgrid.helpers.mail.Mail;
import jakarta.ws.rs.WebApplicationException;
import java.io.IOException;
import java.util.Map;
import java.util.Objects;
import org.broadinstitute.consent.http.configurations.MailConfiguration;
import org.broadinstitute.consent.http.db.UserDAO;
import org.broadinstitute.consent.http.models.User;
import org.broadinstitute.consent.http.util.ConsentLogger;

public class SendGridAPI implements ConsentLogger {

  private final SendGrid sendGrid;
  private final boolean activateEmailNotifications;

  private final UserDAO userDAO;

  public SendGridAPI(MailConfiguration config, UserDAO userDAO) {
    this.sendGrid = new SendGrid(config.getSendGridApiKey());
    this.activateEmailNotifications = config.isActivateEmailNotifications();
    this.userDAO = userDAO;
  }

  /**
   * Determine if the user we are sending an email to has set their preference to false or not.
   * Users who have been disabled like this should never receive an email.
   *
   * @param userEmail The email of the user we are sending an email to.
   * @return False if the user has explicitly disabled email, True otherwise.
   */
  private boolean findUserEmailPreference(String userEmail) {
    User user = userDAO.findUserByEmail(userEmail);
    if (user == null) {
      logWarn("Unknown user ID: %s".formatted(userEmail));
      return false;
    }
    return Objects.requireNonNullElse(user.getEmailPreference(), true);
  }

  public Response sendMessage(Mail message, String toUserEmail) {
    if (!activateEmailNotifications) {
      return null;
    }
    boolean userEmailPreference = findUserEmailPreference(toUserEmail);
    if (!userEmailPreference) {
      logInfo(
          "User Email Preference has evaluated to 'false', not sending to: %s"
              .formatted(toUserEmail));
      return null;
    }
    try {
      // See https://github.com/sendgrid/sendgrid-java/issues/163
      // for what actually works as compared to the documentation - which doesn't.
      Request request = new Request();
      request.setMethod(Method.POST);
      request.setBody(message.build());
      // make request
      request.setBaseUri(sendGrid.getHost());
      request.setEndpoint("/" + sendGrid.getVersion() + "/mail/send");
      sendGrid.getRequestHeaders().forEach(request::addHeader);
      // send
      Response response = sendGrid.makeCall(request);
      if (response.getStatusCode() > 202) {
        // Indicates some form of error:
        // https://docs.sendgrid.com/api-reference/mail-send/mail-send#responses
        logException(
            "Error sending email via SendGrid: '%s': %s"
                .formatted(response.getStatusCode(), response.getBody()),
            new WebApplicationException(response.getStatusCode()));
      }
      return response;
    } catch (IOException ex) {
      logException("Exception sending email via SendGrid: %s".formatted(ex.getMessage()), ex);
      // Create a response that we can use to capture this failure.
      return new Response(HttpStatusCodes.STATUS_CODE_SERVER_ERROR, ex.getMessage(), Map.of());
    }
  }
}

1	package org.broadinstitute.consent.http.mail;
2
3	import com.google.api.client.http.HttpStatusCodes;
4	import com.sendgrid.Method;
5	import com.sendgrid.Request;
6	import com.sendgrid.Response;
7	import com.sendgrid.SendGrid;
8	import com.sendgrid.helpers.mail.Mail;
9	import jakarta.ws.rs.WebApplicationException;
10	import java.io.IOException;
11	import java.util.Map;
12	import java.util.Objects;
13	import org.broadinstitute.consent.http.configurations.MailConfiguration;
14	import org.broadinstitute.consent.http.db.UserDAO;
15	import org.broadinstitute.consent.http.models.User;
16	import org.broadinstitute.consent.http.util.ConsentLogger;
17
18	public class SendGridAPI implements ConsentLogger {
19
20	private final SendGrid sendGrid;
21	private final boolean activateEmailNotifications;
22
23	private final UserDAO userDAO;
24
25	public SendGridAPI(MailConfiguration config, UserDAO userDAO) {	1✔
26	this.sendGrid = new SendGrid(config.getSendGridApiKey());	1✔
27	this.activateEmailNotifications = config.isActivateEmailNotifications();	1✔
28	this.userDAO = userDAO;	1✔
29	}	1✔
30
31	/**
32	* Determine if the user we are sending an email to has set their preference to false or not.
33	* Users who have been disabled like this should never receive an email.
34	*
35	* @param userEmail The email of the user we are sending an email to.
36	* @return False if the user has explicitly disabled email, True otherwise.
37	*/
38	private boolean findUserEmailPreference(String userEmail) {
39	User user = userDAO.findUserByEmail(userEmail);	1✔
40	if (user == null) {	1✔
41	logWarn("Unknown user ID: %s".formatted(userEmail));	1✔
42	return false;	1✔
43	}
44	return Objects.requireNonNullElse(user.getEmailPreference(), true);	1✔
45	}
46
47	public Response sendMessage(Mail message, String toUserEmail) {
48	if (!activateEmailNotifications) {	1✔
NEW 49	return null;	×
50	}
51	boolean userEmailPreference = findUserEmailPreference(toUserEmail);	1✔
52	if (!userEmailPreference) {	1✔
53	logInfo(	1✔
54	"User Email Preference has evaluated to 'false', not sending to: %s"
55	.formatted(toUserEmail));	1✔
56	return null;	1✔
57	}
58	try {
59	// See https://github.com/sendgrid/sendgrid-java/issues/163
60	// for what actually works as compared to the documentation - which doesn't.
61	Request request = new Request();	1✔
62	request.setMethod(Method.POST);	1✔
63	request.setBody(message.build());	1✔
64	// make request
65	request.setBaseUri(sendGrid.getHost());	1✔
66	request.setEndpoint("/" + sendGrid.getVersion() + "/mail/send");	1✔
67	sendGrid.getRequestHeaders().forEach(request::addHeader);	1✔
68	// send
69	Response response = sendGrid.makeCall(request);	1✔
70	if (response.getStatusCode() > 202) {	1✔
71	// Indicates some form of error:
72	// https://docs.sendgrid.com/api-reference/mail-send/mail-send#responses
73	logException(	1✔
74	"Error sending email via SendGrid: '%s': %s"
75	.formatted(response.getStatusCode(), response.getBody()),	1✔
76	new WebApplicationException(response.getStatusCode()));	1✔
77	}
78	return response;	1✔
79	} catch (IOException ex) {	1✔
80	logException("Exception sending email via SendGrid: %s".formatted(ex.getMessage()), ex);	1✔
81	// Create a response that we can use to capture this failure.
82	return new Response(HttpStatusCodes.STATUS_CODE_SERVER_ERROR, ex.getMessage(), Map.of());	1✔
83	}
84	}
85	}

DataBiosphere / consent / #5772

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous