Upgrade sdk/spring to Jackson 3 to align with Spring Boot 4#49550
Open
rujche wants to merge 5 commits into
Open
Upgrade sdk/spring to Jackson 3 to align with Spring Boot 4#49550rujche wants to merge 5 commits into
rujche wants to merge 5 commits into
Conversation
Migrate Jackson 2 (com.fasterxml.jackson.databind/core) to Jackson 3 (tools.jackson) across 10 sdk/spring modules: poms, source, and tests. Jackson 2 annotations are intentionally retained. Cosmos is out of scope.
rujche
requested review from
a team,
JonathanGiles,
Netyyyy,
alzimmermsft,
avanigupta,
g2vinay,
moarychan,
mrm9084,
nroutray,
samvaity and
saragluna
as code owners
Drop springboot4_com.fasterxml.jackson.core:jackson-databind and springboot4_tools.jackson.core:jackson-core, which are no longer referenced after the Jackson 3 migration.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the Spring libraries under sdk/spring from Jackson 2 (com.fasterxml.jackson.*) to Jackson 3 (tools.jackson.*) to align with the Spring Boot 4 dependency stack and avoid Jackson 2/3 classpath conflicts (per #49538).
Changes:
- Updated multiple Spring module POMs to depend on
tools.jackson.core:jackson-databind:3.1.4(and updated related enforcer rules / version pins). - Migrated production and test code imports and APIs from
com.fasterxml.jackson.*totools.jackson.*(including JSON node string APIs and exception types). - Updated Spring Boot auto-configuration tests to use Jackson 3 auto-config (
JacksonAutoConfiguration) andJsonMapper-based mapper creation where needed.
Reviewed changes
Copilot reviewed 45 out of 45 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| sdk/spring/spring-messaging-azure/src/main/java/com/azure/spring/messaging/implementation/converter/ObjectMapperHolder.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-messaging-azure/src/main/java/com/azure/spring/messaging/implementation/converter/AbstractJacksonAzureMessageConverter.java | Updates Jackson exception/import usage to Jackson 3 types. |
| sdk/spring/spring-messaging-azure/pom.xml | Replaces Jackson 2 databind dependency/enforcer entry with Jackson 3 coordinates. |
| sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/implementation/support/converter/StorageQueueMessageConverter.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-messaging-azure-servicebus/src/main/java/com/azure/spring/messaging/servicebus/implementation/support/converter/ServiceBusMessageConverter.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-messaging-azure-eventhubs/src/test/java/com/azure/spring/messaging/eventhubs/implementation/support/converter/EventHubsBatchMessageConverterTests.java | Migrates test imports/exceptions to Jackson 3. |
| sdk/spring/spring-messaging-azure-eventhubs/src/main/java/com/azure/spring/messaging/eventhubs/implementation/support/converter/EventHubsMessageConverter.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-messaging-azure-eventhubs/src/main/java/com/azure/spring/messaging/eventhubs/implementation/support/converter/EventHubsBatchMessageConverter.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-feature-management/src/main/java/com/azure/spring/cloud/feature/management/implementation/FeatureManagementProperties.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-feature-management/src/main/java/com/azure/spring/cloud/feature/management/filters/TimeWindowFilter.java | Migrates mapper/node APIs and adds Jackson 3 databind exception handling. |
| sdk/spring/spring-cloud-azure-feature-management/src/main/java/com/azure/spring/cloud/feature/management/filters/TargetingFilter.java | Switches Jackson imports to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-feature-management/pom.xml | Replaces Jackson 2 databind dependency/enforcer entry with Jackson 3 coordinates. |
| sdk/spring/spring-cloud-azure-docker-compose/pom.xml | Replaces Jackson 2 databind dependency/enforcer entry with Jackson 3 coordinates. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/test/java/com/azure/spring/cloud/autoconfigure/implementation/storage/AzureStorageQueueMessagingAutoConfigurationTests.java | Moves tests to Jackson 3 auto-config and JsonMapper creation. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/test/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/AzureServiceBusMessagingAutoConfigurationTests.java | Moves tests to Jackson 3 auto-config and JsonMapper creation. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/test/java/com/azure/spring/cloud/autoconfigure/implementation/eventhubs/AzureEventHubsMessagingAutoConfigurationTests.java | Moves tests to Jackson 3 auto-config and JsonMapper creation. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/test/java/com/azure/spring/cloud/autoconfigure/implementation/aad/security/graph/GraphClientTest.java | Updates JSON serialization in tests to use Jackson 3 JsonMapper. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/test/java/com/azure/spring/cloud/autoconfigure/implementation/aad/filter/UserPrincipalMicrosoftGraphTests.java | Migrates test Jackson imports/exceptions to Jackson 3. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/queue/AzureStorageQueueMessagingAutoConfiguration.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/servicebus/AzureServiceBusMessagingAutoConfiguration.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/eventhubs/AzureEventHubsMessagingAutoConfiguration.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/utils/JacksonObjectMapperFactory.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/serde/jackson/StdConverters.java | Migrates Jackson node/converter imports to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/serde/jackson/SerializerUtils.java | Migrates Spring Security Jackson modules and mapper usage to Jackson 3. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/serde/jackson/JsonNodeUtils.java | Updates JsonNode APIs and refactors value conversion to use DeserializationContext. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/serde/jackson/AadOAuth2ClientJacksonModule.java | Replaces Jackson 2 module implementation with Jackson 3 module API usage. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/serde/jackson/AadClientRegistrationMixin.java | Switches @JsonDeserialize annotation import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/serde/jackson/AadClientRegistrationDeserializer.java | Migrates deserializer to Jackson 3 deserializer base type and parsing APIs. |
| sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/filter/AadGraphClient.java | Switches ObjectMapper import to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-autoconfigure/pom.xml | Adds Spring Boot Jackson 3 autoconfig artifact and Jackson 3 databind dependency/enforcer entry. |
| sdk/spring/spring-cloud-azure-appconfiguration-config/src/test/java/com/azure/spring/cloud/appconfiguration/config/implementation/TestUtils.java | Updates test JSON node APIs and exception type to Jackson 3. |
| sdk/spring/spring-cloud-azure-appconfiguration-config/src/test/java/com/azure/spring/cloud/appconfiguration/config/implementation/JsonConfigurationParserTest.java | Switches Jackson imports in tests to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-appconfiguration-config/src/test/java/com/azure/spring/cloud/appconfiguration/config/implementation/AppConfigurationApplicationSettingPropertySourceTest.java | Removes Jackson 2 mapper usage in tests (imports/strategy). |
| sdk/spring/spring-cloud-azure-appconfiguration-config/src/test/java/com/azure/spring/cloud/appconfiguration/config/implementation/AppConfigurationApplicationSettingPropertySourceSnapshotTest.java | Removes Jackson 2 mapper usage in tests (imports/strategy). |
| sdk/spring/spring-cloud-azure-appconfiguration-config/src/main/java/com/azure/spring/cloud/appconfiguration/config/implementation/JsonConfigurationParser.java | Migrates JSON parsing/iteration APIs and exception types to Jackson 3. |
| sdk/spring/spring-cloud-azure-appconfiguration-config/src/main/java/com/azure/spring/cloud/appconfiguration/config/implementation/FeatureFlagClient.java | Migrates JSON parsing APIs and exception types to Jackson 3. |
| sdk/spring/spring-cloud-azure-appconfiguration-config/src/main/java/com/azure/spring/cloud/appconfiguration/config/implementation/AppConfigurationFeatureManagementPropertySource.java | Switches ObjectMapper/JsonMapper imports to Jackson 3 namespace. |
| sdk/spring/spring-cloud-azure-appconfiguration-config/pom.xml | Adds Jackson 3 databind dependency and updates enforcer entry for Jackson 3. |
| sdk/spring/spring-cloud-azure-appconfiguration-config-web/src/test/java/com/azure/spring/cloud/appconfiguration/config/web/implementation/AppConfigurationEndpointTest.java | Migrates tests to Jackson 3 mapper/node types and removes checked Jackson 2 exceptions. |
| sdk/spring/spring-cloud-azure-appconfiguration-config-web/src/main/java/com/azure/spring/cloud/appconfiguration/config/web/implementation/pushrefresh/AppConfigurationRefreshEndpoint.java | Migrates JsonNode import and string accessor API to Jackson 3. |
| sdk/spring/spring-cloud-azure-appconfiguration-config-web/src/main/java/com/azure/spring/cloud/appconfiguration/config/web/implementation/pushbusrefresh/AppConfigurationBusRefreshEndpoint.java | Migrates JsonNode import and string accessor API to Jackson 3. |
| sdk/spring/spring-cloud-azure-appconfiguration-config-web/src/main/java/com/azure/spring/cloud/appconfiguration/config/web/implementation/AppConfigurationEndpoint.java | Migrates to Jackson 3 JsonMapper and string accessor API updates. |
| sdk/spring/spring-cloud-azure-actuator-autoconfigure/pom.xml | Replaces Jackson 2 databind dependency/enforcer entry with Jackson 3 coordinates. |
| sdk/spring/CHANGELOG.md | Adds release notes entries for the Jackson 3 migration across affected Spring modules. |
| eng/versioning/external_dependencies.txt | Adds Spring Boot 4 spring-boot-jackson and Jackson 3 dependency pins for version management. |
…erterTests JacksonException is unchecked in Jackson 3, so the throws clauses (and the now-unused import) are redundant. Addresses Copilot review feedback.
Member
Author
|
/azp run java - spring - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
…ebus Exclude the Jackson 2.18 jackson-annotations brought transitively by the azure-core-serializer-json-jackson test dependency. It lacks com.fasterxml.jackson.annotation.JsonSerializeAs (required by tools.jackson.databind 3.x) and won dependency mediation on the test classpath, breaking ObjectMapperHolder/ServiceBusTemplate initialization. After exclusion, the Jackson 3-compatible jackson-annotations 2.21 from spring-messaging-azure is used.
The protected static OBJECT_MAPPER field type changed from com.fasterxml.jackson.databind.ObjectMapper to tools.jackson.databind.ObjectMapper as part of the Jackson 2->3 migration for Spring Boot 4. Add a RevApi difference allowlist entry with justification for this intentional breaking change.
Member
Author
|
/azp run java - spring - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
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.
Summary
Migrate Jackson 2 (
com.fasterxml.jackson.databind/com.fasterxml.jackson.core) to Jackson 3 (tools.jackson) across 10sdk/springmodules to align with Spring Boot 4.Changes
com.fasterxml.jackson.core:jackson-databinddependency (and Maven enforcer<includes>allowlist entries) totools.jackson.core:jackson-databind:3.1.4in affected POMs.com.fasterxml.jackson.databind.*->tools.jackson.databind.*,com.fasterxml.jackson.core.*->tools.jackson.core.*;new ObjectMapper()->JsonMapper.builder().build();asText()/isTextual()/textValue()->asString()/isString()/stringValue(); checked Jackson exceptions -> uncheckedtools.jackson.core.JacksonException;JsonDeserializer->ValueDeserializer;setMixInAnnotations->setMixIn.AadOAuth2ClientJackson2Modulewith Jackson 3AadOAuth2ClientJacksonModule.spring-boot-jackson(Jackson 3 autoconfig) added alongside the retainedspring-boot-jackson2compat module.com.fasterxml.jackson.annotation.*) are intentionally retained (unchanged in Jackson 3).sdk/spring/CHANGELOG.mdfor all 10 affected modules.Out of scope
Cosmos (
azure-spring-data-cosmosand the Spring Cloud Azure Cosmos starter) is not migrated to Jackson 3 in this PR. It cannot be migrated in isolation because:azure-spring-data-cosmosdepends onazure-cosmos, andazure-cosmosexposes Jackson 2 types (e.g.com.fasterxml.jackson.databind.JsonNodeinCosmosItemSerializer,CosmosItemResponse, and mostcom.azure.cosmos.models.*classes) as part of its public API. About 65 public classes importcom.fasterxml.jackson.JsonNodeis part of the public contract, movingazure-cosmosto Jackson 3 is a breaking API change that cascades to every dependent module undersdk/cosmos(azure-cosmos-encryption,azure-cosmos-spark_3and variants,azure-cosmos-kafka-connect,azure-cosmos-benchmark,azure-cosmos-tests, ...) — roughly 440+ source files reference Jackson 2 across the tree.azure-cosmosis a GA data-plane library, so such a breaking change requires separate API review and a coordinated, multi-module effort.This follow-up work is tracked in #49551.
Verification
Resolves #49538