Persistence no default strategies and persistence configuration health check

[mherwege]

Closes #4470

This is a breaking change.

With this PR, the default persistence strategy is not applied automatically anymore when no other strategy is defined.

The PersistenceService interface still keeps the getDefaultStrategies method. Therefore no change is required in the persistence services implementations. But rather than applying this automatically, these default strategies are now considered configuration suggestions.

The current PersistenceService.getDefaultStrategies() method has been deprecated and replaced by a PersistenceService.getSuggestedStrategies() method. A default implementation will redirect PersistenceService.getSuggestedStrategies() to PersistenceService.getDefaultStrategies(), so there is no need to immediately change PersistenceService implementations.

An extra sub-endpoint to the persistence REST API endpoint is defined to retrieve these strategy suggestions (GET persistence/strategysuggestions?serviceId={serviceId}). This endpoint can be used by the UI to suggest strategies when configuring the service. Applying these suggestions will then become a clear user decision.

File based persistence configurations will have to be changed by the user if they use the default strategies.

As part of this PR, a persistence configuration health check endpoint has been implemented(GET persistence/persistencehealth?serviceId={serviceId}). This endpoint will then be used in the UI to show persistence configuration health (similar to orphan links), and will allow more easy support when default strategies are being removed.

To complete this functionality, the following is also needed:

• Breaking change notice (openhab-distro), see Breaking change alert: persistence no default openhab-distro#1737
• Adapt the UI (openhab-web): remove default strategies and suggest when configuring, make setting a strategy required for the persistence configuration, persistence health in UI, see Persistence strategies not automatically applied openhab-webui#3123
• Upgrade logic for managed persistence configurations: if no strategies are defined, add the suggested ones to the configuration (included in this PR)
• Change documentation, see Persistence no default strategy openhab-docs#2478

[mherwege]

@J-N-K Can you let me know what you think? If this is accepted as the direction, I could start working on the UI side of this. But I don't want to spend time if the direction is not agreed upon.

[J-N-K]

This is what I suggested about two years ago (IIRC). IMO a "proposal" is much better than some magic that is applied. However, there might be an issue with the "empty strategy". It would be better (but not so easy to implement) when the persistence service is not considered "ready" up without a valid configuration. It is necessary to allow the service to start, otherwise it can't be found and as a result the suggested strategy is not present (and the service can't be configured), but it should not be considered as "available".

[mherwege]

It would be better (but not so easy to implement) when the persistence service is not considered "ready" up without a valid configuration.

Yes, I agree that would be better. But it would require implementing a life cycle for persistence services (like for things) which is beyond what I feel comfortable doing. A persistence service persisting anything is not just dependent on a strategy being available, but also items to be persisted defined. What if you delete the all item definitions from an existing configuration? Should it go back to not ready? It should. I think it makes it more complicated then needed, and just not doing anything with an empty definition, or an item definition with no strategy is acceptable I believe.

[openhab-bot]

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

https://community.openhab.org/t/oh-5-0-0-snapshot-mapdb-persistence-not-restoring-some-items-on-startup/163502/2

[mherwege]

@holgerfriedrich I saw #4693. This PR is already rebased on that PR, but I still see a javadoc failure. Should this be resolved?

[holgerfriedrich]

Suggested change

* @param strategy persistence strategy selected for the list of items

[mherwege]

This is good now I believe.

[holgerfriedrich]

@mherwege the log of the javadoc job needs improvement. Running it locally, I see the message causing it to fail:

[INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:3.11.2:javadoc' has not been previously called for the module: 'org.openhab.core.bom:org.openhab.core.bom.compile-model:pom:5.0.0-SNAPSHOT'. Trying to invoke it...
[WARNING] Javadoc Warnings
[WARNING] openhab-core\bundles\org.openhab.core.persistence\src\main\java\org\openhab\core\persistence\PersistenceServiceProblem.java:26: warning: @param argument "strategy" is not the name of a record component.
[WARNING] * @param strategy persistence strategy selected for the list of items

[mherwege]

Thanks. How do I run this locally?

[J-N-K]

What is the current state here? I see 4/4 tasks completed, but has everything been done and this can be considered as "ready for review"?

[mherwege]

What is the current state here? I see 4/4 tasks completed, but has everything been done and this can be considered as "ready for review"?

Yes, I consider this ready for review, in combination with the related PR's that are also ready.

[mherwege]

@J-N-K Any chance to get this across the line?

[mherwege]

Rebased to account for changes in UpgradeTool.

[Copilot]

Pull Request Overview

This PR implements a breaking change that removes automatic application of default persistence strategies when no strategy is defined, requiring explicit configuration by users instead.

Key changes:

• Deprecated PersistenceService.getDefaultStrategies() in favor of PersistenceService.getSuggestedStrategies()
• Added persistence configuration health check API endpoint
• Created upgrade tool to migrate existing configurations with missing strategies

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tools/upgradetool/src/main/java/org/openhab/core/tools/internal/PersistenceUpgrader.java	New upgrader class to migrate persistence configurations by copying default strategies to configurations without explicit strategies
tools/upgradetool/src/main/java/org/openhab/core/tools/UpgradeTool.java	Added persistence upgrader to the list of upgraders
tools/upgradetool/pom.xml	Added persistence bundle dependency and OSGi annotations
bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/PersistenceService.java	Deprecated getDefaultStrategies() and added getSuggestedStrategies() method
bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/PersistenceServiceProblem.java	New record class for representing persistence configuration problems
bundles/org.openhab.core.persistence/src/main/java/org/openhab/core/persistence/internal/PersistenceManagerImpl.java	Removed automatic application of default strategies and simplified configuration handling
bundles/org.openhab.core.io.rest.core/src/main/java/org/openhab/core/io/rest/core/internal/persistence/PersistenceResource.java	Added new REST endpoints for strategy suggestions and persistence health checks

[mherwege]

@wborn Rebased and copilot suggestions considered.