No longer block the tomcat thread when waiting for import or export (servlet 3.0+ AsyncContext)

Add no timeout configuration to behave like before this change

Spring forces us to adapt the tests with boilerplate code (asyncStarted() and asyncDispatch()) as per
https://docs.spring.io/spring-framework/reference/testing/mockmvc/hamcrest/async-requests.html
to mimic the servlet 3.0 redispatch
Add more andReturn and assignement to variables to avoid potential mistakes
The two mvc result represent the same request, inside they hold the same request/response
objects, but some other fields are different (asyncResult for example) and tests may
be unreliable if they use the first one (representing the state before the async split)

Author: jonenst

src/main/java/org/gridsuite/modification/server/NetworkModificationController.java

@@ -26,6 +26,7 @@
 import java.util.Map;
 import java.util.Set;
 import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
 
 /**
  * @author Franck Lecuyer <franck.lecuyer at rte-france.com>
@@ -88,24 +89,24 @@ public ResponseEntity<Map<UUID, UUID>> duplicateGroup(@RequestParam("groupUuid")
     @PutMapping(value = "/groups/{groupUuid}", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
     @Operation(summary = "For a list of network modifications passed in body, Move them before another one or at the end of the list, or Duplicate them at the end of the list, or Insert them (composite) at the end of the list")
     @ApiResponse(responseCode = "200", description = "The modification list of the group has been updated.")
-    public ResponseEntity<NetworkModificationsResult> handleNetworkModifications(@Parameter(description = "updated group UUID, where modifications are pasted") @PathVariable("groupUuid") UUID targetGroupUuid,
+    public CompletableFuture<ResponseEntity<NetworkModificationsResult>> handleNetworkModifications(@Parameter(description = "updated group UUID, where modifications are pasted") @PathVariable("groupUuid") UUID targetGroupUuid,
                                                                                                 @Parameter(description = "kind of modification", required = true) @RequestParam(value = "action") GroupModificationAction action,
                                                                                                 @Parameter(description = "the modification Uuid to move before (MOVE option, empty means moving at the end)") @RequestParam(value = "before", required = false) UUID beforeModificationUuid,
                                                                                                 @Parameter(description = "origin group UUID, where modifications are copied or cut") @RequestParam(value = "originGroupUuid", required = false) UUID originGroupUuid,
                                                                                                 @Parameter(description = "modifications can be applied (default is true)") @RequestParam(value = "build", required = false, defaultValue = "true") Boolean canApply,
                                                                                                 @RequestBody Pair<List<UUID>, List<ModificationApplicationContext>> modificationContextInfos) {
         return switch (action) {
             case COPY ->
-                ResponseEntity.ok().body(networkModificationService.duplicateModifications(targetGroupUuid, originGroupUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond()));
+                networkModificationService.duplicateModifications(targetGroupUuid, originGroupUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond()).thenApply(ResponseEntity.ok()::body);
             case INSERT ->
-                ResponseEntity.ok().body(networkModificationService.insertCompositeModifications(targetGroupUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond()));
+                networkModificationService.insertCompositeModifications(targetGroupUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond()).thenApply(ResponseEntity.ok()::body);
             case MOVE -> {
                 UUID sourceGroupUuid = originGroupUuid == null ? targetGroupUuid : originGroupUuid;
                 boolean applyModifications = canApply;
                 if (sourceGroupUuid.equals(targetGroupUuid)) {
                     applyModifications = false;
                 }
-                yield ResponseEntity.ok().body(networkModificationService.moveModifications(targetGroupUuid, sourceGroupUuid, beforeModificationUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond(), applyModifications));
+                yield networkModificationService.moveModifications(targetGroupUuid, sourceGroupUuid, beforeModificationUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond(), applyModifications).thenApply(ResponseEntity.ok()::body);
             }
         };
     }
@@ -131,11 +132,11 @@ public ResponseEntity<List<UUID>> getModificationGroups() {
     @ApiResponses(value = {
         @ApiResponse(responseCode = "200", description = "The network modification was created"),
         @ApiResponse(responseCode = "404", description = "The network or equipment was not found")})
-    public ResponseEntity<NetworkModificationsResult> createNetworkModification(
+    public CompletableFuture<ResponseEntity<NetworkModificationsResult>> createNetworkModification(
         @Parameter(description = "Group UUID") @RequestParam(name = "groupUuid") UUID groupUuid,
         @RequestBody Pair<ModificationInfos, List<ModificationApplicationContext>> modificationContextInfos) {
         modificationContextInfos.getFirst().check();
-        return ResponseEntity.ok().body(networkModificationService.createNetworkModification(groupUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond()));
+        return networkModificationService.createNetworkModification(groupUuid, modificationContextInfos.getFirst(), modificationContextInfos.getSecond()).thenApply(ResponseEntity.ok()::body);
     }
 
     @PutMapping(value = "/network-modifications/{uuid}", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)

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

@@ -35,6 +35,7 @@
 
 import java.util.List;
 import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
 
 import static org.gridsuite.modification.server.report.NetworkModificationServerReportResourceBundle.ERROR_MESSAGE_KEY;
 
@@ -92,7 +93,7 @@ public NetworkModificationApplicator(NetworkStoreService networkStoreService, Eq
      * medium : preloadingStrategy = COLLECTION
      * large : preloadingStrategy = ALL_COLLECTIONS_NEEDED_FOR_BUS_VIEW
      */
-    public NetworkModificationResult applyModifications(ModificationApplicationGroup modificationInfosGroup, NetworkInfos networkInfos) {
+    public CompletableFuture<NetworkModificationResult> applyModifications(ModificationApplicationGroup modificationInfosGroup, NetworkInfos networkInfos) {
         PreloadingStrategy preloadingStrategy = modificationInfosGroup.modifications().stream()
             .map(ModificationEntity::getType)
             .map(ModificationType::valueOf)
@@ -103,13 +104,16 @@ public NetworkModificationResult applyModifications(ModificationApplicationGroup
         NetworkStoreListener listener = NetworkStoreListener.create(networkInfos.getNetwork(), networkInfos.getNetworkUuuid(), networkStoreService, equipmentInfosService, applicationInfosService, collectionThreshold);
         if (preloadingStrategy == PreloadingStrategy.ALL_COLLECTIONS_NEEDED_FOR_BUS_VIEW) {
             return largeNetworkModificationExecutionService
-                .supplyAsync(() -> applyAndFlush(modificationInfosGroup, listener))
-                .join();
+                .supplyAsync(() -> applyAndFlush(modificationInfosGroup, listener));
         } else {
-            return applyAndFlush(modificationInfosGroup, listener);
+            return CompletableFuture.completedFuture(applyAndFlush(modificationInfosGroup, listener));
         }
     }
 
+    public NetworkModificationResult applyModificationsBlocking(ModificationApplicationGroup modificationInfosGroup, NetworkInfos networkInfos) {
+        return this.applyModifications(modificationInfosGroup, networkInfos).join();
+    }
+
     private NetworkModificationResult applyAndFlush(ModificationApplicationGroup modificationInfosGroup,
             NetworkStoreListener listener) {
         ApplicationStatus groupApplicationStatus = apply(modificationInfosGroup, listener);
@@ -134,7 +138,7 @@ private NetworkModificationResult flushModificationApplications(ApplicationStatu
      * Note : it is possible that the rabbitmq consumer threads here will be blocked by modifications applied directly in the other applyModifications method
      * and no more builds can go through. If this causes problems we should put them in separate rabbitmq queues.
      */
-    public NetworkModificationResult applyModifications(List<ModificationApplicationGroup> modificationInfosGroups, NetworkInfos networkInfos) {
+    public CompletableFuture<NetworkModificationResult> applyModifications(List<ModificationApplicationGroup> modificationInfosGroups, NetworkInfos networkInfos) {
         PreloadingStrategy preloadingStrategy = modificationInfosGroups.stream()
                 .map(ModificationApplicationGroup::modifications)
                 .flatMap(List::stream)
@@ -147,13 +151,26 @@ public NetworkModificationResult applyModifications(List<ModificationApplication
         NetworkStoreListener listener = NetworkStoreListener.create(networkInfos.getNetwork(), networkInfos.getNetworkUuuid(), networkStoreService, equipmentInfosService, applicationInfosService, collectionThreshold);
         if (preloadingStrategy == PreloadingStrategy.ALL_COLLECTIONS_NEEDED_FOR_BUS_VIEW) {
             return largeNetworkModificationExecutionService
+<<<<<<< HEAD
                 .supplyAsync(() -> applyAndFlush(modificationInfosGroups, listener))
                 .join();
         } else {
             return applyAndFlush(modificationInfosGroups, listener);
         }
     }
 
+=======
+                .supplyAsync(() -> applyAndFlush(modificationInfosGroups, listener));
+        } else {
+            return CompletableFuture.completedFuture(applyAndFlush(modificationInfosGroups, listener));
+        }
+    }
+
+    public NetworkModificationResult applyModificationsBlocking(List<ModificationApplicationGroup> modificationInfosGroups, NetworkInfos networkInfos) {
+        return this.applyModifications(modificationInfosGroups, networkInfos).join();
+    }
+
+>>>>>>> 5afdbb38 (No longer block the tomcat thread when waiting for import or export (servlet 3.0+ AsyncContext))
     private NetworkModificationResult applyAndFlush(List<ModificationApplicationGroup> modificationInfosGroups,
             NetworkStoreListener listener) {
         List<ApplicationStatus> groupsApplicationStatuses = apply(modificationInfosGroups, listener);

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

@@ -84,7 +84,8 @@ private CompletableFuture<NetworkModificationResult> execBuildVariant(BuildExecC
 
             CompletableFuture<NetworkModificationResult> future = CompletableFuture.supplyAsync(() -> {
                     LOGGER.info("Starting build on variant : {}", buildInfos.getDestinationVariantId());
-                    return networkModificationService.buildVariant(networkUuid, buildInfos);
+                    // TODO avoid blocking the forkjoinpool commonpool when we are using our own executor
+                    return networkModificationService.buildVariantBlocking(networkUuid, buildInfos);
                 }
             );