Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #695 from fatroom/type_reference_resolving
Added resolving beans by type
- Loading branch information
Showing
7 changed files
with
248 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
...toconfigure/src/main/java/org/zalando/riptide/autoconfigure/DefaultRiptideConfigurer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| package org.zalando.riptide.autoconfigure; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import io.micrometer.core.instrument.MeterRegistry; | ||
| import io.opentracing.Tracer; | ||
| import io.opentracing.contrib.concurrent.TracedExecutorService; | ||
| import io.opentracing.contrib.concurrent.TracedScheduledExecutorService; | ||
| import lombok.AllArgsConstructor; | ||
| import org.springframework.beans.factory.NoSuchBeanDefinitionException; | ||
| import org.springframework.beans.factory.config.BeanDefinition; | ||
| import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; | ||
| import org.zalando.logbook.Logbook; | ||
| import org.zalando.riptide.failsafe.CircuitBreakerListener; | ||
| import org.zalando.riptide.failsafe.RetryListener; | ||
| import org.zalando.riptide.logbook.LogbookPlugin; | ||
| import org.zalando.riptide.micrometer.MicrometerPlugin; | ||
| import org.zalando.riptide.opentracing.OpenTracingPlugin; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| import static org.zalando.riptide.autoconfigure.ValueConstants.LOGBOOK_REF; | ||
| import static org.zalando.riptide.autoconfigure.ValueConstants.METER_REGISTRY_REF; | ||
| import static org.zalando.riptide.autoconfigure.ValueConstants.TRACER_REF; | ||
|
|
||
| @AllArgsConstructor | ||
| class DefaultRiptideConfigurer { | ||
| private final ConfigurableListableBeanFactory beanFactory; | ||
| private final RiptideProperties properties; | ||
|
|
||
| void register() { | ||
| properties.getClients().forEach(this::configure); | ||
| } | ||
|
|
||
| private void configure(final String id, final RiptideProperties.Client client) { | ||
| if (client.getTracing().getEnabled()) { | ||
| final BeanDefinition tracerRef = getBeanRef(Tracer.class, "tracer"); | ||
|
|
||
| findBeanDefinition(id, TracedExecutorService.class) | ||
| .ifPresent(bd -> replaceConstructorArgumentWithBean(bd, TRACER_REF, tracerRef)); | ||
|
|
||
| findBeanDefinition(id, OpenTracingPlugin.class) | ||
| .ifPresent(bd -> replaceConstructorArgumentWithBean(bd, TRACER_REF, tracerRef)); | ||
|
|
||
| findBeanDefinition(id, TracedScheduledExecutorService.class) | ||
| .ifPresent(bd -> replaceConstructorArgumentWithBean(bd, TRACER_REF, tracerRef)); | ||
| } | ||
|
|
||
| if (client.getLogging().getEnabled()) { | ||
| final BeanDefinition logbookRef = getBeanRef(Logbook.class, "logbook"); | ||
|
|
||
| findBeanDefinition(id, LogbookPlugin.class) | ||
| .ifPresent(bd -> replaceConstructorArgumentWithBean(bd, LOGBOOK_REF, logbookRef)); | ||
| } | ||
|
|
||
| if (client.getMetrics().getEnabled()) { | ||
| final BeanDefinition meterRegistryRef = getBeanRef(MeterRegistry.class, "meterRegistry"); | ||
|
|
||
| findBeanDefinition(id, MicrometerPlugin.class) | ||
| .ifPresent(bd -> replaceConstructorArgumentWithBean(bd, METER_REGISTRY_REF, meterRegistryRef)); | ||
|
|
||
| findBeanDefinition(id, RetryListener.class) | ||
| .ifPresent(bd -> replaceConstructorArgumentWithBean(bd, METER_REGISTRY_REF, meterRegistryRef)); | ||
|
|
||
| findBeanDefinition(id, CircuitBreakerListener.class) | ||
| .ifPresent(bd -> replaceConstructorArgumentWithBean(bd, METER_REGISTRY_REF, meterRegistryRef)); | ||
| } | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| BeanDefinition getBeanRef(Class type, String argName) { | ||
| Map<String, BeanDefinition> definitions = new HashMap<>(); | ||
| // search primary bean definition | ||
| for (String beanName : beanFactory.getBeanNamesForType(type)) { | ||
| BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName); | ||
| if (beanDefinition.isPrimary()) { | ||
| return beanDefinition; | ||
| } | ||
| definitions.put(beanName, beanDefinition); | ||
| } | ||
|
|
||
| // resolve by name | ||
| BeanDefinition beanDefinition = definitions.get(argName); | ||
| if (beanDefinition != null) { | ||
| return beanDefinition; | ||
| } | ||
|
|
||
| // if only one candidate present use it | ||
| if (definitions.size() == 1) { | ||
| return definitions.values().iterator().next(); | ||
| } | ||
|
|
||
| throw new NoSuchBeanDefinitionException(type); | ||
| } | ||
|
|
||
| private Optional<BeanDefinition> findBeanDefinition(final String id, final Class<?> type) { | ||
| try { | ||
| final Name name = Name.name(id, type); | ||
| return Optional.of(beanFactory.getBeanDefinition(name.toNormalizedString())); | ||
| } catch (NoSuchBeanDefinitionException e) { | ||
| return Optional.empty(); | ||
| } | ||
| } | ||
|
|
||
| private void replaceConstructorArgumentWithBean(final BeanDefinition bd, final String arg, | ||
| final BeanDefinition ref) { | ||
| bd.getConstructorArgumentValues() | ||
| .getIndexedArgumentValues() | ||
| .values().stream() | ||
| .filter(holder -> arg.equals(holder.getValue())) | ||
| .forEach(holder -> holder.setValue(ref)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
...ng-boot-autoconfigure/src/main/java/org/zalando/riptide/autoconfigure/ValueConstants.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| package org.zalando.riptide.autoconfigure; | ||
|
|
||
| import com.google.gag.annotation.remark.Hack; | ||
|
|
||
| /** | ||
| * Constants referring to beans that need to be looked up by types during Riptide clients constructions. | ||
| * <p>This is an artificial arrangement of 16 unicode characters, with its sole purpose | ||
| * being to never match user-declared values. | ||
| */ | ||
| @Hack("To allow search of the parameters that need to be replaced with Bean references") | ||
| class ValueConstants { | ||
| private ValueConstants() {} | ||
|
|
||
| static final String METER_REGISTRY_REF = "\n\t\t\n\t\t\n\uE000\uE001\uE001\n\t\t\t\t\n"; | ||
| static final String TRACER_REF = "\n\t\t\n\t\t\n\uE000\uE001\uE002\n\t\t\t\t\n"; | ||
| static final String LOGBOOK_REF = "\n\t\t\n\t\t\n\uE000\uE001\uE003\n\t\t\t\t\n"; | ||
| } |
96 changes: 96 additions & 0 deletions
96
...nfigure/src/test/java/org/zalando/riptide/autoconfigure/DefaultRiptideConfigurerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| package org.zalando.riptide.autoconfigure; | ||
|
|
||
| import io.opentracing.Tracer; | ||
| import io.opentracing.noop.NoopTracerFactory; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.springframework.beans.factory.NoSuchBeanDefinitionException; | ||
| import org.springframework.beans.factory.config.BeanDefinition; | ||
| import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; | ||
| import org.springframework.boot.test.context.TestConfiguration; | ||
| import org.springframework.context.annotation.AnnotationConfigApplicationContext; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.annotation.Primary; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
|
|
||
| final class DefaultRiptideConfigurerTest { | ||
| @TestConfiguration | ||
| static class PrimaryTracerConfiguration { | ||
| @Bean | ||
| @Primary | ||
| Tracer primaryTracer() { | ||
| return NoopTracerFactory.create(); | ||
| } | ||
|
|
||
| @Bean | ||
| Tracer secondaryTracer() { | ||
| return NoopTracerFactory.create(); | ||
| } | ||
| } | ||
|
|
||
| @TestConfiguration | ||
| static class SingleTracerConfiguration { | ||
| @Bean | ||
| Tracer opentracingTracer() { | ||
| return NoopTracerFactory.create(); | ||
| } | ||
| } | ||
|
|
||
| @TestConfiguration | ||
| static class DoubleTracerConfiguration { | ||
| @Bean | ||
| Tracer tracer() { | ||
| return NoopTracerFactory.create(); | ||
| } | ||
|
|
||
| @Bean | ||
| Tracer secondaryTracer() { | ||
| return NoopTracerFactory.create(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void shouldFindPrimaryBeanDefinitionIfAvailable() { | ||
| AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); | ||
| context.register(PrimaryTracerConfiguration.class); | ||
| context.refresh(); | ||
| ConfigurableListableBeanFactory beanFactory = context.getBeanFactory(); | ||
| DefaultRiptideConfigurer configurer = new DefaultRiptideConfigurer(beanFactory, null); | ||
| BeanDefinition bd = configurer.getBeanRef(Tracer.class, "tracer"); | ||
| assertThat(bd.isPrimary()).isTrue(); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldBeanDefinitionIfSingleBeanRegisteredForType() { | ||
| AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); | ||
| context.register(SingleTracerConfiguration.class); | ||
| context.refresh(); | ||
| ConfigurableListableBeanFactory beanFactory = context.getBeanFactory(); | ||
| DefaultRiptideConfigurer configurer = new DefaultRiptideConfigurer(beanFactory, null); | ||
| BeanDefinition bd = configurer.getBeanRef(Tracer.class, "tracer"); | ||
| assertThat(bd.getFactoryMethodName()).isEqualTo("opentracingTracer"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldFindBeanDefinitionByNameIfNoPrimaryBeanAvailable() { | ||
| AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); | ||
| context.register(DoubleTracerConfiguration.class); | ||
| context.refresh(); | ||
| ConfigurableListableBeanFactory beanFactory = context.getBeanFactory(); | ||
| DefaultRiptideConfigurer configurer = new DefaultRiptideConfigurer(beanFactory, null); | ||
| BeanDefinition bd = configurer.getBeanRef(Tracer.class, "tracer"); | ||
| assertThat(bd.getFactoryMethodName()).isEqualTo("tracer"); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldFailIfMultipleBeanFoundWithoutCorrespondingName() { | ||
| AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); | ||
| context.register(DoubleTracerConfiguration.class); | ||
| context.refresh(); | ||
| ConfigurableListableBeanFactory beanFactory = context.getBeanFactory(); | ||
| DefaultRiptideConfigurer configurer = new DefaultRiptideConfigurer(beanFactory, null); | ||
| assertThrows(NoSuchBeanDefinitionException.class, | ||
| () -> configurer.getBeanRef(Tracer.class, "opentracingTracer")); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters