Merge pull request php-service-bus#43 from mmasiukevich/develop

mmasiukevich · web-flow · commit 2afeb3741327 · 2018-09-12T16:22:11.000+03:00
Returns the number of rows affected by the last DELETE, INSERT, or UP…
diff --git a/doc/sagas.md b/doc/sagas.md
@@ -30,29 +30,29 @@
 
 #### Конфигурация
 Конфигурация саг указывается в аннотациях [@SagaHeader](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Annotations/SagaHeader.php) и [@SagaEventListener](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Annotations/SagaEventListener.php) соответсвенно
- - **idClass**: Пространство имён класса идентификатора саги.
- - **expireDateModifier**: Интервал времени, в течение которого сага будет считаться открытой
- - **containingIdProperty**: Поле, в которм будет передаваться идентификатор саги. В нашем примере это поле называется *operationId*. Для того, что бы привязать событие к конкретной саге (ведь одно и то же событие может ждать несколько саг),  нужно передавать идентификатор. Данная опция указывает на то, какое свойство события содержит этот идентификатор. Параметр можно переопределить в рамках конкретного слушателя, указав в аннотации @SagaEventListener нужное значение.
+ - ```idClass```: Пространство имён класса идентификатора саги.
+ - ```expireDateModifier```: Интервал времени, в течение которого сага будет считаться открытой
+ - ```containingIdProperty```: Поле, в которм будет передаваться идентификатор саги. В нашем примере это поле называется *operationId*. Для того, что бы привязать событие к конкретной саге (ведь одно и то же событие может ждать несколько саг),  нужно передавать идентификатор. Данная опция указывает на то, какое свойство события содержит этот идентификатор. Параметр можно переопределить в рамках конкретного слушателя, указав в аннотации @SagaEventListener нужное значение.
  
 Каждый слушатель именуется по следующему шаблону: ```on{EventName}```, где *on* - префикс, а *{EventName}* базовое название класса (без указания пространства имён)
 
 #### Жизненный цикл
-Выполнение саги начинается с команды [start](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L133), которая будет вызвана автоматически (пример создания ниже). В рамках саги доступны методы (имеют protected область видимости):
-- [fire](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L191): Отправляет в транспорт команду
-- [raise](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L174): Отправляет в транспорт событие
-- [makeCompleted](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L209): Закрывает сагу, помечая её, как успешную
-- [makeFailed](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L228): Завершает сагу, помечая её, как неуспешную
+Выполнение саги начинается с команды [start()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L133), которая будет вызвана автоматически (пример создания ниже). В рамках саги доступны методы (имеют protected область видимости):
+- [fire()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L191): Отправляет в транспорт команду
+- [raise()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L174): Отправляет в транспорт событие
+- [makeCompleted()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L209): Закрывает сагу, помечая её, как успешную
+- [makeFailed()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Saga.php#L228): Завершает сагу, помечая её, как неуспешную
 
 При изменениях статуса в транспорт будут отправлены события:
-- [SagaCreated](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Contract/SagaCreated.php): Сага была создана
-- [SagaStatusChanged](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Contract/SagaStatusChanged.php): Изменился статус саги
-- [SagaClosed](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Contract/SagaClosed.php): Обработка саги завершена
+- [SagaCreated()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Contract/SagaCreated.php): Сага была создана
+- [SagaStatusChanged()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Contract/SagaStatusChanged.php): Изменился статус саги
+- [SagaClosed()](https://github.com/mmasiukevich/service-bus/blob/master/src/Sagas/Contract/SagaClosed.php): Обработка саги завершена
 
 #### Создание
 Для операций с сагами есть специальный провайдер - [SagaProvider](https://github.com/mmasiukevich/service-bus/blob/master/src/SagaProvider.php), имеющий несколько методов (каждый метод возвращает объект [Promise](https://github.com/amphp/amp/blob/master/lib/Promise.php))
-- [start](https://github.com/mmasiukevich/service-bus/blob/master/src/SagaProvider.php#L78): Создаёт и запускает новую сагу, передавая в неё команду 
-- [obtain](https://github.com/mmasiukevich/service-bus/blob/master/src/SagaProvider.php#L126): Получает существующую сагу из базы данных
-- [save](https://github.com/mmasiukevich/service-bus/blob/master/src/SagaProvider.php#L161): Сохраняет все изменения в саге, а так же триггерит отправку сообщений в транспорт
+- [start()](https://github.com/mmasiukevich/service-bus/blob/master/src/SagaProvider.php#L78): Создаёт и запускает новую сагу, передавая в неё команду 
+- [obtain()](https://github.com/mmasiukevich/service-bus/blob/master/src/SagaProvider.php#L126): Получает существующую сагу из базы данных
+- [save()](https://github.com/mmasiukevich/service-bus/blob/master/src/SagaProvider.php#L161): Сохраняет все изменения в саге, а так же триггерит отправку сообщений в транспорт
 
 #### Примеры кода
 
diff --git a/src/Storage/ResultSet.php b/src/Storage/ResultSet.php
@@ -55,4 +55,13 @@ public function getCurrent();
      * @throws \Desperado\ServiceBus\Storage\Exceptions\ResultSetIterationFailed
      */
     public function lastInsertId(?string $sequence = null);
+
+    /**
+     * Returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement executed
+     *
+     * @return int
+     *
+     * @throws \Desperado\ServiceBus\Storage\Exceptions\ResultSetIterationFailed
+     */
+    public function rowsCount(): int;
 }
diff --git a/src/Storage/SQL/AmpPostgreSQL/AmpPostgreSQLResultSet.php b/src/Storage/SQL/AmpPostgreSQL/AmpPostgreSQLResultSet.php
@@ -13,6 +13,7 @@
 
 namespace Desperado\ServiceBus\Storage\SQL\AmpPostgreSQL;
 
+use Amp\Postgres\PgSqlCommandResult;
 use Amp\Promise;
 use Amp\Sql\PooledResultSet;
 use Amp\Success;
@@ -106,4 +107,26 @@ public function lastInsertId(?string $sequence = null): ?string
         }
         // @codeCoverageIgnoreEnd
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function rowsCount(): int
+    {
+        try
+        {
+            if($this->originalResultSet instanceof PgSqlCommandResult)
+            {
+                return $this->originalResultSet->affectedRows();
+            }
+
+            return 0;
+        }
+            // @codeCoverageIgnoreStart
+        catch(\Throwable $throwable)
+        {
+            throw new ResultSetIterationFailed($throwable->getMessage(), $throwable->getCode(), $throwable);
+        }
+        // @codeCoverageIgnoreEnd
+    }
 }
diff --git a/src/Storage/SQL/DoctrineDBAL/DoctrineDBALResultSet.php b/src/Storage/SQL/DoctrineDBAL/DoctrineDBALResultSet.php
@@ -59,6 +59,13 @@ final class DoctrineDBALResultSet implements ResultSet
      */
     private $connection;
 
+    /**
+     * Number of rows affected by the last DELETE, INSERT, or UPDATE statement
+     *
+     * @var int
+     */
+    private $affectedRows;
+
     /**
      * @param Connection $connection
      * @param Statement  $wrappedStmt
@@ -67,6 +74,7 @@ public function __construct(Connection $connection, Statement $wrappedStmt)
     {
         $this->connection   = $connection;
         $this->fetchResult  = $wrappedStmt->fetchAll();
+        $this->affectedRows = $wrappedStmt->rowCount();
         $this->resultsCount = \count($this->fetchResult);
     }
 
@@ -105,4 +113,12 @@ public function lastInsertId(?string $sequence = null): ?string
     {
         return $this->connection->lastInsertId($sequence);
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function rowsCount(): int
+    {
+        return $this->affectedRows;
+    }
 }
diff --git a/tests/Storage/SQL/BaseStorageAdapterTest.php b/tests/Storage/SQL/BaseStorageAdapterTest.php
@@ -352,6 +352,71 @@ public function uniqueKeyCheckFailed(): void
         wait(new Coroutine($handler($this)));
     }
 
+    /**
+     * @test
+     *
+     * @return void
+     *
+     * @throws \Throwable
+     */
+    public function rowsCount(): void
+    {
+        $handler = static function(BaseStorageAdapterTest $self): \Generator
+        {
+            try
+            {
+                $adapter = static::getAdapter();
+
+                /** @var \Desperado\ServiceBus\Storage\ResultSet $result */
+                $result = yield $adapter->execute(
+                    'INSERT INTO storage_test_table (id, identifier_class) VALUES (?, ?), (?, ?)',
+                    [
+                        '77961031-fd0f-4946-b439-dfc2902b961a', 'SomeIdentifierClass',
+                        '77961031-fd0f-4946-b439-dfc2902b961d', 'SomeIdentifierClass'
+                    ]
+                );
+
+                static::assertSame(2, $result->rowsCount());
+
+                unset($result);
+
+                /** @var \Desperado\ServiceBus\Storage\ResultSet $result */
+                $result = yield $adapter->execute(
+                    'DELETE FROM storage_test_table where id = \'77961031-fd0f-4946-b439-dfc2902b961d\''
+                );
+
+                static::assertSame(1, $result->rowsCount());
+
+                unset($result);
+
+                yield $adapter->execute('DELETE FROM storage_test_table');
+
+                /** @var \Desperado\ServiceBus\Storage\ResultSet $result */
+                $result = yield $adapter->execute('DELETE FROM storage_test_table');
+
+                static::assertSame(0, $result->rowsCount());
+
+                unset($result);
+
+                /** @var \Desperado\ServiceBus\Storage\ResultSet $result */
+                $result = yield $adapter->execute(
+                    'SELECT * FROM storage_test_table where id = \'77961031-fd0f-4946-b439-dfc2902b961d\''
+                );
+
+                static::assertSame(0, $result->rowsCount());
+
+                unset($result);
+            }
+            catch(\Throwable $throwable)
+            {
+                /** @noinspection StaticInvocationViaThisInspection */
+                $self->fail($throwable->getMessage());
+            }
+        };
+
+        wait(new Coroutine($handler($this)));
+    }
+
     /**
      * @param StorageAdapter $adapter
      *
