[ticket/13126] Improve the feedback when running the migrations

PHPBB3-13126

phpBB/phpbb/db/migrator.php

@@ -67,6 +67,13 @@ class migrator
 	*/
 	public $last_run_migration = false;
 
+	/**
+	 * The output handler. A null handler is configured by default.
+	 *
+	 * @var migrator_output_handler
+	 */
+	public $output_handler;
+
 	/**
 	* Constructor of the database migrator
 	*/
@@ -84,6 +91,8 @@ class migrator
 
 		$this->table_prefix = $table_prefix;
 
+		$this->output_handler = new migrator_output_handler();
+
 		foreach ($tools as $tool)
 		{
 			$this->tools[$tool->get_name()] = $tool;
@@ -94,6 +103,16 @@ class migrator
 		$this->load_migration_state();
 	}
 
+	/**
+	 * Set the output handler.
+	 *
+	 * @param migrator_output_handler $handler The output handler
+	 */
+	public function set_output_handler(migrator_output_handler $handler)
+	{
+		$this->output_handler = $handler;
+	}
+
 	/**
 	* Loads all migrations and their application state from the database.
 	*
@@ -161,6 +180,10 @@ class migrator
 					return;
 				}
 			}
+			else
+			{
+				$this->output_handler->write(array('MIGRATION_EFFECTIVELY_INSTALLED', $name), migrator_output_handler::VERBOSITY_DEBUG);
+			}
 		}
 	}
 
@@ -175,6 +198,7 @@ class migrator
 	{
 		if (!class_exists($name))
 		{
+			$this->output_handler->write(array('MIGRATION_NOT_VALID', $name), migrator_output_handler::VERBOSITY_DEBUG);
 			return false;
 		}
 
@@ -191,6 +215,11 @@ class migrator
 				'migration_end_time'	=> 0,
 			);
 
+		if (!empty($state['migration_depends_on']))
+		{
+			$this->output_handler->write(array('MIGRATION_APPLY_DEPENDENCIES', $name), migrator_output_handler::VERBOSITY_DEBUG);
+		}
+
 		foreach ($state['migration_depends_on'] as $depend)
 		{
 			if ($this->unfulfillable($depend) !== false)
@@ -227,6 +256,8 @@ class migrator
 				);
 
 				$this->last_run_migration['effectively_installed'] = true;
+
+				$this->output_handler->write(array('MIGRATION_EFFECTIVELY_INSTALLED', $name), migrator_output_handler::VERBOSITY_NORMAL);
 			}
 			else
 			{
@@ -238,23 +269,43 @@ class migrator
 
 		if (!$state['migration_schema_done'])
 		{
+			$this->output_handler->write(array('MIGRATION_SCHEMA_RUNNING', $name), migrator_output_handler::VERBOSITY_VERY_VERBOSE);
+
 			$this->last_run_migration['task'] = 'process_schema_step';
+			$elapsed_time = microtime(true);
 			$steps = $this->helper->get_schema_steps($migration->update_schema());
 			$result = $this->process_data_step($steps, $state['migration_data_state']);
+			$elapsed_time = microtime(true) - $elapsed_time;
 
 			$state['migration_data_state'] = ($result === true) ? '' : $result;
 			$state['migration_schema_done'] = ($result === true);
+
+			$this->output_handler->write(array('MIGRATION_SCHEMA_DONE', $name, $elapsed_time), migrator_output_handler::VERBOSITY_NORMAL);
 		}
 		else if (!$state['migration_data_done'])
 		{
 			try
 			{
+				$this->output_handler->write(array('MIGRATION_DATA_RUNNING', $name), migrator_output_handler::VERBOSITY_VERY_VERBOSE);
+
 				$this->last_run_migration['task'] = 'process_data_step';
+
+				$elapsed_time = microtime(true);
 				$result = $this->process_data_step($migration->update_data(), $state['migration_data_state']);
+				$elapsed_time = microtime(true) - $elapsed_time;
 
 				$state['migration_data_state'] = ($result === true) ? '' : $result;
 				$state['migration_data_done'] = ($result === true);
 				$state['migration_end_time'] = ($result === true) ? time() : 0;
+
+				if ($state['migration_schema_done'])
+				{
+					$this->output_handler->write(array('MIGRATION_DATA_DONE', $name, $elapsed_time), migrator_output_handler::VERBOSITY_NORMAL);
+				}
+				else
+				{
+					$this->output_handler->write(array('MIGRATION_DATA_IN_PROGRESS', $name, $elapsed_time), migrator_output_handler::VERBOSITY_VERBOSE);
+				}
 			}
 			catch (\phpbb\db\migration\exception $e)
 			{

phpBB/phpbb/db/migrator_output_handler.php

@@ -0,0 +1,55 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\db;
+
+class migrator_output_handler
+{
+	const VERBOSITY_QUIET        = 0;
+	const VERBOSITY_NORMAL       = 1;
+	const VERBOSITY_VERBOSE      = 2;
+	const VERBOSITY_VERY_VERBOSE = 3;
+	const VERBOSITY_DEBUG        = 4;
+
+	/**
+	 * A callable used to write the output.
+	 *
+	 * @var callable
+	 */
+	private $closure;
+
+	/**
+	 * Constructor
+	 *
+	 * @param callable $closure The closure used to write the output. (null by default)
+	 */
+	public function __construct(\Closure $closure = null)
+	{
+		if ($closure === null) {
+			$closure = function($message, $verbosity) {};
+		}
+		$this->closure = $closure;
+	}
+
+	/**
+	 * Write output using the configured closure.
+	 *
+	 * @param string|array $message The message to write or an array containing the language key and all of its parameters.
+	 * @param int $verbosity The verbosity of the message.
+	 */
+	public function write($message, $verbosity)
+	{
+		$closure = $this->closure;
+		$closure((array) $message, $verbosity);
+	}
+}