Skip to content

Move binary serialization to EVCacheSerializingTranscoder Refactor #200

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
joegoogle123 merged 1 commit into from
Jul 9, 2026
Merged

Move binary serialization to EVCacheSerializingTranscoder Refactor #200

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
36 changes: 25 additions & 11 deletions evcache-core/src/main/java/com/netflix/evcache/EVCacheSerializingTranscoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@

import com.netflix.evcache.config.EVCacheTranscoderProperties;
import com.netflix.evcache.metrics.EVCacheMetricsFactory;
import com.netflix.evcache.pool.ServerGroup;
import com.netflix.evcache.pool.EVCacheValue;
import com.netflix.evcache.pool.EVCacheValueSerde;
import com.netflix.evcache.util.EVCacheConfig;
import com.netflix.spectator.api.BasicTag;
import com.netflix.spectator.api.Tag;
Expand All @@ -33,14 +34,11 @@
import net.spy.memcached.transcoders.BaseSerializingTranscoder;
import net.spy.memcached.transcoders.Transcoder;
import net.spy.memcached.transcoders.TranscoderUtils;
import net.spy.memcached.util.StringUtils;

import java.time.Duration;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;


Expand Down Expand Up @@ -70,7 +68,7 @@ public class EVCacheSerializingTranscoder extends BaseSerializingTranscoder impl
private final TranscoderUtils tu = new TranscoderUtils(true);
private Timer timer;

protected final EVCacheTranscoderProperties properties;
protected final EVCacheTranscoderProperties transcoderProperties;

/**
* Get a serializing transcoder with the default max data size.
Expand All @@ -83,20 +81,20 @@ public EVCacheSerializingTranscoder() {
* Get a serializing transcoder that specifies the max data size. Builds a default
* {@link EVCacheTranscoderProperties} bundle from
* {@link EVCacheConfig#getInstance()} — subclasses/callers that want per-app
* resolution should use {@link #EVCacheSerializingTranscoder(EVCacheTranscoderProperties, int)}.
* resolution should use {@link #EVCacheSerializingTranscoder(int, EVCacheTranscoderProperties)}.
*/
public EVCacheSerializingTranscoder(int max) {
this(new EVCacheTranscoderProperties(null, EVCacheConfig.getInstance().getPropertyRepository()), max);
this(max, new EVCacheTranscoderProperties(null, EVCacheConfig.getInstance().getPropertyRepository()));
}

/**
* Get a serializing transcoder with the supplied transcoder-property bundle. The bundle is
* exposed to subclasses via {@link #properties} so downstream transcoders can consult the
* same three-level (per-app → global → static default) resolution chain.
* exposed to subclasses via {@link #transcoderProperties} so downstream transcoders can consult
* the same three-level (per-app → global → static default) resolution chain.
*/
public EVCacheSerializingTranscoder(EVCacheTranscoderProperties properties, int max) {
public EVCacheSerializingTranscoder(int max, EVCacheTranscoderProperties properties) {
super(max);
this.properties = properties;
this.transcoderProperties = properties;
}

@Override
Expand Down Expand Up @@ -213,6 +211,22 @@ public CachedData encode(Object o) {
return new CachedData(flags, b, getMaxSize());
}

@Override
protected byte[] serialize(Object o) {
if (transcoderProperties.isBinarySerializationEnabled() && o instanceof EVCacheValue) {
return EVCacheValueSerde.serialize((EVCacheValue) o);
}
return super.serialize(o);
}

@Override
protected Object deserialize(byte[] in) {
if (EVCacheValueSerde.isBinaryFormat(in)) {
return EVCacheValueSerde.deserialize(in);
}
return super.deserialize(in);
}

private void updateTimerWithCompressionRatio(long ratio_percentage) {
if(timer == null) {
final List<Tag> tagList = new ArrayList<Tag>(1);
Expand Down
52 changes: 7 additions & 45 deletions evcache-core/src/main/java/com/netflix/evcache/EVCacheTranscoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
package com.netflix.evcache;

import com.netflix.evcache.config.EVCacheTranscoderProperties;
import com.netflix.evcache.pool.EVCacheValue;
import com.netflix.evcache.pool.EVCacheValueSerde;
import com.netflix.evcache.util.EVCacheConfig;

import net.spy.memcached.CachedData;

import static com.netflix.evcache.config.EVCacheTranscoderProperties.DEFAULT_COMPRESSION_THRESHOLD_BYTES;
import static com.netflix.evcache.config.EVCacheTranscoderProperties.DEFAULT_MAX_DATA_SIZE_BYTES;
import static com.netflix.evcache.config.EVCacheTranscoderProperties.Key.COMPRESSION_THRESHOLD_BYTES;
import static com.netflix.evcache.config.EVCacheTranscoderProperties.Key.MAX_DATA_SIZE_BYTES;

public class EVCacheTranscoder extends EVCacheSerializingTranscoder {

public EVCacheTranscoder() {
this(new EVCacheTranscoderProperties(null, EVCacheConfig.getInstance().getPropertyRepository()));
}

/**
* @param properties the transcoder property bundle.
* {@link EVCacheTranscoderProperties.Key#MAX_DATA_SIZE_BYTES} and
Expand All @@ -24,14 +20,7 @@ public class EVCacheTranscoder extends EVCacheSerializingTranscoder {
* rather than plumbed through further constructor arguments.
*/
public EVCacheTranscoder(EVCacheTranscoderProperties properties) {
this(properties.getProperty(MAX_DATA_SIZE_BYTES, Integer.class, DEFAULT_MAX_DATA_SIZE_BYTES).get(),
properties.getProperty(COMPRESSION_THRESHOLD_BYTES, Integer.class, DEFAULT_COMPRESSION_THRESHOLD_BYTES).get(),
properties
);
}

public EVCacheTranscoder() {
this(new EVCacheTranscoderProperties(null, EVCacheConfig.getInstance().getPropertyRepository()));
this(properties.getMaxDataSizeBytes(), properties.getCompressionThresholdBytes(), properties);
}

public EVCacheTranscoder(int max) {
Expand All @@ -43,44 +32,17 @@ public EVCacheTranscoder(int max, int compressionThreshold) {
}

private EVCacheTranscoder(int max, EVCacheTranscoderProperties properties) {
this(max, properties.getProperty(COMPRESSION_THRESHOLD_BYTES, Integer.class, DEFAULT_COMPRESSION_THRESHOLD_BYTES).get(), properties);
this(max, properties.getCompressionThresholdBytes(), properties);
}

private EVCacheTranscoder(int max, int compressionThreshold, EVCacheTranscoderProperties properties) {
super(properties, max);
super(max, properties);
setCompressionThreshold(compressionThreshold);
}

@Override
public boolean asyncDecode(CachedData d) {
return super.asyncDecode(d);
}

@Override
public Object decode(CachedData d) {
return super.decode(d);
}

@Override
public CachedData encode(Object o) {
if (o != null && o instanceof CachedData) return (CachedData) o;
return super.encode(o);
}

@Override
protected byte[] serialize(Object o) {
if (this.properties.isBinarySerializationEnabled() && o instanceof EVCacheValue) {
return EVCacheValueSerde.serialize((EVCacheValue) o);
}
return super.serialize(o);
}

@Override
protected Object deserialize(byte[] in) {
if (EVCacheValueSerde.isBinaryFormat(in)) {
return EVCacheValueSerde.deserialize(in);
}
return super.deserialize(in);
}

}
37 changes: 21 additions & 16 deletions evcache-core/src/main/java/com/netflix/evcache/config/EVCacheTranscoderProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
import com.netflix.archaius.api.Property;
import com.netflix.archaius.api.PropertyRepository;

import static com.netflix.evcache.config.EVCacheTranscoderProperties.Key.BINARY_SERIALIZATION_ENABLED;

/**
* Properties related to {@link com.netflix.evcache.EVCacheTranscoder}
* behavior.
Expand All @@ -18,8 +16,9 @@
* </ol>
*
* <p>
* Static properties should be cached as a field for fast access.
* Dynamic properties get be accessed {@link #getProperty(Key, Class, Object)}
* Static properties are snapshotted as primitive fields for fast access. Dynamic fields

@shy-1234 shy-1234 Jul 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not a blocker since it's the original behavior, but just curious how much overhead would it be to also make those static properties dynamic? (I think the dynamic values are also cached?)

@joegoogle123 joegoogle123 Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

There are two fields that where static e.g max and compressionThreshold which I don't think we can make dynamic.

There is a new field to binarySerializationEnabled which we could make dynamic but I did not measure the overhead of dynamically checking this property.

* are exposed as {@link Property} accessors so callers see live FP updates on every
* {@code .get()}.
*
*/
public final class EVCacheTranscoderProperties {
Expand All @@ -43,9 +42,10 @@ public enum Key {
}

private final String appName;
private final PropertyRepository propertyRepository;

private final boolean binarySerializationEnabled;
private final int maxDataSizeBytes;
private final int compressionThresholdBytes;

/**
* Construct the bundle and snapshot every property via the three-level resolution chain.
Expand All @@ -61,24 +61,29 @@ public enum Key {
*/
public EVCacheTranscoderProperties(String appName, PropertyRepository propertyRepository) {
this.appName = appName;
this.propertyRepository = propertyRepository;

this.binarySerializationEnabled = getProperty(appName, propertyRepository,
BINARY_SERIALIZATION_ENABLED, Boolean.class, DEFAULT_BINARY_SERIALIZATION_ENABLED).get();
Key.BINARY_SERIALIZATION_ENABLED, Boolean.class, DEFAULT_BINARY_SERIALIZATION_ENABLED).get();
this.maxDataSizeBytes = getProperty(appName, propertyRepository,
Key.MAX_DATA_SIZE_BYTES, Integer.class, DEFAULT_MAX_DATA_SIZE_BYTES).get();
this.compressionThresholdBytes = getProperty(appName, propertyRepository,
Key.COMPRESSION_THRESHOLD_BYTES, Integer.class, DEFAULT_COMPRESSION_THRESHOLD_BYTES).get();
}

public String getAppName() {
return appName;
}

public boolean isBinarySerializationEnabled() {
return binarySerializationEnabled;
}

/**
* Resolve the Archaius {@link Property} handle for the given key. Callers should hold the
* handle (as a final field, typically) and invoke {@link Property#get()} when they need the
* current value; every {@code .get()} re-reads through the same per-app → global → static-default
* chain, so live FP updates propagate without re-resolving. Returning the handle rather than
* the resolved value makes it obvious that this is a dynamic property, not a static snapshot.
*/
public <T> Property<T> getProperty(Key key, Class<T> type, T defaultValue) {
return getProperty(appName, propertyRepository, key, type, defaultValue);
public int getMaxDataSizeBytes() {
return maxDataSizeBytes;
}

public int getCompressionThresholdBytes() {
return compressionThresholdBytes;
}

private static <T> Property<T> getProperty(String appName, PropertyRepository propertyRepository,
Expand Down
4 changes: 3 additions & 1 deletion evcache-core/src/main/java/com/netflix/evcache/connection/BaseAsciiConnectionFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

import com.netflix.archaius.api.Property;
import com.netflix.evcache.EVCacheTranscoder;
import com.netflix.evcache.config.EVCacheTranscoderProperties;
import com.netflix.evcache.operation.EVCacheAsciiOperationFactory;
import com.netflix.evcache.pool.EVCacheClient;
import com.netflix.evcache.pool.EVCacheClientPool;
Expand Down Expand Up @@ -115,7 +116,8 @@ public BlockingQueue<Operation> createWriteOperationQueue() {
}

public Transcoder<Object> getDefaultTranscoder() {
return new EVCacheTranscoder();
return new EVCacheTranscoder(new EVCacheTranscoderProperties(appName,
client.getPool().getEVCacheClientPoolManager().getEVCacheConfig().getPropertyRepository()));
}

public FailureMode getFailureMode() {
Expand Down
4 changes: 3 additions & 1 deletion evcache-core/src/main/java/com/netflix/evcache/connection/BaseConnectionFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

import com.netflix.archaius.api.Property;
import com.netflix.evcache.EVCacheTranscoder;
import com.netflix.evcache.config.EVCacheTranscoderProperties;
import com.netflix.evcache.pool.EVCacheClient;
import com.netflix.evcache.pool.EVCacheClientPool;
import com.netflix.evcache.pool.EVCacheClientPoolManager;
Expand Down Expand Up @@ -109,7 +110,8 @@ public BlockingQueue<Operation> createWriteOperationQueue() {
}

public Transcoder<Object> getDefaultTranscoder() {
return new EVCacheTranscoder();
return new EVCacheTranscoder(new EVCacheTranscoderProperties(appName,
client.getPool().getEVCacheClientPoolManager().getEVCacheConfig().getPropertyRepository()));
}

public FailureMode getFailureMode() {
Expand Down
36 changes: 24 additions & 12 deletions evcache-core/src/test/java/com/netflix/evcache/config/EVCacheTranscoderPropertiesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
package com.netflix.evcache.config;

import static com.netflix.evcache.config.EVCacheTranscoderProperties.Key.COMPRESSION_THRESHOLD_BYTES;
import static com.netflix.evcache.config.EVCacheTranscoderProperties.Key.MAX_DATA_SIZE_BYTES;
import static org.assertj.core.api.Assertions.assertThat;

import com.netflix.archaius.DefaultPropertyFactory;
Expand Down Expand Up @@ -83,7 +81,7 @@ public void maxDataSize_perAppOverrideWins() {
cfg.setProperty(MAX_DATA_SIZE_PER_APP_KEY, "12345");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(cfg));
assertThat(props.getProperty(MAX_DATA_SIZE_BYTES, Integer.class, 999).get()).isEqualTo(12345);
assertThat(props.getMaxDataSizeBytes()).isEqualTo(12345);
}

@Test
Expand All @@ -92,13 +90,13 @@ public void maxDataSize_globalFallbackWhenPerAppUnset() {
cfg.setProperty(MAX_DATA_SIZE_GLOBAL_KEY, "12345");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(cfg));
assertThat(props.getProperty(MAX_DATA_SIZE_BYTES, Integer.class, 999).get()).isEqualTo(12345);
assertThat(props.getMaxDataSizeBytes()).isEqualTo(12345);
}

@Test
public void maxDataSize_staticDefaultWhenBothUnset() {
EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(new DefaultSettableConfig()));
assertThat(props.getProperty(MAX_DATA_SIZE_BYTES, Integer.class, 999).get()).isEqualTo(999);
assertThat(props.getMaxDataSizeBytes()).isEqualTo(EVCacheTranscoderProperties.DEFAULT_MAX_DATA_SIZE_BYTES);
}

@Test
Expand All @@ -108,7 +106,7 @@ public void maxDataSize_perAppBeatsGlobal() {
cfg.setProperty(MAX_DATA_SIZE_GLOBAL_KEY, "222");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(cfg));
assertThat(props.getProperty(MAX_DATA_SIZE_BYTES, Integer.class, 999).get()).isEqualTo(111);
assertThat(props.getMaxDataSizeBytes()).isEqualTo(111);
}

@Test
Expand All @@ -117,7 +115,7 @@ public void maxDataSize_nullAppNameUsesGlobalKey() {
cfg.setProperty(MAX_DATA_SIZE_GLOBAL_KEY, "12345");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(null, repo(cfg));
assertThat(props.getProperty(MAX_DATA_SIZE_BYTES, Integer.class, 999).get()).isEqualTo(12345);
assertThat(props.getMaxDataSizeBytes()).isEqualTo(12345);
}

// ---- COMPRESSION_THRESHOLD ----
Expand All @@ -128,7 +126,7 @@ public void compressionThreshold_perAppOverrideWins() {
cfg.setProperty(COMPRESSION_PER_APP_KEY, "512");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(cfg));
assertThat(props.getProperty(COMPRESSION_THRESHOLD_BYTES, Integer.class, 999).get()).isEqualTo(512);
assertThat(props.getCompressionThresholdBytes()).isEqualTo(512);
}

@Test
Expand All @@ -137,13 +135,13 @@ public void compressionThreshold_globalFallbackWhenPerAppUnset() {
cfg.setProperty(COMPRESSION_GLOBAL_KEY, "512");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(cfg));
assertThat(props.getProperty(COMPRESSION_THRESHOLD_BYTES, Integer.class, 999).get()).isEqualTo(512);
assertThat(props.getCompressionThresholdBytes()).isEqualTo(512);
}

@Test
public void compressionThreshold_staticDefaultWhenBothUnset() {
EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(new DefaultSettableConfig()));
assertThat(props.getProperty(COMPRESSION_THRESHOLD_BYTES, Integer.class, 999).get()).isEqualTo(999);
assertThat(props.getCompressionThresholdBytes()).isEqualTo(EVCacheTranscoderProperties.DEFAULT_COMPRESSION_THRESHOLD_BYTES);
}

@Test
Expand All @@ -153,7 +151,7 @@ public void compressionThreshold_perAppBeatsGlobal() {
cfg.setProperty(COMPRESSION_GLOBAL_KEY, "222");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(cfg));
assertThat(props.getProperty(COMPRESSION_THRESHOLD_BYTES, Integer.class, 999).get()).isEqualTo(111);
assertThat(props.getCompressionThresholdBytes()).isEqualTo(111);
}

@Test
Expand All @@ -162,6 +160,20 @@ public void compressionThreshold_nullAppNameUsesGlobalKey() {
cfg.setProperty(COMPRESSION_GLOBAL_KEY, "512");

EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(null, repo(cfg));
assertThat(props.getProperty(COMPRESSION_THRESHOLD_BYTES, Integer.class, 999).get()).isEqualTo(512);
assertThat(props.getCompressionThresholdBytes()).isEqualTo(512);
}

// ---- appName ----

@Test
public void appName_isExposedForSubclassLookups() {
EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(APP, repo(new DefaultSettableConfig()));
assertThat(props.getAppName()).isEqualTo(APP);
}

@Test
public void appName_nullPropagates() {
EVCacheTranscoderProperties props = new EVCacheTranscoderProperties(null, repo(new DefaultSettableConfig()));
assertThat(props.getAppName()).isNull();
}
}
Loading