Skip to content

Fix ReportNode use in ValidationUtil #3353

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.

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

Merged
merged 13 commits into from
Jul 1, 2025
Merged

Conversation

flo-dup
Copy link
Collaborator

@flo-dup flo-dup commented Mar 11, 2025

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • A PR or issue has been opened in all impacted repositories (if any)

Does this PR already have an issue describing the problem?
No

What kind of change does this PR introduce?
Bug fix

What is the current behavior?
The ReportNode is used in ValidationUtil

  1. with generated keys (Validable::getMessageHeader) for message template
  2. with missing id information: the message lacks the correct information which is expected by the user: the information given by Validable::getMessageTemplate was used as a template key, hence never displayed to the user.

What is the new behavior (if this is a feature change)?
The ReportNode is used in ValidationUtil

  1. with fixed keys for a given template
  2. with the id information as typed value

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

  • NetworkReports.parentHasBothRatioAndPhaseTapChanger(ReportNode reportNode, String parentMessage) was replaced by NetworkReports.transformerHasBothRatioAndPhaseTapChanger(ReportNode reportNode, String id).
  • NetworkReports.parentHasDuplicatePointForActivePower(ReportNode reportNode, String ownerMessage, Double p) was replaced by NetworkReports.parentHasDuplicatePointForActivePower(ReportNode reportNode, String id, Double p).
  • Users which were using a custom iidm implementation need to return a MessageHeader instead of a String for getMessageHeader method in the classes implementing Validable.

@flo-dup flo-dup requested a review from alicecaron March 11, 2025 14:22
@alicecaron alicecaron moved this from TODO to In Progress in Release 06/2025 Mar 12, 2025
Base automatically changed from use_i18n to integration/report_node_i18n March 12, 2025 08:57
@flo-dup flo-dup force-pushed the validation_util_report_node branch from e9ad2e9 to 412f277 Compare March 12, 2025 09:02
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
78.1% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@flo-dup flo-dup force-pushed the integration/report_node_i18n branch from 70c192d to a6957c2 Compare March 17, 2025 16:30
@alicecaron alicecaron force-pushed the validation_util_report_node branch from 412f277 to a9787e0 Compare March 20, 2025 09:11
@alicecaron alicecaron changed the base branch from integration/report_node_i18n to main March 20, 2025 09:50
flo-dup added 3 commits June 26, 2025 23:14
Signed-off-by: Florian Dupuy <[email protected]>
Signed-off-by: Florian Dupuy <[email protected]>
@flo-dup flo-dup force-pushed the validation_util_report_node branch from a9787e0 to 58d79a5 Compare June 26, 2025 21:28
@github-project-automation github-project-automation bot moved this from In Progress to Waiting for review in Release 06/2025 Jun 27, 2025
@flo-dup flo-dup changed the title Partly clean ReportNode use in ValidationUtil Fix ReportNode use in ValidationUtil Jun 30, 2025
@flo-dup flo-dup added the Breaking Change API is broken label Jun 30, 2025
@github-project-automation github-project-automation bot moved this from Waiting for review to Approved in Release 06/2025 Jul 1, 2025
@alicecaron alicecaron mentioned this pull request Jul 1, 2025
8 tasks
Copy link

sonarqubecloud bot commented Jul 1, 2025

Quality Gate Failed Quality Gate failed

Failed conditions
53.8% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@olperr1 olperr1 merged commit 0c46264 into main Jul 1, 2025
8 of 9 checks passed
@olperr1 olperr1 deleted the validation_util_report_node branch July 1, 2025 11:27
@github-project-automation github-project-automation bot moved this from Approved to Done in Release 06/2025 Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants