fix unit conversion and encoding translation for export csv (#78)

Signed-off-by: Ghazwa REHILI <[email protected]>

Author: ghazwarhili

src/main/java/org/gridsuite/shortcircuit/server/service/ShortCircuitService.java

@@ -23,6 +23,7 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import java.io.*;
+import java.nio.charset.StandardCharsets;
 import java.util.*;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicReference;
@@ -122,18 +123,28 @@ public byte[] exportToCsv(ShortCircuitAnalysisResult result, List<String> header
         List<FaultResult> faultResults = result.getFaults();
         try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
              ZipOutputStream zipOutputStream = new ZipOutputStream(outputStream)) {
-            CsvWriterSettings settings = new CsvWriterSettings();
-            CsvWriter csvWriter = new CsvWriter(zipOutputStream, settings);
             zipOutputStream.putNextEntry(new ZipEntry("shortCircuit_result.csv"));
+
+            // This code is for writing the UTF-8 Byte Order Mark (BOM) to a ZipOutputStream
+            // by adding BOM to the beginning of file to help excel in some versions to detect this is UTF-8 encoding bytes
+            zipOutputStream.write(0xef);
+            zipOutputStream.write(0xbb);
+            zipOutputStream.write(0xbf);
+
+            CsvWriterSettings settings = new CsvWriterSettings();
+            CsvWriter csvWriter = new CsvWriter(zipOutputStream, StandardCharsets.UTF_8, settings);
+
+            // Write headers to the CSV file
             csvWriter.writeHeaders(headersList);
 
+            // Write data to the CSV file
             for (FaultResult faultResult : faultResults) {
                 // Process faultResult data
                 List<String> faultRowData = new ArrayList<>(List.of(
                         faultResult.getFault().getId(),
                         enumValueTranslations.getOrDefault(faultResult.getFault().getFaultType(), ""),
                         "",
-                        Double.toString(faultResult.getPositiveMagnitude())
+                        Double.isNaN(faultResult.getPositiveMagnitude()) ? "" : Double.toString(faultResult.getPositiveMagnitude())
                 ));
 
                 List<LimitViolation> limitViolations = faultResult.getLimitViolations();
@@ -149,8 +160,8 @@ public byte[] exportToCsv(ShortCircuitAnalysisResult result, List<String> header
 
                 ShortCircuitLimits shortCircuitLimits = faultResult.getShortCircuitLimits();
                 faultRowData.addAll(List.of(
-                        Double.toString(shortCircuitLimits.getIpMin()),
-                        Double.toString(shortCircuitLimits.getIpMax()),
+                        Double.toString(shortCircuitLimits.getIpMin() / 1000.0),
+                        Double.toString(shortCircuitLimits.getIpMax() / 1000.0),
                         Double.toString(faultResult.getShortCircuitPower()),
                         Double.toString(shortCircuitLimits.getDeltaCurrentIpMin()),
                         Double.toString(shortCircuitLimits.getDeltaCurrentIpMax())
@@ -166,7 +177,7 @@ public byte[] exportToCsv(ShortCircuitAnalysisResult result, List<String> header
                                 faultResult.getFault().getId(),
                                 "",
                                 feederResult.getConnectableId(),
-                                Double.toString(feederResult.getPositiveMagnitude())
+                                Double.isNaN(feederResult.getPositiveMagnitude()) ? "" : Double.toString(feederResult.getPositiveMagnitude())
                         ));
                         csvWriter.writeRow(feederRowData);
                     }

src/test/java/org/gridsuite/shortcircuit/server/ShortCircuitAnalysisControllerTest.java

@@ -463,7 +463,19 @@ public void runTest() throws Exception {
             byte[] unzippedCsvFile = unzip(zipFile);
             String unzippedCsvFileAsString = new String(unzippedCsvFile, StandardCharsets.UTF_8);
             List<String> actualCsvLines = List.of(Arrays.asList(unzippedCsvFileAsString.split("\n")).get(0).split(","));
-            List<String> expectedLines = new ArrayList<>(CSV_HEADERS);
+            // Including "\uFEFF" indicates the UTF-8 BOM at the start
+            List<String> expectedLines = List.of(
+                    "\uFEFFID nœud",
+                    "Type",
+                    "Départs",
+                    "Icc (kA)",
+                    "Type de limite",
+                    "Icc min (kA)",
+                    "IMACC (kA)",
+                    "Pcc (MVA)",
+                    "Icc - Icc min (kA)",
+                    "Icc - IMACC (kA)"
+            );
             assertEquals(expectedLines, actualCsvLines);
 
             // should throw not found if result does not exist