ChangeSpringPropertyKey not keeping YAML format

[der-eismann]

Hey everyone, we're currently evaluating the recipes for Spring Boot 4, however we're struggling with the properties a bit. Removing and adding them keeps the YAML format, but the ChangeSpringPropertyKey command adds them in *.properties format instead.

What version of OpenRewrite are you using?

I am using

• OpenRewrite Maven plugin v6.24.0
• Spring recipes v6.19.0

How are you running OpenRewrite?

Running mvn rewrite:runNoFork --errors -Drewrite.resolvePropertiesInYaml=false -Drewrite.activeRecipes=... -Drewrite.configLocation=... in a multi-module project.

There is no config in the pom.xml.

What is the smallest, simplest way to reproduce the problem?

With the following application.yaml:

server:
    port: 8934
    servlet:
        encoding:
            charset: UTF-8
            enabled: true
            force: true

spring:
    data:
        web:
            pageable:
                prefix: page.
                default-page-size: 50

and this recipe:

type: specs.openrewrite.org/v1beta/recipe
name: com.test.SB4Test
displayName: Use new uber pom with spring-boot 4.0
recipeList:
  - org.openrewrite.java.spring.boot4.UpgradeSpringBoot_4_0

What did you expect to see?

server:
    port: 8934

spring:
    data:
        web:
            pageable:
                prefix: page.
                default-page-size: 50
    servlet:
        encoding:
            charset: UTF-8
            enabled: true
            force: true

What did you see instead?

server:
    port: 8934

spring:
    data:
        web:
            pageable:
                prefix: page.
                default-page-size: 50
spring.servlet.encoding.charset: UTF-8
spring.servlet.encoding.enabled: true
spring.servlet.encoding.force: true

What is the full stack trace of any errors you encountered?

No error, just wrong formatting

Are you interested in contributing a fix to OpenRewrite?

[timtebeek]

Thanks for the report! That's a bit unexpected indeed; does it help if you run this recipe right after?
https://docs.openrewrite.org/recipes/yaml/unfoldproperties

If so we can look to make that part of ChangeSpringPropertyKey.

[der-eismann]

Hey Tim, thanks for the quick reply! Yes, the unfolding works perfectly 👌 I'll just add this to my composite recipe for now.

[der-eismann]

… or not? I tried it with an actual application and now I have:

spring:
    data:
        web:
            pageable:
                prefix: page.
                default-page-size: 50
    servlet:
        encoding:
            force: true

  spring:
      servlet:
          encoding:
              charset: UTF-8

  spring:
      servlet:
          encoding:
              enabled: true

So only the first line is correctly unfolded, for whatever reason. The others are incorrectly indented as well.

Pre-unfolded it looked like this:

management:
    endpoints:
        web:
            exposure:
                include: info, health, prometheus, mappings
    endpoint:
        health:
            show-details: always
            show-components: always
            probes:
                enabled: true

aws:
    bucket-name: abcdef

spring.servlet.encoding.charset: UTF-8

spring.servlet.encoding.enabled: true

spring.servlet.encoding.force: true

[timtebeek]

Hmm, that's unfortunate; thanks for sharing! Perhaps a draft pull request with some added tests starts to make sense.

[der-eismann]

I opened #853 to test it:

org.opentest4j.AssertionFailedError: [Unexpected result in "src/main/resources/file.yaml":
diff --git a/src/main/resources/file.yaml b/src/main/resources/file.yaml
index c4f3ac8..87d3246 100644
--- a/src/main/resources/file.yaml
+++ b/src/main/resources/file.yaml
@@ -1,11 +1,10 @@ 
+
 server:
   port: 1234
 
 spring:
   datasource:
     url: jdbc:postgresql://localhost/test
-  servlet:
-    encoding:
-      charset: UTF-8
-      enabled: true
-      force: true
\ No newline at end of file
+spring.servlet.encoding.charset: UTF-8
+spring.servlet.encoding.enabled: true
+spring.servlet.encoding.force: true
\ No newline at end of file
] 
expected: 
  "server:
    port: 1234
  
  spring:
    datasource:
      url: jdbc:postgresql://localhost/test
    servlet:
      encoding:
        charset: UTF-8
        enabled: true
        force: true"
 but was: 
  "
  server:
    port: 1234
  
  spring:
    datasource:
      url: jdbc:postgresql://localhost/test
  spring.servlet.encoding.charset: UTF-8
  spring.servlet.encoding.enabled: true
  spring.servlet.encoding.force: true"