Fixes for Spring Boot 3.5.0 API #3007

mschout · 2025-05-23T18:35:11Z

Spring Boot renamed the property methods to determine if HAL is enabled or not. Use reflection to determine which method to call so we can support both versions

Another alternative would have been to merely bump the minimum supported version of spring boot to 3.5.0 and just use the new methods directly. Not sure what is preferred here. This does get it to start under 3.5 and 3.4 however.

Fixes #3005

Spring Boot renamed the property methods to determine if HAL is enabled or not. Use reflection to determine which method to call so we can support both versions Fixes springdoc#3005

mschout · 2025-05-23T20:05:13Z

sorry for confusion. current version of the MR works for me under both 3.4.5 and 3.5.0. This should be good to go now.

silviuburceadev · 2025-05-27T07:35:20Z

Is there anything needed to have this PR merged?

bnasslahsen · 2025-05-27T11:31:45Z

@mschout Thank you for your contribution.
This will be hopefully merged, by the end of this week.

rcbandit111 · 2025-06-01T22:06:09Z

I'm facing this issue when I tested the latest Spring Cloud version 2025.0.0. When I can expect official release with this fix?

StefanSchrass · 2025-06-02T07:04:52Z

...oc-openapi-starter-common/src/main/java/org/springdoc/core/providers/HateoasHalProvider.java

+			}
+		}
+
+		throw new IllegalStateException("No suitable method found to determine if HAL is enabled");


Initial implementation defaults to true if no HateoasProperties are present. Could this also be applicable here?

This is already the case. Have a look at line 86 (formerly line 83).

In my opinion, the exceptional behavior covered in isHalEnabled serves a separate use case. Here, the HateoasProperties are already known to exist, but for some unexpected reason they do neither respond to isUseHalAsDefaultJsonMediaType or getUseHalAsDefaultJsonMediaType. As this should never be the case unless something out of the ordinary is happening, simply returning true would just hide an error that would definitely need awareness.

No its not. Line 82 did map, this line throws--effectively bypassing the default.

I totally get the difference here, but my point is that it is actually harmful because even if you dont use HAL at all your application wont start (and thats why I am here)

The throw on line 105 should only happen if HateoasProperties exists (IE the Optional is non-empty), but we couldn't figure out the appropriate method name to call on it. We try the new method name in SB 3.5.0 first, and if we don't find that, we try the one from SB 3.4.x and ealier. @StefanSchrass do you have a small demo that does not start with the patch?

No I haven't a demo. I am just in fearful expectation of experiencing this again. Bear in mind, for 10 days one is unable to use Spring-Boot 3.5.x with your product. To me this means "no security fixes to production the easy way" for 10 days. That is not really acceptable.
And here we are, preparing the same kind of fun again.

Please be aware of that Spring doesn't view the properties (the getters) as part of their API, so they will absolutely change them if they feel like it. This would mean no deplyoments for as long as it takes for you to add another reflection-action-method here.

God speed!

3.4.x is still actively maintained FYI.

StefanSchrass · 2025-06-02T07:04:55Z

...oc-openapi-starter-common/src/main/java/org/springdoc/core/providers/HateoasHalProvider.java

+					return (boolean) result;
+				}
+
+				throw new IllegalStateException("Method " + methodName + " did not return a boolean value");


Initial implementation defaults to true if no HateoasProperties are present. Could this also be applicable here?

.orElse(true) will still be called if the Optional<HateoasProperties> hateoasPropertiesOptional is empty

totally, but its sheer existence doesn't mean that it is important to the application.

Sorry, I'm not following. If HATEOAS isn't available, the .map() call is a no-op here. This project needs to be compatible with upstream one way or another. If this project doesn't know how to figure out if HAL is active or not, then the only options here (as suggested by upstream) is to either use Reflection (as this PR does), or, to bump the min required version of SB to 3.5.0 and call the new method directly, at the expense of breaking compatibility with older versions of Spring Boot). If upstream changes the property methods yet again, silently returning true if this project couldn't figure out how to determine if HAL is active or not is worse than bailing out IMO. But I'm not part of the springdoc team, so this is not my call.

FWIW, this is far from the only problem blocking me from personally migrating to 3.5.0 at this point. There was a rather serious regression in, for example, spring-data-jpa. Unless more people test -RC releases or milestone releases of upstream, the .0 release is really the first real shake out of problems and thats what we're seeing here.

Sineaggi · 2025-06-02T21:46:59Z

...oc-openapi-starter-common/src/main/java/org/springdoc/core/providers/HateoasHalProvider.java

+				if (result instanceof Boolean) {
+					return (boolean) result;


Should be possible to avoid the type-casting here as the project depends on java 17

Suggested change

if (result instanceof Boolean) {

return (boolean) result;

if (result instanceof Boolean halEnabled) {

return halEnabled;

kdebski85 · 2025-06-03T10:40:33Z

...oc-openapi-starter-common/src/main/java/org/springdoc/core/providers/HateoasHalProvider.java

 				.orElse(true);
 	}

+	private boolean isHalEnabled(@NonNull HateoasProperties hateoasProperties) {


This method can be static.

I pushed this thanks.

...oc-openapi-starter-common/src/main/java/org/springdoc/core/providers/HateoasHalProvider.java

…ore/providers/HateoasHalProvider.java Co-authored-by: Krzysztof Dębski <kdebski85@users.noreply.github.com>

Fixes for Spring Boot 3.5.0 API

bf52312

Spring Boot renamed the property methods to determine if HAL is enabled or not. Use reflection to determine which method to call so we can support both versions Fixes springdoc#3005

mschout force-pushed the spring-boot-3.5-support branch from 15723c9 to bf52312 Compare May 23, 2025 20:04

NelsonLau88 approved these changes May 27, 2025

View reviewed changes

StefanSchrass reviewed Jun 2, 2025

View reviewed changes

Sineaggi reviewed Jun 2, 2025

View reviewed changes

kdebski85 reviewed Jun 3, 2025

View reviewed changes

mschout added 2 commits June 3, 2025 08:39

Make isHalEnabled static

3a403a5

Avoid type cast

fc5ef23

kdebski85 reviewed Jun 3, 2025

View reviewed changes

...oc-openapi-starter-common/src/main/java/org/springdoc/core/providers/HateoasHalProvider.java Outdated Show resolved Hide resolved

mschout and others added 2 commits June 3, 2025 11:26

Update springdoc-openapi-starter-common/src/main/java/org/springdoc/c…

ccf2d2d

…ore/providers/HateoasHalProvider.java Co-authored-by: Krzysztof Dębski <kdebski85@users.noreply.github.com>

Fix formatting

392aec6

silviuburceadev approved these changes Jun 4, 2025

View reviewed changes

kdebski85 approved these changes Jun 4, 2025

View reviewed changes

sebobr approved these changes Jun 5, 2025

View reviewed changes

kimberninger approved these changes Jun 5, 2025

View reviewed changes

Uh oh!

Fixes for Spring Boot 3.5.0 API #3007

Are you sure you want to change the base?

Fixes for Spring Boot 3.5.0 API #3007

Conversation

mschout commented May 23, 2025

Uh oh!

mschout commented May 23, 2025

Uh oh!

silviuburceadev commented May 27, 2025

Uh oh!

bnasslahsen commented May 27, 2025

Uh oh!

rcbandit111 commented Jun 1, 2025

Uh oh!

StefanSchrass Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kimberninger Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

StefanSchrass Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mschout Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

StefanSchrass Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mschout Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

StefanSchrass Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

StefanSchrass Jun 2, 2025 •

edited

Loading

kimberninger Jun 2, 2025 •

edited

Loading

StefanSchrass Jun 2, 2025 •

edited

Loading

mschout Jun 2, 2025 •

edited

Loading

StefanSchrass Jun 2, 2025 •

edited

Loading

mschout Jun 2, 2025 •

edited

Loading

StefanSchrass Jun 2, 2025 •

edited

Loading