Add generic types for TaskHandler (#6030)

src/scheduler/Task.php

@@ -26,8 +26,12 @@ namespace pocketmine\scheduler;
 use pocketmine\utils\Utils;
 
 abstract class Task{
+	/** @phpstan-var TaskHandler<static>|null  */
 	private ?TaskHandler $taskHandler = null;
 
+	/**
+	 * @phpstan-return TaskHandler<static>|null
+	 */
 	final public function getHandler() : ?TaskHandler{
 		return $this->taskHandler;
 	}
@@ -36,6 +40,9 @@ abstract class Task{
 		return Utils::getNiceClassName($this);
 	}
 
+	/**
+	 * @phpstan-param TaskHandler<static>|null $taskHandler
+	 */
 	final public function setHandler(?TaskHandler $taskHandler) : void{
 		if($this->taskHandler === null || $taskHandler === null){
 			$this->taskHandler = $taskHandler;

src/scheduler/TaskHandler.php

@@ -26,6 +26,9 @@ namespace pocketmine\scheduler;
 use pocketmine\timings\Timings;
 use pocketmine\timings\TimingsHandler;
 
+/**
+ * @template TTask of Task
+ */
 class TaskHandler{
 	protected int $nextRun;
 
@@ -36,6 +39,9 @@ class TaskHandler{
 	private string $taskName;
 	private string $ownerName;
 
+	/**
+	 * @phpstan-param TTask $task
+	 */
 	public function __construct(
 		protected Task $task,
 		protected int $delay = -1,
@@ -66,6 +72,9 @@ class TaskHandler{
 		$this->nextRun = $ticks;
 	}
 
+	/**
+	 * @phpstan-return TTask
+	 */
 	public function getTask() : Task{
 		return $this->task;
 	}

src/scheduler/TaskScheduler.php

@@ -33,12 +33,12 @@ use pocketmine\utils\ReversePriorityQueue;
 class TaskScheduler{
 	private bool $enabled = true;
 
-	/** @phpstan-var ReversePriorityQueue<int, TaskHandler> */
+	/** @phpstan-var ReversePriorityQueue<int, TaskHandler<covariant Task>> */
 	protected ReversePriorityQueue $queue;
 
 	/**
 	 * @var ObjectSet|TaskHandler[]
-	 * @phpstan-var ObjectSet<TaskHandler>
+	 * @phpstan-var ObjectSet<TaskHandler<covariant Task>>
 	 */
 	protected ObjectSet $tasks;
 
@@ -51,18 +51,42 @@ class TaskScheduler{
 		$this->tasks = new ObjectSet();
 	}
 
+	/**
+	 * @phpstan-template TTask of Task
+	 * @phpstan-param TTask $task
+	 *
+	 * @phpstan-return TaskHandler<TTask>
+	 */
 	public function scheduleTask(Task $task) : TaskHandler{
 		return $this->addTask($task, -1, -1);
 	}
 
+	/**
+	 * @phpstan-template TTask of Task
+	 * @phpstan-param TTask $task
+	 *
+	 * @phpstan-return TaskHandler<TTask>
+	 */
 	public function scheduleDelayedTask(Task $task, int $delay) : TaskHandler{
 		return $this->addTask($task, $delay, -1);
 	}
 
+	/**
+	 * @phpstan-template TTask of Task
+	 * @phpstan-param TTask $task
+	 *
+	 * @phpstan-return TaskHandler<TTask>
+	 */
 	public function scheduleRepeatingTask(Task $task, int $period) : TaskHandler{
 		return $this->addTask($task, -1, $period);
 	}
 
+	/**
+	 * @phpstan-template TTask of Task
+	 * @phpstan-param TTask $task
+	 *
+	 * @phpstan-return TaskHandler<TTask>
+	 */
 	public function scheduleDelayedRepeatingTask(Task $task, int $delay, int $period) : TaskHandler{
 		return $this->addTask($task, $delay, $period);
 	}
@@ -77,10 +101,19 @@ class TaskScheduler{
 		}
 	}
 
+	/**
+	 * @phpstan-param TaskHandler<covariant Task> $task
+	 */
 	public function isQueued(TaskHandler $task) : bool{
 		return $this->tasks->contains($task);
 	}
 
+	/**
+	 * @phpstan-template TTask of Task
+	 * @phpstan-param TTask $task
+	 *
+	 * @phpstan-return TaskHandler<TTask>
+	 */
 	private function addTask(Task $task, int $delay, int $period) : TaskHandler{
 		if(!$this->enabled){
 			throw new \LogicException("Tried to schedule task to disabled scheduler");
@@ -99,6 +132,11 @@ class TaskScheduler{
 		return $this->handle(new TaskHandler($task, $delay, $period, $this->owner));
 	}
 
+	/**
+	 * @phpstan-template TTask of Task
+	 * @phpstan-param TaskHandler<TTask> $handler
+	 * @phpstan-return TaskHandler<TTask>
+	 */
 	private function handle(TaskHandler $handler) : TaskHandler{
 		if($handler->isDelayed()){
 			$nextRun = $this->currentTick + $handler->getDelay();
@@ -128,7 +166,7 @@ class TaskScheduler{
 		}
 		$this->currentTick = $currentTick;
 		while($this->isReady($this->currentTick)){
-			/** @var TaskHandler $task */
+			/** @phpstan-var TaskHandler<covariant Task> $task */
 			$task = $this->queue->extract();
 			if($task->isCancelled()){
 				$this->tasks->remove($task);

src/timings/Timings.php

@@ -30,6 +30,7 @@ use pocketmine\network\mcpe\protocol\ClientboundPacket;
 use pocketmine\network\mcpe\protocol\ServerboundPacket;
 use pocketmine\player\Player;
 use pocketmine\scheduler\AsyncTask;
+use pocketmine\scheduler\Task;
 use pocketmine\scheduler\TaskHandler;
 use function get_class;
 use function str_starts_with;
@@ -192,6 +193,10 @@ abstract class Timings{
 
 	}
 
+	/**
+	 * @template TTask of Task
+	 * @phpstan-param TaskHandler<TTask> $task
+	 */
 	public static function getScheduledTaskTimings(TaskHandler $task, int $period) : TimingsHandler{
 		self::init();
 		$name = "Task: " . $task->getTaskName();

tests/phpstan/configs/actual-problems.neon

@@ -801,7 +801,7 @@ parameters:
 			path: ../../../src/scheduler/BulkCurlTask.php
 
 		-
-			message: "#^Cannot call method getNextRun\\(\\) on array\\<string, int\\|pocketmine\\\\scheduler\\\\TaskHandler\\>\\|int\\|pocketmine\\\\scheduler\\\\TaskHandler\\.$#"
+			message: "#^Cannot call method getNextRun\\(\\) on array\\<string, int\\|pocketmine\\\\scheduler\\\\TaskHandler\\<covariant pocketmine\\\\scheduler\\\\Task\\>\\>\\|int\\|pocketmine\\\\scheduler\\\\TaskHandler\\<covariant pocketmine\\\\scheduler\\\\Task\\>\\.$#"
 			count: 1
 			path: ../../../src/scheduler/TaskScheduler.php