Status

Current state:  Under DiscussionAccepted

Discussion thread: here

Vote Discussion thread: here

JIRA: 

           and 

...

Window size is not passed to the Kafka consumer during windowed aggregations, so the consumer uses the default Long.MAX_VALUE when initializing the deserializer. Both TimeWindowedSerde and TimeWindowedDeserializer have a default constructor that does not require a window size, causing fatal errors at runtime for some programs. 

Public Interfaces

In ConsumerConfigStreamsConfig.java add window.size.ms

/** <code>window.size.ms</code> */
public static final String WINDOW_SIZE_MS_CONFIG = "window.size.ms";
private static final String WINDOW_SIZE_MS_DOC = "Passes window size to the deserializer in order to calculate window end times. Default is Long.MAX_VALUE";

Deprecate the following methods

@Deprecated
public TimeWindowedSerde(final Serde<T> inner) {
	super(new TimeWindowedSerializer<>(inner.serializer()), new TimeWindowedDeserializer<>(inner.deserializer()));
}

...

@Deprecated
public TimeWindowedDeserializer(final Deserializer<T> inner) {
	this(inner, Long.MAX_VALUE);
}

/**
* Construct a {@code TimeWindowedSerde} object for the specified inner class type.
*/
@Deprecated
static public <T> Serde<Windowed<T>> timeWindowedSerdeFrom(final Class<T> type) {
	return new TimeWindowedSerde<>(Serdes.serdeFrom(type));
}

@Deprecated
public TimeWindowedDeserializer(final Deserializer<T> inner) {
	this(inner, Long.MAX_VALUE);
}

Log an error message in Serdes.scala for implicit def timeWindowedSerde and pass through to the deserializer

// Log error message and pass through to underlying deserializer 
implicit def timeWindowedSerde[T](implicit tSerde: Serde[T]): WindowedSerdes.TimeWindowedSerde[T] =
  new WindowedSerdes.TimeWindowedSerde[T](tSerde)

Proposed Changes

Add window.size.ms to the ConsumerConfigs StreamsConfigs class to ensure that the desired window size is set when the consumer creates the TimeWindowedDeserializer instance. This is relevant for consuming TimeWindowed records directly, which is particularly helpful for when testing windowed aggregations. Without this change, all windows will have a size and end time of Long.MAX_VALUE. Users can either set the window size through the config or set the window size through the constructor. To help enforce this, the window.size.ms will not have a default value.

Additionally, deprecate constructors in both TimeWindowedDeserializer and WindowedSerdes that don't require a window size. This ensures that the window size would be properly set before encountering any instances where it should be used. When these are deprecated, the timeWindowedSerde implicit in Serdes.scala will be updated to log an error message explaining that this implicit should no longer be used. To keep backwards compatibility, this implicit won't be deprecated but will pass through to the deserializer.

Note that to use the windows.size.ms config through the console consumer (if desired), add the key.deserializer prefix and pass it in as a property.

...

• WindowKeySchemaTest
• KStreamAggregationIntegrationTest*
• WindowedSerdesTest*
• TimeWindowedCogroupedKStreamImplTest

Classes that need to be updated:

• TemperatureDemo
• Serdes

Rejected Alternatives