Change mapping to post and pass ids (substations/voltage levels) in request body (#139)

Signed-off-by: BOUHOURS Antoine <[email protected]>

Author: antoinebhs

src/main/java/com/powsybl/sld/server/GeoDataService.java

@@ -28,7 +28,7 @@ public class GeoDataService {
     public static final String GEO_DATA_API_VERSION = "v1";
     public static final String QUERY_PARAM_VARIANT_ID = "variantId";
     public static final String NETWORK_UUID = "networkUuid";
-    static final String SUBSTATIONS = "substations";
+    static final String SUBSTATIONS_INFOS = "substations/infos";
     private static final String DELIMITER = "/";
     private final RestTemplate restTemplate;
     @Setter
@@ -45,22 +45,18 @@ private String getGeoDataServerURI() {
     }
 
     public String getSubstationsGraphics(UUID networkUuid, String variantId, List<String> substationsIds) {
-        UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromHttpUrl(getGeoDataServerURI() + SUBSTATIONS)
+        UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromHttpUrl(getGeoDataServerURI() + SUBSTATIONS_INFOS)
                 .queryParam(NETWORK_UUID, networkUuid);
 
         if (!StringUtils.isBlank(variantId)) {
             uriComponentsBuilder.queryParam(QUERY_PARAM_VARIANT_ID, variantId);
         }
 
-        if (substationsIds != null) {
-            uriComponentsBuilder.queryParam(QUERY_PARAM_SUBSTATION_ID, substationsIds);
-        }
-
         var path = uriComponentsBuilder
                 .buildAndExpand()
                 .toUriString();
 
-        return restTemplate.getForObject(path, String.class);
+        return restTemplate.postForObject(path, substationsIds, String.class);
     }
 }
 

src/main/java/com/powsybl/sld/server/SingleLineDiagramController.java

@@ -260,12 +260,12 @@ public ResponseEntity<Collection<String>> getAvailableSvgComponentLibraries() {
     }
 
     // network area diagram
-    @GetMapping(value = "/network-area-diagram/{networkUuid}", produces = MediaType.APPLICATION_JSON_VALUE)
+    @PostMapping(value = "/network-area-diagram/{networkUuid}", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
     @Operation(summary = "Get network area diagram image")
     @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The network area diagram svg")})
     public @ResponseBody String getNetworkAreaDiagramSvg(
             @Parameter(description = "Network UUID") @PathVariable("networkUuid") UUID networkUuid,
-            @Parameter(description = "Voltage levels ids") @RequestParam(name = "voltageLevelsIds", required = false) List<String> voltageLevelsIds,
+            @RequestBody List<String> voltageLevelsIds,
             @Parameter(description = "Variant Id") @RequestParam(name = "variantId", required = false) String variantId,
             @Parameter(description = "depth") @RequestParam(name = "depth", required = false) int depth,
             @Parameter(description = "Initialize NAD with Geographical Data") @RequestParam(name = "withGeoData", defaultValue = "true") boolean withGeoData) {

src/test/java/com/powsybl/sld/server/GeoDataServiceTest.java

@@ -50,7 +50,7 @@ void testGetSubstationsGraphics() {
         List<String> substationsIds = List.of("subFr1", "subFr2");
 
         String expectedResponse = "Substations graphics data";
-        when(restTemplate.getForObject(ArgumentMatchers.anyString(), ArgumentMatchers.eq(String.class)))
+        when(restTemplate.postForObject(ArgumentMatchers.anyString(), ArgumentMatchers.anyList(), ArgumentMatchers.eq(String.class)))
                 .thenReturn(expectedResponse);
 
         String response = geoDataService.getSubstationsGraphics(networkUuid, variantId, substationsIds);
@@ -67,7 +67,7 @@ void testGetSubstationsGraphicsWithoutVariantId() {
         substationGeoData.setCoordinate(new Coordinate(48.8588443, 2.2943506));
         substationGeoData.setCountry(Country.FR);
         String expectedResponse = substationGeoData.toString();
-        when(restTemplate.getForObject(ArgumentMatchers.anyString(), ArgumentMatchers.eq(String.class)))
+        when(restTemplate.postForObject(ArgumentMatchers.anyString(), ArgumentMatchers.anyList(), ArgumentMatchers.eq(String.class)))
                 .thenReturn(expectedResponse);
 
         String response = geoDataService.getSubstationsGraphics(networkUuid, null, substationsIds);

src/test/java/com/powsybl/sld/server/SingleLineDiagramTest.java

@@ -63,6 +63,7 @@
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 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;
 
@@ -318,7 +319,9 @@ void testNetworkAreaDiagram() throws Exception {
         given(networkStoreService.getNetwork(testNetworkId, PreloadingStrategy.COLLECTION)).willReturn(createNetwork());
         given(networkStoreService.getNetwork(notFoundNetworkId, PreloadingStrategy.COLLECTION)).willThrow(new PowsyblException());
 
-        MvcResult result = mvc.perform(get("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=0" + "&voltageLevelsIds=vlFr1A", testNetworkId))
+        MvcResult result = mvc.perform(post("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=0", testNetworkId)
+                        .contentType(MediaType.APPLICATION_JSON)
+                        .content("[\"vlFr1A\"]"))
                 .andExpect(status().isOk())
                 .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON_VALUE))
                 .andReturn();
@@ -328,7 +331,9 @@ void testNetworkAreaDiagram() throws Exception {
         assertTrue(stringResult.contains("additionalMetadata"));
         assertTrue(stringResult.contains("<?xml"));
 
-        result = mvc.perform(get("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=2" + "&voltageLevelsIds=vlFr1A", testNetworkId))
+        mvc.perform(post("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=2", testNetworkId)
+                        .contentType(MediaType.APPLICATION_JSON)
+                        .content("[\"vlFr1A\"]"))
                 .andExpect(status().isOk())
                 .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON_VALUE))
                 .andReturn();
@@ -338,7 +343,9 @@ void testNetworkAreaDiagram() throws Exception {
         assertTrue(stringResult.contains("additionalMetadata"));
         assertTrue(stringResult2.contains("<?xml"));
 
-        mvc.perform(get("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=2" + "&voltageLevelsIds=notFound", testNetworkId))
+        mvc.perform(post("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=2", testNetworkId)
+                        .contentType(MediaType.APPLICATION_JSON)
+                        .content("[\"notFound\"]"))
                 .andExpect(status().isNotFound());
     }
 
@@ -659,7 +666,9 @@ void testNetworkAreaDiagramWithMissingVoltageLevel() throws Exception {
         assertNotNull(voltageLevels);
         assertEquals(1, voltageLevels.size());
         assertEquals("vlFr1A", voltageLevels.get(0).get("id"));
-        mvc.perform(get("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=0" + "&voltageLevelsIds=vlNotFound1,vlNotFound2", testNetworkId))
+        mvc.perform(post("/v1/network-area-diagram/{networkUuid}?variantId=" + VARIANT_2_ID + "&depth=0", testNetworkId)
+                .contentType(MediaType.APPLICATION_JSON)
+                .content("[\"vlNotFound1\", \"vlNotFound2\"]"))
                 .andExpect(status().isNotFound());
     }