Fix cyclic dependencies

Signed-off-by: Ayoub LABIDI <[email protected]>

Author: ayolab

src/main/java/org/gridsuite/studyconfig/server/configuration/DiagramLayoutJacksonConfiguration.java

@@ -0,0 +1,42 @@
+/*
+  Copyright (c) 2024, 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.studyconfig.server.configuration;
+
+import com.fasterxml.jackson.databind.Module;
+import com.fasterxml.jackson.databind.jsontype.NamedType;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.NadFromElementDiagramLayout;
+import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.NetworkAreaDiagramLayout;
+import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.SubstationDiagramLayout;
+import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.VoltageLevelDiagramLayout;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Jackson configuration for diagram layout polymorphic serialization.
+ * This external configuration avoids circular dependencies between the abstract base class
+ * and its subtypes by registering the type mappings outside the class hierarchy.
+ */
+@Configuration
+public class DiagramLayoutJacksonConfiguration {
+
+    @Bean
+    public Module diagramLayoutTypeModule() {
+        SimpleModule module = new SimpleModule("DiagramLayoutTypeModule");
+
+        // Register subtypes for polymorphic serialization/deserialization
+        // This approach avoids circular dependencies that would occur with @JsonSubTypes
+        module.registerSubtypes(
+            new NamedType(SubstationDiagramLayout.class, "substation"),
+            new NamedType(VoltageLevelDiagramLayout.class, "voltage-level"),
+            new NamedType(NetworkAreaDiagramLayout.class, "network-area-diagram"),
+            new NamedType(NadFromElementDiagramLayout.class, "nad-from-element")
+        );
+
+        return module;
+    }
+}

src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/StudyLayout.java

@@ -2,7 +2,6 @@
 
 import lombok.*;
 import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.AbstractDiagramLayout;
-import org.gridsuite.studyconfig.server.entities.studylayout.StudyLayoutEntity;
 
 import java.util.List;
 
@@ -13,10 +12,4 @@
 @Getter
 public class StudyLayout {
     List<AbstractDiagramLayout> diagramLayoutParams;
-
-    public StudyLayoutEntity toEntity() {
-        return StudyLayoutEntity.builder()
-            .diagramGridLayoutEntityList(diagramLayoutParams.stream().map(AbstractDiagramLayout::toEntity).toList())
-            .build();
-    }
 }

src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/AbstractDiagramLayout.java

@@ -1,13 +1,11 @@
 package org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout;
 
-import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.experimental.SuperBuilder;
-import org.gridsuite.studyconfig.server.entities.studylayout.AbstractDiagramLayoutEntity;
 
 import java.util.Map;
 import java.util.UUID;
@@ -23,16 +21,8 @@
     property = "type",
     visible = true
 )
-@JsonSubTypes({
-    @JsonSubTypes.Type(value = SubstationDiagramLayout.class, name = "substation"),
-    @JsonSubTypes.Type(value = VoltageLevelDiagramLayout.class, name = "voltage-level"),
-    @JsonSubTypes.Type(value = NetworkAreaDiagramLayout.class, name = "network-area-diagram"),
-    @JsonSubTypes.Type(value = NadFromElementDiagramLayout.class, name = "nad-from-element"),
-})
 public abstract class AbstractDiagramLayout {
     UUID diagramUuid;
 
     Map<String, DiagramGridLayout> gridLayout;
-
-    public abstract AbstractDiagramLayoutEntity toEntity();
 }

src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/DiagramGridLayout.java

@@ -3,7 +3,6 @@
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
-import org.gridsuite.studyconfig.server.entities.studylayout.DiagramGridLayoutEntity;
 
 @Builder
 @AllArgsConstructor
@@ -13,13 +12,4 @@ public class DiagramGridLayout {
     Integer h;
     Integer x;
     Integer y;
-
-    public DiagramGridLayoutEntity toEntity() {
-        return DiagramGridLayoutEntity.builder()
-            .width(w)
-            .height(h)
-            .xPosition(x)
-            .yPosition(y)
-            .build();
-    }
 }

src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/NadFromElementDiagramLayout.java

@@ -5,11 +5,8 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.experimental.SuperBuilder;
-import org.gridsuite.studyconfig.server.entities.studylayout.NadFromElementDiagramLayoutEntity;
 
-import java.util.Map;
 import java.util.UUID;
-import java.util.stream.Collectors;
 
 @SuperBuilder
 @AllArgsConstructor
@@ -20,18 +17,4 @@ public class NadFromElementDiagramLayout extends AbstractDiagramLayout {
     String elementName;
     String elementType;
     UUID elementUuid;
-
-    @Override
-    public NadFromElementDiagramLayoutEntity toEntity() {
-        return NadFromElementDiagramLayoutEntity.builder()
-            .diagramUuid(diagramUuid)
-            .gridLayout(gridLayout.entrySet().stream().collect(Collectors.toMap(
-                Map.Entry::getKey,
-                entry -> entry.getValue().toEntity()
-            )))
-            .elementName(elementName)
-            .elementType(elementType)
-            .elementUuid(elementUuid)
-            .build();
-    }
 }

src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/NetworkAreaDiagramLayout.java

@@ -5,11 +5,8 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.experimental.SuperBuilder;
-import org.gridsuite.studyconfig.server.entities.studylayout.NetworkAreaDiagramLayoutEntity;
 
 import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
 
 @SuperBuilder
 @AllArgsConstructor
@@ -19,17 +16,4 @@
 public class NetworkAreaDiagramLayout extends AbstractDiagramLayout {
     List<String> voltageLevelIds;
     Integer depth;
-
-    @Override
-    public NetworkAreaDiagramLayoutEntity toEntity() {
-        return NetworkAreaDiagramLayoutEntity.builder()
-            .diagramUuid(diagramUuid)
-            .gridLayout(gridLayout.entrySet().stream().collect(Collectors.toMap(
-                Map.Entry::getKey,
-                entry -> entry.getValue().toEntity()
-            )))
-            .voltageLevelIds(voltageLevelIds)
-            .depth(depth)
-            .build();
-    }
 }

src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/SubstationDiagramLayout.java

@@ -5,10 +5,6 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.experimental.SuperBuilder;
-import org.gridsuite.studyconfig.server.entities.studylayout.SubstationDiagramLayoutEntity;
-
-import java.util.Map;
-import java.util.stream.Collectors;
 
 @SuperBuilder
 @AllArgsConstructor
@@ -17,16 +13,4 @@
 @Getter
 public class SubstationDiagramLayout extends AbstractDiagramLayout {
     String substationId;
-
-    @Override
-    public SubstationDiagramLayoutEntity toEntity() {
-        return SubstationDiagramLayoutEntity.builder()
-            .diagramUuid(diagramUuid)
-            .gridLayout(gridLayout.entrySet().stream().collect(Collectors.toMap(
-                Map.Entry::getKey,
-                entry -> entry.getValue().toEntity()
-            )))
-            .substationId(substationId)
-            .build();
-    }
 }

src/main/java/org/gridsuite/studyconfig/server/dto/studylayout/diagramlayout/VoltageLevelDiagramLayout.java

@@ -5,10 +5,6 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.experimental.SuperBuilder;
-import org.gridsuite.studyconfig.server.entities.studylayout.VoltageLevelLayoutEntity;
-
-import java.util.Map;
-import java.util.stream.Collectors;
 
 @SuperBuilder
 @AllArgsConstructor
@@ -17,16 +13,4 @@
 @Getter
 public class VoltageLevelDiagramLayout extends AbstractDiagramLayout {
     String voltageLevelId;
-
-    @Override
-    public VoltageLevelLayoutEntity toEntity() {
-        return VoltageLevelLayoutEntity.builder()
-            .diagramUuid(diagramUuid)
-            .gridLayout(gridLayout.entrySet().stream().collect(Collectors.toMap(
-                Map.Entry::getKey,
-                entry -> entry.getValue().toEntity()
-            )))
-            .voltageLevelId(voltageLevelId)
-            .build();
-    }
 }

src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/AbstractDiagramLayoutEntity.java

@@ -2,9 +2,9 @@
 
 import jakarta.persistence.*;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
-import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.AbstractDiagramLayout;
 
 import java.util.Map;
 import java.util.UUID;
@@ -14,6 +14,7 @@
 @SuperBuilder
 @NoArgsConstructor
 @AllArgsConstructor
+@Getter
 public abstract class AbstractDiagramLayoutEntity {
     @Id
     @GeneratedValue(strategy = GenerationType.AUTO)
@@ -25,6 +26,4 @@ public abstract class AbstractDiagramLayoutEntity {
     @CollectionTable(foreignKey = @ForeignKey(name = "fk_grid_layout_abstract_diagram"))
     @MapKeyColumn(name = "grid_layout_key")
     Map<String, DiagramGridLayoutEntity> gridLayout;
-
-    public abstract AbstractDiagramLayout toDto();
 }

src/main/java/org/gridsuite/studyconfig/server/entities/studylayout/DiagramGridLayoutEntity.java

@@ -1,27 +1,28 @@
 package org.gridsuite.studyconfig.server.entities.studylayout;
 
+import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.DiagramGridLayout;
+
 import jakarta.persistence.Embeddable;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
+import lombok.Getter;
 import lombok.NoArgsConstructor;
-import org.gridsuite.studyconfig.server.dto.studylayout.diagramlayout.DiagramGridLayout;
 
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
 @Embeddable
+@Getter
 public class DiagramGridLayoutEntity {
     Integer width;
     Integer height;
     Integer xPosition;
     Integer yPosition;
 
-    public DiagramGridLayout toDto() {
-        return DiagramGridLayout.builder()
-            .w(width)
-            .h(height)
-            .x(xPosition)
-            .y(yPosition)
-            .build();
+    public DiagramGridLayoutEntity(DiagramGridLayout diagramGridLayout) {
+        this.width = diagramGridLayout.getW();
+        this.height = diagramGridLayout.getH();
+        this.xPosition = diagramGridLayout.getX();
+        this.yPosition = diagramGridLayout.getY();
     }
 }