🐛 FIX: smart key with grouping

Author: Pa-Touche

sormas-api/src/main/java/de/symeda/sormas/api/externalmessage/survey/PatchDictionary.java

@@ -7,6 +7,8 @@
 
 import javax.validation.constraints.NotNull;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
 /**
  * Wrapper around concrete storage for patch dictionary.
  */
@@ -40,11 +42,13 @@ public PatchDictionary setDictionary(LinkedHashMap<PatchField, Object> dictionar
 		return this;
 	}
 
+	@JsonIgnore
 	public PatchDictionary setNonTypedPatchDictionary(Map<PatchField, Object> patchDictionary) {
 		this.dictionary = new LinkedHashMap<>(patchDictionary);
 		return this;
 	}
 
+	@JsonIgnore
 	public boolean isEmpty() {
 		return dictionary.isEmpty();
 	}

sormas-api/src/main/java/de/symeda/sormas/api/externalmessage/survey/PatchField.java

@@ -7,6 +7,10 @@
 import javax.annotation.Nullable;
 import javax.validation.constraints.NotNull;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonValue;
+
 /**
  * To be able to repeat some groups and make them belong together, the groupIndex was added.
  */
@@ -23,6 +27,15 @@ public class PatchField implements Serializable {
 	@Nullable
 	private Integer groupIndex;
 
+	public PatchField() {
+	}
+
+	@JsonCreator
+	public PatchField(String field, @Nullable Integer groupIndex) {
+		this.field = field;
+		this.groupIndex = groupIndex;
+	}
+
 	public static PatchField of(String field, Integer groupIndex) {
 		return new PatchField().setField(field).setGroupIndex(groupIndex);
 	}
@@ -50,10 +63,16 @@ public PatchField setGroupIndex(@Nullable Integer groupIndex) {
 		return this;
 	}
 
+	@JsonIgnore
 	public Optional<Integer> getGroupNumber() {
 		return Optional.ofNullable(groupIndex).map(index -> index + 1);
 	}
 
+	@JsonValue
+	public String toJsonValue() {
+		return groupIndex == null ? field : field + "@" + groupIndex;
+	}
+
 	@Override
 	public boolean equals(Object o) {
 		if (o == null || getClass() != o.getClass())

sormas-api/src/main/java/de/symeda/sormas/api/externalmessage/survey/PatchFieldKeyDeserializer.java

@@ -0,0 +1,35 @@
+package de.symeda.sormas.api.externalmessage.survey;
+
+import java.io.IOException;
+
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.KeyDeserializer;
+
+public class PatchFieldKeyDeserializer extends KeyDeserializer {
+
+	@Override
+	public Object deserializeKey(String key, DeserializationContext ctxt) throws IOException {
+		if (key == null || key.isBlank()) {
+			return null;
+		}
+
+		int atIndex = key.lastIndexOf('@');
+		if (atIndex < 0) {
+			return PatchField.of(key);
+		}
+
+		String field = key.substring(0, atIndex);
+		String indexPart = key.substring(atIndex + 1);
+
+		if (field.isBlank()) {
+			throw ctxt.weirdKeyException(PatchField.class, key, "Field part is empty");
+		}
+
+		try {
+			Integer groupIndex = Integer.valueOf(indexPart);
+			return PatchField.of(field, groupIndex);
+		} catch (NumberFormatException e) {
+			throw ctxt.weirdKeyException(PatchField.class, key, String.format("groupIndex must be an integer, was. [%s]", indexPart));
+		}
+	}
+}

sormas-backend/src/main/java/de/symeda/sormas/backend/json/ObjectMapperProvider.java

@@ -22,8 +22,12 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 
+import de.symeda.sormas.api.externalmessage.survey.PatchField;
+import de.symeda.sormas.api.externalmessage.survey.PatchFieldKeyDeserializer;
+
 /**
  * Permits unified access to a pre-configured {@link ObjectMapper} instance.
  */
@@ -72,6 +76,10 @@ private static ObjectMapper createObjectMapper() {
 
 		mapper.registerModule(new JavaTimeModule());
 
+		SimpleModule simpleModule = new SimpleModule();
+		simpleModule.addKeyDeserializer(PatchField.class, new PatchFieldKeyDeserializer());
+		mapper.registerModule(simpleModule);
+
 		mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
 
 		return mapper;

sormas-backend/src/test/java/de/symeda/sormas/backend/externalmessage/survey/PatchDictionarySerializationTest.java

@@ -0,0 +1,34 @@
+package de.symeda.sormas.backend.externalmessage.survey;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.LinkedHashMap;
+
+import org.junit.jupiter.api.Test;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+import de.symeda.sormas.api.externalmessage.survey.PatchDictionary;
+import de.symeda.sormas.api.externalmessage.survey.PatchField;
+import de.symeda.sormas.backend.AbstractUnitTest;
+import de.symeda.sormas.backend.json.ObjectMapperProvider;
+
+class PatchDictionarySerializationTest extends AbstractUnitTest {
+
+	@Test
+	void test_serialization_deserialization_works() throws JsonProcessingException {
+		// PREPARE
+		LinkedHashMap<PatchField, Object> dictionary = new LinkedHashMap<>();
+		dictionary.put(PatchField.of("fieldNameWithoutGroup"), 5);
+		dictionary.put(PatchField.of("fieldNameWithGroup", 2), "toeiwjew");
+		PatchDictionary initial = new PatchDictionary().setDictionary(dictionary);
+
+		// EXECUTE
+		String json = ObjectMapperProvider.writeValueAsStringFailSafe(initial);
+
+		PatchDictionary actual = ObjectMapperProvider.getInstance().readValue(json, PatchDictionary.class);
+
+		// CHECK
+		assertEquals(initial, actual);
+	}
+}