Implementation of SumState-Alerting (BREAKING UI+Backend/Odoo changes!) #2260

da-Kai · 2023-07-10T14:03:05Z

Description:

Notify specific users of the persistent presence of a negative sumState.

Planed Features

React and send mail on sumState
Improved data structure for growing alerting requirements and settings
Unit-Tests
UI settings

Odoo changes

OpenEMS/odoo-openems#3

DerStoecki · 2023-07-14T08:14:48Z

io.openems.backend.alerting/src/io/openems/backend/alerting/handler/SumStateHandler.java

+				final var edgeOpt = this.metadata.getEdge(edgeId);
+				edgeOpt.ifPresent(edge -> {
+					if (level.isAtLeast(Level.FAULT)) {
+						this.tryAddEdge(edge, level);
+					} else {
+						this.tryRemoveEdge(edge);
+					}


Hey @da-Kai

Thank you for providing your wip.
I was able to compare your implementation to mine and I got a good idea of your intention with your implementation.

I know that you stated in your general code you will "Improved data structure for growing alerting requirements and settings"
I just wanted to ask if the line 141

level.isAtLeast(Level.FAULT)

will be configurable in future iterations (so that different users can be notified on different sumStates)?

Thank you in advance.

Hey @DerStoecki

I have inserted this filter for test purposes only. Later this will be configurable.

Separate Odoo-Table for Alerting-Settings;

Move "io.openems.edge.common.test.TimeLeapClock" to "io.openems.common.test.TimeLeapClock";

+ Integration tests for Offline- and SumState-Alerting; + Adapt UI + Change Odoo-Model Settings

# Conflicts: # io.openems.backend.metadata.odoo/src/io/openems/backend/metadata/odoo/MetadataOdoo.java

# Conflicts: # io.openems.backend.alerting/test/io/openems/backend/alerting/handler/TestOfflineEdgeHandler.java # io.openems.edge.battery.fenecon.home/test/io/openems/edge/battery/fenecon/home/BatteryFeneconHomeImplTest.java # io.openems.edge.controller.ess.timeofusetariff.discharge/test/io/openems/edge/controller/ess/timeofusetariff/discharge/ControllerEssTimeOfUseTariffDischargeImplTest.java

This commits refactors the generation of JsonArrays in the JsonUtils class in io.openems.common.utils. This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

This commit adds a constructor, with an Instant Option only. This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

* EventBuilder received a Build method for new Events and * EventReader received toString, hashCode and equals method This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

This doesn't do anything yet. But will in the future, when AlertingSettings get refactored to UserAlertingSettings and OdooHandler calls different db table. This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

The AlertingSettings are only added, and provide no functionality yet. The defined Metadata methods are only added too and provide no functionality yet. This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

* Changed Comments mostly on some alerting classes * Changed getAllEdges to a stream() method -> e.g. MetaDataOdoo calls a Stream of Edges and filters for Edge::isOffline This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert OpenEMS#2260 By Seperating the big OpenEMS#2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

…rtingSettings (#2414) * Refactored Name of AlertingSetting to UserAlertingSettings This is just a refactor of the Name. This does not provide any functionality, but will improve the readability of the SumStateAlert PR in the future. This commit is one of many prepare PRs / commits for a bigger PR: SumStateAlert #2260 By Seperating the big #2260 into smaller commits we would like to make the review easier. Co-authored-by: Kai Jeschek <[email protected]>

# Conflicts: # io.openems.backend.alerting/src/io/openems/backend/alerting/handler/OfflineEdgeHandler.java # io.openems.backend.alerting/src/io/openems/backend/alerting/message/OfflineEdgeMessage.java # io.openems.backend.alerting/test/io/openems/backend/alerting/Dummy.java # io.openems.backend.alerting/test/io/openems/backend/alerting/OfflineEdgeAlertingTest.java # io.openems.backend.alerting/test/io/openems/backend/alerting/handler/TestOfflineEdgeHandler.java # io.openems.backend.common/src/io/openems/backend/common/jsonrpc/request/SetUserAlertingConfigsRequest.java # io.openems.backend.common/src/io/openems/backend/common/jsonrpc/response/GetUserAlertingConfigsResponse.java # io.openems.backend.common/src/io/openems/backend/common/metadata/Metadata.java # io.openems.backend.common/src/io/openems/backend/common/metadata/UserAlertingSettings.java # io.openems.backend.common/src/io/openems/backend/common/test/DummyMetadata.java # io.openems.backend.metadata.dummy/src/io/openems/backend/metadata/dummy/MetadataDummy.java # io.openems.backend.metadata.file/src/io/openems/backend/metadata/file/MetadataFile.java # io.openems.backend.metadata.odoo/src/io/openems/backend/metadata/odoo/MetadataOdoo.java # io.openems.backend.metadata.odoo/src/io/openems/backend/metadata/odoo/odoo/OdooHandler.java # io.openems.backend.uiwebsocket/src/io/openems/backend/uiwebsocket/impl/OnRequest.java

github-actions · 2023-12-12T10:52:31Z

# Conflicts: # io.openems.backend.common/src/io/openems/backend/common/test/DummyMetadata.java # io.openems.backend.metadata.odoo/src/io/openems/backend/metadata/odoo/MetadataOdoo.java # io.openems.backend.metadata.odoo/src/io/openems/backend/metadata/odoo/odoo/OdooHandler.java

github-actions · 2024-01-02T13:43:36Z

github-actions · 2024-01-10T08:30:08Z

DerStoecki · 2024-01-11T15:05:05Z

Hey @da-Kai

I will have a look into this PR,
test this in our environment and start a review.
It'll take some time though.

Thank you for your patience.

DerStoecki

In short:

I merged this PR with our repo + did some test with existing edges (e.g. deployed this to our dev backend and dev ui + enabled Alerting and set the sumstate on test edges )
and the alerting worked.

Send mail only once
Filter recipients
check the sumstate
etc

Some thoughts to keep in mind:

There may be a potential issue with edges, that "toggle" their state periodically, and no notficiation will be send
(e.g. toggle their state every 30 seconds between ok/fault or warning/fault)

sfeilmeier

Thanks for pushing this topic forward. 🥳

Be aware though, that this is a breaking change for OpenEMS UI as well as requires a - not yet published - change to the OpenEMS Odoo addon.

Can you please provide the updated Odoo addon in time for the next release (1st March). Please also provide SQL scripts (or Odoo automated update-scripts?!) to update the existing Odoo database schema to not loose existing settings). Please link them to this PR.

Specifically internally at FENECON we need to be careful when updating a UI and Backend with this PR.

I am merging now, but if the other files are not provided in time, I'll have to remove it again before release 2024.3.0.

github-actions · 2024-02-20T10:56:21Z

sfeilmeier · 2024-02-20T11:10:32Z

Can you please provide the updated Odoo addon in time for the next release (1st March). Please also provide SQL scripts (or Odoo automated update-scripts?!) to update the existing Odoo database schema to not loose existing settings). Please link them to this PR.

Ah. I just realized, that the Odoo addon is already merged: OpenEMS/odoo-openems#3. Sorry!

We (and other users of OpenEMS Backend with Odoo) will still need some migration scripts, right?

@mlang97: FYI; this will be released in FEMS backend soon, as well

…!) (OpenEMS#2260) Notify specific users of the persistent presence of a negative sumState. - react and send mail on sumState - Improved data structure for growing alerting requirements and settings - Unit-Tests - UI settings Requires updated Odoo addon: OpenEMS/odoo-openems#3 Co-authored-by: Kai Jeschek <[email protected]> Co-authored-by: Stefan Feilmeier <[email protected]>

Kai J added 2 commits July 10, 2023 15:52

Implement an initial minimal prototype for sumState-Alerting

7a3b3fd

Merge branch 'develop' into feature/sumStateAlerting

8126996

DerStoecki reviewed Jul 14, 2023

View reviewed changes

Kai J added 3 commits July 20, 2023 12:58

Split Alerting Settings into Offline- and SumStateAlertingSettings;

60ccd11

Separate Odoo-Table for Alerting-Settings;

Merge branch 'develop' into feature/sumStateAlerting

a21cc74

format + checkstyle;

0bf6e3e

DerStoecki mentioned this pull request Aug 22, 2023

Draft: Implementation of SumStateAlert #2237

Closed

Kai J. added 7 commits August 31, 2023 12:20

Merge branch 'develop' into feature/sumStateAlerting

f7c7f5a

test JsonRPC Requests and Responses;

de1944e

Use Clock and TimeLeapClock for testing;

93bf63f

Move "io.openems.edge.common.test.TimeLeapClock" to "io.openems.common.test.TimeLeapClock";

format + checkstyle

cf206d6

checkstyle;

4342ac3

Adapt for Odoo-Model; Improve Unit-Tests

08896f4

+ Integration tests for Offline- and SumState-Alerting; + Adapt UI + Change Odoo-Model Settings

Merge branch 'develop' into feature/sumStateAlerting

3cc393b

# Conflicts: # io.openems.backend.metadata.odoo/src/io/openems/backend/metadata/odoo/MetadataOdoo.java

da-Kai mentioned this pull request Sep 14, 2023

SumState-Alerting OpenEMS/odoo-openems#3

Merged

OpenEMS deleted a comment from github-actions bot Sep 14, 2023

DerStoecki mentioned this pull request Oct 23, 2023

Moved TimeLeapClock from edge.common to common #2395

Merged

da-Kai added 2 commits December 5, 2023 11:00

revert EdgeCache changes

a378adf

UI: first updates

6b301b1

da-Kai added 5 commits December 7, 2023 14:12

simple alerting prototype

1de1774

UI: fix custom values

d8d3c6f

checkstyle

0f5c8a0

implement usable ui

c1d987d

da-Kai added 3 commits January 10, 2024 09:14

fix sumstate alerting sending mails cyclic

83d0bdb

Merge branch 'develop' into feature/sumStateAlerting

00d3608

checkstyle

b81026b

da-Kai marked this pull request as ready for review January 10, 2024 11:04

da-Kai requested a review from DerStoecki January 10, 2024 11:04

da-Kai mentioned this pull request Feb 1, 2024

time_to_wait field was missing OpenEMS/odoo-openems#8

Closed

DerStoecki approved these changes Feb 7, 2024

View reviewed changes

DerStoecki requested a review from sfeilmeier February 19, 2024 10:22

sfeilmeier added 2 commits February 19, 2024 23:15

Merge branch 'develop' into pr/2260

416e28d

Review + apply formatting

6006eae

sfeilmeier approved these changes Feb 20, 2024

View reviewed changes

sfeilmeier changed the title ~~Implementation of SumState-Alerting~~ Implementation of SumState-Alerting (BREAKING UI+Backend/Odoo changes!) Feb 20, 2024

sfeilmeier merged commit 9848e2a into OpenEMS:develop Feb 20, 2024
2 checks passed

da-Kai deleted the feature/sumStateAlerting branch March 18, 2024 07:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implementation of SumState-Alerting (BREAKING UI+Backend/Odoo changes!) #2260

Implementation of SumState-Alerting (BREAKING UI+Backend/Odoo changes!) #2260

da-Kai commented Jul 10, 2023 •

edited

Loading

DerStoecki Jul 14, 2023 •

edited

Loading

da-Kai Jul 17, 2023

github-actions bot commented Dec 12, 2023

github-actions bot commented Jan 2, 2024

github-actions bot commented Jan 10, 2024

DerStoecki commented Jan 11, 2024

DerStoecki left a comment •

edited

Loading

sfeilmeier left a comment

github-actions bot commented Feb 20, 2024

sfeilmeier commented Feb 20, 2024

Implementation of SumState-Alerting (BREAKING UI+Backend/Odoo changes!) #2260

Implementation of SumState-Alerting (BREAKING UI+Backend/Odoo changes!) #2260

Conversation

da-Kai commented Jul 10, 2023 • edited Loading

Description:

Planed Features

Odoo changes

DerStoecki Jul 14, 2023 • edited Loading

Choose a reason for hiding this comment

da-Kai Jul 17, 2023

Choose a reason for hiding this comment

github-actions bot commented Dec 12, 2023

github-actions bot commented Jan 2, 2024

github-actions bot commented Jan 10, 2024

DerStoecki commented Jan 11, 2024

DerStoecki left a comment • edited Loading

Choose a reason for hiding this comment

sfeilmeier left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 20, 2024

sfeilmeier commented Feb 20, 2024

da-Kai commented Jul 10, 2023 •

edited

Loading

DerStoecki Jul 14, 2023 •

edited

Loading

DerStoecki left a comment •

edited

Loading