Spring Boot Cloud Config #1230

lony2003 · 2025-03-04T02:32:03Z

Description

A new library that implement a backend of Spring Cloud Config.

Originally from https://github.com/fangkehou-team/dapr-spring, this library created a backend of SpringCloudConfig just like SpringCloudVault.
The original library only uses secret store as config store api is not stable at that time.
As the configuration api is stable now, the config loader using that api has been implemented, but subscription of configuration has not implemented, just for reservation.

Issue reference

this PR will close: #1225

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

Code compiles correctly
Created/updated tests
Extended the documentation

salaboy · 2025-03-04T08:52:00Z

@lony2003 first of all, thanks so so much for contributing back with this. This is highly appreciated.. I will start adding comments in the PR with small details that we need to fix and questions about how this would work.

It will be great if you can add as part of this PR an example on the spring-boot-examples/ directory showing how this functionality would work. We probably also need tests inside sdk-tests to demonstrate that this works from a client point of view. You will notice that we are heavily relying on Testcontainers for all of this, so it will be quite cool to see if the testcontainers integration is missing something to support this functionality.

...ain/java/io/dapr/spring/boot/cloudconfig/autoconfigure/DaprCloudConfigAutoConfiguration.java

salaboy · 2025-03-04T08:53:46Z

.../java/io/dapr/spring/boot/cloudconfig/config/CloudConfigPropertiesDaprConnectionDetails.java

+import io.dapr.spring.boot.autoconfigure.client.DaprClientProperties;
+import io.dapr.spring.boot.autoconfigure.client.DaprConnectionDetails;
+
+class CloudConfigPropertiesDaprConnectionDetails implements DaprConnectionDetails {


@lony2003 do we need to duplicate the DaprConnectionDetails, why are these different for the normal DaprConnectionDetails?

No difference, just because the PropertyDaprConnectionDetails is protected and can't be used in another package.

@artur-ciocanu should we change the PropertyDaprConnectionDetails visibility so it can be reused?

...onfig/src/main/java/io/dapr/spring/boot/cloudconfig/config/DaprCloudConfigClientManager.java

...udconfig/src/main/java/io/dapr/spring/boot/cloudconfig/config/DaprCloudConfigProperties.java

lony2003 · 2025-03-04T09:40:58Z

@lony2003 first of all, thanks so so much for contributing back with this. This is highly appreciated.. I will start adding comments in the PR with small details that we need to fix and questions about how this would work.

It will be great if you can add as part of this PR an example on the spring-boot-examples/ directory showing how this functionality would work. We probably also need tests inside sdk-tests to demonstrate that this works from a client point of view. You will notice that we are heavily relying on Testcontainers for all of this, so it will be quite cool to see if the testcontainers integration is missing something to support this functionality.

Thanks. the code is not completed currently, I created this pull request is for the problems in issue #1225 , I think we need a schema for cloud config url, and have some other things to be discussed😊😊😊

lony2003 · 2025-03-05T05:09:38Z

Cloud Config Import Schemas

Secret Store Component

url structure

dapr:secret:<store-name>[/<secret-name>][?<paramters>]

paramters

parameter	description	default	available
type	value type	`value`	`value`/`doc`
doc-type	type of doc	`properties`	`yaml`/`properties`/`or any file extensions you want`

when type = value, if secret-name is specified, will treat secret as the value of property, and secret-name as the key of property; if none secret-name is specified, will get bulk secret and treat every value of secret as the value of property, and every key of secret as the key of property.
when type = doc, if secret-name is specified, will treat secret as a bunch of property, and load it with property or yaml loader; if none secret-name is specified, will get bulk secret and and treat every value of secret as bunches of property, and load them with property or yaml loader.
secret store with multiValud = true must specify nestedSeparator = ".", and using type = doc is not recommanded

demo

multiValued = false:

store content(file secret store as example)

{
	"dapr.spring.demo-config-secret.singlevalue": "testvalue",
	"multivalue-properties": "dapr.spring.demo-config-secret.multivalue.v1=spring\ndapr.spring.demo-config-secret.multivalue.v2=dapr",
	"multivalue-yaml": "dapr:\n  spring:\n    demo-config-secret:\n      multivalue:\n        v3: cloud"
}

valid demo url

dapr:secret:democonfig/multivalue-properties?type=doc&doc-type=properties
dapr:secret:democonfig/multivalue-yaml?type=doc&doc-type=yaml
dapr:secret:democonfig/dapr.spring.demo-config.singlevalue?type=value
dapr:secret:democonfig?type=value
dapr:secret:democonfig?type=doc

multiValued = true, nestedSeparator = ".":

store content(file secret store as example)

{
	"value1": {
		"dapr": {
			"spring": {
				"demo-config-secret": {
					"multivalue": {
						"v4": "config"
					}
				}
			}
		}
	}
}

will be read as

{
	"value1": {
		"dapr.spring.demo-config-secret.multivalue.v4": "config"
	}
}

valid demo url

dapr:secret:demo-config-multi/value1?type=value
dapr:secret:demo-config-multi?type=value

Configuration Component

url structure

dapr:config:<store-name>[/<key>][?<paramters>]

paramters

parameter	description	default	available
type	value type	`value`	`doc`/`value`
doc-type	type of doc	`properties`	`yaml`/`properties`/`or any file extensions you want`
subscribe	subscribe this configuration	`false`	`true`/`false`

when subscribe = true, will subscribe update for the configuration.
when type = value, if key is specified, will treat config value as the value of property, and key as the key of property; if none key is specified, will get all key and value in the config-name and treat every config value as the value of property, and every key as the key of property.
when type = doc, if key is specified, will treat config value as a bunch of property, and load it with property or yaml loader; if none key is specified, will get all key and value in the config-name and treat every config value as bunches of property, and load them with property or yaml loader.

Demo

store content(table as example)

key	value
dapr.spring.demo-config-config.singlevalue	testvalue
multivalue-properties	`dapr.spring.demo-config-config.multivalue.v1=spring\ndapr.spring.demo-config-config.multivalue.v2=dapr`
multivalue-yaml	`dapr:\n spring:\n demo-config-config:\n multivalue:\n v3: cloud`

valid demo url

dapr:config:democonfigconf/dapr.spring.demo-config-config.singlevalue?type=value
dapr:config:democonfigconf/multivalue-properties?type=doc&doc-type=properties
dapr:config:democonfigconf/multivalue-yaml?type=doc&doc-type=yaml
dapr:config:democonfigconf?type=doc
dapr:config:democonfigconf?type=value

lony2003 · 2025-03-09T09:39:55Z

All jobs have done, waiting for review. Note that subscription of configuration api is not implemented, just as a reservation.

dapr-spring/dapr-spring-cloudconfig/pom.xml

...ng-cloudconfig/src/test/java/io/dapr/spring/boot/cloudconfig/CloudConfigTestApplication.java

dapr-spring/dapr-spring-cloudconfig/src/test/resources/application.yaml

daprdocs/content/en/java-sdk-docs/spring-boot/_index.md

codecov · 2025-03-27T05:07:56Z

Codecov Report

Attention: Patch coverage is 66.04278% with 127 lines in your changes missing coverage. Please review.

Project coverage is 74.89%. Comparing base (d759c53) to head (6a376b1).
Report is 118 commits behind head on master.

Files with missing lines	Patch %	Lines
...igdata/secret/DaprSecretStoreConfigDataLoader.java	44.44%	30 Missing and 5 partials ⚠️
...g/DaprConfigurationConfigDataLocationResolver.java	70.68%	10 Missing and 7 partials ⚠️
...data/config/DaprConfigurationConfigDataLoader.java	68.08%	10 Missing and 5 partials ⚠️
...oudconfig/config/DaprCloudConfigClientManager.java	48.00%	7 Missing and 6 partials ⚠️
...ret/DaprSecretStoreConfigDataLocationResolver.java	78.57%	7 Missing and 5 partials ⚠️
...onfig/configdata/DaprCloudConfigParserHandler.java	85.00%	3 Missing and 3 partials ⚠️
...ta/config/DaprConfigurationConfigDataResource.java	60.00%	6 Missing ⚠️
...data/secret/DaprSecretStoreConfigDataResource.java	57.14%	6 Missing ⚠️
...ot/examples/cloudconfig/config/MultipleConfig.java	40.00%	6 Missing ⚠️
.../cloudconfig/config/DaprCloudConfigProperties.java	76.47%	4 Missing ⚠️
... and 3 more

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #1230      +/-   ##
============================================
- Coverage     76.91%   74.89%   -2.03%     
- Complexity     1592     1694     +102     
============================================
  Files           145      208      +63     
  Lines          4843     5449     +606     
  Branches        562      590      +28     
============================================
+ Hits           3725     4081     +356     
- Misses          821     1024     +203     
- Partials        297      344      +47

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

lony2003 · 2025-03-27T05:27:46Z

I have checked the error, and it seems that jacoco coverage throws the error. I have add a test of bulk secret to coverage more situation in DaprSecretStoreConfigDataLoader.java listed in the first line of codeconv report. Not sure if it's the cause of jacoco coverage failed, but I can't add more coverage as it's a little difficult to test error situation in bootstrap stage (springboot application will crash and test will be failed)

salaboy · 2025-03-29T08:56:19Z

@lony2003 if you don't feel comfortable with that.. I can spend some time after KubeCon (the whole next week) to see if I can get it working on your branch

lony2003 · 2025-03-29T09:23:03Z

@salaboy I'll try to enhence that part. But may be I need your help as I really don't familiar with that😂😂😂.

I am from China, so sometimes I might use some inappropriate words when communicating in English. I hope you don't mind😃😃😃.

salaboy · 2025-03-29T09:38:13Z

@lony2003 your english is more than fine! thanks so much for all the work, if you have questions don't hesitate to ask. Are you on discord right?

lony2003 · 2025-03-29T09:42:12Z

Are you on discord right?

@salaboy yeah, I'll communicate with you on discord if I meet troubles. Thanks!

lony2003 · 2025-03-29T16:33:48Z

@salaboy I have checked the dapr documentation and find that Kubernetes ConfigMap is not supported in dapr runtime, only Kubernetes Secret supported in dapr secret.

I have write a simple documentation of how to deploy on Kubernetes. Further test and review may needed.

lony2003 · 2025-03-30T15:25:37Z

@salaboy I have tried the Kubernetes usage and everything needed is documented, it works for me.

…dcoded prefix(dapr#1225) create a public static final value PROPERTY_PREFIX in DaprClientProperties change the prefix value in the ConfigurationProperties to DaprClientProperties.PROPERTY_PREFIX Dapr Cloud Config rely on that. Signed-off-by: lony2003 <[email protected]>

…of Spring Cloud Config(dapr#1225) Originally from https://github.com/fangkehou-team/dapr-spring, this library created a backend of SpringCloudConfig just like SpringCloudVault. The original library only uses secret store as config store api is not stable at that time. As the configuration api is stable now, the config loader using that api would be implemented later. Signed-off-by: lony2003 <[email protected]>

Signed-off-by: lony2003 <[email protected]>

…porter Implemented the configuration importer using dapr client configuration api also done a style check Signed-off-by: lony2003 <[email protected]>

Signed-off-by: lony2003 <[email protected]>

Springboot‘s PropertySourceLoader will return a invalid source if it doesn't support that instead of throw errors. So we have to clear that what kind of loader we want to use, that is , that kind of resource it is. Signed-off-by: lony2003 <[email protected]>

Enum of Config Type has lack of file extension suport, reimplement it as class Signed-off-by: lony2003 <[email protected]>

… and config store Signed-off-by: lony2003 <[email protected]>

…fig store (try1) Signed-off-by: lony2003 <[email protected]>

…cloudconfig Signed-off-by: lony2003 <[email protected]>

Signed-off-by: lony2003 <[email protected]>

add a test of Dapr Secret getBulkSecret method Signed-off-by: lony2003 <[email protected]>

Signed-off-by: lony2003 <[email protected]>

Fix the example doc to make cloud config demo works both local and kubernetes, and pass the mm doc validate Signed-off-by: lony2003 <[email protected]>

(cherry picked from commit 31a47f5) Signed-off-by: lony2003 <[email protected]>

Fix the example doc to make cloud config demo works both local and kubernetes Signed-off-by: lony2003 <[email protected]>

Signed-off-by: lony2003 <[email protected]>

lony2003 requested review from a team as code owners March 4, 2025 02:32

lony2003 force-pushed the development-cloudconfig branch 3 times, most recently from 25b3e33 to 2b4022b Compare March 4, 2025 03:14

salaboy reviewed Mar 4, 2025

View reviewed changes

...ain/java/io/dapr/spring/boot/cloudconfig/autoconfigure/DaprCloudConfigAutoConfiguration.java Outdated Show resolved Hide resolved

salaboy reviewed Mar 4, 2025

View reviewed changes

...onfig/src/main/java/io/dapr/spring/boot/cloudconfig/config/DaprCloudConfigClientManager.java Outdated Show resolved Hide resolved

salaboy reviewed Mar 4, 2025

View reviewed changes

...udconfig/src/main/java/io/dapr/spring/boot/cloudconfig/config/DaprCloudConfigProperties.java Show resolved Hide resolved

cicoyle assigned lony2003 Mar 6, 2025

cicoyle added this to the v1.15 milestone Mar 6, 2025

lony2003 force-pushed the development-cloudconfig branch 7 times, most recently from 383a076 to 034baad Compare March 8, 2025 16:57

lony2003 changed the title ~~[WIP] Spring Boot Cloud Config~~ [All jobs done] Spring Boot Cloud Config Mar 9, 2025

salaboy reviewed Mar 10, 2025

View reviewed changes

dapr-spring/dapr-spring-cloudconfig/pom.xml Outdated Show resolved Hide resolved

salaboy reviewed Mar 10, 2025

View reviewed changes

...ng-cloudconfig/src/test/java/io/dapr/spring/boot/cloudconfig/CloudConfigTestApplication.java Show resolved Hide resolved

salaboy reviewed Mar 10, 2025

View reviewed changes

dapr-spring/dapr-spring-cloudconfig/src/test/resources/application.yaml Outdated Show resolved Hide resolved

salaboy reviewed Mar 10, 2025

View reviewed changes

daprdocs/content/en/java-sdk-docs/spring-boot/_index.md Outdated Show resolved Hide resolved

lony2003 requested a review from salaboy March 28, 2025 10:43

lony2003 changed the title ~~[All jobs done] Spring Boot Cloud Config~~ Spring Boot Cloud Config Apr 2, 2025

lony2003 and others added 22 commits April 3, 2025 17:58

style(springboot cloudconfig): update file header

3b55b4c

Signed-off-by: lony2003 <[email protected]>

style(springboot cloudconfig): change code style to match checkstyle

c318d8b

Signed-off-by: lony2003 <[email protected]>

feat(springboot cloudconfig): Implement Configuration Cloud Config Im…

3fb8cab

…porter Implemented the configuration importer using dapr client configuration api also done a style check Signed-off-by: lony2003 <[email protected]>

fix(springboot cloudconfig): Update version of dapr-spring-parent

6724b46

Signed-off-by: lony2003 <[email protected]>

feat(springboot cloudconfig): test cases for cloud config

49c1ab6

Signed-off-by: lony2003 <[email protected]>

feat(springboot cloudconfig): Change the behavior of Config Type

3359473

Enum of Config Type has lack of file extension suport, reimplement it as class Signed-off-by: lony2003 <[email protected]>

test(springboot cloudconfig): Implemented integration test for secret…

b7e660e

… and config store Signed-off-by: lony2003 <[email protected]>

test(springboot cloudconfig): fix integration test for secret and con…

653bb12

…fig store (try1) Signed-off-by: lony2003 <[email protected]>

docs(springboot cloudconfig): Write examples and docs for springboot …

1169c54

…cloudconfig Signed-off-by: lony2003 <[email protected]>

style(springboot cloudconfig): Clean comments

f5fab34

Signed-off-by: lony2003 <[email protected]>

docs(springboot cloudconfig): Fix typo of import

852d459

Signed-off-by: lony2003 <[email protected]>

test(springboot cloudconfig): Fix test coverage

29fa755

add a test of Dapr Secret getBulkSecret method Signed-off-by: lony2003 <[email protected]>

docs(cloud-config-demo): enhence Kubernetes cluster usages

74e36d4

Signed-off-by: lony2003 <[email protected]>

docs(cloud-config-demo): enhence Kubernetes cluster usages

716ecb7

Signed-off-by: lony2003 <[email protected]>

docs(cloud-config-demo): enhence Kubernetes cluster usages

ffc43d3

Signed-off-by: lony2003 <[email protected]>

docs(springboot cloudconfig): A fix of example docs.

186b1bb

Fix the example doc to make cloud config demo works both local and kubernetes, and pass the mm doc validate Signed-off-by: lony2003 <[email protected]>

Update springboot to latest minor.patch version. (dapr#826)

15fefb1

(cherry picked from commit 31a47f5) Signed-off-by: lony2003 <[email protected]>

docs(springboot cloudconfig): A fix of example docs.

a31ce67

Fix the example doc to make cloud config demo works both local and kubernetes Signed-off-by: lony2003 <[email protected]>

docs(springboot cloudconfig): A fix of example docs.

70d4eea

Signed-off-by: lony2003 <[email protected]>

lony2003 force-pushed the development-cloudconfig branch from 2bed2a2 to 70d4eea Compare April 3, 2025 10:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spring Boot Cloud Config #1230

Spring Boot Cloud Config #1230

lony2003 commented Mar 4, 2025 •

edited

Loading

salaboy commented Mar 4, 2025

salaboy Mar 4, 2025

lony2003 Mar 4, 2025

salaboy Mar 10, 2025

lony2003 commented Mar 4, 2025

lony2003 commented Mar 5, 2025 •

edited

Loading

lony2003 commented Mar 9, 2025

codecov bot commented Mar 27, 2025

lony2003 commented Mar 27, 2025 •

edited

Loading

salaboy commented Mar 29, 2025

lony2003 commented Mar 29, 2025

salaboy commented Mar 29, 2025

lony2003 commented Mar 29, 2025

lony2003 commented Mar 29, 2025

lony2003 commented Mar 30, 2025

Spring Boot Cloud Config #1230

Are you sure you want to change the base?

Spring Boot Cloud Config #1230

Conversation

lony2003 commented Mar 4, 2025 • edited Loading

Description

Issue reference

Checklist

salaboy commented Mar 4, 2025

salaboy Mar 4, 2025

Choose a reason for hiding this comment

lony2003 Mar 4, 2025

Choose a reason for hiding this comment

salaboy Mar 10, 2025

Choose a reason for hiding this comment

lony2003 commented Mar 4, 2025

lony2003 commented Mar 5, 2025 • edited Loading

Cloud Config Import Schemas

Secret Store Component

url structure

paramters

demo

multiValued = false:

store content(file secret store as example)

valid demo url

multiValued = true, nestedSeparator = ".":

store content(file secret store as example)

valid demo url

Configuration Component

url structure

paramters

Demo

store content(table as example)

valid demo url

lony2003 commented Mar 9, 2025

codecov bot commented Mar 27, 2025

Codecov Report

lony2003 commented Mar 27, 2025 • edited Loading

salaboy commented Mar 29, 2025

lony2003 commented Mar 29, 2025

salaboy commented Mar 29, 2025

lony2003 commented Mar 29, 2025

lony2003 commented Mar 29, 2025

lony2003 commented Mar 30, 2025

lony2003 commented Mar 4, 2025 •

edited

Loading

lony2003 commented Mar 5, 2025 •

edited

Loading

lony2003 commented Mar 27, 2025 •

edited

Loading