[9.1] TransactionCreatedEvent

changelog.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [9.1.0] - 2022-08-08
+### Added
+- TransactionCreatedEvent #538
+
+### Fixed
+- Fixed a bug with sending multiple events inside the queue. Extra events were sent.
+
 ## [9.0.4] - 2022-07-28
 ### Fixed
 - Add allow plugin infection by @rez1dent3 in #528
@@ -889,7 +896,8 @@ The operation is now executed in the transaction and updates the new `refund` fi
 - Exceptions: AmountInvalid, BalanceIsEmpty.
 - Models: Transfer, Transaction.
 
-[Unreleased]: https://github.com/bavix/laravel-wallet/compare/9.0.4...develop
+[Unreleased]: https://github.com/bavix/laravel-wallet/compare/9.1.0...develop
+[9.1.0]: https://github.com/bavix/laravel-wallet/compare/9.0.4...9.1.0
 [9.0.4]: https://github.com/bavix/laravel-wallet/compare/9.0.3...9.0.4
 [9.0.3]: https://github.com/bavix/laravel-wallet/compare/9.0.2...9.0.3
 [9.0.2]: https://github.com/bavix/laravel-wallet/compare/9.0.1...9.0.2

config/config.php

@@ -6,12 +6,14 @@
 use Bavix\Wallet\Internal\Assembler\BalanceUpdatedEventAssembler;
 use Bavix\Wallet\Internal\Assembler\ExtraDtoAssembler;
 use Bavix\Wallet\Internal\Assembler\OptionDtoAssembler;
+use Bavix\Wallet\Internal\Assembler\TransactionCreatedEventAssembler;
 use Bavix\Wallet\Internal\Assembler\TransactionDtoAssembler;
 use Bavix\Wallet\Internal\Assembler\TransactionQueryAssembler;
 use Bavix\Wallet\Internal\Assembler\TransferDtoAssembler;
 use Bavix\Wallet\Internal\Assembler\TransferLazyDtoAssembler;
 use Bavix\Wallet\Internal\Assembler\TransferQueryAssembler;
 use Bavix\Wallet\Internal\Events\BalanceUpdatedEvent;
+use Bavix\Wallet\Internal\Events\TransactionCreatedEvent;
 use Bavix\Wallet\Internal\Events\WalletCreatedEvent;
 use Bavix\Wallet\Internal\Repository\TransactionRepository;
 use Bavix\Wallet\Internal\Repository\TransferRepository;
@@ -139,6 +141,7 @@
         'transaction' => TransactionDtoAssembler::class,
         'transfer_lazy' => TransferLazyDtoAssembler::class,
         'transfer' => TransferDtoAssembler::class,
+        'transaction_created_event' => TransactionCreatedEventAssembler::class,
         'transaction_query' => TransactionQueryAssembler::class,
         'transfer_query' => TransferQueryAssembler::class,
     ],
@@ -149,6 +152,7 @@
     'events' => [
         'balance_updated' => BalanceUpdatedEvent::class,
         'wallet_created' => WalletCreatedEvent::class,
+        'transaction_created' => TransactionCreatedEvent::class,
     ],
 
     /**

docs/_sidebar.md

@@ -44,6 +44,7 @@
 
     - [BalanceUpdatedEvent](balance-updated-event)
     - [WalletCreatedEvent](wallet-created-event)
+    - [TransactionCreatedEvent](transaction-created-event)
     - [Event Customize](event-customize)
 
 - Additions

docs/transaction-created-event.md

@@ -0,0 +1,33 @@
+## Tracking the creation of wallet transactions
+
+The events are similar to the events for updating the balance, only for the creation of a wallet. A frequent case of transferring data via websockets to the front-end.
+
+Version 7.3 introduces an interface to which you can subscribe.
+This is done using standard Laravel methods.
+More information in the [documentation](https://laravel.com/docs/8.x/events).
+
+```php
+use Bavix\Wallet\Internal\Events\TransactionCreatedEventInterface;
+
+protected $listen = [
+    TransactionCreatedEventInterface::class => [
+        MyWalletTransactionCreatedListener::class,
+    ],
+];
+```
+
+And then we create a listener.
+
+```php
+use Bavix\Wallet\Internal\Events\TransactionCreatedEventInterface;
+
+class MyWalletTransactionCreatedListener
+{
+    public function handle(TransactionCreatedEventInterface $event): void
+    {
+        // And then the implementation...
+    }
+}
+```
+
+It worked! 

src/Internal/Assembler/TransactionCreatedEventAssembler.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Internal\Assembler;
+
+use Bavix\Wallet\Internal\Events\TransactionCreatedEvent;
+use Bavix\Wallet\Internal\Events\TransactionCreatedEventInterface;
+use Bavix\Wallet\Internal\Service\ClockServiceInterface;
+use Bavix\Wallet\Models\Transaction;
+
+final class TransactionCreatedEventAssembler implements TransactionCreatedEventAssemblerInterface
+{
+    public function __construct(
+        private ClockServiceInterface $clockService
+    ) {
+    }
+
+    public function create(Transaction $transaction): TransactionCreatedEventInterface
+    {
+        return new TransactionCreatedEvent(
+            (int) $transaction->getKey(),
+            $transaction->type,
+            $transaction->wallet_id,
+            $this->clockService->now(),
+        );
+    }
+}

src/Internal/Assembler/TransactionCreatedEventAssemblerInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Internal\Assembler;
+
+use Bavix\Wallet\Internal\Events\TransactionCreatedEventInterface;
+use Bavix\Wallet\Models\Transaction;
+
+interface TransactionCreatedEventAssemblerInterface
+{
+    public function create(Transaction $transaction): TransactionCreatedEventInterface;
+}

src/Internal/Events/TransactionCreatedEvent.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Internal\Events;
+
+use DateTimeImmutable;
+
+final class TransactionCreatedEvent implements TransactionCreatedEventInterface
+{
+    public function __construct(
+        private int $id,
+        private string $type,
+        private int $walletId,
+        private DateTimeImmutable $createdAt,
+    ) {
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    public function getWalletId(): int
+    {
+        return $this->walletId;
+    }
+
+    public function getCreatedAt(): DateTimeImmutable
+    {
+        return $this->createdAt;
+    }
+}

src/Internal/Events/TransactionCreatedEventInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Internal\Events;
+
+use DateTimeImmutable;
+
+interface TransactionCreatedEventInterface extends EventInterface
+{
+    public function getId(): int;
+
+    public function getType(): string;
+
+    public function getWalletId(): int;
+
+    public function getCreatedAt(): DateTimeImmutable;
+}

src/Internal/Service/DispatcherService.php

@@ -30,12 +30,17 @@ public function flush(): void
         foreach (array_keys($this->events) as $event) {
             $this->dispatcher->flush($event);
         }
+
+        $this->dispatcher->forgetPushed();
+        $this->events = [];
     }
 
     public function forgot(): void
     {
         foreach (array_keys($this->events) as $event) {
             $this->dispatcher->forget($event);
         }
+
+        $this->events = [];
     }
 }

src/Services/TransactionService.php

@@ -5,14 +5,18 @@
 namespace Bavix\Wallet\Services;
 
 use Bavix\Wallet\Interfaces\Wallet;
+use Bavix\Wallet\Internal\Assembler\TransactionCreatedEventAssemblerInterface;
 use Bavix\Wallet\Internal\Dto\TransactionDtoInterface;
 use Bavix\Wallet\Internal\Exceptions\LockProviderNotFoundException;
 use Bavix\Wallet\Internal\Exceptions\RecordNotFoundException;
+use Bavix\Wallet\Internal\Service\DispatcherServiceInterface;
 use Bavix\Wallet\Models\Transaction;
 
 final class TransactionService implements TransactionServiceInterface
 {
     public function __construct(
+        private TransactionCreatedEventAssemblerInterface $transactionCreatedEventAssembler,
+        private DispatcherServiceInterface $dispatcherService,
         private AssistantServiceInterface $assistantService,
         private RegulatorServiceInterface $regulatorService,
         private PrepareServiceInterface $prepareService,
@@ -58,6 +62,7 @@ public function apply(array $wallets, array $objects): array
     {
         $transactions = $this->atmService->makeTransactions($objects); // q1
         $totals = $this->assistantService->getSums($objects);
+        assert(count($objects) === count($transactions));
 
         foreach ($totals as $walletId => $total) {
             $wallet = $wallets[$walletId] ?? null;
@@ -69,6 +74,10 @@ public function apply(array $wallets, array $objects): array
             $this->regulatorService->increase($object, $total);
         }
 
+        foreach ($transactions as $transaction) {
+            $this->dispatcherService->dispatch($this->transactionCreatedEventAssembler->create($transaction));
+        }
+
         return $transactions;
     }
 }

src/WalletServiceProvider.php

@@ -13,6 +13,8 @@
 use Bavix\Wallet\Internal\Assembler\ExtraDtoAssemblerInterface;
 use Bavix\Wallet\Internal\Assembler\OptionDtoAssembler;
 use Bavix\Wallet\Internal\Assembler\OptionDtoAssemblerInterface;
+use Bavix\Wallet\Internal\Assembler\TransactionCreatedEventAssembler;
+use Bavix\Wallet\Internal\Assembler\TransactionCreatedEventAssemblerInterface;
 use Bavix\Wallet\Internal\Assembler\TransactionDtoAssembler;
 use Bavix\Wallet\Internal\Assembler\TransactionDtoAssemblerInterface;
 use Bavix\Wallet\Internal\Assembler\TransactionQueryAssembler;
@@ -27,6 +29,8 @@
 use Bavix\Wallet\Internal\Assembler\WalletCreatedEventAssemblerInterface;
 use Bavix\Wallet\Internal\Events\BalanceUpdatedEvent;
 use Bavix\Wallet\Internal\Events\BalanceUpdatedEventInterface;
+use Bavix\Wallet\Internal\Events\TransactionCreatedEvent;
+use Bavix\Wallet\Internal\Events\TransactionCreatedEventInterface;
 use Bavix\Wallet\Internal\Events\WalletCreatedEvent;
 use Bavix\Wallet\Internal\Events\WalletCreatedEventInterface;
 use Bavix\Wallet\Internal\Repository\TransactionRepository;
@@ -290,6 +294,11 @@ private function assemblers(array $configure): void
             WalletCreatedEventAssemblerInterface::class,
             $configure['wallet_created_event'] ?? WalletCreatedEventAssembler::class
         );
+
+        $this->app->singleton(
+            TransactionCreatedEventAssemblerInterface::class,
+            $configure['transaction_created_event'] ?? TransactionCreatedEventAssembler::class
+        );
     }
 
     private function transformers(array $configure): void
@@ -316,6 +325,11 @@ private function events(array $configure): void
             WalletCreatedEventInterface::class,
             $configure['wallet_created'] ?? WalletCreatedEvent::class
         );
+
+        $this->app->bind(
+            TransactionCreatedEventInterface::class,
+            $configure['transaction_created'] ?? TransactionCreatedEvent::class
+        );
     }
 
     private function bindObjects(array $configure): void

tests/Infra/Listeners/TransactionCreatedThrowListener.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Test\Infra\Listeners;
+
+use Bavix\Wallet\Internal\Events\TransactionCreatedEventInterface;
+use Bavix\Wallet\Test\Infra\Exceptions\UnknownEventException;
+
+final class TransactionCreatedThrowListener
+{
+    public function handle(TransactionCreatedEventInterface $transactionCreatedEvent): void
+    {
+        $type = $transactionCreatedEvent->getType();
+        $walletId = $transactionCreatedEvent->getWalletId();
+        $createdAt = $transactionCreatedEvent->getCreatedAt()
+            ->format(\DateTimeInterface::ATOM)
+        ;
+
+        $message = hash('sha256', $type . $walletId . $createdAt);
+
+        throw new UnknownEventException($message, $transactionCreatedEvent->getId());
+    }
+}