Add endpoint to reset spreadsheet config filters (#815)

Signed-off-by: Hugo Marcellin <[email protected]>

Author: Meklo

src/main/java/org/gridsuite/study/server/controller/SpreadsheetConfigController.java

@@ -130,4 +130,16 @@ public ResponseEntity<Void> renameSpreadsheetConfig(
         studyService.renameSpreadsheetConfig(studyUuid, id, name);
         return ResponseEntity.noContent().build();
     }
+
+    @PutMapping("/{id}/reset-filters")
+    @Operation(summary = "Reset global and column filters",
+            description = "Reset all columns filters in a spreadsheet configuration as well as the global filter")
+    @ApiResponse(responseCode = "204", description = "Filters reset successfully")
+    @ApiResponse(responseCode = "404", description = "Spreadsheet configuration not found")
+    public ResponseEntity<Void> resetFilters(
+            @PathVariable("studyUuid") UUID studyUuid,
+            @Parameter(description = "ID of the spreadsheet config") @PathVariable UUID id) {
+        studyService.resetFilters(studyUuid, id);
+        return ResponseEntity.noContent().build();
+    }
 }

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

@@ -389,6 +389,16 @@ public void setGlobalFilters(UUID configUuid, String globalFilters) {
         }
     }
 
+    public void resetFilters(UUID configUuid) {
+        String path = UriComponentsBuilder.fromPath(DELIMITER + STUDY_CONFIG_API_VERSION + SPREADSHEET_CONFIG_WITH_ID_URI + "/reset-filters")
+                .buildAndExpand(configUuid).toUriString();
+        try {
+            restTemplate.exchange(studyConfigServerBaseUri + path, HttpMethod.PUT, null, UUID.class);
+        } catch (HttpStatusCodeException e) {
+            throw handleHttpError(e, UPDATE_SPREADSHEET_CONFIG_FAILED);
+        }
+    }
+
     public DiagramGridLayout getDiagramGridLayout(UUID diagramGridLayoutUuid) {
         Objects.requireNonNull(diagramGridLayoutUuid);
         String path = UriComponentsBuilder.fromPath(DELIMITER + STUDY_CONFIG_API_VERSION + DIAGRAM_GRID_LAYOUT_WITH_ID_URI)

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

@@ -3422,6 +3422,11 @@ public void reorderSpreadsheetConfigs(UUID studyUuid, UUID collectionUuid, List<
         notificationService.emitSpreadsheetCollectionChanged(studyUuid, collectionUuid);
     }
 
+    public void resetFilters(UUID studyUuid, UUID configUuid) {
+        studyConfigService.resetFilters(configUuid);
+        notificationService.emitSpreadsheetConfigChanged(studyUuid, configUuid);
+    }
+
     @Transactional(readOnly = true)
     public String getVoltageInitResult(UUID nodeUuid, UUID rootNetworkUuid, String globalFilters) {
         UUID networkuuid = rootNetworkService.getNetworkUuid(rootNetworkUuid);

src/test/java/org/gridsuite/study/server/SpreadsheetConfigTest.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.WireMock;
+import mockwebserver3.MockWebServer;
 import mockwebserver3.junit5.internal.MockWebServerExtension;
 import org.gridsuite.study.server.notification.NotificationService;
 import org.gridsuite.study.server.repository.StudyEntity;
@@ -35,9 +36,9 @@
 
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put;
-import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 /**
@@ -238,6 +239,23 @@ void testSetGlobalFilters() throws Exception {
         wireMockUtils.verifyPostRequest(stubId, configServerUrl, false, Map.of(), globalFilters);
     }
 
+    @Test
+    void testResetFilters(final MockWebServer server) throws Exception {
+        StudyEntity studyEntity = insertStudy();
+        final String configServerUrl = "/v1/spreadsheet-configs/" + SPREADSHEET_CONFIG_UUID + "/reset-filters";
+
+        UUID stubId = wireMockServer.stubFor(WireMock.put(WireMock.urlPathEqualTo(configServerUrl))
+                .willReturn(WireMock.noContent())).getId();
+
+        mockMvc.perform(put("/v1/studies/{studyUuid}/spreadsheet-config/{configUuid}/reset-filters", studyEntity.getId(), SPREADSHEET_CONFIG_UUID)
+                        .header("content-type", "application/json"))
+                .andExpect(status().isNoContent())
+                .andReturn();
+
+        checkSpreadsheetTabUpdateMessageReceived(studyEntity.getId());
+        wireMockUtils.verifyPutRequest(stubId, configServerUrl, false, Map.of(), null);
+    }
+
     private StudyEntity insertStudy() {
         StudyEntity studyEntity = TestUtils.createDummyStudy(NETWORK_UUID, "netId", CASE_UUID, "", "", SPREADSHEET_CONFIG_UUID);
         var study = studyRepository.save(studyEntity);