Dynamic Margin Calculation (DMC) - First implementation

Signed-off-by: Thang PHAM <[email protected]>

Author: thangqp

lombok.config

@@ -0,0 +1 @@
+import target/configs/powsybl-build-tools.jar!powsybl-build-tools/lombok.config

pom.xml

@@ -42,14 +42,11 @@
     </developers>
 
     <properties>
-        <gridsuite-dependencies.version>39.0.0</gridsuite-dependencies.version>
+        <gridsuite-dependencies.version>41.0.0</gridsuite-dependencies.version>
         <jib.from.image>powsybl/java-dynawo:3.0.0</jib.from.image>
         <liquibase-hibernate-package>org.gridsuite.dynamicmargincalculation.server</liquibase-hibernate-package>
         <sonar.organization>gridsuite</sonar.organization>
-        <spring-cloud-aws.version>3.2.0</spring-cloud-aws.version>
         <sonar.projectKey>org.gridsuite:dynamic-margin-calculation-server</sonar.projectKey>
-        <!-- FIXME: powsybl-ws-commons modules'version is overloaded in the dependencies section to be removed at next powsybl-ws-dependencies.version upgrade -->
-        <powsybl-ws-commons.version>1.26.0-SNAPSHOT</powsybl-ws-commons.version>
     </properties>
 
     <build>
@@ -92,17 +89,17 @@
             <dependency>
                 <groupId>com.powsybl</groupId>
                 <artifactId>powsybl-computation-local</artifactId>
-                <version>6.8.0-SNAPSHOT</version>
+                <version>6.8.0</version>
             </dependency>
             <dependency>
                 <groupId>com.powsybl</groupId>
                 <artifactId>powsybl-computation</artifactId>
-                <version>6.8.0-SNAPSHOT</version>
+                <version>6.8.0</version>
             </dependency>
             <dependency>
                 <groupId>com.powsybl</groupId>
                 <artifactId>powsybl-iidm-api</artifactId>
-                <version>6.8.0-SNAPSHOT</version>
+                <version>6.8.0</version>
             </dependency>
             <!-- imports -->
             <dependency>
@@ -131,11 +128,6 @@
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-stream</artifactId>
         </dependency>
-        <dependency>
-            <groupId>io.awspring.cloud</groupId>
-            <artifactId>spring-cloud-aws-starter-s3</artifactId>
-            <version>${spring-cloud-aws.version}</version>
-        </dependency>
         <dependency>
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
@@ -152,7 +144,6 @@
         <dependency>
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-ws-commons</artifactId>
-            <version>${powsybl-ws-commons.version}</version>
         </dependency>
         <dependency>
             <groupId>com.powsybl</groupId>

src/main/java/org/gridsuite/dynamicmargincalculation/server/DynamicMarginCalculationApi.java

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2025, 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.dynamicmargincalculation.server;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+public final class DynamicMarginCalculationApi {
+
+    private DynamicMarginCalculationApi() {
+    }
+
+    public static final String API_VERSION = "v1";
+}

src/main/java/org/gridsuite/dynamicmargincalculation/server/DynamicMarginCalculationApplication.java

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2025, 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.dynamicmargincalculation.server;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+@SuppressWarnings("checkstyle:HideUtilityClassConstructor")
+@SpringBootApplication
+public class DynamicMarginCalculationApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(DynamicMarginCalculationApplication.class, args);
+    }
+
+}

src/main/java/org/gridsuite/dynamicmargincalculation/server/DynamicMarginCalculationException.java

@@ -0,0 +1,27 @@
+/**
+ * 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.dynamicmargincalculation.server;
+
+import lombok.Getter;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+@Getter
+public class DynamicMarginCalculationException extends RuntimeException {
+
+    public enum Type {
+        RESULT_UUID_NOT_FOUND,
+    }
+
+    private final Type type;
+
+    public DynamicMarginCalculationException(Type type, String message) {
+        super(message);
+        this.type = type;
+    }
+}

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

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2025, 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.dynamicmargincalculation.server;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+@ControllerAdvice
+public class RestResponseEntityExceptionHandler {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(RestResponseEntityExceptionHandler.class);
+
+    @ExceptionHandler(DynamicMarginCalculationException.class)
+    protected ResponseEntity<Object> handleDynamicSecurityAnalysisException(DynamicMarginCalculationException exception) {
+        if (LOGGER.isErrorEnabled()) {
+            LOGGER.error(exception.getMessage(), exception);
+        }
+
+        DynamicMarginCalculationException.Type type = exception.getType();
+        return switch (type) {
+            case RESULT_UUID_NOT_FOUND
+                    -> ResponseEntity.status(HttpStatus.NOT_FOUND).body(exception.getMessage());
+        };
+    }
+
+}

src/main/java/org/gridsuite/dynamicmargincalculation/server/config/SwaggerConfig.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2025, 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.dynamicmargincalculation.server.config;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.gridsuite.dynamicmargincalculation.server.DynamicMarginCalculationApi;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+@Configuration
+public class SwaggerConfig {
+
+    @Bean
+    public OpenAPI createOpenApi() {
+        return new OpenAPI()
+                .info(new Info()
+                        .title("Dynamic Margin Calculation Server API")
+                        .description("This is the documentation of the Dynamic-Margin-Calculation REST API")
+                        .version(DynamicMarginCalculationApi.API_VERSION));
+    }
+}

src/main/java/org/gridsuite/dynamicmargincalculation/server/controller/SupervisionController.java

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2025, 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.dynamicmargincalculation.server.controller;
+
+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.gridsuite.dynamicmargincalculation.server.DynamicMarginCalculationApi;
+import org.gridsuite.dynamicmargincalculation.server.service.SupervisionService;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+@RestController
+@RequestMapping(value = "/" + DynamicMarginCalculationApi.API_VERSION + "/supervision")
+@Tag(name = "Dynamic margin calculation server - Supervision")
+public class SupervisionController {
+    private final SupervisionService supervisionService;
+
+    public SupervisionController(SupervisionService supervisionService) {
+        this.supervisionService = supervisionService;
+    }
+
+    @GetMapping(value = "/results-count")
+    @Operation(summary = "Get results count")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The count of all results")})
+    public ResponseEntity<Integer> getResultsCount() {
+        return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(supervisionService.getResultsCount());
+    }
+}

src/main/java/org/gridsuite/dynamicmargincalculation/server/dto/DynamicMarginCalculationStatus.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025, 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.dynamicmargincalculation.server.dto;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+public enum DynamicMarginCalculationStatus {
+    NOT_DONE,
+    RUNNING,
+    SUCCEED,
+    FAILED
+}

src/main/java/org/gridsuite/dynamicmargincalculation/server/entities/DynamicMarginCalculationResultEntity.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2025, 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.dynamicmargincalculation.server.entities;
+
+import jakarta.persistence.*;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import org.gridsuite.dynamicmargincalculation.server.dto.DynamicMarginCalculationStatus;
+
+import java.util.UUID;
+
+/**
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
+ */
+@Getter
+@Setter
+@Table(name = "dynamic_margin_calculation_result")
+@NoArgsConstructor
+@Entity
+public class DynamicMarginCalculationResultEntity {
+
+    public DynamicMarginCalculationResultEntity(UUID id, DynamicMarginCalculationStatus status) {
+        this.id = id;
+        this.status = status;
+    }
+
+    @Id
+    @Column(name = "result_uuid")
+    private UUID id;
+
+    @Column(name = "status")
+    @Enumerated(EnumType.STRING)
+    private DynamicMarginCalculationStatus status;
+
+}