Add Zstd support for EVCache by janewang1680 · Pull Request #197 · Netflix/EVCache

janewang1680 · 2026-06-10T23:13:42Z

Summary
Add pluggable compression algorithm support (gzip, zstd) via a new CompressionAlgorithm enum on EVCacheSerializingTranscoder, with magic-byte auto-detection on decode so existing gzip-compressed cache entries
continue to decode correctly. Algorithm and zstd level are configurable via two new fast properties:
default.evcache.compression.algorithm (default GZIP)
default.evcache.compression.zstd.level (default 3)
Fix a pre-existing bug in the compression ratio metric where compressed.length / b.length always evaluated to 1.0 because b was reassigned to compressed before the ratio calculation. The metric now uses the
captured originalLength, producing accurate ratios.
Test plan
./gradlew :evcache-core:test --tests "com.netflix.evcache.EVCacheSerializingTranscoderTest" — 17 tests covering enum values, default constructor, gzip/zstd round-trip, cross-decode (gzip-written read by zstd
transcoder and vice versa), and FP wiring.
Verify backward compatibility: data written with gzip in production decodes correctly after deploy.
Verify compression ratio metric (COMPRESSION_RATIO timer) reports realistic ratios (not always ~100%) in a canary.
Verify it works in our internal services

srrangarajan · 2026-06-22T16:43:29Z

@shy-1234 can you also review the PR please

…nscoderProperties Today EVCacheImpl reads the binary-serialization FastProperty inline: ```java final boolean useBinarySerialization = propertyRepository.get(_appName + ".envelope.binary.serialization.enabled", Boolean.class) .orElseGet("evcache.envelope.binary.serialization.enabled").orElse(false).get(); this.evcacheValueTranscoder = new EVCacheTranscoder(maxValueSize, ENVELOPE_COMPRESSION_DISABLED, useBinarySerialization); ``` This change introduces an EVCacheTranscoderProperties bundle that owns the read and exposes the result behind a typed accessor. Each property follows a uniform three-level resolution chain: 1. <appName>.<appSuffix> (per-app override) 2. <globalKey> (fleet-wide global) 3. compiled-in static default Today the bundle holds exactly one property — USE_BINARY_SERIALIZATION, appSuffix `binary.serialization.enabled`, globalKey `default.evcache.binary.serialization.enabled`. The Key enum is the extension point: new transcoder properties land here and inherit the same chain without touching the call sites. EVCacheTranscoder gains a (int, int, EVCacheTranscoderProperties) ctor that stores the bundle and consults `properties.isBinarySerializationEnabled()` inside `serialize()`. The old (int, int, boolean) ctor is gone; the 2-arg (int, int) ctor constructs a properties object with appName=null so the no-app callers naturally fall through to the global key. EVCacheImpl drops the inline read and the ENVELOPE_COMPRESSION_DISABLED constant, building the bundle once per app. NOTE on property key naming: the global key changed from `evcache.envelope.binary.serialization.enabled` to `default.evcache.binary.serialization.enabled`, matching the `default.evcache.…` convention used by the other transcoder properties. The per-app suffix is `binary.serialization.enabled` (no `envelope.` prefix). Any caller who set the old global key will need to migrate. Future fields that need runtime-dynamic reads can call the bundle's `getProperty(Key, Class, default)` method instead of caching at construction. PR #197's setCompressionAlgorithmProperty / setCompressionLevelProperty setters on EVCacheSerializingTranscoder are orthogonal and untouched here. Tests: 5 new tests in EVCacheTranscoderPropertiesTest cover per-app override, global fallback, static default, per-app-beats-global precedence, and null-appName routing to the global key. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Move compression algorithm/level resolution into EVCacheTranscoderProperties so the transcoder holds live Property handles resolved through the standard per-app -> global -> static-default chain (keys: compression.algorithm, compression.zstd.level). Simplifies EVCacheSerializingTranscoder/EVCacheTranscoder plumbing and removes the ad-hoc getProperty overloads and setters. Harden algorithm parsing: an unrecognized FP value (e.g. a typo) previously resolved to null and NPE'd the compression switch at encode time. It now warn-logs and falls back to DEFAULT_COMPRESSION_ALGORITHM (GZIP), so a bad fast-property degrades instead of taking down writes. Tests: rewrite EVCacheSerializingTranscoderTest and EVCacheTranscoderPropertiesTest against the new property-bundle API; add coverage for three-level resolution of the two new keys, case-insensitivity, live FP updates, the compression-grew-data branch, and the unrecognized-algorithm fallback. Remove redundant duplicate tests. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

srrangarajan · 2026-07-06T18:30:50Z

LGTM

shy-1234

LGTM. Please also get a +1 from @joegoogle123 and I think we are good to go.

Add Zstd support for EVCache

f02390e

srrangarajan had a problem deploying to Publish June 10, 2026 23:38 — with GitHub Actions Failure

srrangarajan temporarily deployed to Publish June 10, 2026 23:38 — with GitHub Actions Inactive

Jane Wang added 2 commits June 10, 2026 22:17

change to use dynamic property

a745906

use per appName property

dc33926

janewang1680 had a problem deploying to Publish June 11, 2026 16:56 — with GitHub Actions Error

use info

ad44ed0

srrangarajan had a problem deploying to Publish June 11, 2026 17:08 — with GitHub Actions Error

change logger

78960f3

srrangarajan temporarily deployed to Publish June 11, 2026 18:43 — with GitHub Actions Inactive

srrangarajan had a problem deploying to Publish June 11, 2026 18:43 — with GitHub Actions Failure

suse poolManager.getEVCacheConfig().getPropertyRepository()

1c4c263

srrangarajan temporarily deployed to Publish June 12, 2026 16:28 — with GitHub Actions Inactive

srrangarajan had a problem deploying to Publish June 12, 2026 16:28 — with GitHub Actions Failure

replace deprecated code

5e90561

srrangarajan temporarily deployed to Publish June 12, 2026 21:35 — with GitHub Actions Inactive

srrangarajan had a problem deploying to Publish June 12, 2026 21:35 — with GitHub Actions Failure

janewang1680 requested review from freerum and srrangarajan June 12, 2026 22:04

srrangarajan reviewed Jun 18, 2026

View reviewed changes

Comment thread evcache-core/src/main/java/com/netflix/evcache/EVCacheSerializingTranscoder.java Outdated