Skip to content

ContractVerifierObjectMapper - special support for Avro #2405

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

Open
etrandafir93 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

ContractVerifierObjectMapper - special support for Avro #2405

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a66f03e
reproduce the issue
etrandafir93 Jan 11, 2026
558624b
ignore avro-specific fields if avro is in the classpath
etrandafir93 Jan 17, 2026
a74018f
code review
etrandafir93 Jan 17, 2026
bea662f
code review
etrandafir93 Jan 21, 2026
db8f868
remove reflection code
etrandafir93 Jan 22, 2026
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
12 changes: 12 additions & 0 deletions spring-cloud-contract-verifier/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,18 @@
<artifactId>spring-boot-resttestclient</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.avro</groupId>
<artifactId>avro</artifactId>
<version>1.12.1</version>
Copy link
Contributor

@marcingrzejszczak marcingrzejszczak Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this to a property

Copy link
Author

@etrandafir93 etrandafir93 Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed now 👌🏼

<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.avro</groupId>
<artifactId>avro</artifactId>
<version>1.12.1</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
Expand Down
32 changes: 27 additions & 5 deletions ...ingframework/cloud/contract/verifier/messaging/internal/ContractVerifierObjectMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,27 @@

package org.springframework.cloud.contract.verifier.messaging.internal;

import org.springframework.util.ClassUtils;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

import tools.jackson.databind.json.JsonMapper;

/**
* Wrapper over {@link JsonMapper} that won't try to parse String but will directly return
* it.
*
* @author Marcin Grzejszczak
*/
public class ContractVerifierObjectMapper {

private final JsonMapper objectMapper;

public ContractVerifierObjectMapper(JsonMapper objectMapper) {
this.objectMapper = objectMapper;
public ContractVerifierObjectMapper() {
this(new JsonMapper());
}

public ContractVerifierObjectMapper() {
this.objectMapper = new JsonMapper();
public ContractVerifierObjectMapper(JsonMapper mapper) {
this.objectMapper = usesAvro() ? ignoreAvroFields(mapper) : mapper;
Copy link
Contributor

@marcingrzejszczak marcingrzejszczak Jan 18, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering about one thing though. Now we have Avro. What if in the future we will need to support more things? I don't like that we're leaking Avro in this class.

I think this code should be moved to NoOpContractVerifierAutoConfiguration and have a conditional on class there, where in case of avro being present would create a proper ContractVerifierObjectMapper.

WDYT?

Copy link
Author

@etrandafir93 etrandafir93 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marcingrzejszczak yes, it makes sense. I've re-arranged things a bit, now.
Can you please take a look?

}

public String writeValueAsString(Object payload) {
Expand All @@ -56,4 +59,23 @@ else if (payload instanceof byte[]) {
return this.objectMapper.writeValueAsBytes(payload);
}

private static boolean usesAvro() {
return ClassUtils.isPresent("org.apache.avro.specific.SpecificRecordBase", null);
}

private static JsonMapper ignoreAvroFields(JsonMapper mapper) {
try {
return mapper.rebuild().addMixIn(
ClassUtils.forName("org.apache.avro.specific.SpecificRecordBase",
null), IgnoreAvroMixin.class).build();
}
catch (ClassNotFoundException e) {
throw new RuntimeException(e);
}
}

@JsonIgnoreProperties({ "schema", "specificData", "classSchema", "conversion" })
interface IgnoreAvroMixin {
}

}
9 changes: 9 additions & 0 deletions ...mework/cloud/contract/verifier/messaging/internal/ContractVerifierObjectMapperSpec.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ class ContractVerifierObjectMapperSpec extends Specification {
result == '''{"foo":"bar"}'''
}

def "should convert an Avro-generated object into a json representation"() {
given:
FooAvro input = FooAvro.newBuilder().setFooAvro("barAvro").build()
when:
String result = mapper.writeValueAsString(input)
then:
result == '''{"fooAvro":"barAvro"}'''
}

def "should convert bytes into a json representation"() {
given:
String input = '''{"foo":"bar"}'''
Expand Down
Loading