Improve handling of OSGi References and target filters (#1603)

* Try to restart Components if they are unavailable

Due to a race condition on startup, sometimes Components are unavailable to the ComponentManager. The related error message is `[Core.ComponentManager(1)] : Could not get service from ref`. We are fixing this by restarting (i.e. 'reconfiguring') the Component in such a case.

* Increase ComponentManager 'ConfigNotActivated' level to 'FAULT'

* On UpdateComponent via ComponentManager: reset target properties

Before if a Component was referencing 'modbus0' and you would update it to 'modbus1', there were two possible behaviours. (1) if 'modbus0' was still existing, the update would work and the target filter would be set properly. (2) otherwise the target filter could not be set, because the Component would not reactivate. This would leave the Component in an error state. We are fixing this by always resetting the target properties.

* Set non-empty default target filter by default

If the target filter is made available via 'Config.java' and the configuration property is left as an empty string, the error `Invalid syntax in target property for dependency` arises on activate, which showed to also cause wrong behaviour later. We fix this by setting a default target filter of `(enabled=true)` - which is always true, but avoids the error

Thanks @sebastianasen for your valuable inputs.

io.openems.common/resources/templates/device-modbus/$srcDir$/$basePackageDir$/Config.java

@@ -24,8 +24,8 @@
 	int modbusUnitId() default 1;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
-	
+	String Modbus_target() default "(enabled=true)";
+
 	String webconsole_configurationFactory_nameHint() default "$projectName$ [{id}]";
 
 }

io.openems.edge.battery.bmw/src/io/openems/edge/battery/bmw/Config.java

@@ -32,7 +32,7 @@
 	long errorDelay() default 600;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Max Start Attempts", description = "Sets the counter how many time the system should try to start")
 	int maxStartAttempts() default 5;

io.openems.edge.battery.bydcommercial/src/io/openems/edge/battery/bydcommercial/Config.java

@@ -64,7 +64,7 @@
 	 * @return String
 	 */
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	/**
 	 * The webconsole_configurationFactory_nameHint.

io.openems.edge.battery.fenecon.home/src/io/openems/edge/battery/fenecon/home/Config.java

@@ -29,7 +29,7 @@
 	int modbusUnitId() default 1;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Battery FENECON Home [{id}]";
 

io.openems.edge.battery.soltaro/src/io/openems/edge/battery/soltaro/cluster/versionb/Config.java

@@ -57,7 +57,7 @@
 	int minimalCellVoltage() default 2800;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "BMS Soltaro Cluster Version B [{id}]";
 }

io.openems.edge.battery.soltaro/src/io/openems/edge/battery/soltaro/cluster/versionc/Config.java

@@ -114,7 +114,7 @@
 	 * @return String
 	 */
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	/**
 	 * Gets the webconsole_configurationFactory_nameHint.

io.openems.edge.battery.soltaro/src/io/openems/edge/battery/soltaro/single/versiona/Config.java

@@ -50,7 +50,7 @@
 	BatteryState batteryState() default BatteryState.DEFAULT;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "BMS Soltaro Single Rack Version A [{id}]";
 }

io.openems.edge.battery.soltaro/src/io/openems/edge/battery/soltaro/single/versionb/Config.java

@@ -145,7 +145,7 @@
 	 * @return Modbus_target
 	 */
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	/**
 	 * Return the webconsole_configurationFactory_nameHint.

io.openems.edge.battery.soltaro/src/io/openems/edge/battery/soltaro/single/versionc/Config.java

@@ -114,7 +114,7 @@
 	 * @return Modbus_target
 	 */
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	/**
 	 * Return the webconsole_configurationFactory_nameHint.

io.openems.edge.batteryinverter.kaco.blueplanetgridsave/src/io/openems/edge/batteryinverter/kaco/blueplanetgridsave/Config.java

@@ -29,7 +29,7 @@
 	String modbus_id() default "modbus0";
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Battery-Inverter KACO blueplanet gridsave [{id}]";
 

io.openems.edge.batteryinverter.refu88k/src/io/openems/edge/batteryinverter/refu88k/Config.java

@@ -32,7 +32,7 @@
 	StartStopConfig startStop() default StartStopConfig.AUTO;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Watchdog", description = "Sets the watchdog timer interval in seconds, 0=disable")
 	int watchdoginterval() default 0;

io.openems.edge.batteryinverter.sunspec/src/io/openems/edge/batteryinverter/sunspec/Config.java

@@ -26,7 +26,7 @@
 	int readFromCommonBlockNo() default 1;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Battery-Inverter SunSpec [{id}]";
 

io.openems.edge.common/src/io/openems/edge/common/component/ComponentManager.java

@@ -21,7 +21,7 @@
 public interface ComponentManager extends OpenemsComponent, JsonApi, ClockProvider {
 
 	public enum ChannelId implements io.openems.edge.common.channel.ChannelId {
-		CONFIG_NOT_ACTIVATED(Doc.of(Level.WARNING) //
+		CONFIG_NOT_ACTIVATED(Doc.of(Level.FAULT) //
 				.text("A configured OpenEMS Component was not activated")), //
 		DUPLICATED_COMPONENT_ID(Doc.of(Level.FAULT) //
 				.text("Configuration has duplicated Component-IDs")), //

io.openems.edge.controller.api.modbus/src/io/openems/edge/controller/api/modbus/readonly/Config.java

@@ -29,7 +29,7 @@
 	int maxConcurrentConnections() default AbstractModbusTcpApi.DEFAULT_MAX_CONCURRENT_CONNECTIONS;
 
 	@AttributeDefinition(name = "Components target filter", description = "This is auto-generated by 'Component-IDs'.")
-	String Component_target() default "";
+	String Component_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Api Modbus/TCP Read-Only [{id}]";
 }

io.openems.edge.controller.api.modbus/src/io/openems/edge/controller/api/modbus/readwrite/Config.java

@@ -32,7 +32,7 @@
 	int maxConcurrentConnections() default AbstractModbusTcpApi.DEFAULT_MAX_CONCURRENT_CONNECTIONS;
 
 	@AttributeDefinition(name = "Components target filter", description = "This is auto-generated by 'Component-IDs'.")
-	String Component_target() default "";
+	String Component_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Api Modbus/TCP Read-Write [{id}]";
 }

io.openems.edge.controller.ess.activepowervoltagecharacteristic/src/io/openems/edge/controller/ess/activepowervoltagecharacteristic/Config.java

@@ -33,10 +33,10 @@
 	int waitForHysteresis() default 20;
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Meter target filter", description = "This is auto-generated by 'Meter-ID'.")
-	String meter_target() default "";
+	String meter_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Ess Voltage Active Power Characteristic [{id}]";
 }

io.openems.edge.controller.ess.fixactivepower/src/io/openems/edge/controller/ess/fixactivepower/Config.java

@@ -27,7 +27,7 @@
 	int power();
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Ess Fix Active Power [{id}]";
 }

io.openems.edge.controller.ess.gridoptimizedcharge/src/io/openems/edge/controller/ess/gridoptimizedcharge/Config.java

@@ -46,10 +46,10 @@
 	int sellToGridLimitRampPercentage() default 2;
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Meter target filter", description = "This is auto-generated by 'Grid-Meter-ID'.")
-	String meter_target() default "";
+	String meter_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Ess Grid Optimized Charge [{id}]";
 }

io.openems.edge.controller.ess.hybrid.surplusfeedtogrid/src/io/openems/edge/controller/ess/hybrid/surplusfeedtogrid/Config.java

@@ -21,7 +21,7 @@
 	String ess_id() default "ess0";
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Ess Hybrid Surplus-Feed-To-Grid [{id}]";
 

io.openems.edge.controller.ess.linearpowerband/src/io/openems/edge/controller/ess/linearpowerband/Config.java

@@ -33,7 +33,7 @@
 	StartDirection startDirection() default StartDirection.CHARGE;
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Ess Linear Power Band [{id}]";
 }

io.openems.edge.controller.ess.reactivepowervoltagecharacteristic/src/io/openems/edge/controller/ess/reactivepowervoltagecharacteristic/Config.java

@@ -33,10 +33,10 @@
 	int waitForHysteresis() default 20;
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Meter target filter", description = "This is auto-generated by 'Meter-ID'.")
-	String meter_target() default "";
+	String meter_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Ess Voltage Reactive Power Characteristic [{id}]";
 

io.openems.edge.controller.ess.selltogridlimit/src/io/openems/edge/controller/symmetric/selltogridlimit/Config.java

@@ -27,10 +27,10 @@
 	int maximumSellToGridPower();
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Meter target filter", description = "This is auto-generated by 'Grid-Meter-ID'.")
-	String meter_target() default "";
+	String meter_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Ess Sell-to-Grid Limit [{id}]";
 }

io.openems.edge.controller.evcs/src/io/openems/edge/controller/evcs/Config.java

@@ -45,7 +45,7 @@
 	int energySessionLimit() default 0;
 
 	@AttributeDefinition(name = "Evcs target filter", description = "This is auto-generated by 'Evcs-ID'.")
-	String evcs_target() default "";
+	String evcs_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Electric Vehicle Charging Station [{id}]";
 

io.openems.edge.controller.symmetric.balancingschedule/src/io/openems/edge/controller/symmetric/balancingschedule/Config.java

@@ -27,10 +27,10 @@
 	String schedule() default "";
 
 	@AttributeDefinition(name = "Ess target filter", description = "This is auto-generated by 'Ess-ID'.")
-	String ess_target() default "";
+	String ess_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Grid-Meter target filter", description = "This is auto-generated by 'Grid-Meter-ID'.")
-	String meter_target() default "";
+	String meter_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "Controller Balancing Schedule Symmetric [{id}]";
 }

io.openems.edge.core/src/io/openems/edge/core/componentmanager/ComponentManagerImpl.java

@@ -7,6 +7,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Dictionary;
+import java.util.Enumeration;
 import java.util.Hashtable;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -323,6 +324,15 @@ protected CompletableFuture<JsonrpcResponseSuccess> handleUpdateComponentConfigR
 			throw OpenemsError.EDGE_UNABLE_TO_APPLY_CONFIG.exception(request.getComponentId(),
 					config.getPid() + ": Properties is 'null'");
 		}
+
+		// Reset all target properties to avoid missing old references
+		for (Enumeration<String> k = properties.keys(); k.hasMoreElements();) {
+			String property = k.nextElement();
+			if (property.endsWith(".target")) {
+				properties.put(property, "(enabled=true)");
+			}
+		}
+
 		for (Property property : request.getProperties()) {
 			// do not allow certain properties to be updated, like pid and service.pid
 			if (!EdgeConfig.ignorePropertyKey(property.getName())) {

io.openems.edge.core/src/io/openems/edge/core/componentmanager/OsgiValidateWorker.java

@@ -1,12 +1,12 @@
 package io.openems.edge.core.componentmanager;
 
+import java.io.IOException;
 import java.util.Collection;
 import java.util.Dictionary;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Map.Entry;
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -59,11 +59,6 @@ public class OsgiValidateWorker extends ComponentManagerWorker {
 	 */
 	private final Map<String, String> defectiveComponents = new HashMap<>();
 
-	/**
-	 * Delays announcement of defective Components by one execution Cycle.
-	 */
-	private final Set<String> lastDefectiveComponents = new HashSet<>();
-
 	/**
 	 * Components with duplicated Component-IDs.
 	 */
@@ -94,18 +89,12 @@ private void findDefectiveComponents() {
 		final Configuration[] configs = this.readEnabledConfigurations();
 		final Map<String, String> defectiveComponents = new HashMap<>();
 		updateInactiveComponentsUsingScr(defectiveComponents, this.parent.serviceComponentRuntime);
-		updateInactiveComponentsUsingConfigurationAdmin(defectiveComponents, this.parent.getEnabledComponents(),
-				configs);
+		this.updateInactiveComponentsUsingConfigurationAdmin(defectiveComponents, this.parent.getEnabledComponents(),
+				configs, this.parent.serviceComponentRuntime);
 		this.parent._setConfigNotActivated(!defectiveComponents.isEmpty());
 		synchronized (this.defectiveComponents) {
 			this.defectiveComponents.clear();
-			for (Entry<String, String> c : defectiveComponents.entrySet()) {
-				if (this.lastDefectiveComponents.contains(c.getKey())) {
-					// Delay announcement of defective Components by one execution Cycle.
-					this.defectiveComponents.put(c.getKey(), c.getValue());
-				}
-			}
-			this.lastDefectiveComponents.addAll(defectiveComponents.keySet());
+			this.defectiveComponents.putAll(defectiveComponents);
 		}
 	}
 
@@ -171,8 +160,8 @@ private static void updateInactiveComponentsUsingScr(Map<String, String> defecti
 	 * 
 	 * @param configs enabled {@link Configuration}s from {@link ConfigurationAdmin}
 	 */
-	private static void updateInactiveComponentsUsingConfigurationAdmin(Map<String, String> defectiveComponents,
-			List<OpenemsComponent> enabledComponents, Configuration[] configs) {
+	private void updateInactiveComponentsUsingConfigurationAdmin(Map<String, String> defectiveComponents,
+			List<OpenemsComponent> enabledComponents, Configuration[] configs, ServiceComponentRuntime scr) {
 		for (Configuration config : configs) {
 			Dictionary<String, Object> properties;
 			try {
@@ -192,7 +181,21 @@ private static void updateInactiveComponentsUsingConfigurationAdmin(Map<String,
 					continue;
 				}
 				if (!isComponentActivated(enabledComponents, componentId)) {
-					defectiveComponents.putIfAbsent(componentId, "Missing Bundle");
+					String factoryPid = config.getFactoryPid();
+					if (factoryPid != null && scr.getComponentDescriptionDTOs().stream()
+							.anyMatch(description -> factoryPid.equals(description.name))) {
+						// Bundle exists -> try to restart Component
+						try {
+							this.parent.logInfo(this.log, "Trying to restart Component [" + componentId + "]");
+							config.update(properties);
+						} catch (IOException e) {
+							e.printStackTrace();
+							defectiveComponents.putIfAbsent(componentId, "Unable to restart: " + e.getMessage());
+						}
+					} else {
+						// Bundle with this name does not exist
+						defectiveComponents.putIfAbsent(componentId, "Missing Bundle");
+					}
 				}
 			}
 		}

io.openems.edge.ess.adstec.storaxe/src/io/openems/edge/ess/adstec/storaxe/Config.java

@@ -27,7 +27,7 @@
 	int capacity() default 47000;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "ESS ADS-TEC StoraXe [{id}]";
 }

io.openems.edge.ess.byd.container/src/io/openems/edge/ess/byd/container/Config.java

@@ -30,13 +30,13 @@
 	String modbus_id2();
 
 	@AttributeDefinition(name = "Modbus0 target filter", description = "This is auto-generated by 'Modbus-ID 0'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Modbus1 target filter", description = "This is auto-generated by 'Modbus-ID 1'.")
-	String modbus1_target() default "";
+	String modbus1_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Modbus2 target filter", description = "This is auto-generated by 'Modbus-ID 2'.")
-	String modbus2_target() default "";
+	String modbus2_target() default "(enabled=true)";
 
 	String webconsole_configurationFactory_nameHint() default "ESS FENECON BYD Container [{id}]";
 }

io.openems.edge.ess.fenecon.commercial40/src/io/openems/edge/ess/fenecon/commercial40/Config.java

@@ -27,7 +27,7 @@
 	int powerLimitOnPowerDecreaseCausedByOvertemperatureChannel() default 20_000;
 
 	@AttributeDefinition(name = "Modbus target filter", description = "This is auto-generated by 'Modbus-ID'.")
-	String Modbus_target() default "";
+	String Modbus_target() default "(enabled=true)";
 
 	@AttributeDefinition(name = "Surplus Feed-In: State-of-Charge limit", description = "Start Surplus-feed-in if State-of-Charge is bigger than this limit")
 	int surplusFeedInSocLimit() default 90;