LogbookAutoConfiguration fails in environments without Spring Web (missing ClientHttpRequestInterceptor)

[clinmanc]

Description

When using logbook-spring-boot-starter in a project that does not include spring-web, the LogbookAutoConfiguration unconditionally registers a LogbookClientHttpRequestInterceptor bean.
This causes a ClassNotFoundException since org.springframework.http.client.ClientHttpRequestInterceptor is not present.

Expected Behavior

LogbookAutoConfiguration should not fail in environments without Spring Web.
The LogbookClientHttpRequestInterceptor bean should only be created if ClientHttpRequestInterceptor is available on the classpath.

Actual Behavior

Application startup fails with the following error:

Caused by: java.lang.ClassNotFoundException: org.springframework.http.client.ClientHttpRequestInterceptor

Possible Fix

Update LogbookAutoConfiguration to conditionally register the bean, for example:

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({
        ClientHttpRequestInterceptor.class,
        LogbookClientHttpRequestInterceptor.class
})
static class ClientHttpAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean(LogbookClientHttpRequestInterceptor.class)
    public LogbookClientHttpRequestInterceptor logbookClientHttpRequestInterceptor(Logbook logbook) {
        return new LogbookClientHttpRequestInterceptor(logbook);
    }

}

Steps to Reproduce

Create a new Spring Boot project without including spring-boot-starter-web.

Add logbook-spring-boot-starter as a dependency.

Start the application.

Observe the ClassNotFoundException.

Context

We are using Logbook in a non-web Spring Boot application (for logging outgoing requests/responses from other HTTP clients, not via Spring Web).
The unconditional creation of the Spring-specific interceptor prevents the application from starting.

Your Environment

Logbook version: 3.12.3

Spring Boot version: 3.5.5

[thesumitkrsingh]

Hi, I've been looking at this issue and would like to work on a fix.

The problem is that LogbookClientHttpRequestInterceptor is registered unconditionally in LogbookAutoConfiguration. The solution is to wrap its @Bean definition with @ConditionalOnClass(ClientHttpRequestInterceptor.class) to prevent it from being loaded when Spring Web is not on the classpath.

I have a clear understanding of the changes needed and will include appropriate tests to verify the fix works in both scenarios (with and without spring-web).

Please assign this issue to me. Thanks!

[kasmarian]

@thesumitkrsingh feel free to work on the PR, thank you for the help offer!

[thesumitkrsingh]

Thank you for the giving me opportunity to adding something effective

[thesumitkrsingh]

That's a very clear and well-detailed update on the issue! I'm sorry to hear you won't be able to continue the work, but I understand that things happen.

Here is an apology message you can use, framed to acknowledge the work you already did and the helpful analysis you provided.

Apology Message
Hi [Maintainer/Team Member Name] or Team,

Please accept my apologies, but due to unforeseen circumstances [or 'a change in my availability' or 'other commitments'], I will not be able to continue working on the fix for the LogbookClientHttpRequestInterceptor issue.

I realize I asked for the issue to be assigned to me, and I regret having to step away. I wanted to let you know as soon as possible so that someone else can pick it up.

For reference, the solution I identified remains: the fix is to wrap the @bean definition for LogbookClientHttpRequestInterceptor with @ConditionalOnClass(ClientHttpRequestInterceptor.class) in LogbookAutoConfiguration to ensure it only loads when Spring Web is on the classpath.

I’m un-assigning myself now. I hope this analysis still helps the next person tackle the issue quickly.

Thank you for your understanding.

Best regards,