Agnostic interface to support multiple circuit breaker strategies config (#550)

* setup resilience4j

* specifying circuit breaker strategy name

* creating agnostic interface to support multiple circuit breaker strategy types

* fixme

* [Gradle Release Plugin] - new version commit:  '3.25.11-snapshot'.

* release notes

Author: mageddo

RELEASE-NOTES.md

@@ -1,3 +1,6 @@
+## 3.25.11
+* Agnostic interface to support multiple circuit breaker strategies config #533
+
 ## 3.25.10
 * Create `IntTests` suite, they are comp tests which can be run within native image, see the docs #480
 * Upgrading necessary deps

build.gradle

@@ -65,6 +65,7 @@ dependencies {
   implementation('org.apache.commons:commons-compress:1.22')
   implementation('org.rauschig:jarchivelib:1.2.0')
   implementation('dev.failsafe:failsafe:3.3.1')
+  implementation("io.github.resilience4j:resilience4j-circuitbreaker:2.2.0")
 
   implementation('com.github.docker-java:docker-java-core:3.3.4')
   implementation('com.github.docker-java:docker-java-transport-httpclient5:3.3.4')

gradle.properties

@@ -1 +1 @@
-version=3.25.10-snapshot
+version=3.25.11-snapshot

src/main/java/com/mageddo/dnsproxyserver/config/CircuitBreakerStrategy.java

@@ -0,0 +1,11 @@
+package com.mageddo.dnsproxyserver.config;
+
+public interface CircuitBreakerStrategy {
+
+  Name type();
+
+  enum Name {
+    STATIC_THRESHOLD,
+    CANARY_RATE_THRESHOLD,
+  }
+}

src/main/java/com/mageddo/dnsproxyserver/config/Config.java

@@ -90,7 +90,7 @@ public void resetConfigFile() {
   }
 
   @JsonIgnore
-  public CircuitBreaker getSolverRemoteCircuitBreaker() {
+  public CircuitBreakerStrategy getSolverRemoteCircuitBreaker() {
     if (this.solverRemote == null) {
       return null;
     }

src/main/java/com/mageddo/dnsproxyserver/config/SolverRemote.java

@@ -9,5 +9,5 @@ public class SolverRemote {
 
   private Boolean active;
 
-  private CircuitBreaker circuitBreaker;
+  private CircuitBreakerStrategy circuitBreaker;
 }

…nsproxyserver/config/CircuitBreaker.java …aticThresholdCircuitBreakerStrategy.javasrc/main/java/com/mageddo/dnsproxyserver/config/CircuitBreaker.java renamed to src/main/java/com/mageddo/dnsproxyserver/config/StaticThresholdCircuitBreakerStrategy.java src/main/java/com/mageddo/dnsproxyserver/config/CircuitBreaker.java renamed to src/main/java/com/mageddo/dnsproxyserver/config/StaticThresholdCircuitBreakerStrategy.java

@@ -8,7 +8,7 @@
 
 @Value
 @Builder
-public class CircuitBreaker {
+public class StaticThresholdCircuitBreakerStrategy implements CircuitBreakerStrategy {
 
   /**
    * See {@link dev.failsafe.CircuitBreakerBuilder#withFailureThreshold(int, int)}
@@ -26,7 +26,12 @@ public class CircuitBreaker {
    */
   private Duration testDelay;
 
-  public static CircuitBreaker empty() {
-    return CircuitBreaker.builder().build();
+  public static StaticThresholdCircuitBreakerStrategy empty() {
+    return StaticThresholdCircuitBreakerStrategy.builder().build();
+  }
+
+  @Override
+  public Name type() {
+    return Name.STATIC_THRESHOLD;
   }
 }

src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/mapper/ConfigJsonV2Mapper.java

@@ -1,6 +1,6 @@
 package com.mageddo.dnsproxyserver.config.dataprovider.mapper;
 
-import com.mageddo.dnsproxyserver.config.CircuitBreaker;
+import com.mageddo.dnsproxyserver.config.StaticThresholdCircuitBreakerStrategy;
 import com.mageddo.dnsproxyserver.config.Config;
 import com.mageddo.dnsproxyserver.config.SolverRemote;
 import com.mageddo.dnsproxyserver.config.dataprovider.vo.ConfigJson;
@@ -63,7 +63,9 @@ static SolverRemote buildCompleteSolverRemote(ConfigJson json, ConfigJsonV2.Circ
     return SolverRemote
       .builder()
       .active(Booleans.reverseWhenNotNull(json.getNoRemoteServers()))
-      .circuitBreaker(CircuitBreaker
+      // fixme #533 need to create a dynamic json parser for different strategies,
+      //      then a dynamic mapper to the solver remote
+      .circuitBreaker(StaticThresholdCircuitBreakerStrategy
         .builder()
         .failureThreshold(circuitBreaker.getFailureThreshold())
         .failureThresholdCapacity(circuitBreaker.getFailureThresholdCapacity())

src/main/java/com/mageddo/dnsproxyserver/config/mapper/ConfigMapper.java

@@ -1,6 +1,6 @@
 package com.mageddo.dnsproxyserver.config.mapper;
 
-import com.mageddo.dnsproxyserver.config.CircuitBreaker;
+import com.mageddo.dnsproxyserver.config.StaticThresholdCircuitBreakerStrategy;
 import com.mageddo.dnsproxyserver.config.Config;
 import com.mageddo.dnsproxyserver.config.SolverRemote;
 import com.mageddo.dnsproxyserver.config.dataprovider.ConfigPropDAO;
@@ -74,8 +74,8 @@ private static Config buildDefault() {
       .build();
   }
 
-  public static CircuitBreaker defaultCircuitBreaker() {
-    return CircuitBreaker
+  public static StaticThresholdCircuitBreakerStrategy defaultCircuitBreaker() {
+    return StaticThresholdCircuitBreakerStrategy
       .builder()
       .failureThreshold(3)
       .failureThresholdCapacity(10)

src/main/java/com/mageddo/dnsproxyserver/config/validator/CircuitBreakerValidator.java

@@ -1,12 +1,12 @@
 package com.mageddo.dnsproxyserver.config.validator;
 
-import com.mageddo.dnsproxyserver.config.CircuitBreaker;
+import com.mageddo.dnsproxyserver.config.StaticThresholdCircuitBreakerStrategy;
 import org.apache.commons.lang3.Validate;
 
 import static com.mageddo.dnsproxyserver.utils.Numbers.positiveOrNull;
 
 public class CircuitBreakerValidator {
-  public static void validate(CircuitBreaker circuit) {
+  public static void validate(StaticThresholdCircuitBreakerStrategy circuit) {
     Validate.notNull(positiveOrNull(circuit.getFailureThreshold()), genMsg("failure theshold must be a positive number"));
     Validate.notNull(positiveOrNull(circuit.getSuccessThreshold()), genMsg("success theshold must be positive number"));
     Validate.notNull(positiveOrNull(circuit.getFailureThresholdCapacity()), genMsg("success theshold capacity must be positive number"));