Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract computations notification types #620

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Extract computations notification types #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
53f4b67
setip params notification.
AAJELLAL Sep 3, 2024
da714fb
Some cleanup.
AAJELLAL Sep 10, 2024
6a3a5f5
Merge branch 'main' of https://github.com/gridsuite/study-server into…
AAJELLAL Sep 10, 2024
2811124
Merge branch 'main' of https://github.com/gridsuite/study-server into…
AAJELLAL Sep 11, 2024
dc03b0a
Add parameter name to the notification header and fix tests.
AAJELLAL Sep 11, 2024
8e334f0
Send params notification after updating the provider.
AAJELLAL Sep 12, 2024
0fc79bb
Merge branch 'main' of https://github.com/gridsuite/study-server into…
AAJELLAL Sep 12, 2024
9ca36c3
Fix tests.
AAJELLAL Sep 13, 2024
911ceb3
Change some names + fix the review remarks.
AAJELLAL Sep 18, 2024
64cde18
Merge branch 'main' of https://github.com/gridsuite/study-server into…
AAJELLAL Sep 18, 2024
93c9c1e
fix checkstyle.
AAJELLAL Sep 18, 2024
a510096
review remarks.
AAJELLAL Sep 19, 2024
400ef5a
Merge branch 'main' of https://github.com/powsybl/powsybl-study-serve…
Oct 7, 2024
6fddccb
extract ComputationsNotificationTypes
Mathieu-Deharbe Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions src/main/java/org/gridsuite/study/server/dto/ComputationType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
package org.gridsuite.study.server.dto;

import lombok.Getter;
import org.gridsuite.study.server.notification.NotificationService;
import static org.gridsuite.study.server.notification.ComputationsNotificationTypes.*;

@Getter
public enum ComputationType {
LOAD_FLOW("Load flow", "loadFlowResultUuid",
NotificationService.UPDATE_TYPE_LOADFLOW_STATUS, NotificationService.UPDATE_TYPE_LOADFLOW_RESULT,
NotificationService.UPDATE_TYPE_LOADFLOW_FAILED),
UPDATE_TYPE_LOADFLOW_STATUS, UPDATE_TYPE_LOADFLOW_RESULT,
UPDATE_TYPE_LOADFLOW_FAILED),
SECURITY_ANALYSIS("Security analysis", "securityAnalysisResultUuid",
NotificationService.UPDATE_TYPE_SECURITY_ANALYSIS_STATUS, NotificationService.UPDATE_TYPE_SECURITY_ANALYSIS_RESULT,
NotificationService.UPDATE_TYPE_SECURITY_ANALYSIS_FAILED),
UPDATE_TYPE_SECURITY_ANALYSIS_STATUS, UPDATE_TYPE_SECURITY_ANALYSIS_RESULT,
UPDATE_TYPE_SECURITY_ANALYSIS_FAILED),
SENSITIVITY_ANALYSIS("Sensitivity analysis", "sensitivityAnalysisResultUuid",
NotificationService.UPDATE_TYPE_SENSITIVITY_ANALYSIS_STATUS, NotificationService.UPDATE_TYPE_SENSITIVITY_ANALYSIS_RESULT,
NotificationService.UPDATE_TYPE_SENSITIVITY_ANALYSIS_FAILED),
UPDATE_TYPE_SENSITIVITY_ANALYSIS_STATUS, UPDATE_TYPE_SENSITIVITY_ANALYSIS_RESULT,
UPDATE_TYPE_SENSITIVITY_ANALYSIS_FAILED),
NON_EVACUATED_ENERGY_ANALYSIS("Non evacuated energy analysis", "nonEvacuatedEnergyResultUuid",
NotificationService.UPDATE_TYPE_NON_EVACUATED_ENERGY_STATUS, NotificationService.UPDATE_TYPE_NON_EVACUATED_ENERGY_RESULT,
NotificationService.UPDATE_TYPE_NON_EVACUATED_ENERGY_FAILED),
UPDATE_TYPE_NON_EVACUATED_ENERGY_STATUS, UPDATE_TYPE_NON_EVACUATED_ENERGY_RESULT,
UPDATE_TYPE_NON_EVACUATED_ENERGY_FAILED),
SHORT_CIRCUIT("Short circuit analysis", "shortCircuitAnalysisResultUuid",
NotificationService.UPDATE_TYPE_SHORT_CIRCUIT_STATUS, NotificationService.UPDATE_TYPE_SHORT_CIRCUIT_RESULT,
NotificationService.UPDATE_TYPE_SHORT_CIRCUIT_FAILED),
UPDATE_TYPE_SHORT_CIRCUIT_STATUS, UPDATE_TYPE_SHORT_CIRCUIT_RESULT,
UPDATE_TYPE_SHORT_CIRCUIT_FAILED),
VOLTAGE_INITIALIZATION("Voltage init", "voltageInitResultUuid",
NotificationService.UPDATE_TYPE_VOLTAGE_INIT_STATUS, NotificationService.UPDATE_TYPE_VOLTAGE_INIT_RESULT,
NotificationService.UPDATE_TYPE_VOLTAGE_INIT_FAILED),
UPDATE_TYPE_VOLTAGE_INIT_STATUS, UPDATE_TYPE_VOLTAGE_INIT_RESULT,
UPDATE_TYPE_VOLTAGE_INIT_FAILED),
DYNAMIC_SIMULATION("Dynamic simulation", "dynamicSimulationResultUuid",
NotificationService.UPDATE_TYPE_DYNAMIC_SIMULATION_STATUS, NotificationService.UPDATE_TYPE_DYNAMIC_SIMULATION_RESULT,
NotificationService.UPDATE_TYPE_DYNAMIC_SIMULATION_FAILED),
UPDATE_TYPE_DYNAMIC_SIMULATION_STATUS, UPDATE_TYPE_DYNAMIC_SIMULATION_RESULT,
UPDATE_TYPE_DYNAMIC_SIMULATION_FAILED),
SHORT_CIRCUIT_ONE_BUS("One bus Short circuit analysis", "oneBusShortCircuitAnalysisResultUuid",
NotificationService.UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_STATUS, NotificationService.UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_RESULT,
NotificationService.UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_FAILED),
UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_STATUS, UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_RESULT,
UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_FAILED),
STATE_ESTIMATION("State estimation", "stateEstimationResultUuid",
NotificationService.UPDATE_TYPE_STATE_ESTIMATION_STATUS, NotificationService.UPDATE_TYPE_STATE_ESTIMATION_RESULT,
NotificationService.UPDATE_TYPE_STATE_ESTIMATION_FAILED);
UPDATE_TYPE_STATE_ESTIMATION_STATUS, UPDATE_TYPE_STATE_ESTIMATION_RESULT,
UPDATE_TYPE_STATE_ESTIMATION_FAILED);

private final String label; // used for logs
private final String resultUuidLabel;
Expand Down
52 changes: 52 additions & 0 deletions src/main/java/org/gridsuite/study/server/notification/ComputationsNotificationTypes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/**
* 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.study.server.notification;

/**
* @author Mathieu Deharbe <mathieu.deharbe_externe at rte-france.com
*/
public final class ComputationsNotificationTypes {
private ComputationsNotificationTypes() {
// this class should never be constructed
}

public static final String UPDATE_TYPE_LOADFLOW_STATUS = "loadflow_status";
public static final String UPDATE_TYPE_LOADFLOW_RESULT = "loadflowResult";
public static final String UPDATE_TYPE_LOADFLOW_FAILED = "loadflow_failed";

public static final String UPDATE_TYPE_SECURITY_ANALYSIS_STATUS = "securityAnalysis_status";
public static final String UPDATE_TYPE_SECURITY_ANALYSIS_RESULT = "securityAnalysisResult";
public static final String UPDATE_TYPE_SECURITY_ANALYSIS_FAILED = "securityAnalysis_failed";

public static final String UPDATE_TYPE_SENSITIVITY_ANALYSIS_STATUS = "sensitivityAnalysis_status";
public static final String UPDATE_TYPE_SENSITIVITY_ANALYSIS_RESULT = "sensitivityAnalysisResult";
public static final String UPDATE_TYPE_SENSITIVITY_ANALYSIS_FAILED = "sensitivityAnalysis_failed";

public static final String UPDATE_TYPE_NON_EVACUATED_ENERGY_STATUS = "nonEvacuatedEnergy_status";
public static final String UPDATE_TYPE_NON_EVACUATED_ENERGY_RESULT = "nonEvacuatedEnergyResult";
public static final String UPDATE_TYPE_NON_EVACUATED_ENERGY_FAILED = "nonEvacuatedEnergy_failed";

public static final String UPDATE_TYPE_SHORT_CIRCUIT_STATUS = "shortCircuitAnalysis_status";
public static final String UPDATE_TYPE_SHORT_CIRCUIT_RESULT = "shortCircuitAnalysisResult";
public static final String UPDATE_TYPE_SHORT_CIRCUIT_FAILED = "shortCircuitAnalysis_failed";

public static final String UPDATE_TYPE_VOLTAGE_INIT_STATUS = "voltageInit_status";
public static final String UPDATE_TYPE_VOLTAGE_INIT_RESULT = "voltageInitResult";
public static final String UPDATE_TYPE_VOLTAGE_INIT_FAILED = "voltageInit_failed";

public static final String UPDATE_TYPE_DYNAMIC_SIMULATION_STATUS = "dynamicSimulation_status";
public static final String UPDATE_TYPE_DYNAMIC_SIMULATION_RESULT = "dynamicSimulationResult";
public static final String UPDATE_TYPE_DYNAMIC_SIMULATION_FAILED = "dynamicSimulation_failed";

public static final String UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_STATUS = "oneBusShortCircuitAnalysis_status";
public static final String UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_RESULT = "oneBusShortCircuitAnalysisResult";
public static final String UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_FAILED = "oneBusShortCircuitAnalysis_failed";

public static final String UPDATE_TYPE_STATE_ESTIMATION_STATUS = "stateEstimation_status";
public static final String UPDATE_TYPE_STATE_ESTIMATION_RESULT = "stateEstimationResult";
public static final String UPDATE_TYPE_STATE_ESTIMATION_FAILED = "stateEstimation_failed";
}
39 changes: 12 additions & 27 deletions src/main/java/org/gridsuite/study/server/notification/NotificationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.gridsuite.study.server.dto.ComputationType;
import org.gridsuite.study.server.dto.StudyIndexationStatus;
import org.gridsuite.study.server.networkmodificationtree.dto.InsertMode;
import org.gridsuite.study.server.notification.dto.NetworkImpactsInfos;
Expand Down Expand Up @@ -38,6 +39,7 @@ public class NotificationService {
public static final String HEADER_NODES = "nodes";
public static final String HEADER_STUDY_UUID = "studyUuid";
public static final String HEADER_UPDATE_TYPE = "updateType";
public static final String HEADER_COMPUTATION_TYPE = "computationType";
public static final String HEADER_UPDATE_TYPE_SUBSTATIONS_IDS = "substationsIds";
public static final String HEADER_USER_ID = "userId";
public static final String HEADER_MODIFIED_BY = "modifiedBy";
Expand All @@ -47,39 +49,13 @@ public class NotificationService {
public static final String UPDATE_TYPE_BUILD_CANCELLED = "buildCancelled";
public static final String UPDATE_TYPE_BUILD_COMPLETED = "buildCompleted";
public static final String UPDATE_TYPE_BUILD_FAILED = "buildFailed";
public static final String UPDATE_TYPE_LOADFLOW_RESULT = "loadflowResult";
public static final String UPDATE_TYPE_LOADFLOW_STATUS = "loadflow_status";
public static final String UPDATE_TYPE_LOADFLOW_FAILED = "loadflow_failed";
public static final String UPDATE_TYPE_SECURITY_ANALYSIS_FAILED = "securityAnalysis_failed";
public static final String UPDATE_TYPE_SECURITY_ANALYSIS_RESULT = "securityAnalysisResult";
public static final String UPDATE_TYPE_SECURITY_ANALYSIS_STATUS = "securityAnalysis_status";
public static final String UPDATE_TYPE_SENSITIVITY_ANALYSIS_RESULT = "sensitivityAnalysisResult";
public static final String UPDATE_TYPE_SENSITIVITY_ANALYSIS_STATUS = "sensitivityAnalysis_status";
public static final String UPDATE_TYPE_SENSITIVITY_ANALYSIS_FAILED = "sensitivityAnalysis_failed";
public static final String UPDATE_TYPE_NON_EVACUATED_ENERGY_RESULT = "nonEvacuatedEnergyResult";
public static final String UPDATE_TYPE_NON_EVACUATED_ENERGY_STATUS = "nonEvacuatedEnergy_status";
public static final String UPDATE_TYPE_NON_EVACUATED_ENERGY_FAILED = "nonEvacuatedEnergy_failed";
public static final String UPDATE_TYPE_SHORT_CIRCUIT_RESULT = "shortCircuitAnalysisResult";
public static final String UPDATE_TYPE_SHORT_CIRCUIT_STATUS = "shortCircuitAnalysis_status";
public static final String UPDATE_TYPE_SHORT_CIRCUIT_FAILED = "shortCircuitAnalysis_failed";
public static final String UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_RESULT = "oneBusShortCircuitAnalysisResult";
public static final String UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_STATUS = "oneBusShortCircuitAnalysis_status";
public static final String UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_FAILED = "oneBusShortCircuitAnalysis_failed";
public static final String UPDATE_TYPE_DYNAMIC_SIMULATION_FAILED = "dynamicSimulation_failed";
public static final String UPDATE_TYPE_DYNAMIC_SIMULATION_RESULT = "dynamicSimulationResult";
public static final String UPDATE_TYPE_DYNAMIC_SIMULATION_STATUS = "dynamicSimulation_status";
public static final String UPDATE_TYPE_VOLTAGE_INIT_RESULT = "voltageInitResult";
public static final String UPDATE_TYPE_VOLTAGE_INIT_STATUS = "voltageInit_status";
public static final String UPDATE_TYPE_VOLTAGE_INIT_FAILED = "voltageInit_failed";
public static final String UPDATE_TYPE_VOLTAGE_INIT_CANCEL_FAILED = "voltageInit_cancel_failed";
public static final String UPDATE_TYPE_STUDIES = "studies";
public static final String UPDATE_TYPE_STUDY_NETWORK_RECREATION_DONE = "study_network_recreation_done";
public static final String UPDATE_TYPE_STUDY = "study";
public static final String UPDATE_TYPE_STUDY_METADATA_UPDATED = "metadata_updated";
public static final String UPDATE_TYPE_INDEXATION_STATUS = "indexation_status_updated";
public static final String UPDATE_TYPE_STATE_ESTIMATION_FAILED = "stateEstimation_failed";
public static final String UPDATE_TYPE_STATE_ESTIMATION_RESULT = "stateEstimationResult";
public static final String UPDATE_TYPE_STATE_ESTIMATION_STATUS = "stateEstimation_status";
public static final String UPDATE_TYPE_COMPUTATION_PARAMETERS = "computationParametersUpdated";

public static final String MODIFICATIONS_CREATING_IN_PROGRESS = "creatingInProgress";
public static final String MODIFICATIONS_STASHING_IN_PROGRESS = "stashingInProgress";
Expand Down Expand Up @@ -166,6 +142,15 @@ public void emitStudyChanged(UUID studyUuid, UUID nodeUuid, String updateType) {
.build());
}

@PostCompletion
public void emitComputationParamsChanged(UUID studyUuid, ComputationType computationType) {
sendUpdateMessage(MessageBuilder.withPayload("")
.setHeader(HEADER_STUDY_UUID, studyUuid)
.setHeader(HEADER_UPDATE_TYPE, UPDATE_TYPE_COMPUTATION_PARAMETERS)
.setHeader(HEADER_COMPUTATION_TYPE, computationType.name())
.build());
}

public void emitStudyCreationError(UUID studyUuid, String userId, String errorMessage) {
sendUpdateMessage(MessageBuilder.withPayload("")
.setHeader(HEADER_STUDY_UUID, studyUuid)
Expand Down
Loading
Loading