review: made some configs "non 0"-able where reasonable

* removed unused MqttConfig.getSourceBufferSize() Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
eclipse-ditto · Jul 12, 2021 · 8d96b7c · 8d96b7c
1 parent 48a1eb4
commit 8d96b7c
Show file tree

Hide file tree

Showing 12 changed files with 37 additions and 49 deletions.
diff --git a/...va/org/eclipse/ditto/base/service/config/supervision/DefaultExponentialBackOffConfig.java b/...va/org/eclipse/ditto/base/service/config/supervision/DefaultExponentialBackOffConfig.java
@@ -36,9 +36,9 @@ public final class DefaultExponentialBackOffConfig implements ExponentialBackOff
     private final Duration corruptedReceiveTimeout;
 
     private DefaultExponentialBackOffConfig(final ScopedConfig config) {
-        min = config.getNonNegativeAndNonZeroDurationOrThrow(ExponentialBackOffConfigValue.MIN);
+        min = config.getNonNegativeDurationOrThrow(ExponentialBackOffConfigValue.MIN);
         max = config.getNonNegativeDurationOrThrow(ExponentialBackOffConfigValue.MAX);
-        randomFactor = config.getNonNegativeDoubleOrThrow(ExponentialBackOffConfigValue.RANDOM_FACTOR);
+        randomFactor = config.getPositiveDoubleOrThrow(ExponentialBackOffConfigValue.RANDOM_FACTOR);
         corruptedReceiveTimeout =
                 config.getNonNegativeDurationOrThrow(ExponentialBackOffConfigValue.CORRUPTED_RECEIVE_TIMEOUT);
     }

diff --git a/...main/java/org/eclipse/ditto/concierge/service/common/DefaultPersistenceCleanupConfig.java b/...main/java/org/eclipse/ditto/concierge/service/common/DefaultPersistenceCleanupConfig.java
@@ -40,7 +40,7 @@ private DefaultPersistenceCleanupConfig(final ScopedConfig config) {
         this.enabled = config.getBoolean(ConfigValue.ENABLED.getConfigPath());
         this.quietPeriod = config.getNonNegativeAndNonZeroDurationOrThrow(ConfigValue.QUIET_PERIOD);
         this.cleanupTimeout = config.getNonNegativeAndNonZeroDurationOrThrow(ConfigValue.CLEANUP_TIMEOUT);
-        this.parallelism = config.getNonNegativeIntOrThrow(ConfigValue.PARALLELISM);
+        this.parallelism = config.getPositiveIntOrThrow(ConfigValue.PARALLELISM);
         this.keptCreditDecisions = config.getPositiveIntOrThrow(ConfigValue.KEEP_CREDIT_DECISIONS);
         this.keptActions = config.getPositiveIntOrThrow(ConfigValue.KEEP_ACTIONS);
         this.keptEvents = config.getPositiveIntOrThrow(ConfigValue.KEEP_EVENTS);

diff --git a/...c/main/java/org/eclipse/ditto/concierge/service/common/DefaultThingsAggregatorConfig.java b/...c/main/java/org/eclipse/ditto/concierge/service/common/DefaultThingsAggregatorConfig.java
@@ -36,7 +36,7 @@ public final class DefaultThingsAggregatorConfig implements ThingsAggregatorConf
     private DefaultThingsAggregatorConfig(final ScopedConfig config) {
         singleRetrieveThingTimeout =
                 config.getNonNegativeAndNonZeroDurationOrThrow(ThingsAggregatorConfigValue.SINGLE_RETRIEVE_THING_TIMEOUT);
-        maxParallelism = config.getNonNegativeIntOrThrow(ThingsAggregatorConfigValue.MAX_PARALLELISM);
+        maxParallelism = config.getPositiveIntOrThrow(ThingsAggregatorConfigValue.MAX_PARALLELISM);
     }
 
     /**

diff --git a/...va/org/eclipse/ditto/connectivity/service/config/DefaultConnectionIdsRetrievalConfig.java b/...va/org/eclipse/ditto/connectivity/service/config/DefaultConnectionIdsRetrievalConfig.java
@@ -34,9 +34,9 @@ public final class DefaultConnectionIdsRetrievalConfig implements ConnectionIdsR
 
     private DefaultConnectionIdsRetrievalConfig(final ScopedConfig config) {
         readJournalBatchSize =
-                config.getNonNegativeIntOrThrow(ConnectionIdsRetrievalConfigValue.READ_JOURNAL_BATCH_SIZE);
+                config.getPositiveIntOrThrow(ConnectionIdsRetrievalConfigValue.READ_JOURNAL_BATCH_SIZE);
         readSnapshotBatchSize =
-                config.getNonNegativeIntOrThrow(ConnectionIdsRetrievalConfigValue.READ_SNAPSHOT_BATCH_SIZE);
+                config.getPositiveIntOrThrow(ConnectionIdsRetrievalConfigValue.READ_SNAPSHOT_BATCH_SIZE);
     }
 
     /**

diff --git a/...ce/src/main/java/org/eclipse/ditto/connectivity/service/config/DefaultHttpPushConfig.java b/...ce/src/main/java/org/eclipse/ditto/connectivity/service/config/DefaultHttpPushConfig.java
@@ -39,7 +39,7 @@ final class DefaultHttpPushConfig implements HttpPushConfig, WithStringMapDecodi
     private final Map<String, String> hmacAlgorithms;
 
     private DefaultHttpPushConfig(final ScopedConfig config) {
-        maxQueueSize = config.getNonNegativeIntOrThrow(ConfigValue.MAX_QUEUE_SIZE);
+        maxQueueSize = config.getPositiveIntOrThrow(ConfigValue.MAX_QUEUE_SIZE);
         requestTimeout = config.getNonNegativeAndNonZeroDurationOrThrow(ConfigValue.REQUEST_TIMEOUT);
         httpProxyConfig = DefaultHttpProxyConfig.ofProxy(config);
         hmacAlgorithms = asStringMap(config, ConfigValue.HMAC_ALGORITHMS.getConfigPath());

diff --git a/...c/main/java/org/eclipse/ditto/connectivity/service/config/DefaultKafkaProducerConfig.java b/...c/main/java/org/eclipse/ditto/connectivity/service/config/DefaultKafkaProducerConfig.java
@@ -39,11 +39,11 @@ public final class DefaultKafkaProducerConfig implements KafkaProducerConfig {
     private final Config alpakkaConfig;
 
     private DefaultKafkaProducerConfig(final ScopedConfig kafkaProducerScopedConfig) {
-        queueSize = kafkaProducerScopedConfig.getNonNegativeIntOrThrow(ConfigValue.QUEUE_SIZE);
-        parallelism = kafkaProducerScopedConfig.getNonNegativeIntOrThrow(ConfigValue.PARALLELISM);
+        queueSize = kafkaProducerScopedConfig.getPositiveIntOrThrow(ConfigValue.QUEUE_SIZE);
+        parallelism = kafkaProducerScopedConfig.getPositiveIntOrThrow(ConfigValue.PARALLELISM);
         minBackoff = kafkaProducerScopedConfig.getNonNegativeDurationOrThrow(ConfigValue.MIN_BACKOFF);
         maxBackoff = kafkaProducerScopedConfig.getNonNegativeAndNonZeroDurationOrThrow(ConfigValue.MAX_BACKOFF);
-        randomFactor = kafkaProducerScopedConfig.getNonNegativeDoubleOrThrow(ConfigValue.RANDOM_FACTOR);
+        randomFactor = kafkaProducerScopedConfig.getPositiveDoubleOrThrow(ConfigValue.RANDOM_FACTOR);
         alpakkaConfig = kafkaProducerScopedConfig.getConfig(ALPAKKA_PATH);
     }
 

diff --git a/...ervice/src/main/java/org/eclipse/ditto/connectivity/service/config/DefaultMqttConfig.java b/...ervice/src/main/java/org/eclipse/ditto/connectivity/service/config/DefaultMqttConfig.java
@@ -33,7 +33,6 @@ public final class DefaultMqttConfig implements MqttConfig {
     private static final String CONFIG_PATH = "mqtt";
     private static final String RECONNECT_PATH = "reconnect";
 
-    private final int sourceBufferSize;
     private final int eventLoopThreads;
     private final boolean cleanSession;
     private final boolean reconnectForRedelivery;
@@ -43,7 +42,6 @@ public final class DefaultMqttConfig implements MqttConfig {
     private final BackOffConfig reconnectBackOffConfig;
 
     private DefaultMqttConfig(final ScopedConfig config) {
-        sourceBufferSize = config.getNonNegativeIntOrThrow(MqttConfigValue.SOURCE_BUFFER_SIZE);
         eventLoopThreads = config.getNonNegativeIntOrThrow(MqttConfigValue.EVENT_LOOP_THREADS);
         cleanSession = config.getBoolean(MqttConfigValue.CLEAN_SESSION.getConfigPath());
         reconnectForRedelivery = config.getBoolean(MqttConfigValue.RECONNECT_FOR_REDELIVERY.getConfigPath());
@@ -68,11 +66,6 @@ public static DefaultMqttConfig of(final Config config) {
         return new DefaultMqttConfig(ConfigWithFallback.newInstance(config, CONFIG_PATH, MqttConfigValue.values()));
     }
 
-    @Override
-    public int getSourceBufferSize() {
-        return sourceBufferSize;
-    }
-
     @Override
     public int getEventLoopThreads() {
         return eventLoopThreads;
@@ -117,8 +110,7 @@ public boolean equals(@Nullable final Object o) {
             return false;
         }
         final DefaultMqttConfig that = (DefaultMqttConfig) o;
-        return Objects.equals(sourceBufferSize, that.sourceBufferSize) &&
-                Objects.equals(eventLoopThreads, that.eventLoopThreads) &&
+        return Objects.equals(eventLoopThreads, that.eventLoopThreads) &&
                 Objects.equals(cleanSession, that.cleanSession) &&
                 Objects.equals(reconnectForRedelivery, that.reconnectForRedelivery) &&
                 Objects.equals(reconnectForRedeliveryDelay, that.reconnectForRedeliveryDelay) &&
@@ -130,16 +122,15 @@ public boolean equals(@Nullable final Object o) {
 
     @Override
     public int hashCode() {
-        return Objects.hash(sourceBufferSize, eventLoopThreads, cleanSession, reconnectForRedelivery,
+        return Objects.hash(eventLoopThreads, cleanSession, reconnectForRedelivery,
                 reconnectForRedeliveryDelay, useSeparateClientForPublisher,
                 reconnectMinTimeoutForMqttBrokerInitiatedDisconnect, reconnectBackOffConfig);
     }
 
     @Override
     public String toString() {
         return getClass().getSimpleName() + " [" +
-                "sourceBufferSize=" + sourceBufferSize +
-                ", eventLoopThreads=" + eventLoopThreads +
+                "eventLoopThreads=" + eventLoopThreads +
                 ", cleanSession=" + cleanSession +
                 ", reconnectForRedelivery=" + reconnectForRedelivery +
                 ", reconnectForRedeliveryDelay=" + reconnectForRedeliveryDelay +

diff --git a/...ivity/service/src/main/java/org/eclipse/ditto/connectivity/service/config/MqttConfig.java b/...ivity/service/src/main/java/org/eclipse/ditto/connectivity/service/config/MqttConfig.java
@@ -24,14 +24,6 @@
 @Immutable
 public interface MqttConfig {
 
-    /**
-     * Returns the maximum number of buffered messages for each MQTT source.
-     *
-     * @return the buffer size.
-     */
-    int getSourceBufferSize();
-
-
     /**
      * Returns the number of threads to use for the underlying event loop of the MQTT client.
      * When configured to {@code 0}, the size is determined based on {@code the available processor cores * 2}.
@@ -96,11 +88,6 @@ public interface MqttConfig {
      */
     enum MqttConfigValue implements KnownConfigValue {
 
-        /**
-         * The maximum number of buffered messages for each MQTT source.
-         */
-        SOURCE_BUFFER_SIZE("source-buffer-size", 8),
-
         /**
          * The number of threads to use for the underlying event loop of the MQTT client.
          */

diff --git a/...ava/org/eclipse/ditto/connectivity/service/config/javascript/DefaultJavaScriptConfig.java b/...ava/org/eclipse/ditto/connectivity/service/config/javascript/DefaultJavaScriptConfig.java
@@ -38,7 +38,7 @@ private DefaultJavaScriptConfig(final ScopedConfig config) {
         maxScriptSizeBytes = config.getPositiveIntOrThrow(JavaScriptConfigValue.MAX_SCRIPT_SIZE_BYTES);
         maxScriptExecutionTime =
                 config.getNonNegativeAndNonZeroDurationOrThrow(JavaScriptConfigValue.MAX_SCRIPT_EXECUTION_TIME);
-        maxScriptStackDepth = config.getNonNegativeIntOrThrow(JavaScriptConfigValue.MAX_SCRIPT_STACK_DEPTH);
+        maxScriptStackDepth = config.getPositiveIntOrThrow(JavaScriptConfigValue.MAX_SCRIPT_STACK_DEPTH);
     }
 
     /**

diff --git a/...main/java/org/eclipse/ditto/connectivity/service/config/mapping/DefaultMappingConfig.java b/...main/java/org/eclipse/ditto/connectivity/service/config/mapping/DefaultMappingConfig.java
@@ -39,8 +39,8 @@ public final class DefaultMappingConfig implements MappingConfig {
 
     private DefaultMappingConfig(final ScopedConfig config) {
         bufferSize = config.getNonNegativeIntOrThrow(MappingConfigValue.BUFFER_SIZE);
-        parallelism = config.getNonNegativeIntOrThrow(MappingConfigValue.PARALLELISM);
-        maxPoolSize = config.getNonNegativeIntOrThrow(MappingConfigValue.MAX_POOL_SIZE);
+        parallelism = config.getPositiveIntOrThrow(MappingConfigValue.PARALLELISM);
+        maxPoolSize = config.getPositiveIntOrThrow(MappingConfigValue.MAX_POOL_SIZE);
         mapperLimitsConfig = DefaultMapperLimitsConfig.of(config);
         javaScriptConfig = DefaultJavaScriptConfig.of(config);
     }

diff --git a/.../test/java/org/eclipse/ditto/connectivity/service/config/DefaultConnectionConfigTest.java b/.../test/java/org/eclipse/ditto/connectivity/service/config/DefaultConnectionConfigTest.java
@@ -114,12 +114,6 @@ public void underTestReturnsValuesOfConfigFile() {
                         .as(SnapshotConfig.SnapshotConfigValue.THRESHOLD.getConfigPath())
                         .isEqualTo(20));
 
-        softly.assertThat(underTest.getMqttConfig())
-                .as("mqttConfig")
-                .satisfies(mqttConfig -> softly.assertThat(mqttConfig.getSourceBufferSize())
-                        .as(MqttConfig.MqttConfigValue.SOURCE_BUFFER_SIZE.getConfigPath())
-                        .isEqualTo(7));
-
         softly.assertThat(underTest.getHttpPushConfig())
                 .as("httpPushConfig")
                 .satisfies(httpPushConfig -> softly.assertThat(httpPushConfig.getMaxQueueSize())

diff --git a/...rnal/utils/config/src/main/java/org/eclipse/ditto/internal/utils/config/ScopedConfig.java b/...rnal/utils/config/src/main/java/org/eclipse/ditto/internal/utils/config/ScopedConfig.java
@@ -76,7 +76,7 @@ public interface ScopedConfig extends Config, WithConfigPath {
     String DITTO_SCOPE = "ditto";
 
     /**
-     * Same as {@link #getDuration(String)} but with the guarantee that the returned Duration is non-negative.
+     * Same as {@link #getDuration(String)} but with the guarantee that the returned Duration is positive.
      *
      * @param withConfigPath provides the config path to get the Duration value for.
      * @return the duration.
@@ -128,7 +128,7 @@ default int getPositiveIntOrThrow(final WithConfigPath withConfigPath) {
      * Same as {@link #getLong(String)} but with the guarantee that the returned value is positive.
      *
      * @param withConfigPath provides the config path to get the long value for.
-     * @return the int value.
+     * @return the long value.
      * @throws DittoConfigError if the long value at the config path is zero or negative.
      */
     default long getPositiveLongOrThrow(final WithConfigPath withConfigPath) {
@@ -140,6 +140,22 @@ default long getPositiveLongOrThrow(final WithConfigPath withConfigPath) {
         return result;
     }
 
+    /**
+     * Same as {@link #getDouble(String)} but with the guarantee that the returned value is positive.
+     *
+     * @param withConfigPath provides the config path to get the double value for.
+     * @return the double value.
+     * @throws DittoConfigError if the long value at the config path is zero or negative.
+     */
+    default double getPositiveDoubleOrThrow(final WithConfigPath withConfigPath) {
+        final var result = getDouble(withConfigPath.getConfigPath());
+        if (0.0 >= result) {
+            final var msgPattern = "The double value at <{0}> must be positive but it was <{1}>!";
+            throw new DittoConfigError(MessageFormat.format(msgPattern, withConfigPath.getConfigPath(), result));
+        }
+        return result;
+    }
+
     /**
      * Same as {@link #getInt(String)} but with the guarantee that the returned int is greater zero.
      *
@@ -160,7 +176,7 @@ default int getNonNegativeIntOrThrow(final WithConfigPath withConfigPath) {
      * Same as {@link #getLong(String)} but with the guarantee that the returned long is greater zero.
      *
      * @param withConfigPath provides the config path to get the long value for.
-     * @return the int value.
+     * @return the long value.
      * @throws DittoConfigError if the long value at the config path is negative.
      */
     default long getNonNegativeLongOrThrow(final WithConfigPath withConfigPath) {
@@ -176,7 +192,7 @@ default long getNonNegativeLongOrThrow(final WithConfigPath withConfigPath) {
      * Same as {@link #getDouble(String)} but with the guarantee that the returned double is not negative.
      *
      * @param withConfigPath provides the config path to get the double value for.
-     * @return the int value.
+     * @return the double value.
      * @throws DittoConfigError if the double value at the config path is negative.
      */
     default double getNonNegativeDoubleOrThrow(final WithConfigPath withConfigPath) {
@@ -192,7 +208,7 @@ default double getNonNegativeDoubleOrThrow(final WithConfigPath withConfigPath)
      * Same as {@link #getBytes(String)} but with the guarantee that the returned long is greater zero.
      *
      * @param withConfigPath provides the config path to get the bytes value for.
-     * @return the int value.
+     * @return the bytes value.
      * @throws DittoConfigError if the bytes value at the config path is negative.
      */
     default long getNonNegativeBytesOrThrow(final WithConfigPath withConfigPath) {