[Clock][RFC] pass \DateTinterval or DateInterface to ClockInterface::sleep()

[nikophil]

Description

I think ClockInterface::sleep() in tests is mainly used to perform "time jumps" to predefined dates, thus it is cumbersome to always have to make the conversion to seconds in userland.

I think it would be useful to be able to pass \DateInterval or \DateInterface to ClockInterface::sleep()

The method would become something like:

public function sleep(float|int|\DateInterval|\DateInterface $sleep) void
{
    $sleep = match(true) {
        $sleep instanceof \DateInterval => // convert interval to seconds, throw if negative,
        $sleep instanceof \DateInterface => // convert date interface to seconds from now(), throw if negative,
       default => $sleep
    }

    // ...
}

I'd be pleased to perform the PR if it seems acceptable.

Example

No response

[OskarStark]

WDYT @nicolas-grekas ?

[stof]

I'd rather keep the interface simple and have that implemented as a utility function taking the Clock and the interval/datetime.

[stof]

Also, converting an interval to seconds is ill-defined (how many seconds is 1 month ?)

[nicolas-grekas]

Technically we can add this to MockClock if that can help testing, but for the interface, it'd be a BC break.
More importantly, I don't see the use case: sleeping should happen only for a few (µ)seconds. I don't see any process wait more.

[nikophil]

The use case is indeed for tests purpose, in order to check life cycle of an object got example. But now I see your answer, I'm really wondering if this issue is really worth it: something like $mockClock->sleepUntil($date) is really the same as self::mockTime($date)

[carsonbot]

Thank you for this suggestion.
There has not been a lot of activity here for a while. Would you still like to see this feature?

[derrabus]

I think we can close this. Thank you for the proposal though.