Startup failure after upgrade to 2.8.4

[aptituz]

Describe the bug

After upgrading springdoc to 2.8.4 we face the following startup failure:

java.lang.IllegalStateException: Unable to read meta-data for class org.springdoc.core.configuration.SpringDocUIConfiguration
at org.springframework.boot.autoconfigure.AutoConfigurationSorter$AutoConfigurationClass.getAnnotationMetadata(AutoConfigurationSorter.java:264)
at org.springframework.boot.autoconfigure.AutoConfigurationSorter$AutoConfigurationClass.getOrder(AutoConfigurationSorter.java:235)
at org.springframework.boot.autoconfigure.AutoConfigurationSorter.lambda$getInPriorityOrder$0(AutoConfigurationSorter.java:72)
at java.base/java.util.TimSort.countRunAndMakeAscending(TimSort.java:360)
at java.base/java.util.TimSort.sort(TimSort.java:234)
at java.base/java.util.Arrays.sort(Arrays.java:1307)
at java.base/java.util.ArrayList.sort(ArrayList.java:1721)
at org.springframework.boot.autoconfigure.AutoConfigurationSorter.getInPriorityOrder(AutoConfigurationSorter.java:71)
at org.springframework.boot.autoconfigure.AutoConfigurationImportSelector$AutoConfigurationGroup.sortAutoConfigurations(AutoConfigurationImportSelector.java:505)
at org.springframework.boot.autoconfigure.AutoConfigurationImportSelector$AutoConfigurationGroup.selectImports(AutoConfigurationImportSelector.java:489)
at org.springframework.context.annotation.ConfigurationClassParser$DeferredImportSelectorGrouping.getImports(ConfigurationClassParser.java:906)
at org.springframework.context.annotation.ConfigurationClassParser$DeferredImportSelectorGroupingHandler.processGroupImports(ConfigurationClassParser.java:833)
at org.springframework.context.annotation.ConfigurationClassParser$DeferredImportSelectorHandler.process(ConfigurationClassParser.java:803)
at org.springframework.context.annotation.ConfigurationClassParser.parse(ConfigurationClassParser.java:189)
at org.springframework.context.annotation.ConfigurationClassPostProcessor.processConfigBeanDefinitions(ConfigurationClassPostProcessor.java:418)
at org.springframework.context.annotation.ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry(ConfigurationClassPostProcessor.java:290)
at org.springframework.context.support.PostProcessorRegistrationDelegate.invokeBeanDefinitionRegistryPostProcessors(PostProcessorRegistrationDelegate.java:349)
at org.springframework.context.support.PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(PostProcessorRegistrationDelegate.java:118)
at org.springframework.context.support.AbstractApplicationContext.invokeBeanFactoryPostProcessors(AbstractApplicationContext.java:791)
at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:609)
at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:146)
at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:752)
at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:439)
at org.springframework.boot.SpringApplication.run(SpringApplication.java:318)
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1361)
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1350)
at digital.metro.companion.backend.allowlist.ApplicationKt.main(Application.kt:36)
Caused by: java.io.FileNotFoundException: class path resource [org/springdoc/core/configuration/SpringDocUIConfiguration.class] cannot be opened because it does not exist
at org.springframework.core.io.ClassPathResource.getInputStream(ClassPathResource.java:215)
at org.springframework.core.type.classreading.SimpleMetadataReader.getClassReader(SimpleMetadataReader.java:54)
at org.springframework.core.type.classreading.SimpleMetadataReader.(SimpleMetadataReader.java:48)
at org.springframework.core.type.classreading.SimpleMetadataReaderFactory.getMetadataReader(SimpleMetadataReaderFactory.java:103)
at org.springframework.boot.type.classreading.ConcurrentReferenceCachingMetadataReaderFactory.createMetadataReader(ConcurrentReferenceCachingMetadataReaderFactory.java:98)
at org.springframework.boot.type.classreading.ConcurrentReferenceCachingMetadataReaderFactory.getMetadataReader(ConcurrentReferenceCachingMetadataReaderFactory.java:85)
at org.springframework.core.type.classreading.SimpleMetadataReaderFactory.getMetadataReader(SimpleMetadataReaderFactory.java:81)
at org.springframework.boot.type.classreading.ConcurrentReferenceCachingMetadataReaderFactory.getMetadataReader(ConcurrentReferenceCachingMetadataReaderFactory.java:75)
at org.springframework.boot.autoconfigure.AutoConfigurationSorter$AutoConfigurationClass.getAnnotationMetadata(AutoConfigurationSorter.java:260)
... 26 common frames omitted

Process finished with exit code 1

To Reproduce
Steps to reproduce the behavior:

• What version of spring-boot you are using?

3.4.1

• What modules and versions of springdoc-openapi are you using?

springdoc-openapi-starter-webmvc-ui

Unfortunately I failed at compiling a minimal reproducer, so it doesn't seem to be a general issue, but it seems to affect all our services.

[madorb]

Oops. Looks like the public API was broken in a patch release due to SpringDocUIConfiguration being deleted :|

v2.8.3...v2.8.4#diff-27b86bea0552bb85363db7ace021c4904d2a7cff7b5a704fb01d53cc5fd0bd44

for this MR: #2862

the documentation needs to be updated as well.

[bnasslahsen]

@aptituz without at reproducible, difficult to help.

Feel free to provide a Minimal, Reproducible Example - with HelloController that reproduces the problem.

This ticket will be closed, but can be reopened if your provide the reproducible sample.

[erikpetzold]

The class SpringDocUIConfiguration was obviously deleted. This is a breaking change, released with a patch version.

There is even a link to the docs showing that you should use this class. This example would not even compile.

Just closing the issue as non reproducible feels very wrong.

[aptituz]

Hey @bnasslahsen,

closing this issue w/o any attempt to help is kinda disappointing.

I would have hoped that you, as the developers of springdoc-openapi, might have a better idea what might be necessary to reproduce the issue.

We are now stuck on the old version of your springdoc-openapi and don't know why. Simply closing this issue doesn't feel right, especially since @madorb indicated that the class that has been mentioned in the error message has been deleted in this minor update, which most likely indicates a bug in the first place, right? Or why would you delete a class in a minor release and still mention it in the documentation?

[jshyun]

I encountered this just now. For us it was because our project was referencing springdoc-openapi-starter-webmvc-ui 2.8.3 but also directly referencing a later version of springdoc-openapi-starter-webmvc-api 2.8.4. The autoconfigure import comes from the ui library but the Configuration file lives in the common (which is pulled in by the api). Aligning all the versions fixed it for us.