refactor: dates validation and formatting

build.gradle.kts

@@ -16,7 +16,7 @@ java {
 
 allprojects {
     group = "fr.insee.eno"
-    version = "3.30.1-SNAPSHOT.1"
+    version = "3.30.1-SNAPSHOT.2"
 }
 
 subprojects {

eno-core/src/main/java/fr/insee/eno/core/exceptions/business/InvalidValueException.java

@@ -0,0 +1,9 @@
+package fr.insee.eno.core.exceptions.business;
+
+public class InvalidValueException extends RuntimeException {
+
+    public  InvalidValueException(String message) {
+        super(message);
+    }
+
+}

eno-core/src/main/java/fr/insee/eno/core/exceptions/business/RequiredPropertyException.java

@@ -0,0 +1,9 @@
+package fr.insee.eno.core.exceptions.business;
+
+public class RequiredPropertyException extends RuntimeException {
+
+    public  RequiredPropertyException(String message) {
+        super(message);
+    }
+
+}

eno-core/src/main/java/fr/insee/eno/core/i18n/date/DateFormatter.java

@@ -0,0 +1,46 @@
+package fr.insee.eno.core.i18n.date;
+
+import lombok.Getter;
+import lombok.NonNull;
+
+/**
+ * Interface to validate and format dates.
+ */
+public interface DateFormatter {
+
+    @Getter
+    class Result {
+        private final boolean valid;
+        private final String value;
+        private final String errorMessage;
+
+        private Result(boolean valid, String value, String errorMessage) {
+            this.valid = valid;
+            this.value = value;
+            this.errorMessage = errorMessage;
+        }
+
+        public static Result success(String value) {
+            return new Result(true, value, null);
+        }
+
+        public static Result failure(String errorMessage) {
+            return new Result(false, null, errorMessage);
+        }
+    }
+
+    default Result convertYearDate(@NonNull String date) {
+        if (date.length() != 4 || !date.matches("\\d{4}"))
+            return Result.failure(errorMessage(date, "YYYY"));
+        return Result.success(date);
+    }
+
+    Result convertYearMontDate(@NonNull String date);
+
+    Result convertYearMontDayDate(@NonNull String date);
+
+    default String errorMessage(String date, String format) {
+        return "Date '" + date + "' is invalid or doesn't match format '" + format + "'.";
+    }
+
+}

eno-core/src/main/java/fr/insee/eno/core/i18n/date/DateFormatterFactory.java

@@ -0,0 +1,16 @@
+package fr.insee.eno.core.i18n.date;
+
+import fr.insee.eno.core.parameter.EnoParameters;
+
+public class DateFormatterFactory {
+
+    private DateFormatterFactory() {}
+
+    public static DateFormatter forLanguage(EnoParameters.Language language) {
+        if (EnoParameters.Language.FR.equals(language))
+            return new Iso8601ToFrench();
+        // By default, return the implementation that returns date values in ISO-8601 format
+        return new Iso8601Formatter();
+    }
+
+}

eno-core/src/main/java/fr/insee/eno/core/i18n/date/Iso8601Formatter.java

@@ -0,0 +1,29 @@
+package fr.insee.eno.core.i18n.date;
+
+import lombok.NonNull;
+
+import java.time.LocalDate;
+import java.time.YearMonth;
+import java.time.format.DateTimeFormatter;
+
+public class Iso8601Formatter implements DateFormatter {
+
+    public Result convertYearMontDate(@NonNull String date) {
+        try {
+            return Result.success(
+                    YearMonth.parse(date).format(DateTimeFormatter.ofPattern("yyyy-MM")));
+        } catch (Exception e) {
+            return Result.failure(errorMessage(date, "YYYY-MM"));
+        }
+    }
+
+    public Result convertYearMontDayDate(@NonNull String date) {
+        try {
+            return Result.success(
+                    LocalDate.parse(date).format(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
+        } catch (Exception e) {
+            return Result.failure(errorMessage(date, "YYYY-MM-DD"));
+        }
+    }
+
+}

eno-core/src/main/java/fr/insee/eno/core/i18n/date/Iso8601ToFrench.java

@@ -0,0 +1,29 @@
+package fr.insee.eno.core.i18n.date;
+
+import lombok.NonNull;
+
+import java.time.LocalDate;
+import java.time.YearMonth;
+import java.time.format.DateTimeFormatter;
+
+public class Iso8601ToFrench implements DateFormatter {
+
+    public Result convertYearMontDate(@NonNull String date) {
+        try {
+            return Result.success(
+                    YearMonth.parse(date).format(DateTimeFormatter.ofPattern("MM/yyyy")));
+        } catch (Exception e) {
+            return Result.failure(errorMessage(date, "YYYY-MM"));
+        }
+    }
+
+    public Result convertYearMontDayDate(@NonNull String date) {
+        try {
+            return Result.success(
+                    LocalDate.parse(date).format(DateTimeFormatter.ofPattern("dd/MM/yyyy")));
+        } catch (Exception e) {
+            return Result.failure(errorMessage(date, "YYYY-MM-DD"));
+        }
+    }
+
+}

eno-core/src/main/java/fr/insee/eno/core/model/question/DateQuestion.java

@@ -20,6 +20,10 @@
 @Context(format = Format.LUNATIC, type = Datepicker.class)
 public class DateQuestion extends SingleResponseQuestion {
 
+    public static final String YEAR_FORMAT = "YYYY";
+    public static final String YEAR_MONTH_FORMAT = "YYYY-MM";
+    public static final String YEAR_MONTH_DAY_FORMAT = "YYYY-MM-DD";
+
     /**
      * Minimum date value allowed.
      */

eno-core/src/main/java/fr/insee/eno/core/processing/out/steps/lunatic/LunaticAddControlFormat.java

@@ -1,15 +1,18 @@
 package fr.insee.eno.core.processing.out.steps.lunatic;
 
+import fr.insee.eno.core.exceptions.business.InvalidValueException;
+import fr.insee.eno.core.exceptions.business.RequiredPropertyException;
+import fr.insee.eno.core.i18n.date.DateFormatter;
+import fr.insee.eno.core.i18n.date.DateFormatterFactory;
+import fr.insee.eno.core.model.question.DateQuestion;
+import fr.insee.eno.core.parameter.EnoParameters;
 import fr.insee.eno.core.processing.ProcessingStep;
 import fr.insee.lunatic.model.flat.*;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import lombok.NonNull;
 import lombok.extern.slf4j.Slf4j;
+
 import java.math.BigDecimal;
 import java.math.RoundingMode;
-import java.time.LocalDate;
-import java.time.YearMonth;
-import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
@@ -21,6 +24,18 @@
  */
 @Slf4j
 public class LunaticAddControlFormat implements ProcessingStep<Questionnaire> {
+
+    private final DateFormatter dateFormatter;
+
+    /** Using french as default value for date formatting. */
+    public LunaticAddControlFormat() {
+        dateFormatter = DateFormatterFactory.forLanguage(EnoParameters.Language.FR);
+    }
+
+    public LunaticAddControlFormat(EnoParameters.Language language) {
+        dateFormatter = DateFormatterFactory.forLanguage(language);
+    }
+
     /**
      *
      * @param lunaticQuestionnaire lunatic questionnaire to be processed.
@@ -94,6 +109,8 @@ private List<ControlType> getFormatControlsForBodyCells(List<BodyCell> bodyCells
         return controls;
     }
 
+    // TODO: internationalization of the generated messages
+
     /**
      * Create controls for a input number component
      * @param number input number to process
@@ -162,26 +179,15 @@ private void createFormatControlsForDatepicker(Datepicker datepicker) {
         // of the first control is displayed.
     }
 
-    private static final Logger logger = LoggerFactory.getLogger(LunaticAddControlFormat.class);
-
-    String formatDateToFrench(String date) {
-
-        if (date == null || date.isEmpty()) {
-            logger.warn("Date nulle ou vide reçue. Elle sera ignorée.");
-            return null;
-        }
-        if (date.matches("\\d{4}")) {
-            return date;
-        } else if (date.matches("\\d{4}-\\d{2}")) {
-            YearMonth parsedDate = YearMonth.parse(date);
-            return parsedDate.format(DateTimeFormatter.ofPattern("MM-yyyy"));
-        } else if (date.matches("\\d{4}-\\d{2}-\\d{2}")) {
-            LocalDate parsedDate = LocalDate.parse(date);
-            return parsedDate.format(DateTimeFormatter.ofPattern("dd-MM-yyyy"));
-        } else {
-            logger.warn("Format de date non pris en charge. Attendu : AAAA, AAAA-MM, ou AAAA-MM-JJ. Reçu : {}. La date sera ignorée.", date);
-            return null;
-        }
+    private DateFormatter.Result validateAndConvertDate(String date, @NonNull String format) {
+        if (date == null)
+            return null; // The min/max date properties can eventually be null (not 'required' in Pogues)
+        return switch (format) {
+            case DateQuestion.YEAR_MONTH_DAY_FORMAT -> dateFormatter.convertYearMontDayDate(date);
+            case DateQuestion.YEAR_MONTH_FORMAT -> dateFormatter.convertYearMontDate(date);
+            case DateQuestion.YEAR_FORMAT -> dateFormatter.convertYearDate(date);
+            default -> throw new InvalidValueException("Date format '" + format + "' is invalid.");
+        };
     }
 
     /**
@@ -192,20 +198,28 @@ String formatDateToFrench(String date) {
      * @param format format string
      * @param responseName date picker response attribute
      */
+    private Optional<ControlType> getFormatControlFromDatepickerAttributes(String id, String minValue, String maxValue, String format, String responseName) {
+        if (format == null)
+            throw new RequiredPropertyException("Format is missing in date question '" + id + "'");
 
-    Optional<ControlType> getFormatControlFromDatepickerAttributes(String id, String minValue, String maxValue, String format, String responseName) {
         String controlIdPrefix = id + "-format-date";
 
-        String formattedMinValue = minValue != null ? formatDateToFrench(minValue) : null;
-        String formattedMaxValue = maxValue != null ? formatDateToFrench(maxValue) : null;
-
-        if (minValue == null && maxValue == null) {
-            logger.warn("Aucune contrainte de date définie pour l'id : {}.", id);
-            return Optional.empty();
+        DateFormatter.Result formattedMinValue = validateAndConvertDate(minValue, format);
+        if (formattedMinValue != null && !formattedMinValue.isValid()) {
+            String message = "Invalid value for min date of question '" + id + "': " + formattedMinValue.getErrorMessage();
+            log.error(message);
+            throw new InvalidValueException(message);
+        }
+        DateFormatter.Result formattedMaxValue = validateAndConvertDate(maxValue, format);
+        if (formattedMaxValue != null && !formattedMaxValue.isValid()) {
+            // Due to a bug in the Pogues -> DDI transformation, an invalid max date doesn't throw an exception for now
+            log.warn("Invalid value for max date of question '" + id + "': " + maxValue);
         }
 
-        if (minValue != null && maxValue != null) {
+        boolean generateMin = formattedMinValue != null && formattedMinValue.isValid();
+        boolean generateMax = formattedMaxValue != null && formattedMaxValue.isValid();
 
+        if (generateMin && generateMax) {
             String controlExpression = String.format(
                     "not(not(isnull(%s)) and " +
                             "(cast(%s, date, \"%s\")<cast(\"%s\", date, \"%s\") or " +
@@ -214,31 +228,31 @@ Optional<ControlType> getFormatControlFromDatepickerAttributes(String id, String
             );
             String controlErrorMessage = String.format(
                     "\"La date saisie doit être comprise entre %s et %s.\"",
-                    formattedMinValue, formattedMaxValue
+                    formattedMinValue.getValue(), formattedMaxValue.getValue()
             );
             return Optional.of(createFormatControl(controlIdPrefix + "-borne-inf-sup", controlExpression, controlErrorMessage));
         }
 
-        if (minValue == null && maxValue != null) {
+        if (generateMax) {
             String controlExpression = String.format(
                     "not(not(isnull(%s)) and (cast(%s, date, \"%s\")>cast(\"%s\", date, \"%s\")))",
                     responseName, responseName, format, maxValue, format
             );
             String controlErrorMessage = String.format(
                     "\"La date saisie doit être antérieure à %s.\"",
-                    formattedMaxValue
+                    formattedMaxValue.getValue()
             );
             return Optional.of(createFormatControl(controlIdPrefix + "-borne-sup", controlExpression, controlErrorMessage));
         }
 
-        if (minValue != null && maxValue == null) {
+        if (generateMin) {
             String controlExpression = String.format(
                     "not(not(isnull(%s)) and (cast(%s, date, \"%s\")<cast(\"%s\", date, \"%s\")))",
                     responseName, responseName, format, minValue, format
             );
             String controlErrorMessage = String.format(
                     "\"La date saisie doit être postérieure à %s.\"",
-                    formattedMinValue
+                    formattedMinValue.getValue()
             );
             return Optional.of(createFormatControl(controlIdPrefix + "-borne-inf", controlExpression, controlErrorMessage));
         }