Merge pull request SORMAS-Foundation#3614 from hzi-braunschweig/3599-climedo-validation-error

FredrikSchaefer · web-flow · commit 22f3f4f3235e · 2020-11-30T09:03:48.000+01:00
3599 climedo validation error
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/ExternalJournalFacade.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/ExternalJournalFacade.java
@@ -2,6 +2,8 @@
 
 import javax.ejb.Remote;
 
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryPersonDto;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryRegisterResult;
 import de.symeda.sormas.api.person.PersonDto;
 
 @Remote
@@ -15,5 +17,5 @@ public interface ExternalJournalFacade {
 
 	PatientDiaryRegisterResult registerPatientDiaryPerson(PersonDto person);
 
-	PatientDiaryPersonValidation validatePatientDiaryPerson(PersonDto person);
+	ExternalJournalValidation validatePatientDiaryPerson(PersonDto person);
 }
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/ExternalJournalValidation.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/ExternalJournalValidation.java
@@ -2,12 +2,12 @@
 
 import java.io.Serializable;
 
-public class PatientDiaryPersonValidation implements Serializable {
+public class ExternalJournalValidation implements Serializable {
 
     private boolean valid;
     private String message;
 
-    public PatientDiaryPersonValidation(boolean valid, String message) {
+    public ExternalJournalValidation(boolean valid, String message) {
         this.valid = valid;
         this.message = message;
     }
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryContactInformation.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryContactInformation.java
@@ -1,8 +1,11 @@
-package de.symeda.sormas.api.externaljournal;
+package de.symeda.sormas.api.externaljournal.patientdiary;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 
 import java.io.Serializable;
 
-class PatientDiaryContactInformation implements Serializable {
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class PatientDiaryContactInformation implements Serializable {
 
 	private static final long serialVersionUID = -144631462985961640L;
 
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryIdatId.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryIdatId.java
@@ -0,0 +1,20 @@
+package de.symeda.sormas.api.externaljournal.patientdiary;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+import java.io.Serializable;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class PatientDiaryIdatId implements Serializable {
+    private static final long serialVersionUID = -2785744892381447672L;
+
+    private PatientDiaryPersonDto idat;
+
+    public PatientDiaryPersonDto getIdat() {
+        return idat;
+    }
+
+    public void setIdat(PatientDiaryPersonDto idat) {
+        this.idat = idat;
+    }
+}
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryPersonData.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryPersonData.java
@@ -1,4 +1,4 @@
-package de.symeda.sormas.api.externaljournal;
+package de.symeda.sormas.api.externaljournal.patientdiary;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 
@@ -10,6 +10,7 @@ public class PatientDiaryPersonData implements Serializable {
     private static final long serialVersionUID = -1036432520752506284L;
 
     private String _id;
+    private PatientDiaryIdatId idatId;
     // Other returned fields are ignored. Add as needed
 
     public String get_id() {
@@ -19,4 +20,12 @@ public String get_id() {
     public void set_id(String _id) {
         this._id = _id;
     }
+
+    public PatientDiaryIdatId getIdatId() {
+        return idatId;
+    }
+
+    public void setIdatId(PatientDiaryIdatId idatId) {
+        this.idatId = idatId;
+    }
 }
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryPersonDto.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryPersonDto.java
@@ -1,4 +1,4 @@
-package de.symeda.sormas.api.externaljournal;
+package de.symeda.sormas.api.externaljournal.patientdiary;
 
 import java.io.Serializable;
 
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryPhone.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryPhone.java
@@ -1,4 +1,4 @@
-package de.symeda.sormas.api.externaljournal;
+package de.symeda.sormas.api.externaljournal.patientdiary;
 
 import java.io.Serializable;
 
@@ -51,4 +51,4 @@ public String getDialCode() {
     public void setDialCode(String dialCode) {
         this.dialCode = dialCode;
     }
-}
+}
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryQueryResponse.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryQueryResponse.java
@@ -1,9 +1,9 @@
-package de.symeda.sormas.api.externaljournal;
+package de.symeda.sormas.api.externaljournal.patientdiary;
 
 import java.io.Serializable;
 import java.util.List;
 
-public class PatientDiaryPersonQueryResponse implements Serializable {
+public class PatientDiaryQueryResponse implements Serializable {
 
 	private static final long serialVersionUID = -1089320137577059438L;
 
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryRegisterResult.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryRegisterResult.java
@@ -1,4 +1,4 @@
-package de.symeda.sormas.api.externaljournal;
+package de.symeda.sormas.api.externaljournal.patientdiary;
 
 import java.io.Serializable;
 
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryValidationError.java b/sormas-api/src/main/java/de/symeda/sormas/api/externaljournal/patientdiary/PatientDiaryValidationError.java
@@ -0,0 +1,23 @@
+package de.symeda.sormas.api.externaljournal.patientdiary;
+
+import de.symeda.sormas.api.i18n.Validations;
+
+public enum PatientDiaryValidationError {
+
+    NO_PHONE_OR_EMAIL(Validations.externalJournalPersonValidationNoEmailOrPhone),
+    INVALID_EMAIL(Validations.externalJournalPersonValidationEmail),
+    INVALID_PHONE(Validations.externalJournalPersonValidationPhone),
+    INVALID_BIRTHDATE(Validations.externalJournalPersonValidationBirthdate),
+    EMAIL_TAKEN(Validations.externalJournalPersonValidationEmailTaken),
+    PHONE_TAKEN(Validations.externalJournalPersonValidationPhoneTaken);
+
+    public String errorLanguageKey;
+
+    PatientDiaryValidationError(String errorLanguageKey) {
+        this.errorLanguageKey = errorLanguageKey;
+    }
+
+    public String getErrorLanguageKey() {
+        return errorLanguageKey;
+    }
+}
diff --git a/sormas-api/src/main/resources/doc/SORMAS_Data_Dictionary.xlsx b/sormas-api/src/main/resources/doc/SORMAS_Data_Dictionary.xlsx
diff --git a/sormas-api/src/main/resources/doc/SORMAS_User_Rights.xlsx b/sormas-api/src/main/resources/doc/SORMAS_User_Rights.xlsx
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/externaljournal/ExternalJournalFacadeEjb.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/externaljournal/ExternalJournalFacadeEjb.java
@@ -4,9 +4,9 @@
 import javax.ejb.Stateless;
 
 import de.symeda.sormas.api.externaljournal.ExternalJournalFacade;
-import de.symeda.sormas.api.externaljournal.PatientDiaryPersonDto;
-import de.symeda.sormas.api.externaljournal.PatientDiaryPersonValidation;
-import de.symeda.sormas.api.externaljournal.PatientDiaryRegisterResult;
+import de.symeda.sormas.api.externaljournal.ExternalJournalValidation;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryPersonDto;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryRegisterResult;
 import de.symeda.sormas.api.person.PersonDto;
 
 @Stateless(name = "ExternalJournalFacade")
@@ -36,7 +36,7 @@ public PatientDiaryRegisterResult registerPatientDiaryPerson(PersonDto person) {
 	}
 
 	@Override
-	public PatientDiaryPersonValidation validatePatientDiaryPerson(PersonDto person) {
+	public ExternalJournalValidation validatePatientDiaryPerson(PersonDto person) {
 		return externalJournalService.validatePatientDiaryPerson(person);
 	}
 
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/externaljournal/ExternalJournalService.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/externaljournal/ExternalJournalService.java
@@ -1,13 +1,22 @@
 package de.symeda.sormas.backend.externaljournal;
 
+import static de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryValidationError.EMAIL_TAKEN;
+import static de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryValidationError.INVALID_BIRTHDATE;
+import static de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryValidationError.INVALID_EMAIL;
+import static de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryValidationError.INVALID_PHONE;
+import static de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryValidationError.NO_PHONE_OR_EMAIL;
+import static de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryValidationError.PHONE_TAKEN;
+
 import java.io.IOException;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.util.Comparator;
 import java.util.Date;
+import java.util.EnumSet;
 import java.util.Optional;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
 
 import javax.ejb.EJB;
 import javax.ejb.LocalBean;
@@ -37,12 +46,14 @@
 import com.google.i18n.phonenumbers.Phonenumber;
 
 import de.symeda.sormas.api.contact.ContactDto;
-import de.symeda.sormas.api.externaljournal.PatientDiaryPersonDto;
-import de.symeda.sormas.api.externaljournal.PatientDiaryPersonQueryResponse;
-import de.symeda.sormas.api.externaljournal.PatientDiaryPersonValidation;
-import de.symeda.sormas.api.externaljournal.PatientDiaryRegisterResult;
+import de.symeda.sormas.api.externaljournal.ExternalJournalValidation;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryIdatId;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryPersonData;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryPersonDto;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryQueryResponse;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryRegisterResult;
+import de.symeda.sormas.api.externaljournal.patientdiary.PatientDiaryValidationError;
 import de.symeda.sormas.api.i18n.I18nProperties;
-import de.symeda.sormas.api.i18n.Validations;
 import de.symeda.sormas.api.person.PersonDto;
 import de.symeda.sormas.api.person.SymptomJournalStatus;
 import de.symeda.sormas.backend.common.ConfigFacadeEjb;
@@ -272,10 +283,10 @@ public Optional<PatientDiaryPersonDto> getPatientDiaryPerson(String personUuid)
 			ObjectMapper mapper = new ObjectMapper();
 			JsonNode node = mapper.readValue(responseJson, JsonNode.class);
 			JsonNode idatData = node.get("idatData");
-			PatientDiaryPersonDto patientDiaryPersonDto = mapper.treeToValue(idatData, PatientDiaryPersonDto.class);
+			PatientDiaryPersonDto personDto = mapper.treeToValue(idatData, PatientDiaryPersonDto.class);
 			String endDate = node.get("endDate").textValue();
-			patientDiaryPersonDto.setEndDate(endDate);
-			return Optional.of(patientDiaryPersonDto);
+			personDto.setEndDate(endDate);
+			return Optional.of(personDto);
 		} catch (IOException e) {
 			logger.error("Could not retrieve patient: {}", e.getMessage());
 			throw new RuntimeException(e);
@@ -327,51 +338,77 @@ private Invocation.Builder getExternalDataPersonInvocationBuilder(String personU
 	 *            the person to validate
 	 * @return the result of the validation
 	 */
-	public PatientDiaryPersonValidation validatePatientDiaryPerson(PersonDto person) {
+	public ExternalJournalValidation validatePatientDiaryPerson(PersonDto person) {
+		EnumSet<PatientDiaryValidationError> validationErrors = EnumSet.noneOf(PatientDiaryValidationError.class);
+
 		String email = person.getEmailAddress();
 		String phone = person.getPhone();
-		boolean validEmail = true;
-		boolean validPhone = true;
-		boolean validBirthdate = true;
-		boolean emailAvailable = true;
-		boolean phoneAvailable = true;
+		boolean hasPhoneOrEmail = !StringUtils.isAllEmpty(email, phone);
+		if (!hasPhoneOrEmail) {
+			validationErrors.add(NO_PHONE_OR_EMAIL);
+		}
+
 		if (StringUtils.isNotEmpty(email)) {
 			EmailValidator validator = EmailValidator.getInstance();
-			validEmail = validator.isValid(email);
-			emailAvailable = isEmailAvailable(person.getEmailAddress());
+			if (!validator.isValid(email)) {
+				validationErrors.add(INVALID_EMAIL);
+			}
+			if (!isEmailAvailable(person)) {
+				validationErrors.add(EMAIL_TAKEN);
+			}
 		}
+
 		if (StringUtils.isNotEmpty(phone)) {
-			validPhone = false;
 			PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
 			try {
 				Phonenumber.PhoneNumber germanNumberProto = phoneUtil.parse(phone, "DE");
-				validPhone = phoneUtil.isValidNumber(germanNumberProto);
+				if (!phoneUtil.isValidNumber(germanNumberProto)) {
+					validationErrors.add(INVALID_PHONE);
+				}
 				String internationalPhone = phoneUtil.format(germanNumberProto, PhoneNumberUtil.PhoneNumberFormat.INTERNATIONAL);
-				phoneAvailable = isPhoneAvailable(internationalPhone);
+				if (!isPhoneAvailable(person, internationalPhone)) {
+					validationErrors.add(PHONE_TAKEN);
+				}
 			} catch (NumberParseException e) {
 				logger.warn("NumberParseException was thrown: " + e.toString());
+				validationErrors.add(INVALID_PHONE);
 			}
 		}
+
 		if (ObjectUtils.anyNotNull(person.getBirthdateDD(), person.getBirthdateMM(), person.getBirthdateYYYY())) {
-			validBirthdate = ObjectUtils.allNotNull(person.getBirthdateDD(), person.getBirthdateMM(), person.getBirthdateYYYY());
+			boolean validBirthdate = ObjectUtils.allNotNull(person.getBirthdateDD(), person.getBirthdateMM(), person.getBirthdateYYYY());
+			if (!validBirthdate) {
+				validationErrors.add(INVALID_BIRTHDATE);
+			}
 		}
 
-		boolean hasPhoneOrEmail = !StringUtils.isAllEmpty(email, phone);
-		boolean valid = hasPhoneOrEmail && validEmail && validPhone && validBirthdate && emailAvailable && phoneAvailable;
-		String message = getValidationMessage(hasPhoneOrEmail, validEmail, validPhone, validBirthdate, emailAvailable, phoneAvailable);
-		return new PatientDiaryPersonValidation(valid, message);
+		return new ExternalJournalValidation(validationErrors.isEmpty(), getValidationMessage(validationErrors));
 	}
 
-	private boolean isEmailAvailable(String emailAddress) {
-		return queryPatientDiary(EMAIL_QUERY_PARAM, emailAddress)
-			.orElseThrow(() -> new RuntimeException("Could not query patient diary for Email address availability"))
-			.getCount() == 0;
+	private boolean isEmailAvailable(PersonDto person) {
+		PatientDiaryQueryResponse response = queryPatientDiary(EMAIL_QUERY_PARAM, person.getEmailAddress())
+			.orElseThrow(() -> new RuntimeException("Could not query patient diary for Email address availability"));
+		boolean notUsed = response.getCount() == 0;
+		boolean samePerson = response.getResults()
+			.stream()
+			.map(PatientDiaryPersonData::getIdatId)
+			.map(PatientDiaryIdatId::getIdat)
+			.map(PatientDiaryPersonDto::getPersonUUID)
+			.anyMatch(uuid -> person.getUuid().equals(uuid));
+		return notUsed || samePerson;
 	}
 
-	private boolean isPhoneAvailable(String phone) {
-		return queryPatientDiary(MOBILE_PHONE_QUERY_PARAM, phone)
-			.orElseThrow(() -> new RuntimeException("Could not query patient diary for phone number availability"))
-			.getCount() == 0;
+	private boolean isPhoneAvailable(PersonDto person, String phone) {
+		PatientDiaryQueryResponse response = queryPatientDiary(MOBILE_PHONE_QUERY_PARAM, phone)
+			.orElseThrow(() -> new RuntimeException("Could not query patient diary for phone number availability"));
+		boolean notUsed = response.getCount() == 0;
+		boolean samePerson = response.getResults()
+			.stream()
+			.map(PatientDiaryPersonData::getIdatId)
+			.map(PatientDiaryIdatId::getIdat)
+			.map(PatientDiaryPersonDto::getPersonUUID)
+			.anyMatch(uuid -> person.getUuid().equals(uuid));
+		return notUsed || samePerson;
 	}
 
 	/**
@@ -383,7 +420,7 @@ private boolean isPhoneAvailable(String phone) {
 	 *            the value of the property to match
 	 * @return result of query
 	 */
-	public Optional<PatientDiaryPersonQueryResponse> queryPatientDiary(String key, String value) {
+	public Optional<PatientDiaryQueryResponse> queryPatientDiary(String key, String value) {
 		try {
 			String probandsUrl = configFacade.getPatientDiaryConfig().getProbandsUrl() + "/probands";
 			String queryParam = "\"" + key + "\" = \"" + value + "\"";
@@ -394,45 +431,17 @@ public Optional<PatientDiaryPersonQueryResponse> queryPatientDiary(String key, S
 			if (response.getStatus() == NOT_FOUND_STATUS) {
 				return Optional.empty();
 			}
-			return Optional.ofNullable(response.readEntity(PatientDiaryPersonQueryResponse.class));
+			return Optional.ofNullable(response.readEntity(PatientDiaryQueryResponse.class));
 		} catch (IOException e) {
 			logger.error("Could not retrieve patient query response: {}", e.getMessage());
 			throw new RuntimeException(e);
 		}
 	}
 
-	private String getValidationMessage(
-		boolean hasPhoneOrEmail,
-		boolean validEmail,
-		boolean validPhone,
-		boolean validBirthdate,
-		boolean emailAvailable,
-		boolean phoneAvailable) {
-		StringBuilder message = new StringBuilder();
-		if (!hasPhoneOrEmail) {
-			message.append(I18nProperties.getValidationError(Validations.externalJournalPersonValidationNoEmailOrPhone));
-			message.append('\n');
-		}
-		if (!validEmail) {
-			message.append(I18nProperties.getValidationError(Validations.externalJournalPersonValidationEmail));
-			message.append('\n');
-		}
-		if (!validPhone) {
-			message.append(I18nProperties.getValidationError(Validations.externalJournalPersonValidationPhone));
-			message.append('\n');
-		}
-		if (!validBirthdate) {
-			message.append(I18nProperties.getValidationError(Validations.externalJournalPersonValidationBirthdate));
-			message.append('\n');
-		}
-		if (!emailAvailable) {
-			message.append(I18nProperties.getValidationError(Validations.externalJournalPersonValidationEmailTaken));
-			message.append('\n');
-		}
-		if (!phoneAvailable) {
-			message.append(I18nProperties.getValidationError(Validations.externalJournalPersonValidationPhoneTaken));
-			message.append('\n');
-		}
-		return message.toString();
+	private String getValidationMessage(EnumSet<PatientDiaryValidationError> validationErrors) {
+		return validationErrors.stream()
+			.map(PatientDiaryValidationError::getErrorLanguageKey)
+			.map(I18nProperties::getValidationError)
+			.collect(Collectors.joining("\n"));
 	}
 }
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/person/PersonFacadeEjb.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/person/PersonFacadeEjb.java
diff --git a/sormas-backend/src/test/java/de/symeda/sormas/backend/externaljournal/ExternalJournalServiceTest.java b/sormas-backend/src/test/java/de/symeda/sormas/backend/externaljournal/ExternalJournalServiceTest.java
diff --git a/sormas-ui/src/main/java/de/symeda/sormas/ui/contact/ContactController.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/contact/ContactController.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package de.symeda.sormas.api.externaljournal;`
	`1`	`+package de.symeda.sormas.api.externaljournal.patientdiary;`
`2`	`2`
`3`	`3`	`import java.io.Serializable;`
`4`	`4`