feat: merge into main

.github/workflows/create-snapshot.yml

@@ -1,10 +1,8 @@
 name: Build release candidate
 
 on:
-  push:
-    branches:
-      - v4-develop #temp branch
-      - develop
+  workflow_dispatch:
+    branches: [ develop ]
 
 jobs:
   check-version:

.github/workflows/sonar.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - v4-develop #temp branch
       - develop
   pull_request:
     types: [opened, synchronize, reopened]

.mvn/wrapper/maven-wrapper.properties

@@ -16,4 +16,4 @@
 # under the License.
 wrapperVersion=3.3.2
 distributionType=only-script
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.7/apache-maven-3.9.7-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.7/apache-maven-3.9.7-bin.zip

pom.xml

@@ -10,7 +10,7 @@
     <description>Modules for queen back-office</description>
 
     <properties>
-        <revision>4.2.7</revision>
+        <revision>4.3.12</revision>
         <changelist></changelist>
         <java.version>21</java.version>
         <maven.compiler.source>21</maven.compiler.source>
@@ -30,7 +30,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.3.0</version>
+        <version>3.3.1</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
 

queen-application/pom.xml

@@ -8,7 +8,7 @@
 		<version>${revision}${changelist}</version>
 	</parent>
 	<artifactId>queen-application</artifactId>
-	<name>queen-application</name>
+	<name>queen-api</name>
 	<description>API for Queen/Stromae</description>
 
 	<properties>

queen-application/src/main/java/fr/insee/queen/application/campaign/component/MetadataComponentConverter.java

@@ -0,0 +1,121 @@
+package fr.insee.queen.application.campaign.component;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import fr.insee.queen.application.surveyunit.dto.output.*;
+import fr.insee.queen.domain.surveyunit.service.exception.MetadataValueNotFoundException;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+@Component
+@RequiredArgsConstructor
+public class MetadataComponentConverter implements MetadataConverter {
+    public static final String METADATA_CONTEXT = "inseeContext";
+    public static final String METADATA_OBJECTIVES = "Enq_ObjectifsCourts";
+    public static final String METADATA_LABEL = "Enq_LibelleEnquete";
+    public static final String METADATA_VARIABLES = "variables";
+    public static final String METADATA_VARIABLE_NAME = "name";
+    public static final String METADATA_VARIABLE_VALUE = "value";
+    public static final String METADATA_LOGOS = "logos";
+    public static final String METADATA_LOGO_LABEL = "label";
+    public static final String METADATA_LOGO_URL = "url";
+
+    private final ObjectMapper mapper;
+
+    public MetadataDto convert(ObjectNode metadataNode) {
+        QuestionnaireContextDto context = extractMetadataContext(metadataNode);
+
+        JsonNode metadataVariablesNode = metadataNode.get(METADATA_VARIABLES);
+        if(metadataVariablesNode == null || !metadataVariablesNode.isArray()) {
+            throw new MetadataValueNotFoundException(METADATA_VARIABLES);
+        }
+        String shortObjectives = extractMetadataVariable(metadataVariablesNode, METADATA_OBJECTIVES);
+        String shortLabel = extractMetadataVariable(metadataVariablesNode, METADATA_LABEL);
+        List<MetadataVariableDto> variables = getVariables((ArrayNode)metadataVariablesNode);
+        LogoDtos logos = null;
+
+        JsonNode metadataLogosNode = metadataNode.get(METADATA_LOGOS);
+        if(metadataLogosNode != null && metadataLogosNode.isArray()) {
+            logos = getLogos((ArrayNode)metadataLogosNode);
+        }
+        return new MetadataDto(variables, logos, context, shortLabel, shortObjectives);
+    }
+
+    private List<MetadataVariableDto> getVariables(ArrayNode variablesNode) {
+        List<MetadataVariableDto> variables = new ArrayList<>();
+        Iterator<JsonNode> iteratorVariables = variablesNode.elements();
+        while(iteratorVariables.hasNext()) {
+            JsonNode variableNode = iteratorVariables.next();
+            JsonNode nameNode = variableNode.get(METADATA_VARIABLE_NAME);
+            if(METADATA_OBJECTIVES.equals(nameNode.textValue()) || METADATA_LABEL.equals(nameNode.textValue())) {
+                continue;
+            }
+            JsonNode valueNode = variableNode.get(METADATA_VARIABLE_VALUE);
+            variables.add(new MetadataVariableDto(nameNode.textValue(), mapper.convertValue(valueNode, Object.class)));
+        }
+        return variables;
+    }
+
+    private LogoDtos getLogos(ArrayNode metadataLogosNode) {
+        LogoDto mainLogo = null;
+        List<LogoDto> secondaryLogos = new ArrayList<>();
+        Iterator<JsonNode> iteratorMetadataLogosNode = metadataLogosNode.elements();
+
+        while(iteratorMetadataLogosNode.hasNext()) {
+            JsonNode variableNode = iteratorMetadataLogosNode.next();
+            JsonNode urlNode = variableNode.get(METADATA_LOGO_URL);
+            JsonNode labelNode = variableNode.get(METADATA_LOGO_LABEL);
+            LogoDto logo = new LogoDto(urlNode.textValue(), labelNode.textValue());
+            if(mainLogo == null) {
+                mainLogo = logo;
+                continue;
+            }
+            secondaryLogos.add(logo);
+        }
+        if(mainLogo == null) {
+            return null;
+        }
+
+        if(secondaryLogos.isEmpty()) {
+            return LogoDtos.createWithMainLogoOnly(mainLogo);
+        }
+        return LogoDtos.create(mainLogo, secondaryLogos);
+    }
+
+    private QuestionnaireContextDto extractMetadataContext(ObjectNode metadata) {
+        JsonNode metadataValue = metadata.get(METADATA_CONTEXT);
+
+        if(metadataValue == null || !metadataValue.isTextual()) {
+            throw new MetadataValueNotFoundException(METADATA_CONTEXT);
+        }
+        return QuestionnaireContextDto.getQuestionnaireContext(metadataValue.textValue());
+    }
+
+    private String extractMetadataVariable(JsonNode metadataVariables, String metadataKey) {
+        Iterator<JsonNode> iteratorVariables = metadataVariables.elements();
+        while(iteratorVariables.hasNext()) {
+            JsonNode variable = iteratorVariables.next();
+
+            if(! variable.isObject()) {
+                throw new MetadataValueNotFoundException(metadataKey);
+            }
+            JsonNode name = variable.get(METADATA_VARIABLE_NAME);
+            if(!metadataKey.equals(name.textValue())) {
+                continue;
+            }
+
+            JsonNode value = variable.get(METADATA_VARIABLE_VALUE);
+            if(!value.isTextual()) {
+                throw new MetadataValueNotFoundException(metadataKey);
+            }
+            return value.textValue();
+        }
+        throw new MetadataValueNotFoundException(metadataKey);
+    }
+}

queen-application/src/main/java/fr/insee/queen/application/campaign/component/MetadataConverter.java

@@ -0,0 +1,8 @@
+package fr.insee.queen.application.campaign.component;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import fr.insee.queen.application.surveyunit.dto.output.*;
+
+public interface MetadataConverter {
+    MetadataDto convert(ObjectNode metadataNode);
+}

queen-application/src/main/java/fr/insee/queen/application/campaign/controller/CampaignController.java

@@ -1,6 +1,7 @@
 package fr.insee.queen.application.campaign.controller;
 
 import fr.insee.queen.application.campaign.dto.input.CampaignCreationData;
+import fr.insee.queen.application.campaign.dto.input.CampaignCreationDataV2;
 import fr.insee.queen.application.campaign.dto.output.CampaignSummaryDto;
 import fr.insee.queen.application.configuration.auth.AuthorityPrivileges;
 import fr.insee.queen.application.pilotage.controller.PilotageComponent;
@@ -47,10 +48,12 @@ public List<CampaignSummaryDto> getListCampaign() {
     }
 
     /**
+     * @deprecated
      * Create a new campaign
      *
      * @param campaignInputDto the value to create
      */
+    @Deprecated(since = "4.3.0")
     @Operation(summary = "Create a campaign")
     @PostMapping(path = "/campaigns")
     @PreAuthorize(AuthorityPrivileges.HAS_ADMIN_PRIVILEGES)
@@ -59,6 +62,19 @@ public void createCampaign(@Valid @RequestBody CampaignCreationData campaignInpu
         campaignService.createCampaign(CampaignCreationData.toModel(campaignInputDto));
     }
 
+    /**
+     * Create a new campaign
+     *
+     * @param campaignInputDto the value to create
+     */
+    @Operation(summary = "Create a campaign")
+    @PostMapping(path = "/campaign")
+    @PreAuthorize(AuthorityPrivileges.HAS_ADMIN_PRIVILEGES)
+    @ResponseStatus(HttpStatus.CREATED)
+    public void createCampaignV2(@Valid @RequestBody CampaignCreationDataV2 campaignInputDto) {
+        campaignService.createCampaign(CampaignCreationDataV2.toModel(campaignInputDto));
+    }
+
     /**
      * Delete a campaign. The deletion is processed in two cases:
      * - the campaign is closed (check on pilotage api)

queen-application/src/main/java/fr/insee/queen/application/campaign/controller/MetadataController.java

@@ -1,9 +1,14 @@
 package fr.insee.queen.application.campaign.controller;
 
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import fr.insee.queen.application.configuration.auth.AuthorityPrivileges;
 import fr.insee.queen.application.web.validation.IdValid;
+import fr.insee.queen.application.web.validation.json.SchemaType;
 import fr.insee.queen.domain.campaign.service.MetadataService;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -36,7 +41,8 @@ public class MetadataController {
     @Operation(summary = "Get metadata for a campaign ")
     @GetMapping(path = "/campaign/{id}/metadata")
     @PreAuthorize(AuthorityPrivileges.HAS_USER_PRIVILEGES)
-    public String getMetadataByCampaignId(@IdValid @PathVariable(value = "id") String campaignId) {
+    @ApiResponse(responseCode = "200", content = {@Content(mediaType = "application/json", schema = @Schema(ref = SchemaType.Names.METADATA))})
+    public ObjectNode getMetadataByCampaignId(@IdValid @PathVariable(value = "id") String campaignId) {
         return metadataService.getMetadata(campaignId);
     }
 
@@ -49,7 +55,8 @@ public String getMetadataByCampaignId(@IdValid @PathVariable(value = "id") Strin
     @Operation(summary = "Get metadata for a questionnaire ")
     @GetMapping(path = "/questionnaire/{id}/metadata")
     @PreAuthorize(AuthorityPrivileges.HAS_USER_PRIVILEGES)
-    public String getMetadataByQuestionnaireId(@IdValid @PathVariable(value = "id") String questionnaireId) {
+    @ApiResponse(responseCode = "200", content = {@Content(mediaType = "application/json", schema = @Schema(ref = SchemaType.Names.METADATA))})
+    public ObjectNode getMetadataByQuestionnaireId(@IdValid @PathVariable(value = "id") String questionnaireId) {
         return metadataService.getMetadataByQuestionnaireId(questionnaireId);
     }
 }

queen-application/src/main/java/fr/insee/queen/application/campaign/controller/NomenclatureController.java

@@ -1,10 +1,15 @@
 package fr.insee.queen.application.campaign.controller;
 
+import com.fasterxml.jackson.databind.node.ArrayNode;
 import fr.insee.queen.application.campaign.dto.input.NomenclatureCreationData;
 import fr.insee.queen.application.configuration.auth.AuthorityPrivileges;
 import fr.insee.queen.application.web.validation.IdValid;
+import fr.insee.queen.application.web.validation.json.SchemaType;
 import fr.insee.queen.domain.campaign.service.NomenclatureService;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.AllArgsConstructor;
@@ -36,7 +41,7 @@ public class NomenclatureController {
      */
     @Operation(summary = "Get all nomenclatures Ids ")
     @GetMapping(path = "/nomenclatures")
-    @PreAuthorize(AuthorityPrivileges.HAS_MANAGEMENT_PRIVILEGES)
+    @PreAuthorize(AuthorityPrivileges.HAS_REVIEWER_PRIVILEGES)
     public List<String> getNomenclaturesId() {
         return nomenclatureService.getAllNomenclatureIds();
     }
@@ -46,14 +51,14 @@ public List<String> getNomenclaturesId() {
      * Retrieve a nomenclature
      *
      * @param nomenclatureId the id of nomenclature
-     * @return {@link String} the nomenclature in json format
+     * @return {@link ArrayNode} the nomenclature in json format
      */
     @Operation(summary = "Get Nomenclature")
     @GetMapping(path = "/nomenclature/{id}")
     @PreAuthorize(AuthorityPrivileges.HAS_USER_PRIVILEGES)
-    public String getNomenclatureById(@IdValid @PathVariable(value = "id") String nomenclatureId) {
+    @ApiResponse(responseCode = "200", content = {@Content(mediaType = "application/json", schema = @Schema(ref = SchemaType.Names.NOMENCLATURE))})
+    public ArrayNode getNomenclatureById(@IdValid @PathVariable(value = "id") String nomenclatureId) {
         return nomenclatureService.getNomenclature(nomenclatureId).value();
-
     }
 
     /**

queen-application/src/main/java/fr/insee/queen/application/campaign/controller/QuestionnaireModelController.java

@@ -1,5 +1,6 @@
 package fr.insee.queen.application.campaign.controller;
 
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import fr.insee.queen.application.campaign.dto.input.QuestionnaireModelCreationData;
 import fr.insee.queen.application.campaign.dto.output.QuestionnaireModelIdDto;
 import fr.insee.queen.application.campaign.dto.output.QuestionnaireModelValueDto;
@@ -45,7 +46,7 @@ public class QuestionnaireModelController {
      */
     @Operation(summary = "Get questionnaire list for a campaign ")
     @GetMapping(path = "/campaign/{id}/questionnaires")
-    @PreAuthorize(AuthorityPrivileges.HAS_MANAGEMENT_PRIVILEGES)
+    @PreAuthorize(AuthorityPrivileges.HAS_REVIEWER_PRIVILEGES)
     public List<QuestionnaireModelValueDto> getQuestionnaireDatasByCampaignId(
             @IdValid @PathVariable(value = "id") String campaignId) {
         return questionnaireModelService
@@ -55,6 +56,7 @@ public List<QuestionnaireModelValueDto> getQuestionnaireDatasByCampaignId(
     }
 
     /**
+     * @deprecated
      * Retrieve the data structure of a questionnaire
      *
      * @param questionnaireModelId the id of questionnaire
@@ -63,8 +65,22 @@ public List<QuestionnaireModelValueDto> getQuestionnaireDatasByCampaignId(
     @Operation(summary = "Get questionnnaire")
     @GetMapping(path = "/questionnaire/{id}")
     @PreAuthorize(AuthorityPrivileges.HAS_USER_PRIVILEGES)
-    public QuestionnaireModelValueDto getQuestionnaireData(@IdValid @PathVariable(value = "id") String questionnaireModelId) {
-        return new QuestionnaireModelValueDto(questionnaireModelService.getQuestionnaireData(questionnaireModelId));
+    @Deprecated(since = "4.2.12")
+    public QuestionnaireModelValueDto getQuestionnaireValue(@IdValid @PathVariable(value = "id") String questionnaireModelId) {
+        return new QuestionnaireModelValueDto(getQuestionnaireData(questionnaireModelId));
+    }
+
+    /**
+     * Retrieve the data structure of a questionnaire
+     *
+     * @param questionnaireModelId the id of questionnaire
+     * @return the data linked to the questionnaire
+     */
+    @Operation(summary = "Get questionnnaire data")
+    @GetMapping(path = "/questionnaire/{id}/data")
+    @PreAuthorize(AuthorityPrivileges.HAS_USER_PRIVILEGES)
+    public ObjectNode getQuestionnaireData(@IdValid @PathVariable(value = "id") String questionnaireModelId) {
+        return questionnaireModelService.getQuestionnaireData(questionnaireModelId);
     }
 
     /**
@@ -75,7 +91,7 @@ public QuestionnaireModelValueDto getQuestionnaireData(@IdValid @PathVariable(va
      */
     @Operation(summary = "Get list of questionnaire ids for a campaign")
     @GetMapping(path = "/campaign/{id}/questionnaire-id")
-    @PreAuthorize(AuthorityPrivileges.HAS_MANAGEMENT_PRIVILEGES)
+    @PreAuthorize(AuthorityPrivileges.HAS_REVIEWER_PRIVILEGES)
     public List<QuestionnaireModelIdDto> getQuestionnaireIdsByCampaignId(
             @IdValid @PathVariable(value = "id") String campaignId) {
         return questionnaireModelService
@@ -106,7 +122,7 @@ public void createQuestionnaire(@RequestBody @Valid QuestionnaireModelCreationDa
      */
     @Operation(summary = "Search questionnaire ids linked to survey units")
     @PostMapping(path = "/survey-units/questionnaire-model-id")
-    @PreAuthorize(AuthorityPrivileges.HAS_MANAGEMENT_PRIVILEGES)
+    @PreAuthorize(AuthorityPrivileges.HAS_REVIEWER_PRIVILEGES)
     public ResponseEntity<SurveyUnitOkNokDto> getQuestionnaireModelIdBySurveyUnits(
             @NotEmpty @RequestBody List<String> surveyUnitIdsToSearch) {
         List<SurveyUnitSummary> surveyUnitsFound = surveyUnitService.findSummariesByIds(surveyUnitIdsToSearch);

queen-application/src/main/java/fr/insee/queen/application/campaign/dto/input/CampaignCreationData.java

@@ -5,6 +5,7 @@
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import fr.insee.queen.application.web.validation.IdValid;
 import fr.insee.queen.domain.campaign.model.Campaign;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotEmpty;
@@ -20,6 +21,7 @@
  * @param metadata campaign metadata
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
+@Schema(name = "CampaignCreation")
 public record CampaignCreationData(
         @IdValid
         String id,
@@ -35,6 +37,6 @@ public static Campaign toModel(CampaignCreationData campaign) {
         if (campaign.metadata() != null) {
             metadataValue = campaign.metadata.value();
         }
-        return new Campaign(campaign.id, campaign.label, campaign.questionnaireIds, metadataValue.toString());
+        return new Campaign(campaign.id, campaign.label, campaign.questionnaireIds, metadataValue);
     }
 }