facile-it/doctrine-mysql-come-back

• Intercept new timeout message in MySQL 8.0.24+ under PHP 8.4+ (thanks @ackermannd)
• Test against PHP 8.5

• Intercept new timeout message in MySQL 8.0.24+ under PHP 8.4+ (thanks @ackermannd)
• Test against PHP 8.5

• Resolve PHP 8.4 deprecation

• Resolve PHP 8.4 deprecation

• Fixed beginTransaction reconnection behavior with MySQLi and DBAL 4.2.3+

• Fixed beginTransaction reconnection behavior with MySQLi and DBAL 4.2.3+

This new major version is identical to the previous one; the only changes are the ones needed to maintain compatibility with the new DBAL major, so mainly signature changes.

Added

• Support DBAL 4

Removed

• Drop support for DBAL 3

New Contributors

• @oleg-andreyev made their first contribution in #84

Full Changelog: 2.0.0...3.0.0

This new major version is identical to the previous one; the only changes are the ones needed to maintain compatibility with the new DBAL major, so mainly signature changes.

Added

• Support DBAL 4

Removed

• Drop support for DBAL 3

• Bump minimum PHP version to 8.1
• Intercept new timeout message in MySQL 8.0.24+ under PHP 8.4+ (thanks @ackermannd)
• Test against PHP 8.5

• Resolve PHP 8.4 deprecation (fix 2.0.1 tag)

• Resolve PHP 8.4 deprecation

This is the final, stable release of the new version of this library, supporting DBAL 3.6+; unfortunately, DBAL 3.0 to 3.5 is unsupported (but upgrading to 3.6 should not be an issue).

If you're upgrading from a 1.x version, please refer to the UPGRADE-2.0.md document.

The version has no changes from 2.0.0-BETA4; the following is the detailed changelog from the 1.x series:

Added

• Support DBAL v3.6+
• Add GoneAwayDetector interface and MySQLGoneAwayDetector class implementation
• Add setGoneAwayDetector method to the connections
• Add handling of AWS MySQL RDS connection loss
• Add validation to x_reconnect_attempts
• Add mutation testing with Infection

Changed

• Change Connection method signatures to follow DBAL v3 changes:

namespace Facile\DoctrineMySQLComeBack\Doctrine\DBAL;

use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\DBAL\Connection as DBALConnection;
+use Doctrine\DBAL\Result;

class Connection extends DBALConnection
{
// ...
-    public function prepare($sql)
+    public function prepare(string $sql): DBALStatement
// ...
-    public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
+    public function executeQuery(string $sql, array $params = [], $types = [], ?QueryCacheProfile $qcp = null): Result
// ...
}

• Change Statement constructor and method signatures to follow DBAL v3 changes:

namespace Facile\DoctrineMySQLComeBack\Doctrine\DBAL;

use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\DBAL\Connection as DBALConnection;
+use Doctrine\DBAL\Result;

class Statement extends \Doctrine\DBAL\Statement
{
// ...
-    public function __construct($sql, ConnectionInterface $conn)
+    public function __construct(Connection $retriableConnection, Driver\Statement $statement, string $sql)
// ...
-    public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
+    public function executeQuery(string $sql, array $params = [], $types = [], ?QueryCacheProfile $qcp = null): Result
// ...
}

Fixed

• In PrimaryReadReplicaConnection, fetch driverOptions from under the primary key

Removed

• Drop support for DBAL v2
• Drop support for PHP 7.3
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Connections\MasterSlaveConnection class
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\ServerGoneAwayExceptionsAwareInterface interface
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\ServerGoneAwayExceptionsAwareTrait trait
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\Mysqli\Driver class
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\PDOMySQL\Driver class
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\PDO\MySQL\Driver class
• Removed Connection::query() method (due to drop in DBAL v3)
• Removed Connection::refresh() method (due to drop in DBAL v3)
• Removed Connection::isUpdateQuery() method (logic is now behind the GoneAwayDetector interface)
• Removed Statement::bindValue() method
• Removed Statement::bindParam() method
• Removed Statement::execute() method
• Removed Statement::setFetchMode() method

This is the final, stable release of the new version of this library, supporting DBAL 3.6+; unfortunately, DBAL 3.0 to 3.5 is unsupported (but upgrading to 3.6 should not be an issue).

If you're upgrading from a 1.x version, please refer to the UPGRADE-2.0.md document.

The version has no changes from 2.0.0-BETA4; the following is the detailed changelog from the 1.x series:

Added

• Support DBAL v3.6+
• Add GoneAwayDetector interface and MySQLGoneAwayDetector class implementation
• Add setGoneAwayDetector method to the connections
• Add handling of AWS MySQL RDS connection loss
• Add validation to x_reconnect_attempts
• Add mutation testing with Infection

Changed

• Change Connection method signatures to follow DBAL v3 changes:

namespace Facile\DoctrineMySQLComeBack\Doctrine\DBAL;

use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\DBAL\Connection as DBALConnection;
+use Doctrine\DBAL\Result;

class Connection extends DBALConnection
{
// ...
-    public function prepare($sql)
+    public function prepare(string $sql): DBALStatement
// ...
-    public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
+    public function executeQuery(string $sql, array $params = [], $types = [], ?QueryCacheProfile $qcp = null): Result
// ...
}

• Change Statement constructor and method signatures to follow DBAL v3 changes:

namespace Facile\DoctrineMySQLComeBack\Doctrine\DBAL;

use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\DBAL\Connection as DBALConnection;
+use Doctrine\DBAL\Result;

class Statement extends \Doctrine\DBAL\Statement
{
// ...
-    public function __construct($sql, ConnectionInterface $conn)
+    public function __construct(Connection $retriableConnection, Driver\Statement $statement, string $sql)
// ...
-    public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
+    public function executeQuery(string $sql, array $params = [], $types = [], ?QueryCacheProfile $qcp = null): Result
// ...
}

Fixed

• In PrimaryReadReplicaConnection, fetch driverOptions from under the primary key

Removed

• Drop support for DBAL v2
• Drop support for PHP 7.3
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Connections\MasterSlaveConnection class
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\ServerGoneAwayExceptionsAwareInterface interface
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\ServerGoneAwayExceptionsAwareTrait trait
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\Mysqli\Driver class
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\PDOMySQL\Driver class
• Removed Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Driver\PDO\MySQL\Driver class
• Removed Connection::query() method (due to drop in DBAL v3)
• Removed Connection::refresh() method (due to drop in DBAL v3)
• Removed Connection::isUpdateQuery() method (logic is now behind the GoneAwayDetector interface)
• Removed Statement::bindValue() method
• Removed Statement::bindParam() method
• Removed Statement::execute() method
• Removed Statement::setFetchMode() method

Added

• Centralize reconnect attempts counter
• Add Statement::fromDBALStatement for simpler creation
• Add mutation testing with Infection

Fixed

• Avoid reconnection attempts if a transaction was opened (and not closed) before the "gone away" error
• Avoid retrying SAVEPOINT statements
• Handle Statement::bindParam and Statement::bindValue correctly on reconnection

Changed

• Refactor Connection retry logic into a single method
• Make Statement::__construct private

Added

• Centralize reconnect attempts counter
• Add Statement::fromDBALStatement for simpler creation
• Add mutation testing with Infection

Fixed

• Avoid reconnection attempts if a transaction was opened (and not closed) before the "gone away" error
• Avoid retrying SAVEPOINT statements
• Handle Statement::bindParam and Statement::bindValue correctly on reconnection

Changed

• Refactor Connection retry logic into a single method
• Make Statement::__construct private

Added

• Add validation to x_reconnect_attempts

Fixed

• In PrimaryReadReplicaConnection, fetch driverOptions from under the primary key

Added

• Add validation to x_reconnect_attempts

Fixed

• In PrimaryReadReplicaConnection, fetch driverOptions from under the primary key

Added

• Added PrimaryReadReplicaConnection and ConnectionTrait back
• Added handling of AWS MySQL RDS connection loss

Fixed

• Fixed beginTransaction function to have reconnection support

Removed

• Drop support for DBAL < 3.6
• Drop support for PHP 7.3

Added

• Support DBAL v3
• Add GoneAwayDetector interface and MySQLGoneAwayDetector class implementation

Changed

• Changed Connection constructor and method signatures to follow DBAL v3 changes

Removed

• Drop support for DBAL v2
• Removed Driver classes
• Removed ConnectionTrait, now everything is inside Connection
• Removed Connection::refresh() method (due to drop in DBAL v3)
• Removed Connection::isUpdateQuery() method (logic is now behind the GoneAwayDetector interface)
• Removed specialized MasterSlaveConnection and PrimaryReadReplicaConnection (due to drop of corresponding classes in DBAL v3)

Added

• Added PHP 8 support
• Added compatibility with doctrine/dbal > 2.11 Statement
• Added ability to reconnect when creating Mysqli statement

Changed

• Statement now extends the original one, so all methods are implemented now
• Connection::refresh() is deprecated, you should use the original Connection::ping()

Added

• Added compatibility with doctrine/dbal 2.11
• Added Github Actions for CI

Changed

• Bumped minimum PHP version to 7.3
• Updated dependencies
• Added functional tests

Fixed

• Fixed compatiblity with doctrine/dbal 2.11

Changed

• Changed the version constraint of doctrine/dbal to ^2.3 to allow v2.7 (#26)

Added

• Compatibility with doctrine/dbal up to version 2.6 (#22)

Changed

• Bumped minimum PHP version to 5.6 (#21)
• Updated various dev dependecies
• Simplified the Travis CI build matrix

Added

• Added a test suite

Fixed

• Fix issue for not retrying a query that has a new line after the SELECT keyword (#19)
• Avoid retrying UPDATE queries to avoid issues (#17)

Added

• Added a test suite (#16)
• Added a configuration example for ZendFramework (#13)

Fixed

• Fix issue with Driver::connect() (#14)

Added

• Add support for MySQLi (#9)

Changed

• Refactor and eliminate duplication using a trait

Fixed

• Explicit the requirement for PHP >= 5.4