Skip to content

Persistence upgrader: Create default persistence settings if no configuration so far #5212

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.

Sign up for GitHub

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

Merged
kaikreuzer merged 5 commits into from
Dec 19, 2025
Merged

Persistence upgrader: Create default persistence settings if no configuration so far #5212

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ec1879
fix persistence upgrade
mherwege Dec 19, 2025
ee9cd86
Fix build & Address Copilot review
florian-h05 Dec 19, 2025
156ee29
Prevent warning from JSONDB
florian-h05 Dec 19, 2025
68a1b22
Improve logging
florian-h05 Dec 19, 2025
9cd0750
Fix spotless
florian-h05 Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 130 additions & 6 deletions tools/upgradetool/src/main/java/org/openhab/core/tools/internal/PersistenceUpgrader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,20 @@
*/
package org.openhab.core.tools.internal;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.stream.Stream;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.core.persistence.dto.PersistenceCronStrategyDTO;
import org.openhab.core.persistence.dto.PersistenceItemConfigurationDTO;
import org.openhab.core.persistence.dto.PersistenceServiceConfigurationDTO;
import org.openhab.core.persistence.strategy.PersistenceStrategy;
import org.openhab.core.storage.json.internal.JsonStorage;
import org.openhab.core.tools.Upgrader;
import org.slf4j.Logger;
Expand Down Expand Up @@ -56,16 +60,38 @@ public boolean execute(@Nullable Path userdataPath, @Nullable Path confPath) {
logger.error("{} skipped: no userdata directory found.", getName());
return false;
}
if (confPath == null) {
logger.error("{} skipped: no conf directory found.", getName());
return false;
}

Path persistenceJsonDatabasePath = userdataPath
.resolve(Path.of("jsondb", "org.openhab.core.persistence.PersistenceServiceConfiguration.json"));
if (Files.notExists(persistenceJsonDatabasePath)) {
List<String> managedConfigs;
try {
managedConfigs = managedPersistenceConfigs(installedPersistenceAddons(userdataPath),
unmanagedPersistenceConfigs(confPath));
} catch (IOException e) {
logger.error("{} skipped: failed to read config: {}", getName(), e.getMessage());
return false;
}
if (managedConfigs.isEmpty()) {
// No managed persistence configurations, so no need to upgrade
return true;
}

logger.info("Setting default strategy on managed persistence configurations without strategy '{}'",
persistenceJsonDatabasePath);
Path persistenceJsonDatabasePath = userdataPath
.resolve(Path.of("jsondb", "org.openhab.core.persistence.PersistenceServiceConfiguration.json"));
if (Files.notExists(persistenceJsonDatabasePath)) {
// No configuration, but persistence addons are installed and there is no unmanaged configuration for it, so
// it needs to be created. Add JSON content to avoid warning from JSONDB.
try {
Files.createFile(persistenceJsonDatabasePath);
Files.writeString(persistenceJsonDatabasePath, "{}");
} catch (IOException e) {
logger.error("Cannot create persistence configuration database '{}', check path and access rights.",
persistenceJsonDatabasePath);
return false;
}
}

if (!Files.isWritable(persistenceJsonDatabasePath)) {
logger.error("Cannot access persistence configuration database '{}', check path and access rights.",
Expand All @@ -75,7 +101,23 @@ public boolean execute(@Nullable Path userdataPath, @Nullable Path confPath) {
JsonStorage<PersistenceServiceConfigurationDTO> persistenceStorage = new JsonStorage<>(
persistenceJsonDatabasePath.toFile(), null, 5, 0, 0, List.of());

List.copyOf(persistenceStorage.getKeys()).forEach(serviceId -> {
List<String> persistenceStorageKeys = List.copyOf(persistenceStorage.getKeys());

// Add all installed persistence services without explicit configuration with their previous default
// configuration
List<String> managedConfigsToAdd = managedConfigs.stream()
.filter(serviceId -> !persistenceStorageKeys.contains(serviceId)).toList();
managedConfigsToAdd.forEach(serviceId -> {
PersistenceServiceConfigurationDTO serviceConfigDTO = defaultServiceConfig(serviceId);
if (serviceConfigDTO != null) {
persistenceStorage.put(serviceId, serviceConfigDTO);
logger.info("{}: added strategy configurations for persistence service without configuration",
serviceId);
}
});

// Update existing managed configurations
persistenceStorageKeys.forEach(serviceId -> {
PersistenceServiceConfigurationDTO serviceConfigDTO = Objects
.requireNonNull(persistenceStorage.get(serviceId));
Collection<String> defaults = serviceConfigDTO.defaults;
Expand All @@ -97,4 +139,86 @@ public boolean execute(@Nullable Path userdataPath, @Nullable Path confPath) {
persistenceStorage.flush();
return true;
}

private List<String> installedPersistenceAddons(Path userdataPath) throws IOException {
Path addonsConfigPath = userdataPath.resolve("config/org/openhab/addons.config");
if (Files.notExists(addonsConfigPath)) {
throw new IOException(
"Cannot access addon config '" + addonsConfigPath + "', check path and access rights.");
}

List<String> configLines;
configLines = Files.readAllLines(addonsConfigPath);

for (String line : configLines) {
if (line.startsWith("persistence")) {
String[] persistenceLine = line.split("=");
if (persistenceLine.length > 1) {
String[] persistenceAddons = persistenceLine[1].replace("\"", "").split(",");
return Stream.of(persistenceAddons).map(String::trim).toList();
}
}
}
return List.of();
}

private List<String> unmanagedPersistenceConfigs(Path configPath) throws IOException {
Path persistenceConfigPath = configPath.resolve("persistence");
try (Stream<Path> files = Files.list(persistenceConfigPath)) {
return files.filter(configFile -> configFile.endsWith(".persist"))
.map(configFile -> configFile.getFileName().toString().replace(".persist", "")).toList();
}
}

private List<String> managedPersistenceConfigs(List<String> installedAddons, List<String> unmanagedConfigs) {
return installedAddons.stream().filter(a -> !unmanagedConfigs.contains(a)).toList();
}

private @Nullable PersistenceServiceConfigurationDTO defaultServiceConfig(String serviceId) {
PersistenceItemConfigurationDTO itemConfigDTO = new PersistenceItemConfigurationDTO();
List<String> strategies = defaultPersistenceStrategies(serviceId);
if (strategies != null) {
itemConfigDTO.items = List.of("*");
itemConfigDTO.strategies = strategies;
PersistenceServiceConfigurationDTO serviceConfigDTO = new PersistenceServiceConfigurationDTO();
serviceConfigDTO.serviceId = serviceId;
serviceConfigDTO.configs = List.of(itemConfigDTO);
List<PersistenceCronStrategyDTO> cronStrategies = defaultCronStrategies(serviceId);
if (cronStrategies != null) {
serviceConfigDTO.cronStrategies = cronStrategies;
}
return serviceConfigDTO;
}
return null;
}

private @Nullable List<String> defaultPersistenceStrategies(String service) {
return switch (service) {
case "rrd4j" -> List.of(PersistenceStrategy.Globals.RESTORE.getName(),
PersistenceStrategy.Globals.CHANGE.getName(), "everyMinute");
case "mapdb" ->
List.of(PersistenceStrategy.Globals.RESTORE.getName(), PersistenceStrategy.Globals.CHANGE.getName());
case "inmemory" -> List.of(PersistenceStrategy.Globals.FORECAST.getName());
case "jdbc" -> List.of(PersistenceStrategy.Globals.CHANGE.getName());
case "influxdb" ->
List.of(PersistenceStrategy.Globals.RESTORE.getName(), PersistenceStrategy.Globals.CHANGE.getName());
case "dynamodb" ->
List.of(PersistenceStrategy.Globals.RESTORE.getName(), PersistenceStrategy.Globals.CHANGE.getName());
default -> null;
};
}

private @Nullable List<PersistenceCronStrategyDTO> defaultCronStrategies(String service) {
return switch (service) {
case "rrd4j" -> List.of(everyMinuteStrategy());
default -> null;
};
}

private PersistenceCronStrategyDTO everyMinuteStrategy() {
PersistenceCronStrategyDTO everyMinuteStrategy = new PersistenceCronStrategyDTO();
everyMinuteStrategy.name = "everyMinute";
everyMinuteStrategy.cronExpression = "0 * * * * ?";
return everyMinuteStrategy;
}
}