Replace EmbeddedChannel's 'frozen time' feature with Ticker
#13169
Conversation
This file contains 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
Motivation:
Netty currently lacks a standard abstraction for time source, as known
as 'ticker' or 'clock'. As a result, Netty relies on ad-hoc overridable
protected methods for 'time getter' methods, which gives hard time to
users who want to test the time-sensitive logic that involes Netty.
Modifications:
- Added `Ticker` and `MockTicker` and their default implementations.
- (Breaking) Updated `EmbeddedChannel` and `EmbeddedEventLoop` to use
`Ticker` instead of its own time manipulation API.
- Removed the old time manipulation API.
- Note that I removed `freezeTime()` and `unfreezeTime()` because it
can easily be replicated with `advance()`.
Result:
- Netty now has a better abstraction for scheduling and testing
time-sensitive logic.
- A user can now specify system, mock or custom `Ticker` implementation
when constructing an `EmbeddedChannel`, which is more flexible than
the previous API.
- (Breaking) The previous time-manipulation API in `EmbeddedChannel`
has been removed in favor of the new API.
- Partially resolves #12827. However, this PR didn't update
`IdleStateHandler` or any other time-sensitive logic in Netty, which
is left as future work.
yawkat
reviewed
Jan 30, 2023
common/src/main/java/io/netty5/util/concurrent/SystemTicker.java
Outdated
Show resolved
Hide resolved
|
lgtm, but this change only applies to EmbeddedEventLoop still, do you plan to move the ticker to "normal" event loops later? |
Thanks for taking a look, @yawkat 🙇 Yeah, that's the plan. |
yawkat
approved these changes
Jan 30, 2023
|
i wish fixing bad sleep was always this easy |
jchrys
reviewed
Jan 30, 2023
common/src/main/java/io/netty5/util/concurrent/SingleThreadEventExecutor.java
Outdated
Show resolved
Hide resolved
…ntExecutor.java Co-authored-by: jchrys <jchrys@me.com>
|
@normanmaurer @chrisvest @hyperxpro Thoughts on this change? Let me continue on this path if it looks good to you. |
hyperxpro
suggested changes
Feb 7, 2023
| void newMockTickerShouldReturnDefaultMockTicker() { | ||
| assertTrue(Ticker.newMockTicker() instanceof DefaultMockTicker); | ||
| } | ||
| @Test |
There was a problem hiding this comment.
Suggested change
| @Test | |
| @Test |
common/src/test/java/io/netty5/util/concurrent/DefaultMockTickerTest.java
Outdated
Show resolved
Hide resolved
common/src/test/java/io/netty5/util/concurrent/DefaultMockTickerTest.java
Outdated
Show resolved
Hide resolved
|
@hyperxpro Thanks for reviewing. Let me address the comments. |
|
@hyperxpro Resolved all comments. PTAL again. 🙇 |
|
Will merge this if I don't get any comments until I check this PR again, like in 3 days. |
hyperxpro
approved these changes
Mar 12, 2023
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.
Motivation:
Netty currently lacks a standard abstraction for time source, as known as 'ticker' or 'clock'. As a result, Netty relies on ad-hoc overridable protected methods for 'time getter' methods, which gives hard time to users who want to test the time-sensitive logic that involes Netty.
Modifications:
TickerandMockTickerand their default implementations.EmbeddedChannelandEmbeddedEventLoopto useTickerinstead of its own time manipulation API.freezeTime()andunfreezeTime()because it can easily be replicated withadvance().Result:
Tickerimplementation when constructing anEmbeddedChannel, which is more flexible than the previous API.EmbeddedChannelhas been removed in favor of the new API.AbstractScheduledEventExecutor.getCurrentTimeNanos#12827. However, this PR didn't updateIdleStateHandleror any other time-sensitive logic in Netty, which is left as future work.