Each modifications group now have a dedicated application status (#274)

Meklo · SlimaneAmar · web-flow · commit 87c676729cd7 · 2023-07-06T12:19:24.000+02:00
Signed-off-by: Hugo Marcellin &lt;hugo.marcelin@rte-france.com&gt;
Co-authored-by: Slimane AMAR &lt;slimane.amar@rte-france.com&gt;
diff --git a/src/main/java/org/gridsuite/modification/server/dto/NetworkModificationResult.java b/src/main/java/org/gridsuite/modification/server/dto/NetworkModificationResult.java
@@ -39,9 +39,12 @@ public ApplicationStatus max(ApplicationStatus other) {
         }
     }
 
-    @Schema(description = "Application status")
+    @Schema(description = "Global application status")
     ApplicationStatus applicationStatus;
 
+    @Schema(description = "Last group application status")
+    ApplicationStatus lastGroupApplicationStatus;
+
     @Schema(description = "Network modification impacts")
     @Builder.Default
     private List<SimpleElementImpact> networkImpacts = List.of();
diff --git a/src/main/java/org/gridsuite/modification/server/modifications/NetworkModificationApplicator.java b/src/main/java/org/gridsuite/modification/server/modifications/NetworkModificationApplicator.java
@@ -6,6 +6,7 @@
  */
 package org.gridsuite.modification.server.modifications;
 
+import com.google.common.collect.Streams;
 import com.powsybl.commons.PowsyblException;
 import com.powsybl.commons.reporter.Report;
 import com.powsybl.commons.reporter.Reporter;
@@ -38,7 +39,7 @@
 public class NetworkModificationApplicator {
     private static final Logger LOGGER = LoggerFactory.getLogger(NetworkModificationApplicator.class);
 
-    private static final String NETWORK_MODIFICATION_TYPE_REPORT = "NetworkModification";
+    public static final String NETWORK_MODIFICATION_TYPE_REPORT = "NetworkModification";
 
     private final NetworkStoreService networkStoreService;
 
@@ -56,36 +57,44 @@ public NetworkModificationApplicator(NetworkStoreService networkStoreService, Eq
         this.context = context;
     }
 
-    public NetworkModificationResult applyModification(ModificationInfos modificationInfos, NetworkInfos networkInfos, ReportInfos reportInfos) {
-        NetworkStoreListener listener = NetworkStoreListener.create(networkInfos.getNetwork(), networkInfos.getNetworkUuuid(), networkStoreService, equipmentInfosService);
-        apply(modificationInfos, listener, reportInfos);
-        return listener.flushNetworkModifications();
-    }
-
     public NetworkModificationResult applyModifications(List<ModificationInfos> modificationInfosList, NetworkInfos networkInfos, ReportInfos reportInfos) {
         NetworkStoreListener listener = NetworkStoreListener.create(networkInfos.getNetwork(), networkInfos.getNetworkUuuid(), networkStoreService, equipmentInfosService);
-        modificationInfosList.forEach(m -> apply(m, listener, reportInfos));
+        ApplicationStatus applicationStatus = apply(modificationInfosList, listener.getNetwork(), reportInfos);
+        listener.setApplicationStatus(applicationStatus);
+        listener.setLastGroupApplicationStatus(applicationStatus);
         return listener.flushNetworkModifications();
     }
 
     public NetworkModificationResult applyModifications(List<Pair<String, List<ModificationInfos>>> modificationInfosGroups, NetworkInfos networkInfos, UUID reportUuid) {
         NetworkStoreListener listener = NetworkStoreListener.create(networkInfos.getNetwork(), networkInfos.getNetworkUuuid(), networkStoreService, equipmentInfosService);
-        modificationInfosGroups.forEach(g -> g.getRight().forEach(m -> apply(m, listener, new ReportInfos(reportUuid, g.getLeft()))));
+        List<ApplicationStatus> groupsStatuses =
+                modificationInfosGroups.stream()
+                        .map(g -> apply(g.getRight(), listener.getNetwork(), new ReportInfos(reportUuid, g.getLeft())))
+                        .toList();
+        listener.setApplicationStatus(groupsStatuses.stream().reduce(ApplicationStatus::max).orElse(ApplicationStatus.ALL_OK));
+        listener.setLastGroupApplicationStatus(Streams.findLast(groupsStatuses.stream()).orElse(ApplicationStatus.ALL_OK));
         return listener.flushNetworkModifications();
     }
 
-    private void apply(ModificationInfos modificationInfos, NetworkStoreListener listener, ReportInfos reportInfos) {
+    private ApplicationStatus apply(List<ModificationInfos> modificationInfosList, Network network, ReportInfos reportInfos) {
         String rootReporterId = reportInfos.getReporterId() + "@" + NETWORK_MODIFICATION_TYPE_REPORT;
         ReporterModel reporter = new ReporterModel(rootReporterId, rootReporterId);
+        ApplicationStatus applicationStatus = modificationInfosList.stream()
+                .map(m -> apply(m, network, reporter))
+                .reduce(ApplicationStatus::max)
+                .orElse(ApplicationStatus.ALL_OK);
+        reportService.sendReport(reportInfos.getReportUuid(), reporter);
+        return applicationStatus;
+    }
+
+    private ApplicationStatus apply(ModificationInfos modificationInfos, Network network, ReporterModel reporter) {
         Reporter subReporter = modificationInfos.createSubReporter(reporter);
         try {
-            apply(modificationInfos.toModification(), listener.getNetwork(), subReporter);
+            apply(modificationInfos.toModification(), network, subReporter);
         } catch (Exception e) {
             handleException(modificationInfos.getErrorType(), subReporter, e);
-        } finally {
-            listener.setApplicationStatus(getApplicationStatus(reporter));
-            reportService.sendReport(reportInfos.getReportUuid(), reporter); // TODO : Group report sends ?
         }
+        return getApplicationStatus(reporter);
     }
 
     @SuppressWarnings("squid:S1181")
diff --git a/src/main/java/org/gridsuite/modification/server/modifications/NetworkStoreListener.java b/src/main/java/org/gridsuite/modification/server/modifications/NetworkStoreListener.java
@@ -8,8 +8,10 @@
 
 import com.powsybl.iidm.network.*;
 import com.powsybl.network.store.client.NetworkStoreService;
+import lombok.Setter;
 import org.gridsuite.modification.server.NetworkModificationException;
 import org.gridsuite.modification.server.dto.NetworkModificationResult;
+import org.gridsuite.modification.server.dto.NetworkModificationResult.ApplicationStatus;
 import org.gridsuite.modification.server.dto.elasticsearch.EquipmentInfos;
 import org.gridsuite.modification.server.dto.elasticsearch.TombstonedEquipmentInfos;
 import org.gridsuite.modification.server.elasticsearch.EquipmentInfosService;
@@ -41,7 +43,10 @@ public class NetworkStoreListener implements NetworkListener {
     private final Set<SimpleElementImpact> networkImpacts = new LinkedHashSet<>();
 
     // TODO : Move to the NetworkModificationApplicator class
-    private NetworkModificationResult.ApplicationStatus applicationStatus = NetworkModificationResult.ApplicationStatus.ALL_OK;
+    @Setter
+    private ApplicationStatus applicationStatus;
+    @Setter
+    private ApplicationStatus lastGroupApplicationStatus;
 
     protected NetworkStoreListener(Network network, UUID networkUuid,
                                    NetworkStoreService networkStoreService, EquipmentInfosService equipmentInfosService) {
@@ -181,14 +186,11 @@ public NetworkModificationResult flushNetworkModifications() {
         return
             NetworkModificationResult.builder()
                 .applicationStatus(applicationStatus)
+                .lastGroupApplicationStatus(lastGroupApplicationStatus)
                 .networkImpacts(new ArrayList<>(networkImpacts))
                 .build();
     }
 
-    public void setApplicationStatus(NetworkModificationResult.ApplicationStatus applicationStatus) {
-        this.applicationStatus = this.applicationStatus.max(applicationStatus);
-    }
-
     private void flushEquipmentInfos() {
         String variantId = network.getVariantManager().getWorkingVariantId();
         Set<String> presentEquipmentDeletionsIds = equipmentInfosService.findEquipmentInfosList(deletedEquipmentsIds, networkUuid, variantId).stream().map(EquipmentInfos::getId).collect(Collectors.toSet());
diff --git a/src/main/java/org/gridsuite/modification/server/service/NetworkModificationService.java b/src/main/java/org/gridsuite/modification/server/service/NetworkModificationService.java
@@ -9,7 +9,6 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.collect.Streams;
 import com.powsybl.commons.PowsyblException;
-import com.powsybl.commons.reporter.ReporterModel;
 import com.powsybl.iidm.network.Network;
 import com.powsybl.iidm.network.VariantManagerConstants;
 import com.powsybl.network.store.client.NetworkStoreService;
@@ -46,19 +45,16 @@ public class NetworkModificationService {
 
     private final NotificationService notificationService;
 
-    private final ReportService reportService;
-
     private final ObjectMapper objectMapper;
 
     public NetworkModificationService(NetworkStoreService networkStoreService, NetworkModificationRepository networkModificationRepository,
-                                      EquipmentInfosService equipmentInfosService, NotificationService notificationService, ReportService reportService,
+                                      EquipmentInfosService equipmentInfosService, NotificationService notificationService,
                                       NetworkModificationApplicator applicationService, ObjectMapper objectMapper) {
         this.networkStoreService = networkStoreService;
         this.networkModificationRepository = networkModificationRepository;
         this.equipmentInfosService = equipmentInfosService;
         this.notificationService = notificationService;
         this.modificationApplicator = applicationService;
-        this.reportService = reportService;
         this.objectMapper = objectMapper;
     }
 
@@ -113,7 +109,7 @@ public Optional<NetworkModificationResult> createNetworkModification(@NonNull Ne
         networkModificationRepository.saveModifications(groupUuid, List.of(modificationInfos.toEntity()));
 
         return networkInfos.isVariantPresent() ?
-            Optional.of(modificationApplicator.applyModification(modificationInfos, networkInfos, reportInfos)) :
+            Optional.of(modificationApplicator.applyModifications(List.of(modificationInfos), networkInfos, reportInfos)) :
             Optional.empty();
     }
 
@@ -150,17 +146,13 @@ public NetworkModificationResult buildVariant(@NonNull NetworkInfos networkInfos
                         throw e;
                     }
                 }
+                modificationInfos.add(
+                    Pair.of(reporterId,
+                        modificationsByGroup.stream()
+                            .filter(e -> !buildInfos.getModificationsToExclude().contains(e.getUuid()))
+                            .collect(Collectors.toList()))
+                );
 
-                if (modificationsByGroup.isEmpty()) {
-                    reportService.sendReport(buildInfos.getReportUuid(), new ReporterModel(reporterId, reporterId));
-                } else {
-                    modificationInfos.add(
-                        Pair.of(reporterId,
-                            modificationsByGroup.stream()
-                                .filter(e -> !buildInfos.getModificationsToExclude().contains(e.getUuid()))
-                                .collect(Collectors.toList()))
-                    );
-                }
             }
         );
 
diff --git a/src/test/java/org/gridsuite/modification/server/Impacts/ElementImpactTest.java b/src/test/java/org/gridsuite/modification/server/Impacts/ElementImpactTest.java
@@ -21,7 +21,6 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.TreeSet;
-
 import static org.gridsuite.modification.server.Impacts.TestImpactUtils.*;
 import static org.junit.Assert.assertEquals;
 
@@ -49,14 +48,17 @@ public void testElementImpact() throws IOException {
 
         NetworkModificationResult result = NetworkModificationResult.builder()
             .applicationStatus(ApplicationStatus.ALL_OK)
+            .lastGroupApplicationStatus(ApplicationStatus.ALL_OK)
             .networkImpacts((List<SimpleElementImpact>) impacts)
             .build();
         assertEquals(TestUtils.resourceToString("/network-modification-result-with-all-ok.json"), mapper.writeValueAsString(result));
 
         result.setApplicationStatus(ApplicationStatus.WITH_WARNINGS);
+        result.setLastGroupApplicationStatus(ApplicationStatus.WITH_WARNINGS);
         assertEquals(TestUtils.resourceToString("/network-modification-result-with-with-warnings.json"), mapper.writeValueAsString(result));
 
         result.setApplicationStatus(ApplicationStatus.WITH_ERRORS);
+        result.setLastGroupApplicationStatus(ApplicationStatus.WITH_ERRORS);
         assertEquals(TestUtils.resourceToString("/network-modification-result-with-with-errors.json"), mapper.writeValueAsString(result));
 
         assertEquals("[s1, s2, s3, s4]", result.getImpactedSubstationsIds().toString());
diff --git a/src/test/java/org/gridsuite/modification/server/Impacts/TestImpactUtils.java b/src/test/java/org/gridsuite/modification/server/Impacts/TestImpactUtils.java
@@ -37,16 +37,21 @@ public static void testEmptyImpacts(ObjectMapper mapper, String resultAsString)
     }
 
     public static void testEmptyImpacts(ObjectMapper mapper, NetworkModificationResult networkModificationResult) {
-        testEmptyImpacts(mapper, ApplicationStatus.ALL_OK, networkModificationResult);
+        testEmptyImpacts(mapper, ApplicationStatus.ALL_OK, ApplicationStatus.ALL_OK, networkModificationResult);
     }
 
     public static void testEmptyImpactsWithErrors(ObjectMapper mapper, NetworkModificationResult networkModificationResult) {
-        testEmptyImpacts(mapper, ApplicationStatus.WITH_ERRORS, networkModificationResult);
+        testEmptyImpacts(mapper, ApplicationStatus.WITH_ERRORS, ApplicationStatus.WITH_ERRORS, networkModificationResult);
     }
 
-    private static void testEmptyImpacts(ObjectMapper mapper, ApplicationStatus applicationStatusExpected, NetworkModificationResult networkModificationResult) {
+    public static void testEmptyImpactsWithErrorsLastOK(ObjectMapper mapper, NetworkModificationResult networkModificationResult) {
+        testEmptyImpacts(mapper, ApplicationStatus.WITH_ERRORS, ApplicationStatus.ALL_OK, networkModificationResult);
+    }
+
+    private static void testEmptyImpacts(ObjectMapper mapper, ApplicationStatus globalApplicationStatusExpected, ApplicationStatus localApplicationStatusExpected, NetworkModificationResult networkModificationResult) {
         NetworkModificationResult resultExpected = NetworkModificationResult.builder()
-            .applicationStatus(applicationStatusExpected)
+            .applicationStatus(globalApplicationStatusExpected)
+            .lastGroupApplicationStatus(localApplicationStatusExpected)
             .networkImpacts(List.of())
             .build();
         assertThat(networkModificationResult).recursivelyEquals(resultExpected);
@@ -66,6 +71,7 @@ public static void testElementImpacts(ObjectMapper mapper, String resultAsString
         assertTrue(networkModificationResult.isPresent());
         NetworkModificationResult resultExpected = NetworkModificationResult.builder()
             .applicationStatus(ApplicationStatus.ALL_OK)
+            .lastGroupApplicationStatus(ApplicationStatus.ALL_OK)
             .networkImpacts(elementImpactsExpected)
             .build();
         assertThat(networkModificationResult.get()).recursivelyEquals(resultExpected);
@@ -88,6 +94,7 @@ public static void testElementImpact(SimpleImpactType impactType, ObjectMapper m
         assertTrue(networkModificationResult.isPresent());
         NetworkModificationResult resultExpected = NetworkModificationResult.builder()
             .applicationStatus(ApplicationStatus.ALL_OK)
+            .lastGroupApplicationStatus(ApplicationStatus.ALL_OK)
             .networkImpacts(List.of(createElementImpact(impactType, elementType, elementId, new HashSet<>(substationIds))))
             .build();
         assertThat(networkModificationResult.get()).recursivelyEquals(resultExpected);
@@ -100,6 +107,7 @@ public static void testConnectableDeletionImpacts(ObjectMapper mapper, String re
         assertTrue(networkModificationResult.isPresent());
         NetworkModificationResult resultExpected = NetworkModificationResult.builder()
             .applicationStatus(ApplicationStatus.ALL_OK)
+            .lastGroupApplicationStatus(ApplicationStatus.ALL_OK)
             .networkImpacts(createConnectableDeletionImpacts(connectableType, connectableId, breakerId, disconnectorId, substationId))
             .build();
         assertThat(networkModificationResult.get()).recursivelyEquals(resultExpected);
@@ -144,6 +152,7 @@ public static void testBranchImpacts(ObjectMapper mapper, SimpleImpactType impac
         assertTrue(networkModificationResult.isPresent());
         NetworkModificationResult resultExpected = NetworkModificationResult.builder()
             .applicationStatus(ApplicationStatus.ALL_OK)
+            .lastGroupApplicationStatus(ApplicationStatus.ALL_OK)
             .networkImpacts(createBranchImpacts(impactType, branchType, branchId, breakerId1, disconnectorId1, substationId1, breakerId2, disconnectorId2, substationId2))
             .build();
         assertThat(networkModificationResult.get()).recursivelyEquals(resultExpected);
@@ -177,6 +186,7 @@ public static void test3WTDeletionImpacts(ObjectMapper mapper, String resultAsSt
         assertTrue(networkModificationResult.isPresent());
         NetworkModificationResult resultExpected = NetworkModificationResult.builder()
             .applicationStatus(ApplicationStatus.ALL_OK)
+            .lastGroupApplicationStatus(ApplicationStatus.ALL_OK)
             .networkImpacts(create3wtDeletionImpacts(w3tId, breakerId1, disconnectorId1, breakerId2, disconnectorId2, breakerId3, disconnectorId3, substationId))
             .build();
         assertThat(networkModificationResult.get()).recursivelyEquals(resultExpected);
diff --git a/src/test/java/org/gridsuite/modification/server/service/BuildTest.java b/src/test/java/org/gridsuite/modification/server/service/BuildTest.java
@@ -18,6 +18,7 @@
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
 import okhttp3.mockwebserver.RecordedRequest;
+import org.apache.commons.lang3.tuple.Pair;
 import org.gridsuite.modification.server.ContextConfigurationWithTestChannel;
 import org.gridsuite.modification.server.TapChangerType;
 import org.gridsuite.modification.server.dto.*;
@@ -63,6 +64,7 @@
 
 import static com.powsybl.iidm.network.ReactiveLimitsKind.MIN_MAX;
 import static org.gridsuite.modification.server.Impacts.TestImpactUtils.*;
+import static org.gridsuite.modification.server.modifications.NetworkModificationApplicator.NETWORK_MODIFICATION_TYPE_REPORT;
 import static org.gridsuite.modification.server.service.BuildWorkerService.CANCEL_MESSAGE;
 import static org.gridsuite.modification.server.service.BuildWorkerService.FAIL_MESSAGE;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -319,7 +321,7 @@ public void runBuildWithEmptyGroupTest() throws Exception {
             List.of(TEST_GROUP_ID),
             List.of(TEST_SUB_REPORTER_ID_1),
             new HashSet<>());
-        String expectedBody = mapper.writeValueAsString(new ReporterModel(TEST_SUB_REPORTER_ID_1, TEST_SUB_REPORTER_ID_1));
+        String expectedBody = mapper.writeValueAsString(new ReporterModel(TEST_SUB_REPORTER_ID_1 + "@" + NETWORK_MODIFICATION_TYPE_REPORT, TEST_SUB_REPORTER_ID_1 + "@" + NETWORK_MODIFICATION_TYPE_REPORT));
 
         // Group does not exist
         String uriString = "/v1/networks/{networkUuid}/build?receiver=me";
@@ -825,6 +827,25 @@ public void testApplyModificationWithErrors() {
         testNetworkModificationsCount(groupUuid, 2);
     }
 
+    @Test
+    public void testLastGroupModificationStatus() {
+        Network network = NetworkCreation.create(TEST_NETWORK_ID, true);
+        LoadCreationInfos loadCreationInfos = LoadCreationInfos.builder().voltageLevelId("unknownVoltageLevelId").equipmentId("loadId").build();
+        UUID reportUuid = UUID.randomUUID();
+        String reporterId = UUID.randomUUID().toString();
+        String reporterId2 = UUID.randomUUID().toString();
+
+        List<Pair<String, List<ModificationInfos>>> modificationInfosGroups = new ArrayList<>();
+        modificationInfosGroups.add(Pair.of(reporterId, List.of(loadCreationInfos)));
+        modificationInfosGroups.add(Pair.of(reporterId2, List.of()));
+
+        //Global application status should be in error and last application status should be OK
+        NetworkModificationResult networkModificationResult = networkModificationApplicator.applyModifications(modificationInfosGroups, new NetworkInfos(network, TEST_NETWORK_ID, true), reportUuid);
+        assertNotNull(networkModificationResult);
+        testEmptyImpactsWithErrorsLastOK(mapper, networkModificationResult);
+        assertTrue(TestUtils.getRequestsDone(2, server).stream().anyMatch(r -> r.matches(String.format("/v1/reports/%s", reportUuid))));
+    }
+
     private void testNetworkModificationsCount(UUID groupUuid, int actualSize) {
         assertEquals(actualSize, modificationRepository.getModifications(groupUuid, true, true).size());
     }
diff --git a/src/test/resources/network-modification-result-with-all-ok.json b/src/test/resources/network-modification-result-with-all-ok.json
@@ -1,5 +1,6 @@
 {
   "applicationStatus": "ALL_OK",
+  "lastGroupApplicationStatus": "ALL_OK",
   "networkImpacts": [
     {
       "impactType": "CREATION",
diff --git a/src/test/resources/network-modification-result-with-with-errors.json b/src/test/resources/network-modification-result-with-with-errors.json
@@ -1,5 +1,6 @@
 {
   "applicationStatus": "WITH_ERRORS",
+  "lastGroupApplicationStatus": "WITH_ERRORS",
   "networkImpacts": [
     {
       "impactType": "CREATION",
diff --git a/src/test/resources/network-modification-result-with-with-warnings.json b/src/test/resources/network-modification-result-with-with-warnings.json

Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,12 @@ public ApplicationStatus max(ApplicationStatus other) {`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`
`42`		`- @Schema(description = "Application status")`
	`42`	`+ @Schema(description = "Global application status")`
`43`	`43`	`ApplicationStatus applicationStatus;`
`44`	`44`
	`45`	`+ @Schema(description = "Last group application status")`
	`46`	`+ ApplicationStatus lastGroupApplicationStatus;`
	`47`	`+`
`45`	`48`	`@Schema(description = "Network modification impacts")`
`46`	`49`	`@Builder.Default`
`47`	`50`	`private List<SimpleElementImpact> networkImpacts = List.of();`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"applicationStatus": "ALL_OK",`
	`3`	`+ "lastGroupApplicationStatus": "ALL_OK",`
`3`	`4`	`"networkImpacts": [`
`4`	`5`	`{`
`5`	`6`	`"impactType": "CREATION",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"applicationStatus": "WITH_ERRORS",`
	`3`	`+ "lastGroupApplicationStatus": "WITH_ERRORS",`
`3`	`4`	`"networkImpacts": [`
`4`	`5`	`{`
`5`	`6`	`"impactType": "CREATION",`