Feat: Manage Map Card save in layout (#816)

sBouzols · web-flow · commit 97311f5e6d5e · 2025-08-01T16:27:29.000+02:00
* feat(DiagramGridLayout): Manage Map Card save in layout and add a control over the number of Map Card in the grid

Signed-off-by: sBouzols &lt;sylvain.bouzols@gmail.com&gt;
diff --git a/src/main/java/org/gridsuite/study/server/RestResponseEntityExceptionHandler.java b/src/main/java/org/gridsuite/study/server/RestResponseEntityExceptionHandler.java
@@ -70,7 +70,8 @@ protected ResponseEntity<Object> handleStudyException(StudyException exception)
                     ROOT_NETWORK_DELETE_FORBIDDEN,
                     MAXIMUM_ROOT_NETWORK_BY_STUDY_REACHED,
                     MAXIMUM_TAG_LENGTH_EXCEEDED,
-                    TOO_MANY_NAD_CONFIGS
+                    TOO_MANY_NAD_CONFIGS,
+                    TOO_MANY_MAP_CARDS
                     -> ResponseEntity.status(HttpStatus.FORBIDDEN).body(exception.getMessage());
             case CANT_DELETE_ROOT_NODE -> ResponseEntity.status(HttpStatus.FORBIDDEN).body(NOT_ALLOWED);
             case CREATE_NETWORK_MODIFICATION_FAILED,
diff --git a/src/main/java/org/gridsuite/study/server/StudyException.java b/src/main/java/org/gridsuite/study/server/StudyException.java
@@ -156,7 +156,8 @@ public enum Type {
         UPDATE_SPREADSHEET_CONFIG_FAILED,
         NETWORK_EXPORT_FAILED,
         GET_LOADFLOW_PROVIDER_FAILED,
-        TOO_MANY_NAD_CONFIGS
+        TOO_MANY_NAD_CONFIGS,
+        TOO_MANY_MAP_CARDS
     }
 
     private final Type type;
diff --git a/src/main/java/org/gridsuite/study/server/dto/diagramgridlayout/diagramlayout/AbstractDiagramLayoutJsonMapper.java b/src/main/java/org/gridsuite/study/server/dto/diagramgridlayout/diagramlayout/AbstractDiagramLayoutJsonMapper.java
@@ -21,6 +21,7 @@
     @JsonSubTypes.Type(value = NetworkAreaDiagramLayout.class, name = "network-area-diagram"),
     @JsonSubTypes.Type(value = SubstationDiagramLayout.class, name = "substation"),
     @JsonSubTypes.Type(value = VoltageLevelDiagramLayout.class, name = "voltage-level"),
+    @JsonSubTypes.Type(value = MapLayout.class, name = "map"),
 })
 public interface AbstractDiagramLayoutJsonMapper {
 }
diff --git a/src/main/java/org/gridsuite/study/server/dto/diagramgridlayout/diagramlayout/MapLayout.java b/src/main/java/org/gridsuite/study/server/dto/diagramgridlayout/diagramlayout/MapLayout.java
@@ -0,0 +1,19 @@
+/**
+ * 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.diagramgridlayout.diagramlayout;
+
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.experimental.SuperBuilder;
+
+@SuperBuilder
+@NoArgsConstructor
+@Setter
+@Getter
+public class MapLayout extends AbstractDiagramLayout {
+}
diff --git a/src/main/java/org/gridsuite/study/server/service/DiagramGridLayoutService.java b/src/main/java/org/gridsuite/study/server/service/DiagramGridLayoutService.java
@@ -10,6 +10,7 @@
 import org.gridsuite.study.server.StudyException;
 import org.gridsuite.study.server.dto.diagramgridlayout.DiagramGridLayout;
 import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.AbstractDiagramLayout;
+import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.MapLayout;
 import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.NetworkAreaDiagramLayout;
 import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.NetworkAreaDiagramLayoutDetails;
 import org.gridsuite.study.server.dto.diagramgridlayout.nad.NadConfigInfos;
@@ -30,7 +31,8 @@
 public class DiagramGridLayoutService {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(DiagramGridLayoutService.class);
-    private static final int MAX_NAD_CONFIGS_ALLOWED = 3;
+    public static final int MAX_NAD_CONFIGS_ALLOWED = 3;
+    public static final int MAX_MAP_CARDS_ALLOWED = 1;
 
     private final StudyConfigService studyConfigService;
     private final SingleLineDiagramService singleLineDiagramService;
@@ -47,6 +49,9 @@ public UUID createDiagramGridLayout(DiagramGridLayout diagramGridLayout) {
         // Validate NAD config count before processing
         validateNadConfigCount(diagramGridLayout);
 
+        // Validate map card count
+        validateMapCardCount(diagramGridLayout);
+
         // Process diagram layout and handle NAD layout details
         DiagramGridLayout processedDiagramLayout = processNADLayoutDetails(diagramGridLayout);
         return studyConfigService.saveDiagramGridLayout(processedDiagramLayout);
@@ -59,6 +64,9 @@ public UUID updateDiagramGridLayout(UUID existingDiagramGridLayoutUuid, DiagramG
         // Validate NAD config count before processing
         validateNadConfigCount(diagramGridLayout);
 
+        // Validate map card count
+        validateMapCardCount(diagramGridLayout);
+
         List<UUID> oldNadConfigUuidsToDelete = collectOldNadConfigUuids(existingDiagramGridLayoutUuid);
 
         // Process diagram layout and handle NAD layout details
@@ -134,6 +142,22 @@ private void cleanupOldNadConfigs(List<UUID> oldNadConfigUuidsToDelete) {
         }
     }
 
+    /**
+     * Validates that the diagram grid layout does not contain more than one map card.
+     */
+    private void validateMapCardCount(DiagramGridLayout diagramGridLayout) {
+        if (diagramGridLayout != null && diagramGridLayout.getDiagramLayouts() != null) {
+            long mapCardsCount = diagramGridLayout.getDiagramLayouts().stream()
+                .filter(MapLayout.class::isInstance)
+                .count();
+
+            if (mapCardsCount > MAX_MAP_CARDS_ALLOWED) {
+                throw new StudyException(StudyException.Type.TOO_MANY_MAP_CARDS,
+                    "Maximum " + MAX_MAP_CARDS_ALLOWED + " map card allowed, but " + mapCardsCount + " provided");
+            }
+        }
+    }
+
     /**
      * Validates that the diagram grid layout does not exceed the maximum allowed NAD configurations.
      */
diff --git a/src/test/java/org/gridsuite/study/server/DiagramGridLayoutTest.java b/src/test/java/org/gridsuite/study/server/DiagramGridLayoutTest.java
@@ -11,7 +11,9 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.gridsuite.study.server.dto.diagramgridlayout.DiagramGridLayout;
+import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.AbstractDiagramLayout;
 import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.DiagramPosition;
+import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.MapLayout;
 import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.NadVoltageLevelPositionInfos;
 import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.NetworkAreaDiagramLayoutDetails;
 import org.gridsuite.study.server.dto.diagramgridlayout.diagramlayout.NetworkAreaDiagramLayout;
@@ -592,9 +594,9 @@ void testUpdateDiagramGridLayoutWithTooManyNads() throws Exception {
         UUID existingDiagramGridLayoutUuid = UUID.randomUUID();
         studyRepository.save(StudyEntity.builder().id(studyUuid).diagramGridLayoutUuid(existingDiagramGridLayoutUuid).build());
 
-        // Create 4 NAD layout details (exceeds the limit of 3)
+        // Create more than MAX_NAD_CONFIGS_ALLOWED NAD layout details
         List<NetworkAreaDiagramLayoutDetails> nadLayouts = new ArrayList<>();
-        for (int i = 0; i < 4; i++) {
+        for (int i = 0; i < DiagramGridLayoutService.MAX_NAD_CONFIGS_ALLOWED + 1; i++) {
             nadLayouts.add(NetworkAreaDiagramLayoutDetails.builder()
                 .diagramUuid(UUID.randomUUID())
                 .voltageLevelIds(Set.of("VL" + i))
@@ -626,4 +628,59 @@ void testUpdateDiagramGridLayoutWithTooManyNads() throws Exception {
         wireMockServer.verify(0, WireMock.putRequestedFor(WireMock.urlMatching(".*")));
     }
 
+    @Test
+    void testCreateDiagramGridLayoutWithTooManyMapCards() throws Exception {
+        UUID studyUuid = UUID.randomUUID();
+        studyRepository.save(StudyEntity.builder().id(studyUuid).build());
+
+        // Create more than MAX_MAP_CARDS_ALLOWED Map Cards
+        List<AbstractDiagramLayout> mapLayouts = new ArrayList<>();
+        for (int i = 0; i < DiagramGridLayoutService.MAX_MAP_CARDS_ALLOWED + 1; i++) {
+            mapLayouts.add(MapLayout.builder().diagramUuid(UUID.randomUUID()).build());
+        }
+
+        DiagramGridLayout diagramGridLayoutWithTooMuchMapCards = DiagramGridLayout.builder().diagramLayouts(mapLayouts).build();
+
+        String payload = objectMapper.writeValueAsString(diagramGridLayoutWithTooMuchMapCards);
+
+        // Should return forbidden due to too many Map Cards
+        mockMvc.perform(post("/v1/studies/{studyUuid}/diagram-grid-layout", studyUuid)
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(payload))
+            .andExpect(status().isForbidden());
+
+        // Verify no external services were called since validation failed early
+        wireMockServer.verify(0, WireMock.postRequestedFor(WireMock.urlMatching(".*")));
+    }
+
+    @Test
+    void testUpdateDiagramGridLayoutWithTooManyMapCards() throws Exception {
+        UUID studyUuid = UUID.randomUUID();
+        UUID existingDiagramGridLayoutUuid = UUID.randomUUID();
+        studyRepository.save(StudyEntity.builder().id(studyUuid).diagramGridLayoutUuid(existingDiagramGridLayoutUuid).build());
+
+        // Create more than MAX_MAP_CARDS_ALLOWED Map Cards
+        List<AbstractDiagramLayout> mapLayouts = new ArrayList<>();
+        for (int i = 0; i < DiagramGridLayoutService.MAX_MAP_CARDS_ALLOWED + 1; i++) {
+            mapLayouts.add(MapLayout.builder().diagramUuid(UUID.randomUUID()).build());
+        }
+
+        DiagramGridLayout updatePayload = DiagramGridLayout.builder()
+            .diagramLayouts(new ArrayList<>(mapLayouts))
+            .build();
+
+        String payload = objectMapper.writeValueAsString(updatePayload);
+
+        // Should return forbidden due to too many Map Cards
+        mockMvc.perform(post("/v1/studies/{studyUuid}/diagram-grid-layout", studyUuid)
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(payload))
+            .andExpect(status().isForbidden());
+
+        // Verify no external services were called since validation failed early
+        wireMockServer.verify(0, WireMock.getRequestedFor(WireMock.urlMatching(".*")));
+        wireMockServer.verify(0, WireMock.postRequestedFor(WireMock.urlMatching(".*")));
+        wireMockServer.verify(0, WireMock.putRequestedFor(WireMock.urlMatching(".*")));
+    }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,8 @@ public enum Type {`
`156`	`156`	`UPDATE_SPREADSHEET_CONFIG_FAILED,`
`157`	`157`	`NETWORK_EXPORT_FAILED,`
`158`	`158`	`GET_LOADFLOW_PROVIDER_FAILED,`
`159`		`- TOO_MANY_NAD_CONFIGS`
	`159`	`+ TOO_MANY_NAD_CONFIGS,`
	`160`	`+ TOO_MANY_MAP_CARDS`
`160`	`161`	`}`
`161`	`162`
`162`	`163`	`private final Type type;`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`@JsonSubTypes.Type(value = NetworkAreaDiagramLayout.class, name = "network-area-diagram"),`
`22`	`22`	`@JsonSubTypes.Type(value = SubstationDiagramLayout.class, name = "substation"),`
`23`	`23`	`@JsonSubTypes.Type(value = VoltageLevelDiagramLayout.class, name = "voltage-level"),`
	`24`	`+ @JsonSubTypes.Type(value = MapLayout.class, name = "map"),`
`24`	`25`	`})`
`25`	`26`	`public interface AbstractDiagramLayoutJsonMapper {`
`26`	`27`	`}`