Fix #136 (#141)

Author: Tristan-WorkGH

src/main/java/org/gridsuite/shortcircuit/server/report/MapperBeans.java

@@ -0,0 +1,78 @@
+package org.gridsuite.shortcircuit.server.report;
+
+import com.powsybl.commons.report.TypedValue;
+import org.gridsuite.shortcircuit.server.report.mappers.AdnSummarizeMapper;
+import org.gridsuite.shortcircuit.server.report.mappers.SeverityMapper;
+import org.gridsuite.shortcircuit.server.service.ShortCircuitRunContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Just initialize all the mappers
+ */
+@Configuration
+public class MapperBeans {
+    @Bean
+    public SeverityMapper powsyblAdnGeneratorsAndBatteriesSeverity() {
+        // in generatorConversion and batteryConversion
+        return new SeverityMapper("disconnectedTerminalGenerator", TypedValue.TRACE_SEVERITY);
+    }
+
+    @Bean
+    public SeverityMapper powsyblAdnLinesSeverity() {
+        // in branchConversion.twoWindingsTransformerConversion
+        return new SeverityMapper("lineConversion", "addConstantRatio", TypedValue.TRACE_SEVERITY);
+    }
+
+    @Bean
+    public SeverityMapper powsyblAdnTwoWindingsTransformersSeverity() {
+        // in branchConversion.twoWindingsTransformerConversion
+        return new SeverityMapper("twoWindingsTransformerConversion", "addConstantRatio", TypedValue.TRACE_SEVERITY);
+    }
+
+    @Bean
+    public AdnSummarizeMapper powsyblAdnGeneratorsSummary() {
+        return new AdnSummarizeMapper("generators",
+                "generatorConversion",
+                "disconnectedTerminalGenerator",
+                "shortcircuit.server.disconnectedTerminalEquipmentSummary",
+                ShortCircuitRunContext::getAdnSummarizeCounterGenerator);
+    }
+
+    @Bean
+    public AdnSummarizeMapper powsyblAdnBatteriesSummary() {
+        return new AdnSummarizeMapper("batteries",
+                "batteryConversion",
+                "disconnectedTerminalGenerator",
+                "shortcircuit.server.disconnectedTerminalEquipmentSummary",
+                ShortCircuitRunContext::getAdnSummarizeCounterBattery);
+    }
+
+    @Bean
+    public AdnSummarizeMapper powsyblAdnLinesSummary() {
+        // in branchConversion.twoWindingsTransformerConversion
+        return new AdnSummarizeMapper("lines",
+                "lineConversion",
+                "addConstantRatio",
+                "shortcircuit.server.addConstantRatioSummary",
+                ShortCircuitRunContext::getAdnSummarizeCounterLines);
+    }
+
+    @Bean
+    public AdnSummarizeMapper powsyblAdnTwoWindingsTransformersSummary() {
+        // in branchConversion.twoWindingsTransformerConversion
+        return new AdnSummarizeMapper("two windings transformers",
+                "twoWindingsTransformerConversion",
+                "addConstantRatio",
+                "shortcircuit.server.addConstantRatioSummary",
+                ShortCircuitRunContext::getAdnSummarizeCounterT2W);
+    }
+
+    /* There is also possibly adn nodes:
+     * branchConversion.twoWindingsTransformerConversion
+     * branchConversion.threeWindingsTransformerConversion
+     * branchConversion.lineConversion
+     * branchConversion.tieLineConversion
+     * danglinglinesConversion
+     */
+}

src/main/java/org/gridsuite/shortcircuit/server/report/mappers/AdnSummarizeMapper.java

@@ -0,0 +1,55 @@
+package org.gridsuite.shortcircuit.server.report.mappers;
+
+import com.powsybl.commons.report.ReportNode;
+import com.powsybl.commons.report.TypedValue;
+import lombok.Data;
+import lombok.NonNull;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.mutable.MutableLong;
+import org.gridsuite.shortcircuit.server.report.ReportMapper;
+import org.gridsuite.shortcircuit.server.report.ShortcircuitServerReportResourceBundle;
+import org.gridsuite.shortcircuit.server.service.ShortCircuitRunContext;
+
+import java.util.function.Function;
+
+/**
+ * Insert a summarized log line for some of the verbose ADN logs.
+ *
+ * @see com.rte_france.powsybl.iidm.export.adn.ADNHelper
+ * @see com.rte_france.powsybl.iidm.export.adn.BranchHelper
+ */
+@Slf4j
+@Data
+public class AdnSummarizeMapper implements ReportMapper {
+    @NonNull private final String equipmentsLabel;
+    @NonNull private final String parentMessageKey; //"Conversion of ..."
+    @NonNull private final String toSummarizeMessageKey;
+    @NonNull private final String summaryMessageKey;
+    @NonNull private final Function<ShortCircuitRunContext, MutableLong> logsToSummarizeCountGetter; // =0L
+
+    /** {@inheritDoc}  */
+    @Override
+    public void transformNode(final @NonNull ReportNode node, @NonNull final ShortCircuitRunContext context) {
+        if (this.parentMessageKey.equals(node.getMessageKey())) {
+            log.debug("ADN logs node for {} detected, will analyse them...", this.equipmentsLabel);
+            for (final ReportNode child : node.getChildren()) {
+                if (this.toSummarizeMessageKey.equals(child.getMessageKey())) {
+                    this.logsToSummarizeCountGetter.apply(context).increment();
+                }
+            }
+            /* finalize computation of summaries */
+            final long logsToSummarizeCount = this.logsToSummarizeCountGetter.apply(context).longValue();
+            log.debug("Found {} lines in shortcircuit logs matching {}", logsToSummarizeCount, this.toSummarizeMessageKey);
+            if (logsToSummarizeCount > 0L) {
+                node.newReportNode()
+                    .withResourceBundles(ShortcircuitServerReportResourceBundle.BASE_NAME) //TODO what is this bug with tests?
+                    .withMessageTemplate(this.summaryMessageKey)
+                    .withTimestamp()
+                    .withSeverity(TypedValue.WARN_SEVERITY)
+                    .withUntypedValue("equipmentsLabel", this.equipmentsLabel)
+                    .withUntypedValue("nb", logsToSummarizeCount)
+                    .add();
+            }
+        }
+    }
+}

src/main/java/org/gridsuite/shortcircuit/server/report/mappers/AdnTraceLevelAndSummarizeMapper.java

@@ -0,0 +1,49 @@
+package org.gridsuite.shortcircuit.server.report.mappers;
+
+import com.powsybl.commons.report.ReportNode;
+import com.powsybl.commons.report.TypedValue;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NonNull;
+import lombok.extern.slf4j.Slf4j;
+import org.gridsuite.shortcircuit.server.report.ReportMapper;
+import org.gridsuite.shortcircuit.server.service.ShortCircuitRunContext;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Pass some of the verbose logs to {@link TypedValue#TRACE_SEVERITY TRACE} severity for example.
+ */
+@Slf4j
+@AllArgsConstructor
+@Data
+public class SeverityMapper implements ReportMapper {
+    @Nullable private final String parentMessageKey; //"Conversion of ..."
+    @NonNull private final String messageKey;
+    @NonNull private final TypedValue severity;
+
+    public SeverityMapper(@NotNull String messageKey, @NotNull TypedValue severity) {
+        this(null, messageKey, severity);
+    }
+
+    /** {@inheritDoc}  */
+    @Override
+    public void transformNode(final @NonNull ReportNode node, @Nullable final ShortCircuitRunContext unused) {
+        if (parentMessageKey == null) {
+            this.testAndSet(node);
+        } else {
+            if (this.parentMessageKey.equals(node.getMessageKey())) {
+                log.debug("ADN logs node {} detected, will analyse it...", this.parentMessageKey);
+                for (final ReportNode child : node.getChildren()) {
+                    this.testAndSet(child);
+                }
+            }
+        }
+    }
+
+    private void testAndSet(final @NotNull ReportNode node) {
+        if (this.messageKey.equals(node.getMessageKey())) {
+            node.addSeverity(this.severity);
+        }
+    }
+}

src/main/java/org/gridsuite/shortcircuit/server/report/mappers/SeverityMapper.java

@@ -7,10 +7,11 @@
 package org.gridsuite.shortcircuit.server.service;
 
 import com.powsybl.shortcircuit.ShortCircuitParameters;
-import lombok.Getter;
 import com.powsybl.ws.commons.computation.dto.ReportInfos;
 import com.powsybl.ws.commons.computation.service.AbstractComputationRunContext;
+import lombok.Getter;
 import lombok.Setter;
+import org.apache.commons.lang3.mutable.MutableLong;
 import org.gridsuite.shortcircuit.server.dto.ShortCircuitLimits;
 
 import java.util.*;
@@ -20,17 +21,24 @@
  */
 @Getter
 public class ShortCircuitRunContext extends AbstractComputationRunContext<ShortCircuitParameters> {
-
     @Setter
     private Map<String, ShortCircuitLimits> shortCircuitLimits = new HashMap<>();
     private final String busId;
     @Setter
     private List<String> voltageLevelsWithWrongIsc = new ArrayList<>();
 
+    /** @see org.gridsuite.shortcircuit.server.report.mappers.AdnSummarizeMapper */
+    private final MutableLong adnSummarizeCounterGenerator = new MutableLong();
+    /** @see org.gridsuite.shortcircuit.server.report.mappers.AdnSummarizeMapper */
+    private final MutableLong adnSummarizeCounterBattery = new MutableLong();
+    /** @see org.gridsuite.shortcircuit.server.report.mappers.AdnSummarizeMapper */
+    private final MutableLong adnSummarizeCounterLines = new MutableLong();
+    /** @see org.gridsuite.shortcircuit.server.report.mappers.AdnSummarizeMapper */
+    private final MutableLong adnSummarizeCounterT2W = new MutableLong();
+
     public ShortCircuitRunContext(UUID networkUuid, String variantId, String receiver, ShortCircuitParameters parameters,
                                   UUID reportUuid, String reporterId, String reportType, String userId, String provider, String busId) {
         super(networkUuid, variantId, receiver, new ReportInfos(reportUuid, reporterId, reportType), userId, provider, parameters);
         this.busId = busId;
     }
-
 }

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

@@ -18,3 +18,11 @@ gridsuite:
   services:
     report-server:
       base-uri: http://localhost:5028
+
+logging:
+  level:
+    # please let us debug that server
+    org.gridsuite.shortcircuit.server.report: DEBUG
+    # helpers logs the same content as the ReportNode tree being constructed: that is noise for us
+    com.rte_france.powsybl.iidm.export.adn: ERROR
+    com.rte_france.powsybl.courcirc.Courcirc: WARN

src/main/resources/application-local.yaml

@@ -1,4 +1,4 @@
-shortcircuit.server.addConstantRatioSummary = Adding constant ratio voltage transformation on ${nb} ${equipmentsLabel} because both voltage levels have different nominal voltage
+shortcircuit.server.addConstantRatioSummary = Adding constant ratio voltage transformation on ${nb} ${equipmentsLabel} because extremities voltage levels have different nominal voltage
 shortcircuit.server.disconnectedTerminalEquipmentSummary = Regulating terminal of ${nb} connected ${equipmentsLabel} is disconnected. Regulation is disabled.
 shortcircuit.server.VoltageLevelsWithWrongIscValues = Voltage levels having wrong isc values
 shortcircuit.server.VoltageLevelsWithWrongIscValuesSummarize = Some voltage levels have wrong isc values, isc min must be <= isc max: ${voltageLevels}