Zenstruck\ScheduleBundle\EventListener\ScheduleConsoleOutputSubscriber

Complexity

Total Complexity

25

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getSubscribedEvents()	0	7	1
B	beforeSchedule()	0	20	7
A	afterTaskMessage()	0	15	4
A	__construct()	0	3	1
B	afterSchedule()	0	37	7
A	afterTask()	0	16	3
A	beforeTask()	0	10	2

<?php

namespace Zenstruck\ScheduleBundle\EventListener;

use Symfony\Component\Console\Style\OutputStyle;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Zenstruck\ScheduleBundle\Event\AfterScheduleEvent;
use Zenstruck\ScheduleBundle\Event\AfterTaskEvent;
use Zenstruck\ScheduleBundle\Event\BeforeScheduleEvent;
use Zenstruck\ScheduleBundle\Event\BeforeTaskEvent;
use Zenstruck\ScheduleBundle\Schedule\Task\Result;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class ScheduleConsoleOutputSubscriber implements EventSubscriberInterface
{
    /** @var OutputStyle */
    private $io;

    public function __construct(OutputStyle $io)
    {
        $this->io = $io;
    }

    public static function getSubscribedEvents(): array
    {
        return [
            BeforeScheduleEvent::class => 'beforeSchedule',
            AfterScheduleEvent::class => 'afterSchedule',
            BeforeTaskEvent::class => 'beforeTask',
            AfterTaskEvent::class => 'afterTask',
        ];
    }

    public function afterSchedule(AfterScheduleEvent $event): void
    {
        $context = $event->runContext();

        if ($context->isSkipped()) {
            $this->io->note($context->getSkipReason());

            return;
        }

        $total = \count($context->getResults());
        $successful = \count($context->getSuccessful());
        $failures = \count($context->getFailures());
        $skipped = \count($context->getSkipped());
        $run = \count($context->getRun());
        $messages = ["{$run}/{$total} tasks ran"];

        if (0 === $total) {
            return;
        }

        if ($successful > 0) {
            $messages[] = "{$successful} succeeded";
        }

        if ($skipped > 0) {
            $messages[] = "{$skipped} skipped";
        }

        if ($failures > 0) {
            $messages[] = "{$failures} failed";
        }

        $messages = \implode(', ', $messages).'.';
        $messages .= " (Duration: {$context->getFormattedDuration()}, Memory: {$context->getFormattedMemory()})";

        $this->io->{$context->isSuccessful() ? 'success' : 'error'}($messages);
    }

    public function beforeSchedule(BeforeScheduleEvent $event): void
    {
        $context = $event->runContext();

        $allTaskCount = \count($context->getSchedule()->all());
        $dueTaskCount = \count($context->dueTasks());

        if ($dueTaskCount > 0) {
            $this->io->{$this->io instanceof SymfonyStyle ? 'comment' : 'text'}(\sprintf(
                '%sRunning <info>%s</info> %stask%s. (%s total tasks)',
                $context->isForceRun() ? '<error>Force</error> ' : '',
                $dueTaskCount,
                $context->isForceRun() ? '' : 'due ',
                $dueTaskCount > 1 ? 's' : '',
                $allTaskCount
            ));
        }

        if ($this->io->isDebug()) {
            $this->io->note(\sprintf('No tasks due to run. (%s total tasks)', $allTaskCount));
        }
    }

    public function beforeTask(BeforeTaskEvent $event): void
    {
        $context = $event->runContext();
        $task = $context->getTask();

        $this->io->text(\sprintf(
            '%s<comment>Running %s:</comment> %s',
            $context->getScheduleRunContext()->isForceRun() ? '<error>Force</error> ' : '',
            $task->getType(),
            $task->getDescription()
        ));
    }

    public function afterTask(AfterTaskEvent $event): void
    {
        $context = $event->runContext();

        if ($this->io->isVerbose() && $output = $context->getResult()->getOutput()) {
            $this->io->text('---begin output---');
            $this->io->write($output);
            $this->io->text('---end output---');
        }

        $this->io->text(\sprintf('%s (<comment>Duration:</comment> %s, <comment>Memory:</comment> %s)',
            $this->afterTaskMessage($context->getResult()),
            $context->getFormattedDuration(),
            $context->getFormattedMemory()
        ));
        $this->io->newLine();
    }

    private function afterTaskMessage(Result $result): string
    {
        if ($result->isException()) {
            return "<error>Exception:</error> {$result->getDescription()}";
        }

        if ($result->isFailure()) {
            return "<error>Failure:</error> {$result->getDescription()}";
        }

        if ($result->isSkipped()) {
            return "<question>Skipped:</question> {$result->getDescription()}";
        }

        return '<info>Success.</info>';
    }
}