LaravelFreelancerNL / laravel-arangodb

src/Concerns/ManagesTransactions.php

<?php

declare(strict_types=1);

namespace LaravelFreelancerNL\Aranguent\Concerns;

use Closure;
use LaravelFreelancerNL\Aranguent\Exceptions\NoArangoClientException;
use Throwable;

trait ManagesTransactions
{
    /**
     * Execute a Closure within a transaction.
     *
     * @param \Closure $callback
     * @param  int  $attempts
     * @param  array<mixed> $collections
     *
     * @return mixed
     *
     * @throws \Throwable
     */
    public function transaction(Closure $callback, $attempts = 1, array $collections = [])
    {
        for ($currentAttempt = 1; $currentAttempt <= $attempts; $currentAttempt++) {
            $this->beginTransaction($collections);

            // We'll simply execute the given callback within a try / catch block and if we
            // catch any exception we can rollback this transaction so that none of this
            // gets actually persisted to a database or stored in a permanent fashion.
            try {
                $callbackResult = $callback($this);
            } catch (Throwable $e) {
                // If we catch an exception we'll rollback this transaction and try again if we
                // are not out of attempts. If we are out of attempts we will just throw the
                // exception back out and let the developer handle an uncaught exceptions.

                $this->handleTransactionException(

It seems like handleTransactionException() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $e,
                    $currentAttempt,
                    $attempts,
                );

                continue;
            }

            try {
                if ($this->transactions == 1) {
                    $this->commit();
                }

                $this->transactions = max(0, $this->transactions - 1);

The property transactions does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            } catch (Throwable $e) {
                $this->handleCommitTransactionException(

It seems like handleCommitTransactionException() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $e,
                    $currentAttempt,
                    $attempts,
                );

                continue;
            }

            $this->fireConnectionEvent('committed');

It seems like fireConnectionEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $callbackResult;
        }
    }

    /**
     * Start a new database transaction.
     *
     * @param  array<string, array<string>>  $collections
     *
     * @throws Throwable
     */
    public function beginTransaction(array $collections = []): void
    {
        $this->createTransaction($collections);

        $this->transactions++;

        $this->fireConnectionEvent('beganTransaction');
    }

    /**
     * Create a transaction within the database.
     *
     * @param  array<string, array<string>>  $collections
     *
     * @throws Throwable
     */
    protected function createTransaction(array $collections = []): void
    {
        if ($this->transactions == 0) {
            $this->reconnectIfMissingConnection();

It seems like reconnectIfMissingConnection() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            try {
                if ($this->arangoClient === null) {
                    throw new NoArangoClientException();
                }
                $this->arangoClient->begin($collections);
            } catch (Throwable $e) {
                $this->handleBeginTransactionException($e);

It seems like handleBeginTransactionException() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            }
        }
    }

    /**
     * Commit the active database transaction.
     *
     * @return void
     *
     * @throws Throwable
     */
    public function commit()
    {
        if ($this->arangoClient === null) {
            throw new NoArangoClientException();
        }

        if ($this->transactions == 1) {
            $this->arangoClient->commit();
        }

        $this->transactions = max(0, $this->transactions - 1);

The property transactions does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->fireConnectionEvent('committed');
    }

    /**
     * Rollback the active database transaction.
     *
     * @param  int|null  $toLevel
     * @return void
     *
     * @throws \Throwable
     */
    public function rollBack($toLevel = null)
    {
        // We allow developers to rollback to a certain transaction level. We will verify
        // that this given transaction level is valid before attempting to rollback to
        // that level. If it's not we will just return out and not attempt anything.
        $toLevel = is_null($toLevel)
            ? $this->transactions - 1
            : $toLevel;

        if ($toLevel < 0 || $toLevel >= $this->transactions) {
            return;
        }

        // Next, we will actually perform this rollback within this database and fire the
        // rollback event. We will also set the current transaction level to the given
        // level that was passed into this method so it will be right from here out.
        try {
            $this->performRollBack($toLevel);
        } catch (Throwable $e) {
            $this->handleRollBackException($e);

It seems like handleRollBackException() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        $this->transactions = $toLevel;

The property transactions does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->fireConnectionEvent('rollingBack');
    }

    /**
     * Perform a rollback within the database.
     *
     * @param  int  $toLevel
     * @return void
     *
     * @throws Throwable
     */
    protected function performRollBack($toLevel)
    {
        if ($this->arangoClient === null) {
            throw new NoArangoClientException();
        }

        if ($toLevel == 0) {
            $this->arangoClient->abort();
        }
    }
}