FEMS Backports 2023-06 (#2664)

- Hardy Barth: correct Phase URL mapping
  - Wrong mapping of Phase 3 current
- BridgeHttp: added support for http code & message
  - added support for http code & message
  - changed DelayTimeProvider to also be able to handle errors and success responses
  - improved testing
  - added common class HttpStatus with all official Http status codes as constants
  - added lazy endpoint construction to define unique params for each call
- UI: Added metric field in 'Network configuration'
- UI: fix tab title
  - setting web-app tab title to ```environment.edgeShortName```
- Backend: Remove edges from authenticate
  -Removed Edges from Authenticate response
- UI: Split user and company related information
  - Splitting user and company related data, only user data is editable, non company assigned users are still seeing the same and are able to change all userInformation
- EdgeConfig: remove Channels
  - Normal EdgeConfig does not contain Channels anymore
  - Added separate Requests to get channels for:
  - [x]  Component Status View
  - [x]  Component Channels View
  - [x]  Subscribe only needed Channels in Soltaro ServiceAssistent
  - [x]  Get Channel Units for variable channel for singlethreshold history & live
  - [x]  Get DigitalInputChannels with separate request and fixed subscription
- Time-of-Use Tariff Stadtwerk Haßfurt implementation
- Time-of-Use Tariff Groupe-E implementation
  - Added new provider Groupe-E.
  - Added new currency CHF (Swiss francs) to the list of currencies in core meta.
  - Moved the exchangerate API to Utils so it is common for both ENTSO-E and Groupe-E providers.
- UI: set secure=https property in Cookie
  -This fixes an issue where a token value could be exposed when redirecting from http to https
- Update EdgeApp.bndrun

---------

Co-authored-by: Sebastian Asen <[email protected]>
Co-authored-by: Michael Grill <[email protected]>
Co-authored-by: Sagar Venu <[email protected]>
Co-authored-by: Lukas Rieger <[email protected]>
Co-authored-by: Katsuya Oda <[email protected]>
Co-authored-by: Hiromasa Ihara <[email protected]>

Author: 7 people

io.openems.backend.common/src/io/openems/backend/common/metadata/User.java

@@ -1,17 +1,12 @@
 package io.openems.backend.common.metadata;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map.Entry;
 import java.util.NavigableMap;
 import java.util.TreeMap;
 
 import com.google.gson.JsonObject;
 
-import io.openems.common.channel.Level;
 import io.openems.common.exceptions.OpenemsError;
 import io.openems.common.exceptions.OpenemsError.OpenemsNamedException;
-import io.openems.common.jsonrpc.response.GetEdgesResponse.EdgeMetadata;
 import io.openems.common.session.AbstractUser;
 import io.openems.common.session.Language;
 import io.openems.common.session.Role;
@@ -74,37 +69,6 @@ public Role assertEdgeRoleIsAtLeast(String resource, String edgeId, Role role) t
 		return thisRole;
 	}
 
-	/**
-	 * Gets the Metadata information of the accessible Edges.
-	 *
-	 * @param user            the {@link User}
-	 * @param metadataService a {@link Metadata} provider
-	 * @return a list of {@link EdgeMetadata}
-	 */
-	public static List<EdgeMetadata> generateEdgeMetadatas(User user, Metadata metadataService) {
-		List<EdgeMetadata> metadatas = new ArrayList<>();
-		for (Entry<String, Role> edgeRole : user.getEdgeRoles().entrySet()) {
-			var edgeId = edgeRole.getKey();
-			var role = edgeRole.getValue();
-			var edgeOpt = metadataService.getEdge(edgeId);
-			if (edgeOpt.isPresent()) {
-				var edge = edgeOpt.get();
-				metadatas.add(new EdgeMetadata(//
-						edge.getId(), // Edge-ID
-						edge.getComment(), // Comment
-						edge.getProducttype(), // Product-Type
-						edge.getVersion(), // Version
-						role, // Role
-						edge.isOnline(), // Online-State
-						edge.getLastmessage(), // Last-Message Timestamp
-						null, //
-						Level.OK //
-				));
-			}
-		}
-		return metadatas;
-	}
-
 	@Override
 	public boolean hasMultipleEdges() {
 		return this.hasMultipleEdges;

io.openems.backend.metadata.odoo/src/io/openems/backend/metadata/odoo/MetadataOdoo.java

@@ -9,7 +9,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.NavigableMap;
 import java.util.Optional;
 import java.util.TreeMap;
 import java.util.UUID;
@@ -176,16 +175,8 @@ public User authenticate(String sessionId) throws OpenemsNamedException {
 				.flatMap(JsonUtils::getAsOptionalJsonObject) //
 				.orElse(new JsonObject());
 
-		var jDevices = JsonUtils.getAsJsonArray(result, "devices");
-		NavigableMap<String, Role> roles = new TreeMap<>();
-		for (JsonElement device : jDevices) {
-			var edgeId = JsonUtils.getAsString(device, "name");
-			var role = Role.getRole(JsonUtils.getAsString(device, "role"));
-			roles.put(edgeId, role);
-		}
-
-		var user = new MyUser(odooUserId, login, name, sessionId, language, globalRole, roles, hasMultipleEdges,
-				settings);
+		var user = new MyUser(odooUserId, login, name, sessionId, language, globalRole, new TreeMap<>(),
+				hasMultipleEdges, settings);
 		var oldUser = this.users.put(login, user);
 		if (oldUser != null) {
 			oldUser.getEdgeRoles().forEach((edgeId, role) -> {

io.openems.backend.uiwebsocket/src/io/openems/backend/uiwebsocket/impl/OnRequest.java

@@ -170,8 +170,8 @@ private CompletableFuture<JsonrpcResponseSuccess> handleAuthentication(WsData ws
 			throws OpenemsNamedException {
 		wsData.setUserId(user.getId());
 		wsData.setToken(user.getToken());
-		return CompletableFuture.completedFuture(new AuthenticateResponse(requestId, user.getToken(), user,
-				User.generateEdgeMetadatas(user, this.parent.metadata), user.getLanguage()));
+		return CompletableFuture
+				.completedFuture(new AuthenticateResponse(requestId, user.getToken(), user, user.getLanguage()));
 	}
 
 	/**
@@ -225,9 +225,8 @@ private CompletableFuture<EdgeRpcResponse> handleEdgeRpcRequest(WsData wsData, U
 			this.handleSubscribeChannelsRequest(wsData, edgeId, user, SubscribeChannelsRequest.from(request));
 		case SubscribeSystemLogRequest.METHOD ->
 			this.handleSubscribeSystemLogRequest(wsData, edgeId, user, SubscribeSystemLogRequest.from(request));
-		case SimulationRequest.METHOD ->
-			this.handleSimulationRequest(edgeId, user, SimulationRequest.from(request));
-			
+		case SimulationRequest.METHOD -> this.handleSimulationRequest(edgeId, user, SimulationRequest.from(request));
+
 		case ComponentJsonApiRequest.METHOD -> {
 			final var componentRequest = ComponentJsonApiRequest.from(request);
 			if (!"_host".equals(componentRequest.getComponentId())) {
@@ -287,19 +286,20 @@ private CompletableFuture<EdgeRpcResponse> handleEdgeRpcRequest(WsData wsData, U
 	/**
 	 * Handles a {@link GetSimulationRequest}.
 	 * 
-	 * @param edgeId the Edge-ID
-	 * @param user the {@link User} - no specific level required
+	 * @param edgeId  the Edge-ID
+	 * @param user    the {@link User} - no specific level required
 	 * @param request the {@link GetSimulationRequest}
 	 * @return the JSON-RPC Success Response Future
 	 * @throws OpenemsNamedException on error
 	 */
-	private CompletableFuture<JsonrpcResponseSuccess> handleSimulationRequest(String edgeId, User user, SimulationRequest request) throws OpenemsNamedException {
-		
+	private CompletableFuture<JsonrpcResponseSuccess> handleSimulationRequest(String edgeId, User user,
+			SimulationRequest request) throws OpenemsNamedException {
+
 		final var simulation = this.parent.simulation;
 		if (simulation == null) {
 			throw new OpenemsException("simulation unavailable");
 		}
-		
+
 		return simulation.handleRequest(edgeId, user, request);
 	}
 

io.openems.common/src/io/openems/common/jsonrpc/response/AuthenticateResponse.java

@@ -1,15 +1,13 @@
 package io.openems.common.jsonrpc.response;
 
-import java.util.Collections;
-import java.util.List;
 import java.util.UUID;
 
+import com.google.gson.JsonArray;
 import com.google.gson.JsonObject;
 
 import io.openems.common.jsonrpc.base.JsonrpcResponseSuccess;
 import io.openems.common.jsonrpc.request.AuthenticateWithPasswordRequest;
 import io.openems.common.jsonrpc.request.AuthenticateWithTokenRequest;
-import io.openems.common.jsonrpc.response.GetEdgesResponse.EdgeMetadata;
 import io.openems.common.session.AbstractUser;
 import io.openems.common.session.Language;
 import io.openems.common.utils.JsonUtils;
@@ -33,19 +31,12 @@ public class AuthenticateResponse extends JsonrpcResponseSuccess {
 
 	private final String token;
 	private final AbstractUser user;
-	private final List<EdgeMetadata> edges;
 	private final Language language;
 
 	public AuthenticateResponse(UUID id, String token, AbstractUser user, Language language) {
-		this(id, token, user, Collections.emptyList(), language);
-	}
-
-	// TODO: remove after UI is updated to new version
-	public AuthenticateResponse(UUID id, String token, AbstractUser user, List<EdgeMetadata> edges, Language language) {
 		super(id);
 		this.token = token;
 		this.user = user;
-		this.edges = edges;
 		this.language = language;
 	}
 
@@ -65,7 +56,8 @@ public JsonObject getResult() {
 						.add("settings", this.user.getSettings()) //
 						.add("globalRole", this.user.getGlobalRole().asJson()) //
 						.build()) //
-				.add("edges", EdgeMetadata.toJson(this.edges)) //
+				// still kept to avoid NPE in UI for older versions
+				.add("edges", new JsonArray()) //
 				.build();
 	}
 

io.openems.common/src/io/openems/common/jsonrpc/serialization/JsonObjectPath.java

@@ -27,6 +27,23 @@ public default StringPath getStringPath(String member) {
 		return this.getJsonElementPath(member).getAsStringPath();
 	}
 
+	/**
+	 * Gets the enum value of the element associated with the member name of this
+	 * object.
+	 * 
+	 * @param <T>       the type of the enum
+	 * @param member    the name of the member
+	 * @param enumClass the class of the enum
+	 * @return the enum value
+	 */
+	public default <T extends Enum<T>> T getEnum(String member, Class<T> enumClass) {
+		try {
+			return Enum.valueOf(enumClass, this.getString(member));
+		} catch (Exception e) {
+			return enumClass.getEnumConstants()[0];
+		}
+	}
+
 	/**
 	 * Gets the element associated with the member name from this object as a
 	 * {@link String}.

io.openems.common/src/io/openems/common/jsonrpc/serialization/JsonSerializer.java

@@ -1,5 +1,10 @@
 package io.openems.common.jsonrpc.serialization;
 
+import static io.openems.common.jsonrpc.serialization.JsonSerializerUtil.jsonSerializer;
+import static io.openems.common.utils.JsonUtils.toJsonArray;
+
+import java.util.List;
+
 import com.google.gson.JsonElement;
 
 public interface JsonSerializer<T> {
@@ -38,4 +43,18 @@ public default T deserialize(JsonElement json) {
 		return this.deserializePath(new JsonElementPathActual(json));
 	}
 
+	/**
+	 * Creates a new {@link JsonSerializer} which is able to serialize {@link List
+	 * Lists} with their generic type of the current {@link JsonSerializer}.
+	 * 
+	 * @return the new {@link JsonSerializer} of a {@link List}
+	 */
+	public default JsonSerializer<List<T>> toListSerializer() {
+		return jsonSerializer(//
+				json -> json.getAsJsonArrayPath().getAsList(this), //
+				obj -> obj.stream() //
+						.map(this::serialize) //
+						.collect(toJsonArray()));
+	}
+
 }

io.openems.common/src/io/openems/common/oem/DummyOpenemsEdgeOem.java

@@ -65,6 +65,8 @@ public SystemUpdateParams getSystemUpdateParams() {
 			.put("App.FENECON.Industrial.S.ISK011", "https://fenecon.de/fenecon-industrial-s/") //
 			.put("App.TimeOfUseTariff.Awattar", "") //
 			.put("App.TimeOfUseTariff.ENTSO-E", "") //
+			.put("App.TimeOfUseTariff.GroupeE", "") //
+			.put("App.TimeOfUseTariff.Hassfurt", "") //
 			.put("App.TimeOfUseTariff.RabotCharge", "") //
 			.put("App.TimeOfUseTariff.Stromdao", "") //
 			.put("App.TimeOfUseTariff.Tibber", "") //

io.openems.common/src/io/openems/common/types/EdgeConfig.java

@@ -40,7 +40,7 @@
  */
 public class EdgeConfig {
 
-	private static Logger LOG = LoggerFactory.getLogger(EdgeConfig.class);
+	private static final Logger LOG = LoggerFactory.getLogger(EdgeConfig.class);
 
 	/**
 	 * Represents an instance of an OpenEMS Component.
@@ -1388,7 +1388,7 @@ public List<Component> getComponentsByFactory(String factoryId) {
 	public synchronized JsonObject toJson() {
 		if (this._json == null) {
 			this._json = JsonUtils.buildJsonObject() //
-					.add("components", this.componentsToJson(JsonFormat.COMPLETE)) //
+					.add("components", this.componentsToJson(JsonFormat.WITHOUT_CHANNELS)) //
 					.add("factories", this.factoriesToJson()) //
 					.build();
 		}