Merge pull request #268 from InseeFr/devMetadataCache

feat: Stockage des métadonnées BPM

Author: alexisszmundy

pom.xml

@@ -57,6 +57,10 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-webflux</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-cache</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>org.springframework.boot</groupId>

src/main/java/fr/insee/genesis/configuration/CacheConfiguration.java

@@ -0,0 +1,18 @@
+package fr.insee.genesis.configuration;
+
+import org.springframework.cache.CacheManager;
+import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.cache.concurrent.ConcurrentMapCacheManager;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+@Configuration
+@EnableCaching
+@EnableScheduling
+public class CacheConfiguration {
+    @Bean
+    public CacheManager cacheManager(){
+        return new ConcurrentMapCacheManager("variableTypes","metadatas");
+    }
+}

src/main/java/fr/insee/genesis/configuration/Config.java

@@ -2,14 +2,12 @@
 
 import lombok.Getter;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.context.annotation.Configuration;
 
 import java.nio.file.Path;
 
 @Configuration
 @Getter
-@EnableCaching
 public class Config {
 
 	/******************************************************/

src/main/java/fr/insee/genesis/controller/rest/QuestionnaireMetadataController.java

@@ -0,0 +1,62 @@
+package fr.insee.genesis.controller.rest;
+
+import fr.insee.bpm.metadata.model.MetadataModel;
+import fr.insee.genesis.domain.model.surveyunit.Mode;
+import fr.insee.genesis.domain.ports.api.QuestionnaireMetadataApiPort;
+import fr.insee.genesis.exceptions.GenesisException;
+import io.swagger.v3.oas.annotations.Operation;
+import lombok.AllArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+
+@Controller
+@RequestMapping(path = "/questionnaire-metadata")
+@AllArgsConstructor
+public class QuestionnaireMetadataController {
+
+    private final QuestionnaireMetadataApiPort questionnaireMetadataApiPort;
+
+    @Operation(summary = "Get questionnaire metadata from database")
+    @GetMapping("")
+    @PreAuthorize("hasRole('USER_KRAFTWERK')")
+    public ResponseEntity<Object> getMetadata(
+            @RequestParam("questionnaireId") String questionnaireId,
+            @RequestParam("mode") Mode mode
+    ){
+        try {
+            return ResponseEntity.ok().body(questionnaireMetadataApiPort.find(questionnaireId, mode));
+        } catch (GenesisException e) {
+            return ResponseEntity.status(e.getStatus()).body(e.getMessage());
+        }
+    }
+
+    @Operation(summary = "Save questionnaire metadata into database")
+    @PostMapping("")
+    @PreAuthorize("hasRole('USER_KRAFTWERK')")
+    public ResponseEntity<Object> saveMetadata(
+            @RequestParam("questionnaireId") String questionnaireId,
+            @RequestParam("mode") Mode mode,
+            @RequestBody MetadataModel body
+    ) {
+        questionnaireMetadataApiPort.save(questionnaireId, mode, body);
+        return ResponseEntity.ok().build();
+    }
+
+    @Operation(summary = "Removes questionnaire metadata from database")
+    @DeleteMapping("")
+    @PreAuthorize("hasRole('ADMIN')")
+    public ResponseEntity<Object> deleteMetadata(
+            @RequestParam("questionnaireId") String questionnaireId,
+            @RequestParam("mode") Mode mode
+    ){
+        questionnaireMetadataApiPort.remove(questionnaireId, mode);
+        return ResponseEntity.ok().build();
+    }
+}

src/main/java/fr/insee/genesis/controller/rest/responses/ResponseController.java

@@ -0,0 +1,10 @@
+package fr.insee.genesis.domain.model.metadata;
+
+import fr.insee.bpm.metadata.model.MetadataModel;
+import fr.insee.genesis.domain.model.surveyunit.Mode;
+
+public record QuestionnaireMetadataModel (
+    String questionnaireId,
+    Mode mode,
+    MetadataModel metadataModel
+){}

src/main/java/fr/insee/genesis/domain/model/metadata/QuestionnaireMetadataModel.java

@@ -0,0 +1,18 @@
+package fr.insee.genesis.domain.ports.api;
+
+import fr.insee.bpm.metadata.model.MetadataModel;
+import fr.insee.genesis.domain.model.surveyunit.Mode;
+import fr.insee.genesis.exceptions.GenesisError;
+import fr.insee.genesis.exceptions.GenesisException;
+import fr.insee.genesis.infrastructure.utils.FileUtils;
+
+import java.util.List;
+
+public interface QuestionnaireMetadataApiPort {
+    MetadataModel find(String questionnaireId, Mode mode) throws GenesisException;
+    MetadataModel loadAndSaveIfNotExists(String campaignName, String questionnaireId, Mode mode, FileUtils fileUtils,
+                                         List<GenesisError> errors) throws GenesisException;
+    void remove(String questionnaireId, Mode mode);
+
+    void save(String questionnaireId, Mode mode, MetadataModel metadataModel);
+}

src/main/java/fr/insee/genesis/domain/ports/api/QuestionnaireMetadataApiPort.java

@@ -31,7 +31,7 @@ public interface SurveyUnitApiPort {
     List<List<SurveyUnitModel>> findLatestByIdAndByQuestionnaireIdAndModeOrdered(String questionnaireId, String mode, List<InterrogationId> interrogationIds);
     //========= OPTIMISATIONS PERFS (END) ==========
 
-    SurveyUnitDto findLatestValuesByStateByIdAndByQuestionnaireId(String interrogationId, String questionnaireId);
+    SurveyUnitDto findLatestValuesByStateByIdAndByQuestionnaireId(String interrogationId, String questionnaireId) throws GenesisException;
 
     List<SurveyUnitModel> findInterrogationIdsAndModesByQuestionnaireId(String questionnaireId);
 

src/main/java/fr/insee/genesis/domain/ports/api/SurveyUnitApiPort.java

@@ -0,0 +1,5 @@
+package fr.insee.genesis.domain.ports.spi;
+
+public interface CacheServicePort {
+    void cleanCache();
+}

src/main/java/fr/insee/genesis/domain/ports/spi/CacheServicePort.java

@@ -0,0 +1,13 @@
+package fr.insee.genesis.domain.ports.spi;
+
+import fr.insee.genesis.domain.model.metadata.QuestionnaireMetadataModel;
+import fr.insee.genesis.domain.model.surveyunit.Mode;
+
+import java.util.List;
+
+public interface QuestionnaireMetadataPersistancePort {
+    List<QuestionnaireMetadataModel> find(String questionnaireId, Mode mode);
+    void save(QuestionnaireMetadataModel questionnaireMetadataModel);
+
+    void remove(String questionnaireId, Mode mode);
+}