Represent subnetworks in network-area diagrams#669

Merged

So-Fras merged 24 commits intomainfrom

nad-subnetwork-highlight

Mar 29, 2025

Contributor

quinarygio commented Jan 20, 2025 •

edited by So-Fras

Loading

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)

Does this PR already have an issue describing the problem?

Fixes #611

What kind of change does this PR introduce?

What is the current behavior?

What is the new behavior (if this is a feature change)?

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)

Other information:


          Represent subnetworks in network-area diagrams

844cca2

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>

quinarygio marked this pull request as draft

January 20, 2025 16:51

quinarygio added 2 commits

January 21, 2025 09:41


          Fix sonar issues

09236a1

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>


          Fix sonar issue

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>

quinarygio marked this pull request as ready for review

January 21, 2025 11:55

Member

So-Fras commented Jan 24, 2025 •

edited

Loading

Thanks for the work!

As discussed together:

It was not mentioned in the issue but it would be great if users could choose whether or not they want to highlight subnetworks. Maybe, via a new SvgParameters boolean attribute? The SvgWriter has already access to the SvgParameters. There can be a if condition using this new SvgParameters boolean that would trigger the duplication of lines and nodes (or not). Furthermore, this way, all the duplicated parts would be grouped together in the svg.
The Graph should not be the object to hold information on style (it's only nodes and edges) --> the NetworkGraphBuilder class should not be affected by this PR
The StyleProvider "family" should be the one affected by the PR. In the if condition in the SvgWriter mentioned above, we would call a new specific method of the StyleProvider for highlight. Thus, the StyleProvider does not need to "know" whether the user wants to highlight something or not.

quinarygio added 4 commits

January 30, 2025 10:42


          Move highlight logic to StyleProvider

bed6cc1

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>


          Svg separated highlight section

03a71a1

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>


          Fix sonar issue. Remove unnecessary attributes from highligh section

8510e07

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>


          Fix sonar issues

cd69050

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>

So-Fras requested changes

View reviewed changes

Member

So-Fras left a comment

Thanks for the changes! I think the PR is in line with the code's "philosophy".
There is just a small typo in a name.
As for the unit test barrier, I think you should add tests to cover a few more lines and reach the 90%.

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgParameters.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgParameters.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgParameters.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgParameters.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated


          Fix typo and increase code coverage.

2333a90

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>

So-Fras approved these changes

View reviewed changes

So-Fras requested a review from flo-dup

February 18, 2025 17:48

So-Fras added the Release 03/2025 label

So-Fras and others added 2 commits

February 28, 2025 09:38


          Merge branch 'main' into nad-subnetwork-highlight

88a36fd


          Fix test after merge with main

d2e7faa

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

Member

So-Fras commented Feb 28, 2025

Now I think about it, we should add some documentation on this feature. I am adding the "do-not-merge" label until then.
@quinarygio I will add the documentation for this PR.

So-Fras added the PR: do-not-merge label


          First attempt at documentation

2f2dd4f

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

So-Fras removed the PR: do-not-merge label

flo-dup added 2 commits

March 25, 2025 22:47


          Merge branch 'main' into nad-subnetwork-highlight

70e509f

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>


          Update unit test references

4c8ef81

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>

flo-dup requested changes

View reviewed changes

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated

network-area-diagram/src/test/resources/subnetwork_highlight.svg Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

flo-dup and others added 4 commits

March 26, 2025 14:54


          Merge branch 'main' into nad-subnetwork-highlight

1a64e59


          Merge branch 'main' into nad-subnetwork-highlight

cf761b1


          Fix after merge

2d07b2a

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>


          Fixes after review

df8fa8c

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>

flo-dup requested changes

View reviewed changes

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgWriter.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

flo-dup reviewed

View reviewed changes

network-area-diagram/src/main/java/com/powsybl/nad/svg/SvgParameters.java Outdated


          New fixes after review

d799456

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>

flo-dup requested changes

View reviewed changes

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

network-area-diagram/src/main/java/com/powsybl/nad/svg/iidm/AbstractVoltageStyleProvider.java Outdated

flo-dup requested changes

View reviewed changes

Collaborator

flo-dup left a comment

Could you correct the signoff of the second to last commit 71816fe and then push-force? So that the DCO passes.

network-area-diagram/src/test/java/com/powsybl/nad/svg/SubnetworkHighlightTest.java

+                  @Test
+                  void testSubnetworkHighlight() {
+                      Network network = createWithTieLines();
+                      assertSvgEquals("/subnetwork_highlight.svg", network);

Collaborator

flo-dup Mar 28, 2025

Could you add another test with a partial graph, for instance VoltageLevelFilter.createVoltageLevelDepthFilter(network, "VLHV2", 1)?
So that you test the case of a non-visible edge, and so the coverage will be improved.


          Fix and renane svg parameter from highlightSubnetworks to highlightGraph

25eafde

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>

quinarygio force-pushed the nad-subnetwork-highlight branch from 3015788 to 25eafde Compare

March 28, 2025 13:03

quinarygio and others added 4 commits

March 28, 2025 14:26


          Add test to increase code coverage

8fecd1e

Signed-off-by: Giovanni Ferrari <giovanni.ferrari@soft.it>


          Update doc

c87eaa2

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>


          Merge branch 'main' into nad-subnetwork-highlight

34c57c1

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>


          Rephrase the style for subnetworks

b1b5968

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>

flo-dup approved these changes

View reviewed changes

github-project-automation bot moved this from Waiting for review to Approved in Release 03/2025


          Rephrase again

09eb63c

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>

sonarqubecloud bot commented Mar 28, 2025

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
92.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

So-Fras approved these changes

View reviewed changes

So-Fras merged commit 222b7b9 into main

8 checks passed

So-Fras deleted the nad-subnetwork-highlight branch

March 29, 2025 19:53

github-project-automation bot moved this from Approved to Done in Release 03/2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Release 03/2025