Merge pull request #603 from ansforge/feat/dispatcher/migrate-to-client-config-map

[ Dispatcher] Refacto : migration des maps de configuration vers un objet de configuration client

Author: bou3108

hub/dispatcher/src/main/java/com/hubsante/hub/config/Constants.java

@@ -34,6 +34,7 @@ public class Constants {
     public static final String DISPATCHED_MESSAGE = "dispatch.message";
     public static final String USE_CASE_TAG = "use_case";
     public static final String UNKNOWN = "unknown";
+    public static final boolean DEFAULT_DIRECT_CISU_PREFERENCE = false;
     public static final String FR_HEALTH_PREFIX = "fr.health";
     public static final String FR_FIRE_PREFIX = "fr.fire";
     public static final String FR_CISU_PREFIX = "fr.cisu";

hub/dispatcher/src/main/java/com/hubsante/hub/config/HubConfiguration.java

@@ -15,24 +15,17 @@
  */
 package com.hubsante.hub.config;
 
+import com.hubsante.hub.service.ClientPropertiesRegistry;
 import com.hubsante.model.EdxlHandler;
 import com.hubsante.model.Validator;
-import com.univocity.parsers.common.ParsingContext;
-import com.univocity.parsers.common.processor.ObjectRowProcessor;
-import com.univocity.parsers.csv.CsvParser;
-import com.univocity.parsers.csv.CsvParserSettings;
 import io.micrometer.core.aop.TimedAspect;
 import io.micrometer.core.instrument.MeterRegistry;
 import jakarta.annotation.PostConstruct;
 import java.io.*;
 import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
 import java.util.*;
-import java.util.stream.Collectors;
 import lombok.extern.slf4j.Slf4j;
-import org.apache.commons.csv.CSVFormat;
-import org.apache.commons.csv.CSVParser;
-import org.apache.commons.csv.CSVRecord;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -42,16 +35,8 @@
 @Configuration
 public class HubConfiguration {
 
-    private static final int ROW_LENGTH = 11;
     private static final String DATA_DIVIDER = ",";
     private static final String COLUMN_DIVIDER = ";";
-    private static final String CLIENT_ID_HEADER = "client_id";
-    private static final String INHIBITED_USE_CASES_HEADER = "inhibited_use_cases";
-
-    private static final StructuredLogger structuredLog = new StructuredLogger(log);
-
-    @Value("${client.preferences.file}")
-    private File configFile;
 
     @Value("${supported.messages.file}")
     private File supportedMessagesFile;
@@ -64,110 +49,19 @@ public class HubConfiguration {
     @Value("${spring.rabbitmq.virtual-host}")
     private String vhost;
 
-    private HashMap<String, Boolean> useXmlPreferences = new HashMap<>();
-    private HashMap<String, Boolean> directCisuPreferences = new HashMap<>();
-    private HashMap<String, String> clientsEditorMap = new HashMap<>();
-    private Map<String, Map<String, String>> clientsPerimeterAndVersions = new HashMap<>();
-    private Map<String, List<String>> clientsInhibitedMessages = new HashMap<>();
+    @Autowired private ClientPropertiesRegistry clientPropertiesRegistry;
+
     private List<String> supportedMessages;
 
     @PostConstruct
     public void init() throws Exception {
+        // We first get the parameterized default message TTL
+        defaultTTL = Long.parseLong(this.ttlProperty);
 
-        try {
-            // We first get the parameterized default message TTL
-            defaultTTL = Long.parseLong(this.ttlProperty);
-
-            // We explicitly set the Locale to ensure cross platform consistency
-            Locale.setDefault(Locale.ENGLISH);
-
-            // We define a custom row processor to read the config file
-            // we override the rowProcessed method on the fly to store the config in a HashMap
-            // then we define the parser settings and parse the file
-            ObjectRowProcessor clientPreferencesRowProcessor =
-                    new ObjectRowProcessor() {
-                        @Override
-                        public void rowProcessed(Object[] objects, ParsingContext parsingContext) {
-                            if (objects.length != ROW_LENGTH) {
-                                log.warn(
-                                        "There were more than {} columns in the client preferences file, extra columns are being ignored",
-                                        ROW_LENGTH);
-                            }
-                            String[] items = Arrays.asList(objects).toArray(new String[ROW_LENGTH]);
-                            useXmlPreferences.put(items[0], Boolean.parseBoolean(items[1]));
-                            directCisuPreferences.put(items[0], Boolean.parseBoolean(items[2]));
-                            clientsEditorMap.put(items[0], items[3]);
-                        }
-                    };
-            CsvParserSettings parserSettings = new CsvParserSettings();
-            parserSettings.getFormat().setLineSeparator("\n");
-            parserSettings.getFormat().setDelimiter(';');
-            parserSettings.setHeaderExtractionEnabled(true);
-            parserSettings.setNullValue("");
-            parserSettings.setProcessor(clientPreferencesRowProcessor);
-
-            CsvParser parser = new CsvParser(parserSettings);
-            parser.parse(new BufferedReader(new FileReader(configFile, StandardCharsets.UTF_8)));
-            clientsPerimeterAndVersions = loadClientsPerimetersAndVersions();
-            clientsInhibitedMessages = loadClientsInhibitedMessages();
-            supportedMessages = loadSupportedMessages(vhost);
-        } catch (Exception e) {
-            throw new Exception("Could not read config file " + configFile.getAbsolutePath(), e);
-        }
-    }
-
-    public Map<String, Map<String, String>> loadClientsPerimetersAndVersions() throws IOException {
-        Map<String, Map<String, String>> clientsPerimeterAndVersions = new HashMap<>();
-        BufferedReader reader =
-                new BufferedReader(new FileReader(configFile, StandardCharsets.UTF_8));
-        String headerLine = reader.readLine();
-        String[] headers = headerLine.split(COLUMN_DIVIDER);
-        int numberOfColumns = headers.length;
-
-        Set<String> perimeterNames =
-                Arrays.stream(Constants.Perimeter.values())
-                        .map(Constants.Perimeter::getName)
-                        .collect(Collectors.toSet());
-
-        Map<String, Integer> perimeterColumnIndexes = new HashMap<>();
-        for (int i = 0; i < numberOfColumns; i++) {
-            if (perimeterNames.contains(headers[i])) {
-                perimeterColumnIndexes.put(headers[i], i);
-            }
-        }
-        String line;
-        while ((line = reader.readLine()) != null) {
-            String[] values = line.split(COLUMN_DIVIDER, -1); // -1 allows trailing empty strings
-
-            if (values.length < numberOfColumns) continue;
-
-            String clientId = values[0];
-            Map<String, String> allPerimetersVersions = new HashMap<>();
-
-            for (Map.Entry<String, Integer> perimeterMatch : perimeterColumnIndexes.entrySet()) {
-                String perimeterName = perimeterMatch.getKey();
-                int columnIndex = perimeterMatch.getValue();
-                allPerimetersVersions.put(perimeterName, values[columnIndex]);
-            }
-
-            clientsPerimeterAndVersions.put(clientId, allPerimetersVersions);
-        }
-
-        reader.close();
-        return clientsPerimeterAndVersions;
-    }
+        // We explicitly set the Locale to ensure cross platform consistency
+        Locale.setDefault(Locale.ENGLISH);
 
-    public String[] getClientVersionsForPerimeter(String clientId, String perimeterName) {
-        Map<String, String> clientPerimeterDefinition =
-                clientsPerimeterAndVersions.getOrDefault(clientId, null);
-        if (clientPerimeterDefinition == null) {
-            structuredLog.warn(
-                    "ClientId was not found in clientsPerimeterAndVersions, or the variable is not initialized.",
-                    Map.of(LogConstants.RECIPIENT_ID, clientId));
-            return null;
-        }
-        String versions = clientPerimeterDefinition.getOrDefault(perimeterName, null);
-        return splitString(versions);
+        supportedMessages = loadSupportedMessages(vhost);
     }
 
     public List<String> loadSupportedMessages(String vhost) throws Exception {
@@ -198,64 +92,10 @@ public List<String> loadSupportedMessages(String vhost) throws Exception {
         return supportedMessages;
     }
 
-    private Map<String, List<String>> loadClientsInhibitedMessages() throws IOException {
-        Map<String, List<String>> result = new HashMap<>();
-
-        try (Reader reader = Files.newBufferedReader(configFile.toPath());
-                CSVParser parser =
-                        CSVFormat.DEFAULT
-                                .builder()
-                                .setDelimiter(';')
-                                .setHeader()
-                                .setSkipHeaderRecord(true)
-                                .setTrim(true)
-                                .build()
-                                .parse(reader)) {
-            boolean hasUseCasesColumn =
-                    parser.getHeaderMap().containsKey(INHIBITED_USE_CASES_HEADER);
-
-            for (CSVRecord record : parser) {
-
-                String clientId = record.get(CLIENT_ID_HEADER);
-                List<String> useCases;
-
-                if (hasUseCasesColumn) {
-                    useCases =
-                            Arrays.stream(record.get(INHIBITED_USE_CASES_HEADER).split(","))
-                                    .map(String::trim)
-                                    .filter(s -> !s.isEmpty())
-                                    .toList();
-                } else {
-                    useCases = List.of();
-                }
-
-                result.put(clientId, useCases);
-            }
-        }
-
-        return Collections.unmodifiableMap(result);
-    }
-
     public List<String> getSupportedMessages() {
         return supportedMessages;
     }
 
-    public HashMap<String, Boolean> getUseXmlPreferences() {
-        return useXmlPreferences;
-    }
-
-    public HashMap<String, Boolean> getDirectCisuPreferences() {
-        return directCisuPreferences;
-    }
-
-    public HashMap<String, String> getClientsEditorMap() {
-        return clientsEditorMap;
-    }
-
-    public Map<String, List<String>> getClientsInhibitedMessages() {
-        return clientsInhibitedMessages;
-    }
-
     public long getDefaultTTL() {
         return defaultTTL;
     }
@@ -264,6 +104,10 @@ public String getVhost() {
         return vhost;
     }
 
+    public ClientPropertiesRegistry getClientPropertiesRegistry() {
+        return clientPropertiesRegistry;
+    }
+
     @Bean
     public EdxlHandler edxlHandler() {
         return new EdxlHandler();

hub/dispatcher/src/main/java/com/hubsante/hub/service/ClientPropertiesRegistry.java

@@ -15,12 +15,18 @@
  */
 package com.hubsante.hub.service;
 
+import static com.hubsante.hub.config.Constants.DEFAULT_DIRECT_CISU_PREFERENCE;
+import static com.hubsante.hub.config.Constants.UNKNOWN;
+
+import com.hubsante.hub.config.LogConstants;
+import com.hubsante.hub.config.StructuredLogger;
 import com.hubsante.hub.exception.ClientConfigurationException;
 import com.hubsante.hub.model.ClientProperties;
 import com.hubsante.hub.model.PerimeterDefinition;
 import java.util.*;
 import java.util.function.Function;
 import java.util.stream.Collectors;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
 import org.springframework.boot.context.properties.bind.Bindable;
@@ -31,15 +37,17 @@
 import org.springframework.stereotype.Component;
 
 @Component
+@Slf4j
 public class ClientPropertiesRegistry {
+    private static final StructuredLogger structuredLog = new StructuredLogger(log);
+
     private Map<String, ClientProperties> clientsById = Map.of();
 
-    public ClientPropertiesRegistry(@Value("${client.configuration.file}") Resource resource)
-            throws Exception {
+    public ClientPropertiesRegistry(@Value("${client.configuration.file}") Resource resource) {
         load(resource);
     }
 
-    private void load(Resource resource) throws Exception {
+    private void load(Resource resource) {
         try {
             YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
             factory.setResources(resource);
@@ -135,12 +143,63 @@ private ClientConfigurationException buildException(Map<String, List<String>> er
     }
 
     public ClientProperties get(String clientId) {
-        ClientProperties clientProperties = clientsById.get(clientId);
+        return clientsById.get(clientId);
+    }
+
+    public String[] getClientVersionsForPerimeter(String clientId, String perimeterName) {
+        ClientProperties clientProperties = get(clientId);
+
+        if (clientProperties == null) {
+            structuredLog.warn(
+                    "Client has no configuration", Map.of(LogConstants.RECIPIENT_ID, clientId));
+            return null;
+        }
+
+        PerimeterDefinition perimeter =
+                clientProperties.perimeters().stream()
+                        .filter(p -> p.name().equals(perimeterName))
+                        .findFirst()
+                        .orElse(null);
+
+        if (perimeter == null) {
+            structuredLog.warn(
+                    "Client does not support perimeter " + perimeterName,
+                    Map.of(LogConstants.RECIPIENT_ID, clientId));
+            return null;
+        }
+        return perimeter.versions().toArray(String[]::new);
+    }
 
+    public Boolean isClientUseXml(String clientId) {
+        ClientProperties clientProperties = get(clientId);
+
+        if (clientProperties == null) {
+            return null;
+        }
+        return clientProperties.useXml();
+    }
+
+    public boolean isClientDirectCisu(String clientId) {
+        ClientProperties clientProperties = get(clientId);
+
+        return clientProperties != null
+                ? clientProperties.directCisu()
+                : DEFAULT_DIRECT_CISU_PREFERENCE;
+    }
+
+    public List<String> getClientInhibitedUseCases(String clientId) {
+        ClientProperties clientProperties = get(clientId);
         if (clientProperties == null) {
-            throw new ClientConfigurationException("client " + clientId + " is not configured");
+            return new ArrayList<>();
         }
+        return clientProperties.inhibitedUseCases();
+    }
+
+    public String getClientEditor(String clientId) {
+        ClientProperties clientProperties = get(clientId);
 
-        return clientProperties;
+        if (clientProperties != null && clientProperties.editor() != null) {
+            return clientProperties.editor();
+        } else return UNKNOWN;
     }
 }