Allow managing persistence configurations and enable filters #2871

J-N-K · 2022-03-25T19:00:44Z

Depends on #2994
Fixes #3590

The aim of this PR is to allow managing persistence service configurations via the REST API (UI).

To achieve this

A PersistenceServiceConfigurationRegistry has been introduced. It needs to add an own interface for the change listener because one class can't inherit two RegistryChangeListener<T> with different types and the persistence manager needs to listen to both, the ItemRegistry and the PersistenceServiceConfigurationRegistry.
The PersistenceManager interface has been removed.
The PersistenceManagerImpl has been renamed to PersistenceManager and makes use of the new registry.
The PersistenceModelManager has been refactored to a PersistenceServiceConfigurationProvider.
A ManagedPersistenceServiceConfigurationProvider has been introduced.
The core REST bundle has been extended to allow adding configurations. Unmanaged configurations can also be retrieved.

Signed-off-by: Jan N. Klug [email protected]

J-N-K · 2022-03-26T10:46:16Z

@ghys Can you have a look at the REST part and let me know if that is a good design for the UI?

J-N-K · 2022-03-26T17:55:11Z

I'll add more extensive test coverage to ensure that my refactoring are all correct.

splatch · 2022-04-07T22:23:38Z

Since you touch fairly important base - have a look on PersistenceFilter which is blind interface without use. While it can be referred in persistence service config it plays no role in config itself. I made it an Predicate<Item> which allows to use it as an exclusion filter for certain items. Obviously there is still a problem of mapping the filters, but that's other thing. Other elephant then would be the xtext part which would need to be provided by someone who knows how to work with it (or omitted as deprecated).

J-N-K · 2022-04-22T16:34:24Z

@splatch I enabled the PersistenceFilter.

splatch · 2022-04-22T17:09:27Z

@splatch I enabled the PersistenceFilter.

Yes, I saw it and see you use it to throttle or limit writes to persistence stuff. It makes a lot of sense cause this can be used when multiple stores are used. My approach so far was focusing on use of profiles which worked for single persistence but not for all.

I think there is still an area for improvement in excluding certain items, cause mapFilter is currently fairly limited. Its really about use cases reported several times in forums (where I advertised own externalized XML config for that) to serve cases where it is easier to mark item with an tag than create a completely new group without just few members.
Knowing the limit of xtext I think it could be done with a basic instanceof call to see if ie. incoming filter instance is already compatible with contract and does not require further mapping.

J-N-K · 2022-04-22T17:13:56Z

The two filters I added were already defined in the model, that's why I implemented them. If someone knows how to properly extend that, more filters can be added. Maybe something like !itemName could be used to exclude items. But it's difficult if we need wildcards. This should ne done in a separate PR. I only added the filters here because I needed to figure out how to model them for the REST API.

splatch · 2022-04-22T17:15:07Z

@J-N-K I'm perfectly fine with your work, my stuff is sitting on OH 3.0.x fork, so I still have plenty of time to fight with 3.3 updates. ;-)

openhab-bot · 2022-11-14T17:15:16Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/is-there-a-way-to-limit-the-precision-of-number-items/141006/7

openhab-bot · 2023-01-07T19:54:47Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/profiling-results-using-jprofiler/143073/2

openhab-bot · 2023-01-10T11:58:19Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/openhab-4-0-wishlist/142388/248

J-N-K · 2023-04-07T19:09:31Z

@florian-h05 FYI. This is also lacking UI support and I don't have a good idea how this should look like.

florian-h05 · 2023-04-18T08:43:02Z

Thanks for the hint, I have also seen openhab/openhab-webui#1463.
I am currently super busy wit my final exams (Abitur), but I put this on my UI list 👍

clinique · 2023-04-18T10:04:12Z

Abitur

May the force be with you !

J-N-K · 2023-04-18T10:55:16Z

I am currently super busy wit my final exams (Abitur), but I put this on my UI list 👍

Best of luck!

Signed-off-by: Jan N. Klug <[email protected]>

kaikreuzer

Many thanks! I have just a few small comments below.

...del.persistence/src/org/openhab/core/model/persistence/internal/PersistenceModelManager.java

.../org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/FilterCriteria.java

....core.persistence/src/main/java/org/openhab/core/persistence/dto/PersistenceStrategyDTO.java

...ab.core.persistence/src/main/java/org/openhab/core/persistence/filter/PersistenceFilter.java

...ersistence/src/main/java/org/openhab/core/persistence/filter/PersistenceThresholdFilter.java

Signed-off-by: Jan N. Klug <[email protected]>

kaikreuzer

Thanks again!

lolodomo · 2023-05-18T11:13:21Z

Other elephant then would be the xtext part which would need to be provided by someone who knows how to work with it (or omitted as deprecated).

@J-N-K : What exactly is missing in current XText for persistence?
I can try to add/fix it if I understand what is the problem.

J-N-K · 2023-05-18T11:17:57Z

Filters are already enabled (I think we need documentation for that). Currently there are two types of filters: value-based and time-based. If we would add more, then there would also be the need for XText support, but I think currently we are fine.

lolodomo · 2023-05-18T11:23:09Z

Fine.
I see them in XText syntax.

Closes #1463. Refs openhab/openhab-core#2871. Refs openhab/openhab-core#3642. It is accessible from the add-on settings page and has both a design and a code tab. The design tab allows to set persistence strategies for Items, define cron strategies and set the default strategies. It does not duplicate names for (cron) persistence strategies and filters as well as configs for the same set of Items. All four filters provided by openHAB core (treshold, time, equals/not equals, include/exclude) can be configured. When the user removes a cron strategy or a filter, it is automatically removed from all configs so that there is no API failure (400 Bad Request). No code completion is not provided, but required attributes for filters are automatically set on save to avoid API failure (500 Internal Server Error). A few words about order and sorting: - openHAB Core seems to sort the cron strategies. - Configurations itself are unsorted, they could be sorted alphabetically by the UI. - Items of configuration are sorted by their type (groups before normal Items) as well as alphabetically. -- Signed-off-by: Florian Hotze <[email protected]> Co-authored-by: J-N-K <[email protected]>

…#2871) * Allow managing persistence configurations Signed-off-by: Jan N. Klug <[email protected]> GitOrigin-RevId: 2e00efc

J-N-K requested a review from a team as a code owner March 25, 2022 19:00

wborn added the enhancement An enhancement or new feature of the Core label Mar 26, 2022

J-N-K mentioned this pull request Mar 27, 2022

Fix null annotations on PersistenceItemConfiguration #2876

Merged

J-N-K force-pushed the feature-persistenceregistry branch from d0dba2d to b360c1f Compare March 27, 2022 13:59

wborn added the persistence label Mar 27, 2022

J-N-K force-pushed the feature-persistenceregistry branch from c56d40c to d78ed90 Compare April 2, 2022 12:53

J-N-K force-pushed the feature-persistenceregistry branch 2 times, most recently from 549e233 to 22e6de1 Compare April 18, 2022 11:48

J-N-K changed the title ~~Allow managing persistence configurations~~ Allow managing persistence configurations and enable filters Apr 18, 2022

J-N-K force-pushed the feature-persistenceregistry branch 4 times, most recently from 4bf6efe to 78575a8 Compare April 20, 2022 16:21

J-N-K force-pushed the feature-persistenceregistry branch from 8121a8f to f93e881 Compare May 16, 2022 21:32

J-N-K force-pushed the feature-persistenceregistry branch from f93e881 to a94fffb Compare August 3, 2022 16:02

J-N-K mentioned this pull request Aug 7, 2022

Persistence configuration via UI openhab/openhab-webui#1463

Closed

J-N-K force-pushed the feature-persistenceregistry branch from df77f51 to e4cc100 Compare December 25, 2022 20:38

J-N-K force-pushed the feature-persistenceregistry branch from e4cc100 to df3bd28 Compare January 3, 2023 20:38

J-N-K mentioned this pull request Apr 7, 2023

Enable binding to store historic states #3000

Closed

J-N-K force-pushed the feature-persistenceregistry branch from df3bd28 to dfde419 Compare April 7, 2023 18:50

J-N-K added 3 commits May 4, 2023 16:39

Allow managing persistence configurations

c18a030

Signed-off-by: Jan N. Klug <[email protected]>

spotless

5c0767e

Signed-off-by: Jan N. Klug <[email protected]>

fix

5a17529

Signed-off-by: Jan N. Klug <[email protected]>

J-N-K force-pushed the feature-persistenceregistry branch from dfde419 to 5a17529 Compare May 4, 2023 15:04

kaikreuzer requested changes May 7, 2023

View reviewed changes

J-N-K added 2 commits May 7, 2023 19:11

address review comments

78e2410

Signed-off-by: Jan N. Klug <[email protected]>

remove models on deactivate

b4120d3

Signed-off-by: Jan N. Klug <[email protected]>

kaikreuzer approved these changes May 7, 2023

View reviewed changes

kaikreuzer added this to the 4.0 milestone May 7, 2023

kaikreuzer merged commit 2e00efc into openhab:main May 7, 2023

J-N-K deleted the feature-persistenceregistry branch May 7, 2023 18:51

J-N-K mentioned this pull request May 7, 2023

Adjust to core changes (FilterCriteria) openhab/openhab-addons#14952

Merged

lolodomo mentioned this pull request May 17, 2023

Item value no more persisted => problem in persistence strategy loading ? #3617

Closed

This was referenced May 29, 2023

Allow sending historic states and forecasts #3597

Merged

Improve existing and add new persistence filters #3642

Merged

florian-h05 mentioned this pull request Jun 6, 2023

Add a persistence configuration page openhab/openhab-webui#1917

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow managing persistence configurations and enable filters #2871

Allow managing persistence configurations and enable filters #2871

J-N-K commented Mar 25, 2022 •

edited

Loading

J-N-K commented Mar 26, 2022

J-N-K commented Mar 26, 2022

splatch commented Apr 7, 2022 •

edited

Loading

J-N-K commented Apr 22, 2022

splatch commented Apr 22, 2022

J-N-K commented Apr 22, 2022

splatch commented Apr 22, 2022

openhab-bot commented Nov 14, 2022

openhab-bot commented Jan 7, 2023

openhab-bot commented Jan 10, 2023

J-N-K commented Apr 7, 2023

florian-h05 commented Apr 18, 2023

clinique commented Apr 18, 2023

J-N-K commented Apr 18, 2023

kaikreuzer left a comment

kaikreuzer left a comment

lolodomo commented May 18, 2023

J-N-K commented May 18, 2023

lolodomo commented May 18, 2023

Allow managing persistence configurations and enable filters #2871

Allow managing persistence configurations and enable filters #2871

Conversation

J-N-K commented Mar 25, 2022 • edited Loading

J-N-K commented Mar 26, 2022

J-N-K commented Mar 26, 2022

splatch commented Apr 7, 2022 • edited Loading

J-N-K commented Apr 22, 2022

splatch commented Apr 22, 2022

J-N-K commented Apr 22, 2022

splatch commented Apr 22, 2022

openhab-bot commented Nov 14, 2022

openhab-bot commented Jan 7, 2023

openhab-bot commented Jan 10, 2023

J-N-K commented Apr 7, 2023

florian-h05 commented Apr 18, 2023

clinique commented Apr 18, 2023

J-N-K commented Apr 18, 2023

kaikreuzer left a comment

Choose a reason for hiding this comment

kaikreuzer left a comment

Choose a reason for hiding this comment

lolodomo commented May 18, 2023

J-N-K commented May 18, 2023

lolodomo commented May 18, 2023

J-N-K commented Mar 25, 2022 •

edited

Loading

splatch commented Apr 7, 2022 •

edited

Loading