Add TimeSource implementation to TestCoroutineScheduler #3087
Conversation
There was a problem hiding this comment.
Nicely implemented! It was a TODO not because it was bothersome, but because we didn't want to decide immediately whether to deprecate currentTime in favor of manipulating time marks. On one hand, measureTime, markTime, etc., are more structured than manipulating currentTime's Long values, but on the other hand, TimeSource is still an experimental API, and also, a lot of tests explicitly compare currentTime with specific Long values.
However, your approach provides the functionality without railroading us into some particular API. If we decide after all to make TestCoroutineScheduler itself a TimeSource, we can just easily deprecate timeSource in favor of this and be done.
kotlinx-coroutines-test/common/test/TestCoroutineSchedulerTest.kt
Outdated
Show resolved
Hide resolved
|
Loosely related: Kotlin/kotlinx-datetime#164 to handle this new delay skipping behavior when using |
| /** | ||
| * Returns the [TimeSource] representation of the virtual time of this scheduler. | ||
| */ | ||
| @ExperimentalTime |
There was a problem hiding this comment.
Maybe it is worth marking it as ExperimentalCoroutinesApi as well in case we'll decide to implement TimeSource interface when it's stable?
| * @see TestCoroutineScheduler.timeSource | ||
| */ | ||
| @ExperimentalTime | ||
| public val TestScope.testTimeSource: TimeSource get() = testScheduler.timeSource |
There was a problem hiding this comment.
Shouldn't it be timeSource or schedulerTimeSource?
Also lacks ExperimentalCoroutinesApi
There was a problem hiding this comment.
It was initially timeSource, but I advised against it because seeing just a bare timeSource in the middle of a test wolud be disheartening, I assumed. schedulerTimeSource is not much better than testScheduler.timeSource, so I think it's either testTimeSource or no extension on TestScope at all.
There was a problem hiding this comment.
Works for me, thanks for the explanation
There was a problem hiding this comment.
Added annotation as well
|
Merged manually: d5a66e0 |
Fixes #3086
I didn't inherit
TestCoroutineSchedulerfromTimeSource, because you rarely useTestCoroutineScheduler.markNow()but rather use itstimeSourceto inject it in your time based components.Also the method
elapsedNowfromTimeSourceis quite confusing in aScheduler. What happened when callingelapsedNowwith its job? (Nothing...)