Verify that all packets have a designated direction

Author: dktapps

src/PacketPool.php

@@ -16,6 +16,8 @@
 
 use pmmp\encoding\DataDecodeException;
 use pmmp\encoding\VarInt;
+use function array_filter;
+use function is_object;
 
 class PacketPool{
 	protected static ?PacketPool $instance = null;
@@ -273,4 +275,12 @@ public function getPacketById(int $pid) : ?Packet{
 	public function getPacket(string $buffer) : ?Packet{
 		return $this->getPacketById(VarInt::unpackUnsignedInt($buffer) & DataPacket::PID_MASK);
 	}
+
+	/**
+	 * @return Packet[]
+	 * @phpstan-return array<int, Packet>
+	 */
+	public function getAll() : array{
+		return array_filter($this->pool->toArray(), is_object(...));
+	}
 }

tests/phpunit/PacketPoolTest.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace phpunit;
+
+use PHPUnit\Framework\TestCase;
+use pocketmine\network\mcpe\protocol\ClientboundPacket;
+use pocketmine\network\mcpe\protocol\PacketPool;
+use pocketmine\network\mcpe\protocol\ServerboundPacket;
+
+final class PacketPoolTest extends TestCase{
+
+	private PacketPool $pool;
+
+	public function setUp() : void{
+		$this->pool = new PacketPool();
+	}
+
+	public function testPacketDirectionDesignations() : void{
+		foreach($this->pool->getAll() as $packet){
+			self::assertTrue($packet instanceof ClientboundPacket || $packet instanceof ServerboundPacket, $packet->getName() . " must implement ClientboundPacket, ServerboundPacket, or both\n");
+		}
+	}
+}

tools/generate-protocol-info.php

@@ -180,6 +180,8 @@ interface PacketHandlerInterface{
 
 use pmmp\encoding\DataDecodeException;
 use pmmp\encoding\VarInt;
+use function array_filter;
+use function is_object;
 
 class PacketPool{
 	protected static ?PacketPool $instance = null;
@@ -213,6 +215,14 @@ public function getPacketById(int $pid) : ?Packet{
 	public function getPacket(string $buffer) : ?Packet{
 		return $this->getPacketById(VarInt::unpackUnsignedInt($buffer) & DataPacket::PID_MASK);
 	}
+
+	/**
+	 * @return Packet[]
+	 * @phpstan-return array<int, Packet>
+	 */
+	public function getAll() : array{
+		return array_filter($this->pool->toArray(), is_object(...));
+	}
 }
 
 CODE;