Shlinkio\Shlink\CLI\Command\Util\AbstractLockedCommand

Complexity

Total Complexity

3

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

92.31%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	execute()	0	16	2

<?php
declare(strict_types=1);

namespace Shlinkio\Shlink\CLI\Command\Util;

use Shlinkio\Shlink\CLI\Util\ExitCodes;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Lock\Factory as Locker;

use function sprintf;

abstract class AbstractLockedCommand extends Command
{
    /** @var Locker */
    private $locker;

    public function __construct(Locker $locker)
    {
        parent::__construct();
        $this->locker = $locker;
    }

    final protected function execute(InputInterface $input, OutputInterface $output): ?int
    {
        $lockConfig = $this->getLockConfig();
        $lock = $this->locker->createLock($lockConfig->lockName(), $lockConfig->ttl(), $lockConfig->isBlocking());

        if (! $lock->acquire($lockConfig->isBlocking())) {
            $output->writeln(
                sprintf('<comment>Command "%s" is already in progress. Skipping.</comment>', $lockConfig->lockName())
            );
            return ExitCodes::EXIT_WARNING;
        }

        try {
            return $this->lockedExecute($input, $output);
        } finally {
            $lock->release();
        }
    }

    abstract protected function lockedExecute(InputInterface $input, OutputInterface $output): int;

    abstract protected function getLockConfig(): LockedCommandConfig;
}