feat: compute scope label in get variables (#380)

Author: chloe-renaud

src/main/java/fr/insee/pogues/service/VariableService.java

@@ -64,8 +64,28 @@ public List<VariableType> getVersionVariables(UUID versionId) throws Exception {
         return getQuestionnaireVariables(questionnaire);
     }
 
+    /**
+     * Get the questionnaire's variables and, if they have a scope, compute the scope name instead of the id.
+     * @param questionnaire Questionnaire from which we want the variables
+     * @return Questionnaire's variables with a readable scope.
+     */
     private List<VariableType> getQuestionnaireVariables(Questionnaire questionnaire) {
-        return questionnaire.getVariables().getVariable().stream().toList();
+        List<VariableType> variables = questionnaire.getVariables().getVariable().stream().toList();
+        variables.forEach(v -> computeScopeNameFromScopeId(v, questionnaire.getIterations()));
+        return variables;
+    }
+
+    /**
+     * Compute the scope name instead of the id. If no related scope is found, do nothing.
+     * @param variable Variable to update
+     * @param iterations Iterations in which we will find the scope name
+     */
+    private void computeScopeNameFromScopeId(VariableType variable, Questionnaire.Iterations iterations) {
+        String scopeId = variable.getScope();
+        if (scopeId != null) {
+            IterationType iteration = iterations.getIteration().stream().filter(v -> scopeId.equals(v.getId())).toList().getFirst();
+            if (iteration != null) variable.setScope(iteration.getName());
+        }
     }
 
     /**

src/test/java/fr/insee/pogues/service/VariableServiceTest.java

@@ -15,10 +15,12 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+import java.math.BigInteger;
 import java.util.List;
 
 import static fr.insee.pogues.utils.Utils.loadQuestionnaireFromResources;
 import static fr.insee.pogues.utils.json.JSONFunctions.jsonStringtoJsonNode;
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.*;
 
 @ExtendWith(MockitoExtension.class)
@@ -57,6 +59,36 @@ void getQuestionnaireVariables_success() throws Exception {
         assertEquals(expected.getId(), res.getFirst().getId());
     }
 
+    @Test
+    @DisplayName("Should fetch questionnaire variables and compute the scope name")
+    void getQuestionnaireVariables_success_scopeName() throws Exception {
+        // Given a questionnaire with 1 variable
+        Questionnaire mockQuestionnaire = loadQuestionnaireFromResources("service/withScope.json");
+        String mockQuestionnaireString = PoguesSerializer.questionnaireJavaToString(mockQuestionnaire);
+        JsonNode mockQuestionnaireJSON = jsonStringtoJsonNode(mockQuestionnaireString);
+        questionnaireService.createQuestionnaire(mockQuestionnaireJSON);
+
+        String questionnaireId = "ma0nzzmj";
+        String variableId = "mdy51s3x";
+
+        VariableType expected = new CollectedVariableType();
+        expected.setId(variableId);
+        expected.setName("NOMDUPOKEM");
+        expected.setLabel("NOMDUPOKEM label");
+        expected.setScope("LOOP_TEST");
+        TextDatatypeType expectedDatatype = new TextDatatypeType();
+        expectedDatatype.setTypeName(DatatypeTypeEnum.TEXT);
+        expectedDatatype.setMaxLength(BigInteger.valueOf(249));
+        expected.setDatatype(expectedDatatype);
+
+        // When we get the questionnaire's variables
+        List<VariableType> res = variableService.getQuestionnaireVariables(questionnaireId);
+
+        // Then the variable is fetched
+        VariableType variable = res.stream().filter(v -> variableId.equals(v.getId())).toList().getFirst();
+        assertThat(variable).usingRecursiveComparison().isEqualTo(expected);
+    }
+
     @Test
     @DisplayName("Should trigger an error when we try to fetch variables from a questionnaire that does not exist")
     void getQuestionnaireVariables_error_questionnaireNotFound() {