Cycle\ORM\Transaction\Runner

Complexity

Total Complexity

29

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Test Coverage

Coverage

82.35%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	complete()	0	17	5
A	rollback()	0	18	5
A	innerTransaction()	0	3	1
A	count()	0	3	1
B	run()	0	32	10
A	outerTransaction()	0	3	2
A	__construct()	0	3	1
A	prepareTransaction()	0	17	4

<?php

declare(strict_types=1);

namespace Cycle\ORM\Transaction;

use Cycle\Database\Driver\DriverInterface;
use Cycle\ORM\Command\CommandInterface;
use Cycle\ORM\Command\CompleteMethodInterface;
use Cycle\ORM\Command\RollbackMethodInterface;
use Cycle\ORM\Command\StoreCommandInterface;
use Cycle\ORM\Exception\RunnerException;
use Traversable;

/**
 * @internal
 */
final class Runner implements RunnerInterface
{
    private const MODE_IGNORE_TRANSACTION = 0;
    private const MODE_CONTINUE_TRANSACTION = 1;
    private const MODE_OPEN_TRANSACTION = 2;

    /** @var DriverInterface[] */
    private array $drivers = [];

    /** @var CommandInterface[] */
    private array $executed = [];

    private int $countExecuted = 0;

    private function __construct(
        private int $mode
    ) {
    }

    public function run(CommandInterface $command): void
    {
        if ($command instanceof Traversable) {
            foreach ($command as $cmd) {
                $this->run($cmd);
            }
            return;
        }
        // found the same link from multiple branches
        if ($command->isExecuted()) {
            $this->countExecuted++;
            return;
        }
        if ($command instanceof StoreCommandInterface && !$command->hasData()) {
            return;
        }

        if ($command->getDatabase() !== null) {
            $driver = $command->getDatabase()->getDriver();

            if (!\in_array($driver, $this->drivers, true)) {
                $this->prepareTransaction($driver);

                $this->drivers[] = $driver;
            }
        }

        $command->execute();
        $this->countExecuted++;

        if ($command instanceof CompleteMethodInterface || $command instanceof RollbackMethodInterface) {
            $this->executed[] = $command;
        }
    }

    public function count(): int
    {
        return $this->countExecuted;
    }

    public function complete(): void
    {
        if ($this->mode === self::MODE_OPEN_TRANSACTION) {
            // Commit all of the open and normalized database transactions
            foreach (array_reverse($this->drivers) as $driver) {
                /** @var DriverInterface $driver */
                $driver->commitTransaction();
            }
        }

        // Other type of transaction to close
        foreach ($this->executed as $command) {
            if ($command instanceof CompleteMethodInterface) {
                $command->complete();
            }
        }
        $this->drivers = $this->executed = [];
    }

    public function rollback(): void
    {
        if ($this->mode === self::MODE_OPEN_TRANSACTION) {
            // Close all open and normalized database transactions
            foreach (array_reverse($this->drivers) as $driver) {
                /** @var DriverInterface $driver */
                $driver->rollbackTransaction();
            }
        }

        // Close all of external types of transactions (revert changes)
        foreach (array_reverse($this->executed) as $command) {
            if ($command instanceof RollbackMethodInterface) {
                $command->rollBack();
            }
        }

        $this->drivers = $this->executed = [];
    }

    /**
     * Create Runner in the 'inner transaction' mode.
     * In this case the Runner will open new transaction for each used driver connection
     * and will close they on finish.
     */
    public static function innerTransaction(): self
    {
        return new self(self::MODE_OPEN_TRANSACTION);
    }

    /**
     * Create Runner in the 'outer transaction' mode.
     * In this case the Runner won't begin transactions, you should do it previously manually.
     * This mode also means the Runner WON'T commit or rollback opened transactions on success or fail.
     * But commands that implement CompleteMethodInterface or RollbackMethodInterface will be called.
     *
     * @param bool $strict Check transaction statuses before commands running.
     *        When strict mode is {@see true} and a transaction of any used driver didn't be opened
     *        the Runner will throw an Exception and stop Unit of Work.
     *        When strict mode is {@see false} the Runner won't begin/commit/rollback transactions
     *        and will ignore any transaction statuses.
     */
    public static function outerTransaction(bool $strict = true): self
    {
        return new self($strict ? self::MODE_CONTINUE_TRANSACTION : self::MODE_IGNORE_TRANSACTION);
    }

    private function prepareTransaction(DriverInterface $driver): void
    {
        if ($this->mode === self::MODE_IGNORE_TRANSACTION) {
            return;
        }

        if ($this->mode === self::MODE_CONTINUE_TRANSACTION) {
            if ($driver->getTransactionLevel() === 0) {
                throw new RunnerException(sprintf(
                    'The `%s` driver connection has no opened transaction.',
                    $driver->getType()
                ));
            }
            return;
        }

        $driver->beginTransaction();
    }
}