Export execution details #1193
Merged
Export execution details #1193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Philippe Edwards <[email protected]>
Signed-off-by: Philippe Edwards <[email protected]>
phiedw
added
breaking-change
Signed-off-by: Philippe Edwards <[email protected]>
Signed-off-by: Philippe Edwards <[email protected]>
Signed-off-by: Philippe Edwards <[email protected]>
Signed-off-by: Philippe Edwards <[email protected]>
Signed-off-by: Philippe Edwards <[email protected]>
|
Part of this PR can actually make debugging harder because you lose access to the stack trace. Should I add a business error log in the catch to log the error and its stack trace? |
… the information Signed-off-by: Philippe Edwards <[email protected]>
Added a business error |
Godelaine
requested changes
Nov 28, 2024
| @@ -66,8 +65,8 @@ public RaoResult deserialize(JsonParser jsonParser, DeserializationContext deser | |||
| raoResult.setComputationStatus(deserializeStatus(jsonParser.nextTextValue())); | |||
| break; | |||
|
|
|||
| case OPTIMIZATION_STEPS_EXECUTED: | |||
| raoResult.setOptimizationStepsExecuted(deserializeOptimizedStepsExecuted(jsonParser.nextTextValue())); | |||
| case OPTIMIZATION_STEPS_EXECUTED, EXECUTION_DETAILS: | |||
There was a problem hiding this comment.
should this be handled as a version increment, with a checkDeprecatedField ?
|
|
||
| if (!(raoResult instanceof FailedRaoResultImpl)) { | ||
| OptimizationStepsExecuted optimizationStepsExecuted = raoResult.getOptimizationStepsExecuted(); | ||
| jsonGenerator.writeStringField(OPTIMIZATION_STEPS_EXECUTED, serializeOptimizedStepsExecuted(optimizationStepsExecuted)); | ||
| jsonGenerator.writeStringField(EXECUTION_DETAILS, raoResult.getExecutionDetails()); |
There was a problem hiding this comment.
EXECUTION_DETAILS written twice
There was a problem hiding this comment.
I'm surprised this was not caught by a unit test, I'll add one
| assertEquals("The RaoResult object should not be modified outside of its usual routine", exception.getMessage()); | ||
| exception = assertThrows(OpenRaoException.class, () -> output.setOptimizationStepsExecuted(OptimizationStepsExecuted.FIRST_PREVENTIVE_FELLBACK_TO_INITIAL_SITUATION)); | ||
| assertEquals("The RaoResult object should not be modified outside of its usual routine", exception.getMessage()); | ||
| setUp(); |
There was a problem hiding this comment.
already called with @beforeeach
Godelaine
added
the
PR: waiting-for-correction
# Conflicts: # data/rao-result/rao-result-api/src/test/java/com/powsybl/openrao/data/raoresult/api/OptimizationStepsExecutedTest.java # data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/RaoResultJsonConstants.java # data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/RaoResultSerializer.java # data/rao-result/rao-result-io/rao-result-json/src/test/java/com/powsybl/openrao/data/raoresult/io/json/RaoResultJsonConstantsTest.java # ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/FailedRaoResultImpl.java # ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/FailedRaoResultImplTest.java
Signed-off-by: Thomas Bouquet <[email protected]>
… ordering of states in range action results Signed-off-by: Philippe Edwards <[email protected]>
…/open-rao into export_execution_details Signed-off-by: Philippe Edwards <[email protected]>
Signed-off-by: Godelaine de Montmorillon <[email protected]>
Godelaine
approved these changes
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
Fixes #1137
What kind of change does this PR introduce?
Feature
What is the current behavior?
The RaoResult only exports executed steps (for non failing RAOs)
What is the new behavior (if this is a feature change)?
We now export either the steps executed or a failure reason (as a string). Also surronded the main parts of the RAO to be able to return a FailedRaoResult instead of crashing when an unexpected RuntimeException happens.
Does this PR introduce a breaking change or deprecate an API?
If yes, please check if the following requirements are fulfilled
What changes might users need to make in their application due to this PR? (migration steps)
If you use RaoResult.getOptimizationSteps, you will have to replace it with RaoResult.getExecutionDetails