Write timings to file on shutdown & add API for writing timings file

src/Server.php

@@ -1500,6 +1500,16 @@ public function shutdown() : void{
 		if($this->isRunning){
 			$this->isRunning = false;
 			$this->signalHandler->unregister();
+
+			if(TimingsHandler::isEnabled()){
+				TimingsHandler::createReportFile(Path::join($this->getDataPath(), "timings"))->onCompletion(
+					function(string $timingsFile) : void{
+						$this->logger->info($this->language->translate(KnownTranslationFactory::pocketmine_command_timings_timingsWrite($timingsFile)));
+						TimingsHandler::setEnabled(false);
+					},
+					fn() => $this->logger->error("Failed to create timings report file")
+				);
+			}
 		}
 	}
 

src/command/defaults/TimingsCommand.php

@@ -26,7 +26,6 @@
 use pocketmine\command\Command;
 use pocketmine\command\CommandSender;
 use pocketmine\command\utils\InvalidCommandSyntaxException;
-use pocketmine\errorhandler\ErrorToExceptionHandler;
 use pocketmine\lang\KnownTranslationFactory;
 use pocketmine\permission\DefaultPermissionNames;
 use pocketmine\player\Player;
@@ -39,24 +38,18 @@
 use pocketmine\YmlServerProperties;
 use Symfony\Component\Filesystem\Path;
 use function count;
-use function fclose;
-use function file_exists;
-use function fopen;
-use function fwrite;
 use function http_build_query;
 use function implode;
 use function is_array;
 use function is_int;
 use function is_string;
 use function json_decode;
-use function mkdir;
 use function strtolower;
 use const CURLOPT_AUTOREFERER;
 use const CURLOPT_FOLLOWLOCATION;
 use const CURLOPT_HTTPHEADER;
 use const CURLOPT_POST;
 use const CURLOPT_POSTFIELDS;
-use const PHP_EOL;
 
 class TimingsCommand extends VanillaCommand{
 
@@ -103,44 +96,28 @@ public function execute(CommandSender $sender, string $commandLabel, array $args
 			TimingsHandler::reload();
 			Command::broadcastCommandMessage($sender, KnownTranslationFactory::pocketmine_command_timings_reset());
 		}elseif($mode === "merged" || $mode === "report" || $paste){
-			$timingsPromise = TimingsHandler::requestPrintTimings();
-			Command::broadcastCommandMessage($sender, KnownTranslationFactory::pocketmine_command_timings_collect());
-			$timingsPromise->onCompletion(
-				fn(array $lines) => $paste ? $this->uploadReport($lines, $sender) : $this->createReportFile($lines, $sender),
-				fn() => throw new AssumptionFailedError("This promise is not expected to be rejected")
-			);
+			if($paste){
+				$timingsPromise = TimingsHandler::requestPrintTimings();
+				Command::broadcastCommandMessage($sender, KnownTranslationFactory::pocketmine_command_timings_collect());
+				$timingsPromise->onCompletion(
+					fn(array $lines) => $this->uploadReport($lines, $sender),
+					fn() => throw new AssumptionFailedError("This promise is not expected to be rejected")
+				);
+			}else{
+				TimingsHandler::createReportFile(Path::join($sender->getServer()->getDataPath(), "timings"))->onCompletion(
+					function(string $timingsFile) use ($sender) : void{
+						Command::broadcastCommandMessage($sender, KnownTranslationFactory::pocketmine_command_timings_timingsWrite($timingsFile));
+					},
+					fn() => $sender->getServer()->getLogger()->error("Failed to create timings report file")
+				);
+			}
 		}else{
 			throw new InvalidCommandSyntaxException();
 		}
 
 		return true;
 	}
 
-	/**
-	 * @param string[] $lines
-	 * @phpstan-param list<string> $lines
-	 */
-	private function createReportFile(array $lines, CommandSender $sender) : void{
-		$index = 0;
-		$timingFolder = Path::join($sender->getServer()->getDataPath(), "timings");
-
-		if(!file_exists($timingFolder)){
-			mkdir($timingFolder, 0777);
-		}
-		$timings = Path::join($timingFolder, "timings.txt");
-		while(file_exists($timings)){
-			$timings = Path::join($timingFolder, "timings" . (++$index) . ".txt");
-		}
-
-		$fileTimings = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => fopen($timings, "a+b"));
-		foreach($lines as $line){
-			fwrite($fileTimings, $line . PHP_EOL);
-		}
-		fclose($fileTimings);
-
-		Command::broadcastCommandMessage($sender, KnownTranslationFactory::pocketmine_command_timings_timingsWrite($timings));
-	}
-
 	/**
 	 * @param string[] $lines
 	 * @phpstan-param list<string> $lines

src/timings/TimingsHandler.php

@@ -24,16 +24,26 @@
 namespace pocketmine\timings;
 
 use pmmp\thread\Thread as NativeThread;
+use pocketmine\errorhandler\ErrorToExceptionHandler;
 use pocketmine\promise\Promise;
 use pocketmine\promise\PromiseResolver;
 use pocketmine\Server;
+use pocketmine\utils\AssumptionFailedError;
 use pocketmine\utils\ObjectSet;
 use pocketmine\utils\Utils;
+use Symfony\Component\Filesystem\Path;
 use function array_merge;
 use function array_push;
+use function date;
+use function fclose;
+use function fopen;
+use function fwrite;
 use function hrtime;
 use function implode;
+use function is_dir;
+use function mkdir;
 use function spl_object_id;
+use const PHP_EOL;
 
 /**
  * @phpstan-type CollectPromise Promise<list<string>>
@@ -332,4 +342,50 @@ public function reset() : void{
 		$this->recordsByParent = [];
 		$this->timingDepth = 0;
 	}
+
+	/**
+	 * Creates a timings report file locally in the provided file path.
+	 * Collects timings data and returns a promise that resolves with the created file.
+	 *
+	 * @param string      $directory directory path to the timings folder.
+	 * @param string|null $fileName  Optional custom file name, If null, uses default timings file naming
+	 *
+	 * @phpstan-return Promise<string>
+	 */
+	public static function createReportFile(string $directory, ?string $fileName = null) : Promise{
+		$timingsPromise = self::requestPrintTimings();
+
+		/** @var PromiseResolver<string> $resolver */
+		$resolver = new PromiseResolver();
+
+		$timingsPromise->onCompletion(
+			function(array $lines) use ($fileName, $directory, $resolver) : void{
+				if($fileName === null){
+					$date = date('Y-m-d_H.i.s_T');
+					$fileName = "timings_{$date}";
+				}
+				if(!@mkdir($directory, 0777, true) && !is_dir($directory)){
+					$resolver->reject();
+					return;
+				}
+				$timingsFile = Path::join($directory, $fileName . ".txt");
+				try{
+					$handle = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => fopen($timingsFile, "x+b"));
+				}catch(\ErrorException){
+					//TODO: it'd be better if we could report this to the promise callback
+					$resolver->reject();
+					return;
+				}
+				foreach($lines as $line){
+					fwrite($handle, $line . PHP_EOL);
+				}
+				fclose($handle);
+
+				$resolver->resolve($timingsFile);
+			},
+			fn() => throw new AssumptionFailedError("This promise is not expected to be rejected")
+		);
+
+		return $resolver->getPromise();
+	}
 }