Skip to content

NAD Depth refactor #788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

NAD Depth refactor #788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0485a6b
NAD Depth refactor (WIP)
Jun 26, 2025
ab932b5
Merge branch 'main' into nad_depth_refactor
EstherDarkish Jun 27, 2025
1ad158d
Merge branch 'main' into nad_depth_refactor
EstherDarkish Jun 28, 2025
ccebc42
fix TU
Jun 30, 2025
f0dc2be
eslint
Jun 30, 2025
c9b3fa9
fix TU
Jun 30, 2025
e8baf8e
Merge branch 'main' into nad_depth_refactor
souissimai Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 3 additions & 18 deletions src/main/java/org/gridsuite/study/server/controller/StudyController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1144,30 +1144,15 @@ public ResponseEntity<String> getSubstationDiagramAndMetadata(
ResponseEntity.noContent().build();
}

@PostMapping(value = "/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@PostMapping(value = "/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram", produces = MediaType.APPLICATION_JSON_VALUE)
@Operation(summary = "get the network area diagram for the given network and voltage levels")
@ApiResponse(responseCode = "200", description = "The svg")
public ResponseEntity<String> getNetworkAreaDiagram(
@PathVariable("studyUuid") UUID studyUuid,
@PathVariable("rootNetworkUuid") UUID rootNetworkUuid,
@PathVariable("nodeUuid") UUID nodeUuid,
@RequestBody List<String> voltageLevelsIds,
@Parameter(description = "depth") @RequestParam(name = "depth", defaultValue = "0") int depth,
@Parameter(description = "Initialize NAD with Geographical Data") @RequestParam(name = "withGeoData", defaultValue = "true") boolean withGeoData) {
String result = studyService.getNetworkAreaDiagram(nodeUuid, rootNetworkUuid, voltageLevelsIds, depth, withGeoData);
return result != null ? ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(result) :
ResponseEntity.noContent().build();
}

@GetMapping(value = "/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram")
@Operation(summary = "get a network area diagram for the given network using a config or a filter")
@ApiResponse(responseCode = "200", description = "The svg")
public ResponseEntity<String> getNetworkAreaDiagram(
@PathVariable("studyUuid") UUID studyUuid,
@PathVariable("rootNetworkUuid") UUID rootNetworkUuid,
@PathVariable("nodeUuid") UUID nodeUuid,
@Parameter(description = "Element parameters") @RequestParam(name = "elementParams") String elementParams) {
String result = studyService.getNetworkAreaDiagram(nodeUuid, rootNetworkUuid, elementParams);
@RequestBody String nadRequestInfos) {
String result = studyService.getNetworkAreaDiagram(nodeUuid, rootNetworkUuid, nadRequestInfos);
return result != null ? ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(result) :
ResponseEntity.noContent().build();
}
Expand Down
43 changes: 9 additions & 34 deletions src/main/java/org/gridsuite/study/server/service/SingleLineDiagramService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
import static org.gridsuite.study.server.StudyConstants.SINGLE_LINE_DIAGRAM_API_VERSION;
import static org.gridsuite.study.server.StudyException.Type.SVG_NOT_FOUND;

import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.UUID;

Expand All @@ -26,8 +24,7 @@
import org.gridsuite.study.server.dto.DiagramParameters;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.*;
import org.springframework.stereotype.Service;
import org.springframework.web.client.HttpStatusCodeException;
import org.springframework.web.client.RestTemplate;
Expand Down Expand Up @@ -170,51 +167,29 @@ public String getSubstationSvgAndMetadata(UUID networkUuid, String variantId, St
return result;
}

public String getNetworkAreaDiagram(UUID networkUuid, String variantId, List<String> voltageLevelsIds, int depth, boolean withGeoData) {
public String getNetworkAreaDiagram(UUID networkUuid, String variantId, String nadRequestInfos) {
var uriComponentsBuilder = UriComponentsBuilder.fromPath(DELIMITER + SINGLE_LINE_DIAGRAM_API_VERSION +
"/network-area-diagram/{networkUuid}")
.queryParam(QUERY_PARAM_DEPTH, depth)
.queryParam(QUERY_PARAM_INIT_WITH_GEO_DATA, withGeoData);
"/network-area-diagram/{networkUuid}");
if (!StringUtils.isBlank(variantId)) {
uriComponentsBuilder.queryParam(QUERY_PARAM_VARIANT_ID, variantId);
}
var path = uriComponentsBuilder
.buildAndExpand(networkUuid)
.toUriString();
String result;
try {
result = restTemplate.postForObject(singleLineDiagramServerBaseUri + path, voltageLevelsIds, String.class);
} catch (HttpStatusCodeException e) {
if (HttpStatus.NOT_FOUND.equals(e.getStatusCode())) {
throw new StudyException(SVG_NOT_FOUND, VOLTAGE_LEVEL + voltageLevelsIds + NOT_FOUND);
} else {
throw e;
}
}
return result;
}

public String getNetworkAreaDiagram(UUID networkUuid, String variantId, String elementParams) {
var uriComponentsBuilder = UriComponentsBuilder.fromPath(DELIMITER + SINGLE_LINE_DIAGRAM_API_VERSION +
"/network-area-diagram/{networkUuid}")
.queryParam(QUERY_PARAM_ELEMENT_PARAMS, URLEncoder.encode(elementParams, StandardCharsets.UTF_8));
if (!StringUtils.isBlank(variantId)) {
uriComponentsBuilder.queryParam(QUERY_PARAM_VARIANT_ID, variantId);
}
var path = uriComponentsBuilder
.buildAndExpand(networkUuid)
.toUriString();
String result;
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> request = new HttpEntity<>(nadRequestInfos, headers);

try {
result = restTemplate.getForObject(singleLineDiagramServerBaseUri + path, String.class);
return restTemplate.postForObject(singleLineDiagramServerBaseUri + path, request, String.class);
} catch (HttpStatusCodeException e) {
if (HttpStatus.NOT_FOUND.equals(e.getStatusCode())) {
throw new StudyException(SVG_NOT_FOUND, ELEMENT + NOT_FOUND);
throw new StudyException(SVG_NOT_FOUND, VOLTAGE_LEVEL + NOT_FOUND);
} else {
throw e;
}
}
return result;
}

public void setSingleLineDiagramServerBaseUri(String singleLineDiagramServerBaseUri) {
Expand Down
17 changes: 2 additions & 15 deletions src/main/java/org/gridsuite/study/server/service/StudyService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1301,27 +1301,14 @@ public String getSubstationSvgAndMetadata(String substationId, DiagramParameters
}
}

public String getNetworkAreaDiagram(UUID nodeUuid, UUID rootNetworkUuid, List<String> voltageLevelsIds, int depth, boolean withGeoData) {
public String getNetworkAreaDiagram(UUID nodeUuid, UUID rootNetworkUuid, String nadRequestInfos) {
UUID networkUuid = rootNetworkService.getNetworkUuid(rootNetworkUuid);
if (networkUuid == null) {
throw new StudyException(ROOT_NETWORK_NOT_FOUND);
}
String variantId = networkModificationTreeService.getVariantId(nodeUuid, rootNetworkUuid);
if (networkStoreService.existVariant(networkUuid, variantId)) {
return singleLineDiagramService.getNetworkAreaDiagram(networkUuid, variantId, voltageLevelsIds, depth, withGeoData);
} else {
return null;
}
}

public String getNetworkAreaDiagram(UUID nodeUuid, UUID rootNetworkUuid, String elementParams) {
UUID networkUuid = rootNetworkService.getNetworkUuid(rootNetworkUuid);
if (networkUuid == null) {
throw new StudyException(ROOT_NETWORK_NOT_FOUND);
}
String variantId = networkModificationTreeService.getVariantId(nodeUuid, rootNetworkUuid);
if (networkStoreService.existVariant(networkUuid, variantId)) {
return singleLineDiagramService.getNetworkAreaDiagram(networkUuid, variantId, elementParams);
return singleLineDiagramService.getNetworkAreaDiagram(networkUuid, variantId, nadRequestInfos);
} else {
return null;
}
Expand Down
70 changes: 48 additions & 22 deletions src/test/java/org/gridsuite/study/server/NetworkAreaDiagramTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.testcontainers.shaded.com.fasterxml.jackson.core.JsonProcessingException;
import org.testcontainers.shaded.com.fasterxml.jackson.databind.ObjectMapper;

import java.net.URLEncoder;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.nio.charset.StandardCharsets;

import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

Expand Down Expand Up @@ -60,7 +62,6 @@ class NetworkAreaDiagramTest {
private static final UUID ELEMENT_UUID = UUID.randomUUID();
private static final UUID ROOTNETWORK_UUID = UUID.randomUUID();
private static final UUID NODE_UUID = UUID.randomUUID();
private static final String ELEMENT_PARAMETERS = "{\"elementType\":\"DIAGRAM_CONFIG\",\"elementUuid\":\"" + ELEMENT_UUID + "\"}";

@BeforeEach
void setUp() {
Expand All @@ -74,59 +75,84 @@ void setUp() {
when(networkStoreService.getVariantsInfos(NETWORK_UUID)).thenReturn(List.of(new VariantInfos(VariantManagerConstants.INITIAL_VARIANT_ID, 0)));
}

private String createNadRequestInfos(
UUID nadConfigUuid,
UUID filterUuid,
List<String> voltageLevelIds,
List<String> voltageLevelToExpandIds,
List<String> voltageLevelToOmitIds,
boolean withGeoData
) throws JsonProcessingException {
Map<String, Object> requestBody = new HashMap<>();
requestBody.put("nadConfigUuid", nadConfigUuid);
requestBody.put("filterUuid", filterUuid);
requestBody.put("voltageLevelIds", voltageLevelIds);
requestBody.put("voltageLevelToExpandIds", voltageLevelToExpandIds);
requestBody.put("voltageLevelToOmitIds", voltageLevelToOmitIds);
requestBody.put("positions", List.of());
requestBody.put("withGeoData", withGeoData);

ObjectMapper objectMapper = new ObjectMapper();
return objectMapper.writeValueAsString(requestBody);
}

@Test
void testGetNetworkAreaDiagramFromConfig() throws Exception {
UUID stubId = wireMockServer.stubFor(WireMock.get(WireMock.urlPathMatching(SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + ".*"))
String nadRequestConfigInfos = createNadRequestInfos(ELEMENT_UUID, null, List.of(), List.of(), List.of(), true);
UUID stubId = wireMockServer.stubFor(WireMock.post(WireMock.urlPathMatching(SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + ".*"))
.withRequestBody(equalTo(nadRequestConfigInfos))
.willReturn(WireMock.ok()
.withHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
.withBody("nad-svg-from-config")
)).getId();

mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
mockMvc.perform(post("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
NETWORK_UUID, ROOTNETWORK_UUID, NODE_UUID)
.param("elementParams", ELEMENT_PARAMETERS)
.content(nadRequestConfigInfos).contentType(MediaType.APPLICATION_JSON)
.header("userId", USER1))
.andExpectAll(status().isOk(), content().string("nad-svg-from-config"))
.andReturn();

wireMockUtils.verifyGetRequest(stubId, SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + NETWORK_UUID, Map.of(
"elementParams", WireMock.equalTo(URLEncoder.encode(ELEMENT_PARAMETERS, StandardCharsets.UTF_8)),
"variantId", WireMock.equalTo(VariantManagerConstants.INITIAL_VARIANT_ID)));
wireMockUtils.verifyPostRequest(stubId, SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + NETWORK_UUID, false, Map.of("variantId", WireMock.equalTo(VariantManagerConstants.INITIAL_VARIANT_ID)), nadRequestConfigInfos);
}

@Test
void testGetNetworkAreaDiagramFromConfigVariantError() throws Exception {
when(networkModificationTreeService.getVariantId(NODE_UUID, ROOTNETWORK_UUID)).thenReturn("Another_variant");
String nadRequestConfigInfos = createNadRequestInfos(ELEMENT_UUID, null, List.of(), List.of(), List.of(), true);

mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
when(networkModificationTreeService.getVariantId(NODE_UUID, ROOTNETWORK_UUID)).thenReturn("Another_variant");
mockMvc.perform(post("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
NETWORK_UUID, ROOTNETWORK_UUID, NODE_UUID)
.param("elementParams", ELEMENT_PARAMETERS)
.content(nadRequestConfigInfos).contentType(MediaType.APPLICATION_JSON)
.header("userId", USER1))
.andExpectAll(status().isNoContent());
}

@Test
void testGetNetworkAreaDiagramFromConfigRootNetworkError() throws Exception {
mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
String nadRequestConfigInfos = createNadRequestInfos(ELEMENT_UUID, null, List.of(), List.of(), List.of(), true);

mockMvc.perform(post("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
UUID.randomUUID(), UUID.randomUUID(), UUID.randomUUID())
.param("elementParams", ELEMENT_PARAMETERS)
.content(nadRequestConfigInfos).contentType(MediaType.APPLICATION_JSON)
.header("userId", USER1))
.andExpectAll(status().isNotFound());
}

@Test
void testGetNetworkAreaDiagramFromConfigElementUuidNotFound() throws Exception {
UUID stubId = wireMockServer.stubFor(WireMock.get(WireMock.urlPathMatching(SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + ".*"))
String nadRequestConfigInfos = createNadRequestInfos(ELEMENT_UUID, null, List.of(), List.of(), List.of(), true);

UUID stubId = wireMockServer.stubFor(WireMock.post(WireMock.urlPathMatching(SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + ".*"))
.withRequestBody(equalTo(nadRequestConfigInfos))
.willReturn(WireMock.notFound())).getId();

mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
mockMvc.perform(post("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/network-area-diagram",
NETWORK_UUID, ROOTNETWORK_UUID, NODE_UUID)
.param("elementParams", ELEMENT_PARAMETERS)
.content(nadRequestConfigInfos).contentType(MediaType.APPLICATION_JSON)
.header("userId", USER1))
.andExpectAll(status().isNotFound());

wireMockUtils.verifyGetRequest(stubId, SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + NETWORK_UUID, Map.of(
"elementParams", WireMock.equalTo(URLEncoder.encode(ELEMENT_PARAMETERS, StandardCharsets.UTF_8)),
"variantId", WireMock.equalTo(VariantManagerConstants.INITIAL_VARIANT_ID)));
wireMockUtils.verifyPostRequest(stubId, SINGLE_LINE_DIAGRAM_SERVER_BASE_URL + NETWORK_UUID, Map.of(
"variantId", WireMock.equalTo(VariantManagerConstants.INITIAL_VARIANT_ID)));
}
}
Loading