Skip to content
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

MAINT: allow latest schema version if not specified in confluent schema #4453

Merged
merged 1 commit into from
Apr 24, 2024
Merged

MAINT: allow latest schema version if not specified in confluent schema #4453

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
31 changes: 25 additions & 6 deletions .../dataprepper/plugins/kafka/source/ConfluentKafkaProducerConsumerWithSchemaRegistryIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ public void setup() {
jsonSourceConfig = mock(KafkaSourceConfig.class);
avroSourceConfig = mock(KafkaSourceConfig.class);
pluginMetrics = mock(PluginMetrics.class);
pluginConfigObservable = mock(PluginConfigObservable.class);
Random random = new Random();
testId = random.nextInt();
testValue = random.nextDouble();
Expand Down Expand Up @@ -251,12 +252,21 @@ public void setup() {
}

@Test
public void KafkaJsonProducerConsumerTest() {
public void KafkaJsonProducerConsumerTestWithSpecifiedSchemaVersion() {
when(schemaConfig.getVersion()).thenReturn(2);
produceJsonRecords(bootstrapServers, numRecordsProduced);
consumeRecords(bootstrapServers, jsonSourceConfig);
await().atMost(Duration.ofSeconds(20)).
untilAsserted(() -> assertThat(numRecordsReceived.get(), equalTo(numRecordsProduced)));
produceJsonRecords(bootstrapServers, numRecordsProduced);
consumeRecords(bootstrapServers, jsonSourceConfig);
await().atMost(Duration.ofSeconds(20)).
untilAsserted(() -> assertThat(numRecordsReceived.get(), equalTo(numRecordsProduced)));
}

@Test
public void KafkaJsonProducerConsumerTestWithLatestSchemaVersion() {
when(schemaConfig.getVersion()).thenReturn(null);
produceJsonRecords(bootstrapServers, numRecordsProduced);
consumeRecords(bootstrapServers, jsonSourceConfig);
await().atMost(Duration.ofSeconds(20)).
untilAsserted(() -> assertThat(numRecordsReceived.get(), equalTo(numRecordsProduced)));
}

public void consumeRecords(String servers, KafkaSourceConfig sourceConfig) {
Expand Down Expand Up @@ -293,14 +303,23 @@ public void produceJsonRecords(String servers, int numRecords) throws Serializat


@Test
public void KafkaAvroProducerConsumerTest() {
public void KafkaAvroProducerConsumerTestWithSpecifiedSchemaVersion() {
when(schemaConfig.getVersion()).thenReturn(1);
produceAvroRecords(bootstrapServers, numRecordsProduced);
consumeRecords(bootstrapServers, avroSourceConfig);
await().atMost(Duration.ofSeconds(20)).
untilAsserted(() -> assertThat(numRecordsReceived.get(), equalTo(numRecordsProduced)));
}

@Test
public void KafkaAvroProducerConsumerTestWithLatestSchemaVersion() {
when(schemaConfig.getVersion()).thenReturn(null);
produceAvroRecords(bootstrapServers, numRecordsProduced);
consumeRecords(bootstrapServers, avroSourceConfig);
await().atMost(Duration.ofSeconds(20)).
untilAsserted(() -> assertThat(numRecordsReceived.get(), equalTo(numRecordsProduced)));
}

public void produceAvroRecords(String servers, int numRecords) throws SerializationException {
Properties properties = new Properties();
properties.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, servers);
Expand Down
4 changes: 2 additions & 2 deletions ...ns/src/main/java/org/opensearch/dataprepper/plugins/kafka/configuration/SchemaConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public class SchemaConfig {
private String registryURL;

@JsonProperty("version")
private int version;
private Integer version;

@JsonAlias("schema_registry_api_key")
@JsonProperty("api_key")
Expand Down Expand Up @@ -103,7 +103,7 @@ public String getRegistryURL() {
return registryURL;
}

public int getVersion() {
public Integer getVersion() {
return version;
}

Expand Down
10 changes: 8 additions & 2 deletions ...in/java/org/opensearch/dataprepper/plugins/kafka/consumer/KafkaCustomConsumerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,9 +218,15 @@ private void setPropertiesForSchemaType(final KafkaConsumerConfig kafkaConsumerC
properties.put(KafkaAvroDeserializerConfig.AUTO_REGISTER_SCHEMAS, false);
final CachedSchemaRegistryClient schemaRegistryClient = new CachedSchemaRegistryClient(properties.getProperty(KafkaAvroDeserializerConfig.SCHEMA_REGISTRY_URL_CONFIG),
100, propertyMap);
final SchemaConfig schemaConfig = kafkaConsumerConfig.getSchemaConfig();
try {
schemaType = schemaRegistryClient.getSchemaMetadata(topic.getName() + "-value",
kafkaConsumerConfig.getSchemaConfig().getVersion()).getSchemaType();
final String subject = topic.getName() + "-value";
if (schemaConfig.getVersion() != null) {
schemaType = schemaRegistryClient.getSchemaMetadata(subject,
kafkaConsumerConfig.getSchemaConfig().getVersion()).getSchemaType();
} else {
schemaType = schemaRegistryClient.getLatestSchemaMetadata(subject).getSchemaType();
}
} catch (IOException | RestClientException e) {
LOG.error("Failed to connect to the schema registry...");
throw new RuntimeException(e);
Expand Down
10 changes: 8 additions & 2 deletions ...ka-plugins/src/main/java/org/opensearch/dataprepper/plugins/kafka/source/KafkaSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,9 +293,15 @@ private void setPropertiesForSchemaType(Properties properties, TopicConfig topic
properties.put("auto.register.schemas", false);
schemaRegistryClient = new CachedSchemaRegistryClient(getSchemaRegistryUrl(),
100, propertyMap);
final SchemaConfig schemaConfig = sourceConfig.getSchemaConfig();
Copy link
Member

Choose a reason for hiding this comment

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

Can we combine this code with the code above?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I believe it has been attempted by myself and others to use KafkaCustomConsumerFactory here but there has been some subtleties. Tracked in a separate issue: #4456

try {
schemaType = schemaRegistryClient.getSchemaMetadata(topic.getName() + "-value",
sourceConfig.getSchemaConfig().getVersion()).getSchemaType();
final String subject = topic.getName() + "-value";
if (schemaConfig.getVersion() != null) {
schemaType = schemaRegistryClient.getSchemaMetadata(subject,
schemaConfig.getVersion()).getSchemaType();
} else {
schemaType = schemaRegistryClient.getLatestSchemaMetadata(subject).getSchemaType();
}
} catch (IOException | RestClientException e) {
LOG.error("Failed to connect to the schema registry...");
throw new RuntimeException(e);
Expand Down
Loading