Merge branch 'next-minor' into next-major

.github/workflows/draft-release.yml

@@ -56,6 +56,7 @@ jobs:
           echo ::set-output name=PM_VERSION_SHORT::$(php -r 'require "vendor/autoload.php"; $v = explode(".", \pocketmine\VersionInfo::BASE_VERSION); array_pop($v); echo implode(".", $v);')
           echo ::set-output name=PM_VERSION_MD::$(php -r 'require "vendor/autoload.php"; echo str_replace(".", "", \pocketmine\VersionInfo::BASE_VERSION);')
           echo ::set-output name=CHANGELOG_SUFFIX::$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BUILD_CHANNEL === "stable" ? "" : "-" . \pocketmine\VersionInfo::BUILD_CHANNEL;')
+          echo ::set-output name=PRERELEASE::$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BUILD_CHANNEL === "stable" ? "false" : "true";')
 
       - name: Generate build info
         run: php build/generate-build-info-json.php ${{ github.sha }} ${{ steps.get-pm-version.outputs.PM_VERSION }} ${{ github.repository }} ${{ steps.build-number.outputs.BUILD_NUMBER }} ${{ github.run_id }} > build_info.json
@@ -75,6 +76,7 @@ jobs:
           artifacts: ${{ github.workspace }}/PocketMine-MP.phar,${{ github.workspace }}/start.*,${{ github.workspace }}/build_info.json
           commit: ${{ github.sha }}
           draft: true
+          prerelease: ${{ steps.get-pm-version.outputs.PRERELEASE }}
           name: PocketMine-MP ${{ steps.get-pm-version.outputs.PM_VERSION }}
           tag: ${{ steps.get-pm-version.outputs.PM_VERSION }}
           token: ${{ secrets.GITHUB_TOKEN }}

changelogs/4.16-beta.md

@@ -0,0 +1,45 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.x.y version will also run on these releases and do not need API bumps.
+Plugin developers should **only** update their required API to this version if you need the changes in this build.
+
+**WARNING: If your plugin uses the protocol, you're not shielded by API change constraints.** You should consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you do.
+
+# 4.16.0-BETA1
+Released 4th March 2023.
+
+## General
+- Added granular timings for packet encode, similar to the existing timings for packet decode.
+- Timings now covers several areas of the network system which were previously not counted by network timings, but were counted by total timings. This provides a better insight into the performance of the network system.
+
+## Performance
+- Improved performance of packet batch handling by avoiding unnecessary object allocations.
+- Improved performance of packet broadcasting when the broadcast size is below the batch threshold. Previously, the packets would be encoded once by every recipient, but now they are encoded once and then added to the send buffer of each session in their raw form.
+  - This change mostly affects servers with larger maps, where players are more widely distributed.
+
+## Build system
+- Added a new script `build/generate-bedrockdata-path-consts.php`, which must be run whenever BedrockData is updated. This script generates a class of constants with the file paths of all BedrockData files.
+
+## API
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Entity->getGravity() : float` - returns the entity's gravity acceleration in blocks/tick^2
+  - `public Entity->setGravity(float $gravity) : void` - sets the entity's gravity acceleration in blocks/tick^2
+
+## Internals
+- Now uses [`pocketmine/bedrock-data` 2.0.0](https://github.com/pmmp/BedrockData/releases/tag/2.0.0+bedrock-1.19.60).
+  - This version is now used by both PM4 and PM5, reducing maintenance burden.
+- Now uses [`pocketmine/bedrock-protocol` 19.3.0](https://github.com/pmmp/BedrockProtocol/releases/tag/19.3.0+bedrock-1.19.62).
+  - This version provides new APIs for handling packet batches which enabled improving performance and adding new features, such as detailed packet encode timings.
+- Crafting recipes and creative inventory data are now loaded from `recipes/legacy_recipes.json` and `recipes/legacy_creativeitems.json` respectively. Previously, these were loaded from BedrockData directly, but BedrockData 2.0 now uses a format which can't be supported in 4.x without BC breaks.
+- Added dependencies on [`pocketmine/bedrock-block-upgrade-schema`](https://github.com/pmmp/BedrockBlockUpgradeSchema) and [`pocketmine/bedrock-item-upgrade-schema`](https://github.com/pmmp/BedrockItemUpgradeSchema). These provide mapping files no longer present in BedrockData 2.0.
+- Reduced and/or eliminated most usages of `PacketBatch`, since it only appeared as a throwaway object and was therefore wasting performance.
+- `Compressor` now exposes `getCompressionThreshold()` instead of `willCompress()`, which allows determining whether a batch will be compressed without allocating it.
+- Added `pocketmine\data\bedrock\BedrockDataFiles`, an auto-generated class of constants with the file paths of all BedrockData files. This makes it easier to locate usages, detect unused files and avoid typos.
+
+# 4.16.0-BETA2
+Released 4th March 2023.
+
+## General
+- Fixed incorrect release channel for 4.16.0-BETA1.

composer.lock

@@ -1834,16 +1834,16 @@
         },
         {
             "name": "phpstan/phpstan-phpunit",
-            "version": "1.3.9",
+            "version": "1.3.10",
             "source": {
                 "type": "git",
                 "url": "https://github.com/phpstan/phpstan-phpunit.git",
-                "reference": "34ee324a2b8fcab680fbb3f3f3d6c86389df35ba"
+                "reference": "4cc5c6cc38e56bce7ea47c4091814e516d172dc3"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/phpstan/phpstan-phpunit/zipball/34ee324a2b8fcab680fbb3f3f3d6c86389df35ba",
-                "reference": "34ee324a2b8fcab680fbb3f3f3d6c86389df35ba",
+                "url": "https://api.github.com/repos/phpstan/phpstan-phpunit/zipball/4cc5c6cc38e56bce7ea47c4091814e516d172dc3",
+                "reference": "4cc5c6cc38e56bce7ea47c4091814e516d172dc3",
                 "shasum": ""
             },
             "require": {
@@ -1880,9 +1880,9 @@
             "description": "PHPUnit extensions and rules for PHPStan",
             "support": {
                 "issues": "https://github.com/phpstan/phpstan-phpunit/issues",
-                "source": "https://github.com/phpstan/phpstan-phpunit/tree/1.3.9"
+                "source": "https://github.com/phpstan/phpstan-phpunit/tree/1.3.10"
             },
-            "time": "2023-02-28T13:04:23+00:00"
+            "time": "2023-03-02T10:25:13+00:00"
         },
         {
             "name": "phpstan/phpstan-strict-rules",

src/MemoryManager.php

@@ -49,6 +49,7 @@ use function ini_get;
 use function ini_set;
 use function intdiv;
 use function is_array;
+use function is_float;
 use function is_object;
 use function is_resource;
 use function is_string;
@@ -514,6 +515,8 @@ class MemoryManager{
 			$data = "(string) len(" . strlen($from) . ") " . substr(Utils::printable($from), 0, $maxStringSize);
 		}elseif(is_resource($from)){
 			$data = "(resource) " . print_r($from, true);
+		}elseif(is_float($from)){
+			$data = "(float) $from";
 		}else{
 			$data = $from;
 		}

src/Server.php

@@ -1378,14 +1378,16 @@ class Server{
 	 *
 	 * @param bool|null $sync Compression on the main thread (true) or workers (false). Default is automatic (null).
 	 */
-	public function prepareBatch(PacketBatch $stream, Compressor $compressor, ?bool $sync = null) : CompressBatchPromise{
+	public function prepareBatch(PacketBatch $stream, Compressor $compressor, ?bool $sync = null, ?TimingsHandler $timings = null) : CompressBatchPromise{
+		$timings ??= Timings::$playerNetworkSendCompress;
 		try{
-			Timings::$playerNetworkSendCompress->startTiming();
+			$timings->startTiming();
 
 			$buffer = $stream->getBuffer();
 
 			if($sync === null){
-				$sync = !($this->networkCompressionAsync && $compressor->willCompress($buffer));
+				$threshold = $compressor->getCompressionThreshold();
+				$sync = !$this->networkCompressionAsync || $threshold === null || strlen($stream->getBuffer()) < $threshold;
 			}
 
 			$promise = new CompressBatchPromise();
@@ -1398,7 +1400,7 @@ class Server{
 
 			return $promise;
 		}finally{
-			Timings::$playerNetworkSendCompress->stopTiming();
+			$timings->stopTiming();
 		}
 	}
 

src/network/mcpe/NetworkSession.php

@@ -533,7 +533,7 @@ class NetworkSession{
 				PacketBatch::encodeRaw($stream, $this->sendBuffer);
 
 				if($this->enableCompression){
-					$promise = $this->server->prepareBatch(new PacketBatch($stream->getBuffer()), $this->compressor, $syncMode);
+					$promise = $this->server->prepareBatch(new PacketBatch($stream->getBuffer()), $this->compressor, $syncMode, Timings::$playerNetworkSendCompressSessionBuffer);
 				}else{
 					$promise = new CompressBatchPromise();
 					$promise->resolve($stream->getBuffer());

src/network/mcpe/StandardPacketBroadcaster.php

@@ -23,11 +23,12 @@ declare(strict_types=1);
 
 namespace pocketmine\network\mcpe;
 
-use pocketmine\network\mcpe\compression\ThresholdCompressor;
 use pocketmine\network\mcpe\protocol\serializer\PacketBatch;
 use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
 use pocketmine\Server;
+use pocketmine\timings\Timings;
 use pocketmine\utils\BinaryStream;
+use function count;
 use function spl_object_id;
 use function strlen;
 
@@ -64,36 +65,23 @@ final class StandardPacketBroadcaster implements PacketBroadcaster{
 			foreach($compressorMap as $compressorId => $compressorTargets){
 				$compressor = $compressors[$compressorId];
 
-				$batchBuffer = null;
-				if($compressor instanceof ThresholdCompressor){
-					$threshold = $compressor->getCompressionThreshold();
-					if($threshold !== null && $packetBufferTotalLengths[$bufferId] >= $threshold){
-						//do not prepare shared batch unless we're sure it will be compressed
-						$stream = new BinaryStream();
-						PacketBatch::encodeRaw($stream, $packetBuffers[$bufferId]);
-						$batchBuffer = $stream->getBuffer();
-					}
-				}else{
-					//this is a legacy compressor, so we have to encode the batch and check if it will compress
+				$threshold = $compressor->getCompressionThreshold();
+				if(count($compressorTargets) > 1 && $threshold !== null && $packetBufferTotalLengths[$bufferId] >= $threshold){
+					//do not prepare shared batch unless we're sure it will be compressed
 					$stream = new BinaryStream();
 					PacketBatch::encodeRaw($stream, $packetBuffers[$bufferId]);
-					$tempBatchBuffer = $stream->getBuffer();
-					if($compressor->willCompress($tempBatchBuffer)){
-						$batchBuffer = $tempBatchBuffer;
-					}
-				}
+					$batchBuffer = $stream->getBuffer();
 
-				if($batchBuffer === null){
+					$promise = $this->server->prepareBatch(new PacketBatch($batchBuffer), $compressor, timings: Timings::$playerNetworkSendCompressBroadcast);
+					foreach($compressorTargets as $target){
+						$target->queueCompressed($promise);
+					}
+				}else{
 					foreach($compressorTargets as $target){
 						foreach($packetBuffers[$bufferId] as $packetBuffer){
 							$target->addToSendBuffer($packetBuffer);
 						}
 					}
-				}else{
-					$promise = $this->server->prepareBatch(new PacketBatch($batchBuffer), $compressor);
-					foreach($compressorTargets as $target){
-						$target->queueCompressed($promise);
-					}
 				}
 			}
 		}

src/network/mcpe/compression/Compressor.php

@@ -24,13 +24,20 @@ declare(strict_types=1);
 namespace pocketmine\network\mcpe\compression;
 
 interface Compressor{
-
-	public function willCompress(string $data) : bool;
-
 	/**
 	 * @throws DecompressionException
 	 */
 	public function decompress(string $payload) : string;
 
 	public function compress(string $payload) : string;
+
+	/**
+	 * Returns the minimum size of packet batch that the compressor will attempt to compress.
+	 *
+	 * The compressor's output **MUST** still be valid input for the decompressor even if the compressor input is
+	 * below this threshold.
+	 * However, it may choose to use a cheaper compression option (e.g. zlib level 0, which simply wraps the data and
+	 * doesn't attempt to compress it) to avoid wasting CPU time.
+	 */
+	public function getCompressionThreshold() : ?int;
 }

src/network/mcpe/compression/ThresholdCompressor.php

@@ -1,31 +0,0 @@
-<?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 pocketmine\network\mcpe\compression;
-
-interface ThresholdCompressor extends Compressor{
-	/**
-	 * Returns the minimum size of packet batch that will be compressed. Null means that no packets will be compressed.
-	 */
-	public function getCompressionThreshold() : ?int;
-}

src/network/mcpe/compression/ZlibCompressor.php

@@ -32,7 +32,7 @@ use function zlib_decode;
 use function zlib_encode;
 use const ZLIB_ENCODING_RAW;
 
-final class ZlibCompressor implements ThresholdCompressor{
+final class ZlibCompressor implements Compressor{
 	use SingletonTrait;
 
 	public const DEFAULT_LEVEL = 7;
@@ -56,10 +56,6 @@ final class ZlibCompressor implements ThresholdCompressor{
 		return $this->minCompressionSize;
 	}
 
-	public function willCompress(string $data) : bool{
-		return $this->minCompressionSize !== null && strlen($data) >= $this->minCompressionSize;
-	}
-
 	/**
 	 * @throws DecompressionException
 	 */
@@ -76,11 +72,12 @@ final class ZlibCompressor implements ThresholdCompressor{
 	}
 
 	public function compress(string $payload) : string{
+		$compressible = $this->minCompressionSize !== null && strlen($payload) >= $this->minCompressionSize;
 		if(function_exists('libdeflate_deflate_compress')){
-			return $this->willCompress($payload) ?
+			return $compressible ?
 				libdeflate_deflate_compress($payload, $this->level) :
 				self::zlib_encode($payload, 0);
 		}
-		return self::zlib_encode($payload, $this->willCompress($payload) ? $this->level : 0);
+		return self::zlib_encode($payload, $compressible ? $this->level : 0);
 	}
 }

src/timings/Timings.php

@@ -44,6 +44,8 @@ abstract class Timings{
 	public static TimingsHandler $titleTick;
 	public static TimingsHandler $playerNetworkSend;
 	public static TimingsHandler $playerNetworkSendCompress;
+	public static TimingsHandler $playerNetworkSendCompressBroadcast;
+	public static TimingsHandler $playerNetworkSendCompressSessionBuffer;
 	public static TimingsHandler $playerNetworkSendEncrypt;
 	public static TimingsHandler $playerNetworkReceive;
 	public static TimingsHandler $playerNetworkReceiveDecompress;
@@ -120,6 +122,8 @@ abstract class Timings{
 
 		self::$playerNetworkSend = new TimingsHandler("Player Network Send");
 		self::$playerNetworkSendCompress = new TimingsHandler(self::INCLUDED_BY_OTHER_TIMINGS_PREFIX . "Player Network Send - Compression", self::$playerNetworkSend);
+		self::$playerNetworkSendCompressBroadcast = new TimingsHandler(self::INCLUDED_BY_OTHER_TIMINGS_PREFIX . "Player Network Send - Compression (Broadcast)", self::$playerNetworkSendCompress);
+		self::$playerNetworkSendCompressSessionBuffer = new TimingsHandler(self::INCLUDED_BY_OTHER_TIMINGS_PREFIX . "Player Network Send - Compression (Session Buffer)", self::$playerNetworkSendCompress);
 		self::$playerNetworkSendEncrypt = new TimingsHandler(self::INCLUDED_BY_OTHER_TIMINGS_PREFIX . "Player Network Send - Encryption", self::$playerNetworkSend);
 
 		self::$playerNetworkReceive = new TimingsHandler("Player Network Receive");