Skip to content

KAFKA-20798: Add readOnly(IsolationLevel) to TimestampedWindowStoreWithHeaders and SessionStoreWithHeaders #22806

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
bbejeck merged 4 commits into from
Jul 14, 2026
Merged

KAFKA-20798: Add readOnly(IsolationLevel) to TimestampedWindowStoreWithHeaders and SessionStoreWithHeaders #22806

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
0da3fc6
let metered store's readonly override with headeraware
lucliu1108 Jul 10, 2026
1811b62
revise naming inconsistency for ReadOnlyHeadersView
lucliu1108 Jul 10, 2026
a81cc40
clean up comments
lucliu1108 Jul 12, 2026
cb10d35
adjust import order
lucliu1108 Jul 13, 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
97 changes: 97 additions & 0 deletions ...rc/main/java/org/apache/kafka/streams/state/internals/MeteredSessionStoreWithHeaders.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*/
package org.apache.kafka.streams.state.internals;

import org.apache.kafka.common.IsolationLevel;
import org.apache.kafka.common.header.Headers;
import org.apache.kafka.common.header.internals.RecordHeaders;
import org.apache.kafka.common.serialization.Serde;
Expand All @@ -35,6 +36,7 @@
import org.apache.kafka.streams.query.internals.InternalQueryResultUtil;
import org.apache.kafka.streams.state.AggregationWithHeaders;
import org.apache.kafka.streams.state.KeyValueIterator;
import org.apache.kafka.streams.state.ReadOnlySessionStore;
import org.apache.kafka.streams.state.SessionStore;
import org.apache.kafka.streams.state.SessionStoreWithHeaders;

Expand Down Expand Up @@ -360,6 +362,101 @@ private <R> QueryResult<R> runRangeQuery(
return queryResult;
}

@Override
public ReadOnlySessionStore<K, AggregationWithHeaders<AGG>> readOnly(final IsolationLevel isolationLevel) {
Objects.requireNonNull(isolationLevel, "isolationLevel cannot be null");
return new ReadOnlyHeadersView(wrapped().readOnly(isolationLevel));
}

private final class ReadOnlyHeadersView implements ReadOnlySessionStore<K, AggregationWithHeaders<AGG>> {

private final ReadOnlySessionStore<Bytes, byte[]> underlying;

ReadOnlyHeadersView(final ReadOnlySessionStore<Bytes, byte[]> underlying) {
this.underlying = underlying;
}

@Override
public AggregationWithHeaders<AGG> fetchSession(
final K key, final long earliestSessionEndTime, final long latestSessionStartTime) {
Objects.requireNonNull(key, "key cannot be null");
return maybeMeasureLatency(
() -> deserializeValue(underlying.fetchSession(
serializeKey(key, internalContext.headers()), earliestSessionEndTime, latestSessionStartTime)),
time,
fetchSensor
);
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> fetch(final K key) {
Objects.requireNonNull(key, "key cannot be null");
return new MeteredSessionStoreWithHeadersIterator(underlying.fetch(serializeKey(key, internalContext.headers())));
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> backwardFetch(final K key) {
Objects.requireNonNull(key, "key cannot be null");
return new MeteredSessionStoreWithHeadersIterator(underlying.backwardFetch(serializeKey(key, internalContext.headers())));
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> fetch(final K keyFrom, final K keyTo) {
return new MeteredSessionStoreWithHeadersIterator(
underlying.fetch(serializeKey(keyFrom, internalContext.headers()), serializeKey(keyTo, internalContext.headers()))
);
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> backwardFetch(final K keyFrom, final K keyTo) {
return new MeteredSessionStoreWithHeadersIterator(
underlying.backwardFetch(serializeKey(keyFrom, internalContext.headers()), serializeKey(keyTo, internalContext.headers()))
);
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> findSessions(
final K key, final long earliestSessionEndTime, final long latestSessionStartTime) {
Objects.requireNonNull(key, "key cannot be null");
return new MeteredSessionStoreWithHeadersIterator(
underlying.findSessions(serializeKey(key, internalContext.headers()), earliestSessionEndTime, latestSessionStartTime)
);
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> backwardFindSessions(
final K key, final long earliestSessionEndTime, final long latestSessionStartTime) {
Objects.requireNonNull(key, "key cannot be null");
return new MeteredSessionStoreWithHeadersIterator(
underlying.backwardFindSessions(serializeKey(key, internalContext.headers()), earliestSessionEndTime, latestSessionStartTime)
);
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> findSessions(
final K keyFrom, final K keyTo, final long earliestSessionEndTime, final long latestSessionStartTime) {
return new MeteredSessionStoreWithHeadersIterator(
underlying.findSessions(
serializeKey(keyFrom, internalContext.headers()),
serializeKey(keyTo, internalContext.headers()),
earliestSessionEndTime,
latestSessionStartTime)
);
}

@Override
public KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>> backwardFindSessions(
final K keyFrom, final K keyTo, final long earliestSessionEndTime, final long latestSessionStartTime) {
return new MeteredSessionStoreWithHeadersIterator(
underlying.backwardFindSessions(
serializeKey(keyFrom, internalContext.headers()),
serializeKey(keyTo, internalContext.headers()),
earliestSessionEndTime,
latestSessionStartTime)
);
}
}

private class MeteredSessionStoreWithHeadersIterator
implements KeyValueIterator<Windowed<K>, AggregationWithHeaders<AGG>>, MeteredIterator {

Expand Down
107 changes: 107 additions & 0 deletions ...va/org/apache/kafka/streams/state/internals/MeteredTimestampedWindowStoreWithHeaders.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*/
package org.apache.kafka.streams.state.internals;

import org.apache.kafka.common.IsolationLevel;
import org.apache.kafka.common.header.Headers;
import org.apache.kafka.common.header.internals.RecordHeaders;
import org.apache.kafka.common.serialization.Serde;
Expand All @@ -36,13 +37,15 @@
import org.apache.kafka.streams.query.WindowRangeQuery;
import org.apache.kafka.streams.query.internals.InternalQueryResultUtil;
import org.apache.kafka.streams.state.KeyValueIterator;
import org.apache.kafka.streams.state.ReadOnlyWindowStore;
import org.apache.kafka.streams.state.TimestampedBytesStore;
import org.apache.kafka.streams.state.TimestampedWindowStoreWithHeaders;
import org.apache.kafka.streams.state.ValueAndTimestamp;
import org.apache.kafka.streams.state.ValueTimestampHeaders;
import org.apache.kafka.streams.state.WindowStore;
import org.apache.kafka.streams.state.WindowStoreIterator;

import java.time.Instant;
import java.util.Objects;
import java.util.function.Function;

Expand Down Expand Up @@ -347,6 +350,110 @@ public KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>> backwardAll() {
);
}

@Override
public ReadOnlyWindowStore<K, ValueTimestampHeaders<V>> readOnly(final IsolationLevel isolationLevel) {
Objects.requireNonNull(isolationLevel, "isolationLevel cannot be null");
return new ReadOnlyHeadersView(wrapped().readOnly(isolationLevel));
}

private final class ReadOnlyHeadersView implements ReadOnlyWindowStore<K, ValueTimestampHeaders<V>> {

private final ReadOnlyWindowStore<Bytes, byte[]> underlying;

ReadOnlyHeadersView(final ReadOnlyWindowStore<Bytes, byte[]> underlying) {
this.underlying = underlying;
}

@Override
public ValueTimestampHeaders<V> fetch(final K key, final long windowStartTimestamp) {
Objects.requireNonNull(key, "key cannot be null");
return maybeMeasureLatency(
() -> {
final byte[] result = underlying.fetch(serializeKey(key, internalContext.headers()), windowStartTimestamp);
return result == null ? null : deserializeValue(result);
},
time,
fetchSensor
);
}

@Override
public WindowStoreIterator<ValueTimestampHeaders<V>> fetch(
final K key, final Instant timeFrom, final Instant timeTo) {
Objects.requireNonNull(key, "key cannot be null");
return new MeteredWindowStoreIterator<>(
underlying.fetch(serializeKey(key, internalContext.headers()), timeFrom, timeTo),
fetchSensor,
iteratorDurationSensor,
MeteredTimestampedWindowStoreWithHeaders.this::deserializeValue,
time,
numOpenIterators,
openIterators
);
}

@Override
public WindowStoreIterator<ValueTimestampHeaders<V>> backwardFetch(
final K key, final Instant timeFrom, final Instant timeTo) {
Objects.requireNonNull(key, "key cannot be null");
return new MeteredWindowStoreIterator<>(
underlying.backwardFetch(serializeKey(key, internalContext.headers()), timeFrom, timeTo),
fetchSensor,
iteratorDurationSensor,
MeteredTimestampedWindowStoreWithHeaders.this::deserializeValue,
time,
numOpenIterators,
openIterators
);
}

@Override
public KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>> fetch(
final K keyFrom, final K keyTo, final Instant timeFrom, final Instant timeTo) {
return new MeteredTimestampedWindowStoreWithHeadersKeyValueIterator(
underlying.fetch(
serializeKey(keyFrom, internalContext.headers()),
serializeKey(keyTo, internalContext.headers()),
timeFrom,
timeTo)
);
}

@Override
public KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>> backwardFetch(
final K keyFrom, final K keyTo, final Instant timeFrom, final Instant timeTo) {
return new MeteredTimestampedWindowStoreWithHeadersKeyValueIterator(
underlying.backwardFetch(
serializeKey(keyFrom, internalContext.headers()),
serializeKey(keyTo, internalContext.headers()),
timeFrom,
timeTo)
);
}

@Override
public KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>> all() {
return new MeteredTimestampedWindowStoreWithHeadersKeyValueIterator(underlying.all());
}

@Override
public KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>> backwardAll() {
return new MeteredTimestampedWindowStoreWithHeadersKeyValueIterator(underlying.backwardAll());
}

@Override
public KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>> fetchAll(
final Instant timeFrom, final Instant timeTo) {
return new MeteredTimestampedWindowStoreWithHeadersKeyValueIterator(underlying.fetchAll(timeFrom, timeTo));
}

@Override
public KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>> backwardFetchAll(
final Instant timeFrom, final Instant timeTo) {
return new MeteredTimestampedWindowStoreWithHeadersKeyValueIterator(underlying.backwardFetchAll(timeFrom, timeTo));
}
}

private class MeteredTimestampedWindowStoreWithHeadersKeyValueIterator
implements KeyValueIterator<Windowed<K>, ValueTimestampHeaders<V>>, MeteredIterator {

Expand Down
29 changes: 29 additions & 0 deletions ...est/java/org/apache/kafka/streams/state/internals/MeteredSessionStoreWithHeadersTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*/
package org.apache.kafka.streams.state.internals;

import org.apache.kafka.common.IsolationLevel;
import org.apache.kafka.common.Metric;
import org.apache.kafka.common.MetricName;
import org.apache.kafka.common.header.Headers;
Expand Down Expand Up @@ -47,6 +48,7 @@
import org.apache.kafka.streams.query.WindowRangeQuery;
import org.apache.kafka.streams.state.AggregationWithHeaders;
import org.apache.kafka.streams.state.KeyValueIterator;
import org.apache.kafka.streams.state.ReadOnlySessionStore;
import org.apache.kafka.streams.state.SessionStore;
import org.apache.kafka.test.KeyValueIteratorStub;

Expand Down Expand Up @@ -1050,6 +1052,33 @@ public void shouldUseHeadersFromValueToDeserializeKeyInBackwardFindSessionsRange
verify(keySerde.deserializer()).deserialize(any(), eq(HEADERS), eq(KEY.getBytes()));
}

@SuppressWarnings("unchecked")
@Test
public void shouldUseHeadersFromValueToDeserializeKeyInReadOnlyFindSessions() {
setUp();
final Serde<String> keySerde = mock(Serde.class);
final MeteredSessionStoreWithHeaders<String, String> store = createStoreWithMockSerdes(keySerde);

final ReadOnlySessionStore<Bytes, byte[]> readOnlyInner = mock(ReadOnlySessionStore.class);
when(innerStore.readOnly(IsolationLevel.READ_COMMITTED)).thenReturn(readOnlyInner);
when(readOnlyInner.findSessions(any(Bytes.class), eq(0L), eq(100L)))
.thenReturn(new KeyValueIteratorStub<>(
List.of(KeyValue.pair(WINDOWED_KEY_BYTES, SERIALIZED_VALUE)).iterator()));

final KeyValueIterator<Windowed<String>, AggregationWithHeaders<String>> iterator =
store.readOnly(IsolationLevel.READ_COMMITTED).findSessions(KEY, 0L, 100L);

assertTrue(iterator.hasNext());
assertEquals(KEY, iterator.peekNextKey().key());
final KeyValue<Windowed<String>, AggregationWithHeaders<String>> result = iterator.next();
assertEquals(KEY, result.key.key());
assertEquals(AGG_WITH_HEADERS, result.value);
assertFalse(iterator.hasNext());
iterator.close();

verify(keySerde.deserializer()).deserialize(any(), eq(HEADERS), eq(KEY.getBytes()));
}

@SuppressWarnings("unchecked")
@Test
public void shouldUseHeadersFromValueToDeserializeKeyInFindSessionsByTime() {
Expand Down
32 changes: 32 additions & 0 deletions ...rg/apache/kafka/streams/state/internals/MeteredTimestampedWindowStoreWithHeadersTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*/
package org.apache.kafka.streams.state.internals;

import org.apache.kafka.common.IsolationLevel;
import org.apache.kafka.common.header.internals.RecordHeaders;
import org.apache.kafka.common.metrics.MetricConfig;
import org.apache.kafka.common.metrics.Metrics;
Expand All @@ -39,6 +40,7 @@
import org.apache.kafka.streams.processor.internals.ProcessorStateManager;
import org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl;
import org.apache.kafka.streams.state.KeyValueIterator;
import org.apache.kafka.streams.state.ReadOnlyWindowStore;
import org.apache.kafka.streams.state.ValueTimestampHeaders;
import org.apache.kafka.streams.state.WindowStore;
import org.apache.kafka.test.InternalMockProcessorContext;
Expand All @@ -54,6 +56,7 @@
import org.mockito.junit.jupiter.MockitoSettings;
import org.mockito.quality.Strictness;

import java.time.Instant;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;
Expand Down Expand Up @@ -484,4 +487,33 @@ public void shouldUseHeadersFromValueToDeserializeKeyInBackwardFetchRange() {

verify(keyDeserializer).deserialize(any(), eq(HEADERS), eq(KEY.getBytes()));
}

@Test
public void shouldUseHeadersFromValueToDeserializeKeyInReadOnlyFetchAll() {
setUp();

final Windowed<Bytes> windowedKey = new Windowed<>(KEY_BYTES, new TimeWindow(0, WINDOW_SIZE_MS));
final KeyValue<Windowed<Bytes>, byte[]> testData = KeyValue.pair(windowedKey, VALUE_TIMESTAMP_HEADERS_BYTES);

final ReadOnlyWindowStore<Bytes, byte[]> readOnlyInner = mock(ReadOnlyWindowStore.class);
when(innerStoreMock.readOnly(IsolationLevel.READ_COMMITTED)).thenReturn(readOnlyInner);
when(readOnlyInner.fetchAll(Instant.ofEpochMilli(0), Instant.ofEpochMilli(100)))
.thenReturn(new KeyValueIteratorStub<>(List.of(testData).iterator()));

store = createStoreWithMockSerdes();

final KeyValueIterator<Windowed<String>, ValueTimestampHeaders<String>> iterator =
store.readOnly(IsolationLevel.READ_COMMITTED).fetchAll(Instant.ofEpochMilli(0), Instant.ofEpochMilli(100));

assertTrue(iterator.hasNext());
assertEquals(KEY, iterator.peekNextKey().key());
final KeyValue<Windowed<String>, ValueTimestampHeaders<String>> result = iterator.next();

assertEquals(KEY, result.key.key());
assertEquals(VALUE_TIMESTAMP_HEADERS, result.value);
assertFalse(iterator.hasNext());
iterator.close();

verify(keyDeserializer).deserialize(any(), eq(HEADERS), eq(KEY.getBytes()));
}
}
Loading