Merge pull request #2134 from beyonnex-io/bugfix/fix-config-throttling

fix configuration of throttling of search index update after policy update

Author: thjaeckle

base/service/src/main/java/org/eclipse/ditto/base/service/config/ThrottlingConfig.java

@@ -90,7 +90,7 @@ enum ConfigValue implements KnownConfigValue {
         /**
          * Whether throttling should be enabled.
          */
-        ENABLED("enabled", false),
+        ENABLED("enabled", true),
 
         /**
          * The throttling interval meaning in which duration may the configured

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.7.0  # chart version is effectively set by release-job
+version: 3.7.1  # chart version is effectively set by release-job
 appVersion: 3.7.0
 keywords:
   - iot-chart

deployment/helm/ditto/templates/thingssearch-deployment.yaml

@@ -206,7 +206,7 @@ spec:
               value: "{{ .Values.thingsSearch.config.mongodb.policyModificationCausedSearchIndexUpdateThrottling.enabled }}"
             - name: POLICY_MODIFICATION_CAUSED_SEARCH_INDEX_UPDATE_THROTTLING_INTERVAL
               value: "{{ .Values.thingsSearch.config.mongodb.policyModificationCausedSearchIndexUpdateThrottling.interval }}"
-            - name: POLICY_MODIFICATION_CAUSED_SEARCH_INDEX_UPDATE_policyModificationCausedSearchIndexUpdateThrottlingTHROTTLING_LIMIT
+            - name: POLICY_MODIFICATION_CAUSED_SEARCH_INDEX_UPDATE_THROTTLING_LIMIT
               value: "{{ .Values.thingsSearch.config.mongodb.policyModificationCausedSearchIndexUpdateThrottling.limit }}"
             - name: THINGS_SEARCH_UPDATER_STREAM_PERSISTENCE_WITH_ACKS_WRITE_CONCERN
               value: "{{ .Values.thingsSearch.config.mongodb.searchWithAcksWriteConcern }}"

deployment/helm/ditto/values.yaml

@@ -1376,13 +1376,13 @@ thingsSearch:
       updaterPersistenceReadConcern: "local"
       # updaterPersistenceReadPreference configures the MongoDB read preference for the "ThingUpdater"
       updaterPersistenceReadPreference: "primaryPreferred"
-      # PolicyModificationCausedSearchIndexUpdateThrottling contains throttling configuration for the search Index update after a policy update
+      # policyModificationCausedSearchIndexUpdateThrottling contains throttling configuration for the search Index update after a policy update
       policyModificationCausedSearchIndexUpdateThrottling:
-        # enabled defines whether throttling should be applied for search Index update after a policy update.
-        enabled: false
-        # The time window within which the throttling limit applies.
+        # enabled defines whether throttling should be applied for search Index update after a policy update
+        enabled: true
+        # interval defined the time window within which the throttling limit applies
         interval: 1s
-        # The maximum number of updates allowed within each throttling interval.
+        # limit is the maximum number of updates allowed within each throttling interval
         limit: 100
     # updater contains configuration for the "Things Updater" of things-search service
     updater:

thingsearch/service/src/main/java/org/eclipse/ditto/thingsearch/service/persistence/write/impl/MongoThingsSearchUpdaterPersistence.java

@@ -25,6 +25,9 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import org.apache.pekko.NotUsed;
+import org.apache.pekko.japi.pf.PFBuilder;
+import org.apache.pekko.stream.javadsl.Source;
 import org.bson.BsonDateTime;
 import org.bson.BsonDocument;
 import org.bson.BsonInt32;
@@ -48,22 +51,20 @@
 import com.mongodb.reactivestreams.client.MongoCollection;
 import com.mongodb.reactivestreams.client.MongoDatabase;
 
-import org.apache.pekko.NotUsed;
-import org.apache.pekko.japi.pf.PFBuilder;
-import org.apache.pekko.stream.javadsl.Source;
-
 /**
  * MongoDB specific implementation of the {@link org.eclipse.ditto.thingsearch.service.persistence.write.ThingsSearchUpdaterPersistence}.
  */
 public final class MongoThingsSearchUpdaterPersistence implements ThingsSearchUpdaterPersistence {
 
     private final MongoCollection<Document> collection;
 
-    private final ThrottlingConfig PolicyModificationCausedSearchIndexUpdateThrottling;
+    private final ThrottlingConfig policyModificationCausedSearchIndexUpdateThrottling;
 
     private MongoThingsSearchUpdaterPersistence(final MongoDatabase database,
-                                                final SearchPersistenceConfig updaterPersistenceConfig) {
-        this.PolicyModificationCausedSearchIndexUpdateThrottling = updaterPersistenceConfig.getPolicyModificationCausedSearchIndexUpdateThrottling();
+                                                final SearchPersistenceConfig updaterPersistenceConfig)
+    {
+        this.policyModificationCausedSearchIndexUpdateThrottling = updaterPersistenceConfig
+                .getPolicyModificationCausedSearchIndexUpdateThrottling();
 
         collection = database.getCollection(PersistenceConstants.THINGS_COLLECTION_NAME)
                 .withReadConcern(updaterPersistenceConfig.readConcern().getMongoReadConcern())
@@ -111,10 +112,10 @@ public Source<PolicyReferenceTag, NotUsed> getPolicyReferenceTags(final Map<Poli
                         .append(PersistenceConstants.FIELD_REFERENCED_POLICIES, new BsonInt32(1)));
 
 
-        final Source<Document, NotUsed> throttledSource = PolicyModificationCausedSearchIndexUpdateThrottling.isEnabled()
+        final Source<Document, NotUsed> throttledSource = policyModificationCausedSearchIndexUpdateThrottling.isEnabled()
                 ? Source.fromPublisher(publisher).throttle(
-                    PolicyModificationCausedSearchIndexUpdateThrottling.getLimit(),
-                    PolicyModificationCausedSearchIndexUpdateThrottling.getInterval()
+                    policyModificationCausedSearchIndexUpdateThrottling.getLimit(),
+                    policyModificationCausedSearchIndexUpdateThrottling.getInterval()
                 )
                 : Source.fromPublisher(publisher);
 

thingsearch/service/src/main/resources/search.conf

@@ -299,16 +299,18 @@ ditto {
         # read concern is one of: default, local, majority, linearizable, snapshot, available
         readConcern = ${ditto.mongodb.options.readConcern}
         readConcern = ${?UPDATER_PERSISTENCE_MONGO_DB_READ_CONCERN}
-        # PolicyModificationCausedSearchIndexUpdateThrottling contains throttling configuration for the search Index update after a policy update
+
+        # policyModificationCausedSearchIndexUpdateThrottling contains throttling configuration for the search Index update after a policy update
         policyModificationCausedSearchIndexUpdateThrottling {
-        # enabled defines whether throttling should be applied for search Index update after a policy update.
+          # enabled defines whether throttling should be applied for search Index update after a policy update
           enabled = false
           enabled = ${?POLICY_MODIFICATION_CAUSED_SEARCH_INDEX_UPDATE_THROTTLING_ENABLED}
-          # The interval at which updates are throttled (e.g., every 1 second)
+
+          # interval at which updates are throttled (e.g., every 1 second)
           interval = 1s
           interval = ${?POLICY_MODIFICATION_CAUSED_SEARCH_INDEX_UPDATE_THROTTLING_INTERVAL}
 
-          # Maximum number of updates allowed per interval (e.g., 100 updates per second)
+          # limit is the maximum number of updates allowed per interval (e.g., 100 updates per second)
           limit = 100
           limit = ${?POLICY_MODIFICATION_CAUSED_SEARCH_INDEX_UPDATE_THROTTLING_LIMIT}
         }