Simplify loop timer ordering

Author: Greg Bowler

src/Loop.php

@@ -57,7 +57,9 @@ public function waitUntil(float $waitUntilEpoch):void {
 		);
 	}
 
-	private function triggerNextTimers():int {
+// TODO: The epochList is a perfect candidate for one of SPL's Iterators.
+// Probably the MultipleIterator...
+	public function getTimerOrder() {
 		$epochList = [];
 
 // Create a list of all timers that have a next run time.
@@ -67,17 +69,22 @@ private function triggerNextTimers():int {
 			}
 		}
 
-// If there are no more timers to run, return early.
-		if(empty($epochList)) {
-			return 0;
-		}
-
 // Sort the epoch list so that they are in order of next run time.
 		usort(
 			$epochList,
 			fn($a, $b) => $a[0] < $b[0] ? -1 : 1
 		);
 
+		return $epochList;
+	}
+
+	private function triggerNextTimers():int {
+		$epochList = $this->getTimerOrder();
+// If there are no more timers to run, return early.
+		if(empty($epochList)) {
+			return 0;
+		}
+
 // Wait until the first epoch is due, then trigger the timer.
 		$this->waitUntil($epochList[0][0]);
 		$this->trigger($epochList[0][1]);

src/Timer/Timer.php

@@ -17,9 +17,9 @@ public function __construct() {
 		$this->callbackList = [];
 	}
 
-	public function addCallback(callable $callback):void {
-		$this->callbackList[] = $callback;
-	}
+//	public function addCallback(callable $callback):void {
+//		$this->callbackList[] = $callback;
+//	}
 
 	public function getNextRunTime():?float {
 		return $this->triggerTimeQueue[0] ?? null;

test/phpunit/LoopTest.php

@@ -34,7 +34,7 @@ public function testWaitUntilNegative() {
 		$numCalls = 0;
 
 		$sut = new Loop();
-		$sut->setSleepFunction(function(int $milliseconds) use (&$numCalls) {
+		$sut->setSleepFunction(function() use (&$numCalls) {
 			$numCalls++;
 		});
 
@@ -93,4 +93,48 @@ public function testRunWithTimerNoNextRunTime() {
 
 		self::assertEquals(0, $sut->getTriggerCount());
 	}
+
+	public function testGetTimerList() {
+		$epoch = microtime(true);
+
+		$timer1 = self::createMock(Timer::class);
+		$timer1->method("getNextRunTime")
+			->willReturn($epoch + 1, null);
+		$timer2 = self::createMock(Timer::class);
+		$timer2->method("getNextRunTime")
+			->willReturn($epoch + 2, null);
+
+		$sut = new Loop();
+		$sut->setSleepFunction(function() {});
+		$sut->addTimer($timer1);
+		$sut->addTimer($timer2);
+
+		$timerOrder = $sut->getTimerOrder();
+		self::assertSame($timer1, $timerOrder[0][1]);
+		self::assertSame($timer2, $timerOrder[1][1]);
+	}
+
+	/**
+	 * The only difference here to the test above is that timer1 is set to
+	 * be due after timer2, so the order of the timers will be different.
+	 */
+	public function testGetTimerListOutOfOrder() {
+		$epoch = microtime(true);
+
+		$timer1 = self::createMock(Timer::class);
+		$timer1->method("getNextRunTime")
+			->willReturn($epoch + 2, null);
+		$timer2 = self::createMock(Timer::class);
+		$timer2->method("getNextRunTime")
+			->willReturn($epoch + 1, null);
+
+		$sut = new Loop();
+		$sut->setSleepFunction(function() {});
+		$sut->addTimer($timer1);
+		$sut->addTimer($timer2);
+
+		$timerOrder = $sut->getTimerOrder();
+		self::assertSame($timer2, $timerOrder[0][1]);
+		self::assertSame($timer1, $timerOrder[1][1]);
+	}
 }

test/phpunit/Timer/IndividualTimerTest.php

@@ -2,8 +2,9 @@
 namespace Gt\Async\Test\Timer;
 
 use Gt\Async\Timer\IndividualTimer;
+use PHPUnit\Framework\TestCase;
 
-class IndividualTimerTest extends \PHPUnit\Framework\TestCase {
+class IndividualTimerTest extends TestCase {
 	public function testConstructWithFutureTime() {
 		$epoch = microtime(true);
 		$epochPlus50ms = $epoch + 0.05;