Skip to content

Commit

Permalink
Issue resilience4j#703: Added builder for CircuitBreakerRegistry (res…
Browse files Browse the repository at this point in the history 
…ilience4j#882)
  • Loading branch information
@KrnSaurabh
KrnSaurabh committed Mar 4, 2020
1 parent b434731 commit 6b30b2c
Show file tree
Hide file tree
Showing 9 changed files with 545 additions and 12 deletions.
92 changes: 92 additions & 0 deletions ...itbreaker/src/main/java/io/github/resilience4j/circuitbreaker/CircuitBreakerRegistry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@

import io.github.resilience4j.circuitbreaker.internal.InMemoryCircuitBreakerRegistry;
import io.github.resilience4j.core.Registry;
import io.github.resilience4j.core.RegistryStore;
import io.github.resilience4j.core.registry.RegistryEventConsumer;
import io.vavr.collection.HashMap;
import io.vavr.collection.Seq;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;
Expand Down Expand Up @@ -261,4 +263,94 @@ CircuitBreaker circuitBreaker(String name,
Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier,
io.vavr.collection.Map<String, String> tags);

/**
* Returns a builder to create a custom CircuitBreakerRegistry.
*
* @return a {@link CircuitBreakerRegistry.Builder}
*/
static Builder custom() {
return new Builder();
}

class Builder {

private static final String DEFAULT_CONFIG = "default";
private RegistryStore registryStore;
private Map<String, CircuitBreakerConfig> circuitBreakerConfigsMap;
private List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers;
private io.vavr.collection.Map<String, String> tags;

public Builder() {
this.circuitBreakerConfigsMap = new java.util.HashMap<>();
this.registryEventConsumers = new ArrayList<>();
}

public Builder withRegistryStore(RegistryStore registryStore) {
this.registryStore = registryStore;
return this;
}

/**
* Configures a CircuitBreakerRegistry with a custom default CircuitBreaker configuration.
*
* @param circuitBreakerConfig a custom default CircuitBreaker configuration
* @return a {@link CircuitBreakerRegistry.Builder}
*/
public Builder withCircuitBreakerConfig(CircuitBreakerConfig circuitBreakerConfig) {
circuitBreakerConfigsMap.put(DEFAULT_CONFIG, circuitBreakerConfig);
return this;
}

/**
* Configures a CircuitBreakerRegistry with a custom CircuitBreaker configuration.
*
* @param configName configName for a custom shared CircuitBreaker configuration
* @param configuration a custom shared CircuitBreaker configuration
* @return a {@link CircuitBreakerRegistry.Builder}
* @throws IllegalArgumentException if {@code configName.equals("default")}
*/
public Builder addCircuitBreakerConfig(String configName, CircuitBreakerConfig configuration) {
if (configName.equals(DEFAULT_CONFIG)) {
throw new IllegalArgumentException(
"You cannot add another configuration with name 'default' as it is preserved for default configuration");
}
circuitBreakerConfigsMap.put(configName, configuration);
return this;
}

/**
* Configures a CircuitBreakerRegistry with a CircuitBreaker registry event consumer.
*
* @param registryEventConsumer a CircuitBreaker registry event consumer.
* @return a {@link CircuitBreakerRegistry.Builder}
*/
public Builder addRegistryEventConsumer(RegistryEventConsumer<CircuitBreaker> registryEventConsumer) {
this.registryEventConsumers.add(registryEventConsumer);
return this;
}

/**
* Configures a CircuitBreakerRegistry with Tags.
* <p>
* Tags added to the registry will be added to every instance created by this registry.
*
* @param tags default tags to add to the registry.
* @return a {@link CircuitBreakerRegistry.Builder}
*/
public Builder withTags(io.vavr.collection.Map<String, String> tags) {
this.tags = tags;
return this;
}

/**
* Builds a CircuitBreakerRegistry
*
* @return the CircuitBreakerRegistry
*/
public CircuitBreakerRegistry build() {
return new InMemoryCircuitBreakerRegistry(circuitBreakerConfigsMap, registryEventConsumers, tags,
registryStore);
}
}

}
12 changes: 12 additions & 0 deletions ...n/java/io/github/resilience4j/circuitbreaker/internal/InMemoryCircuitBreakerRegistry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@
import io.github.resilience4j.circuitbreaker.CircuitBreakerConfig;
import io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry;
import io.github.resilience4j.core.ConfigurationNotFoundException;
import io.github.resilience4j.core.RegistryStore;
import io.github.resilience4j.core.registry.AbstractRegistry;
import io.github.resilience4j.core.registry.InMemoryRegistryStore;
import io.github.resilience4j.core.registry.RegistryEventConsumer;
import io.vavr.collection.Array;
import io.vavr.collection.HashMap;
Expand All @@ -31,6 +33,7 @@
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Supplier;

/**
Expand Down Expand Up @@ -76,6 +79,15 @@ public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs,
this.configurations.putAll(configs);
}

public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs,
List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers,
io.vavr.collection.Map<String, String> tags, RegistryStore<CircuitBreaker> registryStore) {
super(configs.getOrDefault(DEFAULT_CONFIG, CircuitBreakerConfig.ofDefaults()),
registryEventConsumers, Optional.ofNullable(tags).orElse(HashMap.empty()),
Optional.ofNullable(registryStore).orElse(new InMemoryRegistryStore<>()));
this.configurations.putAll(configs);
}

public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs,
List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers) {
this(configs.getOrDefault(DEFAULT_CONFIG, CircuitBreakerConfig.ofDefaults()),
Expand Down
125 changes: 124 additions & 1 deletion ...eaker/src/test/java/io/github/resilience4j/circuitbreaker/CircuitBreakerRegistryTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,17 @@
import io.github.resilience4j.core.registry.EntryAddedEvent;
import io.github.resilience4j.core.registry.EntryRemovedEvent;
import io.github.resilience4j.core.registry.EntryReplacedEvent;
import io.github.resilience4j.core.registry.InMemoryRegistryStore;
import io.github.resilience4j.core.registry.RegistryEventConsumer;
import io.vavr.Tuple;
import org.junit.Test;

import java.util.*;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;

import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.assertj.core.api.BDDAssertions.assertThat;
Expand Down Expand Up @@ -290,6 +296,123 @@ public void testCreateWithNullConfig() {
.isInstanceOf(NullPointerException.class).hasMessage("Config must not be null");
}

@Test
public void testCreateUsingBuilderWithDefaultConfig() {
CircuitBreakerRegistry circuitBreakerRegistry =
CircuitBreakerRegistry.custom().withCircuitBreakerConfig(CircuitBreakerConfig.ofDefaults()).build();
CircuitBreaker circuitBreaker = circuitBreakerRegistry.circuitBreaker("testName");
CircuitBreaker circuitBreaker2 = circuitBreakerRegistry.circuitBreaker("otherTestName");
assertThat(circuitBreaker).isNotSameAs(circuitBreaker2);

assertThat(circuitBreakerRegistry.getAllCircuitBreakers()).hasSize(2);
}

@Test
public void testCreateUsingBuilderWithCustomConfig() {
float failureRate = 30f;
CircuitBreakerConfig circuitBreakerConfig = CircuitBreakerConfig.custom()
.failureRateThreshold(failureRate).build();

CircuitBreakerRegistry circuitBreakerRegistry =
CircuitBreakerRegistry.custom().withCircuitBreakerConfig(circuitBreakerConfig).build();
CircuitBreaker circuitBreaker = circuitBreakerRegistry.circuitBreaker("testName");

assertThat(circuitBreaker.getCircuitBreakerConfig().getFailureRateThreshold())
.isEqualTo(failureRate);
}

@Test
public void testCreateUsingBuilderWithoutDefaultConfig() {
float failureRate = 30f;
CircuitBreakerConfig circuitBreakerConfig = CircuitBreakerConfig.custom()
.failureRateThreshold(failureRate).build();

CircuitBreakerRegistry circuitBreakerRegistry =
CircuitBreakerRegistry.custom().addCircuitBreakerConfig("someSharedConfig", circuitBreakerConfig).build();

assertThat(circuitBreakerRegistry.getDefaultConfig()).isNotNull();
assertThat(circuitBreakerRegistry.getDefaultConfig().getFailureRateThreshold())
.isEqualTo(50f);
assertThat(circuitBreakerRegistry.getConfiguration("someSharedConfig")).isNotEmpty();

CircuitBreaker circuitBreaker = circuitBreakerRegistry
.circuitBreaker("name", "someSharedConfig");

assertThat(circuitBreaker.getCircuitBreakerConfig()).isEqualTo(circuitBreakerConfig);
assertThat(circuitBreaker.getCircuitBreakerConfig().getFailureRateThreshold())
.isEqualTo(failureRate);
}

@Test(expected = IllegalArgumentException.class)
public void testAddMultipleDefaultConfigUsingBuilderShouldThrowException() {
CircuitBreakerConfig circuitBreakerConfig = CircuitBreakerConfig.custom()
.failureRateThreshold(30f).build();
CircuitBreakerRegistry.custom().addCircuitBreakerConfig("default", circuitBreakerConfig).build();
}

@Test
public void testCreateUsingBuilderWithDefaultAndCustomConfig() {
CircuitBreakerConfig circuitBreakerConfig = CircuitBreakerConfig.custom()
.failureRateThreshold(30f).build();
CircuitBreakerConfig customCircuitBreakerConfig = CircuitBreakerConfig.custom()
.failureRateThreshold(40f).build();

CircuitBreakerRegistry circuitBreakerRegistry = CircuitBreakerRegistry.custom()
.withCircuitBreakerConfig(circuitBreakerConfig)
.addCircuitBreakerConfig("custom", customCircuitBreakerConfig)
.build();

assertThat(circuitBreakerRegistry.getDefaultConfig()).isNotNull();
assertThat(circuitBreakerRegistry.getDefaultConfig().getFailureRateThreshold())
.isEqualTo(30f);
assertThat(circuitBreakerRegistry.getConfiguration("custom")).isNotEmpty();
}

@Test
public void testCreateUsingBuilderWithNullConfig() {
assertThatThrownBy(
() -> CircuitBreakerRegistry.custom().withCircuitBreakerConfig(null).build())
.isInstanceOf(NullPointerException.class).hasMessage("Config must not be null");
}

@Test
public void testCreateUsingBuilderWithMultipleRegistryEventConsumer() {
CircuitBreakerRegistry circuitBreakerRegistry = CircuitBreakerRegistry.custom()
.withCircuitBreakerConfig(CircuitBreakerConfig.ofDefaults())
.addRegistryEventConsumer(new NoOpCircuitBreakerEventConsumer())
.addRegistryEventConsumer(new NoOpCircuitBreakerEventConsumer())
.build();

getEventProcessor(circuitBreakerRegistry.getEventPublisher())
.ifPresent(eventProcessor -> assertThat(eventProcessor.hasConsumers()).isTrue());
}

@Test
public void testCreateUsingBuilderWithRegistryTags() {
io.vavr.collection.Map<String, String> circuitBreakerTags = io.vavr.collection.HashMap
.of("key1", "value1", "key2", "value2");
CircuitBreakerRegistry circuitBreakerRegistry = CircuitBreakerRegistry.custom()
.withCircuitBreakerConfig(CircuitBreakerConfig.ofDefaults())
.withTags(circuitBreakerTags)
.build();
CircuitBreaker circuitBreaker = circuitBreakerRegistry.circuitBreaker("testName");

assertThat(circuitBreaker.getTags()).containsOnlyElementsOf(circuitBreakerTags);
}

@Test
public void testCreateUsingBuilderWithRegistryStore() {
CircuitBreakerRegistry circuitBreakerRegistry = CircuitBreakerRegistry.custom()
.withCircuitBreakerConfig(CircuitBreakerConfig.ofDefaults())
.withRegistryStore(new InMemoryRegistryStore())
.build();
CircuitBreaker circuitBreaker = circuitBreakerRegistry.circuitBreaker("testName");
CircuitBreaker circuitBreaker2 = circuitBreakerRegistry.circuitBreaker("otherTestName");

assertThat(circuitBreaker).isNotSameAs(circuitBreaker2);
assertThat(circuitBreakerRegistry.getAllCircuitBreakers()).hasSize(2);
}

private static class NoOpCircuitBreakerEventConsumer implements
RegistryEventConsumer<CircuitBreaker> {

Expand Down
39 changes: 39 additions & 0 deletions ...va/io/github/resilience4j/circuitbreaker/internal/InMemoryCircuitBreakerRegistryTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,18 @@
import io.github.resilience4j.circuitbreaker.CircuitBreakerConfig;
import io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry;
import io.github.resilience4j.core.ConfigurationNotFoundException;
import io.github.resilience4j.core.registry.EntryAddedEvent;
import io.github.resilience4j.core.registry.EntryRemovedEvent;
import io.github.resilience4j.core.registry.EntryReplacedEvent;
import io.github.resilience4j.core.registry.InMemoryRegistryStore;
import io.github.resilience4j.core.registry.RegistryEventConsumer;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThatThrownBy;
Expand Down Expand Up @@ -98,4 +105,36 @@ public void testCreateCircuitBreakerWithConfigNameNotFound() {
"testConfig")).isInstanceOf(ConfigurationNotFoundException.class);
}

@Test
public void shouldCreateCircuitBreakerRegistryWithRegistryStore() {
RegistryEventConsumer<CircuitBreaker> registryEventConsumer = getNoOpsRegistryEventConsumer();
List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers = new ArrayList<>();
registryEventConsumers.add(registryEventConsumer);
Map<String, CircuitBreakerConfig> configs = new HashMap<>();
final CircuitBreakerConfig defaultConfig = CircuitBreakerConfig.ofDefaults();
configs.put("default", defaultConfig);
final InMemoryCircuitBreakerRegistry inMemoryCircuitBreakerRegistry =
new InMemoryCircuitBreakerRegistry(configs, registryEventConsumers,
io.vavr.collection.HashMap.of("Tag1", "Tag1Value"), new InMemoryRegistryStore());

assertThat(inMemoryCircuitBreakerRegistry).isNotNull();
assertThat(inMemoryCircuitBreakerRegistry.getDefaultConfig()).isEqualTo(defaultConfig);
assertThat(inMemoryCircuitBreakerRegistry.getConfiguration("testNotFound")).isEmpty();
inMemoryCircuitBreakerRegistry.addConfiguration("testConfig", defaultConfig);
assertThat(inMemoryCircuitBreakerRegistry.getConfiguration("testConfig")).isNotNull();
}

private RegistryEventConsumer<CircuitBreaker> getNoOpsRegistryEventConsumer() {
return new RegistryEventConsumer<CircuitBreaker>() {
@Override
public void onEntryAddedEvent(EntryAddedEvent<CircuitBreaker> entryAddedEvent) {
}
@Override
public void onEntryRemovedEvent(EntryRemovedEvent<CircuitBreaker> entryRemoveEvent) {
}
@Override
public void onEntryReplacedEvent(EntryReplacedEvent<CircuitBreaker> entryReplacedEvent) {
}
};
}
}
38 changes: 38 additions & 0 deletions resilience4j-core/src/main/java/io/github/resilience4j/core/RegistryStore.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/*
* Copyright 2020 KrnSaurabh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package io.github.resilience4j.core;

import java.util.Collection;
import java.util.Optional;
import java.util.function.Function;

public interface RegistryStore<E> {

E computeIfAbsent(String key,
Function<? super String, ? extends E> mappingFunction);

E putIfAbsent(String key, E value);

Optional<E> find(String key);

Optional<E> remove(String name);

Optional<E> replace(String name, E newEntry);

Collection<E> values();

}
Loading

0 comments on commit 6b30b2c

Please sign in to comment.