Merge pull request #4420 from Elsensee/ticket/14742-32x

[ticket/14742-32x] Further improvements to migrator

phpBB/phpbb/db/migration/tool/config.php

@@ -152,7 +152,7 @@ class config implements \phpbb\db\migration\tool\tool_interface
 			break;
 
 			case 'reverse':
-				// It's like double negative
+				// Reversing a reverse is just the call itself
 				$call = array_shift($arguments);
 			break;
 		}

phpBB/phpbb/db/migration/tool/config_text.php

@@ -117,7 +117,7 @@ class config_text implements \phpbb\db\migration\tool\tool_interface
 			break;
 
 			case 'reverse':
-				// It's like double negative
+				// Reversing a reverse is just the call itself
 				$call = array_shift($arguments);
 			break;
 		}

phpBB/phpbb/db/migration/tool/module.php

@@ -445,7 +445,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
 			break;
 
 			case 'reverse':
-				// It's like double negative
+				// Reversing a reverse is just the call itself
 				$call = array_shift($arguments);
 			break;
 		}

phpBB/phpbb/db/migration/tool/permission.php

@@ -639,7 +639,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
 			break;
 
 			case 'reverse':
-				// It's like double negative
+				// Reversing a reverse is just the call itself
 				$call = array_shift($arguments);
 			break;
 		}

phpBB/phpbb/db/migrator.php

@@ -362,8 +362,10 @@ class migrator
 			$total_time = (is_array($state['migration_data_state']) && isset($state['migration_data_state']['_total_time'])) ?
 				$state['migration_data_state']['_total_time'] : 0.0;
 			$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;
 			$total_time += $elapsed_time;
 
@@ -397,7 +399,9 @@ class migrator
 				$total_time = (is_array($state['migration_data_state']) && isset($state['migration_data_state']['_total_time'])) ?
 					$state['migration_data_state']['_total_time'] : 0.0;
 				$elapsed_time = microtime(true);
+
 				$result = $this->process_data_step($migration->update_data(), $state['migration_data_state']);
+
 				$elapsed_time = microtime(true) - $elapsed_time;
 				$total_time += $elapsed_time;
 
@@ -421,7 +425,10 @@ class migrator
 			}
 			catch (\phpbb\db\migration\exception $e)
 			{
-				// Revert the schema changes
+				// Reset data state and revert the schema changes
+				$state['migration_data_state'] = '';
+				$this->set_migration_state($name, $state);
+
 				$this->revert_do($name);
 
 				throw $e;
@@ -506,8 +513,10 @@ class migrator
 			$total_time = (is_array($state['migration_data_state']) && isset($state['migration_data_state']['_total_time'])) ?
 				$state['migration_data_state']['_total_time'] : 0.0;
 			$elapsed_time = microtime(true);
+
 			$steps = array_merge($this->helper->reverse_update_data($migration->update_data()), $migration->revert_data());
 			$result = $this->process_data_step($steps, $state['migration_data_state']);
+
 			$elapsed_time = microtime(true) - $elapsed_time;
 			$total_time += $elapsed_time;
 
@@ -539,8 +548,10 @@ class migrator
 			$total_time = (is_array($state['migration_data_state']) && isset($state['migration_data_state']['_total_time'])) ?
 				$state['migration_data_state']['_total_time'] : 0.0;
 			$elapsed_time = microtime(true);
+
 			$steps = $this->helper->get_schema_steps($migration->revert_schema());
 			$result = $this->process_data_step($steps, $state['migration_data_state']);
+
 			$elapsed_time = microtime(true) - $elapsed_time;
 			$total_time += $elapsed_time;
 
@@ -585,6 +596,11 @@ class migrator
 	*/
 	protected function process_data_step($steps, $state, $revert = false)
 	{
+		if (sizeof($steps) === 0)
+		{
+			return true;
+		}
+
 		$state = is_array($state) ? $state : false;
 
 		// reverse order of steps if reverting
@@ -593,65 +609,45 @@ class migrator
 			$steps = array_reverse($steps);
 		}
 
-		end($steps);
-		$last_step_identifier = key($steps);
-
-		foreach ($steps as $step_identifier => $step)
+		$step = $last_result = 0;
+		if ($state)
 		{
-			$last_result = 0;
-			if ($state)
+			$step = $state['step'];
+
+			// We send the result from last time to the callable function
+			$last_result = $state['result'];
+		}
+
+		try
+		{
+			// Result will be null or true if everything completed correctly
+			// Stop after each update step, to let the updater control the script runtime
+			$result = $this->run_step($steps[$step], $last_result, $revert);
+			if (($result !== null && $result !== true) || $step + 1 < sizeof($steps))
 			{
-				// Continue until we reach the step that matches the last step called
-				if ($state['step'] != $step_identifier)
+				return array(
+					'result'	=> $result,
+					// Move on if the last call finished
+					'step'		=> ($result !== null && $result !== true) ? $step : $step + 1,
+				);
+			}
+		}
+		catch (\phpbb\db\migration\exception $e)
+		{
+			// We should try rolling back here
+			foreach ($steps as $reverse_step_identifier => $reverse_step)
+			{
+				// If we've reached the current step we can break because we reversed everything that was run
+				if ($reverse_step_identifier == $step)
 				{
-					continue;
+					break;
 				}
 
-				// We send the result from last time to the callable function
-				$last_result = $state['result'];
-
-				// Set state to false since we reached the point we were at
-				$state = false;
-
-				// There is a tendency to get stuck in some cases
-				if ($last_result === null || $last_result === true)
-				{
-					continue;
-				}
+				// Reverse the step that was run
+				$result = $this->run_step($reverse_step, false, !$revert);
 			}
 
-			try
-			{
-				// Result will be null or true if everything completed correctly
-				// After any schema update step we allow to pause, since
-				// database changes can take quite some time
-				$result = $this->run_step($step, $last_result, $revert);
-				if (($result !== null && $result !== true) ||
-					(strpos($step[0], 'dbtools') === 0 && $step_identifier !== $last_step_identifier))
-				{
-					return array(
-						'result'	=> $result,
-						'step'		=> $step_identifier,
-					);
-				}
-			}
-			catch (\phpbb\db\migration\exception $e)
-			{
-				// We should try rolling back here
-				foreach ($steps as $reverse_step_identifier => $reverse_step)
-				{
-					// If we've reached the current step we can break because we reversed everything that was run
-					if ($reverse_step_identifier == $step_identifier)
-					{
-						break;
-					}
-
-					// Reverse the step that was run
-					$this->run_step($reverse_step, false, !$revert);
-				}
-
-				throw $e;
-			}
+			throw $e;
 		}
 
 		return true;

phpBB/phpbb/db/output_handler/migrator_output_handler_interface.php

@@ -15,11 +15,11 @@ namespace phpbb\db\output_handler;
 
 interface migrator_output_handler_interface
 {
-	const VERBOSITY_QUIET        = 0;
-	const VERBOSITY_NORMAL       = 1;
-	const VERBOSITY_VERBOSE      = 2;
-	const VERBOSITY_VERY_VERBOSE = 3;
-	const VERBOSITY_DEBUG        = 4;
+	const VERBOSITY_QUIET        = 16;
+	const VERBOSITY_NORMAL       = 32;
+	const VERBOSITY_VERBOSE      = 64;
+	const VERBOSITY_VERY_VERBOSE = 128;
+	const VERBOSITY_DEBUG        = 256;
 
 	/**
 	 * Write output using the configured closure.

phpBB/phpbb/install/helper/iohandler/cli_iohandler.php

@@ -198,6 +198,16 @@ class cli_iohandler extends iohandler_base
 
 		if ($this->output->getVerbosity() === OutputInterface::VERBOSITY_NORMAL)
 		{
+			if ($this->progress_bar !== null)
+			{
+				// Symfony's ProgressBar is immutable regarding task_count, so delete the old and create a new one.
+				$this->progress_bar->clear();
+			}
+			else
+			{
+				$this->io->newLine(2);
+			}
+
 			$this->progress_bar = $this->io->createProgressBar($task_count);
 			$this->progress_bar->setFormat(
 				"    %current:3s%/%max:-3s% %bar%  %percent:3s%%\n" .
@@ -212,7 +222,6 @@ class cli_iohandler extends iohandler_base
 			}
 
 			$this->progress_bar->setMessage('');
-			$this->io->newLine(2);
 			$this->progress_bar->start();
 		}
 	}

phpBB/phpbb/install/module/update_database/task/update.php

@@ -158,18 +158,23 @@ class update extends task_base
 			try
 			{
 				$this->migrator->update();
+				$progress_count++;
 
 				$last_run_migration = $this->migrator->get_last_run_migration();
 				if (isset($last_run_migration['effectively_installed']) && $last_run_migration['effectively_installed'])
 				{
-					$progress_count += 2;
-				}
-				else if (($last_run_migration['task'] === 'process_schema_step' && $last_run_migration['state']['migration_schema_done']) ||
-					($last_run_migration['task'] === 'process_data_step' && $last_run_migration['state']['migration_data_done']))
-				{
+					// We skipped two step, so increment $progress_count by another one
 					$progress_count++;
 				}
+				else if (($last_run_migration['task'] === 'process_schema_step' && !$last_run_migration['state']['migration_schema_done']) ||
+					($last_run_migration['task'] === 'process_data_step' && !$last_run_migration['state']['migration_data_done']))
+				{
+					// We just run a step that wasn't counted yet so make it count
+					$migration_step_count++;
+				}
 
+				$this->iohandler->set_task_count($migration_step_count);
+				$this->installer_config->set_task_progress_count($migration_step_count);
 				$this->iohandler->set_progress('STAGE_UPDATE_DATABASE', $progress_count);
 			}
 			catch (exception $e)
@@ -184,6 +189,7 @@ class update extends task_base
 			if ($this->installer_config->get_time_remaining() <= 0 || $this->installer_config->get_memory_remaining() <= 0)
 			{
 				$this->installer_config->set('database_update_count', $progress_count);
+				$this->installer_config->set('database_update_migration_steps', $migration_step_count);
 				throw new resource_limit_reached_exception();
 			}
 		}