Upgrade to powsybl.dependencies 2024.1.0 (#89)

Signed-off-by: Etienne Homer <[email protected]>

Author: etiennehomer

pom.xml

@@ -42,7 +42,7 @@
     </developers>
 
     <properties>
-        <powsybl-ws-dependencies.version>2.9.0</powsybl-ws-dependencies.version>
+        <gridsuite-dependencies.version>29</gridsuite-dependencies.version>
         <liquibase-hibernate-package>org.gridsuite.shortcircuit.server</liquibase-hibernate-package>
         <mockito-inline.version>3.11.1</mockito-inline.version>
         <db-util.version>1.0.5</db-util.version>
@@ -88,9 +88,9 @@
 
             <!-- imports -->
             <dependency>
-                <groupId>com.powsybl</groupId>
-                <artifactId>powsybl-ws-dependencies</artifactId>
-                <version>${powsybl-ws-dependencies.version}</version>
+                <groupId>org.gridsuite</groupId>
+                <artifactId>gridsuite-dependencies</artifactId>
+                <version>${gridsuite-dependencies.version}</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>

src/main/java/org/gridsuite/shortcircuit/server/RestTemplateConfig.java

@@ -10,8 +10,8 @@
 import com.fasterxml.jackson.databind.InjectableValues;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
-import com.powsybl.commons.reporter.ReporterModelDeserializer;
-import com.powsybl.commons.reporter.ReporterModelJsonModule;
+import com.powsybl.commons.report.ReportNodeDeserializer;
+import com.powsybl.commons.report.ReportNodeJsonModule;
 import com.powsybl.shortcircuit.json.ShortCircuitAnalysisJsonModule;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -51,8 +51,8 @@ private static ObjectMapper createObjectMapper() {
         var objectMapper = Jackson2ObjectMapperBuilder.json().build();
         objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
         objectMapper.registerModule(new ShortCircuitAnalysisJsonModule());
-        objectMapper.registerModule(new ReporterModelJsonModule());
-        objectMapper.setInjectableValues(new InjectableValues.Std().addValue(ReporterModelDeserializer.DICTIONARY_VALUE_ID, null));
+        objectMapper.registerModule(new ReportNodeJsonModule());
+        objectMapper.setInjectableValues(new InjectableValues.Std().addValue(ReportNodeDeserializer.DICTIONARY_VALUE_ID, null));
         return objectMapper;
     }
 

src/main/java/org/gridsuite/shortcircuit/server/ShortCircuitController.java

@@ -45,7 +45,9 @@ public ShortCircuitController(ShortCircuitService shortCircuitService) {
     }
 
     private static ShortCircuitParameters getNonNullParameters(ShortCircuitParameters parameters) {
-        return parameters != null ? parameters : new ShortCircuitParameters();
+        ShortCircuitParameters shortCircuitParameters = parameters != null ? parameters : new ShortCircuitParameters();
+        shortCircuitParameters.setDetailedReport(false);
+        return shortCircuitParameters;
     }
 
     @PostMapping(value = "/networks/{networkUuid}/run-and-save", produces = APPLICATION_JSON_VALUE, consumes = APPLICATION_JSON_VALUE)

src/main/java/org/gridsuite/shortcircuit/server/reports/AbstractReportMapper.java

@@ -6,10 +6,8 @@
  */
 package org.gridsuite.shortcircuit.server.reports;
 
-import com.powsybl.commons.reporter.Report;
-import com.powsybl.commons.reporter.Reporter;
-import com.powsybl.commons.reporter.ReporterModel;
-import com.powsybl.commons.reporter.TypedValue;
+import com.powsybl.commons.report.*;
+import jdk.javadoc.doclet.Reporter;
 import lombok.NonNull;
 import lombok.extern.slf4j.Slf4j;
 import org.gridsuite.shortcircuit.server.service.ShortCircuitRunContext;
@@ -38,19 +36,34 @@
 public abstract class AbstractReportMapper {
     /**
      * Will try to modify the reporter
-     * @param reporter the reporter to modify
+     * @param reportNode reportNode to modify
      * @return the result
      *
      * @implNote currently support only some implementations of {@link Reporter}
      */
-    public Reporter processReporter(@NonNull final Reporter reporter) {
-        if (reporter instanceof ReporterModel reporterModel && reporterModel.getTaskKey()
+    public ReportNode processReporter(@NonNull final ReportNode reportNode) {
+        if (reportNode.getMessageKey() != null && reportNode.getMessageKey()
                 .matches("^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}@)?.*ShortCircuitAnalysis$")) {
             log.debug("ShortCircuitAnalysis root node found, will modify it!");
-            return forUuidAtShortCircuitAnalysis(reporterModel);
+            return forUuidAtShortCircuitAnalysis(reportNode);
         } else {
-            log.trace("Unrecognized Reporter: {}", reporter);
-            return reporter;
+            log.trace("Unrecognized ReportNode: {}", reportNode);
+            return reportNode;
+        }
+    }
+
+    public static void insertReportNode(ReportNode parent, ReportNode child) {
+        ReportNodeAdder adder = parent.newReportNode().withMessageTemplate(child.getMessageKey(), child.getMessageTemplate());
+        for (Map.Entry<String, TypedValue> valueEntry : child.getValues().entrySet()) {
+            adder.withUntypedValue(valueEntry.getKey(), valueEntry.getValue().toString());
+        }
+        TypedValue severity = child.getValue(ReportConstants.REPORT_SEVERITY_KEY).orElse(null);
+        if (severity != null) {
+            adder.withSeverity(severity);
+        }
+        ReportNode insertedChild = adder.add();
+        if (child.getChildren() != null) {
+            child.getChildren().forEach(grandChild -> insertReportNode(insertedChild, grandChild));
         }
     }
 
@@ -59,32 +72,37 @@ public Reporter processReporter(@NonNull final Reporter reporter) {
      *
      * @implNote we assume there will always be at least one modification
      */
-    protected Reporter forUuidAtShortCircuitAnalysis(@NonNull final ReporterModel reporterModel) {
-        final ReporterModel newReporter = new ReporterModel(reporterModel.getTaskKey(), reporterModel.getDefaultName(), reporterModel.getTaskValues());
-        reporterModel.getReports().forEach(newReporter::report);
-        reporterModel.getSubReporters().forEach(reporter -> {
-            if (reporter.getTaskKey() != null && reporter.getTaskKey().endsWith("ShortCircuitAnalysis")) {
-                newReporter.addSubReporter(forShortCircuitAnalysis(reporter));
+    protected ReportNode forUuidAtShortCircuitAnalysis(@NonNull final ReportNode reportNode) {
+        ReportNodeBuilder builder = ReportNode.newRootReportNode()
+                .withMessageTemplate(reportNode.getMessageKey(), reportNode.getMessageTemplate());
+        reportNode.getValues().entrySet().forEach(entry -> builder.withTypedValue(entry.getKey(), entry.getValue().getValue().toString(), entry.getValue().getType()));
+        final ReportNode newReportNode = builder.build();
+
+        reportNode.getChildren().forEach(child -> {
+            if (child.getMessageKey() != null && child.getMessageKey().endsWith("ShortCircuitAnalysis")) {
+                insertReportNode(newReportNode, forShortCircuitAnalysis(child));
             } else {
-                newReporter.addSubReporter(reporter);
+                insertReportNode(newReportNode, child);
             }
         });
-        return newReporter;
+        return newReportNode;
     }
 
     /**
      * Modify node with key {@code ShortCircuitAnalysis}
      */
-    protected abstract ReporterModel forShortCircuitAnalysis(@NonNull final ReporterModel reporterModel);
+    protected abstract ReportNode forShortCircuitAnalysis(@NonNull final ReportNode reportNode);
 
     /**
-     * Copy the report, but with {@link TypedValue#TRACE_SEVERITY} severity
-     * @param reporterModel the {@link ReporterModel reporter} to which add the modified {@link Report}
-     * @param report the report to copy with {@code TRACE} severity
+     * Copy the reportNode, but with {@link TypedValue#TRACE_SEVERITY} severity
+     * @param reportNode the {@link ReportNode reporter} to which add the modified {@link ReportNode}
+     * @param child the report to copy with {@code TRACE} severity
      */
-    static void copyReportAsTrace(@NonNull final ReporterModel reporterModel, @NonNull final Report report) {
-        final Map<String, TypedValue> values = new HashMap<>(report.getValues());
-        values.put(Report.REPORT_SEVERITY_KEY, TypedValue.TRACE_SEVERITY);
-        reporterModel.report(new Report(report.getReportKey(), report.getDefaultMessage(), values));
+    static void copyReportAsTrace(@NonNull final ReportNode reportNode, @NonNull final ReportNode child) {
+        final Map<String, TypedValue> values = new HashMap<>(child.getValues());
+        values.put(ReportConstants.REPORT_SEVERITY_KEY, TypedValue.TRACE_SEVERITY);
+        ReportNodeAdder adder = reportNode.newReportNode().withMessageTemplate(child.getMessageKey(), child.getMessageTemplate());
+        values.entrySet().forEach(entry -> adder.withTypedValue(entry.getKey(), entry.getValue().getValue().toString(), entry.getValue().getType()));
+        adder.add();
     }
 }