Set proper Nad name when we create a new study with a Nad in user profile (#836)

Signed-off-by: David BRAQUART <[email protected]>

Author: dbraquart

src/main/java/org/gridsuite/study/server/StudyConstants.java

@@ -36,6 +36,7 @@ private StudyConstants() {
     public static final String DYNAMIC_MAPPING_API_VERSION = ""; // mapping server is now without version, must be v1 in the next time
     public static final String FILTER_API_VERSION = "v1";
     public static final String STATE_ESTIMATION_API_VERSION = "v1";
+    public static final String DIRECTORY_API_VERSION = "v1";
 
     public static final String NETWORK_UUID = "networkUuid";
     public static final String CASE_UUID = "caseUuid";

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

@@ -68,6 +68,7 @@ public class ConsumerService {
     private final UserAdminService userAdminService;
     private final NetworkModificationTreeService networkModificationTreeService;
     private final StudyConfigService studyConfigService;
+    private final DirectoryService directoryService;
     private final ShortCircuitService shortCircuitService;
     private final RootNetworkNodeInfoService rootNetworkNodeInfoService;
     private final VoltageInitService voltageInitService;
@@ -87,6 +88,7 @@ public ConsumerService(ObjectMapper objectMapper,
                            NetworkModificationTreeService networkModificationTreeService,
                            SensitivityAnalysisService sensitivityAnalysisService,
                            StudyConfigService studyConfigService,
+                           DirectoryService directoryService,
                            RootNetworkNodeInfoService rootNetworkNodeInfoService,
                            VoltageInitService voltageInitService,
                            DynamicSecurityAnalysisService dynamicSecurityAnalysisService,
@@ -102,6 +104,7 @@ public ConsumerService(ObjectMapper objectMapper,
         this.networkModificationTreeService = networkModificationTreeService;
         this.sensitivityAnalysisService = sensitivityAnalysisService;
         this.studyConfigService = studyConfigService;
+        this.directoryService = directoryService;
         this.shortCircuitService = shortCircuitService;
         this.rootNetworkNodeInfoService = rootNetworkNodeInfoService;
         this.voltageInitService = voltageInitService;
@@ -308,12 +311,14 @@ private void insertStudy(UUID studyUuid, String userId, NetworkInfos networkInfo
 
     private UUID createGridLayoutFromNadDiagram(String userId, UserProfileInfos userProfileInfos) {
         if (userProfileInfos != null && userProfileInfos.getDiagramConfigId() != null) {
+            UUID sourceNadConfig = userProfileInfos.getDiagramConfigId();
             try {
-                UUID clonedNadConfig = singleLineDiagramService.duplicateNadConfig(userProfileInfos.getDiagramConfigId());
-                return studyConfigService.createGridLayoutFromNadDiagram(userProfileInfos.getDiagramConfigId(), clonedNadConfig);
+                UUID clonedNadConfig = singleLineDiagramService.duplicateNadConfig(sourceNadConfig);
+                String nadConfigName = directoryService.getElementName(sourceNadConfig);
+                return studyConfigService.createGridLayoutFromNadDiagram(sourceNadConfig, clonedNadConfig, nadConfigName);
             } catch (Exception e) {
-                LOGGER.error(String.format("Could not create a diagram grid layout with NAD elment id '%s' from user/profile '%s/%s'. No layout created",
-                    userProfileInfos.getDiagramConfigId(), userId, userProfileInfos.getName()), e);
+                LOGGER.error(String.format("Could not create a diagram grid layout cloning NAD elment id '%s' from user/profile '%s/%s'. No layout created",
+                    sourceNadConfig, userId, userProfileInfos.getName()), e);
             }
         }
         return null;

src/main/java/org/gridsuite/study/server/service/DirectoryService.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.study.server.service;
+
+import lombok.Setter;
+import org.gridsuite.study.server.RemoteServicesProperties;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+import org.springframework.web.client.RestTemplate;
+import org.springframework.web.util.UriComponentsBuilder;
+import java.util.UUID;
+
+import static org.gridsuite.study.server.StudyConstants.DELIMITER;
+import static org.gridsuite.study.server.StudyConstants.DIRECTORY_API_VERSION;
+
+/**
+ * @author David Braquart <david.braquart at rte-france.com>
+ */
+@Service
+public class DirectoryService {
+
+    private final RestTemplate restTemplate;
+
+    @Setter
+    private String directoryServerServerBaseUri;
+
+    @Autowired
+    public DirectoryService(RemoteServicesProperties remoteServicesProperties, RestTemplate restTemplate) {
+        this.directoryServerServerBaseUri = remoteServicesProperties.getServiceUri("directory-server");
+        this.restTemplate = restTemplate;
+    }
+
+    public String getElementName(UUID elementUuid) {
+        UriComponentsBuilder pathBuilder = UriComponentsBuilder.fromPath(DELIMITER + DIRECTORY_API_VERSION + "/elements/{elementUuid}/name");
+        String path = pathBuilder.buildAndExpand(elementUuid).toUriString();
+        return restTemplate.getForObject(directoryServerServerBaseUri + path, String.class);
+    }
+}

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

@@ -478,14 +478,15 @@ public void updateDiagramGridLayout(UUID diagramGridLayoutUuid, DiagramGridLayou
         }
     }
 
-    public UUID createGridLayoutFromNadDiagram(UUID sourceNadConfigUuid, UUID clonedNadConfigUuid) {
+    public UUID createGridLayoutFromNadDiagram(UUID sourceNadConfigUuid, UUID clonedNadConfigUuid, String nadDiagramConfigName) {
         if (sourceNadConfigUuid == null) {
             return null;
         }
         DiagramGridLayout diagramGridLayout = DiagramGridLayout.builder()
             .diagramLayouts(List.of(NetworkAreaDiagramLayout.builder()
                 .originalNadConfigUuid(sourceNadConfigUuid)
                 .currentNadConfigUuid(clonedNadConfigUuid)
+                .name(nadDiagramConfigName)
                 .build()))
             .build();
 

src/main/resources/application-local.yml

@@ -82,3 +82,6 @@ gridsuite:
     -
       name: study-config-server
       base-uri: http://localhost:5035/
+    -
+      name: directory-server
+      base-uri: http://localhost:5026

src/main/resources/config/application.yaml

@@ -224,6 +224,9 @@ gridsuite:
     -
       name: study-config-server
       base-uri: http://study-config-server/
+    -
+      name: directory-server
+      base-uri: http://directory-server/
 
 study:
   max-root-network-by-study: 4

src/test/java/org/gridsuite/study/server/service/ConsumerServiceTest.java

@@ -14,15 +14,17 @@ class ConsumerServiceTest {
 
     private StudyConfigService studyConfigService;
     private SingleLineDiagramService singleLineDiagramService;
+    private DirectoryService directoryService;
     private ConsumerService consumerService;
 
     @BeforeEach
     void setUp() {
         studyConfigService = mock(StudyConfigService.class);
         singleLineDiagramService = mock(SingleLineDiagramService.class);
+        directoryService = mock(DirectoryService.class);
         consumerService = new ConsumerService(null, null, null, null, null,
                 null, null, null, null, null,
-                studyConfigService, null, null, null, null,
+                studyConfigService, directoryService, null, null, null, null,
                 singleLineDiagramService);
     }
 
@@ -31,16 +33,18 @@ void createGridLayoutFromNadDiagram() {
         UUID diagramConfigId = UUID.randomUUID();
         UUID clonedConfigId = UUID.randomUUID();
         UUID gridLayoutUuid = UUID.randomUUID();
+        String nadElementName = "N";
         UserProfileInfos profile = UserProfileInfos.builder().diagramConfigId(diagramConfigId).build();
 
         when(singleLineDiagramService.duplicateNadConfig(diagramConfigId)).thenReturn(clonedConfigId);
-        when(studyConfigService.createGridLayoutFromNadDiagram(diagramConfigId, clonedConfigId)).thenReturn(gridLayoutUuid);
+        when(directoryService.getElementName(diagramConfigId)).thenReturn(nadElementName);
+        when(studyConfigService.createGridLayoutFromNadDiagram(diagramConfigId, clonedConfigId, nadElementName)).thenReturn(gridLayoutUuid);
 
         UUID result = ReflectionTestUtils.invokeMethod(consumerService, "createGridLayoutFromNadDiagram", "user", profile);
 
         assertEquals(gridLayoutUuid, result);
         verify(singleLineDiagramService).duplicateNadConfig(diagramConfigId);
-        verify(studyConfigService).createGridLayoutFromNadDiagram(diagramConfigId, clonedConfigId);
+        verify(studyConfigService).createGridLayoutFromNadDiagram(diagramConfigId, clonedConfigId, nadElementName);
     }
 
     @Test

src/test/java/org/gridsuite/study/server/service/StudyConfigServiceTest.java

@@ -36,7 +36,7 @@ void createGridLayoutFromNadDiagram() {
                 eq(HttpMethod.POST), captor.capture(), eq(UUID.class)))
             .thenReturn(ResponseEntity.ok(expected));
 
-        assertEquals(expected, service.createGridLayoutFromNadDiagram(src, clone));
+        assertEquals(expected, service.createGridLayoutFromNadDiagram(src, clone, "N"));
 
         DiagramGridLayout body = captor.getValue().getBody();
         NetworkAreaDiagramLayout layout = (NetworkAreaDiagramLayout) body.getDiagramLayouts().get(0);
@@ -51,7 +51,7 @@ void createGridLayoutFromNadDiagramNullSource() {
         when(properties.getServiceUri("study-config-server")).thenReturn("http://study-config");
         StudyConfigService service = new StudyConfigService(properties, restTemplate);
 
-        assertNull(service.createGridLayoutFromNadDiagram(null, UUID.randomUUID()));
+        assertNull(service.createGridLayoutFromNadDiagram(null, UUID.randomUUID(), "N"));
         verifyNoInteractions(restTemplate);
     }
 
@@ -69,6 +69,6 @@ void createGridLayoutFromNadDiagramRestError() {
                 eq(HttpMethod.POST), any(HttpEntity.class), eq(UUID.class)))
             .thenThrow(new HttpServerErrorException(HttpStatus.INTERNAL_SERVER_ERROR));
 
-        assertThrows(StudyException.class, () -> service.createGridLayoutFromNadDiagram(src, clone));
+        assertThrows(StudyException.class, () -> service.createGridLayoutFromNadDiagram(src, clone, "N"));
     }
 }