Dependency management and unification with Spring's bom and azure-sdk-bom

[conniey]

Description

One of the problems we have is that there are dependency conflicts between the boms shipped from Spring and our azure-sdk bom. We need a way to resolve it.

Option 1

A layered approach where the boms use azure-sdk-bom.

1. azure-spring-cloud-dependencies
2. azure-spring-boot-bom

Option 2

We ship another azure-sdk-dependencies bom that azure-spring-cloud-dependencies and azure-spring-boot-bom use. Investigation work item #21306

Work items

General

• Investigate creating azure-sdk-dependencies #21306: Investigate efforts to using Option 2
• Investigate ways to decouple common conflicting dependencies #21307: Investigate ways to decouple common conflicting dependencies
  • Resilient Jackson Multi-Version Support #20998: Resilient Jackson Multi-Version Support
  • Possibly sub-issues will be created for implementing a solution
• Increase cadence at which we ship azure-sdk-bom #21308: Increase the cadence at which we ship the azure-sdk-bom
  • This is at the end so we don't have it lost amongst the work

Tooling

• Support for side-by-side versioning #15512: Ability to ship multiple versions of the spring starters with our versions of Azure SDK.
  • The Spring team has to concurrently support multiple versions of Spring (ie. 2.2, 2.3, 2.4) with their starters. We need some way to be able to ship them with our versions of the Azure SDK.
  • Possible consideration is different artefact names.
  • What about the starters that we have shipped GA already, what would we use?
    • Relocation package? (https://maven.apache.org/guides/mini/guide-relocation.html)
• Add/Integrate existing tests that verify versions of the azure-sdk work with spring starters. #21305: Tests that verify our versions shipped in azure-sdk work with the Spring versions they ship.
  • Weekly Multi-Version Dependency Test Runs #20514: Weekly multi-version dependency runs.
• Create Tooling to Generate SDK to Dependency Version Compatibility Chart #21220: Tooling to Generate SDK to dependency version compatibility

Notes

• Spring Boot dependencies: https://repo.maven.apache.org/maven2/org/springframework/boot/spring-boot-dependencies/
• Spring Cloud dependencies: https://repo.maven.apache.org/maven2/org/springframework/cloud/spring-cloud-dependencies/
• Our Azure Spring's dependencies are updated via: update_spring_managed_external_dependencies.py
  • Output spring_managed_external_dependencies.txt

[joshfree]

Tagging @pallavit who is working on the azure-sdk-bom tooling and increasing the shipping cadence of the bom to monthly this semester

[saragluna]

FYI, the latest version of Spring Cloud Azure BOM has been renamed to spring-cloud-azure-dependencies and it shipped with the azure-sdk-bom. Check the ref doc for more details https://microsoft.github.io/spring-cloud-azure/current/reference/html/index.html#bill-of-material-bom.

[stevenylai]

Hi, in our case, we want to use a specific version of Azure library and would like to find the most recent spring starter which works with it. The one we want is: azure-schemaregistry-kafka-avro:1.0.0-beta.7 which depends on azure-data-schemaregistry:1.1.1. We also want to use azure-sdk-bom since we have other services such as CosmosDB in our projects. The 'schemaregistry' version we need is from azure-sdk-bom:1.2.1. But from version table it's not clear if it's OK to upgrade our SpingBoot from 2.6.x to 2.7.x. We tried 2.7.4 but got the same 'NoSuchMethodError: reactor.core.publisher.MonoSink.contextView()' error as shown here.

It looks like the not found method was introduced in reactor-core:3.4.18 and we are better off staying with no later than spring-boot-starter-webflux:2.6.7

It would be nice if the version table could also provide this kind of information

[saragluna]

@stevenylai you could find it from our changelog https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/spring/CHANGELOG.md, and the Spring Cloud Azure version compatible with azure-sdk-bom version 1.2.1 is https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/spring/CHANGELOG.md#410-2022-05-05.