Merge pull request #865 from bavix/864-can-a-new-field-be-added-to-th…

…e-transfer-table [11.x] Adding an Extra column to the transfer table
bavix · Jan 24, 2024 · 8f57694 · 8f57694
2 parents 7a0f9c6 + 12151a7
commit 8f57694
Show file tree

Hide file tree

Showing 27 changed files with 227 additions and 22 deletions.
diff --git a/database/2024_01_24_185401_add_extra_column_in_transfer.php b/database/2024_01_24_185401_add_extra_column_in_transfer.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use Bavix\Wallet\Models\Transfer;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+    public function up(): void
+    {
+        Schema::table($this->table(), static function (Blueprint $table) {
+            $table->json('extra')
+                ->nullable()
+                ->after('fee')
+            ;
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropColumns($this->table(), ['extra']);
+    }
+
+    private function table(): string
+    {
+        return (new Transfer())->getTable();
+    }
+};
diff --git a/phpstan.src.baseline.neon b/phpstan.src.baseline.neon
@@ -1,5 +1,10 @@
 parameters:
 	ignoreErrors:
+		-
+			message: "#^Constructor in Bavix\\\\Wallet\\\\External\\\\Dto\\\\Extra has parameter \\$extra with default value\\.$#"
+			count: 1
+			path: src/External/Dto/Extra.php
+
 		-
 			message: "#^Constructor in Bavix\\\\Wallet\\\\External\\\\Dto\\\\Extra has parameter \\$uuid with default value\\.$#"
 			count: 1

diff --git a/src/External/Contracts/ExtraDtoInterface.php b/src/External/Contracts/ExtraDtoInterface.php
@@ -11,4 +11,9 @@ public function getDepositOption(): OptionDtoInterface;
     public function getWithdrawOption(): OptionDtoInterface;
 
     public function getUuid(): ?string;
+
+    /**
+     * @return array<mixed>|null
+     */
+    public function getExtra(): ?array;
 }
diff --git a/src/External/Dto/Extra.php b/src/External/Dto/Extra.php
@@ -16,11 +16,13 @@ final class Extra implements ExtraDtoInterface
     /**
      * @param OptionDtoInterface|array<mixed>|null $deposit
      * @param OptionDtoInterface|array<mixed>|null $withdraw
+     * @param array<mixed>|null $extra
      */
     public function __construct(
         OptionDtoInterface|array|null $deposit,
         OptionDtoInterface|array|null $withdraw,
-        private readonly ?string $uuid = null
+        private readonly ?string $uuid = null,
+        private readonly ?array $extra = null
     ) {
         $this->deposit = $deposit instanceof OptionDtoInterface ? $deposit : new Option($deposit);
         $this->withdraw = $withdraw instanceof OptionDtoInterface ? $withdraw : new Option($withdraw);
@@ -40,4 +42,12 @@ public function getUuid(): ?string
     {
         return $this->uuid;
     }
+
+    /**
+     * @return array<mixed>|null
+     */
+    public function getExtra(): ?array
+    {
+        return $this->extra;
+    }
 }
diff --git a/src/Internal/Assembler/TransferDtoAssembler.php b/src/Internal/Assembler/TransferDtoAssembler.php
@@ -18,6 +18,7 @@ public function __construct(
     ) {
     }
 
+    /** @param array<mixed>|null $extra */
     public function create(
         int $depositId,
         int $withdrawId,
@@ -26,7 +27,8 @@ public function create(
         Model $toModel,
         int $discount,
         string $fee,
-        ?string $uuid
+        ?string $uuid,
+        ?array $extra,
     ): TransferDtoInterface {
         return new TransferDto(
             $uuid ?? $this->uuidService->uuid4(),
@@ -37,6 +39,7 @@ public function create(
             $toModel->getKey(),
             $discount,
             $fee,
+            $extra,
             $this->clockService->now(),
             $this->clockService->now(),
         );

diff --git a/src/Internal/Assembler/TransferDtoAssemblerInterface.php b/src/Internal/Assembler/TransferDtoAssemblerInterface.php
@@ -9,6 +9,7 @@
 
 interface TransferDtoAssemblerInterface
 {
+    /** @param array<mixed>|null $extra */
     public function create(
         int $depositId,
         int $withdrawId,
@@ -17,6 +18,7 @@ public function create(
         Model $toModel,
         int $discount,
         string $fee,
-        ?string $uuid
+        ?string $uuid,
+        ?array $extra,
     ): TransferDtoInterface;
 }
diff --git a/src/Internal/Assembler/TransferLazyDtoAssembler.php b/src/Internal/Assembler/TransferLazyDtoAssembler.php
@@ -11,6 +11,7 @@
 
 final class TransferLazyDtoAssembler implements TransferLazyDtoAssemblerInterface
 {
+    /** @param array<mixed>|null $extra */
     public function create(
         Wallet $fromWallet,
         Wallet $toWallet,
@@ -19,8 +20,19 @@ public function create(
         TransactionDtoInterface $withdrawDto,
         TransactionDtoInterface $depositDto,
         string $status,
-        ?string $uuid
+        ?string $uuid,
+        ?array $extra,
     ): TransferLazyDtoInterface {
-        return new TransferLazyDto($fromWallet, $toWallet, $discount, $fee, $withdrawDto, $depositDto, $status, $uuid);
+        return new TransferLazyDto(
+            $fromWallet,
+            $toWallet,
+            $discount,
+            $fee,
+            $withdrawDto,
+            $depositDto,
+            $status,
+            $uuid,
+            $extra,
+        );
     }
 }
diff --git a/src/Internal/Assembler/TransferLazyDtoAssemblerInterface.php b/src/Internal/Assembler/TransferLazyDtoAssemblerInterface.php
@@ -10,6 +10,7 @@
 
 interface TransferLazyDtoAssemblerInterface
 {
+    /** @param array<mixed>|null $extra */
     public function create(
         Wallet $fromWallet,
         Wallet $toWallet,
@@ -18,6 +19,7 @@ public function create(
         TransactionDtoInterface $withdrawDto,
         TransactionDtoInterface $depositDto,
         string $status,
-        ?string $uuid
+        ?string $uuid,
+        ?array $extra,
     ): TransferLazyDtoInterface;
 }
diff --git a/src/Internal/Dto/BasketDto.php b/src/Internal/Dto/BasketDto.php
@@ -12,10 +12,12 @@
     /**
      * @param non-empty-array<int|string, ItemDtoInterface> $items
      * @param array<mixed> $meta
+     * @param array<mixed>|null $extra
      */
     public function __construct(
         private array $items,
-        private array $meta
+        private array $meta,
+        private ?array $extra,
     ) {
     }
 
@@ -53,4 +55,12 @@ public function items(): array
     {
         return $this->items;
     }
+
+    /**
+     * @return array<mixed>|null
+     */
+    public function extra(): ?array
+    {
+        return $this->extra;
+    }
 }
diff --git a/src/Internal/Dto/BasketDtoInterface.php b/src/Internal/Dto/BasketDtoInterface.php
@@ -17,6 +17,11 @@ public function total(): int;
      */
     public function meta(): array;
 
+    /**
+     * @return array<mixed>|null
+     */
+    public function extra(): ?array;
+
     /**
      * @return non-empty-array<int|string, ItemDtoInterface>
      */

diff --git a/src/Internal/Dto/TransferDto.php b/src/Internal/Dto/TransferDto.php
@@ -9,6 +9,7 @@
 /** @immutable */
 final readonly class TransferDto implements TransferDtoInterface
 {
+    /** @param array<mixed>|null $extra */
     public function __construct(
         private string $uuid,
         private int $depositId,
@@ -18,6 +19,7 @@ public function __construct(
         private int $toId,
         private int $discount,
         private string $fee,
+        private ?array $extra,
         private DateTimeImmutable $createdAt,
         private DateTimeImmutable $updatedAt,
     ) {
@@ -63,6 +65,14 @@ public function getFee(): string
         return $this->fee;
     }
 
+    /**
+     * @return array<mixed>|null
+     */
+    public function getExtra(): ?array
+    {
+        return $this->extra;
+    }
+
     public function getCreatedAt(): DateTimeImmutable
     {
         return $this->createdAt;

diff --git a/src/Internal/Dto/TransferDtoInterface.php b/src/Internal/Dto/TransferDtoInterface.php
@@ -24,6 +24,9 @@ public function getDiscount(): int;
 
     public function getFee(): string;
 
+    /** @return array<mixed>|null */
+    public function getExtra(): ?array;
+
     public function getCreatedAt(): DateTimeImmutable;
 
     public function getUpdatedAt(): DateTimeImmutable;

diff --git a/src/Internal/Dto/TransferLazyDto.php b/src/Internal/Dto/TransferLazyDto.php
@@ -9,6 +9,9 @@
 /** @immutable */
 final readonly class TransferLazyDto implements TransferLazyDtoInterface
 {
+    /**
+     * @param array<mixed>|null $extra
+     */
     public function __construct(
         private Wallet $fromWallet,
         private Wallet $toWallet,
@@ -17,7 +20,8 @@ public function __construct(
         private TransactionDtoInterface $withdrawDto,
         private TransactionDtoInterface $depositDto,
         private string $status,
-        private ?string $uuid
+        private ?string $uuid,
+        private ?array $extra,
     ) {
     }
 
@@ -60,4 +64,12 @@ public function getUuid(): ?string
     {
         return $this->uuid;
     }
+
+    /**
+     * @return array<mixed>|null
+     */
+    public function getExtra(): ?array
+    {
+        return $this->extra;
+    }
 }
diff --git a/src/Internal/Dto/TransferLazyDtoInterface.php b/src/Internal/Dto/TransferLazyDtoInterface.php
@@ -23,4 +23,7 @@ public function getDepositDto(): TransactionDtoInterface;
     public function getStatus(): string;
 
     public function getUuid(): ?string;
+
+    /** @return array<mixed>|null */
+    public function getExtra(): ?array;
 }
diff --git a/src/Internal/Repository/TransferRepository.php b/src/Internal/Repository/TransferRepository.php
@@ -6,13 +6,15 @@
 
 use Bavix\Wallet\Internal\Dto\TransferDtoInterface;
 use Bavix\Wallet\Internal\Query\TransferQueryInterface;
+use Bavix\Wallet\Internal\Service\JsonServiceInterface;
 use Bavix\Wallet\Internal\Transform\TransferDtoTransformerInterface;
 use Bavix\Wallet\Models\Transfer;
 
 final readonly class TransferRepository implements TransferRepositoryInterface
 {
     public function __construct(
         private TransferDtoTransformerInterface $transformer,
+        private JsonServiceInterface $jsonService,
         private Transfer $transfer
     ) {
     }
@@ -22,7 +24,14 @@ public function __construct(
      */
     public function insert(array $objects): void
     {
-        $values = array_map(fn (TransferDtoInterface $dto): array => $this->transformer->extract($dto), $objects);
+        $values = [];
+        foreach ($objects as $object) {
+            $values[] = array_map(
+                fn ($value) => is_array($value) ? $this->jsonService->encode($value) : $value,
+                $this->transformer->extract($object)
+            );
+        }
+
         $this->transfer->newQuery()
             ->insert($values)
         ;

diff --git a/src/Internal/Transform/TransferDtoTransformer.php b/src/Internal/Transform/TransferDtoTransformer.php
@@ -19,6 +19,7 @@ public function extract(TransferDtoInterface $dto): array
             'to_id' => $dto->getToId(),
             'discount' => $dto->getDiscount(),
             'fee' => $dto->getFee(),
+            'extra' => $dto->getExtra(),
             'created_at' => $dto->getCreatedAt(),
             'updated_at' => $dto->getUpdatedAt(),
         ];

diff --git a/src/Internal/Transform/TransferDtoTransformerInterface.php b/src/Internal/Transform/TransferDtoTransformerInterface.php
@@ -19,6 +19,7 @@ interface TransferDtoTransformerInterface
      *     to_id: int|string,
      *     discount: int,
      *     fee: string,
+     *     extra: array<mixed>|null,
      *     created_at: DateTimeImmutable,
      *     updated_at: DateTimeImmutable,
      * }

diff --git a/src/Models/Transfer.php b/src/Models/Transfer.php
@@ -25,6 +25,7 @@
  * @property int $to_id
  * @property string $uuid
  * @property string $fee
+ * @property ?array<mixed> $extra
  * @property Transaction $deposit
  * @property Transaction $withdraw
  * @property DateTimeInterface $created_at
@@ -59,6 +60,7 @@ class Transfer extends Model
         'to_id',
         'uuid',
         'fee',
+        'extra',
         'created_at',
         'updated_at',
     ];
@@ -69,6 +71,7 @@ class Transfer extends Model
     protected $casts = [
         'deposit_id' => 'int',
         'withdraw_id' => 'int',
+        'extra' => 'json',
     ];
 
     public function getTable(): string