#2072: enhance Helm configuration with pre-defined extraFields

Author: thjaeckle

deployment/helm/ditto/Chart.yaml

@@ -16,7 +16,7 @@ description: |
   A digital twin is a virtual, cloud based, representation of his real world counterpart
   (real world “Things”, e.g. devices like sensors, smart heating, connected cars, smart grids, EV charging stations etc).
 type: application
-version: 3.6.9  # chart version is effectively set by release-job
+version: 3.6.10  # chart version is effectively set by release-job
 appVersion: 3.6.9
 keywords:
   - iot-chart

deployment/helm/ditto/service-config/things-extension.conf.tpl

@@ -44,6 +44,46 @@ ditto {
           "{{$header}}"
         {{- end }}
         ]
+        pre-defined-extra-fields = [
+        {{- range $index, $extraFieldConfig := .Values.things.config.event.preDefinedExtraFields }}
+          {
+            namespaces = [
+            {{- range $index, $namespace := $extraFieldConfig.namespaces }}
+              "{{$namespace}}"
+            {{- end }}
+            ]
+            {{- if $extraFieldConfig.condition }}
+            condition = "{{$extraFieldConfig.condition}}"
+            {{- end }}
+            extra-fields = [
+            {{- range $index, $extraField := $extraFieldConfig.extraFields }}
+              "{{$extraField}}"
+            {{- end }}
+            ]
+          }
+        {{- end }}
+        ]
+      }
+      message {
+        pre-defined-extra-fields = [
+        {{- range $index, $extraFieldConfig := .Values.things.config.message.preDefinedExtraFields }}
+          {
+            namespaces = [
+            {{- range $index, $namespace := $extraFieldConfig.namespaces }}
+              "{{$namespace}}"
+            {{- end }}
+            ]
+            {{- if $extraFieldConfig.condition }}
+            condition = "{{$extraFieldConfig.condition}}"
+            {{- end }}
+            extra-fields = [
+            {{- range $index, $extraField := $extraFieldConfig.extraFields }}
+              "{{$extraField}}"
+            {{- end }}
+            ]
+          }
+        {{- end }}
+        ]
       }
     }
 

deployment/helm/ditto/values.yaml

@@ -1059,6 +1059,27 @@ things:
         interval: 15m
         # the threshold after how many changes to a Thing to do a snapshot
         threshold: 50
+    # event contains configuration related to e.g. publishing of thing events
+    event:
+      # preDefinedExtraFields contains pre-defined (configured) extraFields to send along all thing (change) events
+      preDefinedExtraFields: []
+      # - namespaces:
+      #     - "org.eclipse.ditto*"
+      #   condition: "eq(attributes/foo,'RQL condition')"
+      #   extraFields:
+      #     - "definition"
+      #     - "attributes/serial"
+    # message contains configuration related to distributing thing messages
+    message:
+      # preDefinedExtraFields contains pre-defined (configured) extraFields to send along all thing messages
+      preDefinedExtraFields: []
+      # - namespaces:
+      #     - "namespace1"
+      #     - "namespace2"
+      #   condition: "eq(attributes/foo,'RQL condition')"
+      #   extra-fields:
+      #     - "definition"
+      #     - "attributes/serial"
     # entityCreation by default, Ditto allows anyone to create a new entity (thing in this case) in any namespace.
     #  However, this behavior can be customized, and the ability to create new entities can be restricted:
     entityCreation:

things/service/src/main/java/org/eclipse/ditto/things/service/common/config/ThingMessageConfig.java

@@ -22,7 +22,7 @@
 public interface ThingMessageConfig {
 
     /**
-     * Contains pre-defined (configured) {@code extraFields} to send along all thing (change) messages.
+     * Contains pre-defined (configured) {@code extraFields} to send along all thing messages.
      *
      * @return the pre-defined {@code extraFields} to send along.
      */

things/service/src/main/java/org/eclipse/ditto/things/service/persistence/actors/enrichment/PreDefinedExtraFieldsEnricher.java

@@ -108,9 +108,12 @@ public <T extends DittoHeadersSettable<? extends T>> CompletionStage<T> enrichWi
         if (null != thing && !preDefinedExtraFieldsConfigs.isEmpty()) {
             final List<PreDefinedExtraFieldsConfig> matchingPreDefinedFieldsConfigs =
                     preDefinedExtraFieldsConfigs.stream()
-                            .filter(conf -> conf
-                                    .getNamespace().stream()
-                                    .anyMatch(pattern -> pattern.matcher(thingId.getNamespace()).matches())
+                            .filter(conf -> conf.getNamespace().isEmpty() ||
+                                    conf.getNamespace()
+                                            .stream()
+                                            .anyMatch(pattern ->
+                                                    pattern.matcher(thingId.getNamespace()).matches()
+                                            )
                             )
                             .filter(applyPredefinedExtraFieldsCondition(thing, withDittoHeaders))
                             .toList();