Implement transaction service

Author: robgridley

composer.json

@@ -10,12 +10,14 @@
     "license": "MIT",
     "require": {
         "php": ">=7.0.0",
+        "ext-soap": "*",
         "nesbot/carbon": "^1.20",
         "doctrine/inflector": "~1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^5.2",
-        "mockery/mockery": "^0.9.4"
+        "mockery/mockery": "^0.9.4",
+        "symfony/var-dumper": "^5.0"
     },
     "autoload": {
         "psr-4": {

src/Client.php

@@ -2,6 +2,7 @@
 
 namespace Pace;
 
+use Closure;
 use InvalidArgumentException;
 use Pace\Soap\DateTimeMapping;
 use Pace\Contracts\Soap\Factory as SoapFactory;
@@ -172,6 +173,42 @@ public function service($name)
         return $this->services[$name] ?? $this->services[$name] = $this->makeService($name);
     }
 
+    /**
+     * Wrap the specified closure in a transaction.
+     *
+     * @param Closure $callback
+     */
+    public function transaction(Closure $callback)
+    {
+        $this->service('TransactionService')->transaction($callback);
+    }
+
+    /**
+     * Start a transaction.
+     *
+     * @param int $timeout
+     */
+    public function startTransaction(int $timeout = 60)
+    {
+        $this->service('TransactionService')->startTransaction($timeout);
+    }
+
+    /**
+     * Rollback the transaction.
+     */
+    public function rollbackTransaction()
+    {
+        $this->service('TransactionService')->rollback();
+    }
+
+    /**
+     * Commit the transaction.
+     */
+    public function commitTransaction()
+    {
+        $this->service('TransactionService')->commit();
+    }
+
     /**
      * Update an object.
      *

src/Services/TransactionService.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Pace\Services;
+
+use Closure;
+use SoapFault;
+use Throwable;
+use Pace\Service;
+use Pace\Soap\SoapClient;
+use Pace\Soap\Middleware\Transaction;
+use Pace\Soap\Middleware\StartTransaction;
+use Pace\Soap\Middleware\CommitTransaction;
+use Pace\Soap\Middleware\RollbackTransaction;
+
+class TransactionService extends Service
+{
+    /**
+     * Wrap the specified closure in a transaction.
+     *
+     * @param Closure $callback
+     */
+    public function transaction(Closure $callback)
+    {
+        $this->startTransaction();
+
+        try {
+            $callback();
+        } catch (SoapFault $exception) {
+            // Pace has already rolled the transaction back.
+            SoapClient::removeMiddleware('transaction');
+            throw $exception;
+        } catch (Throwable $exception) {
+            $this->rollback();
+            throw $exception;
+        }
+
+        $this->commit();
+    }
+
+    /**
+     * Start a new transaction.
+     *
+     * @param int $timeout
+     */
+    public function startTransaction(int $timeout = 60)
+    {
+        SoapClient::addMiddleware('startTransaction', new StartTransaction);
+
+        $response = $this->soap->startTransaction(['in0' => $timeout]);
+
+        SoapClient::removeMiddleware('startTransaction');
+        SoapClient::addMiddleware('transaction', new Transaction($response->out));
+    }
+
+    /**
+     * Rollback the transaction.
+     */
+    public function rollback()
+    {
+        SoapClient::addMiddleware('rollback', new RollbackTransaction);
+
+        $this->soap->rollback();
+
+        SoapClient::removeMiddleware('rollback');
+        SoapClient::removeMiddleware('transaction');
+    }
+
+    /**
+     * Commit the transaction.
+     */
+    public function commit()
+    {
+        SoapClient::addMiddleware('commit', new CommitTransaction);
+
+        $this->soap->commit();
+
+        SoapClient::removeMiddleware('commit');
+        SoapClient::removeMiddleware('transaction');
+    }
+}

src/Soap/Factory.php

@@ -2,7 +2,6 @@
 
 namespace Pace\Soap;
 
-use SoapClient;
 use Pace\Contracts\Soap\TypeMapping;
 use Pace\Contracts\Soap\Factory as FactoryContract;
 

src/Soap/Middleware/CommitTransaction.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Pace\Soap\Middleware;
+
+use SoapHeader;
+
+class CommitTransaction
+{
+    /**
+     * Add the commit transaction SOAP header.
+     *
+     * @param array $headers
+     * @return array
+     */
+    public function __invoke(array $headers): array
+    {
+        $headers[] = new SoapHeader('transaction', 'process', 'commit');
+
+        return $headers;
+    }
+}

src/Soap/Middleware/RollbackTransaction.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Pace\Soap\Middleware;
+
+use SoapHeader;
+
+class RollbackTransaction
+{
+    /**
+     * Add the rollback transaction SOAP header.
+     *
+     * @param array $headers
+     * @return array
+     */
+    public function __invoke(array $headers): array
+    {
+        $headers[] = new SoapHeader('transaction', 'process', 'rollback');
+
+        return $headers;
+    }
+}

src/Soap/Middleware/StartTransaction.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Pace\Soap\Middleware;
+
+use SoapHeader;
+
+class StartTransaction
+{
+    /**
+     * Add the start transaction SOAP header.
+     *
+     * @param array $headers
+     * @return array
+     */
+    public function __invoke(array $headers): array
+    {
+        $headers[] = new SoapHeader('transaction', 'process', 'startTransaction');
+
+        return $headers;
+    }
+}

src/Soap/Middleware/Transaction.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Pace\Soap\Middleware;
+
+use SoapHeader;
+
+class Transaction
+{
+    /**
+     * The transaction ID.
+     *
+     * @var string
+     */
+    protected $id;
+
+    /**
+     * Create a new middleware instance.
+     *
+     * @param string $id
+     */
+    public function __construct(string $id)
+    {
+        $this->id = $id;
+    }
+
+    /**
+     * Add the transaction ID SOAP header.
+     *
+     * @param array $headers
+     * @return array
+     */
+    public function __invoke(array $headers): array
+    {
+        $headers[] = new SoapHeader('transaction', 'txnId', $this->id);
+
+        return $headers;
+    }
+}

src/Soap/SoapClient.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Pace\Soap;
+
+use SoapClient as PhpSoapClient;
+
+class SoapClient extends PhpSoapClient
+{
+    /**
+     * The middleware.
+     *
+     * @var array
+     */
+    protected static $middleware = [];
+
+    /**
+     * Add the specified middleware.
+     *
+     * @param string $name
+     * @param callable $callable
+     */
+    public static function addMiddleware(string $name, callable $callable)
+    {
+        static::$middleware[$name] = $callable;
+    }
+
+    /**
+     * Remove the specified middleware.
+     *
+     * @param string $name
+     */
+    public static function removeMiddleware(string $name)
+    {
+        unset(static::$middleware[$name]);
+    }
+
+    /**
+     * Apply middleware before calling the specified SOAP function.
+     *
+     * @param string $function
+     * @param array $arguments
+     * @return mixed
+     */
+    public function __call($function, $arguments)
+    {
+        $this->applyMiddleware();
+
+        return parent::__call($function, $arguments);
+    }
+
+    /**
+     * Apply the middleware.
+     */
+    protected function applyMiddleware()
+    {
+        $headers = [];
+
+        foreach(static::$middleware as $middleware) {
+            $headers = $middleware($headers);
+        }
+
+        $this->__setSoapHeaders($headers);
+    }
+}