fix(micrometer): add MicrometerOutboxListener to ConditionalOnClass for Okapi Spring auto configuration class - #85
Open
rawo wants to merge 1 commit into
Open
fix(micrometer): add MicrometerOutboxListener to ConditionalOnClass for Okapi Spring auto configuration class#85rawo wants to merge 1 commit into
rawo wants to merge 1 commit into
Conversation
…or Okapi Spring auto configuration class
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a Spring Boot autoconfiguration edge case where OkapiMicrometerAutoConfiguration could be loaded when Micrometer is present (e.g., via Actuator) but okapi-micrometer is not, leading to NoClassDefFoundError at startup (Issue #84). It tightens the classpath guard and adds a regression test to ensure the autoconfiguration is fully skipped when okapi-micrometer classes are absent.
Changes:
- Extend the class-level
@ConditionalOnClassguard inOkapiMicrometerAutoConfigurationto also require anokapi-micrometertype (via class name string). - Add a Spring Boot
FilteredClassLoader-based test covering the “MeterRegistry present, okapi-micrometer missing” scenario and a sanity check for the positive path.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| okapi-spring-boot/src/main/kotlin/com/softwaremill/okapi/springboot/OkapiMicrometerAutoConfiguration.kt | Strengthens classpath-based conditional loading to avoid NoClassDefFoundError when okapi-micrometer is not on the classpath. |
| okapi-spring-boot/src/test/kotlin/com/softwaremill/okapi/springboot/OkapiMicrometerAutoConfigurationTest.kt | Adds regression coverage verifying autoconfiguration is skipped when MicrometerOutboxListener is hidden from the context classloader. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+42
to
+53
| @ConditionalOnClass( | ||
| name = [ | ||
| // A consuming app can easily have MeterRegistry on the classpath (e.g. via Spring Boot | ||
| // Actuator) without depending on okapi-micrometer at all -- MeterRegistry alone is not | ||
| // evidence okapi-micrometer is present. This class directly references | ||
| // MicrometerOutboxListener/MicrometerOutboxMetrics/OutboxMetricsRefresher below, so without | ||
| // this guard, Spring's condition/annotation evaluation would try to load this class on | ||
| // such a classpath and fail with NoClassDefFoundError instead of just skipping it. | ||
| "io.micrometer.core.instrument.MeterRegistry", | ||
| "com.softwaremill.okapi.micrometer.MicrometerOutboxListener", | ||
| ], | ||
| ) |
endrju19
approved these changes
Jul 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#84
Fix: add MicrometerOutboxListener to the class-level @ConditionalOnClass, so the whole autoconfiguration is skipped (not just attempted and failed) when okapi-micrometer isn't on the classpath.