Merge pull request #4071 from kofzera/send_notifications_bulk

feat(core): resend notifications method

Author: xflord

perun-openapi/openapi.yml

@@ -16466,6 +16466,39 @@ paths:
                 appId: { type: integer, description: "application id" }
                 reason: { type: string, description: "you can specify reason for case: mailType == APP_REJECTED_USER" }
 
+  /json/registrarManager/sendMessages:
+    post:
+      tags:
+        - RegistrarManager
+      operationId: sendMessages
+      summary: Manually re-sends mail notifications for existing applications.
+      description: |
+        Expected to be called as a result of direct VO administrator action in the web UI.
+      responses:
+        '200':
+          $ref: '#/components/responses/VoidResponse'
+        default:
+          $ref: '#/components/responses/ExceptionResponse'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              title: InputSendMessages
+              description: "input to sendMessages"
+              type: object
+              required:
+                - mailType
+                - ids
+              properties:
+                mailType: { $ref: '#/components/schemas/MailType' }
+                reason: { type: string, description: "you can specify reason for case: mailType == APP_REJECTED_USER" }
+                ids:
+                  type: array
+                  items:
+                    type: integer
+                  description: "An array of integers representing the IDs of applications"
+
   /json/registrarManager/getApplicationForm/vo:
     get:
       tags:

perun-registrar-lib/src/main/java/cz/metacentrum/perun/registrar/MailManager.java

@@ -155,6 +155,16 @@ public interface MailManager {
 	 */
 	void sendMessage(PerunSession sess, Application app, MailType mailType, String reason) throws PerunException;
 
+	/**
+	 * Manually re-send multiple notifications at once. Expected to be called as a result of direct VO administrator action in the web UI.
+	 *
+	 * @param sess PerunSession for authz
+	 * @param applications application to send notification for
+	 * @param mailType MailType action which caused sending
+	 * @param reason custom text passed to mail by admin (e.g. reason of application reject)
+	 */
+	void sendMessages(PerunSession sess, List<Application> applications, MailType mailType, String reason) throws PerunException;
+
 	/**
 	 * Send invitations with link to VO / Group application form from provided csv data
 	 *

perun-registrar-lib/src/main/java/cz/metacentrum/perun/registrar/impl/MailManagerImpl.java

@@ -576,12 +576,12 @@ public void sendMessage(PerunSession sess, Application app, MailType mailType, S
 		ApplicationForm form = getForm(app);
 
 		ApplicationMail mail = getMailByParams(form.getId(), app.getType(), mailType);
-		if (mail == null) throw new RegistrarException("Notification template for "+mailType+" is not defined.");
-		if (!mail.getSend()) throw new RegistrarException("Sending of notification "+mailType+" is disabled.");
+		if (mail == null) throw new RegistrarException("Notification template for "+mailType+" for application " + app.getId() + " is not defined.");
+		if (!mail.getSend()) throw new RegistrarException("Sending of notification "+mailType+" for application " + app.getId() + " is disabled.");
 
 		if (!(AuthzResolver.hasRole(sess.getPerunPrincipal(), Role.PERUNADMIN) || AuthzResolver.hasRole(sess.getPerunPrincipal(), Role.PERUNADMINBA))) {
 			if (MailType.APP_ERROR_VO_ADMIN.equals(mailType)) {
-				throw new RegistrarException("APP_ERROR_VO_ADMIN notification can't be sent this way, since it's bound to each approval process. Try to approve application once again to receive this message.");
+				throw new RegistrarException("APP_ERROR_VO_ADMIN notification can't be sent this way, since it's bound to each approval process. Try to approve application " + app.getId() + "  once again to receive this message.");
 			}
 
 			switch (mailType) {
@@ -591,28 +591,28 @@ public void sendMessage(PerunSession sess, Application app, MailType mailType, S
 					if (app.getState().equals(Application.AppState.NEW) || app.getState().equals(Application.AppState.VERIFIED)) {
 						sendMessage(app, mailType, null, null);
 					} else {
-						throw new RegistrarException("Application must be in state NEW or VERIFIED to allow sending of "+mailType+" notification.");
+						throw new RegistrarException("Application " + app.getId() + " must be in state NEW or VERIFIED to allow sending of "+mailType+" notification.");
 					}
 				} break;
 				case MAIL_VALIDATION: {
 					if (app.getState().equals(Application.AppState.NEW)) {
 						sendMessage(app, mailType, null, null);
 					} else {
-						throw new ApplicationNotNewException("Application must be in state NEW to allow sending of "+mailType+" notification.", app.getState().toString());
+						throw new ApplicationNotNewException("Application " + app.getId() + " must be in state NEW to allow sending of "+mailType+" notification.", app.getState().toString());
 					}
 				} break;
 				case APP_APPROVED_USER: {
 					if (Application.AppState.APPROVED.equals(app.getState())) {
 						sendMessage(app, mailType, null, null);
 					} else {
-						throw new RegistrarException("Application must be in state APPROVED to allow sending of "+mailType+" notification.");
+						throw new RegistrarException("Application " + app.getId() + " must be in state APPROVED to allow sending of "+mailType+" notification.");
 					}
 				} break;
 				case APP_REJECTED_USER: {
 					if (Application.AppState.REJECTED.equals(app.getState())) {
 						sendMessage(app, mailType, reason, null);
 					} else {
-						throw new RegistrarException("Application must be in state REJECTED to allow sending of "+mailType+" notification.");
+						throw new RegistrarException("Application " + app.getId() + " must be in state REJECTED to allow sending of "+mailType+" notification.");
 					}
 				} break;
 			}
@@ -623,6 +623,13 @@ public void sendMessage(PerunSession sess, Application app, MailType mailType, S
 		perun.getAuditer().log(sess, new MailSentForApplication(mailType, app.getId()));
 	}
 
+	@Override
+	public void sendMessages(PerunSession sess, List<Application> applications, MailType mailType, String reason) throws PerunException {
+		for (Application application : applications) {
+			sendMessage(sess, application, mailType, reason);
+		}
+	}
+
 	@Override
 	public void sendInvitation(PerunSession sess, Vo vo, Group group, String name, String email, String language) throws PerunException {
 		perun.getVosManagerBl().checkVoExists(sess, vo);

perun-registrar-lib/src/test/java/cz/metacentrum/perun/registrar/RegistrarBaseIntegrationTest.java

@@ -39,12 +39,14 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.dao.DataIntegrityViolationException;
+import org.springframework.mail.javamail.JavaMailSender;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 import org.springframework.test.util.AopTestUtils;
+import org.springframework.test.util.ReflectionTestUtils;
 import org.springframework.transaction.annotation.Transactional;
 
+import javax.mail.internet.MimeMessage;
 import java.util.*;
 import java.util.function.Predicate;
 
@@ -54,6 +56,10 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.junit.Assert.*;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
 
 /**
  * Base registrar-lib test class
@@ -266,6 +272,45 @@ public void updateAppMailMessageTemplates() throws PerunException {
 		assertEquals("Html message (cs) doesn't contain correct text", mail.getHtmlMessage(new Locale("cs")).getText(), "<p>Upravený český text mailu <b>v html</b>.</p>");
 	}
 
+	@Test
+	public void testResendNotifications() throws PerunException {
+		JavaMailSender mailSender = (JavaMailSender) ReflectionTestUtils.getField(mailManager, "mailSender");
+        assert mailSender != null;
+        JavaMailSender spyMailSender = spy(mailSender);
+		ReflectionTestUtils.setField(mailManager, "mailSender", spyMailSender);
+
+		User user1 = new User(-1, "User1", "Test1", "", "", "");
+		User user2 = new User(-2, "User2", "Test2", "", "", "");
+		User user3 = new User(-3, "User3", "Test3", "", "", "");
+		user1 = perun.getUsersManagerBl().createUser(session, user1);
+		user2 = perun.getUsersManagerBl().createUser(session, user2);
+		user3 = perun.getUsersManagerBl().createUser(session, user3);
+
+		Application application1 = prepareApplicationToVo(user1);
+		Application application2 = prepareApplicationToVo(user2);
+		Application application3 = prepareApplicationToVo(user3);
+		registrarManager.submitApplication(session, application1, new ArrayList<>());
+		registrarManager.submitApplication(session, application2, new ArrayList<>());
+		registrarManager.submitApplication(session, application3, new ArrayList<>());
+
+		application1.setState(Application.AppState.REJECTED);
+		application2.setState(Application.AppState.REJECTED);
+		application3.setState(Application.AppState.REJECTED);
+
+		ApplicationForm form = registrarManager.getFormForVo(vo);
+
+		ApplicationMail mail = new ApplicationMail(0,AppType.INITIAL, form.getId(), MailType.APP_REJECTED_USER, true);
+		MailText t = mail.getMessage(new Locale("en"));
+		t.setSubject("Test subject");
+		t.setText("Test Mail content.");
+		mailManager.addMail(session, form, mail);
+
+
+		mailManager.sendMessages(session, List.of(application1, application2, application3), MailType.APP_REJECTED_USER, null);
+
+		verify(spyMailSender, times(3)).send(any(MimeMessage.class));
+	}
+
 	@Test
 	public void createVOformIntegrationTest() throws PerunException {
 		System.out.println("createVOformIntegrationTest()");

perun-rpc/src/main/java/cz/metacentrum/perun/rpc/methods/RegistrarManagerMethod.java

@@ -281,6 +281,40 @@ public Void call(ApiCaller ac, Deserializer parms) throws PerunException {
 
 		}
 
+	},
+
+	/*#
+	 * Manually re-send multiple notifications at once.
+	 * Expected to be called as a result of direct VO administrator action in the web UI.
+	 *
+	 * @param ids int[] List of Application IDs
+	 */
+	sendMessages {
+
+		@Override
+		public Void call(ApiCaller ac, Deserializer parms) throws PerunException {
+			parms.stateChangingCheck();
+
+			List<Application> applications = new ArrayList<>();
+			List<Integer> appIds = parms.readList("ids", Integer.class);
+			for (Integer id : appIds) {
+				applications.add(ac.getRegistrarManager().getApplicationById(ac.getSession(), id));
+			}
+			if (parms.readString("mailType").equals("APP_REJECTED_USER")) {
+
+				ac.getRegistrarManager().getMailManager().sendMessages(ac.getSession(), applications,
+					ApplicationMail.MailType.valueOf(parms.readString("mailType")),
+					parms.readString("reason"));
+
+			} else {
+
+				ac.getRegistrarManager().getMailManager().sendMessages(ac.getSession(), applications,
+					ApplicationMail.MailType.valueOf(parms.readString("mailType")), null);
+
+			}
+			return null;
+		}
+
 	},
 	/*#
 	 * Create application form for a VO.