Properly check for error conditions with EncapsulatedPacket

this needs to be redesigned, but we can do better than just blacklisting these errors.
on the receive layer they should always be correct, but on the send layer it's possible
for application code to forget to set stuff, so these should be checked.

Author: dktapps

phpstan.neon.dist

@@ -1,5 +1,4 @@
 includes:
-	- tests/phpstan/configs/encapsulated-packet-sucks.neon
 	- tests/phpstan/configs/phpstan-bugs.neon
 	- vendor/phpstan/phpstan-strict-rules/rules.neon
 

src/generic/ReceiveReliabilityLayer.php

@@ -176,7 +176,7 @@ private function handleEncapsulatedPacket(EncapsulatedPacket $packet) : void{
 		}
 
 		if(PacketReliability::isSequenced($packet->reliability)){
-			assert($packet->orderChannel !== null, 'This should have been set during decode');
+			assert($packet->orderChannel !== null && $packet->sequenceIndex !== null, 'These should have been set during decode');
 			if($packet->sequenceIndex < $this->receiveSequencedHighestIndex[$packet->orderChannel] or $packet->orderIndex < $this->receiveOrderedIndex[$packet->orderChannel]){
 				//too old sequenced packet, discard it
 				return;

src/generic/SendReliabilityLayer.php

@@ -170,12 +170,12 @@ public function addEncapsulatedToQueue(EncapsulatedPacket $packet, bool $immedia
 
 		if(PacketReliability::isOrdered($packet->reliability)){
 			if($packet->orderChannel === null){
-				throw new \InvalidArgumentException("Order channel must be set for an ordered packet");
+				throw new \InvalidArgumentException("Order channel must be set reliability $packet->reliability");
 			}
 			$packet->orderIndex = $this->sendOrderedIndex[$packet->orderChannel]++;
 		}elseif(PacketReliability::isSequenced($packet->reliability)){
 			if($packet->orderChannel === null){
-				throw new \InvalidArgumentException("Order channel must be set for a sequenced packet");
+				throw new \InvalidArgumentException("Order channel must be set for reliability $packet->reliability");
 			}
 			$packet->orderIndex = $this->sendOrderedIndex[$packet->orderChannel]; //sequenced packets don't increment the ordered channel index
 			$packet->sequenceIndex = $this->sendSequencedIndex[$packet->orderChannel]++;

src/protocol/EncapsulatedPacket.php

@@ -83,9 +83,19 @@ public function toBinary() : string{
 		return
 			chr(($this->reliability << self::RELIABILITY_SHIFT) | ($this->splitInfo !== null ? self::SPLIT_FLAG : 0)) .
 			Binary::writeShort(strlen($this->buffer) << 3) .
-			(PacketReliability::isReliable($this->reliability) ? Binary::writeLTriad($this->messageIndex) : "") .
-			(PacketReliability::isSequenced($this->reliability) ? Binary::writeLTriad($this->sequenceIndex) : "") .
-			(PacketReliability::isSequencedOrOrdered($this->reliability) ? Binary::writeLTriad($this->orderIndex) . chr($this->orderChannel) : "") .
+			(PacketReliability::isReliable($this->reliability) ?
+				Binary::writeLTriad($this->messageIndex ?? throw new \LogicException("Message index must be set for reliability $this->reliability")) :
+				""
+			) .
+			(PacketReliability::isSequenced($this->reliability) ?
+				Binary::writeLTriad($this->sequenceIndex ?? throw new \LogicException("Sequence index must be set for reliability $this->reliability")) :
+				""
+			) .
+			(PacketReliability::isSequencedOrOrdered($this->reliability) ?
+				Binary::writeLTriad($this->orderIndex ?? throw new \LogicException("Order index must be set for reliability $this->reliability")) .
+					chr($this->orderChannel ?? throw new \LogicException("Order channel must be set for reliability $this->reliability")) :
+				""
+			) .
 			($this->splitInfo !== null ? Binary::writeInt($this->splitInfo->getTotalPartCount()) . Binary::writeShort($this->splitInfo->getId()) . Binary::writeInt($this->splitInfo->getPartIndex()) : "")
 			. $this->buffer;
 	}