Spring Boot 4 compatibility ?

[antoinelochet]

Hello,

I have a project which we are exploring the compatility with Spring Boot 4.
I encounter an issue with plugin, here is the stacktrace:

java.lang.ClassCastException: class org.springframework.http.ReadOnlyHttpHeaders cannot be cast to class java.util.Map (org.springframework.http.ReadOnlyHttpHeaders is in unnamed module of loader 'app'; java.util.Map is in module java.base of loader 'bootstrap') at com.epages.restdocs.apispec.BasicSecurityHandler.isBasicSecurity(SecurityRequirementsHandler.kt:31) at com.epages.restdocs.apispec.BasicSecurityHandler.extractSecurityRequirements(SecurityRequirementsHandler.kt:25) at com.epages.restdocs.apispec.SecurityRequirementsHandler.extractSecurityRequirements(SecurityRequirementsHandler.kt:14) at com.epages.restdocs.apispec.ResourceSnippet.createModel(ResourceSnippet.kt:52) at com.epages.restdocs.apispec.ResourceSnippet.document(ResourceSnippet.kt:34) at org.springframework.restdocs.generate.RestDocumentationGenerator.handle(RestDocumentationGenerator.java:191) at org.springframework.restdocs.mockmvc.RestDocumentationResultHandler.handle(RestDocumentationResultHandler.java:52) at org.springframework.test.web.servlet.MockMvc$1.andDo(MockMvc.java:217)

Do you want a contribution ?

[wodrobina]

Hello,

Thank you for reaching out. We’d really appreciate your contribution to the project and your help in making it compatible with Spring Boot 4. It would be great to collaborate with you on this.

[antoinelochet]

I will do my best then :)
Do you mind if I update Gradle and all the necessary plugins while I am on the subject ?

[wodrobina]

Unless it’s strictly necessary, I would recommend handling this in a separate pull request. It will also make it easier for me to review and test the code.

[antoinelochet]

Spring Boot 4 Gradle plugin requires at least Gradle 8.14.X: https://docs.spring.io/spring-boot/4.0/gradle-plugin/index.html
I will update the absolute necessary for this to work and leave the rest as is.
But I think that this will be the most of the dependencies.
Would you maybe prefer a PR for upgrading to Gradle 8.14.x first ?

[MarcelKonrad]

I recently updated our fork of restdocs-api-spec to Gradle 8.14.3, which may help you with the PR (you can cherry-pick them if you want). You can find the change list here, containing only absolutely necessary changes. It also includes an update to Java 21 and spring boot 3.2, which will break Postman URI templating, so you might want to skip those commits. I'm also not 100% sure on the JaCoCo changes, so please double-check. I can also create a PR if necessary.

[antoinelochet]

I recently updated our fork of restdocs-api-spec to Gradle 8.14.3, which may help you with the PR (you can cherry-pick them if you want). You can find the change list here, containing only absolutely necessary changes. It also includes an update to Java 21 and spring boot 3.2, which will break Postman URI templating, so you might want to skip those commits. I'm also not 100% sure on the JaCoCo changes, so please double-check. I can also create a PR if necessary.

Hello !
I have cherry-picked all of your commits as of today.
I had some issues with the tests and some compilation problems when I was doing a clean Gradle build.
I don't know if something was wrong on my side but anyway, you can check the resulting commit here: 666dec3

[antoinelochet]

You can also check my dev branch which is at Spring Boot 3.5.7 update: https://github.com/antoinelochet/restdocs-api-spec/commits/feature/sb4/

[MarcelKonrad]

I have cherry-picked all of your commits as of today.

Please don't cherry-pick every commit from our fork. It contains additional features and fixes, which are separate from the dependency updates. We eventually also want to merge those upstream, if possible. For the moment, I recommend limiting commits to the change list mentioned above.

[MarcelKonrad]

I created a new branch on my GitHub fork of the project, which builds and tests successfully on Gradle 8.14.3 and Spring Boot 3.2. It only contains the absolutely necessary changes. You can use that one as a base. Should I create a PR for it?

[antoinelochet]

I have cherry-picked all of your commits as of today.

Please don't cherry-pick every commit from our fork. It contains additional features and fixes, which are separate from the dependency updates. We eventually also want to merge those upstream, if possible. For the moment, I recommend limiting commits to the change list mentioned above.

Wow, thank you !
I have rebased my work on your branch.

[antoinelochet]

A lot of third-party libs depend on Jackson 2.
With Spring Boot 4 being based on Jackson 3, JSON schema and Swagger 1.X are not easily replaceable.
JSON schema seems to be a dead project and maybe (maybe) Swagger 1.X will be updated but I would not count on it.
What would be the prefered approach for these issues ?

[antoinelochet]

A lot of third-party libs depend on Jackson 2. With Spring Boot 4 being based on Jackson 3, JSON schema and Swagger 1.X are not easily replaceable. JSON schema seems to be a dead project and maybe (maybe) Swagger 1.X will be updated but I would not count on it. What would be the prefered approach for these issues ?

I have found that for the moment, using Spring Boot 4 Jackson 2 compatibility module does the trick.
All the libs are updated, compilation issues sorted and tests fixed.
You can check the dev branch here: https://github.com/antoinelochet/restdocs-api-spec/tree/feature/sb4