Functionality complete Loop, ready to refactor using Iterator

Author: Greg Bowler

src/Loop.php

@@ -59,7 +59,8 @@ public function waitUntil(float $waitUntilEpoch):void {
 
 // TODO: The epochList is a perfect candidate for one of SPL's Iterators.
 // Probably the MultipleIterator...
-	public function getTimerOrder() {
+	/** @return array[] */
+	public function getTimerOrder():array {
 		$epochList = [];
 
 // Create a list of all timers that have a next run time.
@@ -78,6 +79,13 @@ public function getTimerOrder() {
 		return $epochList;
 	}
 
+	/** return array[] */
+	public function getReadyTimers(array $epochList):array {
+		$now = microtime(true);
+		$epochList = array_filter($epochList, fn($a) => $a[0] <= $now);
+		return $epochList;
+	}
+
 	private function triggerNextTimers():int {
 		$epochList = $this->getTimerOrder();
 // If there are no more timers to run, return early.
@@ -88,33 +96,23 @@ private function triggerNextTimers():int {
 // Wait until the first epoch is due, then trigger the timer.
 		$this->waitUntil($epochList[0][0]);
 		$this->trigger($epochList[0][1]);
-		$triggered = 1;
 
 // Triggering the timer may have caused time to pass so that
 // other timers are now due.
 		array_shift($epochList);
-		$triggered += $this->executeAllReadyTimers($epochList);
-		return $triggered;
+		$readyList = $this->getReadyTimers($epochList);
+		$this->executeTimers($readyList);
+		return 1 + count($readyList);
 	}
 
 	private function trigger(Timer $timer):void {
 		$timer->tick();
 	}
 
 	/** @param array[] $epochList [$epoch, $timer] */
-	private function executeAllReadyTimers(array $epochList):int {
-$now = microtime(true);
-		$triggered = 0;
-
-		while(isset($epochList[0])
-		&& $epochList[0][0] <= $now) {
-			$this->trigger($epochList[0][1]);
-			array_shift($epochList);
-			$triggered++;
-
-$now = microtime(true);
+	private function executeTimers(array $epochList):void {
+		foreach($epochList as $timerThing) {
+			$this->trigger($timerThing[1]);
 		}
-
-		return $triggered;
 	}
 }

src/Timer/Timer.php

@@ -9,7 +9,9 @@
  * use of CPU cycles, sleep for the duration until the Timer's next run time.
  */
 abstract class Timer {
+	/** @var float[] */
 	protected array $triggerTimeQueue;
+	/** @var callable[] */
 	protected array $callbackList;
 
 	public function __construct() {
@@ -43,7 +45,7 @@ public function tick():bool {
 			array_shift($this->triggerTimeQueue);
 		}
 		while(isset($this->triggerTimeQueue[0])
-		&& $this->triggerTimeQueue <= $now);
+		&& $this->triggerTimeQueue[0] <= $now);
 
 		return true;
 	}

test/phpunit/LoopTest.php

@@ -137,4 +137,52 @@ public function testGetTimerListOutOfOrder() {
 		self::assertSame($timer2, $timerOrder[0][1]);
 		self::assertSame($timer1, $timerOrder[1][1]);
 	}
+
+	public function testGetTimerListManyReadyManyFuture() {
+		$epoch = microtime(true);
+
+		$timerList = [];
+
+		for($i = 0; $i < 100; $i++) {
+// Offset the epoch by a random amount between -10 and +10 seconds.
+			$rand = rand(-1000, 1000) / 100;
+			$timer = self::createMock(Timer::class);
+			$timer->method("getNextRunTime")
+				->willReturn($epoch + $rand);
+			$timerList[] = $timer;
+		}
+
+		$sut = new Loop();
+		$sut->setSleepFunction(function() {});
+
+		foreach($timerList as $timer) {
+			$sut->addTimer($timer);
+		}
+
+		$timerOrder = $sut->getTimerOrder();
+		$earliest = 0;
+		foreach($timerOrder as $timer) {
+			self::assertGreaterThanOrEqual($earliest, $timer[0]);
+			$earliest = $timer[0];
+		}
+	}
+
+	public function testGetReadyTimers() {
+		$epoch = microtime(true);
+
+		$timerFuture = self::createMock(Timer::class);
+		$timerFuture->method("getNextRunTime")
+			->willReturn($epoch + 100);
+		$timerPast = self::createMock(Timer::class);
+		$timerPast->method("getNextRunTime")
+			->willReturn($epoch - 100);
+		$sut = new Loop();
+		$sut->addTimer($timerFuture);
+		$sut->addTimer($timerPast);
+		$allTimers = $sut->getTimerOrder();
+		$readyTimers = $sut->getReadyTimers($allTimers);
+
+		self::assertCount(1, $readyTimers);
+		self::assertSame($timerPast, $readyTimers[0][1]);
+	}
 }