Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Always use the inTransaction() method when possible in TransactionHelper #1149

Closed
wants to merge 3 commits into from
Closed

Always use the inTransaction() method when possible in TransactionHelper #1149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4393eb8
Make TransactionHelper always respect the presence of the inTransacti…
ste93cry Apr 22, 2021
687d85e
Fix PHPStan issues
ste93cry Apr 22, 2021
22bfda8
Fix CR issues
ste93cry Apr 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions lib/Doctrine/Migrations/Tools/TransactionHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
namespace Doctrine\Migrations\Tools;

use Doctrine\DBAL\Connection;
use PDO;

use function method_exists;

/**
* @internal
Expand Down Expand Up @@ -36,6 +37,10 @@ private static function inTransaction(Connection $connection): bool

/* Attempt to commit or rollback while no transaction is running
results in an exception since PHP 8 + pdo_mysql combination */
return ! $wrappedConnection instanceof PDO || $wrappedConnection->inTransaction();
if (method_exists($wrappedConnection, 'inTransaction')) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only now do I notice that while PDOConnection extends PDO, it is deprecated in favor of PDO\Connection which no longer does in DBAL 3. That means your fix is needed regardless, and that implementing inTransaction in PDO\Connection will be necessary.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, but this lib does not support yet the newer version of the DBAL so for now this is a non-issue, and this code is future-proof if the method name is the one used in the implementation of doctrine/dbal#4616. A future iteration on this piece of code may of course change the check to use the more reliable instanceof TransactionAwareDriverConnection (or whatever name it will have)

return $wrappedConnection->inTransaction();
}

return true;
}
}
6 changes: 6 additions & 0 deletions tests/Doctrine/Migrations/Tests/Event/Listeners/AutoCommitListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace Doctrine\Migrations\Tests\Event\Listeners;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\Connection as DriverConnection;
use Doctrine\Migrations\Configuration\Configuration;
use Doctrine\Migrations\Event\Listeners\AutoCommitListener;
use Doctrine\Migrations\Event\MigrationsEventArgs;
Expand Down Expand Up @@ -38,9 +39,14 @@ public function testListenerDoesNothingWhenConnecitonAutoCommitIsOn(): void

public function testListenerDoesFinalCommitWhenAutoCommitIsOff(): void
{
$this->conn->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$this->conn->expects(self::once())
->method('isAutoCommit')
->willReturn(false);

$this->conn->expects(self::once())
->method('commit');

Expand Down
97 changes: 97 additions & 0 deletions tests/Doctrine/Migrations/Tests/Tools/TransactionHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<?php

declare(strict_types=1);

namespace Doctrine\Migrations\Tests\Tools;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\Connection as DriverConnection;
use Doctrine\DBAL\Driver\PDO\Connection as PDOConnection;
use Doctrine\Migrations\Tools\TransactionHelper;
use PHPUnit\Framework\TestCase;

final class TransactionHelperTest extends TestCase
{
/**
* @param class-string $driverConnectionFqcn
ste93cry marked this conversation as resolved.
Show resolved Hide resolved
*
* @dataProvider getDriverConnectionClassesImplementingInTransactionMethod
*/
public function testCommitIfInTransactionWithConnectionImplementingInTransactionMethod(string $driverConnectionFqcn, bool $commitExpected): void
{
$wrappedConnection = $this->createMock($driverConnectionFqcn);
$wrappedConnection->expects(self::once())
->method('inTransaction')
->willReturn($commitExpected);

$connection = $this->createMock(Connection::class);
$connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($wrappedConnection);

$connection->expects($commitExpected ? self::once() : self::never())
->method('commit');

TransactionHelper::commitIfInTransaction($connection);
}

public function testCommitIfInTransactionWithConnectionNotImplementingInTransactionMethod(): void
{
$connection = $this->createMock(Connection::class);
$connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$connection->expects(self::once())
->method('commit');

TransactionHelper::commitIfInTransaction($connection);
}

/**
* @param class-string $driverConnectionFqcn
ste93cry marked this conversation as resolved.
Show resolved Hide resolved
*
* @dataProvider getDriverConnectionClassesImplementingInTransactionMethod
*/
public function testRollbackIfInTransactionWithConnectionImplementingInTransactionMethod(string $driverConnectionFqcn, bool $commitExpected): void
{
$wrappedConnection = $this->createMock($driverConnectionFqcn);
$wrappedConnection->expects(self::once())
->method('inTransaction')
->willReturn($commitExpected);

$connection = $this->createMock(Connection::class);
$connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($wrappedConnection);

$connection->expects($commitExpected ? self::once() : self::never())
->method('rollback');

TransactionHelper::rollbackIfInTransaction($connection);
}

public function testRollbackIfInTransactionWithConnectionNotImplementingInTransactionMethod(): void
{
$connection = $this->createMock(Connection::class);
$connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$connection->expects(self::once())
->method('rollback');

TransactionHelper::rollbackIfInTransaction($connection);
}

/**
* @return list<array{class-string<DriverConnection>, bool}>
*/
public function getDriverConnectionClassesImplementingInTransactionMethod(): array
{
return [
[PDOConnection::class, true],
[PDOConnection::class, false],
];
}
}
9 changes: 9 additions & 0 deletions tests/Doctrine/Migrations/Tests/Tracking/TableUpdaterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace Doctrine\Migrations\Tests\Tracking;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\Connection as DriverConnection;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Schema\AbstractSchemaManager;
use Doctrine\DBAL\Schema\Column;
Expand Down Expand Up @@ -96,6 +97,10 @@ public function testUpdateMigrationTable(): void
->with($toSchema, $this->platform)
->willReturn(['ALTER TABLE table_name ADD COLUMN executed_at DATETIME DEFAULT NULL']);

$this->connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$this->connection->expects(self::once())
->method('beginTransaction');

Expand Down Expand Up @@ -173,6 +178,10 @@ public function testUpdateMigrationTableRollback(): void
->with($toSchema, $this->platform)
->willReturn(['ALTER TABLE table_name ADD COLUMN executed_at DATETIME DEFAULT NULL']);

$this->connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$this->connection->expects(self::once())
->method('beginTransaction');

Expand Down
17 changes: 17 additions & 0 deletions tests/Doctrine/Migrations/Tests/Version/ExecutorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace Doctrine\Migrations\Tests\Version;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\Connection as DriverConnection;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\Migrations\AbstractMigration;
Expand Down Expand Up @@ -63,6 +64,10 @@ public function testAddSql(): void

public function testExecuteUp(): void
{
$this->connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$this->outputWriter->expects(self::at(0))
->method('write')
->with("\n <info>++</info> migrating <comment>001</comment>\n");
Expand Down Expand Up @@ -113,6 +118,10 @@ public function testExecuteUp(): void
*/
public function executeUpShouldAppendDescriptionWhenItIsNotEmpty(): void
{
$this->connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$this->outputWriter->expects(self::at(0))
->method('write')
->with("\n <info>++</info> migrating <comment>001 (testing)</comment>\n");
Expand All @@ -130,6 +139,10 @@ public function executeUpShouldAppendDescriptionWhenItIsNotEmpty(): void

public function testExecuteDown(): void
{
$this->connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$this->outputWriter->expects(self::at(0))
->method('write')
->with("\n <info>--</info> reverting <comment>001</comment>\n");
Expand Down Expand Up @@ -180,6 +193,10 @@ public function testExecuteDown(): void
*/
public function executeDownShouldAppendDescriptionWhenItIsNotEmpty(): void
{
$this->connection->expects(self::once())
->method('getWrappedConnection')
->willReturn($this->createMock(DriverConnection::class));

$this->outputWriter->expects(self::at(0))
->method('write')
->with("\n <info>--</info> reverting <comment>001 (testing)</comment>\n");
Expand Down