Fix an issue in configuring idleTimeBetweenReadsInMillis #1230
Conversation
…Daemon
Fix an issue where the idleTimeBetweenReadInMillis configured
via MultiLangDaemon was not taking effect because it used
the auto-generated setter from Lombok to set the configured value,
while there is a custom setter that must be invoked to set the
value correctly.
There is also a general confusion between using Lombok's setter vs
custom setter in java.
Unifying the approach to use the custom Lombok-fluent-style setter
and deprecating the previously added custom setIdleTimeBetweenReadsInMillis
Correct way to configure idleTimeBetweenReadsInMillis for MultiLang is
to add this in the properties file:
idleTimeBetweenReadsInMillis = 10000 # 10 seconds
Correct way to configure for java:
configsBuilder.retrievalConfig().retrievalSpecificConfig(
new PollingConfig(streamName, kinesisClient)
.idleTimeBetweenReadsInMillis(Duration.ofSeconds(10).toMillis())
Issues: awslabs#999, awslabs#950, awslabs#515
| * </p> | ||
| */ | ||
| private long idleTimeBetweenReadsInMillis = 1000L; | ||
| @Setter(AccessLevel.NONE) | ||
| private long idleTimeBetweenReadsInMillis = 1500L; |
There was a problem hiding this comment.
Why is it we are chaniging this default?
There was a problem hiding this comment.
Because the current default of 1000L is never used, if it is not explicitly configured it used a default defined in an internal API which is 1500L, so I am keeping them consistent without behavior change.
| * @Deprecated Use {@link PollingConfig#idleTimeBetweenReadsInMillis} instead | ||
| */ | ||
| @Deprecated | ||
| public void setIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis) { |
There was a problem hiding this comment.
What is going to be the cost of deprecating this. I know that we like everything to be backward compadible. Do we know how many people use this. What will happen to peoples code as they update. Will this require a major release?
It looks to me that it will just call the value below
There was a problem hiding this comment.
Deprecating will print a warning during compilation for customer still using this. The behavior will still be correct because they both do the same thing.
We want to avoid confusion with multiple ways to do the same thing, so this says explicitly that we want to support the lombok-fluent-like API that customers are already used to using over the other setter.
| usePollingConfigIdleTimeValue = true; | ||
| this.idleTimeBetweenReadsInMillis = idleTimeBetweenReadsInMillis; | ||
| return this; |
There was a problem hiding this comment.
Why is it we are now returning the value
There was a problem hiding this comment.
This is just the explicit implementation of lombok fluent api implementation. It follows the fluent interface - https://en.wikipedia.org/wiki/Fluent_interface
Description of changes:
Fix an issue where the idleTimeBetweenReadInMillis configured via MultiLangDaemon was not taking effect because it used the auto-generated setter from Lombok to set the configured value, while there is a custom setter that must be invoked to set the value correctly.
There is also a general confusion between using Lombok's fluent setter vs custom setter in java.
Unifying the approach to use the custom Lombok-fluent-style setter and deprecating the previously added setIdleTimeBetweenReadsInMillis
Correct way to configure idleTimeBetweenReadsInMillis for MultiLang is to add this in the properties file:
idleTimeBetweenReadsInMillis = 10000 # 10 seconds
Correct way to configure for java:
configsBuilder.retrievalConfig().retrievalSpecificConfig(
new PollingConfig(streamName, kinesisClient)
.idleTimeBetweenReadsInMillis(Duration.ofSeconds(10).toMillis())
Issue # #999, #950, #515
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.