Skip to content

GH-10235: Remove Joda Time support from Jackson 3 ObjectMapper #10236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025
Merged

GH-10235: Remove Joda Time support from Jackson 3 ObjectMapper #10236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,6 @@ project('spring-integration-core') {
api 'io.micrometer:micrometer-observation'

optionalApi 'tools.jackson.core:jackson-databind'
optionalApi 'tools.jackson.datatype:jackson-datatype-joda'
optionalApi('tools.jackson.module:jackson-module-kotlin') {
exclude group: 'org.jetbrains.kotlin'
}
Expand Down
66 changes: 7 additions & 59 deletions .../test/java/org/springframework/integration/support/json/JacksonJsonObjectMapperTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@
import java.util.Set;
import java.util.stream.Collectors;

import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
Expand All @@ -49,7 +47,6 @@
import tools.jackson.databind.JsonNode;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.databind.json.JsonMapper;
import tools.jackson.datatype.joda.JodaModule;
import tools.jackson.module.kotlin.KotlinModule;

import static org.assertj.core.api.Assertions.assertThat;
Expand All @@ -62,10 +59,6 @@
*/
class JacksonJsonObjectMapperTests {

private static final JacksonModule JODA_MODULE = new JodaModule();

private static final JacksonModule KOTLIN_MODULE = new KotlinModule.Builder().build();

private JacksonJsonObjectMapper mapper;

@BeforeEach
Expand All @@ -75,17 +68,15 @@ void setUp() {

@Test
void compareAutoDiscoveryVsManualModules() {
KotlinModule kotlinModule = new KotlinModule.Builder().build();
ObjectMapper manualMapper = JsonMapper.builder()
.addModules(collectWellKnownModulesIfAvailable())
.addModules(kotlinModule)
.build();

Set<String> collectedModuleNames = getModuleNames(collectWellKnownModulesIfAvailable());

Set<String> autoModuleNames = getModuleNames(mapper.getObjectMapper().getRegisteredModules());
assertThat(autoModuleNames).isEqualTo(collectedModuleNames);

Set<String> manualModuleNames = getModuleNames(manualMapper.getRegisteredModules());
assertThat(manualModuleNames).isEqualTo(collectedModuleNames);

assertThat(autoModuleNames).isEqualTo(manualModuleNames);
}

@Test
Expand Down Expand Up @@ -196,7 +187,7 @@ void testMapTypes() throws IOException {
}

@Test
public void testOptional() throws IOException {
void testOptional() throws IOException {
TestData data = new TestData("John", Optional.of("[email protected]"), Optional.empty());

String json = mapper.toJson(data);
Expand All @@ -207,72 +198,29 @@ public void testOptional() throws IOException {
}

@Test
public void testJavaTime() throws Exception {
void testJavaTime() throws IOException {
LocalDateTime localDateTime = LocalDateTime.of(2000, 1, 1, 0, 0);
ZonedDateTime zonedDateTime = ZonedDateTime.of(localDateTime, ZoneId.of("UTC"));
TimeData data = new TimeData(localDateTime, zonedDateTime);

String json = mapper.toJson(data);
assertThat("{\"localDate\":\"2000-01-01T00:00:00\",\"zoneDate\":\"2000-01-01T00:00:00Z\"}").isEqualTo(json);
assertThat(json).isEqualTo("{\"localDate\":\"2000-01-01T00:00:00\",\"zoneDate\":\"2000-01-01T00:00:00Z\"}");

TimeData deserialized = mapper.fromJson(json, TimeData.class);
assertThat(deserialized.localDate()).isEqualTo(data.localDate());
assertThat(deserialized.zoneDate().toInstant()).isEqualTo(data.zoneDate().toInstant());
}

@Test
public void testJodaWithJodaModule() throws Exception {
ObjectMapper objectMapper = mapper.getObjectMapper();
Set<String> registeredModules = getModuleNames(objectMapper.getRegisteredModules());
assertThat(registeredModules.contains(JODA_MODULE.getModuleName())).isTrue();

org.joda.time.DateTime jodaDateTime = new DateTime(2000, 1, 1, 0, 0, DateTimeZone.UTC);
JodaData data = new JodaData("John", jodaDateTime);

String json = mapper.toJson(data);
assertThat("{\"name\":\"John\",\"jodaDate\":\"2000-01-01T00:00:00.000Z\"}").isEqualTo(json);

JodaData deserialized = mapper.fromJson(json, JodaData.class);
assertThat(deserialized.name()).isEqualTo(data.name());
assertThat(deserialized.jodaDate()).isEqualTo(data.jodaDate());
}

@Test
public void testJodaWithoutJodaModule() {
ObjectMapper customMapper = JsonMapper.builder().build();
JacksonJsonObjectMapper mapper = new JacksonJsonObjectMapper(customMapper);

Set<String> registeredModules = getModuleNames(mapper.getObjectMapper().getRegisteredModules());
assertThat(registeredModules.contains(JODA_MODULE.getModuleName())).isFalse();

org.joda.time.DateTime jodaDateTime = new DateTime(2000, 1, 1, 0, 0, DateTimeZone.UTC);
JodaData data = new JodaData("John", jodaDateTime);

assertThatThrownBy(() -> mapper.toJson(data))
.isInstanceOf(IOException.class);

String json = "{\"name\":\"John\",\"jodaDate\":\"2000-01-01T00:00:00.000Z\"}";
assertThatThrownBy(() -> mapper.fromJson(json, JodaData.class))
.isInstanceOf(IOException.class);
}

private Set<String> getModuleNames(Collection<JacksonModule> modules) {
return modules.stream()
.map(JacksonModule::getModuleName)
.collect(Collectors.toUnmodifiableSet());
}

private List<JacksonModule> collectWellKnownModulesIfAvailable() {
return List.of(JODA_MODULE, KOTLIN_MODULE);
}

private record TestData(String name, Optional<String> email, Optional<Integer> age) {
}

private record TimeData(LocalDateTime localDate, ZonedDateTime zoneDate) {
}

private record JodaData(String name, org.joda.time.DateTime jodaDate) {
}

}
15 changes: 3 additions & 12 deletions ...rc/test/java/org/springframework/integration/support/json/JacksonMessagingUtilsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,14 @@

package org.springframework.integration.support.json;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import tools.jackson.databind.JacksonModule;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.datatype.joda.JodaModule;
import tools.jackson.module.kotlin.KotlinModule;

import org.springframework.integration.message.AdviceMessage;
Expand All @@ -53,16 +50,10 @@ void setUp() {
}

@Test
void shouldIncludeWellKnownModules() {
List<JacksonModule> wellKnownModules = Arrays.asList(
new JodaModule(),
new KotlinModule.Builder().build()
);

Set<String> wellKnownModuleNames = getModuleNames(wellKnownModules);
void shouldIncludeKotlinModule() {
KotlinModule kotlinModule = new KotlinModule.Builder().build();
Set<String> registeredModuleNames = getModuleNames(mapper.getRegisteredModules());

assertThat(registeredModuleNames).containsAll(wellKnownModuleNames);
assertThat(registeredModuleNames).contains(kotlinModule.getModuleName());
}

@Test
Expand Down