Feature/27476 rework tags (#618)

* Starting tags rework

* Everything is building again

* eip-tests working

* file adapter tests working

* http adapter working

* modbus adapter working

* opcua adapter working

* plc4x adapter working

* Move it

* All tests are working

* eip working with new persistence

* Reworked tag config structure

* Remaining tests fixed

* Getting rid of the explicit persistence and moving it into the adaptermanager

* Fixing compile issues

* Added logs

* Applying debugging results

* A last typing change

* Reverting the last typing change because of generics-shenanigans

* npe ...

* Fixed a broken config mapping

* Fixed a mapping problem

* Prevent empty rewrite

* protecting underlying map

* Removed FIXME

* Post rebase cleanup

* Review comments

* Review comments

* add license headers

* Cleaning up mess caused by rebase ...

* update OpenAPI

---------

Co-authored-by: Daniel Krueger <[email protected]>

Author: codepitbull

ext/hivemq-edge-openapi-2024.8-SNAPSHOT.yaml

@@ -4702,7 +4702,11 @@ components:
           type: string
           description: The protocol id of the protocol for which this tag was created.
         tagDefinition:
-          $ref: '#/components/schemas/JsonNode'
+          type: object
+          additionalProperties:
+            type: object
+            description: A user created description for this tag.
+          description: A user created description for this tag.
         tagName:
           type: string
           description: The name of the tag that identifies it within this edge instance.

hivemq-edge/src/distribution/conf/examples/configuration/adapters/config-sample-s7.xml

@@ -26,32 +26,42 @@
     </mqtt-listeners>
     <protocol-adapters>
         <s7>
-            <id>my-s7-id</id>
-            <host>172.16.10.51</host>
-            <port>102</port>
-            <controllerType>S7_1500</controllerType>
-            <remoteRack>0</remoteRack>
-            <remoteRack2>0</remoteRack2>
-            <remoteSlot>0</remoteSlot>
-            <remoteSlot2>0</remoteSlot2>
-            <remoteTsap>0</remoteTsap>
-            <s7ToMqtt>
-                <maxPollingErrorsBeforeRemoval>10</maxPollingErrorsBeforeRemoval>
-                <pollingIntervalMillis>1000</pollingIntervalMillis>
-                <publishChangedDataOnly>true</publishChangedDataOnly>
-                <s7ToMqttMappings>
-                    <s7ToMqttMapping>
-                        <mqttTopic>my/topic</mqttTopic>
-                        <mqttQos>1</mqttQos>
-                        <includeTagNames>false</includeTagNames>
-                        <includeTimestamp>true</includeTimestamp>
-                        <messageHandlingOptions>MQTTMessagePerTag</messageHandlingOptions>
-                        <tagName>my-tag-name-1</tagName>
-                        <tagDefinition>tag1</tagDefinition>
-                        <dataType>BOOL</dataType>
-                    </s7ToMqttMapping>
-                </s7ToMqttMappings>
-            </s7ToMqtt>
+            <config>
+                <id>my-s7-id</id>
+                <host>172.16.10.51</host>
+                <port>102</port>
+                <controllerType>S7_1500</controllerType>
+                <remoteRack>0</remoteRack>
+                <remoteRack2>0</remoteRack2>
+                <remoteSlot>0</remoteSlot>
+                <remoteSlot2>0</remoteSlot2>
+                <remoteTsap>0</remoteTsap>
+                <s7ToMqtt>
+                    <maxPollingErrorsBeforeRemoval>10</maxPollingErrorsBeforeRemoval>
+                    <pollingIntervalMillis>1000</pollingIntervalMillis>
+                    <publishChangedDataOnly>true</publishChangedDataOnly>
+                    <s7ToMqttMappings>
+                        <s7ToMqttMapping>
+                            <mqttTopic>my/topic</mqttTopic>
+                            <mqttQos>1</mqttQos>
+                            <includeTagNames>false</includeTagNames>
+                            <includeTimestamp>true</includeTimestamp>
+                            <messageHandlingOptions>MQTTMessagePerTag</messageHandlingOptions>
+                            <tagName>my-tag-name-1</tagName>
+                            <dataType>BOOL</dataType>
+                        </s7ToMqttMapping>
+                    </s7ToMqttMappings>
+                </s7ToMqtt>
+            </config>
+            <tags>
+                <tag>
+                    <name>my-tag-name-1</name>
+                    <description></description>
+                    <definition>
+                        <tagAddress>tag1</tagAddress>
+                    </definition>
+                </tag>
+            </tags>
         </s7>
     </protocol-adapters>
 </hivemq>

hivemq-edge/src/distribution/conf/tag.xml

@@ -23,13 +23,12 @@
 import com.hivemq.persistence.domain.DomainTag;
 import io.swagger.v3.oas.annotations.media.Schema;
 
+import java.util.Map;
+import java.util.Objects;
+
 @Schema(name = "DomainTag")
 public class DomainTagModel {
 
-    @JsonProperty("tagDefinition")
-    @Schema(description = "The address for the data point on the device.")
-    private final @NotNull JsonNode tagDefinition;
-
     @JsonProperty("tagName")
     @Schema(description = "The name of the tag that identifies it within this edge instance.")
     private final @NotNull String tag;
@@ -42,26 +41,26 @@ public class DomainTagModel {
     @Schema(description = "A user created description for this tag.")
     private final @NotNull String description;
 
+    @JsonProperty("tagDefinition")
+    @Schema(description = "A user created description for this tag.")
+    private final @NotNull Map<String, Object> definition;
+
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
     public DomainTagModel(
-            @JsonProperty("tagDefinition") final @NotNull JsonNode tagDefinition,
             @JsonProperty("tagName") final @NotNull String tag,
             @JsonProperty("protocolId") final @NotNull String protocolId,
-            @JsonProperty("description") final @NotNull String description) {
-        this.tagDefinition = tagDefinition;
+            @JsonProperty("description") final @NotNull String description,
+            @JsonProperty("tagDefinition") final @NotNull Map<String, Object> definition) {
         this.tag = tag;
         this.protocolId = protocolId;
         this.description = description;
+        this.definition = definition;
     }
 
     public @NotNull String getTag() {
         return tag;
     }
 
-    public @NotNull JsonNode getTagDefinition() {
-        return tagDefinition;
-    }
-
     public @NotNull String getDescription() {
         return description;
     }
@@ -70,46 +69,45 @@ public DomainTagModel(
         return protocolId;
     }
 
-    public static @NotNull DomainTagModel fromDomainTag(final @NotNull DomainTag domainTag) {
-        return new DomainTagModel(domainTag.getTagDefinition(),
-                domainTag.getTagName(),
-                "someProtocolId",
-                "someDescription");
-    }
-
-    @Override
-    public boolean equals(final @Nullable Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
-
-        final DomainTagModel that = (DomainTagModel) o;
-        return tagDefinition.equals(that.tagDefinition) &&
-                tag.equals(that.tag) &&
-                protocolId.equals(that.protocolId) &&
-                description.equals(that.description);
+    public @NotNull Map<String, Object> getDefinition() {
+        return definition;
     }
 
-    @Override
-    public int hashCode() {
-        int result = tagDefinition.hashCode();
-        result = 31 * result + tag.hashCode();
-        result = 31 * result + protocolId.hashCode();
-        result = 31 * result + description.hashCode();
-        return result;
+    public static @NotNull DomainTagModel fromDomainTag(final @NotNull DomainTag domainTag) {
+        return new DomainTagModel(
+                domainTag.getTagName(),
+                domainTag.getProtocolId(),
+                domainTag.getDescription(),
+                domainTag.getDefinition());
     }
 
     @Override
-    public @NotNull String toString() {
+    public String toString() {
         return "DomainTagModel{" +
-                "description='" +
-                description +
-                '\'' + ", tagAddress=" + tagDefinition +
-                ", tag='" +
+                "tag='" +
                 tag +
                 '\'' +
                 ", protocolId='" +
                 protocolId +
                 '\'' +
+                ", description='" +
+                description +
+                '\'' +
                 '}';
     }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        final DomainTagModel that = (DomainTagModel) o;
+        return Objects.equals(tag, that.tag) &&
+                Objects.equals(protocolId, that.protocolId) &&
+                Objects.equals(description, that.description);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(tag, protocolId, description);
+    }
 }

hivemq-edge/src/distribution/conf/tag.xsd

@@ -23,7 +23,6 @@
 import com.google.common.base.Preconditions;
 import com.hivemq.adapter.sdk.api.ProtocolAdapterCapability;
 import com.hivemq.adapter.sdk.api.ProtocolAdapterInformation;
-import com.hivemq.adapter.sdk.api.factories.ProtocolAdapterFactory;
 import com.hivemq.api.model.adapters.ProtocolAdapter;
 import com.hivemq.api.model.adapters.ProtocolAdapterCategory;
 import com.hivemq.api.model.components.Module;
@@ -86,17 +85,15 @@ public static ProtocolAdapter convertInstalledAdapterType(
             // so we should trust but validate and at least log.
             LOG.warn("Logo url for adapter '{}' was null. ", info.getDisplayName());
         }
-        final ProtocolAdapterFactory<?> protocolAdapterFactory =
-                adapterManager.getProtocolAdapterFactory(info.getProtocolId());
-        if (protocolAdapterFactory == null) {
+        if (!adapterManager.protocolAdapterFactoryExists(info.getProtocolId())) {
             // this can only happen if the adapter somehow got removed from the manager concurrently, which is not possible right now
-            LOG.warn("Factory for adapter '{}' was not found while conversion of adapter to information for REST API.",
+            LOG.error("Factory for adapter '{}' was not found while conversion of adapter to information for REST API.",
                     info.getDisplayName());
             return null;
         }
 
         final ProtocolAdapterSchemaManager protocolAdapterSchemaManager =
-                new ProtocolAdapterSchemaManager(objectMapper, protocolAdapterFactory.getConfigClass());
+                new ProtocolAdapterSchemaManager(objectMapper, adapterManager.writingEnabled() ? info.configurationClassWriting() : info.configurationClassReading());
 
 
         final String rawVersion = info.getVersion();