Issue #3128616 by alexpott, daffie, mondrake, xjm, Charlie ChX Negyesi:... (2ee59bef) · Commits · project / drupal

core/lib/Drupal/Core/Database/Connection.php

+30 −6

Original line number	Diff line number	Diff line
		@@ -258,8 +258,16 @@ public static function open(array &$connection_options = []) {}
		* variables. In case of PDO database connection objects, PHP only closes the
		* connection when the PDO object is destructed, so any references to this
		* object may cause the number of maximum allowed connections to be exceeded.
		*
		* @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Move custom
		* database destruction logic to __destruct().
		*
		* @see https://www.drupal.org/node/3142866
		*/
		public function destroy() {
		$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
		if ($backtrace[1]['class'] !== self::class && $backtrace[1]['function'] !== '__destruct') {
		@trigger_error(__METHOD__ . '() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Move custom database destruction logic to __destruct(). See https://www.drupal.org/node/3142866', E_USER_DEPRECATED);
		// Destroy all references to this connection by setting them to NULL.
		// The Statement class attribute only accepts a new value that presents a
		// proper callable, so we reset it to PDOStatement.
		@@ -268,6 +276,22 @@ public function destroy() {
		}
		$this->schema = NULL;
		}
		}

		/**
		* Ensures that the PDO connection can be garbage collected.
		*/
		public function __destruct() {
		// Call the ::destroy method to provide a BC layer.
		// @todo https://www.drupal.org/project/drupal/issues/3153864 Remove this
		// call in Drupal 10 as the logic in the destroy() method is no longer
		// required now we implement a proper destructor.
		$this->destroy();
		// Ensure that the circular reference caused by Connection::__construct()
		// using $this in the call to set the statement class can be garbage
		// collected.
		$this->connection = NULL;
		}

		/**
		* Returns the default query options for any given query.

core/lib/Drupal/Core/Database/Database.php

+3 −14

Original line number	Diff line number	Diff line
		@@ -405,26 +405,15 @@ public static function closeConnection($target = NULL, $key = NULL) {
		if (!isset($key)) {
		$key = self::$activeKey;
		}
		// To close a connection, it needs to be set to NULL and removed from the
		// static variable. In all cases, closeConnection() might be called for a
		// connection that was not opened yet, in which case the key is not defined
		// yet and we just ensure that the connection key is undefined.
		if (isset($target)) {
		if (isset(self::$connections[$key][$target])) {
		self::$connections[$key][$target]->destroy();
		self::$connections[$key][$target] = NULL;
		}
		unset(self::$connections[$key][$target]);
		}
		else {
		if (isset(self::$connections[$key])) {
		foreach (self::$connections[$key] as $target => $connection) {
		self::$connections[$key][$target]->destroy();
		self::$connections[$key][$target] = NULL;
		}
		}
		unset(self::$connections[$key]);
		}
		// Force garbage collection to run. This ensures that PDO connection objects
		// and destroyed and results in the connections being closed.
		gc_collect_cycles();
		}

		/**

core/lib/Drupal/Core/Database/Driver/mysql/Connection.php

+1 −0

Original line number	Diff line number	Diff line
		@@ -206,6 +206,7 @@ public function __destruct() {
		if ($this->needsCleanup) {
		$this->nextIdDelete();
		}
		parent::__destruct();
		}

		public function queryRange($query, $from, $count, array $args = [], array $options = []) {

core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php

+1 −0

Original line number	Diff line number	Diff line
		@@ -199,6 +199,7 @@ public function __destruct() {
		}
		}
		}
		parent::__destruct();
		}

		/**

core/tests/Drupal/KernelTests/Core/Database/NextIdTest.php

+35 −0

Original line number	Diff line number	Diff line
		@@ -2,6 +2,8 @@

		namespace Drupal\KernelTests\Core\Database;

		use Drupal\Core\Database\Database;

		/**
		* Tests the sequences API.
		*
		@@ -38,4 +40,37 @@ public function testDbNextId() {
		$this->assertEqual($result, 1001, 'Sequence provides a larger number than the existing ID.');
		}

		/**
		* Tests that sequences table clear up works when a connection is closed.
		*
		* @see \Drupal\Core\Database\Driver\mysql\Connection::__destruct()
		*/
		public function testDbNextIdClosedConnection() {
		// Only run this test for the 'mysql' driver.
		$driver = $this->connection->driver();
		if ($driver !== 'mysql') {
		$this->markTestSkipped("MySql tests can not run for driver '$driver'.");
		}
		// Create an additional connection to test closing the connection.
		$connection_info = Database::getConnectionInfo();
		Database::addConnectionInfo('default', 'next_id', $connection_info['default']);

		// Get a few IDs to ensure there the clean up needs to run and there is more
		// than one row.
		Database::getConnection('next_id')->nextId();
		Database::getConnection('next_id')->nextId();

		// At this point the sequences table should contain unnecessary rows.
		$count = $this->connection->select('sequences')->countQuery()->execute()->fetchField();
		$this->assertGreaterThan(1, $count);

		// Close the connection.
		Database::closeConnection('next_id');

		// Test that \Drupal\Core\Database\Driver\mysql\Connection::__destruct()
		// successfully trims the sequences table if the connection is closed.
		$count = $this->connection->select('sequences')->countQuery()->execute()->fetchField();
		$this->assertEquals(1, $count);
		}

		}