Skip to content

Port Repair and Migrator events to IEventDispatcher #33640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
come-nc merged 12 commits into from
Aug 30, 2022
Merged

Port Repair and Migrator events to IEventDispatcher #33640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4ba30d4
Switch to string keys for argument of GenericEvent for OC\DB\Migrator
come-nc Aug 22, 2022
4f260dc
Moving to string key for arguments of GenericEvent in Repair
come-nc Aug 22, 2022
5aac997
Remove listeners of \OC\DB\Migrator::checkTable which is never emitted
come-nc Aug 22, 2022
a83a8f0
Migrate Migrator::executeSql to OCP\EventDispatcher\Event
come-nc Aug 22, 2022
a2a7150
Migrate Repair events to OCP\EventDispatcher\Event
come-nc Aug 22, 2022
5d313da
Fix RepairTest
come-nc Aug 23, 2022
e5731b3
Fix BackgroundRepairTest
come-nc Aug 23, 2022
5cfdf9b
Add void return types to callables
come-nc Aug 23, 2022
4ac8173
Declare strict types in all new Event classes
come-nc Aug 25, 2022
652ab6d
Surround cli output with appropriate xml tags
come-nc Aug 25, 2022
9a29025
Parameter of RepairAdvanceEvent is actually an increment, not a step id
come-nc Aug 25, 2022
0b9a878
Flag repair errors as error level in eventSource->send
come-nc Aug 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions build/psalm-baseline.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3946,23 +3946,6 @@
<code>$path</code>
</InvalidReturnStatement>
</file>
<file src="lib/private/Updater.php">
<InvalidScalarArgument occurrences="13">
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>0</code>
<code>1</code>
<code>1</code>
<code>1</code>
<code>1</code>
</InvalidScalarArgument>
</file>
<file src="lib/private/Updater/VersionCheck.php">
<InvalidScalarArgument occurrences="2">
<code>microtime(true)</code>
Expand Down
72 changes: 34 additions & 38 deletions core/Command/Maintenance/Repair.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,31 @@

use Exception;
use OCP\App\IAppManager;
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OC\Repair\Events\RepairAdvanceEvent;
use OC\Repair\Events\RepairErrorEvent;
use OC\Repair\Events\RepairFinishEvent;
use OC\Repair\Events\RepairInfoEvent;
use OC\Repair\Events\RepairStartEvent;
use OC\Repair\Events\RepairStepEvent;
use OC\Repair\Events\RepairWarningEvent;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;

class Repair extends Command {
protected \OC\Repair $repair;
protected IConfig $config;
private EventDispatcherInterface $dispatcher;
private IEventDispatcher $dispatcher;
private ProgressBar $progress;
private OutputInterface $output;
private IAppManager $appManager;

public function __construct(\OC\Repair $repair, IConfig $config, EventDispatcherInterface $dispatcher, IAppManager $appManager) {
public function __construct(\OC\Repair $repair, IConfig $config, IEventDispatcher $dispatcher, IAppManager $appManager) {
$this->repair = $repair;
$this->config = $config;
$this->dispatcher = $dispatcher;
Expand Down Expand Up @@ -102,47 +109,36 @@ protected function execute(InputInterface $input, OutputInterface $output): int

$this->progress = new ProgressBar($output);
$this->output = $output;
$this->dispatcher->addListener('\OC\Repair::startProgress', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::advance', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::finishProgress', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::step', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::info', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::warning', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener('\OC\Repair::error', [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairStartEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairAdvanceEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairFinishEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairStepEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairInfoEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairWarningEvent::class, [$this, 'handleRepairFeedBack']);
$this->dispatcher->addListener(RepairErrorEvent::class, [$this, 'handleRepairFeedBack']);

$this->repair->run();

$this->config->setSystemValue('maintenance', $maintenanceMode);
return 0;
}

public function handleRepairFeedBack($event) {
if (!$event instanceof GenericEvent) {
return;
}
switch ($event->getSubject()) {
case '\OC\Repair::startProgress':
$this->progress->start($event->getArgument(0));
break;
case '\OC\Repair::advance':
$this->progress->advance($event->getArgument(0));
break;
case '\OC\Repair::finishProgress':
$this->progress->finish();
$this->output->writeln('');
break;
case '\OC\Repair::step':
$this->output->writeln(' - ' . $event->getArgument(0));
break;
case '\OC\Repair::info':
$this->output->writeln(' - ' . $event->getArgument(0));
break;
case '\OC\Repair::warning':
$this->output->writeln(' - WARNING: ' . $event->getArgument(0));
break;
case '\OC\Repair::error':
$this->output->writeln('<error> - ERROR: ' . $event->getArgument(0) . '</error>');
break;
public function handleRepairFeedBack(Event $event): void {
if ($event instanceof RepairStartEvent) {
$this->progress->start($event->getMaxStep());
} elseif ($event instanceof RepairAdvanceEvent) {
$this->progress->advance($event->getIncrement());
} elseif ($event instanceof RepairFinishEvent) {
$this->progress->finish();
$this->output->writeln('');
} elseif ($event instanceof RepairStepEvent) {
$this->output->writeln('<info> - ' . $event->getStepName() . '</info>');
} elseif ($event instanceof RepairInfoEvent) {
$this->output->writeln('<info> - ' . $event->getMessage() . '</info>');
} elseif ($event instanceof RepairWarningEvent) {
$this->output->writeln('<comment> - WARNING: ' . $event->getMessage()) . '</comment>';
} elseif ($event instanceof RepairErrorEvent) {
$this->output->writeln('<error> - ERROR: ' . $event->getMessage() . '</error>');
}
}
}
137 changes: 66 additions & 71 deletions core/Command/Upgrade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,26 @@
*/
namespace OC\Core\Command;

use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OCP\Util;
use OC\Console\TimestampFormatter;
use OC\DB\MigratorExecuteSqlEvent;
use OC\Installer;
use OC\Repair\Events\RepairAdvanceEvent;
use OC\Repair\Events\RepairErrorEvent;
use OC\Repair\Events\RepairFinishEvent;
use OC\Repair\Events\RepairInfoEvent;
use OC\Repair\Events\RepairStartEvent;
use OC\Repair\Events\RepairStepEvent;
use OC\Repair\Events\RepairWarningEvent;
use OC\Updater;
use OCP\IConfig;
use OCP\Util;
use Psr\Log\LoggerInterface;
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\EventDispatcher\GenericEvent;

class Upgrade extends Command {
public const ERROR_SUCCESS = 0;
Expand Down Expand Up @@ -92,84 +101,70 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$this->installer
);

$dispatcher = \OC::$server->getEventDispatcher();
/** @var IEventDispatcher $dispatcher */
$dispatcher = \OC::$server->get(IEventDispatcher::class);
$progress = new ProgressBar($output);
$progress->setFormat(" %message%\n %current%/%max% [%bar%] %percent:3s%%");
$listener = function ($event) use ($progress, $output) {
if ($event instanceof GenericEvent) {
$message = $event->getSubject();
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln(' Checking table ' . $message);
} else {
if (strlen($message) > 60) {
$message = substr($message, 0, 57) . '...';
}
$progress->setMessage($message);
if ($event[0] === 1) {
$output->writeln('');
$progress->start($event[1]);
}
$progress->setProgress($event[0]);
if ($event[0] === $event[1]) {
$progress->setMessage('Done');
$progress->finish();
$output->writeln('');
}
$listener = function (MigratorExecuteSqlEvent $event) use ($progress, $output): void {
$message = $event->getSql();
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln(' Executing SQL ' . $message);
} else {
if (strlen($message) > 60) {
$message = substr($message, 0, 57) . '...';
}
}
};
$repairListener = function ($event) use ($progress, $output) {
if (!$event instanceof GenericEvent) {
return;
}
switch ($event->getSubject()) {
case '\OC\Repair::startProgress':
$progress->setMessage('Starting ...');
$output->writeln($event->getArgument(1));
$progress->setMessage($message);
if ($event->getCurrentStep() === 1) {
$output->writeln('');
$progress->start($event->getArgument(0));
break;
case '\OC\Repair::advance':
$desc = $event->getArgument(1);
if (!empty($desc)) {
$progress->setMessage($desc);
}
$progress->advance($event->getArgument(0));

break;
case '\OC\Repair::finishProgress':
$progress->start($event->getMaxStep());
}
$progress->setProgress($event->getCurrentStep());
if ($event->getCurrentStep() === $event->getMaxStep()) {
$progress->setMessage('Done');
$progress->finish();
$output->writeln('');
break;
case '\OC\Repair::step':
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair step: ' . $event->getArgument(0) . '</info>');
}
break;
case '\OC\Repair::info':
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair info: ' . $event->getArgument(0) . '</info>');
}
break;
case '\OC\Repair::warning':
$output->writeln('<error>Repair warning: ' . $event->getArgument(0) . '</error>');
break;
case '\OC\Repair::error':
$output->writeln('<error>Repair error: ' . $event->getArgument(0) . '</error>');
break;
}
}
};
$repairListener = function (Event $event) use ($progress, $output): void {
if ($event instanceof RepairStartEvent) {
$progress->setMessage('Starting ...');
$output->writeln($event->getCurrentStepName());
$output->writeln('');
$progress->start($event->getMaxStep());
} elseif ($event instanceof RepairAdvanceEvent) {
$desc = $event->getDescription();
if (!empty($desc)) {
$progress->setMessage($desc);
}
$progress->advance($event->getIncrement());
} elseif ($event instanceof RepairFinishEvent) {
$progress->setMessage('Done');
$progress->finish();
$output->writeln('');
} elseif ($event instanceof RepairStepEvent) {
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair step: ' . $event->getStepName() . '</info>');
}
} elseif ($event instanceof RepairInfoEvent) {
if (OutputInterface::VERBOSITY_NORMAL < $output->getVerbosity()) {
$output->writeln('<info>Repair info: ' . $event->getMessage() . '</info>');
}
} elseif ($event instanceof RepairWarningEvent) {
$output->writeln('<error>Repair warning: ' . $event->getMessage() . '</error>');
} elseif ($event instanceof RepairErrorEvent) {
$output->writeln('<error>Repair error: ' . $event->getMessage() . '</error>');
}
};

$dispatcher->addListener('\OC\DB\Migrator::executeSql', $listener);
$dispatcher->addListener('\OC\DB\Migrator::checkTable', $listener);
$dispatcher->addListener('\OC\Repair::startProgress', $repairListener);
$dispatcher->addListener('\OC\Repair::advance', $repairListener);
$dispatcher->addListener('\OC\Repair::finishProgress', $repairListener);
$dispatcher->addListener('\OC\Repair::step', $repairListener);
$dispatcher->addListener('\OC\Repair::info', $repairListener);
$dispatcher->addListener('\OC\Repair::warning', $repairListener);
$dispatcher->addListener('\OC\Repair::error', $repairListener);
$dispatcher->addListener(MigratorExecuteSqlEvent::class, $listener);
$dispatcher->addListener(RepairStartEvent::class, $repairListener);
$dispatcher->addListener(RepairAdvanceEvent::class, $repairListener);
$dispatcher->addListener(RepairFinishEvent::class, $repairListener);
$dispatcher->addListener(RepairStepEvent::class, $repairListener);
$dispatcher->addListener(RepairInfoEvent::class, $repairListener);
$dispatcher->addListener(RepairWarningEvent::class, $repairListener);
$dispatcher->addListener(RepairErrorEvent::class, $repairListener);


$updater->listen('\OC\Updater', 'maintenanceEnabled', function () use ($output) {
Expand Down
Loading