Wrap PDO exception for correct get sql query and parameters.

Author: ZhukV

src/Exception/PdoMigrationFailedException.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the FiveLab Migrator package
+ *
+ * (c) FiveLab
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code
+ */
+
+declare(strict_types = 1);
+
+namespace FiveLab\Component\Migrator\Exception;
+
+class PdoMigrationFailedException extends \Exception
+{
+    /**
+     * Constructor.
+     *
+     * @param string                              $sql
+     * @param array<string|int, string|int|float> $parameters
+     * @param \Throwable                          $previous
+     *
+     * @throws \JsonException
+     */
+    public function __construct(
+        public readonly string $sql,
+        public readonly array  $parameters,
+        public \Throwable      $previous
+    ) {
+        $message = \sprintf(
+            'Migration failed - "%s", parameters: %s with message: %s.',
+            $this->sql,
+            \json_encode($parameters, \JSON_THROW_ON_ERROR),
+            \rtrim($this->previous->getMessage(), '.')
+        );
+
+        parent::__construct($message, 0, $this->previous);
+    }
+}

src/Migration/AbstractPdoMigration.php

@@ -13,6 +13,8 @@
 
 namespace FiveLab\Component\Migrator\Migration;
 
+use FiveLab\Component\Migrator\Exception\PdoMigrationFailedException;
+
 abstract readonly class AbstractPdoMigration extends AbstractMigration
 {
     /**
@@ -29,19 +31,17 @@ final public function up(): void
     {
         $this->doUp();
 
-        foreach ($this->entries as [$sql, $parameters]) {
-            $stmt = $this->pdo->prepare($sql);
-            $stmt->execute($parameters);
+        foreach ($this->entries as $entry) {
+            $this->executeEntry($entry);
         }
     }
 
     final public function down(): void
     {
         $this->doDown();
 
-        foreach ($this->entries as [$sql, $parameters]) {
-            $stmt = $this->pdo->prepare($sql);
-            $stmt->execute($parameters);
+        foreach ($this->entries as $entry) {
+            $this->executeEntry($entry);
         }
     }
 
@@ -59,4 +59,22 @@ final protected function addSql(string $sql, array $parameters = []): void
     {
         $this->entries->offsetSet(\count($this->entries), [$sql, $parameters]);
     }
+
+    /**
+     * Execute SQL entry.
+     *
+     * @param array{"0": string, 1: array<string|int, string|int|float>} $entry
+     *
+     * @throws PdoMigrationFailedException
+     */
+    private function executeEntry(array $entry): void
+    {
+        $stmt = $this->pdo->prepare($entry[0]);
+
+        try {
+            $stmt->execute($entry[1]);
+        } catch (\Throwable $error) {
+            throw new PdoMigrationFailedException($entry[0], $entry[1], $error);
+        }
+    }
 }

tests/Functional/Migrator/MigratorMySqlTest.php

@@ -13,6 +13,7 @@
 
 namespace FiveLab\Component\Migrator\Tests\Functional\Migrator;
 
+use FiveLab\Component\Migrator\Exception\PdoMigrationFailedException;
 use FiveLab\Component\Migrator\Locator\FilesystemMigrationsLocator;
 use FiveLab\Component\Migrator\MigrateDirection;
 use FiveLab\Component\Migrator\Migrator;
@@ -33,16 +34,21 @@ protected function setUp(): void
     {
         $this->setUpMySql();
 
-        $locator = new FilesystemMigrationsLocator(__DIR__.'/../../Migrations/DataSet02', 'Database');
-
-        $this->migrator = new Migrator($locator, $this->executor);
+        $this->migrator = $this->createMigrator(__DIR__.'/../../Migrations/DataSet02', 'Database');
     }
 
     protected function tearDown(): void
     {
         $this->dropTables();
     }
 
+    protected function createMigrator(string $path, string $group): Migrator
+    {
+        $locator = new FilesystemMigrationsLocator($path, $group);
+
+        return new Migrator($locator, $this->executor);
+    }
+
     #[Test]
     public function shouldSuccessUp(): void
     {
@@ -120,4 +126,15 @@ public function shouldSuccessExecuteSpecificVersion(): void
             ['id' => 2, 'label' => 'Foo Bar'],
         ], $rows);
     }
+
+    #[Test]
+    public function shouldSuccessWrapPdoException(): void
+    {
+        $migrator = $this->createMigrator(__DIR__.'/../../Migrations/DataSet03', 'Database');
+
+        $this->expectException(PdoMigrationFailedException::class);
+        $this->expectExceptionMessage('Migration failed - "SELECT * FROM not_existing_table WHERE label = :foo", parameters: {"foo":"bar"} with message: SQLSTATE[42S02]: Base table or view not found:');
+
+        $migrator->migrate(MigrateDirection::Up, null);
+    }
 }

tests/Migrations/DataSet03/Version01.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the FiveLab Migrator package
+ *
+ * (c) FiveLab
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code
+ */
+
+declare(strict_types = 1);
+
+namespace FiveLab\Component\Migrator\Tests\Migrations\DataSet03;
+
+use FiveLab\Component\Migrator\Migration\AbstractPdoMigration;
+
+readonly class Version01 extends AbstractPdoMigration
+{
+    public function getDescription(): string
+    {
+        return 'pdo version 01';
+    }
+
+    protected function doUp(): void
+    {
+        $this->addSql('SELECT * FROM not_existing_table WHERE label = :foo', [
+            'foo' => 'bar',
+        ]);
+    }
+
+    protected function doDown(): void
+    {
+        $this->addSql('DROP TABLE not_existing_table');
+    }
+}