-
Notifications
You must be signed in to change notification settings - Fork 2k
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.
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
Use ObjectMapperShim in all core packages, deprecate direct ObjectMapper usage #24138
Conversation
sdk/core/azure-core/src/main/java/com/azure/core/util/serializer/JacksonAdapter.java
Outdated
Show resolved
Hide resolved
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment: |
/azp run java - core - ci |
Azure Pipelines successfully started running 1 pipeline(s). |
f01aaa6
to
b526cc5
Compare
/azp run java - core - ci |
Azure Pipelines successfully started running 1 pipeline(s). |
b526cc5
to
bdc8e72
Compare
@@ -32,6 +32,9 @@ | |||
<properties> | |||
<!-- Anomaly detector temporarily skipping code coverage until tests are added --> | |||
<jacoco.skip.coverage.check>true</jacoco.skip.coverage.check> | |||
<javaModulesSurefireArgLine> | |||
--add-exports com.azure.core/com.azure.core.implementation.jackson=ALL-UNNAMED |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What caused this to be needed? Was this a problem with getting an ObjectMapperShim
from azure-core
due to the lack of exporting of implementation
? If so, I'd love to look into adding a sample for SDK libraries on using ObjectMapperShim
which can help flush out any potential Java 9+ module scopes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So the issue here is somewhere between junit5 and surefire and seems like a bug. Junit test module has to have access to implementation.jackson
. Some context here junit-team/junit5#2147
Implementation.jackon
package is exported to management
and json-jackson
modules, so it's not available to junit module created. We have a similar configuration for other packages exported to a limited set of internal packages.
This has no effect on SDK jar being built - end-users don't need access to ObjectMapperShim
and serialization works.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a temporary fix until we export ObjectMapperShim from azure-core or do we need to do this for every library that has this issue?
@@ -32,6 +32,9 @@ | |||
<properties> | |||
<!-- Anomaly detector temporarily skipping code coverage until tests are added --> | |||
<jacoco.skip.coverage.check>true</jacoco.skip.coverage.check> | |||
<javaModulesSurefireArgLine> | |||
--add-exports com.azure.core/com.azure.core.implementation.jackson=ALL-UNNAMED |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a temporary fix until we export ObjectMapperShim from azure-core or do we need to do this for every library that has this issue?
sdk/core/azure-core/src/main/java/com/azure/core/implementation/jackson/ObjectMapperShim.java
Outdated
Show resolved
Hide resolved
sdk/core/azure-core/src/main/java/com/azure/core/util/serializer/JacksonAdapter.java
Outdated
Show resolved
Hide resolved
this is a temporary fix, it won't be needed if/when we expose ObjectMapperShim (or what's left of it). |
This change
azure-core-management
andazure-core-serializer-json-jackson
toObjectMapperShim
(with limited exposure to those modules).ObjectMapper
fromJacksonAdaper
and provides configuration methods, promoting SDKs to useJacksonAdapter
APIs directlyIt allows us to enable more resilient support for multiple Jackson versions and also have better diagnostics information in all core modules.
This is an intermediate step and not a final state of ObjectMapperShim API, next steps are: