Add context to the voltage init modification (#745)

* Add rootNetworkName, nodeName and computationDate in voltage init modifications entity

Signed-off-by: Franck LECUYER <[email protected]>

Author: FranckLecuyer

pom.xml

@@ -51,7 +51,7 @@
         <sonar.coverage.exclusions>**/migration/**/*</sonar.coverage.exclusions>
         <sonar.organization>gridsuite</sonar.organization>
         <sonar.projectKey>org.gridsuite:network-modification-server</sonar.projectKey>
-        <network-modification.version>0.54.0</network-modification.version>
+        <network-modification.version>0.55.0</network-modification.version>
     </properties>
 
     <build>

src/main/java/org/gridsuite/modification/server/entities/equipment/modification/VoltageInitModificationEntity.java

@@ -26,6 +26,10 @@
 import jakarta.persistence.ForeignKey;
 import jakarta.persistence.Index;
 import jakarta.persistence.Table;
+import jakarta.persistence.Column;
+
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -75,6 +79,15 @@ public class VoltageInitModificationEntity extends ModificationEntity {
         foreignKey = @ForeignKey(name = "VoltageInitModificationEntity_buses_fk1"))
     private List<VoltageInitBusModificationEmbeddable> buses;
 
+    @Column(name = "rootNetworkName")
+    private String rootNetworkName;
+
+    @Column(name = "nodeName")
+    private String nodeName;
+
+    @Column(name = "computationDate", columnDefinition = "timestamptz")
+    private Instant computationDate;
+
     public VoltageInitModificationEntity(VoltageInitModificationInfos voltageInitModificationInfos) {
         super(voltageInitModificationInfos);
         assignAttributes(voltageInitModificationInfos);
@@ -93,7 +106,10 @@ private void assignAttributes(VoltageInitModificationInfos voltageInitModificati
         vscConverterStations = toEmbeddableVoltageInitVscConverterStations(voltageInitModificationInfos.getVscConverterStations());
         shuntCompensators = toEmbeddableVoltageInitShuntCompensators(voltageInitModificationInfos.getShuntCompensators());
         buses = toEmbeddableVoltageInitBuses(voltageInitModificationInfos.getBuses());
-
+        rootNetworkName = voltageInitModificationInfos.getRootNetworkName();
+        nodeName = voltageInitModificationInfos.getNodeName();
+        //We need to limit the precision to avoid database precision storage limit issue (postgres has a precision of 6 digits while h2 can go to 9)
+        this.computationDate = voltageInitModificationInfos.getComputationDate() != null ? voltageInitModificationInfos.getComputationDate().truncatedTo(ChronoUnit.MICROS) : null;
     }
 
     public static List<VoltageInitGeneratorModificationEmbeddable> toEmbeddableVoltageInitGenerators(List<VoltageInitGeneratorModificationInfos> generators) {
@@ -187,6 +203,9 @@ public VoltageInitModificationInfos toModificationInfos() {
             .vscConverterStations(toVscConverterStationsModification(vscConverterStations))
             .shuntCompensators(toShuntCompensatorsModification(shuntCompensators))
             .buses(toBusesModification(buses))
+            .rootNetworkName(getRootNetworkName())
+            .nodeName(getNodeName())
+            .computationDate(getComputationDate())
             .build();
     }
 }

src/main/resources/db/changelog/changesets/changelog_20251205T094612Z.xml

@@ -0,0 +1,18 @@
+<?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="lecuyerfra (generated)" id="1764928014619-1">
+        <addColumn tableName="voltage_init_modification">
+            <column name="computation_date" type="timestamptz"/>
+        </addColumn>
+    </changeSet>
+    <changeSet author="lecuyerfra (generated)" id="1764928014619-2">
+        <addColumn tableName="voltage_init_modification">
+            <column name="node_name" type="varchar(255)"/>
+        </addColumn>
+    </changeSet>
+    <changeSet author="lecuyerfra (generated)" id="1764928014619-3">
+        <addColumn tableName="voltage_init_modification">
+            <column name="root_network_name" type="varchar(255)"/>
+        </addColumn>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/db/changelog/db.changelog-master.yaml

@@ -443,4 +443,7 @@ databaseChangeLog:
       relativeToChangelogFile: true
   - include:
       file: changesets/changelog_20251128T072356Z.xml
-      relativeToChangelogFile: true
+      relativeToChangelogFile: true
+  - include:
+      file: changesets/changelog_20251205T094612Z.xml
+      relativeToChangelogFile: true

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

@@ -60,6 +60,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.time.Instant;
 import java.util.*;
 import java.util.stream.Collectors;
 
@@ -1609,6 +1610,9 @@ void testCreateVoltageInitModification() throws Exception {
                     .v(226.)
                     .angle(0.6)
                     .build()))
+            .rootNetworkName("rootNetwork")
+            .nodeName("node")
+            .computationDate(Instant.now())
             .build();
 
         UUID groupUuid = UUID.randomUUID();

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

@@ -147,6 +147,9 @@ private static List<Arguments> voltageInitModifications() {
                     VoltageInitShuntCompensatorModificationInfos.builder().shuntCompensatorId("v5shunt").sectionCount(0).connect(false).build(),
                     VoltageInitShuntCompensatorModificationInfos.builder().shuntCompensatorId("v6shunt").sectionCount(1).connect(false).build()))
                 .buses(List.of())
+                .rootNetworkName("rootNetwork")
+                .nodeName("node")
+                .computationDate(Instant.now())
                 .build())
         );
     }

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

@@ -14,8 +14,11 @@
 import org.junit.jupiter.api.Test;
 import org.springframework.http.MediaType;
 import org.springframework.test.web.servlet.ResultActions;
+import com.fasterxml.jackson.core.type.TypeReference;
 
+import java.time.Instant;
 import java.util.List;
+import java.util.Map;
 import java.util.UUID;
 
 import static org.gridsuite.modification.server.utils.NetworkUtil.createGenerator;
@@ -205,6 +208,9 @@ protected ModificationInfos buildModification() {
                     .v(230.)
                     .angle(0.5)
                     .build()))
+            .rootNetworkName("rootNetwork1")
+            .nodeName("node1")
+            .computationDate(Instant.now())
             .build();
     }
 
@@ -266,6 +272,9 @@ protected ModificationInfos buildModificationUpdate() {
                     .connect(false)
                     .build()))
             .buses(List.of())
+            .rootNetworkName("rootNetwork2")
+            .nodeName("node2")
+            .computationDate(Instant.now())
             .build();
     }
 
@@ -366,4 +375,20 @@ protected void assertAfterNetworkModificationDeletion() {
         assertEquals(225., getNetwork().getShuntCompensator("v5shunt").getTargetV(), 0.001);
         assertEquals(0, getNetwork().getShuntCompensator("v6shunt").getSectionCount());
     }
+
+    @Override
+    protected void testCreationModificationMessage(ModificationInfos modificationInfos) throws Exception {
+        assertEquals("VOLTAGE_INIT_MODIFICATION", modificationInfos.getMessageType());
+        Map<String, String> createdValues = mapper.readValue(modificationInfos.getMessageValues(), new TypeReference<>() { });
+        assertEquals("rootNetwork1", createdValues.get("rootNetworkName"));
+        assertEquals("node1", createdValues.get("nodeName"));
+    }
+
+    @Override
+    protected void testUpdateModificationMessage(ModificationInfos modificationInfos) throws Exception {
+        assertEquals("VOLTAGE_INIT_MODIFICATION", modificationInfos.getMessageType());
+        Map<String, String> updatedValues = mapper.readValue(modificationInfos.getMessageValues(), new TypeReference<>() { });
+        assertEquals("rootNetwork2", updatedValues.get("rootNetworkName"));
+        assertEquals("node2", updatedValues.get("nodeName"));
+    }
 }