KAFKA-16260: Deprecate window.size.ms and window.inner.class.serde in StreamsConfig #18297
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FrankYang0529
force-pushed
the
KAFKA-16260
branch
2 times, most recently
from
2fb2f23 to
926b1cf
Compare
FrankYang0529
force-pushed
the
KAFKA-16260
branch
3 times, most recently
from
17f14fa to
3cef9bd
Compare
FrankYang0529
force-pushed
the
KAFKA-16260
branch
from
3cef9bd to
4a61f67
Compare
… StreamsConfig Signed-off-by: PoAn Yang <[email protected]>
FrankYang0529
force-pushed
the
KAFKA-16260
branch
from
4a61f67 to
f0700e5
Compare
lucasbru
reviewed
Mar 24, 2025
There was a problem hiding this comment.
Thanks for the PR, @FrankYang0529 ! Overall this looks like a well-done PR to me. I left some comments.
docs/upgrade.html
Outdated
| @@ -430,6 +430,9 @@ <h5><a id="upgrade_servers_400_notable" href="#upgrade_servers_400_notable">Nota | |||
| <li> See <a href="https://cwiki.apache.org/confluence/x/B40ODg">KIP-890</a> and | |||
| <a href="https://cwiki.apache.org/confluence/x/8ItyEg">KIP-1050</a> for more details </li> | |||
| </ul> | |||
| <li> | |||
| The <code>window.size.ms</code> and <code>window.inner.serde.class</code> in stream config are deprecated. | |||
There was a problem hiding this comment.
This should not be in the 4.0 section.
| /** | ||
| * {@code windowed.inner.class.serde} | ||
| * | ||
| * @deprecated since 4.0.0. |
| /** | ||
| * {@code window.size.ms} | ||
| * | ||
| * @deprecated since 4.0.0. |
docs/upgrade.html
Outdated
| @@ -430,6 +430,9 @@ <h5><a id="upgrade_servers_400_notable" href="#upgrade_servers_400_notable">Nota | |||
| <li> See <a href="https://cwiki.apache.org/confluence/x/B40ODg">KIP-890</a> and | |||
| <a href="https://cwiki.apache.org/confluence/x/8ItyEg">KIP-1050</a> for more details </li> | |||
| </ul> | |||
| <li> | |||
| The <code>window.size.ms</code> and <code>window.inner.serde.class</code> in stream config are deprecated. | |||
There was a problem hiding this comment.
Suggested change
| The <code>window.size.ms</code> and <code>window.inner.serde.class</code> in stream config are deprecated. | |
| The <code>window.size.ms</code> and <code>window.inner.serde.class</code> in `StreamsConfig` are deprecated. Use the corresponding string constants defined in `TimeWindowedSerializer`, `TimeWindowedDeserializer`, `SessionWindowedSerializer` and `SessionWindowedDeserializer` instead. |
Something like that? Could also be the actual string constants. But it's good to make these notes actionable.
| Serde<T> windowInnerClassSerde = null; | ||
| if (windowedInnerClassSerdeConfig != null) { | ||
| String serializerConfigFrom = WINDOWED_INNER_SERIALIZER_CLASS; | ||
| String windowedInnerSerializerClassConfig = (String) configs.get(WINDOWED_INNER_SERIALIZER_CLASS); |
There was a problem hiding this comment.
variable name suggestion: serializerConfigValue
Also in other places. I think the key/value relationship between these two variables is helpful to understand this code.
| final String windowedInnerClassSerdeConfig = (String) configs.get(StreamsConfig.WINDOWED_INNER_CLASS_SERDE); | ||
| Serde<T> windowInnerClassSerde = null; | ||
| if (windowedInnerClassSerdeConfig != null) { | ||
| String serializerConfigFrom = WINDOWED_INNER_SERIALIZER_CLASS; |
There was a problem hiding this comment.
variable name suggestion: serializerConfigKey
Also in other places
| import java.util.Map; | ||
|
|
||
| public class SessionWindowedDeserializer<T> implements Deserializer<Windowed<T>> { | ||
|
|
||
| /** | ||
| * Configuration key for the windowed inner deserializer class. |
There was a problem hiding this comment.
Can we put any more information into this (and the other) java doc comments about the constants? Since this is a public string constant now, the use of the constant should ideally be clear from the javadoc comments.
Signed-off-by: PoAn Yang <[email protected]>
|
@lucasbru Thanks for the review. I addressed all comments. The document update is like following: 
|
janchilling
pushed a commit
to janchilling/kafka
that referenced
this pull request
Apr 4, 2025
… StreamsConfig (apache#18297) The `window.size.ms` and `window.inner.class.serde` are not a true KafkaStreams config, and are ignored when set from a KStreams application. Both belong on the client. Reviewers: Lucas Brutschy <[email protected]> Signed-off-by: PoAn Yang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
window.size.msandwindow.inner.class.serdeare not a true KafkaStreams config, and are ignored when set from a KStreams application. Both belong on the client.KIP-1020: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=290982804
Reviewers: Lucas Brutschy [email protected]