Skip to content

Log usage of MetadataEncoderService #3943

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

Merged
merged 4 commits into from
Oct 14, 2025
Merged

Log usage of MetadataEncoderService #3943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ab1be61
Log usage of MetadataEncoderService
GunalKupta Oct 13, 2025
61018dd
use a cache update handler
GunalKupta Oct 13, 2025
f00eb74
fix assertions
GunalKupta Oct 13, 2025
6724e3b
checkstyle
GunalKupta Oct 13, 2025
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
27 changes: 26 additions & 1 deletion ...c/main/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.BiFunction;
import java.util.stream.Collectors;

import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.config.types.Password;
import org.apache.kafka.common.serialization.Serde;
import org.apache.kafka.common.serialization.Serdes.StringSerde;
Expand Down Expand Up @@ -96,7 +98,8 @@
}
String topic = config.getString(SchemaRegistryConfig.METADATA_ENCODER_TOPIC_CONFIG);
this.keyTemplate = KeyTemplates.get(KEY_TEMPLATE_NAME);
this.encoders = createCache(new StringSerde(), new KeysetWrapperSerde(config), topic, null);
this.encoders = createCache(new StringSerde(), new KeysetWrapperSerde(config), topic,
new TenantCacheUpdateHandler());
} catch (Exception e) {
throw new IllegalArgumentException("Could not instantiate MetadataEncoderService", e);
}
Expand Down Expand Up @@ -392,4 +395,26 @@
}
}
}

/**
* Cache update handler that logs tenant (key) updates to the encoder cache.
*/
private static class TenantCacheUpdateHandler
implements CacheUpdateHandler<String, KeysetWrapper> {

@Override
public void handleUpdate(String tenant, KeysetWrapper newValue, KeysetWrapper oldValue,
TopicPartition tp, long offset, long timestamp) {
if (oldValue == null) {
log.info("Encoder cache update: new tenant '{}' added (partition={}, offset={}, "
+ "timestamp={})", tenant, tp.partition(), offset, timestamp);

Check failure on line 410 in core/src/main/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderService.java

View check run for this annotation

SonarQube-Confluent / schema-registry Sonarqube Results

core/src/main/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderService.java#L410 

Define a constant instead of duplicating this literal "timestamp={})" 3 times.
} else if (newValue == null) {
log.info("Encoder cache update: tenant '{}' removed (partition={}, offset={}, "
+ "timestamp={})", tenant, tp.partition(), offset, timestamp);
} else {
log.info("Encoder cache update: tenant '{}' updated (partition={}, offset={}, "
+ "timestamp={})", tenant, tp.partition(), offset, timestamp);
}
}
}
}
10 changes: 6 additions & 4 deletions ...st/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,29 @@
encoderService.init();

Map<String, String> properties = new HashMap<>();
properties.put("nonsensitive", "foo");

Check failure on line 52 in core/src/test/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderServiceTest.java

View check run for this annotation

SonarQube-Confluent / schema-registry Sonarqube Results

core/src/test/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderServiceTest.java#L52 

Define a constant instead of duplicating this literal "nonsensitive" 3 times.
properties.put("sensitive", "foo");

Check failure on line 53 in core/src/test/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderServiceTest.java

View check run for this annotation

SonarQube-Confluent / schema-registry Sonarqube Results

core/src/test/java/io/confluent/kafka/schemaregistry/storage/encoder/MetadataEncoderServiceTest.java#L53 

Define a constant instead of duplicating this literal "sensitive" 4 times.
Metadata metadata = new Metadata(null, properties, Collections.singleton("sensitive"));

SchemaValue schema = new SchemaValue(
"mysubject", null, null, null, null, null,
new io.confluent.kafka.schemaregistry.storage.Metadata(metadata), null, "true", false);
encoderService.encodeMetadata(schema);
assertEquals(schema.getMetadata().getProperties().get("nonsensitive"), "foo");
assertEquals("foo", schema.getMetadata().getProperties().get("nonsensitive"));
// the value of "sensitive" is encrypted
assertNotEquals(schema.getMetadata().getProperties().get("sensitive"), "foo");
assertNotEquals("foo", schema.getMetadata().getProperties().get("sensitive"));
assertNotNull(schema.getMetadata().getProperties().get(SchemaValue.ENCODED_PROPERTY));

SchemaValue schema2 = new SchemaValue(
"mysubject", null, null, null, null, null,
new io.confluent.kafka.schemaregistry.storage.Metadata(
schema.getMetadata().toMetadataEntity()), null, "true", false);
encoderService.decodeMetadata(schema2);
assertEquals(schema2.getMetadata().getProperties().get("nonsensitive"), "foo");
assertEquals("foo", schema2.getMetadata().getProperties().get("nonsensitive"));
// the value of "sensitive" is decrypted
assertEquals(schema2.getMetadata().getProperties().get("sensitive"), "foo");
assertEquals("foo", schema2.getMetadata().getProperties().get("sensitive"));
assertNull(schema2.getMetadata().getProperties().get(SchemaValue.ENCODED_PROPERTY));

encoderService.close();
}
}