move apply in another component using its own Tx

Signed-off-by: David BRAQUART <[email protected]>

Author: dbraquart

src/main/java/org/gridsuite/modification/server/modifications/NetworkModificationApplicator.java

@@ -17,13 +17,17 @@
 import com.powsybl.network.store.client.NetworkStoreService;
 import com.powsybl.network.store.client.PreloadingStrategy;
 import lombok.Getter;
+import lombok.NonNull;
 import org.gridsuite.modification.ModificationType;
 import org.gridsuite.modification.dto.ModificationInfos;
 import org.gridsuite.modification.modifications.AbstractModification;
+import org.gridsuite.modification.server.dto.ModificationApplicationContext;
 import org.gridsuite.modification.server.dto.ModificationApplicationGroup;
 import org.gridsuite.modification.server.dto.NetworkInfos;
 import org.gridsuite.modification.server.dto.NetworkModificationResult;
 import org.gridsuite.modification.server.dto.NetworkModificationResult.ApplicationStatus;
+import org.gridsuite.modification.server.dto.NetworkModificationsResult;
+import org.gridsuite.modification.server.dto.ReportInfos;
 import org.gridsuite.modification.server.elasticsearch.EquipmentInfosService;
 import org.gridsuite.modification.server.elasticsearch.ModificationApplicationInfosService;
 import org.gridsuite.modification.server.entities.ModificationEntity;
@@ -33,9 +37,12 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Lazy;
 import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 
 import static org.gridsuite.modification.server.report.NetworkModificationServerReportResourceBundle.ERROR_MESSAGE_KEY;
@@ -55,6 +62,8 @@ public class NetworkModificationApplicator {
 
     private final ReportService reportService;
 
+    private final NetworkModificationService networkModificationService;
+
     @Getter private final FilterService filterService;
 
     @Getter private final LoadFlowService loadFlowService;
@@ -77,6 +86,7 @@ public NetworkModificationApplicator(NetworkStoreService networkStoreService, Eq
                                          LoadFlowService loadFlowService,
                                          NetworkModificationObserver networkModificationObserver,
                                          NetworkModificationRepository networkModificationRepository,
+                                         @Lazy NetworkModificationService networkModificationService,
                                          LargeNetworkModificationExecutionService largeNetworkModificationExecutionService) {
         this.networkStoreService = networkStoreService;
         this.equipmentInfosService = equipmentInfosService;
@@ -86,6 +96,7 @@ public NetworkModificationApplicator(NetworkStoreService networkStoreService, Eq
         this.loadFlowService = loadFlowService;
         this.networkModificationObserver = networkModificationObserver;
         this.networkModificationRepository = networkModificationRepository;
+        this.networkModificationService = networkModificationService;
         this.largeNetworkModificationExecutionService = largeNetworkModificationExecutionService;
     }
 
@@ -263,4 +274,41 @@ public static ApplicationStatus getApplicationStatus(ReportNode reportNode) {
             throw new IllegalArgumentException(String.format("Report severity '%s' unknown !", severity.getValue()));
         }
     }
+
+    /**
+     * Apply modifications on several networks
+     */
+    public List<Optional<NetworkModificationResult>> applyModifications(UUID groupUuid, List<ModificationEntity> modifications, List<ModificationApplicationContext> applicationContexts) {
+        return applicationContexts.stream().map(modificationApplicationContext ->
+                applyModifications(
+                        modificationApplicationContext.networkUuid(),
+                        modificationApplicationContext.variantId(),
+                        new ModificationApplicationGroup(groupUuid,
+                                modifications.stream().filter(m -> !modificationApplicationContext.excludedModifications().contains(m.getId())).toList(),
+                                new ReportInfos(modificationApplicationContext.reportUuid(), modificationApplicationContext.reporterId())
+                        ))
+        ).toList();
+    }
+
+    private Optional<NetworkModificationResult> applyModifications(UUID networkUuid, String variantId, ModificationApplicationGroup modificationGroupInfos) {
+        if (!modificationGroupInfos.modifications().isEmpty()) {
+            PreloadingStrategy preloadingStrategy = modificationGroupInfos.modifications().stream()
+                    .map(ModificationEntity::getType)
+                    .map(ModificationType::valueOf)
+                    .reduce(ModificationType::maxStrategy).map(ModificationType::getStrategy).orElse(PreloadingStrategy.NONE);
+            NetworkInfos networkInfos = networkModificationService.getNetworkInfos(networkUuid, variantId, preloadingStrategy);
+
+            // try to apply the modifications (incremental mode)
+            if (networkInfos.isVariantPresent()) {
+                return Optional.of(applyModifications(modificationGroupInfos, networkInfos));
+            }
+        }
+        return Optional.empty();
+    }
+
+    @Transactional
+    public NetworkModificationsResult applyNewNetworkModification(@NonNull UUID modificationUuid, @NonNull UUID groupUuid, @NonNull List<ModificationApplicationContext> applicationContexts) {
+        ModificationEntity entity = networkModificationRepository.getModificationEntity(modificationUuid);
+        return new NetworkModificationsResult(List.of(modificationUuid), applyModifications(groupUuid, List.of(entity), applicationContexts));
+    }
 }

src/main/java/org/gridsuite/modification/server/repositories/NetworkModificationRepository.java

@@ -109,10 +109,12 @@ public void deleteAll() {
     // This method should be package-private and not used as API of the service as it uses ModificationEntity and
     // we want to encapsulate the use of Entity related objects to this service.
     // Nevertheless We have to keep it public for transactional annotation.
+    // TODO: only used by tests - could be replaced by function below ?
     public List<ModificationEntity> saveModifications(UUID groupUuid, List<ModificationEntity> modifications) {
         return saveModificationsNonTransactional(groupUuid, modifications);
     }
 
+    @Transactional
     public List<ModificationEntity> saveModificationInfos(UUID groupUuid, List<ModificationInfos> modifications) {
         List<ModificationEntity> entities = modifications.stream().map(ModificationEntity::fromDTO).toList();
 

src/main/java/org/gridsuite/modification/server/service/NetworkModificationService.java

@@ -191,27 +191,11 @@ public void restoreNetworkModifications(UUID groupUuid, @NonNull List<UUID> modi
             networkModificationRepository.getModificationsCount(groupUuid, false));
     }
 
-    @Transactional
     public NetworkModificationsResult createNetworkModification(@NonNull UUID groupUuid, @NonNull ModificationInfos modificationInfo, @NonNull List<ModificationApplicationContext> applicationContexts) {
+        // We call 2 methods having a distinct Transaction. This is important for this use-case: when we create a Modification M on a built node,
+        // we want M to be inserted in database even if apply(M) raises an exception.
         List<ModificationEntity> modificationEntities = networkModificationRepository.saveModificationInfos(groupUuid, List.of(modificationInfo));
-
-        return new NetworkModificationsResult(modificationEntities.stream().map(ModificationEntity::getId).toList(),
-            applyModifications(groupUuid, modificationEntities, applicationContexts));
-    }
-
-    /**
-     * Apply modifications on several networks
-     */
-    private List<Optional<NetworkModificationResult>> applyModifications(UUID groupUuid, List<ModificationEntity> modifications, List<ModificationApplicationContext> applicationContexts) {
-        return applicationContexts.stream().map(modificationApplicationContext ->
-            applyModifications(
-                modificationApplicationContext.networkUuid(),
-                modificationApplicationContext.variantId(),
-                new ModificationApplicationGroup(groupUuid,
-                    modifications.stream().filter(m -> !modificationApplicationContext.excludedModifications().contains(m.getId())).toList(),
-                    new ReportInfos(modificationApplicationContext.reportUuid(), modificationApplicationContext.reporterId())
-                ))
-        ).toList();
+        return modificationApplicator.applyNewNetworkModification(modificationEntities.getFirst().getId(), groupUuid, applicationContexts);
     }
 
     public Network cloneNetworkVariant(UUID networkUuid,
@@ -292,7 +276,7 @@ public NetworkModificationsResult moveModifications(@NonNull UUID destinationGro
         // update origin/destinations groups to cut and paste all modificationsToMove
         List<ModificationEntity> modificationEntities = networkModificationRepository.moveModifications(destinationGroupUuid, originGroupUuid, modificationsToMoveUuids, beforeModificationUuid);
 
-        List<Optional<NetworkModificationResult>> result = applyModifications && !modificationEntities.isEmpty() ? applyModifications(destinationGroupUuid, modificationEntities, applicationContexts) : List.of();
+        List<Optional<NetworkModificationResult>> result = applyModifications && !modificationEntities.isEmpty() ? modificationApplicator.applyModifications(destinationGroupUuid, modificationEntities, applicationContexts) : List.of();
         return new NetworkModificationsResult(modificationEntities.stream().map(ModificationEntity::getId).toList(), result);
     }
 
@@ -316,22 +300,6 @@ public Map<UUID, UUID> duplicateGroup(UUID sourceGroupUuid, UUID groupUuid) {
         }
     }
 
-    private Optional<NetworkModificationResult> applyModifications(UUID networkUuid, String variantId, ModificationApplicationGroup modificationGroupInfos) {
-        if (!modificationGroupInfos.modifications().isEmpty()) {
-            PreloadingStrategy preloadingStrategy = modificationGroupInfos.modifications().stream()
-                .map(ModificationEntity::getType)
-                .map(ModificationType::valueOf)
-                .reduce(ModificationType::maxStrategy).map(ModificationType::getStrategy).orElse(PreloadingStrategy.NONE);
-            NetworkInfos networkInfos = getNetworkInfos(networkUuid, variantId, preloadingStrategy);
-
-            // try to apply the duplicated modifications (incremental mode)
-            if (networkInfos.isVariantPresent()) {
-                return Optional.of(modificationApplicator.applyModifications(modificationGroupInfos, networkInfos));
-            }
-        }
-        return Optional.empty();
-    }
-
     @Transactional
     public NetworkModificationsResult duplicateModifications(@NonNull UUID targetGroupUuid, UUID originGroupUuid, @NonNull List<UUID> modificationsUuids, @NonNull List<ModificationApplicationContext> applicationContexts) {
         if (originGroupUuid != null && !modificationsUuids.isEmpty()) { // Duplicate modifications from a group or from a list only
@@ -341,15 +309,15 @@ public NetworkModificationsResult duplicateModifications(@NonNull UUID targetGro
         List<ModificationEntity> duplicateModifications = networkModificationRepository.saveModificationInfos(targetGroupUuid, modificationInfos);
         return new NetworkModificationsResult(
             duplicateModifications.stream().map(ModificationEntity::getId).toList(),
-            applyModifications(targetGroupUuid, duplicateModifications, applicationContexts)
+            modificationApplicator.applyModifications(targetGroupUuid, duplicateModifications, applicationContexts)
         );
     }
 
     @Transactional
     public NetworkModificationsResult insertCompositeModifications(@NonNull UUID targetGroupUuid, @NonNull List<UUID> modificationsUuids, @NonNull List<ModificationApplicationContext> applicationContexts) {
         List<ModificationInfos> modificationInfos = networkModificationRepository.getCompositeModificationsInfos(modificationsUuids);
         List<ModificationEntity> modificationEntities = networkModificationRepository.saveModificationInfos(targetGroupUuid, modificationInfos);
-        return new NetworkModificationsResult(modificationEntities.stream().map(ModificationEntity::getId).toList(), applyModifications(targetGroupUuid, modificationEntities, applicationContexts));
+        return new NetworkModificationsResult(modificationEntities.stream().map(ModificationEntity::getId).toList(), modificationApplicator.applyModifications(targetGroupUuid, modificationEntities, applicationContexts));
     }
 
     @Transactional

src/test/java/org/gridsuite/modification/server/ModificationControllerTest.java

@@ -451,7 +451,7 @@ void testNetworkModificationsWithErrorOnNetworkFlush() throws Exception {
 
         mockMvc.perform(post(NETWORK_MODIFICATION_URI).content(groovyScriptInfosJson).contentType(MediaType.APPLICATION_JSON)).andExpect(status().is5xxServerError());
 
-        assertEquals(0, modificationRepository.getModifications(TEST_GROUP_ID, true, false).size());
+        assertEquals(1, modificationRepository.getModifications(TEST_GROUP_ID, true, false).size());
     }
 
     @Test

src/test/java/org/gridsuite/modification/server/modifications/CompositeModificationsTest.java

@@ -14,6 +14,7 @@
 import org.gridsuite.modification.dto.ModificationInfos;
 import org.gridsuite.modification.server.dto.ModificationApplicationGroup;
 import org.gridsuite.modification.server.dto.NetworkModificationResult;
+import org.gridsuite.modification.server.dto.NetworkModificationsResult;
 import org.gridsuite.modification.server.utils.ModificationCreation;
 import org.gridsuite.modification.server.utils.NetworkCreation;
 import org.junit.jupiter.api.BeforeEach;
@@ -24,6 +25,7 @@
 import org.springframework.http.MediaType;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 
 import static com.vladmihalcea.sql.SQLStatementCountValidator.assertSelectCount;
@@ -40,19 +42,25 @@
 @Tag("IntegrationTest")
 class CompositeModificationsTest extends AbstractNetworkModificationTest {
 
+    // TODO We try to create a Composite Modification using the generic way like any other modification.
+    // But a Composite Modification should be created using a dedicated endpoint, so maybe this test is not relevant?
+
     @MockBean
     private NetworkModificationApplicator networkModificationApplicator;
 
     @BeforeEach
     void specificSetUp() {
         // Currently we never apply composite modifications (apply mocked)
-        NetworkModificationResult networkModificationResultMock = NetworkModificationResult.builder()
+        NetworkModificationResult result = NetworkModificationResult.builder()
                 .applicationStatus(NetworkModificationResult.ApplicationStatus.ALL_OK)
                 .lastGroupApplicationStatus(NetworkModificationResult.ApplicationStatus.ALL_OK)
                 .networkImpacts(List.of())
                 .build();
         when(networkModificationApplicator.applyModifications(any(ModificationApplicationGroup.class), any()))
-                .then((Answer<NetworkModificationResult>) invocation -> networkModificationResultMock);
+                .then((Answer<NetworkModificationResult>) invocation -> result);
+        when(networkModificationApplicator.applyNewNetworkModification(any(UUID.class), any(UUID.class), any()))
+                .then((Answer<NetworkModificationsResult>) invocation ->
+                        new NetworkModificationsResult(List.of(UUID.randomUUID()), List.of(Optional.of(result))));
     }
 
     @Override