Added a log cleaner #4180

Signed-off-by: ClementBouvierN <clement.bouvierneveu@rte-france.com>

config/dev/users-dev.yml

@@ -156,4 +156,7 @@ operatorfabric.users.default:
       description: Da Operator Rulez
 #logging:
 #  level:
-#    ROOT: DEBUG
+#    ROOT: DEBUG
+
+daysBeforeLogExpiration: 61
+hourScheduledForLogsCleaning: 0 30 0 * * *

services/cards-consultation/src/main/java/org/opfab/cards/consultation/repositories/CardCustomRepositoryImpl.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2022, RTE (http://www.rte-france.com)
+/* Copyright (c) 2018-2023, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -16,7 +16,6 @@
 import org.opfab.cards.consultation.model.LightCardConsultationData;
 import org.opfab.cards.model.CardOperationTypeEnum;
 import org.opfab.users.model.CurrentUserWithPerimeters;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.mongodb.core.ReactiveMongoTemplate;
 import org.springframework.data.mongodb.core.query.Criteria;
 import org.springframework.data.mongodb.core.query.Query;

services/users/src/main/java/org/opfab/users/scheduledtask/DeleteExpiredLogsScheduler.java

@@ -0,0 +1,36 @@
+/* Copyright (c) 2023, RTE (http://www.rte-france.com)
+ * See AUTHORS.txt
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ * This file is part of the OperatorFabric project.
+ */
+
+
+package org.opfab.users.scheduledtask;
+
+import lombok.extern.slf4j.Slf4j;
+
+import org.opfab.useractiontracing.services.UserActionLogService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.scheduling.annotation.EnableScheduling;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Service;
+
+@Service
+@Slf4j
+@EnableScheduling
+public class DeleteExpiredLogsScheduler {
+    @Autowired
+    UserActionLogService userActionLogService;
+
+    @Value("${daysBeforeLogExpiration:61}") Integer daysBeforeLogExpiration;
+    @Value("${hourScheduledForLogsCleaning:0 30 0 * * *}") String hourScheduledForLogsCleaning;
+
+    @Scheduled(cron = "${hourScheduledForLogsCleaning:0 30 0 * * *}") //0 30 0 * * *
+    public void deleteExpiredLogs() {
+        userActionLogService.deleteLogsByExpirationDate(daysBeforeLogExpiration);
+    }
+}

tools/user-action-tracing/src/main/java/org/opfab/useractiontracing/repositories/UserActionLogCustomRepository.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2022, RTE (http://www.rte-france.com)
+/* Copyright (c) 2023, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -9,6 +9,8 @@
 
 package org.opfab.useractiontracing.repositories;
 
+import java.time.Instant;
+
 import org.opfab.useractiontracing.model.UserActionLog;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
@@ -17,5 +19,6 @@
 public interface UserActionLogCustomRepository {
 
     Page<UserActionLog> findByParams(MultiValueMap<String, String> params, Pageable pageable);
+    abstract void deleteExpiredLogs(Instant expirationDate);
 
 }

tools/user-action-tracing/src/main/java/org/opfab/useractiontracing/repositories/UserActionLogCustomRepositoryImpl.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2022, RTE (http://www.rte-france.com)
+/* Copyright (c) 2023, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -16,6 +16,7 @@
 import org.springframework.data.mongodb.core.aggregation.Aggregation;
 import org.springframework.data.mongodb.core.aggregation.AggregationOperation;
 import org.springframework.data.mongodb.core.query.Criteria;
+import org.springframework.data.mongodb.core.query.Query;
 import org.springframework.util.MultiValueMap;
 
 import java.time.Instant;
@@ -102,4 +103,10 @@ else if (key.equals("dateTo"))
         return criteria;
     }
 
+    public void deleteExpiredLogs (Instant expirationDate) {
+        Query expiredLogs = new Query();
+        expiredLogs.addCriteria(Criteria.where("date").lt(expirationDate));
+        this.template.remove(expiredLogs, UserActionLog.class, "userActionLogs");
+    }
+
 }

tools/user-action-tracing/src/main/java/org/opfab/useractiontracing/services/UserActionLogService.java

@@ -1,4 +1,4 @@
-/* Copyright (c) 2022, RTE (http://www.rte-france.com)
+/* Copyright (c) 2023, RTE (http://www.rte-france.com)
  * See AUTHORS.txt
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -18,9 +18,13 @@
 import org.springframework.stereotype.Service;
 import org.springframework.util.MultiValueMap;
 
+import lombok.extern.slf4j.Slf4j;
+
 import java.time.Instant;
+import java.time.temporal.ChronoUnit;
 import java.util.List;
 
+@Slf4j
 @Service
 public class UserActionLogService {
 
@@ -30,7 +34,8 @@ public UserActionLogService(UserActionLogRepository userActionLogRepository) {
         this.userActionLogRepository = userActionLogRepository;
     }
 
-    public void insertUserActionLog(String login, UserActionEnum actionType, List<String> entities, String cardUid, String comment) {
+    public void insertUserActionLog(String login, UserActionEnum actionType, List<String> entities, String cardUid,
+            String comment) {
         UserActionLog action = UserActionLog.builder().login(login)
                 .action(actionType)
                 .date(Instant.now())
@@ -40,6 +45,7 @@ public void insertUserActionLog(String login, UserActionEnum actionType, List<St
                 .build();
         this.insertUserActionLog(action);
     }
+
     public void insertUserActionLog(UserActionLog action) {
         this.userActionLogRepository.save(action);
     }
@@ -52,4 +58,10 @@ public Page<UserActionLog> getUserActionLogsByParams(MultiValueMap<String, Strin
         return this.userActionLogRepository.findByParams(params, pageable);
     }
 
+    public void deleteLogsByExpirationDate(Integer daysStored) {     
+        Instant expirationDate = Instant.now().minus(daysStored, ChronoUnit.DAYS);
+        this.userActionLogRepository.deleteExpiredLogs(expirationDate);
+        log.info("Expired logs have been deleted");
+    }
+
 }