Skip to content

Commit cd455a9

Browse files
committed
Restore previous serialization formatting in Actuator responses
Fixes gh-33236
1 parent cb1ee20 commit cd455a9

File tree

3 files changed

+67
-4
lines changed

3 files changed

+67
-4
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/JacksonEndpointAutoConfiguration.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@
1616

1717
package org.springframework.boot.actuate.autoconfigure.endpoint.jackson;
1818

19+
import com.fasterxml.jackson.annotation.JsonInclude.Include;
1920
import com.fasterxml.jackson.databind.ObjectMapper;
21+
import com.fasterxml.jackson.databind.SerializationFeature;
2022

2123
import org.springframework.boot.actuate.endpoint.jackson.EndpointObjectMapper;
2224
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
@@ -42,7 +44,10 @@ public class JacksonEndpointAutoConfiguration {
4244
@ConditionalOnProperty(name = "management.endpoints.jackson.isolated-object-mapper", matchIfMissing = true)
4345
@ConditionalOnClass({ ObjectMapper.class, Jackson2ObjectMapperBuilder.class })
4446
public EndpointObjectMapper endpointObjectMapper() {
45-
ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json().build();
47+
ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json()
48+
.featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,
49+
SerializationFeature.WRITE_DURATIONS_AS_TIMESTAMPS)
50+
.serializationInclusion(Include.NON_NULL).build();
4651
return () -> objectMapper;
4752
}
4853

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/JacksonEndpointAutoConfigurationTests.java

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616

1717
package org.springframework.boot.actuate.autoconfigure.endpoint.jackson;
1818

19+
import java.time.Duration;
20+
import java.time.Instant;
21+
import java.time.format.DateTimeFormatter;
22+
import java.util.HashMap;
23+
import java.util.Map;
24+
1925
import com.fasterxml.jackson.databind.ObjectMapper;
2026
import org.junit.jupiter.api.Test;
2127

@@ -54,6 +60,37 @@ void endpointObjectMapperWhenPropertyFalse() {
5460
.run((context) -> assertThat(context).doesNotHaveBean(EndpointObjectMapper.class));
5561
}
5662

63+
@Test
64+
void endpointObjectMapperDoesNotSerializeDatesAsTimestamps() {
65+
this.runner.run((context) -> {
66+
ObjectMapper objectMapper = context.getBean(EndpointObjectMapper.class).get();
67+
Instant now = Instant.now();
68+
String json = objectMapper.writeValueAsString(Map.of("timestamp", now));
69+
assertThat(json).contains(DateTimeFormatter.ISO_INSTANT.format(now));
70+
});
71+
}
72+
73+
@Test
74+
void endpointObjectMapperDoesNotSerializeDurationsAsTimestamps() {
75+
this.runner.run((context) -> {
76+
ObjectMapper objectMapper = context.getBean(EndpointObjectMapper.class).get();
77+
Duration duration = Duration.ofSeconds(42);
78+
String json = objectMapper.writeValueAsString(Map.of("duration", duration));
79+
assertThat(json).contains(duration.toString());
80+
});
81+
}
82+
83+
@Test
84+
void endpointObjectMapperDoesNotSerializeNullValues() {
85+
this.runner.run((context) -> {
86+
ObjectMapper objectMapper = context.getBean(EndpointObjectMapper.class).get();
87+
HashMap<String, String> map = new HashMap<>();
88+
map.put("key", null);
89+
String json = objectMapper.writeValueAsString(map);
90+
assertThat(json).isEqualTo("{}");
91+
});
92+
}
93+
5794
@Configuration(proxyBeanMethods = false)
5895
static class TestEndpointMapperConfiguration {
5996

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/AbstractEndpointDocumentationTests.java

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,14 @@
2626
import com.fasterxml.jackson.databind.ObjectMapper;
2727
import com.fasterxml.jackson.databind.SerializationFeature;
2828

29+
import org.springframework.beans.BeansException;
30+
import org.springframework.beans.factory.config.BeanPostProcessor;
2931
import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration;
32+
import org.springframework.boot.actuate.autoconfigure.endpoint.jackson.JacksonEndpointAutoConfiguration;
3033
import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointAutoConfiguration;
3134
import org.springframework.boot.actuate.autoconfigure.endpoint.web.reactive.WebFluxEndpointManagementContextConfiguration;
3235
import org.springframework.boot.actuate.autoconfigure.endpoint.web.servlet.WebMvcEndpointManagementContextConfiguration;
36+
import org.springframework.boot.actuate.endpoint.jackson.EndpointObjectMapper;
3337
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
3438
import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
3539
import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration;
@@ -38,6 +42,7 @@
3842
import org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration;
3943
import org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration;
4044
import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
45+
import org.springframework.context.annotation.Bean;
4146
import org.springframework.context.annotation.Configuration;
4247
import org.springframework.restdocs.operation.preprocess.ContentModifyingOperationPreprocessor;
4348
import org.springframework.restdocs.operation.preprocess.OperationPreprocessor;
@@ -54,8 +59,7 @@
5459
*
5560
* @author Andy Wilkinson
5661
*/
57-
@TestPropertySource(properties = { "spring.jackson.serialization.indent_output=true",
58-
"management.endpoints.web.exposure.include=*", "spring.jackson.default-property-inclusion=non_null" })
62+
@TestPropertySource(properties = { "management.endpoints.web.exposure.include=*" })
5963
public abstract class AbstractEndpointDocumentationTests {
6064

6165
protected static String describeEnumValues(Class<? extends Enum<?>> enumType) {
@@ -119,9 +123,26 @@ private <T> List<Object> select(List<Object> candidates, Predicate<T> filter) {
119123
WebMvcAutoConfiguration.class, DispatcherServletAutoConfiguration.class, EndpointAutoConfiguration.class,
120124
WebEndpointAutoConfiguration.class, WebMvcEndpointManagementContextConfiguration.class,
121125
WebFluxEndpointManagementContextConfiguration.class, PropertyPlaceholderAutoConfiguration.class,
122-
WebFluxAutoConfiguration.class, HttpHandlerAutoConfiguration.class })
126+
WebFluxAutoConfiguration.class, HttpHandlerAutoConfiguration.class,
127+
JacksonEndpointAutoConfiguration.class })
123128
static class BaseDocumentationConfiguration {
124129

130+
@Bean
131+
static BeanPostProcessor endpointObjectMapperBeanPostProcessor() {
132+
return new BeanPostProcessor() {
133+
134+
@Override
135+
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
136+
if (bean instanceof EndpointObjectMapper) {
137+
return (EndpointObjectMapper) () -> ((EndpointObjectMapper) bean).get()
138+
.enable(SerializationFeature.INDENT_OUTPUT);
139+
}
140+
return bean;
141+
}
142+
143+
};
144+
}
145+
125146
}
126147

127148
}

0 commit comments

Comments
 (0)