spring-cloud / spring-cloud/spring-cloud-consul

Update misleading config watch documentation.

Open
#617 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Java
Stars
822
Forks
539
Avg merge
9h 31m
Merged PRs (30d)
7

Description

@ConstructorBinding annotated classes not refreshing
I am using Spring Cloud version Hoxton with Spring Boot 2.2.x

Spring Boot 2.2.x introduced a an annotation @ConstructorBinding that allows defining @ConfigurationProperties classes strictly through constructors, which allows using immutable classes in configurations.

While the initial configuration is being loaded from my Consul K/V server, subsequent changes to the server do not get reflected in the configuration objects. The problem is not mitigated by using @RefreshScope.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Spring Cloud Consul configuration-watch documentation and compare its claims with the reported Hoxton and Spring Boot 2.2.x behavior. Review the roles of @ConstructorBinding, @ConfigurationProperties, @RefreshScope, and Consul K/V updates. Done means the documentation accurately explains whether these configuration objects refresh and states any relevant limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring, spring-boot
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.