spring-cloud / spring-cloud/spring-cloud-gateway
Document additional dependencies for hystrix
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.9k
- Forks
- 3.5k
- Avg merge
- 20h 57m
- Merged PRs (30d)
- 8
Description
The documentation for the HystrixGatewayFilterFactory doesn't mention that spring-cloud-starter-netflix-hystrix should be added to the project for it to work.
It might make sense to add this to
- the Hystrix GatewayFilter Factory documentation
- the project quick start documentation
- the
HystrixGatewayFilterFactoryjavadocs - the
GatewayFilterSpec::hystrixjavadocs
Ideally it would also be included in an error message if you attempt to use GatewayFilterSpec::hystrix (or yaml config) while missing the dependency.
In a simple java dsl application, you need to wade 77 lines into a stack trace to get to this:
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.cloud.gateway.filter.factory.HystrixGatewayFilterFactory' available
at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBean(DefaultListableBeanFactory.java:347)
at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBean(DefaultListableBeanFactory.java:334)
at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBean(DefaultListableBeanFactory.java:345)
at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBean(DefaultListableBeanFactory.java:334)
at org.springframework.context.support.AbstractApplicationContext.getBean(AbstractApplicationContext.java:1103)
at org.springframework.cloud.gateway.route.builder.UriSpec.getBean(UriSpec.java:42)
which still doesn't give you a clear indication of the root cause
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Hystrix GatewayFilter Factory and project quick start documentation, then inspect the HystrixGatewayFilterFactory and GatewayFilterSpec::hystrix javadocs. Reproduce the missing-dependency case described by the NoSuchBeanDefinitionException stack trace. Done means the required dependency is documented in the listed locations and the missing-dependency failure has clearer guidance if that behavior is pursued.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- backend, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100