Springboot 3.3.3 migration

pom.xml

@@ -13,7 +13,7 @@
     <parent>
         <groupId>com.powsybl</groupId>
         <artifactId>powsybl-parent-ws</artifactId>
-        <version>17</version>
+        <version>20</version>
         <relativePath/>
     </parent>
 
@@ -48,7 +48,7 @@
 
         <mockito-inline.version>3.11.1</mockito-inline.version>
         <log4j2-mock-version>0.0.2</log4j2-mock-version>
-        <powsybl-ws-dependencies.version>2.9.0</powsybl-ws-dependencies.version>
+        <powsybl-ws-dependencies.version>2.14.0</powsybl-ws-dependencies.version>
         <testcontainers.version>1.18.3</testcontainers.version>
     </properties>
 
@@ -143,10 +143,6 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-actuator</artifactId>
-        </dependency>
         <!-- jpa, crud repository -->
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -224,6 +220,16 @@
             <artifactId>log4j-over-slf4j</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-registry-prometheus</artifactId>
+            <scope>runtime</scope>
+        </dependency>
         <!-- Test dependencies -->
         <dependency>
             <groupId>com.google.guava</groupId>

src/main/java/com/powsybl/caseserver/CaseController.java

@@ -123,9 +123,10 @@ public ResponseEntity<byte[]> downloadCase(@PathVariable("caseUuid") UUID caseUu
     public ResponseEntity<byte[]> exportCase(
             @PathVariable UUID caseUuid,
             @RequestParam String format,
+            @RequestParam(value = "fileName", required = false) String fileName,
             @RequestBody(required = false) Map<String, Object> formatParameters) throws IOException {
         LOGGER.debug("exportCase request received with parameter caseUuid = {}", caseUuid);
-        return caseService.exportCase(caseUuid, format, formatParameters).map(networkInfos -> {
+        return caseService.exportCase(caseUuid, format, fileName, formatParameters).map(networkInfos -> {
             var headers = new HttpHeaders();
             headers.setContentDisposition(
                     ContentDisposition.builder("attachment")
@@ -151,22 +152,23 @@ public ResponseEntity<Boolean> exists(@PathVariable("caseUuid") UUID caseUuid) {
     @Operation(summary = "import a case")
     @SuppressWarnings("javasecurity:S5145")
     public ResponseEntity<UUID> importCase(@RequestParam("file") MultipartFile file,
-                                           @RequestParam(value = "withExpiration", required = false, defaultValue = "false") boolean withExpiration) {
+                                           @RequestParam(value = "withExpiration", required = false, defaultValue = "false") boolean withExpiration,
+                                           @RequestParam(value = "withIndexation", required = false, defaultValue = "false") boolean withIndexation) {
         LOGGER.debug("importCase request received with file = {}", file.getName());
-        UUID caseUuid = caseService.importCase(file, withExpiration);
+        UUID caseUuid = caseService.importCase(file, withExpiration, withIndexation);
         return ResponseEntity.ok().body(caseUuid);
     }
 
-    @PostMapping(value = "/cases")
+    @PostMapping(value = "/cases", params = "duplicateFrom")
     @Operation(summary = "create a case from an existing one")
     @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The case has been duplicated"),
         @ApiResponse(responseCode = "404", description = "Source case not found"),
         @ApiResponse(responseCode = "500", description = "An error occurred during the case file duplication")})
     public ResponseEntity<UUID> duplicateCase(
-            @RequestParam("duplicateFrom") UUID sourceCaseUuid,
+            @RequestParam("duplicateFrom") UUID caseId,
             @RequestParam(value = "withExpiration", required = false, defaultValue = "false") boolean withExpiration) {
-        LOGGER.debug("duplicateCase request received with parameter sourceCaseUuid = {}", sourceCaseUuid);
-        UUID newCaseUuid = caseService.duplicateCase(sourceCaseUuid, withExpiration);
+        LOGGER.debug("duplicateCase request received with parameter sourceCaseUuid = {}", caseId);
+        UUID newCaseUuid = caseService.duplicateCase(caseId, withExpiration);
         return ResponseEntity.ok().body(newCaseUuid);
     }
 
@@ -205,14 +207,6 @@ public ResponseEntity<List<CaseInfos>> searchCases(@RequestParam(value = "q") St
         return ResponseEntity.ok().body(cases);
     }
 
-    @PostMapping(value = "/cases/reindex-all")
-    @Operation(summary = "reindex all cases")
-    public ResponseEntity<Void> reindexAllCases() {
-        LOGGER.debug("reindex all cases request received");
-        caseService.reindexAllCases();
-        return ResponseEntity.ok().build();
-    }
-
     @GetMapping(value = "/cases/metadata")
     @Operation(summary = "Get cases Metadata")
     public ResponseEntity<List<CaseInfos>> getMetadata(@RequestParam("ids") List<UUID> ids) {

src/main/java/com/powsybl/caseserver/CaseService.java

@@ -15,13 +15,13 @@
 import com.powsybl.caseserver.repository.CaseMetadataEntity;
 import com.powsybl.caseserver.repository.CaseMetadataRepository;
 import com.powsybl.commons.datasource.DataSource;
+import com.powsybl.commons.datasource.DataSourceUtil;
 import com.powsybl.commons.datasource.MemDataSource;
 import com.powsybl.computation.ComputationManager;
 import com.powsybl.computation.local.LocalComputationManager;
 import com.powsybl.iidm.network.Exporter;
 import com.powsybl.iidm.network.Importer;
 import com.powsybl.iidm.network.Network;
-import org.apache.commons.io.FilenameUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -44,22 +44,16 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
-import java.time.LocalDateTime;
-import java.time.ZoneOffset;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.Properties;
-import java.util.UUID;
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
+import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 
 import static com.powsybl.caseserver.CaseException.createDirectoryNotFound;
+import static com.powsybl.caseserver.dto.CaseInfos.*;
 
 /**
  * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
@@ -121,7 +115,7 @@ public List<CaseInfos> getCases(Path directory) {
 
     private CaseInfos getCaseInfos(Path file) {
         try {
-            return createInfos(file.getFileName().toString(), UUID.fromString(file.getParent().getFileName().toString()), getFormat(file));
+            return createInfos(file, UUID.fromString(file.getParent().getFileName().toString()));
         } catch (Exception e) {
             LOGGER.error("Error processing file {}: {}", file.getFileName(), e.getMessage(), e);
             return null;
@@ -179,7 +173,7 @@ boolean caseExists(UUID caseName) {
         return Files.exists(caseFile) && Files.isRegularFile(caseFile);
     }
 
-    UUID importCase(MultipartFile mpf, boolean withExpiration) {
+    UUID importCase(MultipartFile mpf, boolean withExpiration, boolean withIndexation) {
         checkStorageInitialization();
 
         UUID caseUuid = UUID.randomUUID();
@@ -214,9 +208,11 @@ UUID importCase(MultipartFile mpf, boolean withExpiration) {
             throw e;
         }
 
-        createCaseMetadataEntity(caseUuid, withExpiration);
+        createCaseMetadataEntity(caseUuid, withExpiration, withIndexation);
         CaseInfos caseInfos = createInfos(caseFile.getFileName().toString(), caseUuid, importer.getFormat());
-        caseInfosService.addCaseInfos(caseInfos);
+        if (withIndexation) {
+            caseInfosService.addCaseInfos(caseInfos);
+        }
         sendImportMessage(caseInfos.createMessage());
         return caseUuid;
     }
@@ -235,10 +231,13 @@ UUID duplicateCase(UUID sourceCaseUuid, boolean withExpiration) {
             newCaseFile = newCaseUuidDirectory.resolve(existingCaseFile.getFileName());
             Files.copy(existingCaseFile, newCaseFile, StandardCopyOption.COPY_ATTRIBUTES);
 
-            CaseInfos existingCaseInfos = caseInfosService.getCaseInfosByUuid(sourceCaseUuid.toString()).orElseThrow();
-            CaseInfos caseInfos = createInfos(existingCaseInfos.getName(), newCaseUuid, existingCaseInfos.getFormat());
-            caseInfosService.addCaseInfos(caseInfos);
-            createCaseMetadataEntity(newCaseUuid, withExpiration);
+            CaseMetadataEntity existingCase = getCaseMetaDataEntity(sourceCaseUuid);
+            CaseInfos caseInfos = createInfos(newCaseFile, newCaseUuid);
+            if (existingCase.isIndexed()) {
+                caseInfosService.addCaseInfos(caseInfos);
+            }
+
+            createCaseMetadataEntity(newCaseUuid, withExpiration, existingCase.isIndexed());
 
             sendImportMessage(caseInfos.createMessage());
             return newCaseUuid;
@@ -248,12 +247,28 @@ UUID duplicateCase(UUID sourceCaseUuid, boolean withExpiration) {
         }
     }
 
-    private void createCaseMetadataEntity(UUID newCaseUuid, boolean withExpiration) {
-        LocalDateTime expirationTime = null;
+    private CaseInfos createInfos(Path caseFile, UUID caseUuid) {
+        return createInfos(caseFile.getFileName().toString(), caseUuid, getFormat(caseFile));
+    }
+
+    private CaseMetadataEntity getCaseMetaDataEntity(UUID caseUuid) {
+        return caseMetadataRepository.findById(caseUuid).orElseThrow(() -> new ResponseStatusException(HttpStatus.NOT_FOUND, "case " + caseUuid + " not found"));
+    }
+
+    private void createCaseMetadataEntity(UUID newCaseUuid, boolean withExpiration, boolean withIndexation) {
+        Instant expirationTime = null;
         if (withExpiration) {
-            expirationTime = LocalDateTime.now(ZoneOffset.UTC).plusHours(1);
+            expirationTime = Instant.now().plus(1, ChronoUnit.HOURS);
         }
-        caseMetadataRepository.save(new CaseMetadataEntity(newCaseUuid, expirationTime));
+        caseMetadataRepository.save(new CaseMetadataEntity(newCaseUuid, expirationTime, withIndexation));
+    }
+
+    public List<CaseInfos> getCasesToReindex() {
+        Set<UUID> casesToReindex = caseMetadataRepository.findAllByIndexedTrue()
+                .stream()
+                .map(CaseMetadataEntity::getId)
+                .collect(Collectors.toSet());
+        return getCases(getStorageRootDir()).stream().filter(c -> casesToReindex.contains(c.getUuid())).toList();
     }
 
     CaseInfos createInfos(String fileBaseName, UUID caseUuid, String format) {
@@ -269,7 +284,7 @@ CaseInfos createInfos(String fileBaseName, UUID caseUuid, String format) {
 
     @Transactional
     public void disableCaseExpiration(UUID caseUuid) {
-        CaseMetadataEntity caseMetadataEntity = caseMetadataRepository.findById(caseUuid).orElseThrow(() -> new ResponseStatusException(HttpStatus.NOT_FOUND, "case " + caseUuid + " not found"));
+        CaseMetadataEntity caseMetadataEntity = getCaseMetaDataEntity(caseUuid);
         caseMetadataEntity.setExpirationDate(null);
     }
 
@@ -373,10 +388,6 @@ private void sendImportMessage(Message<String> message) {
         caseInfosPublisher.send("publishCaseImport-out-0", message);
     }
 
-    public void reindexAllCases() {
-        caseInfosService.recreateAllCaseInfos(getCases(getStorageRootDir()));
-    }
-
     public List<CaseInfos> getMetadata(List<UUID> ids) {
         List<CaseInfos> cases = new ArrayList<>();
         ids.forEach(caseUuid -> {
@@ -408,7 +419,7 @@ Optional<byte[]> getCaseBytes(UUID caseUuid) {
         return Optional.empty();
     }
 
-    public Optional<ExportCaseInfos> exportCase(UUID caseUuid, String format, Map<String, Object> formatParameters) throws IOException {
+    public Optional<ExportCaseInfos> exportCase(UUID caseUuid, String format, String fileName, Map<String, Object> formatParameters) throws IOException {
         if (!Exporter.getFormats().contains(format)) {
             throw CaseException.createUnsupportedFormat(format);
         }
@@ -426,17 +437,17 @@ public Optional<ExportCaseInfos> exportCase(UUID caseUuid, String format, Map<St
             network.write(format, exportProperties, memDataSource);
 
             var listNames = memDataSource.listNames(".*");
-            String networkName = FilenameUtils.removeExtension(getCaseName(caseUuid));
+            String fileOrNetworkName = fileName != null ? fileName : DataSourceUtil.getBaseName(getCaseName(caseUuid));
             byte[] networkData;
             if (listNames.size() == 1) {
                 String extension = listNames.iterator().next();
-                networkName += extension;
+                fileOrNetworkName += extension;
                 networkData = memDataSource.getData(extension);
             } else {
-                networkName += ".zip";
+                fileOrNetworkName += ".zip";
                 networkData = createZipFile(listNames, memDataSource);
             }
-            return Optional.of(new ExportCaseInfos(networkName, networkData));
+            return Optional.of(new ExportCaseInfos(fileOrNetworkName, networkData));
         } else {
             return Optional.empty();
         }

src/main/java/com/powsybl/caseserver/ScheduledCaseCleaner.java

@@ -12,8 +12,7 @@
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Service;
 
-import java.time.LocalDateTime;
-import java.time.ZoneOffset;
+import java.time.Instant;
 
 /**
  * @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
@@ -34,10 +33,10 @@ public ScheduledCaseCleaner(CaseMetadataRepository caseMetadataRepository, CaseS
 
     @Scheduled(cron = "${cleaning-cases-cron}", zone = "UTC")
     public void deleteExpiredCases() {
-        LocalDateTime localDateTime = LocalDateTime.now(ZoneOffset.UTC);
-        LOGGER.info("Cleaning cases cron starting execution at {}", localDateTime);
+        Instant now = Instant.now();
+        LOGGER.info("Cleaning cases cron starting execution at {}", now);
         caseMetadataRepository.findAll().stream().filter(caseMetadataEntity -> caseMetadataEntity.getExpirationDate() != null)
-                .filter(caseMetadataEntity -> localDateTime.isAfter(caseMetadataEntity.getExpirationDate()))
+                .filter(caseMetadataEntity -> now.isAfter(caseMetadataEntity.getExpirationDate()))
                 .forEach(caseMetadataEntity -> {
                     caseService.deleteCase(caseMetadataEntity.getId());
                     caseMetadataRepository.deleteById(caseMetadataEntity.getId());

src/main/java/com/powsybl/caseserver/SupervisionController.java

@@ -0,0 +1,82 @@
+/**
+ * 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 com.powsybl.caseserver;
+
+import com.powsybl.caseserver.elasticsearch.CaseInfosService;
+import com.powsybl.caseserver.services.SupervisionService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.data.elasticsearch.client.ClientConfiguration;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+/**
+ * @author Jamal KHEYYAD <jamal.kheyyad at rte-international.com>
+ */
+@RestController
+@RequestMapping(value = "/" + CaseConstants.API_VERSION + "/supervision")
+@Tag(name = "case-server - Supervision")
+public class SupervisionController {
+    private static final Logger LOGGER = LoggerFactory.getLogger(SupervisionController.class);
+
+    private final SupervisionService supervisionService;
+    private final CaseService caseService;
+    private final ClientConfiguration elasticsearchClientConfiguration;
+    private final CaseInfosService caseInfosService;
+
+    public SupervisionController(SupervisionService supervisionService, CaseService caseService, ClientConfiguration elasticsearchClientConfiguration, CaseInfosService caseInfosService) {
+        this.supervisionService = supervisionService;
+        this.caseService = caseService;
+        this.elasticsearchClientConfiguration = elasticsearchClientConfiguration;
+        this.caseInfosService = caseInfosService;
+    }
+
+    @GetMapping(value = "/elasticsearch-host")
+    @Operation(summary = "get the elasticsearch address")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "the elasticsearch address")})
+    public ResponseEntity<String> getElasticsearchHost() {
+        String host = elasticsearchClientConfiguration.getEndpoints().get(0).getHostName()
+                + ":"
+                + elasticsearchClientConfiguration.getEndpoints().get(0).getPort();
+        return ResponseEntity.ok().contentType(MediaType.TEXT_PLAIN).body(host);
+    }
+
+    @GetMapping(value = "/cases/index-name")
+    @Operation(summary = "get the indexed cases index name")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Indexed directory cases index name")})
+    public ResponseEntity<String> getIndexedCasesFIndexName() {
+        return ResponseEntity.ok().contentType(MediaType.TEXT_PLAIN).body(caseInfosService.getDirectoryCasesIndexName());
+    }
+
+    @PostMapping(value = "/cases/reindex")
+    @Operation(summary = "reindex all cases")
+    public ResponseEntity<Void> reindexAllCases() {
+        LOGGER.debug("reindex all cases request received");
+        caseInfosService.recreateAllCaseInfos(caseService.getCasesToReindex());
+        return ResponseEntity.ok().build();
+    }
+
+    @DeleteMapping(value = "/cases/indexation")
+    @Operation(summary = "delete indexed cases")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "all indexed cases have been deleted")})
+    public ResponseEntity<String> deleteIndexedCases() {
+        return ResponseEntity.ok().contentType(MediaType.TEXT_PLAIN).body(Long.toString(supervisionService.deleteIndexedCases()));
+    }
+
+    @GetMapping(value = "/cases/indexation-count")
+    @Operation(summary = "get indexed cases count")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Indexed cases count")})
+    public ResponseEntity<String> getIndexedCasesCount() {
+        return ResponseEntity.ok().contentType(MediaType.TEXT_PLAIN).body(Long.toString(supervisionService.getIndexedCasesCount()));
+    }
+
+}