Handles timeouts more gracefully in maintenance tools

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Author: Sesquipedalian

Sources/Maintenance/Migration/MigrationBase.php

@@ -64,15 +64,25 @@ public function execute(): bool
 	/**
 	 * Wrapper for the tool to handle timeout protection.
 	 *
-	 * If a timeout needs to occur, it is handled, ensure that prior to this call, all variables are updated..
+	 * @param ?int $start If set, the current start value will be set to this
+	 *    value before the timeout check itself occurs.
 	 */
 	protected function handleTimeout(?int $start = null): void
 	{
 		if ($start !== null) {
 			Maintenance::setCurrentStart($start);
 		}
 
-		Maintenance::$tool->checkAndHandleTimeout();
+		Maintenance::$tool->checkAndHandleTimeout([
+			'name' => $this->name,
+			'completed' => false,
+			'substep' => Maintenance::getCurrentSubStep(),
+			'start' => Maintenance::getCurrentStart(),
+			'total' => Maintenance::$total_substeps,
+			'debug' => [
+				'call' => $this::class,
+			],
+		]);
 	}
 
 	/**

Sources/Maintenance/Tools/ToolsBase.php

@@ -547,23 +547,31 @@ final public function detectLanguages(array $key_files = ['General']): array
 	}
 
 	/**
-	 * This will check if we need to handle a timeout, if so, it sets up data for the next round.
+	 * This will check if we need to handle a timeout, if so, it sets up data
+	 * for the next round.
 	 *
+	 * @param array $json_response_data Data to send in a JSON response if we
+	 *    have timed out. This data is passed to Maintenance::jsonResponse().
+	 *    Only used when Maintenance::isJson() returns true.
 	 * @throws \ValueError
 	 * @throws \Exception
 	 */
-	public function checkAndHandleTimeout(): void
+	public function checkAndHandleTimeout(array $json_response_data = []): void
 	{
 		if (!Maintenance::isOutOfTime()) {
 			return;
 		}
 
+		$this->logProgress(Lang::getTxt('log_paused_step', ['num' => $this->getStep()->getId()], file: 'Maintenance'));
+
 		// If this is not json, we need to do a few things.
 		if (!Maintenance::isJson()) {
 			// We're going to pause after this!
 			Maintenance::$context['pause'] = true;
 
 			Maintenance::setQueryString();
+		} else {
+			Maintenance::jsonResponse($json_response_data);
 		}
 
 		Maintenance::exit(Maintenance::isJson());