Merge pull request SORMAS-Foundation#3648 from hzi-braunschweig/feature-3294-Inform-External-Journal-about-canceled-or-completed-follow-ups

Feature 3294 inform external journal about canceled or completed follow ups

Author: FredrikSchaefer

sormas-api/src/main/java/de/symeda/sormas/api/contact/FollowUpStatusDto.java

@@ -0,0 +1,34 @@
+package de.symeda.sormas.api.contact;
+
+import java.io.Serializable;
+
+public class FollowUpStatusDto implements Serializable {
+
+	private static final long serialVersionUID = 6075542609471404489L;
+
+	private String uuid;
+	private FollowUpStatus followUpStatus;
+
+	public FollowUpStatusDto(String uuid, FollowUpStatus followUpStatus) {
+
+		this.uuid = uuid;
+		this.followUpStatus = followUpStatus;
+
+	}
+
+	public String getUuid() {
+		return uuid;
+	}
+
+	public void setUuid(String uuid) {
+		this.uuid = uuid;
+	}
+
+	public FollowUpStatus getFollowUpStatus() {
+		return followUpStatus;
+	}
+
+	public void setFollowUpStatus(FollowUpStatus followUpStatus) {
+		this.followUpStatus = followUpStatus;
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/person/JournalPersonDto.java

@@ -1,10 +1,12 @@
 package de.symeda.sormas.api.person;
 
+import de.symeda.sormas.api.contact.FollowUpStatus;
 import de.symeda.sormas.api.utils.PersonalData;
 import de.symeda.sormas.api.utils.SensitiveData;
 
 import java.io.Serializable;
 import java.util.Date;
+import java.util.Objects;
 
 import de.symeda.sormas.api.utils.PersonalData;
 import de.symeda.sormas.api.utils.SensitiveData;
@@ -31,8 +33,8 @@ public class JournalPersonDto implements Serializable {
 	private Integer birthdateYYYY;
 
 	private Sex sex;
-	@SensitiveData
 	private Date latestFollowUpEndDate;
+	private FollowUpStatus followUpStatus;
 
 	public String getUuid() {
 		return uuid;
@@ -122,4 +124,54 @@ public void setLatestFollowUpEndDate(Date latestFollowUpEndDate) {
 		this.latestFollowUpEndDate = latestFollowUpEndDate;
 	}
 
+	public FollowUpStatus getFollowUpStatus() {
+		return followUpStatus;
+	}
+
+	public void setFollowUpStatus(FollowUpStatus followUpStatus) {
+		this.followUpStatus = followUpStatus;
+	}
+
+	@Override
+	public String toString() {
+		return uuid + ' ' + firstName + ' ' + lastName;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o)
+			return true;
+		if (o == null || getClass() != o.getClass())
+			return false;
+		JournalPersonDto that = (JournalPersonDto) o;
+		return pseudonymized == that.pseudonymized
+			&& Objects.equals(uuid, that.uuid)
+			&& Objects.equals(firstName, that.firstName)
+			&& Objects.equals(lastName, that.lastName)
+			&& Objects.equals(emailAddress, that.emailAddress)
+			&& Objects.equals(phone, that.phone)
+			&& Objects.equals(birthdateDD, that.birthdateDD)
+			&& Objects.equals(birthdateMM, that.birthdateMM)
+			&& Objects.equals(birthdateYYYY, that.birthdateYYYY)
+			&& sex == that.sex
+			&& Objects.equals(latestFollowUpEndDate, that.latestFollowUpEndDate)
+			&& followUpStatus == that.followUpStatus;
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(
+			uuid,
+			pseudonymized,
+			firstName,
+			lastName,
+			emailAddress,
+			phone,
+			birthdateDD,
+			birthdateMM,
+			birthdateYYYY,
+			sex,
+			latestFollowUpEndDate,
+			followUpStatus);
+	}
 }

sormas-api/src/main/java/de/symeda/sormas/api/person/PersonFacade.java

@@ -25,6 +25,7 @@
 
 import de.symeda.sormas.api.Disease;
 import de.symeda.sormas.api.caze.CaseCriteria;
+import de.symeda.sormas.api.contact.FollowUpStatus;
 import de.symeda.sormas.api.region.DistrictReferenceDto;
 import de.symeda.sormas.api.user.UserReferenceDto;
 
@@ -67,6 +68,8 @@ public interface PersonFacade {
 
 	Date getLatestFollowUpEndDateByUuid(String uuid);
 
+	FollowUpStatus getMostRelevantFollowUpStatusByUuid(String uuid);
+
 	boolean setSymptomJournalStatus(String personUuid, SymptomJournalStatus status);
 
 }

sormas-backend/src/main/java/de/symeda/sormas/backend/contact/ContactFacadeEjb.java

@@ -59,6 +59,7 @@
 import javax.persistence.criteria.Subquery;
 import javax.validation.constraints.NotNull;
 
+import de.symeda.sormas.api.person.JournalPersonDto;
 import org.apache.commons.collections.CollectionUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -210,6 +211,8 @@ public class ContactFacadeEjb implements ContactFacade {
 	private FeatureConfigurationFacadeEjbLocal featureConfigurationFacade;
 	@EJB
 	private EventService eventService;
+	@EJB
+	private PersonFacadeEjb.PersonFacadeEjbLocal personFacade;
 
 	@Override
 	public List<String> getAllActiveUuids() {
@@ -297,7 +300,7 @@ public ContactDto saveContact(ContactDto dto, boolean handleChanges) {
 
 		}
 		if (existingContact != null) {
-			handleExternalJournalPerson(existingContactDto, dto);
+			handleExternalJournalPerson(dto);
 		}
 
 		if (handleChanges) {
@@ -315,9 +318,14 @@ public ContactDto saveContact(ContactDto dto, boolean handleChanges) {
 	}
 
 	// 5 second delay added before notifying of update so that current transaction can complete and new data can be retrieved from DB
-	private void handleExternalJournalPerson(ContactDto existingContact, ContactDto updatedContact) {
+	private void handleExternalJournalPerson(ContactDto updatedContact) {
 		final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
-		Runnable notify = () -> externalJournalService.notifyExternalJournalFollowUpUntilUpdate(updatedContact, existingContact.getFollowUpUntil());
+		/**
+		 * The .getPersonForJournal(...) here gets the person in the state it is (most likely) known to an external journal.
+		 * Changes of related data is assumed to be not yet persisted in the database.
+		 */
+		JournalPersonDto existingPerson = personFacade.getPersonForJournal(updatedContact.getPerson().getUuid());
+		Runnable notify = () -> externalJournalService.notifyExternalJournalPersonUpdate(existingPerson);
 		executorService.schedule(notify, 5, TimeUnit.SECONDS);
 	}
 

sormas-backend/src/main/java/de/symeda/sormas/backend/externaljournal/ExternalJournalService.java

@@ -29,6 +29,7 @@
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 
+import de.symeda.sormas.api.person.JournalPersonDto;
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.validator.routines.EmailValidator;
@@ -201,21 +202,19 @@ public void notifyExternalJournalFollowUpUntilUpdate(ContactDto contact, Date pr
 	/**
 	 * Notify external journals that a person has been updated
 	 * 
-	 * @param existingPerson
+	 * @param existingJournalPerson
 	 *            the person already available in the external journal
-	 * @param updatedPerson
-	 *            the updated person in SORMAS
 	 * @return true if the person data change was considered relevant for external journals, false otherwise.
 	 *
 	 */
-	public boolean notifyExternalJournalPersonUpdate(PersonDto existingPerson, PersonDto updatedPerson) {
-		boolean shouldNotify = shouldNotify(existingPerson, updatedPerson);
-		if (shouldNotify) {
+	public boolean notifyExternalJournalPersonUpdate(JournalPersonDto existingJournalPerson) {
+		boolean shouldNotify = shouldNotify(existingJournalPerson);
+		if (shouldNotify(existingJournalPerson)) {
 			if (configFacade.getSymptomJournalConfig().getUrl() != null) {
-				notifySymptomJournal(existingPerson.getUuid());
+				notifySymptomJournal(existingJournalPerson.getUuid());
 			}
 			if (configFacade.getPatientDiaryConfig().getUrl() != null) {
-				notifyPatientDiary(existingPerson.getUuid());
+				notifyPatientDiary(existingJournalPerson.getUuid());
 			}
 		}
 		return shouldNotify;
@@ -225,19 +224,12 @@ public boolean notifyExternalJournalPersonUpdate(PersonDto existingPerson, Perso
 	 * Note: This method just checks for changes in the Person data.
 	 * It can not check for Contact related data such as FollowUpUntil dates.
 	 */
-	private boolean shouldNotify(PersonDto existingPerson, PersonDto updatedPerson) {
-		boolean relevantPerson = SymptomJournalStatus.ACCEPTED.equals(existingPerson.getSymptomJournalStatus())
-			|| SymptomJournalStatus.REGISTERED.equals(existingPerson.getSymptomJournalStatus());
-		boolean relevantFieldsUpdated = Comparator.comparing(PersonDto::getFirstName, Comparator.nullsLast(Comparator.naturalOrder()))
-			.thenComparing(PersonDto::getLastName, Comparator.nullsLast(Comparator.naturalOrder()))
-			.thenComparing(PersonDto::getEmailAddress, Comparator.nullsLast(Comparator.naturalOrder()))
-			.thenComparing(PersonDto::getPhone, Comparator.nullsLast(Comparator.naturalOrder()))
-			.thenComparing(PersonDto::getBirthdateDD, Comparator.nullsLast(Comparator.naturalOrder()))
-			.thenComparing(PersonDto::getBirthdateMM, Comparator.nullsLast(Comparator.naturalOrder()))
-			.thenComparing(PersonDto::getBirthdateYYYY, Comparator.nullsLast(Comparator.naturalOrder()))
-			.thenComparing(PersonDto::getSex, Comparator.nullsLast(Comparator.naturalOrder()))
-			.compare(existingPerson, updatedPerson)
-			!= 0;
+	private boolean shouldNotify(JournalPersonDto existingJournalPerson) {
+		PersonDto detailedExistingPerson = personFacade.getPersonByUuid(existingJournalPerson.getUuid());
+		boolean relevantPerson = SymptomJournalStatus.ACCEPTED.equals(detailedExistingPerson.getSymptomJournalStatus())
+			|| SymptomJournalStatus.REGISTERED.equals(detailedExistingPerson.getSymptomJournalStatus());
+		JournalPersonDto updatedJournalPerson = personFacade.getPersonForJournal(existingJournalPerson.getUuid());
+		boolean relevantFieldsUpdated = !existingJournalPerson.equals(updatedJournalPerson);
 		return relevantPerson && relevantFieldsUpdated;
 	}
 
@@ -296,7 +288,7 @@ public Optional<PatientDiaryPersonDto> getPatientDiaryPerson(String personUuid)
 	/**
 	 * Attempts to register a new patient in the CLIMEDO patient diary.
 	 * Sets the person symptom journal status to REGISTERED if successful.
-	 * 
+	 *
 	 * @param person
 	 *            the person to register as a patient in CLIMEDO
 	 * @return true if the registration was successful, false otherwise
@@ -413,7 +405,7 @@ private boolean isPhoneAvailable(PersonDto person, String phone) {
 
 	/**
 	 * Queries the CLIMEDO patients for ones matching the given property
-	 * 
+	 *
 	 * @param key
 	 *            the name of the property to match
 	 * @param value