You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "bbejeck (via GitHub)" <gi...@apache.org> on 2026/02/18 21:43:29 UTC
[PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests [kafka]
bbejeck opened a new pull request, #21511:
URL: https://github.com/apache/kafka/pull/21511
This PR introduces the AggregationWithHeaders class and serialization support
introduced in KIP-1271 for storing session aggregations with headers.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2838837121
##########
streams/src/main/java/org/apache/kafka/streams/state/AggregationWithHeaders.java:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state;
+
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.header.internals.RecordHeaders;
+
+import java.util.Objects;
+
+/**
+ * Combines an aggregated value with its associated record headers.
+ * This is used by SessionStoreWithHeaders to store session aggregations along with headers.
+ *
+ * @param <AGG> the aggregation type
+ */
+public final class AggregationWithHeaders<AGG> {
+
+ private final AGG aggregation;
+ private final Headers headers;
+
+ private AggregationWithHeaders(final AGG aggregation, final Headers headers) {
+ this.aggregation = aggregation;
+ this.headers = headers == null ? new RecordHeaders() : headers;
Review Comment:
Should we allow `null` at all? For the `aggregation` it's different, as it might be a `tombstone` that we need to handle -- but for `headers` I am wondering if we need `null` or if we should just disallow it entirly?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "aliehsaeedii (via GitHub)" <gi...@apache.org>.
aliehsaeedii commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2826856558
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
Review Comment:
This class is package-private while `AggregationWithHeadersSerializer` is public
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
Review Comment:
This class is package-private while `AggregationWithHeadersSerializer` is public
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2838826820
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,127 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+
+ public final Deserializer<AGG> aggregationDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = HeadersDeserializer.deserialize(rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.makeAllowNullable(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
+ if (length < 0) {
+ throw new SerializationException(
+ "Invalid AggregationWithHeaders format: negative length " + length
+ );
+ }
+ if (buffer.remaining() < length) {
+ throw new SerializationException(
+ "Invalid AggregationWithHeaders format: expected " + length +
+ " bytes but only " + buffer.remaining() + " bytes remaining"
+ );
+ }
+ final byte[] bytes = new byte[length];
+ buffer.get(bytes);
+ return bytes;
+ }
+
+ /**
+ * Extract headers from serialized AggregationWithHeaders.
+ */
+ static Headers headers(final byte[] rawAggregationWithHeaders) {
+ if (rawAggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(rawAggregationWithHeaders);
Review Comment:
Seems this duplicates some code from above (inside `deserialize`). Should we unify it?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2834185897
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
Review Comment:
Great idea! But we currently don't have a `Utils` class (at least that I know of) can we defer this to a follow-up PR and maybe consider other code as well?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "aliehsaeedii (via GitHub)" <gi...@apache.org>.
aliehsaeedii commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2838260150
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
Review Comment:
Sure
https://issues.apache.org/jira/browse/KAFKA-20205
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "frankvicky (via GitHub)" <gi...@apache.org>.
frankvicky commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2832589129
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
Review Comment:
hmmm...
Make sense, even if we have a null value after deserialization, the headers might still be meaningful.
We should replace with `makeAllowNullable`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "aliehsaeedii (via GitHub)" <gi...@apache.org>.
aliehsaeedii commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2826906633
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersSerializer.java:
##########
@@ -0,0 +1,110 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Serializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableSerializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.io.ByteArrayOutputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableSerializer;
+
+/**
+ * Serializer for AggregationWithHeaders.
+ <p>
+ * Serialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers ([count(varint)][header1][header2]...) from HeadersSerializer
+ * - aggregation: Serialized aggregation using the provided aggregation serializer
+ * <p>
+ * This is used by KIP-1271 to serialize aggregations with headers for session state stores.
+ */
+public class AggregationWithHeadersSerializer<AGG> implements WrappingNullableSerializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ public final Serializer<AGG> aggregationSerializer;
+ private final HeadersSerializer headersSerializer;
+
+ AggregationWithHeadersSerializer(final Serializer<AGG> aggregationSerializer) {
+ Objects.requireNonNull(aggregationSerializer);
+ this.aggregationSerializer = aggregationSerializer;
+ this.headersSerializer = new HeadersSerializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationSerializer.configure(configs, isKey);
+ headersSerializer.configure(configs, isKey);
+ }
+
+ @Override
+ public byte[] serialize(final String topic, final AggregationWithHeaders<AGG> aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+ return serialize(topic, aggregationWithHeaders.aggregation(), aggregationWithHeaders.headers());
+ }
+
+ private byte[] serialize(final String topic, final AGG plainAggregation, final Headers headers) {
+ if (plainAggregation == null) {
+ return null;
+ }
+
+ final byte[] rawAggregation = aggregationSerializer.serialize(topic, headers, plainAggregation);
+
+ if (rawAggregation == null) {
+ return null;
+ }
+
+ final byte[] rawHeaders = headersSerializer.serialize(topic, headers);
+
+ try (final ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ final DataOutputStream out = new DataOutputStream(baos)) {
+
+ ByteUtils.writeVarint(rawHeaders.length, out);
+ out.write(rawHeaders);
+ out.write(rawAggregation);
+
+ return baos.toByteArray();
+ } catch (final IOException e) {
+ throw new SerializationException("Failed to serialize AggregationWithHeaders", e);
Review Comment:
Should we add `topic` to the exception message for better debugging?
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
Review Comment:
This class is package-private while AggregationWithHeadersSerializer is public
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
Review Comment:
Maybe both classes need to be package-private?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck merged PR #21511:
URL: https://github.com/apache/kafka/pull/21511
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2843554319
##########
streams/src/main/java/org/apache/kafka/streams/state/AggregationWithHeaders.java:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state;
+
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.header.internals.RecordHeaders;
+
+import java.util.Objects;
+
+/**
+ * Combines an aggregated value with its associated record headers.
+ * This is used by SessionStoreWithHeaders to store session aggregations along with headers.
+ *
+ * @param <AGG> the aggregation type
+ */
+public final class AggregationWithHeaders<AGG> {
+
+ private final AGG aggregation;
+ private final Headers headers;
+
+ private AggregationWithHeaders(final AGG aggregation, final Headers headers) {
+ this.aggregation = aggregation;
+ this.headers = headers == null ? new RecordHeaders() : headers;
Review Comment:
We can dissallow `null` headers here, which makes since how instances get created, the headers really won't ever be `null`. But this is the same as `ValueTimestampHeaders` should probably follow the same pattern. \cc @frankvicky @aliehsaeedii
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "frankvicky (via GitHub)" <gi...@apache.org>.
frankvicky commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2828026482
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersSerializer.java:
##########
@@ -0,0 +1,110 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Serializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableSerializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.io.ByteArrayOutputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableSerializer;
+
+/**
+ * Serializer for AggregationWithHeaders.
+ <p>
+ * Serialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers ([count(varint)][header1][header2]...) from HeadersSerializer
+ * - aggregation: Serialized aggregation using the provided aggregation serializer
+ * <p>
+ * This is used by KIP-1271 to serialize aggregations with headers for session state stores.
+ */
+public class AggregationWithHeadersSerializer<AGG> implements WrappingNullableSerializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ public final Serializer<AGG> aggregationSerializer;
+ private final HeadersSerializer headersSerializer;
+
+ AggregationWithHeadersSerializer(final Serializer<AGG> aggregationSerializer) {
+ Objects.requireNonNull(aggregationSerializer);
+ this.aggregationSerializer = aggregationSerializer;
+ this.headersSerializer = new HeadersSerializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationSerializer.configure(configs, isKey);
+ headersSerializer.configure(configs, isKey);
+ }
+
+ @Override
+ public byte[] serialize(final String topic, final AggregationWithHeaders<AGG> aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+ return serialize(topic, aggregationWithHeaders.aggregation(), aggregationWithHeaders.headers());
+ }
+
+ private byte[] serialize(final String topic, final AGG plainAggregation, final Headers headers) {
+ if (plainAggregation == null) {
+ return null;
+ }
+
+ final byte[] rawAggregation = aggregationSerializer.serialize(topic, headers, plainAggregation);
+
+ if (rawAggregation == null) {
+ return null;
+ }
+
+ final byte[] rawHeaders = headersSerializer.serialize(topic, headers);
+
+ try (final ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ final DataOutputStream out = new DataOutputStream(baos)) {
+
+ ByteUtils.writeVarint(rawHeaders.length, out);
+ out.write(rawHeaders);
+ out.write(rawAggregation);
+
+ return baos.toByteArray();
+ } catch (final IOException e) {
+ throw new SerializationException("Failed to serialize AggregationWithHeaders", e);
Review Comment:
if so, we should also add it to `ValueTimestampHeadersSerializer`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2834185897
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
Review Comment:
Great idea, but we currently don't have a `Utils` class (at least that I know of) can we defer this to a follow-up PR and maybe consider other code as well?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2838824833
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
Review Comment:
Seems in `HeaderDeserializer` we don't have such a helper at all, and just use
```
final byte[] bytes = new byte[length];
buffer.get(bytes);
```
Might be good to also start using it there for better error messages.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on PR #21511:
URL: https://github.com/apache/kafka/pull/21511#issuecomment-3952451498
Merged #21511 into trunk
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "aliehsaeedii (via GitHub)" <gi...@apache.org>.
aliehsaeedii commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2832393068
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
Review Comment:
This may not be directly related to this PR, but we could refactor the code so that this method lives in a shared place and can be reused by other classes as well.
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
+ if (length < 0) {
Review Comment:
thanks. I like this check. We dont have it in other places.
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
Review Comment:
here if `aggregation` is null, then `make` returns null. I think this should not be the desired behaviour. Same for `ValueTimestampDeserializer.deserialize`. WDYT @frankvicky?
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
+ if (length < 0) {
+ throw new SerializationException(
+ "Invalid AggregationWithHeaders format: negative length " + length
+ );
+ }
+ if (buffer.remaining() < length) {
+ throw new SerializationException(
+ "Invalid AggregationWithHeaders format: expected " + length +
+ " bytes but only " + buffer.remaining() + " bytes remaining"
+ );
+ }
+ final byte[] bytes = new byte[length];
+ buffer.get(bytes);
+ return bytes;
+ }
+
+ /**
+ * Extract aggregation from serialized AggregationWithHeaders.
+ */
+ static <T> T aggregation(final byte[] rawAggregationWithHeaders, final Deserializer<T> deserializer) {
+ if (rawAggregationWithHeaders == null) {
Review Comment:
Not sure why we need this method, but we can go ahead and remove it if it's not needed.
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
+ if (length < 0) {
+ throw new SerializationException(
+ "Invalid AggregationWithHeaders format: negative length " + length
+ );
+ }
+ if (buffer.remaining() < length) {
+ throw new SerializationException(
+ "Invalid AggregationWithHeaders format: expected " + length +
+ " bytes but only " + buffer.remaining() + " bytes remaining"
+ );
+ }
+ final byte[] bytes = new byte[length];
+ buffer.get(bytes);
+ return bytes;
+ }
+
+ /**
+ * Extract aggregation from serialized AggregationWithHeaders.
+ */
+ static <T> T aggregation(final byte[] rawAggregationWithHeaders, final Deserializer<T> deserializer) {
+ if (rawAggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(rawAggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+ // skip headers
+ buffer.position(buffer.position() + headersSize);
+ final byte[] bytes = readBytes(buffer, buffer.remaining());
+
+ return deserializer.deserialize("", bytes);
+ }
+
+ /**
+ * Extract headers from serialized AggregationWithHeaders.
+ */
+ static Headers headers(final byte[] rawAggregationWithHeaders) {
+ if (rawAggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(rawAggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ return HEADERS_DESERIALIZER.deserialize("", rawHeaders);
Review Comment:
If you rebase the PR, you dont need the first input (`""`) any more.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on PR #21511:
URL: https://github.com/apache/kafka/pull/21511#issuecomment-3936062515
@aliehsaeedii @frankvicky all comments addressed ready for another review
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-20158: Add AggregationWithHeaders, serialization support and tests (1/N) [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on code in PR #21511:
URL: https://github.com/apache/kafka/pull/21511#discussion_r2843855694
##########
streams/src/main/java/org/apache/kafka/streams/state/internals/AggregationWithHeadersDeserializer.java:
##########
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.streams.state.internals;
+
+import org.apache.kafka.common.errors.SerializationException;
+import org.apache.kafka.common.header.Headers;
+import org.apache.kafka.common.serialization.Deserializer;
+import org.apache.kafka.common.utils.ByteUtils;
+import org.apache.kafka.streams.kstream.internals.WrappingNullableDeserializer;
+import org.apache.kafka.streams.processor.internals.SerdeGetter;
+import org.apache.kafka.streams.state.AggregationWithHeaders;
+
+import java.nio.ByteBuffer;
+import java.util.Map;
+import java.util.Objects;
+
+import static org.apache.kafka.streams.kstream.internals.WrappingNullableUtils.initNullableDeserializer;
+
+/**
+ * Deserializer for AggregationWithHeaders.
+ * Deserialization format (per KIP-1271):
+ * [headersSize(varint)][headersBytes][aggregation]
+ * <p>
+ * Where:
+ * - headersSize: Size of the headersBytes section in bytes, encoded as varint
+ * - headersBytes:
+ * - For null/empty headers: headersSize = 0, headersBytes is omitted (0 bytes)
+ * - For non-empty headers: headersSize > 0, serialized headers in the format [count(varint)][header1][header2]... to be processed by HeadersDeserializer.
+ * - aggregation: Serialized aggregation to be deserialized with the provided aggregation deserializer
+ * <p>
+ * This is used by KIP-1271 to deserialize aggregations with headers from session state stores.
+ */
+class AggregationWithHeadersDeserializer<AGG> implements WrappingNullableDeserializer<AggregationWithHeaders<AGG>, Void, AGG> {
+ private static final HeadersDeserializer HEADERS_DESERIALIZER = new HeadersDeserializer();
+
+ public final Deserializer<AGG> aggregationDeserializer;
+ private final HeadersDeserializer headersDeserializer;
+
+ AggregationWithHeadersDeserializer(final Deserializer<AGG> aggregationDeserializer) {
+ Objects.requireNonNull(aggregationDeserializer);
+ this.aggregationDeserializer = aggregationDeserializer;
+ this.headersDeserializer = new HeadersDeserializer();
+ }
+
+ @Override
+ public void configure(final Map<String, ?> configs, final boolean isKey) {
+ aggregationDeserializer.configure(configs, isKey);
+ headersDeserializer.configure(configs, isKey);
+ }
+
+ @Override
+ public AggregationWithHeaders<AGG> deserialize(final String topic, final byte[] aggregationWithHeaders) {
+ if (aggregationWithHeaders == null) {
+ return null;
+ }
+
+ final ByteBuffer buffer = ByteBuffer.wrap(aggregationWithHeaders);
+ final int headersSize = ByteUtils.readVarint(buffer);
+
+ final byte[] rawHeaders = readBytes(buffer, headersSize);
+ final Headers headers = headersDeserializer.deserialize(topic, rawHeaders);
+ final byte[] rawAggregation = readBytes(buffer, buffer.remaining());
+ final AGG aggregation = aggregationDeserializer.deserialize(topic, headers, rawAggregation);
+
+ return AggregationWithHeaders.make(aggregation, headers);
+ }
+
+ @Override
+ public void close() {
+ aggregationDeserializer.close();
+ headersDeserializer.close();
+ }
+
+ @Override
+ public void setIfUnset(final SerdeGetter getter) {
+ initNullableDeserializer(aggregationDeserializer, getter);
+ }
+
+
+ /**
+ * Reads the specified number of bytes from the buffer with validation.
+ *
+ * @param buffer the ByteBuffer to read from
+ * @param length the number of bytes to read
+ * @return the byte array containing the read bytes
+ * @throws SerializationException if buffer doesn't have enough bytes or length is negative
+ */
+ private static byte[] readBytes(final ByteBuffer buffer, final int length) {
Review Comment:
What would be a good location for a `Utils` class for this - maybe just a standalone one at the root of `org.apache.kafka.streams.state.internals` ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org