Add root network's original case uuid (#798)

ayolab · web-flow · commit 2090a1977dc0 · 2025-07-11T17:01:17.000+02:00
Signed-off-by: Ayoub LABIDI &lt;ayoub.labidi@protonmail.com&gt;
diff --git a/src/main/java/org/gridsuite/study/server/controller/StudyController.java b/src/main/java/org/gridsuite/study/server/controller/StudyController.java
@@ -223,7 +223,7 @@ public ResponseEntity<Void> updateRootNetwork(@PathVariable("studyUuid") UUID st
             .id(rootNetworkUuid)
             .name(name)
             // .importParameters(importParameters) CANNOT BE PLACED IN DTO (not same type)
-            .caseInfos(new CaseInfos(caseUuid, null, caseFormat))
+            .caseInfos(new CaseInfos(caseUuid, null, null, caseFormat))
             .tag(tag)
             .build();
         // then pass importParameters separately
diff --git a/src/main/java/org/gridsuite/study/server/dto/BasicRootNetworkInfos.java b/src/main/java/org/gridsuite/study/server/dto/BasicRootNetworkInfos.java
@@ -2,4 +2,4 @@
 
 import java.util.UUID;
 
-public record BasicRootNetworkInfos(UUID rootNetworkUuid, String name, String tag, boolean isCreating) { }
+public record BasicRootNetworkInfos(UUID rootNetworkUuid, UUID originalCaseUuid, String name, String tag, boolean isCreating) { }
diff --git a/src/main/java/org/gridsuite/study/server/dto/CaseInfos.java b/src/main/java/org/gridsuite/study/server/dto/CaseInfos.java
@@ -21,6 +21,8 @@
 public class CaseInfos {
     private UUID caseUuid;
 
+    private UUID originalCaseUuid;
+
     private String caseName;
 
     private String caseFormat;
diff --git a/src/main/java/org/gridsuite/study/server/dto/RootNetworkCreationInfos.java b/src/main/java/org/gridsuite/study/server/dto/RootNetworkCreationInfos.java
@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.gridsuite.study.server.dto;
+
+import java.util.UUID;
+
+public record RootNetworkCreationInfos(
+    UUID caseUuid,
+    UUID originalCaseUuid,
+    UUID studyUuid,
+    UUID rootNetworkUuid,
+    String caseFormat
+) { }
+
diff --git a/src/main/java/org/gridsuite/study/server/dto/RootNetworkInfos.java b/src/main/java/org/gridsuite/study/server/dto/RootNetworkInfos.java
@@ -37,6 +37,7 @@ public RootNetworkEntity toEntity() {
             .networkUuid(networkInfos.getNetworkUuid())
             .networkId(networkInfos.getNetworkId())
             .caseUuid(caseInfos.getCaseUuid())
+            .originalCaseUuid(caseInfos.getOriginalCaseUuid())
             .caseName(caseInfos.getCaseName())
             .caseFormat(caseInfos.getCaseFormat())
             .reportUuid(reportUuid)
diff --git a/src/main/java/org/gridsuite/study/server/dto/caseimport/CaseImportReceiver.java b/src/main/java/org/gridsuite/study/server/dto/caseimport/CaseImportReceiver.java
@@ -24,6 +24,7 @@ public class CaseImportReceiver {
     private UUID studyUuid;
     private UUID rootNetworkUuid;
     private UUID caseUuid;
+    private UUID originalCaseUuid;
     private UUID reportUuid;
     private String userId;
     private Long startTime;
diff --git a/src/main/java/org/gridsuite/study/server/repository/rootnetwork/RootNetworkEntity.java b/src/main/java/org/gridsuite/study/server/repository/rootnetwork/RootNetworkEntity.java
@@ -61,6 +61,9 @@ public class RootNetworkEntity {
     @Column(name = "caseUuid", nullable = false)
     private UUID caseUuid;
 
+    @Column(name = "originalCaseUuid")
+    private UUID originalCaseUuid;
+
     @Column(name = "caseName", nullable = false)
     private String caseName;
 
@@ -88,7 +91,7 @@ public RootNetworkInfos toDto() {
             .name(this.name)
             .networkInfos(new NetworkInfos(this.networkUuid, this.networkId))
             .importParameters(this.importParameters)
-            .caseInfos(new CaseInfos(this.caseUuid, this.caseName, this.caseFormat))
+            .caseInfos(new CaseInfos(this.caseUuid, this.originalCaseUuid, this.caseName, this.caseFormat))
             .reportUuid(this.reportUuid)
             .tag(tag)
             .build();
@@ -99,6 +102,6 @@ public RootNetworkInfos toDto() {
     }
 
     public BasicRootNetworkInfos toBasicDto() {
-        return new BasicRootNetworkInfos(getId(), getName(), getTag(), false);
+        return new BasicRootNetworkInfos(getId(), getOriginalCaseUuid(), getName(), getTag(), false);
     }
 }
diff --git a/src/main/java/org/gridsuite/study/server/repository/rootnetwork/RootNetworkRequestEntity.java b/src/main/java/org/gridsuite/study/server/repository/rootnetwork/RootNetworkRequestEntity.java
@@ -47,6 +47,6 @@ public RootNetworkRequestInfos toDto() {
     }
 
     public BasicRootNetworkInfos toBasicDto() {
-        return new BasicRootNetworkInfos(getId(), getName(), getTag(), true);
+        return new BasicRootNetworkInfos(getId(), null, getName(), getTag(), true);
     }
 }
diff --git a/src/main/java/org/gridsuite/study/server/service/ConsumerService.java b/src/main/java/org/gridsuite/study/server/service/ConsumerService.java
@@ -234,7 +234,7 @@ public Consumer<Message<String>> consumeCaseImportSucceeded() {
                 UUID rootNetworkUuid = receiver.getRootNetworkUuid();
                 CaseImportAction caseImportAction = receiver.getCaseImportAction();
 
-                CaseInfos caseInfos = new CaseInfos(caseUuid, caseName, caseFormat);
+                CaseInfos caseInfos = new CaseInfos(caseUuid, receiver.getOriginalCaseUuid(), caseName, caseFormat);
                 NetworkInfos networkInfos = new NetworkInfos(networkUuid, networkId);
                 try {
                     switch (caseImportAction) {
diff --git a/src/main/java/org/gridsuite/study/server/service/NetworkConversionService.java b/src/main/java/org/gridsuite/study/server/service/NetworkConversionService.java
@@ -18,6 +18,7 @@
 import jakarta.servlet.http.HttpServletResponse;
 
 import org.apache.commons.lang3.StringUtils;
+import org.gridsuite.study.server.dto.RootNetworkCreationInfos;
 import org.gridsuite.study.server.dto.caseimport.CaseImportAction;
 import org.gridsuite.study.server.dto.caseimport.CaseImportReceiver;
 import org.gridsuite.study.server.StudyException;
@@ -64,23 +65,22 @@ public NetworkConversionService(@Value("${powsybl.services.network-conversion-se
      * - one variant for root node - INITIAL_VARIANT
      * - one variant cloned from the previous one for the 1st node - *variantId*
      */
-    public void persistNetwork(UUID caseUuid, UUID studyUuid, UUID rootNetworkUuid, String variantId, String userId, UUID importReportUuid, String caseFormat, Map<String, Object> importParameters, CaseImportAction caseImportAction) {
+    public void persistNetwork(RootNetworkCreationInfos rootNetworkCreationInfos, String variantId, String userId, UUID importReportUuid, Map<String, Object> importParameters, CaseImportAction caseImportAction) {
         String receiver;
         try {
             receiver = URLEncoder.encode(objectMapper.writeValueAsString(
-                        new CaseImportReceiver(studyUuid, rootNetworkUuid, caseUuid, importReportUuid, userId, System.nanoTime(), caseImportAction
-                    )),
-                    StandardCharsets.UTF_8);
+                        new CaseImportReceiver(rootNetworkCreationInfos.studyUuid(), rootNetworkCreationInfos.rootNetworkUuid(), rootNetworkCreationInfos.caseUuid(), rootNetworkCreationInfos.originalCaseUuid(), importReportUuid, userId, System.nanoTime(), caseImportAction
+                    )), StandardCharsets.UTF_8);
         } catch (JsonProcessingException e) {
             throw new UncheckedIOException(e);
         }
 
         UriComponentsBuilder builder = UriComponentsBuilder.fromPath(DELIMITER + NETWORK_CONVERSION_API_VERSION + "/networks")
-            .queryParam(CASE_UUID, caseUuid)
+            .queryParam(CASE_UUID, rootNetworkCreationInfos.caseUuid())
             .queryParamIfPresent(QUERY_PARAM_VARIANT_ID, Optional.ofNullable(variantId))
             .queryParam(REPORT_UUID, importReportUuid)
             .queryParam(QUERY_PARAM_RECEIVER, receiver)
-            .queryParam(CASE_FORMAT, caseFormat);
+            .queryParam(CASE_FORMAT, rootNetworkCreationInfos.caseFormat());
 
         String path = builder
                 .buildAndExpand()
diff --git a/src/main/java/org/gridsuite/study/server/service/RootNetworkService.java b/src/main/java/org/gridsuite/study/server/service/RootNetworkService.java
@@ -129,6 +129,7 @@ private void updateCaseInfos(@NonNull RootNetworkEntity rootNetworkEntity, @NonN
         rootNetworkEntity.setCaseUuid(caseInfos.getCaseUuid());
         rootNetworkEntity.setCaseFormat(caseInfos.getCaseFormat());
         rootNetworkEntity.setCaseName(caseInfos.getCaseName());
+        rootNetworkEntity.setOriginalCaseUuid(caseInfos.getOriginalCaseUuid());
     }
 
     private void updateNetworkInfos(@NonNull RootNetworkEntity rootNetworkEntity, @NonNull NetworkInfos networkInfos) {
@@ -189,7 +190,7 @@ public void duplicateStudyRootNetworks(StudyEntity newStudyEntity, StudyEntity s
                         .id(UUID.randomUUID())
                         .name(rootNetworkEntityToDuplicate.getName())
                         .importParameters(newImportParameters)
-                        .caseInfos(new CaseInfos(clonedCaseUuid, rootNetworkEntityToDuplicate.getCaseName(), rootNetworkEntityToDuplicate.getCaseFormat()))
+                        .caseInfos(new CaseInfos(clonedCaseUuid, rootNetworkEntityToDuplicate.getOriginalCaseUuid(), rootNetworkEntityToDuplicate.getCaseName(), rootNetworkEntityToDuplicate.getCaseFormat()))
                         .networkInfos(new NetworkInfos(clonedNetworkUuid, rootNetworkEntityToDuplicate.getNetworkId()))
                         .reportUuid(clonedRootNodeReportUuid)
                         .tag(rootNetworkEntityToDuplicate.getTag())
diff --git a/src/main/java/org/gridsuite/study/server/service/StudyService.java b/src/main/java/org/gridsuite/study/server/service/StudyService.java
@@ -285,7 +285,14 @@ public BasicStudyInfos createStudy(UUID caseUuid, String userId, UUID studyUuid,
             if (duplicateCase) {
                 caseUuidToUse = caseService.duplicateCase(caseUuid, true);
             }
-            persistNetwork(caseUuidToUse, basicStudyInfos.getId(), null, NetworkModificationTreeService.FIRST_VARIANT_ID, userId, importReportUuid, caseFormat, importParameters, CaseImportAction.STUDY_CREATION);
+            RootNetworkCreationInfos rootNetworkCreationInfos = new RootNetworkCreationInfos(
+                    caseUuidToUse,
+                    caseUuid,
+                    basicStudyInfos.getId(),
+                    null,
+                    caseFormat
+            );
+            persistNetwork(rootNetworkCreationInfos, NetworkModificationTreeService.FIRST_VARIANT_ID, userId, importReportUuid, importParameters, CaseImportAction.STUDY_CREATION);
         } catch (Exception e) {
             self.deleteStudyIfNotCreationInProgress(basicStudyInfos.getId());
             throw e;
@@ -322,7 +329,14 @@ public RootNetworkRequestInfos createRootNetworkRequest(UUID studyUuid, String r
         RootNetworkRequestEntity rootNetworkCreationRequestEntity = rootNetworkService.insertCreationRequest(rootNetworkUuid, studyEntity.getId(), rootNetworkName, rootNetworkTag, userId);
         try {
             UUID clonedCaseUuid = caseService.duplicateCase(caseUuid, true);
-            persistNetwork(clonedCaseUuid, studyUuid, rootNetworkUuid, null, userId, importReportUuid, caseFormat, importParameters, CaseImportAction.ROOT_NETWORK_CREATION);
+            RootNetworkCreationInfos rootNetworkCreationInfos = new RootNetworkCreationInfos(
+                    clonedCaseUuid,
+                    caseUuid,
+                    studyUuid,
+                    rootNetworkUuid,
+                    caseFormat
+            );
+            persistNetwork(rootNetworkCreationInfos, null, userId, importReportUuid, importParameters, CaseImportAction.ROOT_NETWORK_CREATION);
         } catch (Exception e) {
             rootNetworkService.deleteRootNetworkRequest(rootNetworkCreationRequestEntity);
             throw new StudyException(ROOT_NETWORK_CREATION_FAILED);
@@ -380,8 +394,15 @@ public void updateRootNetworkRequest(UUID studyUuid, RootNetworkInfos rootNetwor
     private void updateRootNetworkCaseInfos(UUID studyUuid, RootNetworkInfos rootNetworkInfos, String userId, Map<String, Object> importParameters, RootNetworkRequestEntity rootNetworkModificationRequestEntity) {
         UUID importReportUuid = UUID.randomUUID();
         UUID clonedCaseUuid = caseService.duplicateCase(rootNetworkInfos.getCaseInfos().getCaseUuid(), true);
+        RootNetworkCreationInfos rootNetworkCreationInfos = new RootNetworkCreationInfos(
+            clonedCaseUuid,
+            rootNetworkInfos.getCaseInfos().getCaseUuid(),
+            studyUuid,
+            rootNetworkInfos.getId(),
+            rootNetworkInfos.getCaseInfos().getCaseFormat()
+        );
         try {
-            persistNetwork(clonedCaseUuid, studyUuid, rootNetworkInfos.getId(), null, userId, importReportUuid, rootNetworkInfos.getCaseInfos().getCaseFormat(), importParameters, CaseImportAction.ROOT_NETWORK_MODIFICATION);
+            persistNetwork(rootNetworkCreationInfos, null, userId, importReportUuid, importParameters, CaseImportAction.ROOT_NETWORK_MODIFICATION);
         } catch (Exception e) {
             rootNetworkService.deleteRootNetworkRequest(rootNetworkModificationRequestEntity);
             throw new StudyException(ROOT_NETWORK_MODIFICATION_FAILED);
@@ -414,7 +435,14 @@ private void postRootNetworkUpdate(UUID studyUuid, UUID rootNetworkUuid, boolean
      * @param importParameters
      */
     public void recreateNetwork(UUID caseUuid, String userId, UUID studyUuid, UUID rootNetworkUuid, String caseFormat, Map<String, Object> importParameters) {
-        recreateNetwork(caseUuid, userId, studyUuid, rootNetworkUuid, caseFormat, importParameters, false);
+        RootNetworkCreationInfos rootNetworkCreationInfos = new RootNetworkCreationInfos(
+            caseUuid,
+            caseUuid,
+            studyUuid,
+            rootNetworkUuid,
+            caseFormat
+        );
+        recreateNetwork(rootNetworkCreationInfos, userId, importParameters, false);
     }
 
     /**
@@ -423,18 +451,27 @@ public void recreateNetwork(UUID caseUuid, String userId, UUID studyUuid, UUID r
      * @param studyUuid
      */
     public void recreateNetwork(String userId, UUID studyUuid, UUID rootNetworkUuid, String caseFormat) {
-        UUID caseUuid = rootNetworkService.getRootNetwork(rootNetworkUuid).orElseThrow(() -> new StudyException(ROOT_NETWORK_NOT_FOUND)).getCaseUuid();
-        recreateNetwork(caseUuid, userId, studyUuid, rootNetworkUuid, caseFormat, null, true);
+        RootNetworkEntity rootNetwork = rootNetworkService.getRootNetwork(rootNetworkUuid).orElseThrow(() -> new StudyException(ROOT_NETWORK_NOT_FOUND));
+        UUID caseUuid = rootNetwork.getCaseUuid();
+        UUID originalCaseUuid = rootNetwork.getOriginalCaseUuid();
+        RootNetworkCreationInfos rootNetworkCreationInfos = new RootNetworkCreationInfos(
+            caseUuid,
+            originalCaseUuid,
+            studyUuid,
+            rootNetworkUuid,
+            caseFormat
+        );
+        recreateNetwork(rootNetworkCreationInfos, userId, null, true);
     }
 
-    private void recreateNetwork(UUID caseUuid, String userId, UUID studyUuid, UUID rootNetworkUuid, String caseFormat, Map<String, Object> importParameters, boolean shouldLoadPreviousImportParameters) {
-        caseService.assertCaseExists(caseUuid);
+    private void recreateNetwork(RootNetworkCreationInfos rootNetworkCreationInfos, String userId, Map<String, Object> importParameters, boolean shouldLoadPreviousImportParameters) {
+        caseService.assertCaseExists(rootNetworkCreationInfos.caseUuid());
         UUID importReportUuid = UUID.randomUUID();
         Map<String, Object> importParametersToUse = shouldLoadPreviousImportParameters
-            ? new HashMap<>(rootNetworkService.getImportParameters(rootNetworkUuid))
+            ? new HashMap<>(rootNetworkService.getImportParameters(rootNetworkCreationInfos.rootNetworkUuid()))
             : importParameters;
 
-        persistNetwork(caseUuid, studyUuid, rootNetworkUuid, null, userId, importReportUuid, caseFormat, importParametersToUse, CaseImportAction.NETWORK_RECREATION);
+        persistNetwork(rootNetworkCreationInfos, null, userId, importReportUuid, importParametersToUse, CaseImportAction.NETWORK_RECREATION);
     }
 
     public UUID duplicateStudy(UUID sourceStudyUuid, String userId) {
@@ -779,9 +816,9 @@ public String getVoltageLevelSvgAndMetadata(String voltageLevelId, DiagramParame
         }
     }
 
-    private void persistNetwork(UUID caseUuid, UUID studyUuid, UUID rootNetworkUuid, String variantId, String userId, UUID importReportUuid, String caseFormat, Map<String, Object> importParameters, CaseImportAction caseImportAction) {
+    private void persistNetwork(RootNetworkCreationInfos rootNetworkCreationInfos, String variantId, String userId, UUID importReportUuid, Map<String, Object> importParameters, CaseImportAction caseImportAction) {
         try {
-            networkConversionService.persistNetwork(caseUuid, studyUuid, rootNetworkUuid, variantId, userId, importReportUuid, caseFormat, importParameters, caseImportAction);
+            networkConversionService.persistNetwork(rootNetworkCreationInfos, variantId, userId, importReportUuid, importParameters, caseImportAction);
         } catch (HttpStatusCodeException e) {
             throw handleHttpError(e, STUDY_CREATION_FAILED);
         }
diff --git a/src/main/resources/db/changelog/changesets/changelog_20250707T123805Z.xml b/src/main/resources/db/changelog/changesets/changelog_20250707T123805Z.xml
@@ -0,0 +1,8 @@
+<?xml version="1.1" encoding="UTF-8" standalone="no"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet author="labidiayo (generated)" id="1751891923396-16">
+        <addColumn tableName="root_network">
+            <column name="original_case_uuid" type="uuid"/>
+        </addColumn>
+    </changeSet>
+</databaseChangeLog>
diff --git a/src/main/resources/db/changelog/db.changelog-master.yaml b/src/main/resources/db/changelog/db.changelog-master.yaml
@@ -319,4 +319,7 @@ databaseChangeLog:
       relativeToChangelogFile: true
   - include:
       file: changesets/changelog_20250611T131313Z.xml
+      relativeToChangelogFile: true
+  - include:
+      file: changesets/changelog_20250707T123805Z.xml
       relativeToChangelogFile: true
diff --git a/src/test/java/org/gridsuite/study/server/SupervisionControllerTest.java b/src/test/java/org/gridsuite/study/server/SupervisionControllerTest.java
@@ -263,8 +263,8 @@ void testRecreateIndices() throws Exception {
     @Test
     void testReindexStudy() throws Exception {
         UUID studyToReindexUuid = UUID.randomUUID();
-        BasicRootNetworkInfos network1 = new BasicRootNetworkInfos(UUID.randomUUID(), "name1", "tag1", false);
-        BasicRootNetworkInfos network2 = new BasicRootNetworkInfos(UUID.randomUUID(), "name2", "tag2", false);
+        BasicRootNetworkInfos network1 = new BasicRootNetworkInfos(UUID.randomUUID(), UUID.randomUUID(), "name1", "tag1", false);
+        BasicRootNetworkInfos network2 = new BasicRootNetworkInfos(UUID.randomUUID(), UUID.randomUUID(), "name2", "tag2", false);
         doReturn(List.of(network1, network2))
                 .when(studyService).getExistingBasicRootNetworkInfos(studyToReindexUuid);
         doNothing().when(studyService).reindexRootNetwork(studyToReindexUuid, network1.rootNetworkUuid());
diff --git a/src/test/java/org/gridsuite/study/server/rootnetworks/ModificationToExcludeTest.java b/src/test/java/org/gridsuite/study/server/rootnetworks/ModificationToExcludeTest.java
@@ -555,7 +555,7 @@ private void createDummyRootNetwork(StudyEntity studyEntity, String name) {
             .id(UUID.randomUUID())
             .name(name)
             .tag(UUID.randomUUID().toString().substring(0, 4))
-            .caseInfos(new CaseInfos(UUID.randomUUID(), "caseName", "caseFormat"))
+            .caseInfos(new CaseInfos(UUID.randomUUID(), UUID.randomUUID(), "caseName", "caseFormat"))
             .networkInfos(new NetworkInfos(UUID.randomUUID(), UUID.randomUUID().toString()))
             .reportUuid(UUID.randomUUID())
             .build().toEntity();
diff --git a/src/test/java/org/gridsuite/study/server/rootnetworks/RootNetworkTest.java b/src/test/java/org/gridsuite/study/server/rootnetworks/RootNetworkTest.java

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	`import java.util.UUID;`
`4`	`4`
`5`		`-public record BasicRootNetworkInfos(UUID rootNetworkUuid, String name, String tag, boolean isCreating) { }`
	`5`	`+public record BasicRootNetworkInfos(UUID rootNetworkUuid, UUID originalCaseUuid, String name, String tag, boolean isCreating) { }`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,6 @@ public RootNetworkRequestInfos toDto() {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`public BasicRootNetworkInfos toBasicDto() {`
`50`		`- return new BasicRootNetworkInfos(getId(), getName(), getTag(), true);`
	`50`	`+ return new BasicRootNetworkInfos(getId(), null, getName(), getTag(), true);`
`51`	`51`	`}`
`52`	`52`	`}`