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.

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

Add network events to IIDM API #3203

Merged
merged 11 commits into from
Nov 12, 2024
Merged

Add network events to IIDM API #3203

merged 11 commits into from
Nov 12, 2024

Conversation

geofjamg
Copy link
Member

@geofjamg geofjamg commented Nov 7, 2024

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?

No

What kind of change does this PR introduce?

Feature

What is the current behavior?

Network notifications unit testing is hard and not done the same way everywhere.

What is the new behavior (if this is a feature change)?
We added in the API a network event data model and an network listener responsible for event recording that will be used at the end in every notification unit tests and also maybe for other use cases.

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)

NetworkListener has been modified with breaking changes:

  • onUpdate overload without variant ID has been removed, we expect now to one with variant ID to use everywhere and with a null variantId in case of attribute that do not depend on variant.
  • onElementAdded has been renamed onPropertyAdded and default empty implementation has been removed
  • onElementReplaced has been renamed onPropertyReplaced and default empty implementation has been removed
  • onElementRemoved has been renamed onPropertyRemoved and default empty implementation has been removed
  • default empty implementation of onVariantCreated, onVariantOverwritten, onVariantRemoved have been removed

Substation geographicalTags attribute is no more an (old) element type notification but a standard attrbute notification

Other information:

Signed-off-by: Geoffroy Jamgotchian <[email protected]>
Signed-off-by: Geoffroy Jamgotchian <[email protected]>
Signed-off-by: Geoffroy Jamgotchian <[email protected]>
Signed-off-by: Geoffroy Jamgotchian <[email protected]>
@geofjamg geofjamg changed the title [WIP] Add network events to IIDM API Add network events to IIDM API Nov 8, 2024
@geofjamg geofjamg added the Breaking Change API is broken label Nov 8, 2024
Signed-off-by: Geoffroy Jamgotchian <[email protected]>
Signed-off-by: Geoffroy Jamgotchian <[email protected]>
Signed-off-by: Geoffroy Jamgotchian <[email protected]>
Copy link

sonarcloud bot commented Nov 12, 2024

@flo-dup flo-dup merged commit b49d67d into main Nov 12, 2024
7 checks passed
@flo-dup flo-dup deleted the network_events branch November 12, 2024 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change API is broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants