import study

src/main/java/org/gridsuite/study/server/controller/StudyController.java

@@ -18,11 +18,13 @@
 import org.gridsuite.filter.utils.EquipmentType;
 import org.gridsuite.study.server.StudyApi;
 import org.gridsuite.study.server.dto.*;
+import org.gridsuite.study.server.dto.caseimport.CaseImportAction;
 import org.gridsuite.study.server.dto.elasticsearch.EquipmentInfos;
 import org.gridsuite.study.server.dto.modification.*;
 import org.gridsuite.study.server.dto.networkexport.ExportNetworkStatus;
 import org.gridsuite.study.server.dto.networkexport.NodeExportInfos;
 import org.gridsuite.study.server.dto.sequence.NodeSequenceType;
+import org.gridsuite.study.server.dto.studyexport.TreeExportInfos;
 import org.gridsuite.study.server.elasticsearch.EquipmentInfosService;
 import org.gridsuite.study.server.error.StudyException;
 import org.gridsuite.study.server.exception.PartialResultException;
@@ -62,6 +64,7 @@ public class StudyController {
     private final RootNetworkService rootNetworkService;
     private final RebuildNodeService rebuildNodeService;
     private final StudyExportService studyExportService;
+    private final StudyImportService studyImportService;
 
     public StudyController(StudyService studyService,
                            NetworkService networkStoreService,
@@ -72,7 +75,8 @@ public StudyController(StudyService studyService,
                            RemoteServicesInspector remoteServicesInspector,
                            RootNetworkService rootNetworkService,
                            RebuildNodeService rebuildNodeService,
-                           StudyExportService studyExportService) {
+                           StudyExportService studyExportService,
+                           StudyImportService studyImportService) {
         this.studyService = studyService;
         this.networkModificationTreeService = networkModificationTreeService;
         this.networkStoreService = networkStoreService;
@@ -83,6 +87,7 @@ public StudyController(StudyService studyService,
         this.rootNetworkService = rootNetworkService;
         this.rebuildNodeService = rebuildNodeService;
         this.studyExportService = studyExportService;
+        this.studyImportService = studyImportService;
     }
 
     @InitBinder
@@ -175,7 +180,8 @@ public ResponseEntity<List<BasicRootNetworkInfos>> getRootNetworks(@PathVariable
     public ResponseEntity<RootNetworkRequestInfos> createRootNetwork(@PathVariable("studyUuid") UUID studyUuid,
                                                                      @RequestBody RootNetworkInfos rootNetworkInfos,
                                                                      @RequestHeader(HEADER_USER_ID) String userId) {
-        return ResponseEntity.ok().body(studyService.createRootNetworkRequest(studyUuid, rootNetworkInfos, userId));
+        rootNetworkInfos.setId(null);
+        return ResponseEntity.ok().body(studyService.createRootNetworkRequest(studyUuid, rootNetworkInfos, userId, CaseImportAction.ROOT_NETWORK_CREATION));
     }
 
     @PutMapping(value = "/studies/{studyUuid}/root-networks/{rootNetworkUuid}")
@@ -1615,4 +1621,13 @@ public ResponseEntity<Resource> exportStudy(@PathVariable("studyUuid") UUID stud
         headers.setContentType(MediaType.parseMediaType("application/zip"));
         return ResponseEntity.ok().headers(headers).body(studyExportService.exportStudy(studyUuid, userId));
     }
+
+    @PostMapping(value = "/studies/import")
+    @Operation(summary = "Create a study and its root networks from a previously exported study archive")
+    @ApiResponse(responseCode = "200", description = "Study import initiated successfully")
+    public ResponseEntity<Void> importStudyWithCaseImportAction(@RequestBody TreeExportInfos treeExportInfos,
+                                                                @RequestHeader(HEADER_USER_ID) String userId) {
+        studyImportService.importStudyWithCaseImportAction(treeExportInfos, userId);
+        return ResponseEntity.ok().build();
+    }
 }

src/main/java/org/gridsuite/study/server/dto/caseimport/CaseImportAction.java

@@ -11,6 +11,7 @@
 public enum CaseImportAction {
     STUDY_CREATION("Study creation"),
     ROOT_NETWORK_CREATION("Root network creation"),
+    ROOT_NETWORK_CREATION_FOR_STUDY_IMPORT("Root network creation for study import"),
     NETWORK_RECREATION("Network recreation"),
     ROOT_NETWORK_MODIFICATION("Root network modification");
 

src/main/java/org/gridsuite/study/server/repository/StudyEntity.java

@@ -13,6 +13,7 @@
 import org.gridsuite.study.server.repository.voltageinit.StudyVoltageInitParametersEntity;
 
 import java.util.*;
+import java.util.stream.Collectors;
 
 /**
  * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
@@ -36,6 +37,18 @@ public class StudyEntity extends AbstractManuallyAssignedIdentifierEntity<UUID>
     @Builder.Default
     private List<RootNetworkEntity> rootNetworks = new ArrayList<>();
 
+    /**
+     * Desired order of root network ids for an in-progress batch import (they can complete out of order).
+     * Used by {@link #addRootNetwork(RootNetworkEntity)} to place each one correctly; cleared once done.
+     */
+    @ElementCollection
+    @CollectionTable(name = "StudyRootNetworkOrder", foreignKey = @ForeignKey(
+            name = "study_root_network_order_fk"
+        ))
+    @OrderColumn(name = "index")
+    @Column(name = "rootNetworkUuid")
+    private List<UUID> rootNetworkOrder;
+
     /**
      * @deprecated to remove when the data is migrated into the loadflow-server
      */
@@ -140,7 +153,21 @@ public RootNetworkEntity getFirstRootNetwork() {
     public void addRootNetwork(RootNetworkEntity rootNetworkEntity) {
         rootNetworkEntity.setStudy(this);
         rootNetworkEntity.setIndexationStatus(RootNetworkIndexationStatus.INDEXED);
-        rootNetworks.add(rootNetworkEntity);
+        rootNetworks.add(resolveInsertPosition(rootNetworkEntity.getId()), rootNetworkEntity);
+    }
+
+    /**
+     * Position among the root networks already present, for the given target id: the count of ids that
+     * should come before it in {@link #rootNetworkOrder} and are already in {@link #rootNetworks}. Falls back
+     * to appending at the end when there is no pending import batch, or the id isn't part of one.
+     */
+    private int resolveInsertPosition(UUID rootNetworkId) {
+        int targetPos = rootNetworkOrder == null ? -1 : rootNetworkOrder.indexOf(rootNetworkId);
+        if (targetPos < 0) {
+            return rootNetworks.size();
+        }
+        Set<UUID> alreadyPresent = rootNetworks.stream().map(RootNetworkEntity::getId).collect(Collectors.toSet());
+        return (int) rootNetworkOrder.subList(0, targetPos).stream().filter(alreadyPresent::contains).count();
     }
 
     public void deleteRootNetworks(Set<UUID> uuids) {

src/main/java/org/gridsuite/study/server/repository/StudyRepository.java

@@ -20,6 +20,6 @@
 
 @Repository
 public interface StudyRepository extends JpaRepository<StudyEntity, UUID> {
-    @EntityGraph(attributePaths = {"rootNetworks"}, type = EntityGraph.EntityGraphType.LOAD)
+    @EntityGraph(attributePaths = {"rootNetworks", "rootNetworkOrder"}, type = EntityGraph.EntityGraphType.LOAD)
     Optional<StudyEntity> findWithRootNetworksById(UUID id);
 }

src/main/java/org/gridsuite/study/server/repository/rootnetwork/RootNetworkRequestRepository.java

@@ -6,6 +6,7 @@
  */
 package org.gridsuite.study.server.repository.rootnetwork;
 
+import org.gridsuite.study.server.dto.RootNetworkAction;
 import org.springframework.data.jpa.repository.JpaRepository;
 
 import java.util.List;
@@ -17,6 +18,8 @@ public interface RootNetworkRequestRepository extends JpaRepository<RootNetworkR
 
     int countAllByStudyUuid(UUID studyUuid);
 
+    int countAllByStudyUuidAndActionRequest(UUID studyUuid, RootNetworkAction actionRequest);
+
     Optional<RootNetworkRequestRepository> findByNameAndStudyUuid(String name, UUID studyUuid);
 
     Optional<RootNetworkRequestRepository> findByTagAndStudyUuid(String tag, UUID studyUuid);

src/main/java/org/gridsuite/study/server/service/CaseService.java

@@ -16,12 +16,16 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
+import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
-import org.springframework.http.ResponseEntity;
+import org.springframework.http.client.ClientHttpResponse;
 import org.springframework.stereotype.Service;
+import org.springframework.web.client.ResourceAccessException;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.util.UriComponentsBuilder;
 
+import java.io.IOException;
+import java.io.InputStream;
 import java.util.UUID;
 
 import static org.gridsuite.study.server.StudyConstants.CASE_API_VERSION;
@@ -96,11 +100,26 @@ public UUID createCase(String caseKey, String contentType) {
         return restTemplate.exchange(caseServerBaseUri + path, HttpMethod.POST, null, UUID.class).getBody();
     }
 
-    public ResponseEntity<byte[]> getCaseContent(UUID caseUuid) {
+    public void streamCaseContent(UUID caseUuid, CaseContentHandler handler) throws IOException {
         String path = UriComponentsBuilder.fromPath(DELIMITER + CASE_API_VERSION + "/cases/{caseUuid}")
                 .buildAndExpand(caseUuid)
                 .toUriString();
 
-        return restTemplate.exchange(caseServerBaseUri + path, HttpMethod.GET, null, byte[].class);
+        try {
+            restTemplate.execute(caseServerBaseUri + path, HttpMethod.GET, null, (ClientHttpResponse response) -> {
+                handler.handle(response.getHeaders().getFirst(HttpHeaders.CONTENT_ENCODING), response.getBody());
+                return null;
+            });
+        } catch (ResourceAccessException e) {
+            if (e.getCause() instanceof IOException ioException) {
+                throw ioException;
+            }
+            throw e;
+        }
+    }
+
+    @FunctionalInterface
+    public interface CaseContentHandler {
+        void handle(String contentEncoding, InputStream body) throws IOException;
     }
 }

src/main/java/org/gridsuite/study/server/service/ConsumerService.java

@@ -66,10 +66,10 @@
 
     private final NotificationService notificationService;
     private final StudyService studyService;
+    private final StudyImportService studyImportService;
     private final CaseService caseService;
     private final LoadFlowRestService loadFlowRestService;
     private final NetworkModificationTreeService networkModificationTreeService;
-    private final StudyConfigService studyConfigService;
     private final RootNetworkNodeInfoService rootNetworkNodeInfoService;
     private final DirectoryService directoryService;
     private final ComputationParametersService computationParametersService;
@@ -79,10 +79,10 @@
     public ConsumerService(ObjectMapper objectMapper,
                            NotificationService notificationService,
                            StudyService studyService,
+                           StudyImportService studyImportService,
                            CaseService caseService,
                            LoadFlowRestService loadFlowRestService,
                            NetworkModificationTreeService networkModificationTreeService,
-                           StudyConfigService studyConfigService,
                            RootNetworkNodeInfoService rootNetworkNodeInfoService,
                            DirectoryService directoryService,
                            ComputationParametersService computationParametersService,
@@ -91,10 +91,10 @@
         this.objectMapper = objectMapper;
         this.notificationService = notificationService;
         this.studyService = studyService;
+        this.studyImportService = studyImportService;
         this.caseService = caseService;
         this.loadFlowRestService = loadFlowRestService;
         this.networkModificationTreeService = networkModificationTreeService;
-        this.studyConfigService = studyConfigService;
         this.rootNetworkNodeInfoService = rootNetworkNodeInfoService;
         this.directoryService = directoryService;
         this.computationParametersService = computationParametersService;
@@ -250,6 +250,20 @@
                     .networkInfos(networkInfos)
                     .importParameters(importParameters)
                     .build());
+                case ROOT_NETWORK_CREATION_FOR_STUDY_IMPORT -> {
+                    try {
+                        studyService.createRootNetwork(studyUuid, RootNetworkInfos.builder()
+                            .id(rootNetworkUuid)
+                            .caseInfos(caseInfos)
+                            .reportUuid(importReportUuid)
+                            .networkInfos(networkInfos)
+                            .importParameters(importParameters)
+                            .build());
+                    } finally {
+                        studyService.deleteRootNetworkRequest(rootNetworkUuid);
+                        studyImportService.checkFinishedStudyImport(studyUuid, userId);
+                    }
+                }
                 case NETWORK_RECREATION -> studyService.updateNetwork(studyUuid, rootNetworkUuid, networkInfos, userId);
                 case ROOT_NETWORK_MODIFICATION -> studyService.modifyRootNetwork(studyUuid, RootNetworkInfos.builder()
                     .id(rootNetworkUuid)
@@ -281,73 +295,15 @@
         UserProfileInfos userProfileInfos = studyService.getUserProfile(userId);
 
         ComputationParameterUUIDs computationParameterUUIDs = computationParametersService.createDefaultComputationParameters(userId, userProfileInfos);
-        UUID networkVisualizationParametersUuid = createDefaultNetworkVisualizationParameters(userId, userProfileInfos);
-        UUID spreadsheetConfigCollectionUuid = createDefaultSpreadsheetConfigCollection(userId, userProfileInfos);
-        UUID workspacesConfigUuid = createWorkspacesConfig(userProfileInfos);
+        UUID networkVisualizationParametersUuid = studyService.createDefaultNetworkVisualizationParameters(userId, userProfileInfos);
+        UUID spreadsheetConfigCollectionUuid = studyService.createDefaultSpreadsheetConfigCollection(userId, userProfileInfos);
+        UUID workspacesConfigUuid = studyService.createWorkspacesConfig(userProfileInfos);
 
         studyService.insertStudy(studyUuid, userId, networkInfos, caseInfos, computationParameterUUIDs,
             networkVisualizationParametersUuid, spreadsheetConfigCollectionUuid, workspacesConfigUuid,
             importParameters, importReportUuid);
     }
 
-    private UUID createDefaultNetworkVisualizationParameters(String userId, UserProfileInfos userProfileInfos) {
-        if (userProfileInfos != null && userProfileInfos.getNetworkVisualizationParameterId() != null) {
-            // try to access/duplicate the user profile network visualization parameters
-            try {
-                return studyConfigService.duplicateNetworkVisualizationParameters(userProfileInfos.getNetworkVisualizationParameterId());
-            } catch (Exception e) {
-                // TODO try to report a log in Root subreporter ?
-                LOGGER.error(String.format("Could not duplicate network visualization parameters with id '%s' from user/profile '%s/%s'. Using default parameters",
-                    userProfileInfos.getNetworkVisualizationParameterId(), userId, userProfileInfos.getName()), e);
-            }
-        }
-        // no profile, or no/bad network visualization parameters in profile => use default values
-        try {
-            return studyConfigService.createDefaultNetworkVisualizationParameters();
-        } catch (final Exception e) {
-            LOGGER.error("Error while creating network visualization default parameters", e);
-            return null;
-        }
-    }
-
-    private UUID createDefaultSpreadsheetConfigCollection(String userId, UserProfileInfos userProfileInfos) {
-        if (userProfileInfos != null && userProfileInfos.getSpreadsheetConfigCollectionId() != null) {
-            // try to access/duplicate the user profile spreadsheet config collection
-            try {
-                return studyConfigService.duplicateSpreadsheetConfigCollection(userProfileInfos.getSpreadsheetConfigCollectionId());
-            } catch (Exception e) {
-                // TODO try to report a log in Root subreporter ?
-                LOGGER.error(String.format("Could not duplicate spreadsheet config collection with id '%s' from user/profile '%s/%s'. Using default spreadsheet config collection",
-                    userProfileInfos.getSpreadsheetConfigCollectionId(), userId, userProfileInfos.getName()), e);
-            }
-        }
-        // no profile, or no/bad spreadsheet config collection in profile => use default values
-        try {
-            return studyConfigService.createDefaultSpreadsheetConfigCollection();
-        } catch (final Exception e) {
-            LOGGER.error("Error while creating default spreadsheet config collection", e);
-            return null;
-        }
-    }
-
-    @SuppressWarnings("checkstyle:LambdaBodyLength")
-    private UUID createWorkspacesConfig(UserProfileInfos userProfileInfos) {
-        try {
-            List<UUID> workspaceIds = new ArrayList<>();
-            if (userProfileInfos != null && userProfileInfos.getWorkspaceId() != null) {
-                // Create config with profile workspace as first, and two empty workspaces
-                workspaceIds.add(userProfileInfos.getWorkspaceId());
-                workspaceIds.add(null);
-                workspaceIds.add(null);
-            }
-            // Empty list will create default config
-            return studyConfigService.createWorkspacesConfigFromWorkspaces(workspaceIds);
-        } catch (final Exception e) {
-            LOGGER.error("Error while creating workspace collection", e);
-            return null;
-        }
-    }
-
     @Bean
     @SuppressWarnings("checkstyle:LambdaBodyLength")
     public Consumer<Message<String>> consumeCaseImportFailed() {
@@ -364,14 +320,19 @@
                     String userId = receiver.getUserId();
                     UUID rootNetworkUuid = receiver.getRootNetworkUuid();
 
-                    if (receiver.getCaseImportAction() == CaseImportAction.STUDY_CREATION) {
+                    CaseImportAction caseImportAction = receiver.getCaseImportAction();
+                    if (caseImportAction == CaseImportAction.STUDY_CREATION) {
                         studyService.deleteStudyIfNotCreationInProgress(studyUuid, userId);
                         notificationService.emitStudyCreationError(studyUuid, userId, errorMessage);
                     } else {
-                        if (receiver.getCaseImportAction() == CaseImportAction.ROOT_NETWORK_CREATION) {
+                        if (caseImportAction == CaseImportAction.ROOT_NETWORK_CREATION) {
+                            studyService.deleteRootNetworkRequest(rootNetworkUuid);
+                        } else if (caseImportAction == CaseImportAction.ROOT_NETWORK_CREATION_FOR_STUDY_IMPORT) {
                             studyService.deleteRootNetworkRequest(rootNetworkUuid);
+                            studyImportService.checkFinishedStudyImport(studyUuid, userId);
+                        } else {
+                            notificationService.emitRootNetworksUpdateFailed(studyUuid, errorMessage);
                         }
-                        notificationService.emitRootNetworksUpdateFailed(studyUuid, errorMessage);
                     }
                 } catch (Exception e) {
                     LOGGER.error(e.toString(), e);

src/main/java/org/gridsuite/study/server/service/RootNetworkService.java

@@ -280,6 +280,10 @@ public List<RootNetworkRequestEntity> geRootNetworkRequests(UUID studyUuid) {
         return rootNetworkRequestRepository.findAllByStudyUuid(studyUuid);
     }
 
+    public int countRootNetworkCreationRequests(UUID studyUuid) {
+        return rootNetworkRequestRepository.countAllByStudyUuidAndActionRequest(studyUuid, RootNetworkAction.ROOT_NETWORK_CREATION);
+    }
+
     public void deleteRootNetworkRequest(RootNetworkRequestEntity rootNetworkRequestEntity) {
         rootNetworkRequestRepository.delete(rootNetworkRequestEntity);
     }