Show individual sql schema migration steps during upgrade - on web as well as on the command line

This commit is contained in:
Thomas Müller 2016-03-30 23:38:26 +02:00
parent 53c1902706
commit 1bf4c75e8b
8 changed files with 128 additions and 31 deletions

View File

@ -26,6 +26,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
use Symfony\Component\EventDispatcher\GenericEvent;
set_time_limit(0);
require_once '../../lib/base.php';
@ -53,6 +55,13 @@ if (OC::checkUpgrade(false)) {
$incompatibleApps = [];
$disabledThirdPartyApps = [];
$dispatcher = \OC::$server->getEventDispatcher();
$dispatcher->addListener('\OC\DB\Migrator::executeSql', function($event) use ($eventSource, $l) {
if ($event instanceof GenericEvent) {
$eventSource->send('success', (string)$l->t('[%d / %d]: %s', [$event[0], $event[1], $event->getSubject()]));
}
});
$updater->listen('\OC\Updater', 'maintenanceEnabled', function () use ($eventSource, $l) {
$eventSource->send('success', (string)$l->t('Turned on maintenance mode'));
});
@ -132,6 +141,9 @@ if (OC::checkUpgrade(false)) {
$disabledApps[$app] = (string) $l->t('%s (incompatible)', [$app]);
}
$disabledApps=[
'Contacts Plus (incompatible)'
];
if (!empty($disabledApps)) {
$eventSource->send('notice',
(string)$l->t('Following apps have been disabled: %s', implode(', ', $disabledApps)));

View File

@ -34,9 +34,11 @@ use OC\Updater;
use OCP\IConfig;
use OCP\ILogger;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\EventDispatcher\GenericEvent;
class Upgrade extends Command {
@ -135,6 +137,24 @@ class Upgrade extends Command {
$updater->setSimulateStepEnabled($simulateStepEnabled);
$updater->setUpdateStepEnabled($updateStepEnabled);
$updater->setSkip3rdPartyAppsDisable($skip3rdPartyAppsDisable);
$dispatcher = \OC::$server->getEventDispatcher();
$progress = new ProgressBar($output);
$progress->setFormat("%message%\n %current%/%max% [%bar%] %percent:3s%%");
$dispatcher->addListener('\OC\DB\Migrator::executeSql', function($event) use ($progress, $output) {
if ($event instanceof GenericEvent) {
if ($event[0] === 1) {
$output->writeln('');
$progress->start($event[1]);
}
$progress->setMessage($event->getSubject());
$progress->setProgress($event[0]);
$progress->display();
if ($event[0] === $event[1]) {
$progress->finish();
$output->writeln('');
}
}
});
$updater->listen('\OC\Updater', 'maintenanceEnabled', function () use($output) {
$output->writeln('<info>Turned on maintenance mode</info>');

9
core/css/update.css Normal file
View File

@ -0,0 +1,9 @@
#update-progress-icon {
height: 32px;
margin: 10px;
background-size: 32px;
}
#update-progress-message {
margin-bottom: 10px;
}

View File

@ -28,38 +28,47 @@
this._started = true;
var self = this;
$(window).on('beforeunload.inprogress', function () {
return t('core', 'The upgrade is in progress, leaving this page might interrupt the process in some environments.');
});
this.addMessage(t(
$('#update-progress-title').html(t(
'core',
'Updating {productName} to version {version}, this may take a while.', {
productName: options.productName || 'ownCloud',
'Updating to {version}', {
version: options.version
}),
'bold'
).append('<br />'); // FIXME: these should be ul/li with CSS paddings!
})
);
var updateEventSource = new OC.EventSource(OC.webroot+'/core/ajax/update.php');
updateEventSource.listen('success', function(message) {
$('<span>').append(message).append('<br />').appendTo($el);
self.setMessage(message);
});
updateEventSource.listen('notice', function(message) {
$('<span>').addClass('error').append(message).append('<br />').appendTo($el);
self.setPermanentMessage(message);
hasWarnings = true;
});
updateEventSource.listen('error', function(message) {
$('#update-progress-message').hide();
$('#update-progress-icon')
.addClass('icon-error-white')
.removeClass('icon-loading-dark');
message = message || t('core', 'An error occurred.');
$(window).off('beforeunload.inprogress');
$('<span>').addClass('error').append(message).append('<br />').appendTo($el);
self.setErrorMessage(message);
message = t('core', 'Please reload the page.');
$('<span>').addClass('error').append('<a href=".">'+message+'</a><br />').appendTo($el);
updateEventSource.close();
});
updateEventSource.listen('failure', function(message) {
$(window).off('beforeunload.inprogress');
$('<span>').addClass('error').append(message).append('<br />').appendTo($el);
$('#update-progress-message').hide();
$('#update-progress-icon')
.addClass('icon-error-white')
.removeClass('icon-loading-dark');
self.setErrorMessage(message);
var span = $('<span>')
.addClass('bold');
if(message === 'Exception: Updates between multiple major versions and downgrades are unsupported.') {
@ -74,8 +83,14 @@
updateEventSource.listen('done', function() {
$(window).off('beforeunload.inprogress');
$('#update-progress-message').hide();
$('#update-progress-icon')
.addClass('icon-checkmark-white')
.removeClass('icon-loading-dark');
if (hasWarnings) {
$('<span>').addClass('bold')
$('<span>')
.append('<br />')
.append(t('core', 'The update was successful. There were warnings.'))
.appendTo($el);
@ -83,7 +98,7 @@
$('<span>').append('<br />').append(message).append('<br />').appendTo($el);
} else {
// FIXME: use product name
$('<span>').addClass('bold')
$('<span>')
.append('<br />')
.append(t('core', 'The update was successful. Redirecting you to ownCloud now.'))
.appendTo($el);
@ -94,10 +109,21 @@
});
},
addMessage: function(message, className) {
var $span = $('<span>');
$span.addClass(className).append(message).append('<br />').appendTo(this.$el);
return $span;
setMessage: function(message) {
$('#update-progress-message').html(message);
},
setPermanentMessage: function(message) {
$('#update-progress-message').html(message);
$('#update-progress-message-warnings')
.show()
.append($('<ul>').append(message))
},
setErrorMessage: function (message) {
$('#update-progress-message-error')
.show()
.html(message);
}
};
@ -106,12 +132,14 @@
$(document).ready(function() {
$('.updateButton').on('click', function() {
var $updateEl = $('.update');
var $progressEl = $('.updateProgress');
var $progressEl = $('.update-progress');
$progressEl.removeClass('hidden');
$('.updateOverview').addClass('hidden');
$('#update-progress-message-error').hide();
$('#update-progress-message-warnings').hide();
OC.Update.start($progressEl, {
productName: $updateEl.attr('data-productname'),
version: $updateEl.attr('data-version'),
version: $updateEl.attr('data-version')
});
return false;
});

View File

@ -41,5 +41,11 @@
</div>
</div>
<div class="updateProgress hidden"></div>
<div class="update-progress hidden">
<h2 id="update-progress-title"></h2>
<div id="update-progress-icon" class="icon-loading-dark"></div>
<p id="update-progress-message-error" class="warning hidden"></p>
<ul id="update-progress-message-warnings" class="warning hidden"></ul>
<p id="update-progress-message"></p>
</div>
</div>

View File

@ -365,6 +365,7 @@ class OC {
$systemConfig->setValue('theme', '');
\OCP\Util::addScript('config'); // needed for web root
\OCP\Util::addScript('update');
\OCP\Util::addStyle('update');
// check whether this is a core update or apps update
$installedVersion = $systemConfig->getValue('version', '0.0.0');

View File

@ -32,15 +32,14 @@ use Doctrine\DBAL\Platforms\MySqlPlatform;
use Doctrine\DBAL\Platforms\OraclePlatform;
use Doctrine\DBAL\Platforms\PostgreSqlPlatform;
use Doctrine\DBAL\Platforms\SqlitePlatform;
use OCP\IDBConnection;
class MDB2SchemaManager {
/**
* @var \OC\DB\Connection $conn
*/
/** @var \OC\DB\Connection $conn */
protected $conn;
/**
* @param \OCP\IDBConnection $conn
* @param IDBConnection $conn
*/
public function __construct($conn) {
$this->conn = $conn;
@ -77,16 +76,17 @@ class MDB2SchemaManager {
$random = \OC::$server->getSecureRandom();
$platform = $this->conn->getDatabasePlatform();
$config = \OC::$server->getConfig();
$dispatcher = \OC::$server->getEventDispatcher();
if ($platform instanceof SqlitePlatform) {
return new SQLiteMigrator($this->conn, $random, $config);
return new SQLiteMigrator($this->conn, $random, $config, $dispatcher);
} else if ($platform instanceof OraclePlatform) {
return new OracleMigrator($this->conn, $random, $config);
return new OracleMigrator($this->conn, $random, $config, $dispatcher);
} else if ($platform instanceof MySqlPlatform) {
return new MySQLMigrator($this->conn, $random, $config);
return new MySQLMigrator($this->conn, $random, $config, $dispatcher);
} else if ($platform instanceof PostgreSqlPlatform) {
return new Migrator($this->conn, $random, $config);
return new Migrator($this->conn, $random, $config, $dispatcher);
} else {
return new NoCheckMigrator($this->conn, $random, $config);
return new NoCheckMigrator($this->conn, $random, $config, $dispatcher);
}
}
@ -94,6 +94,7 @@ class MDB2SchemaManager {
* Reads database schema from file
*
* @param string $file file to read from
* @return \Doctrine\DBAL\Schema\Schema
*/
private function readSchemaFromFile($file) {
$platform = $this->conn->getDatabasePlatform();

View File

@ -35,6 +35,8 @@ use \Doctrine\DBAL\Schema\SchemaConfig;
use \Doctrine\DBAL\Schema\Comparator;
use OCP\IConfig;
use OCP\Security\ISecureRandom;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\GenericEvent;
class Migrator {
@ -51,15 +53,23 @@ class Migrator {
/** @var IConfig */
protected $config;
/** @var EventDispatcher */
private $dispatcher;
/**
* @param Connection $connection
* @param \Doctrine\DBAL\Connection|Connection $connection
* @param ISecureRandom $random
* @param IConfig $config
* @param EventDispatcher $dispatcher
*/
public function __construct(\Doctrine\DBAL\Connection $connection, ISecureRandom $random, IConfig $config) {
public function __construct(\Doctrine\DBAL\Connection $connection,
ISecureRandom $random,
IConfig $config,
EventDispatcher $dispatcher = null) {
$this->connection = $connection;
$this->random = $random;
$this->config = $config;
$this->dispatcher = $dispatcher;
}
/**
@ -215,7 +225,10 @@ class Migrator {
$schemaDiff = $this->getDiff($targetSchema, $connection);
$connection->beginTransaction();
foreach ($schemaDiff->toSql($connection->getDatabasePlatform()) as $sql) {
$sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
$step = 0;
foreach ($sqls as $sql) {
$this->emit($sql, $step++, count($sqls));
$connection->query($sql);
}
$connection->commit();
@ -254,4 +267,11 @@ class Migrator {
protected function getFilterExpression() {
return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
}
protected function emit($sql, $step, $max) {
if(is_null($this->dispatcher)) {
return;
}
$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
}
}