SORMAS-Foundation#3927 Deletion of old SystemEvents

Author: FredrikSchäferVitagroup

sormas-api/src/main/java/de/symeda/sormas/api/ConfigFacade.java

@@ -85,6 +85,8 @@ public interface ConfigFacade {
 
 	int getDaysAfterEventGetsArchived();
 
+	int getDaysAfterSystemEventGetsDeleted();
+
 	GeoLatLon getCountryCenter();
 
 	int getMapZoom();

sormas-api/src/main/java/de/symeda/sormas/api/systemevents/SystemEventFacade.java

@@ -9,4 +9,7 @@ public interface SystemEventFacade {
 	Date getLatestSuccessByType(SystemEventType type);
 
 	void saveSystemEvent(SystemEventDto dto);
+
+	void deleteAllDeletableSystemEvents(int daysAfterSystemEventGetsDeleted);
+
 }

sormas-backend/src/main/java/de/symeda/sormas/backend/common/ConfigFacadeEjb.java

@@ -108,6 +108,8 @@ public class ConfigFacadeEjb implements ConfigFacade {
 	public static final String DAYS_AFTER_CASE_GETS_ARCHIVED = "daysAfterCaseGetsArchived";
 	private static final String DAYS_AFTER_EVENT_GETS_ARCHIVED = "daysAfterEventGetsArchived";
 
+	private static final String DAYS_AFTER_SYSTEM_EVENT_GETS_DELETED = "daysAfterSystemEventGetsDeleted";
+
 	private static final String GEOCODING_SERVICE_URL_TEMPLATE = "geocodingServiceUrlTemplate";
 	private static final String GEOCODING_LONGITUDE_JSON_PATH = "geocodingLongitudeJsonPath";
 	private static final String GEOCODING_LATITUDE_JSON_PATH = "geocodingLatitudeJsonPath";
@@ -373,6 +375,11 @@ public int getDaysAfterEventGetsArchived() {
 		return getInt(DAYS_AFTER_EVENT_GETS_ARCHIVED, 90);
 	}
 
+	@Override
+	public int getDaysAfterSystemEventGetsDeleted() {
+		return getInt(DAYS_AFTER_SYSTEM_EVENT_GETS_DELETED, 90);
+	}
+
 	@Override
 	public String getGeocodingServiceUrlTemplate() {
 		return getProperty(GEOCODING_SERVICE_URL_TEMPLATE, null);

sormas-backend/src/main/java/de/symeda/sormas/backend/common/CronService.java

@@ -25,6 +25,7 @@
 import javax.ejb.Schedule;
 import javax.ejb.Singleton;
 
+import de.symeda.sormas.backend.systemevent.SystemEventFacadeEjb.SystemEventFacadeEjbLocal;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -65,6 +66,8 @@ public class CronService {
 	private EventFacadeEjbLocal eventFacade;
 	@EJB
 	private DocumentFacadeEjbLocal documentFacade;
+	@EJB
+	private SystemEventFacadeEjbLocal systemEventFacade;
 
 	@Schedule(hour = "*", minute = "*/" + TASK_UPDATE_INTERVAL, second = "0", persistent = false)
 	public void sendNewAndDueTaskMessages() {
@@ -138,4 +141,13 @@ public void archiveEvents() {
 	public void cleanupDeletedDocuments() {
 		documentFacade.cleanupDeletedDocuments();
 	}
+
+	@Schedule(hour = "1", minute = "30", second = "0", persistent = false)
+	public void deleteSystemEvents() {
+		int daysAfterSystemEventGetsDeleted = configFacade.getDaysAfterSystemEventGetsDeleted();
+		if (daysAfterSystemEventGetsDeleted >= 1) {
+			systemEventFacade.deleteAllDeletableSystemEvents(daysAfterSystemEventGetsDeleted);
+		}
+	}
+
 }

sormas-backend/src/main/java/de/symeda/sormas/backend/systemevent/SystemEvent.java

@@ -12,6 +12,7 @@
 import javax.persistence.Temporal;
 import javax.persistence.TemporalType;
 import java.util.Date;
+import java.util.Objects;
 
 import static de.symeda.sormas.api.EntityDto.COLUMN_LENGTH_DEFAULT;
 
@@ -78,4 +79,24 @@ public void setAdditionalInfo(String additionalInfo) {
 		this.additionalInfo = additionalInfo;
 	}
 
+	@Override
+	public boolean equals(Object o) {
+		if (this == o)
+			return true;
+		if (o == null || getClass() != o.getClass())
+			return false;
+		if (!super.equals(o))
+			return false;
+		SystemEvent that = (SystemEvent) o;
+		return type == that.type
+			&& Objects.equals(startDate, that.startDate)
+			&& Objects.equals(endDate, that.endDate)
+			&& status == that.status
+			&& Objects.equals(additionalInfo, that.additionalInfo);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(super.hashCode(), type, startDate, endDate, status, additionalInfo);
+	}
 }

sormas-backend/src/main/java/de/symeda/sormas/backend/systemevent/SystemEventFacadeEjb.java

@@ -4,11 +4,11 @@
 import de.symeda.sormas.api.systemevents.SystemEventFacade;
 import de.symeda.sormas.api.systemevents.SystemEventStatus;
 import de.symeda.sormas.api.systemevents.SystemEventType;
-import de.symeda.sormas.backend.event.EventParticipant;
-import de.symeda.sormas.backend.labmessage.LabMessage;
-import de.symeda.sormas.backend.labmessage.LabMessageFacadeEjb;
+import de.symeda.sormas.api.utils.DateHelper;
 import de.symeda.sormas.backend.util.DtoHelper;
 import de.symeda.sormas.backend.util.ModelConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import javax.ejb.EJB;
 import javax.ejb.LocalBean;
@@ -20,6 +20,8 @@
 import javax.persistence.criteria.Predicate;
 import javax.persistence.criteria.Root;
 import javax.validation.constraints.NotNull;
+import java.sql.Timestamp;
+import java.time.LocalDateTime;
 import java.util.Date;
 import java.util.List;
 
@@ -32,6 +34,8 @@ public class SystemEventFacadeEjb implements SystemEventFacade {
 	@EJB
 	private SystemEventService systemEventService;
 
+	private final Logger logger = LoggerFactory.getLogger(getClass());
+
 	@Override
 	public Date getLatestSuccessByType(SystemEventType type) {
 		CriteriaBuilder cb = em.getCriteriaBuilder();
@@ -60,7 +64,7 @@ public void saveSystemEvent(SystemEventDto dto) {
 
 	}
 
-	private SystemEvent fromDto(@NotNull SystemEventDto source, SystemEvent target) {
+	public SystemEvent fromDto(@NotNull SystemEventDto source, SystemEvent target) {
 
 		if (target == null) {
 			target = new SystemEvent();
@@ -79,6 +83,33 @@ private SystemEvent fromDto(@NotNull SystemEventDto source, SystemEvent target)
 
 	}
 
+	@Override
+	public void deleteAllDeletableSystemEvents(int daysAfterSystemEventGetsDeleted) {
+		deleteAllDeletableSystemEvents(LocalDateTime.now().minusDays(daysAfterSystemEventGetsDeleted));
+	}
+
+	public void deleteAllDeletableSystemEvents(LocalDateTime notChangedUntil) {
+
+		long startTime = DateHelper.startTime();
+
+		CriteriaBuilder cb = em.getCriteriaBuilder();
+		CriteriaQuery<SystemEvent> cq = cb.createQuery(SystemEvent.class);
+		Root<SystemEvent> systemEvent = cq.from(SystemEvent.class);
+
+		Timestamp notChangedTimestamp = Timestamp.valueOf(notChangedUntil);
+		cq.where(cb.not(systemEventService.createChangeDateFilter(cb, systemEvent, notChangedTimestamp)));
+
+		List<SystemEvent> resultList = em.createQuery(cq).getResultList();
+		for (SystemEvent event : resultList) {
+			em.remove(event);
+		}
+
+		logger.debug(
+			"deleteAllDeletableSystemEvents() finished. systemEvent count = {}, {}ms",
+			resultList.size(),
+			DateHelper.durationMillies(startTime));
+	}
+
 	@LocalBean
 	@Stateless
 	public static class SystemEventFacadeEjbLocal extends SystemEventFacadeEjb {

sormas-backend/src/test/java/de/symeda/sormas/backend/systemevent/SystemEventFacadeEjbTest.java

@@ -5,11 +5,18 @@
 import de.symeda.sormas.api.systemevents.SystemEventType;
 import de.symeda.sormas.backend.AbstractBeanTest;
 import de.symeda.sormas.backend.TestDataCreator;
+
 import org.junit.Test;
 
+import javax.persistence.criteria.CriteriaBuilder;
+import javax.persistence.criteria.CriteriaQuery;
+
+import java.time.LocalDateTime;
 import java.util.Date;
+import java.util.List;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
 
 public class SystemEventFacadeEjbTest extends AbstractBeanTest {
 
@@ -32,4 +39,42 @@ public void testGetLatestSuccessByType() {
 		assertEquals(intermediateDate, getSystemEventFacade().getLatestSuccessByType(SystemEventType.FETCH_LAB_MESSAGES));
 	}
 
+	@Test
+	public void testDeleteAllDeletableSystemEvents() throws InterruptedException {
+
+		LocalDateTime earliest = LocalDateTime.now();
+		SystemEventDto systemEvent1 = creator.createSystemEvent(SystemEventType.FETCH_LAB_MESSAGES, new Date(), SystemEventStatus.ERROR);
+		getSystemEventFacade().saveSystemEvent(systemEvent1);
+		// Small delay for the persistence
+		Thread.sleep(100L);
+
+		LocalDateTime inBetween = LocalDateTime.now();
+		SystemEventDto systemEvent2 = creator.createSystemEvent(SystemEventType.FETCH_LAB_MESSAGES, new Date(), SystemEventStatus.SUCCESS);
+		getSystemEventFacade().saveSystemEvent(systemEvent2);
+		// Small delay for the persistence
+		Thread.sleep(100L);
+
+		SystemEventFacadeEjb systemEventFacadeEjb = (SystemEventFacadeEjb) getSystemEventFacade();
+
+		systemEventFacadeEjb.deleteAllDeletableSystemEvents(earliest);
+		assertTrue(getAllSystemEvents().size() == 2);
+
+		getSystemEventFacade().deleteAllDeletableSystemEvents(1);
+		assertTrue(getAllSystemEvents().size() == 2);
+
+		systemEventFacadeEjb.deleteAllDeletableSystemEvents(inBetween);
+		assertEquals(systemEventFacadeEjb.fromDto(systemEvent2, null), getAllSystemEvents().get(0));
+
+		getSystemEventFacade().deleteAllDeletableSystemEvents(-1);
+		assertTrue(getAllSystemEvents().isEmpty());
+
+	}
+
+	private List<SystemEvent> getAllSystemEvents() {
+		CriteriaBuilder cb = getEntityManager().getCriteriaBuilder();
+		CriteriaQuery<SystemEvent> cq = cb.createQuery(SystemEvent.class);
+		cq.from(SystemEvent.class);
+		return getEntityManager().createQuery(cq).getResultList();
+	}
+
 }

sormas-base/setup/sormas.properties

@@ -125,6 +125,10 @@ sms.auth.secret=
 # default: 90 (3 months)
 # daysAfterEventGetsArchived=
 
+# Number of days after which a system event is automatically deleted
+# default: 90 (3 months)
+# daysAfterSystemEventGetsDeleted=
+
 # Location of the Rscript executable. If specified, network diagrams will be enabled
 #rscript.executable=Rscript