Merge pull request #412 from bavix/transtate

[7.1] Transaction State

Author: rez1dent3

.phpstorm.meta.php

@@ -39,7 +39,6 @@
     use Bavix\Wallet\Services\CommonServiceLegacy;
     use Bavix\Wallet\Services\MetaServiceLegacy;
     use Bavix\Wallet\Services\TaxServiceInterface;
-    use Bavix\Wallet\Services\WalletServiceLegacy;
 
     override(\app(0), map([
         // internal.assembler
@@ -93,7 +92,6 @@
         // lagacy.services
         CommonServiceLegacy::class => CommonServiceLegacy::class,
         MetaServiceLegacy::class => MetaServiceLegacy::class,
-        WalletServiceLegacy::class => WalletServiceLegacy::class,
     ]));
 
 }

changelog.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Transaction support.
+- Now, within the transaction, the wallet has its own balance state.
+
+### Updated
+- Due to the state within transactions, I was able to speed up the computation up to 25 times for complex transfers.
+
+### Removed
+- class `WalletServiceLegacy`
+
 ## [7.0.0] - 2021-11-25
 ### Updated
 - Optimization of the `payFreeCart` and `payFree` request. Now the package does not update the repository. But there is no point in updating it, because the client does not pay anything.

composer.json

@@ -46,7 +46,8 @@
     "vimeo/psalm": "^4.12"
   },
   "suggest": {
-    "bavix/laravel-wallet-swap": "Addition to the laravel-wallet library for quick setting of exchange rates"
+    "bavix/laravel-wallet-swap": "Addition to the laravel-wallet library for quick setting of exchange rates",
+    "bavix/laravel-wallet-warmup": "Addition to the laravel-wallet library for refresh balance wallets"
   },
   "autoload": {
     "psr-4": {

config/config.php

@@ -33,6 +33,7 @@
 use Bavix\Wallet\Services\ExchangeService;
 use Bavix\Wallet\Services\PrepareService;
 use Bavix\Wallet\Services\PurchaseService;
+use Bavix\Wallet\Services\RegulatorService;
 use Bavix\Wallet\Services\TaxService;
 
 return [
@@ -78,6 +79,7 @@
         'atomic' => AtomicService::class,
         'basket' => BasketService::class,
         'bookkeeper' => BookkeeperService::class,
+        'regulator' => RegulatorService::class,
         'cast' => CastService::class,
         'consistency' => ConsistencyService::class,
         'discount' => DiscountService::class,

docs/_sidebar.md

@@ -28,7 +28,12 @@
     - [Refund](refund)
     - [Gift](gift)
     - [Cart](cart)
-    
+
+- Transactions
+
+    - [Transaction](transaction) 
+    - [Race condition](race-condition) 
+
 - Additions
 
     - [Wallet Swap](laravel-wallet-swap)

docs/race-condition.md

@@ -0,0 +1,37 @@
+## Race Condition
+
+A common issue in the issue is about race conditions.
+
+If you have not yet imported the config into the project, then you need to do this.
+```bash
+php artisan vendor:publish --tag=laravel-wallet-config
+```
+
+Previously, there was a vacuum package, but now it is a part of the core. You just need to configure the lock service and the cache service in the package configuration `wallet.php`.
+
+```php
+    /**
+     * A system for dealing with race conditions.
+     */
+    'lock' => [
+        'driver' => 'array',
+        'seconds' => 1,
+    ],
+```
+
+To enable the fight against race conditions, you need to select a provider that supports work with locks. I recommend `redis`.
+
+There is a setting for storing the state of the wallet, I recommend choosing `redis` here too.
+
+```php
+    /**
+     * Storage of the state of the balance of wallets.
+     */
+    'cache' => ['driver' => 'array'],
+```
+
+You need `redis-server` and `php-redis`.
+
+Redis is recommended but not required. You can choose whatever the [framework](https://laravel.com/docs/8.x/cache#introduction) offers you.
+
+It worked! 

docs/transaction.md

@@ -0,0 +1,37 @@
+## Transaction
+
+Sometimes you need to execute many simple queries. You want to keep the data atomic. To do this, you need `laravel-wallet` v7.1+.
+
+It is necessary to write off the amount from the balance and raise the ad in the search. What happens if the service for raising an ad fails? We wrote off the money, but did not raise the ad. Received reputational losses. We can imagine the opposite situation, we first raise the ad in the search, but it does not work to write off the money. There are not enough funds. This functionality will help to solve all this. We monitor ONLY the state of the wallet, the rest falls on the developer. Let's take an unsuccessful lift, for example.
+
+```php
+use Bavix\Wallet\Internal\Service\DatabaseServiceInterface;
+
+/** @var object $businessLogicService */
+/** @var \Bavix\Wallet\Models\Wallet $payer */
+$payer->balanceInt; // 9999
+app(DatabaseServiceInterface::class)->transaction(statuc function () use ($payer) {
+    $payer->withdraw(1000); // 8999
+    $businessLogicService->doingMagic($payer); // throws an exception
+}); // rollback payer balance
+
+$payer->balanceInt; // 9999
+```
+
+Now let's look at the successful raising of the ad.
+
+```php
+use Bavix\Wallet\Internal\Service\DatabaseServiceInterface;
+
+/** @var object $businessLogicService */
+/** @var \Bavix\Wallet\Models\Wallet $payer */
+$payer->balanceInt; // 9999
+app(DatabaseServiceInterface::class)->transaction(statuc function () use ($payer) {
+    $payer->withdraw(1000); // 8999
+    $businessLogicService->doingMagic($payer); // successfully
+}); // commit payer balance
+
+$payer->balanceInt; // 8999
+```
+
+It worked! 

rector.php

@@ -5,6 +5,7 @@
 use Rector\Core\Configuration\Option;
 use Rector\Laravel\Set\LaravelSetList;
 use Rector\Php74\Rector\Property\TypedPropertyRector;
+use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\Set\ValueObject\SetList;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
@@ -17,6 +18,7 @@
     ]);
 
     // Define what rule sets will be applied
+    $containerConfigurator->import(PHPUnitSetList::PHPUNIT_91);
     $containerConfigurator->import(LaravelSetList::LARAVEL_60);
     $containerConfigurator->import(SetList::DEAD_CODE);
     $containerConfigurator->import(SetList::PHP_74);

src/Internal/Service/DatabaseService.php

@@ -6,7 +6,7 @@
 
 use Bavix\Wallet\Internal\Exceptions\ExceptionInterface;
 use Bavix\Wallet\Internal\Exceptions\TransactionFailedException;
-use Closure;
+use Bavix\Wallet\Services\RegulatorServiceInterface;
 use Illuminate\Config\Repository as ConfigRepository;
 use Illuminate\Database\ConnectionInterface;
 use Illuminate\Database\ConnectionResolverInterface;
@@ -15,12 +15,15 @@
 
 final class DatabaseService implements DatabaseServiceInterface
 {
+    private RegulatorServiceInterface $regulatorService;
     private ConnectionInterface $connection;
 
     public function __construct(
         ConnectionResolverInterface $connectionResolver,
+        RegulatorServiceInterface $regulatorService,
         ConfigRepository $config
     ) {
+        $this->regulatorService = $regulatorService;
         $this->connection = $connectionResolver->connection(
             $config->get('wallet.database.connection')
         );
@@ -40,10 +43,25 @@ public function transaction(callable $callback)
                 return $callback();
             }
 
-            return $this->connection->transaction(Closure::fromCallable($callback));
+            $this->regulatorService->purge();
+
+            return $this->connection->transaction(function () use ($callback) {
+                $result = $callback();
+                if ($result === false || (is_countable($result) && count($result) === 0)) {
+                    $this->regulatorService->purge();
+                } else {
+                    $this->regulatorService->approve();
+                }
+
+                return $result;
+            });
         } catch (RecordsNotFoundException|ExceptionInterface $exception) {
+            $this->regulatorService->purge();
+
             throw $exception;
         } catch (Throwable $throwable) {
+            $this->regulatorService->purge();
+
             throw new TransactionFailedException(
                 'Transaction failed',
                 ExceptionInterface::TRANSACTION_FAILED,

src/Internal/Service/StorageService.php

@@ -7,43 +7,38 @@
 use Bavix\Wallet\Internal\Exceptions\ExceptionInterface;
 use Bavix\Wallet\Internal\Exceptions\LockProviderNotFoundException;
 use Bavix\Wallet\Internal\Exceptions\RecordNotFoundException;
-use Illuminate\Cache\CacheManager;
-use Illuminate\Config\Repository as ConfigRepository;
 use Illuminate\Contracts\Cache\Repository as CacheRepository;
 
 final class StorageService implements StorageServiceInterface
 {
     private LockServiceInterface $lockService;
     private MathServiceInterface $mathService;
-    private CacheRepository $cache;
+    private CacheRepository $cacheRepository;
 
     public function __construct(
-        CacheManager $cacheManager,
-        ConfigRepository $config,
         LockServiceInterface $lockService,
-        MathServiceInterface $mathService
+        MathServiceInterface $mathService,
+        CacheRepository $cacheRepository
     ) {
+        $this->cacheRepository = $cacheRepository;
         $this->mathService = $mathService;
         $this->lockService = $lockService;
-        $this->cache = $cacheManager->driver(
-            $config->get('wallet.cache.driver', 'array')
-        );
     }
 
     public function flush(): bool
     {
-        return $this->cache->clear();
+        return $this->cacheRepository->clear();
     }
 
     public function missing(string $key): bool
     {
-        return $this->cache->forget($key);
+        return $this->cacheRepository->forget($key);
     }
 
     /** @throws RecordNotFoundException */
     public function get(string $key): string
     {
-        $value = $this->cache->get($key);
+        $value = $this->cacheRepository->get($key);
         if ($value === null) {
             throw new RecordNotFoundException(
                 'The repository did not find the object',
@@ -54,9 +49,10 @@ public function get(string $key): string
         return $this->mathService->round($value);
     }
 
+    /** @param float|int|string $value */
     public function sync(string $key, $value): bool
     {
-        return $this->cache->set($key, $value);
+        return $this->cacheRepository->set($key, $value);
     }
 
     /**