Resolve comments, add metadata endpoint

Signed-off-by: achour94 <[email protected]>

Author: achour94

pom.xml

@@ -42,7 +42,7 @@
     </developers>
 
     <properties>
-        <gridsuite-dependencies.version>33</gridsuite-dependencies.version>
+        <gridsuite-dependencies.version>34</gridsuite-dependencies.version>
         <liquibase-hibernate-package>org.gridsuite.spreadsheetconfig.server</liquibase-hibernate-package>
     </properties>
 
@@ -82,7 +82,6 @@
 
     <dependencies>
         <!-- Compilation dependencies -->
-        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId></dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
@@ -131,11 +130,6 @@
             <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>

src/main/java/org/gridsuite/spreadsheetconfig/server/RestResponseEntityExceptionHandler.java

@@ -20,8 +20,7 @@
 public class RestResponseEntityExceptionHandler {
 
     @ExceptionHandler(EntityNotFoundException.class)
-    protected ResponseEntity<Object> handleEntityNotFound(
-            EntityNotFoundException ex, WebRequest request) {
+    protected ResponseEntity<Object> handleEntityNotFound(EntityNotFoundException ex, WebRequest request) {
         String bodyOfResponse = ex.getMessage();
         return new ResponseEntity<>(bodyOfResponse, HttpStatus.NOT_FOUND);
     }

src/main/java/org/gridsuite/spreadsheetconfig/server/RestTemplateConfig.java

@@ -6,14 +6,9 @@
  */
 package org.gridsuite.spreadsheetconfig.server;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
-import org.springframework.boot.jackson.JsonComponentModule;
+import org.springframework.boot.web.client.RestTemplateBuilder;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.http.converter.HttpMessageConverter;
-import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
-import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
 import org.springframework.web.client.RestTemplate;
 
 /**
@@ -23,36 +18,8 @@
 public class RestTemplateConfig {
 
     @Bean
-    public RestTemplate restTemplate() {
-        final RestTemplate restTemplate = new RestTemplate();
-
-        //find and replace Jackson message converter with our own
-        for (int i = 0; i < restTemplate.getMessageConverters().size(); i++) {
-            final HttpMessageConverter<?> httpMessageConverter = restTemplate.getMessageConverters().get(i);
-            if (httpMessageConverter instanceof MappingJackson2HttpMessageConverter) {
-                restTemplate.getMessageConverters().set(i, mappingJackson2HttpMessageConverter());
-            }
-        }
-
-        return restTemplate;
-    }
-
-    public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
-        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
-        converter.setObjectMapper(objectMapper());
-        return converter;
-    }
-
-    private ObjectMapper createObjectMapper() {
-        var objectMapper = Jackson2ObjectMapperBuilder.json().build();
-        objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
-        objectMapper.registerModule(new JsonComponentModule());
-        return objectMapper;
-    }
-
-    @Bean
-    public ObjectMapper objectMapper() {
-        return createObjectMapper();
+    public RestTemplate restTemplate(RestTemplateBuilder builder) {
+        return builder.build();
     }
 }
 

src/main/java/org/gridsuite/spreadsheetconfig/server/SwaggerConfig.java

@@ -21,8 +21,8 @@ public class SwaggerConfig {
     public OpenAPI openAPI() {
         return new OpenAPI()
                 .info(new Info()
-                        .title("Spreadsheet Config API")
-                        .description("This is the documentation of the spreadsheet config REST API")
-                        .version(SpreadsheetConfigApi.API_VERSION));
+                .title("Spreadsheet Config API")
+                .description("This is the documentation of the spreadsheet config REST API")
+                .version(SpreadsheetConfigApi.API_VERSION));
     }
 }

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

@@ -15,7 +15,8 @@
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.gridsuite.spreadsheetconfig.server.SpreadsheetConfigApi;
-import org.gridsuite.spreadsheetconfig.server.dto.SpreadsheetConfigDto;
+import org.gridsuite.spreadsheetconfig.server.dto.MetadataInfos;
+import org.gridsuite.spreadsheetconfig.server.dto.SpreadsheetConfigInfos;
 import org.gridsuite.spreadsheetconfig.server.service.SpreadsheetConfigService;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -44,7 +45,7 @@ public class SpreadsheetConfigController {
             description = "Creates a new spreadsheet configuration and returns its ID")
     @ApiResponse(responseCode = "201", description = "Configuration created",
             content = @Content(schema = @Schema(implementation = UUID.class)))
-    public ResponseEntity<UUID> createSpreadsheetConfig(@Parameter(description = "Configuration to save") @Valid @RequestBody SpreadsheetConfigDto dto) {
+    public ResponseEntity<UUID> createSpreadsheetConfig(@Parameter(description = "Configuration to save") @Valid @RequestBody SpreadsheetConfigInfos dto) {
         UUID id = spreadsheetConfigService.createSpreadsheetConfig(dto);
         return ResponseEntity.status(HttpStatus.CREATED).body(id);
     }
@@ -56,28 +57,36 @@ public ResponseEntity<UUID> createSpreadsheetConfig(@Parameter(description = "Co
             content = @Content(schema = @Schema(implementation = UUID.class)))
     @ApiResponse(responseCode = "404", description = "Configuration not found")
     public ResponseEntity<UUID> duplicateSpreadsheetConfig(@Parameter(description = "UUID of the configuration to duplicate") @RequestParam(name = DUPLICATE_FROM) UUID id) {
-        return spreadsheetConfigService.duplicateSpreadsheetConfig(id)
-                .map(newId -> ResponseEntity.status(HttpStatus.CREATED).body(newId))
-                .orElse(ResponseEntity.notFound().build());
+        UUID newId = spreadsheetConfigService.duplicateSpreadsheetConfig(id);
+        return ResponseEntity.status(HttpStatus.CREATED).body(newId);
     }
 
     @GetMapping("/{id}")
     @Operation(summary = "Get a spreadsheet configuration",
             description = "Retrieves a spreadsheet configuration by its ID")
     @ApiResponse(responseCode = "200", description = "Configuration found",
-            content = @Content(schema = @Schema(implementation = SpreadsheetConfigDto.class)))
+            content = @Content(schema = @Schema(implementation = SpreadsheetConfigInfos.class)))
     @ApiResponse(responseCode = "404", description = "Configuration not found")
-    public ResponseEntity<SpreadsheetConfigDto> getSpreadsheetConfig(
+    public ResponseEntity<SpreadsheetConfigInfos> getSpreadsheetConfig(
             @Parameter(description = "ID of the configuration to retrieve") @PathVariable UUID id) {
-        return ResponseEntity.of(spreadsheetConfigService.getSpreadsheetConfig(id));
+        return ResponseEntity.ok(spreadsheetConfigService.getSpreadsheetConfig(id));
+    }
+
+    @GetMapping("/metadata")
+    @Operation(summary = "Get spreadsheet configurations metadata",
+            description = "Retrieves metadata of spreadsheet configurations by their IDs")
+    @ApiResponse(responseCode = "200", description = "Metadata found",
+            content = @Content(schema = @Schema(implementation = MetadataInfos.class)))
+    public ResponseEntity<List<MetadataInfos>> getSpreadsheetConfigsMetadata(@RequestParam List<UUID> ids) {
+        return ResponseEntity.ok(spreadsheetConfigService.getSpreadsheetConfigsMetadata(ids));
     }
 
     @GetMapping
     @Operation(summary = "Get all spreadsheet configurations",
             description = "Retrieves all spreadsheet configurations")
     @ApiResponse(responseCode = "200", description = "List of configurations",
-            content = @Content(schema = @Schema(implementation = SpreadsheetConfigDto.class)))
-    public ResponseEntity<List<SpreadsheetConfigDto>> getAllSpreadsheetConfigs() {
+            content = @Content(schema = @Schema(implementation = SpreadsheetConfigInfos.class)))
+    public ResponseEntity<List<SpreadsheetConfigInfos>> getAllSpreadsheetConfigs() {
         return ResponseEntity.ok(spreadsheetConfigService.getAllSpreadsheetConfigs());
     }
 
@@ -88,7 +97,7 @@ public ResponseEntity<List<SpreadsheetConfigDto>> getAllSpreadsheetConfigs() {
     @ApiResponse(responseCode = "404", description = "Configuration not found")
     public ResponseEntity<Void> updateSpreadsheetConfig(
             @Parameter(description = "ID of the configuration to update") @PathVariable UUID id,
-            @Valid @RequestBody SpreadsheetConfigDto dto) {
+            @Valid @RequestBody SpreadsheetConfigInfos dto) {
         spreadsheetConfigService.updateSpreadsheetConfig(id, dto);
         return ResponseEntity.noContent().build();
     }

src/main/java/org/gridsuite/spreadsheetconfig/server/dto/CustomColumnDto.java renamed to src/main/java/org/gridsuite/spreadsheetconfig/server/dto/CustomColumnInfos.java

@@ -8,30 +8,17 @@
 
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.extern.jackson.Jacksonized;
-
-import java.util.UUID;
 
 /**
  * @author Achour BERRAHMA <achour.berrahma at rte-france.com>
  */
-@Data
-@AllArgsConstructor
-@Builder
-@Jacksonized
 @Schema(name = "CustomColumnDto", description = "Custom column configuration")
-public class CustomColumnDto {
-
-    @Schema(description = "Custom column ID")
-    UUID id;
+public record CustomColumnInfos(
 
     @NotNull(message = "Column name is mandatory")
     @Schema(description = "Column name")
-    String name;
+    String name,
 
     @Schema(description = "Column formula")
-    String formula;
-}
+    String formula
+) { }

src/main/java/org/gridsuite/spreadsheetconfig/server/dto/MetadataInfos.java

@@ -0,0 +1,26 @@
+/**
+ * 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.spreadsheetconfig.server.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.gridsuite.spreadsheetconfig.server.constants.SheetType;
+
+import java.util.UUID;
+
+/**
+ * @author Achour BERRAHMA <achour.berrahma at rte-france.com>
+ */
+@Schema(name = "MetadataDto", description = "Spreadsheet configuration metadata")
+public record MetadataInfos(
+
+    @Schema(description = "Spreadsheet configuration ID")
+    UUID id,
+
+    @Schema(description = "Spreadsheet type")
+    SheetType sheetType
+
+) { }

src/main/java/org/gridsuite/spreadsheetconfig/server/dto/SpreadsheetConfigDto.java renamed to src/main/java/org/gridsuite/spreadsheetconfig/server/dto/SpreadsheetConfigInfos.java

@@ -8,9 +8,6 @@
 
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotNull;
-import lombok.Builder;
-import lombok.Value;
-import lombok.extern.jackson.Jacksonized;
 import org.gridsuite.spreadsheetconfig.server.constants.SheetType;
 
 import java.util.List;
@@ -19,19 +16,16 @@
 /**
  * @author Achour BERRAHMA <achour.berrahma at rte-france.com>
  */
-@Value
-@Builder
-@Jacksonized
 @Schema(name = "SpreadsheetConfigDto", description = "Spreadsheet configuration")
-public class SpreadsheetConfigDto {
+public record SpreadsheetConfigInfos(
 
     @Schema(description = "Spreadsheet configuration ID")
-    UUID id;
+    UUID id,
 
     @NotNull(message = "Sheet type is mandatory")
     @Schema(description = "Spreadsheet type")
-    SheetType sheetType;
+    SheetType sheetType,
 
     @Schema(description = "Custom columns")
-    List<CustomColumnDto> customColumns;
-}
+    List<CustomColumnInfos> customColumns
+) { }

src/main/java/org/gridsuite/spreadsheetconfig/server/entities/CustomColumnEntity.java renamed to src/main/java/org/gridsuite/spreadsheetconfig/server/entities/CustomColumnEmbeddable.java

@@ -9,32 +9,21 @@
 import jakarta.persistence.*;
 import lombok.*;
 
-import java.util.UUID;
-
 /**
  * @author Achour BERRAHMA <achour.berrahma at rte-france.com>
  */
-@Entity
-@Table(name = "spreadsheet_custom_column")
+@Embeddable
 @Getter
 @Setter
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
-public class CustomColumnEntity {
-
-    @Id
-    @GeneratedValue(strategy = GenerationType.AUTO)
-    @Column(name = "id")
-    private UUID id;
+public class CustomColumnEmbeddable {
 
     @Column(name = "name", nullable = false, columnDefinition = "varchar(255)")
     private String name;
 
-    @Column(name = "formula", columnDefinition = "varchar(255)")
+    @Column(name = "formula", columnDefinition = "CLOB")
     private String formula;
 
-    @ManyToOne(fetch = FetchType.LAZY)
-    @JoinColumn(name = "spreadsheet_config_id", nullable = false, foreignKey = @ForeignKey(name = "spreadsheet_config_id_fk_constraint"))
-    private SpreadsheetConfigEntity spreadsheetConfig;
 }

src/main/java/org/gridsuite/spreadsheetconfig/server/entities/SpreadsheetConfigEntity.java

@@ -35,8 +35,12 @@ public class SpreadsheetConfigEntity {
     @Enumerated(EnumType.STRING)
     private SheetType sheetType;
 
-    @OneToMany(mappedBy = "spreadsheetConfig", cascade = CascadeType.ALL, orphanRemoval = true)
+    @ElementCollection
+    @CollectionTable(
+            name = "spreadsheet_custom_column",
+            joinColumns = @JoinColumn(name = "spreadsheet_config_id")
+    )
     @Builder.Default
-    private List<CustomColumnEntity> customColumns = new ArrayList<>();
+    private List<CustomColumnEmbeddable> customColumns = new ArrayList<>();
 
 }