Merge branch 'main' into devAuth

Author: alicela

.github/workflows/maven.yml

@@ -46,7 +46,7 @@ jobs:
 
     # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
     - name: Update dependency graph
-      uses: advanced-security/maven-dependency-submission-action@4bf8a28b006c80b3063c8b2c951742d65173255a
+      uses: advanced-security/maven-dependency-submission-action@4b6fc92adc1df4c41b470e692a1688a448907248
 
     - name: Coveralls GitHub Action
       uses: coverallsapp/github-action@v2.3.6

pom.xml

@@ -32,7 +32,7 @@
         <pitest.version>1.19.3</pitest.version>
         <pitest.junit.version>1.2.2</pitest.junit.version>
         <jackson.version>2.19.0</jackson.version>
-        <bpm.version>1.0.6</bpm.version>
+        <bpm.version>1.0.7</bpm.version>
     </properties>
     <dependencies>
         <dependency>
@@ -92,7 +92,7 @@
         <dependency>
             <groupId>net.sf.saxon</groupId>
             <artifactId>Saxon-HE</artifactId>
-            <version>12.6</version>
+            <version>12.7</version>
         </dependency>
 
         <!-- JSON -->

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

@@ -11,8 +11,8 @@
 import fr.insee.genesis.controller.dto.SurveyUnitInputDto;
 import fr.insee.genesis.controller.dto.SurveyUnitQualityToolDto;
 import fr.insee.genesis.controller.dto.SurveyUnitSimplified;
-import fr.insee.genesis.controller.services.MetadataService;
 import fr.insee.genesis.controller.rest.CommonApiResponse;
+import fr.insee.genesis.controller.services.MetadataService;
 import fr.insee.genesis.controller.sources.xml.LunaticXmlCampaign;
 import fr.insee.genesis.controller.sources.xml.LunaticXmlDataParser;
 import fr.insee.genesis.controller.sources.xml.LunaticXmlDataSequentialParser;
@@ -58,6 +58,7 @@
 import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Set;
 import java.util.stream.Stream;
 
 @RequestMapping(path = "/responses" )
@@ -77,7 +78,6 @@ public class ResponseController implements CommonApiResponse {
     private final AuthUtils authUtils;
     private final MetadataService metadataService;
 
-
     public ResponseController(SurveyUnitApiPort surveyUnitService,
                               SurveyUnitQualityService surveyUnitQualityService,
                               FileUtils fileUtils,
@@ -105,7 +105,7 @@ public ResponseEntity<Object> saveResponsesFromXmlFile(@RequestParam("pathLunati
         VariablesMap variablesMap;
         if(withDDI) {
             //Parse DDI
-            log.info(String.format("Try to read DDI file : %s", metadataFilePath));
+            log.info("Try to read DDI file : {}", metadataFilePath);
             try {
                 variablesMap =
                         DDIReader.getMetadataFromDDI(Path.of(metadataFilePath).toFile().toURI().toURL().toString(),
@@ -115,12 +115,12 @@ public ResponseEntity<Object> saveResponsesFromXmlFile(@RequestParam("pathLunati
             }
         }else{
             //Parse Lunatic
-            log.info(String.format("Try to read lunatic file : %s", metadataFilePath));
+            log.info("Try to read lunatic file : {}", metadataFilePath);
 
             variablesMap = LunaticReader.getMetadataFromLunatic(new FileInputStream(metadataFilePath)).getVariables();
         }
 
-        log.info(String.format("Try to read Xml file : %s", xmlFile));
+        log.info("Try to read Xml file : {}", xmlFile);
         Path filepath = Paths.get(xmlFile);
 
         if (getFileSizeInMB(filepath) <= Constants.MAX_FILE_SIZE_UNTIL_SEQUENTIAL) {
@@ -324,9 +324,18 @@ public ResponseEntity<List<SurveyUnitSimplified>> getLatestForInterrogationList(
     public ResponseEntity<Object> saveEditedVariables(
             @RequestBody SurveyUnitInputDto surveyUnitInputDto
     ){
+        //Code quality : we need to put all that logic out of this controller
         //Parse metadata
         //Try to look for DDI first, if no DDI found looks for lunatic components
         List<GenesisError> errors = new ArrayList<>();
+        //We need to retrieve campaignId
+        Set<String> campaignIds = surveyUnitService.findCampaignIdsFrom(surveyUnitInputDto);
+        if (campaignIds.size() != 1){
+            return ResponseEntity.status(500).body("Impossible to assign one campaignId to that response");
+        }
+        // If the size is equal to 1 we get this campaignId
+        String campaignId = campaignIds.iterator().next();
+        surveyUnitInputDto.setCampaignId(campaignId);
         VariablesMap variablesMap = metadataService.readMetadatas(surveyUnitInputDto.getCampaignId(),
                 surveyUnitInputDto.getMode().getModeName(), fileUtils, errors);
         if(variablesMap == null){
@@ -373,6 +382,8 @@ public ResponseEntity<Object> saveEditedVariables(
         return ResponseEntity.ok(SUCCESS_MESSAGE);
     }
 
+
+
     //Utilities
     /**
      * Process a campaign with a specific mode
@@ -489,7 +500,6 @@ private ResponseEntity<Object> processXmlFileSequentially(Path filepath, Mode mo
 
             log.info("Saved {} survey units updates from Xml file {}", suCount,  filepath.getFileName());
         }
-
         return ResponseEntity.ok().build();
     }
 

src/main/java/fr/insee/genesis/controller/services/MetadataService.java

@@ -1,9 +1,14 @@
 package fr.insee.genesis.controller.services;
 
 import fr.insee.bpm.exceptions.MetadataParserException;
+import fr.insee.bpm.metadata.model.MetadataModel;
+import fr.insee.bpm.metadata.model.Variable;
+import fr.insee.bpm.metadata.model.VariableType;
 import fr.insee.bpm.metadata.model.VariablesMap;
 import fr.insee.bpm.metadata.reader.ddi.DDIReader;
 import fr.insee.bpm.metadata.reader.lunatic.LunaticReader;
+import fr.insee.genesis.Constants;
+import fr.insee.genesis.domain.utils.GroupUtils;
 import fr.insee.genesis.exceptions.GenesisError;
 import fr.insee.genesis.infrastructure.utils.FileUtils;
 import lombok.extern.slf4j.Slf4j;
@@ -12,6 +17,7 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.nio.file.Path;
+import java.util.Arrays;
 import java.util.List;
 @Slf4j
 @Service
@@ -31,9 +37,16 @@ public VariablesMap parseMetadata(String metadataFilePath, boolean withDDI) {
         try {
             log.info("Try to read {} file: {}", withDDI ? "DDI" : "Lunatic", metadataFilePath);
             if (withDDI) {
-                return DDIReader.getMetadataFromDDI(
+                MetadataModel metadataModel = DDIReader.getMetadataFromDDI(
                         Path.of(metadataFilePath).toFile().toURI().toURL().toString(),
-                        new FileInputStream(metadataFilePath)).getVariables();
+                        new FileInputStream(metadataFilePath));
+                // Temporary solution
+                // the logic of adding variables from lunatic to the ones present in the DDI needs to be implemented in BPM
+                // (only in Kraftwerk for the moment)
+                for (String enoVar : Constants.getEnoVariables()){
+                    metadataModel.getVariables().putVariable(new Variable(enoVar, metadataModel.getRootGroup(), VariableType.STRING));
+                }
+                return metadataModel.getVariables();
             } else {
                 return LunaticReader.getMetadataFromLunatic(
                         new FileInputStream(metadataFilePath)).getVariables();
@@ -78,6 +91,11 @@ public VariablesMap readMetadatas(String campaignName, String modeName, FileUtil
                 return null;
             }
         }
+/*        // Adding Eno variables if necessary
+        // For review : not sure if this the best way to do it
+        for (String enoVar : Arrays.stream(Constants.getEnoVariables()).toList()){
+            variablesMap.putVariable(new Variable(enoVar, ));
+        }*/
         return variablesMap;
     }
 }

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

@@ -2,12 +2,12 @@
 
 import fr.insee.bpm.metadata.model.VariablesMap;
 import fr.insee.genesis.controller.dto.CampaignWithQuestionnaire;
+import fr.insee.genesis.controller.dto.InterrogationId;
+import fr.insee.genesis.controller.dto.QuestionnaireWithCampaign;
 import fr.insee.genesis.controller.dto.SurveyUnitDto;
 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;
-import fr.insee.genesis.controller.dto.InterrogationId;
 import fr.insee.genesis.exceptions.GenesisException;
 
 import java.util.List;
@@ -57,4 +57,6 @@ List<SurveyUnitModel> parseEditedVariables(SurveyUnitInputDto surveyUnitInputDto
                                          VariablesMap variablesMap) throws GenesisException;
 
     String findQuestionnaireIdByInterrogationId(String interrogationId) throws GenesisException;
+
+    Set<String> findCampaignIdsFrom(SurveyUnitInputDto dto);
 }

src/main/java/fr/insee/genesis/domain/service/surveyunit/SurveyUnitService.java

@@ -10,9 +10,9 @@
 import fr.insee.genesis.controller.dto.VariableInputDto;
 import fr.insee.genesis.controller.dto.VariableStateDto;
 import fr.insee.genesis.domain.model.surveyunit.DataState;
-import fr.insee.genesis.domain.model.surveyunit.VarIdScopeTuple;
 import fr.insee.genesis.domain.model.surveyunit.Mode;
 import fr.insee.genesis.domain.model.surveyunit.SurveyUnitModel;
+import fr.insee.genesis.domain.model.surveyunit.VarIdScopeTuple;
 import fr.insee.genesis.domain.model.surveyunit.VariableModel;
 import fr.insee.genesis.domain.ports.api.SurveyUnitApiPort;
 import fr.insee.genesis.domain.ports.spi.SurveyUnitPersistencePort;
@@ -29,6 +29,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 @Service
@@ -315,6 +316,17 @@ public String findQuestionnaireIdByInterrogationId(String interrogationId) throw
         return questionnaireIds.iterator().next(); //Return first (and supposed only) element of set
     }
 
+    @Override
+    public Set<String> findCampaignIdsFrom(SurveyUnitInputDto dto) {
+        List<SurveyUnitModel> responses = findByIdsInterrogationAndQuestionnaire(
+                dto.getInterrogationId(),
+                dto.getQuestionnaireId()
+        );
+        return responses.stream()
+                .map(SurveyUnitModel::getCampaignId)
+                .collect(Collectors.toSet());
+    }
+
     //Utils
     private static List<Mode> getDistinctsModes(List<SurveyUnitModel> surveyUnitModels) {
         List<Mode> sources = new ArrayList<>();