Refactor : use different Dtos to import changes in Genesis

loichenninger · loichenninger · commit e1fdb108edff · 2025-01-22T18:30:06.000+01:00
diff --git a/src/main/java/fr/insee/genesis/controller/dto/SurveyUnitInputDto.java b/src/main/java/fr/insee/genesis/controller/dto/SurveyUnitInputDto.java
@@ -0,0 +1,19 @@
+package fr.insee.genesis.controller.dto;
+
+import fr.insee.genesis.domain.model.surveyunit.Mode;
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+@Builder
+@Data
+public class SurveyUnitInputDto {
+
+    private String surveyUnitId;
+    private String campaignId;
+    private Mode mode;
+    private String idQuestionnaire;
+    private List<VariableInputDto> collectedVariables;
+
+}
diff --git a/src/main/java/fr/insee/genesis/controller/dto/VariableInputDto.java b/src/main/java/fr/insee/genesis/controller/dto/VariableInputDto.java
@@ -0,0 +1,17 @@
+package fr.insee.genesis.controller.dto;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+@Builder
+@Data
+public class VariableInputDto {
+    private String variableName;
+    private String idLoop;
+
+    @JsonProperty("newVariableState")
+    private VariableStateInputDto variableStateInputDto;
+}
diff --git a/src/main/java/fr/insee/genesis/controller/dto/VariableStateInputDto.java b/src/main/java/fr/insee/genesis/controller/dto/VariableStateInputDto.java
@@ -0,0 +1,15 @@
+package fr.insee.genesis.controller.dto;
+
+import fr.insee.genesis.domain.model.surveyunit.DataState;
+import lombok.Builder;
+import lombok.Data;
+
+@Builder
+@Data
+public class VariableStateInputDto {
+
+    private DataState state;
+
+    private String value;
+
+}
diff --git a/src/main/java/fr/insee/genesis/controller/rest/responses/ResponseController.java b/src/main/java/fr/insee/genesis/controller/rest/responses/ResponseController.java
@@ -9,6 +9,7 @@
 import fr.insee.genesis.controller.adapter.LunaticXmlAdapter;
 import fr.insee.genesis.controller.dto.SurveyUnitDto;
 import fr.insee.genesis.controller.dto.SurveyUnitId;
+import fr.insee.genesis.controller.dto.SurveyUnitInputDto;
 import fr.insee.genesis.controller.dto.SurveyUnitSimplified;
 import fr.insee.genesis.controller.sources.xml.LunaticXmlCampaign;
 import fr.insee.genesis.controller.sources.xml.LunaticXmlDataParser;
@@ -370,34 +371,29 @@ public ResponseEntity<List<SurveyUnitSimplified>> getLatestForUEList(@RequestPar
             description = "Save edited variables document into database")
     @PostMapping(path = "/save-edited")
     public ResponseEntity<Object> saveEditedVariables(
-            @RequestParam("campaignId") String campaignId,
-            @RequestParam("mode") Mode mode,
-            @RequestParam("idQuestionnaire") String idQuestionnaire,
-            @RequestBody SurveyUnitDto surveyUnitDto
+            @RequestBody SurveyUnitInputDto surveyUnitInputDto
     ){
         //Parse metadata
         //Try to look for DDI first, if no DDI found looks for lunatic components
         List<GenesisError> errors = new ArrayList<>();
-        VariablesMap variablesMap = readMetadatas(campaignId, mode, errors, true);
+        VariablesMap variablesMap = readMetadatas(surveyUnitInputDto.getCampaignId(), surveyUnitInputDto.getMode(), errors, true);
         if(variablesMap == null){
             log.warn("Can't find DDI, trying with lunatic...");
-            variablesMap = readMetadatas(campaignId, mode, errors, false);
+            variablesMap = readMetadatas(surveyUnitInputDto.getCampaignId(), surveyUnitInputDto.getMode(), errors, false);
             if(variablesMap == null){
                 return ResponseEntity.status(404).body(errors.getLast().getMessage());
             }
         }
 
         //Check if input edited variables are in metadatas
         List<String> absentCollectedVariableNames =
-                surveyUnitQualityService.checkVariablesPresentInMetadata(surveyUnitDto.getCollectedVariables(),
+                surveyUnitQualityService.checkVariablesPresentInMetadata(surveyUnitInputDto.getCollectedVariables(),
                 variablesMap);
-        List<String> absentExternalVariableNames =
-                surveyUnitQualityService.checkVariablesPresentInMetadata(surveyUnitDto.getExternalVariables(),
-                        variablesMap);
-        if (!absentCollectedVariableNames.isEmpty() || !absentExternalVariableNames.isEmpty()) {
-            String absentVariables =
-                    Stream.concat(absentCollectedVariableNames.stream(),absentExternalVariableNames.stream())
-                    .collect(Collectors.joining("\n"));
+//        List<String> absentExternalVariableNames =
+//                surveyUnitQualityService.checkVariablesPresentInMetadata(surveyUnitInputDto.getExternalVariables(),
+//                        variablesMap);
+        if (!absentCollectedVariableNames.isEmpty()) {
+            String absentVariables = String.join("\n", absentCollectedVariableNames);
             return ResponseEntity.badRequest().body(
                     String.format("The following variables are absent in metadatas : %n%s", absentVariables)
             );
@@ -407,25 +403,19 @@ public ResponseEntity<Object> saveEditedVariables(
         String userIdentifier = authUtils.getIDEP();
 
 
-        //Create EDITED surveyUnitModel
-        SurveyUnitModel surveyUnitModel;
+        //Create surveyUnitModel for each STATE received (Quality tool could send variables with another STATE than EDITED)
+        List<SurveyUnitModel> surveyUnitModels;
         try{
-            surveyUnitModel = surveyUnitService.parseEditedVariables(
-                    campaignId,
-                    mode,
-                    idQuestionnaire,
-                    surveyUnitDto,
+            surveyUnitModels = surveyUnitService.parseEditedVariables(
+                    surveyUnitInputDto,
                     userIdentifier,
                     variablesMap
             );
         }catch (GenesisException e){
            return ResponseEntity.status(e.getStatus()).body(e.getMessage());
         }
 
-
         //Check data with dataverifier (might create a FORCED document)
-        List<SurveyUnitModel> surveyUnitModels = new ArrayList<>();
-        surveyUnitModels.add(surveyUnitModel);
         surveyUnitQualityService.verifySurveyUnits(surveyUnitModels, variablesMap);
 
         //Save documents
diff --git a/src/main/java/fr/insee/genesis/domain/ports/api/SurveyUnitApiPort.java b/src/main/java/fr/insee/genesis/domain/ports/api/SurveyUnitApiPort.java
@@ -3,7 +3,7 @@
 import fr.insee.bpm.metadata.model.VariablesMap;
 import fr.insee.genesis.controller.dto.CampaignWithQuestionnaire;
 import fr.insee.genesis.controller.dto.SurveyUnitDto;
-import fr.insee.genesis.controller.dto.VariableDto;
+import fr.insee.genesis.controller.dto.SurveyUnitInputDto;
 import fr.insee.genesis.domain.model.surveyunit.Mode;
 import fr.insee.genesis.controller.dto.QuestionnaireWithCampaign;
 import fr.insee.genesis.domain.model.surveyunit.SurveyUnitModel;
@@ -52,10 +52,7 @@ public interface SurveyUnitApiPort {
 
     List<QuestionnaireWithCampaign> findQuestionnairesWithCampaigns();
 
-    SurveyUnitModel parseEditedVariables(String campaignId,
-                                         Mode mode,
-                                         String idQuestionnaire,
-                                         SurveyUnitDto surveyUnitDto,
+    List<SurveyUnitModel> parseEditedVariables(SurveyUnitInputDto surveyUnitInputDto,
                                          String userIdentifier,
                                          VariablesMap variablesMap) throws GenesisException;
 }
diff --git a/src/main/java/fr/insee/genesis/domain/service/surveyunit/SurveyUnitQualityService.java b/src/main/java/fr/insee/genesis/domain/service/surveyunit/SurveyUnitQualityService.java
@@ -1,6 +1,7 @@
 package fr.insee.genesis.domain.service.surveyunit;
 
 import fr.insee.genesis.controller.dto.VariableDto;
+import fr.insee.genesis.controller.dto.VariableInputDto;
 import fr.insee.genesis.domain.model.surveyunit.SurveyUnitModel;
 import fr.insee.genesis.domain.utils.DataVerifier;
 import fr.insee.bpm.metadata.model.VariablesMap;
@@ -20,16 +21,16 @@ public void verifySurveyUnits(List<SurveyUnitModel> surveyUnitModels, VariablesM
 
     /**
      * Checks
-     * @param variableDtos input variables to check
+     * @param variableInputDtos input variables to check
      * @param variablesMap BPM Questionnaire metadata to use for checking
      * @return A list of variables that are <strong>absent</strong> in metadata
      */
-    public List<String> checkVariablesPresentInMetadata(List<VariableDto> variableDtos, VariablesMap variablesMap) {
+    public List<String> checkVariablesPresentInMetadata(List<VariableInputDto> variableInputDtos, VariablesMap variablesMap) {
         List<String> absentVariableNames = new ArrayList<>();
 
-        for(VariableDto variableDto : variableDtos){
-            if(!variablesMap.hasVariable(variableDto.getVariableName())){
-                absentVariableNames.add(variableDto.getVariableName());
+        for(VariableInputDto variableInputDto : variableInputDtos){
+            if(!variablesMap.hasVariable(variableInputDto.getVariableName())){
+                absentVariableNames.add(variableInputDto.getVariableName());
             }
         }
 
diff --git a/src/main/java/fr/insee/genesis/domain/service/surveyunit/SurveyUnitService.java b/src/main/java/fr/insee/genesis/domain/service/surveyunit/SurveyUnitService.java
@@ -5,7 +5,9 @@
 import fr.insee.genesis.controller.dto.QuestionnaireWithCampaign;
 import fr.insee.genesis.controller.dto.SurveyUnitDto;
 import fr.insee.genesis.controller.dto.SurveyUnitId;
+import fr.insee.genesis.controller.dto.SurveyUnitInputDto;
 import fr.insee.genesis.controller.dto.VariableDto;
+import fr.insee.genesis.controller.dto.VariableInputDto;
 import fr.insee.genesis.controller.dto.VariableStateDto;
 import fr.insee.genesis.domain.model.surveyunit.CollectedVariable;
 import fr.insee.genesis.domain.model.surveyunit.DataState;
@@ -234,75 +236,58 @@ public List<QuestionnaireWithCampaign> findQuestionnairesWithCampaigns() {
     }
 
     @Override
-    public SurveyUnitModel parseEditedVariables(
-            String campaignId,
-            Mode mode,
-            String idQuestionnaire,
-            SurveyUnitDto surveyUnitDto,
+    public List<SurveyUnitModel> parseEditedVariables(
+            SurveyUnitInputDto surveyUnitInputDto,
             String userIdentifier,
             VariablesMap variablesMap
     ) throws GenesisException {
-        SurveyUnitModel surveyUnitModel = SurveyUnitModel.builder()
-                .idCampaign(campaignId)
-                .mode(mode)
-                .idQuest(idQuestionnaire)
-                .idUE(surveyUnitDto.getSurveyUnitId())
-                .state(DataState.EDITED)
-                .recordDate(LocalDateTime.now())
-                .collectedVariables(new ArrayList<>())
-                .externalVariables(new ArrayList<>())
-                .modifiedBy(userIdentifier)
-                .build();
 
-        //Keep only variable dtos who has at least one EDITED variableStateDto
-        List<VariableDto> editedCollectedVariables = surveyUnitDto.getCollectedVariables().stream().filter(
-                variableDto -> !variableDto.getVariableStateDtoList().stream().filter(
-                        variableStateDto -> variableStateDto.getState().equals(DataState.EDITED)
-                ).toList().isEmpty()
-        ).toList();
-
-        List<VariableDto> editedExternalVariables = surveyUnitDto.getExternalVariables().stream().filter(
-                variableDto -> !variableDto.getVariableStateDtoList().stream().filter(
-                        variableStateDto -> variableStateDto.getState().equals(DataState.EDITED)
-                ).toList().isEmpty()
-        ).toList();
-
-        //Error 400 bad request if no edited variable in list
-        if(editedCollectedVariables.isEmpty() && editedExternalVariables.isEmpty()){
-            throw new GenesisException(400, "No EDITED variable in list");
+        List<DataState> statesReceived = surveyUnitInputDto.getCollectedVariables().stream()
+                .map(colVar -> colVar.getVariableStateInputDto().getState())
+                .distinct()
+                .toList();
+
+        if (statesReceived.contains(DataState.COLLECTED)){
+            throw new GenesisException(400,"You can not persist in database a new value with the state COLLECTED");
         }
 
-        //Collected variables management
-        for(VariableDto editedVariableDto : editedCollectedVariables){
-            CollectedVariable collectedVariable = CollectedVariable.collectedVariableBuilder()
-                    .idVar(editedVariableDto.getVariableName())
-                    .values(new ArrayList<>())
-                    .idParent(LoopIdentifier.getRelatedVariableName(editedVariableDto.getVariableName(), variablesMap))
-                    .idLoop(editedVariableDto.getIdLoop())
+        List<SurveyUnitModel> surveyUnitModels = new ArrayList<>();
+
+        for (DataState state : statesReceived){
+            SurveyUnitModel surveyUnitModel = SurveyUnitModel.builder()
+                    .idCampaign(surveyUnitInputDto.getCampaignId())
+                    .mode(surveyUnitInputDto.getMode())
+                    .idQuest(surveyUnitInputDto.getIdQuestionnaire())
+                    .idUE(surveyUnitInputDto.getSurveyUnitId())
+                    .state(state)
+                    .recordDate(LocalDateTime.now())
+                    .collectedVariables(new ArrayList<>())
+                    .externalVariables(new ArrayList<>())
+                    .modifiedBy(userIdentifier)
                     .build();
 
+            //Keep only variable dtos who has the corresponding state
+            List<VariableInputDto> editedCollectedVariables = surveyUnitInputDto.getCollectedVariables().stream()
+                    .filter(colVar -> colVar.getVariableStateInputDto().getState() == state).toList();
+
+            //Collected variables management
+            for(VariableInputDto editedVariableDto : editedCollectedVariables){
+                CollectedVariable collectedVariable = CollectedVariable.collectedVariableBuilder()
+                        .idVar(editedVariableDto.getVariableName())
+                        .values(new ArrayList<>())
+                        .idParent(LoopIdentifier.getRelatedVariableName(editedVariableDto.getVariableName(), variablesMap))
+                        .idLoop(editedVariableDto.getIdLoop())
+                        .build();
 
+                collectedVariable.getValues().add(editedVariableDto.getVariableStateInputDto().getValue());
 
-            collectedVariable.getValues().add(editedVariableDto.getVariableStateDtoList().stream().filter(variableStateDto ->
-                    variableStateDto.getState().equals(DataState.EDITED)).toList().getFirst().getValue());
-
-            surveyUnitModel.getCollectedVariables().add(collectedVariable);
-        }
-
-        //External variables management
-        for(VariableDto editedVariableDto : editedExternalVariables){
-            Variable externalVariable = Variable.builder()
-                    .idVar(editedVariableDto.getVariableName())
-                    .values(new ArrayList<>())
-                    .build();
-
-            externalVariable.getValues().add(editedVariableDto.getVariableStateDtoList().stream().filter(variableStateDto ->
-                    variableStateDto.getState().equals(DataState.EDITED)).toList().getFirst().getValue());
+                surveyUnitModel.getCollectedVariables().add(collectedVariable);
 
-            surveyUnitModel.getExternalVariables().add(externalVariable);
+            }
+            surveyUnitModels.add(surveyUnitModel);
         }
 
-        return surveyUnitModel;
+        return surveyUnitModels;
     }
 
     //Utils
diff --git a/src/test/java/fr/insee/genesis/controller/rest/responses/ResponseControllerTest.java b/src/test/java/fr/insee/genesis/controller/rest/responses/ResponseControllerTest.java
