Proof of Concept: SAGA

Проблема

Если совсем коротко, то это согласованность действий, и принцип "либо всё, либо ничего".

Различные модули

Допустим, что у нас есть блок данных, которые необходимо поместить в N+1 модуль. Организовать транзакцию средствами базы данных мы не можем, потому что работаем в нескольких базах.

Решение

Любое сложное действие можно разбить на несколько простых.
Чем меньше будет размер "действия", тем больше будет над ним контроля.
Для любого атомарного действия, можно написать его анти-действие.

Решение заключается в том, чтобы разделить один набор действий на максимально атомарные, небольшие задачи, и для каждого шага выполнения (commit) написать его компенсирующий шаг (rollback).

Получаем следующую схему:

Любое действие можно представить как Транзакцию (transaction), которая состоит из Шагов (step).
Каждый шаг умеет выполнять два действия: commit и rollback, и если выполнить сначала commit, а затем rollback, то состояние системы должно быть ровно таким же как если бы ничего не выполнялось.
Все шаги выполняются последовательно, если какой-то шаг не выполнился, то вся транзакция не выполнилась.
Соответственно у транзакции есть только два состояния: либо все шаги выполнились, либо ни один шаг не выполнился.

Реализация

Описываем транзакцию как набор шагов

final class TestTransaction implements TransactionInterface
{
    public function steps(): TransactionStepCollection
    {
        return new TransactionStepCollection(
            new TransactionStep(
                OneStep::class,
                [
                    'name' => 'one',
                ]
            ),
            new TransactionStep(
                TwoStep::class,
                [
                    'name' => 'two',
                ]
            ),
        );
    }
}

Описываем шаги

final class OneStep extends TransactionStepBase
{
    public function __construct(
        public readonly string $name,
    ) {
    }

    public function commit(): bool
    {
        // Полезная работа: запись в хранилище, в очередь...
    
        $this->save(
            TestTransactionData::hydrate(
                [
                    'name' => $this->name,
                    'datetime' => gmdate('c'),
                ]
            )
        );

        return true;
    }

    public function rollback(): bool
    {
        /** @var TestTransactionData $data */
        $data = $this->get(self::class); // получаем Состояние сохранённое при commit
        
        // Полезная работа: удаление из хранилища, компенсационная задача в очередь 
    
        return true;
    }
}

Инициируем экземпляр транзакции, и запускаем

/** 
 * @var TransactionRunner $transactionRunner 
 * @var TransactionResult $transaction
 */
$transaction = $transactionRunner->run(
    new TestTransaction()
);

Так же есть возможность подписаться на события commit и rollback, для того чтобы получить доступ к результату из вне.

$transaction = new TestTransaction();

/** @var TransactionRunner $transactionRunner */
$transactionRunner->run(
    $transaction,
    new CommitCallback(
        static function (TransactionStateCollection $data) {
            ...
        }
    ),
    new RollbackCallback(
        static function (TransactionStateCollection $data, Exception $exception) {
            ...
        }
    ),
);

Получаем данные из транзакции

/** 
 * @var TransactionRunner $transactionRunner 
 * @var TransactionResult $transaction
 */
$transaction = $transactionRunner->run(
    new TestTransaction()
);

/** @var TestTransactionData $dataFromTestStep */
$dataFromTestStep = $transaction->state->getData(OneStep::class);

Docker

docker pull ghcr.io/kuaukutsu/php:8.1-cli

Container:

ghcr.io/kuaukutsu/php:${PHP_VERSION}-cli (default)
jakzal/phpqa:php${PHP_VERSION}

shell

docker run --init -it --rm -v "$(pwd):/app" -w /app ghcr.io/kuaukutsu/php:8.1-cli sh

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

make phpunit

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

make psalm

Code Sniffer

make phpcs

Rector

make rector

kuaukutsu / poc-saga