Merge "Add static type hints in Wikibase\Lib\Rdbms"

wikimedia · Dec 11, 2024 · 1469e41 · 1469e41
2 parents 723c9eb + bb3b146
commit 1469e41
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 66 deletions.
diff --git a/lib/includes/Rdbms/ClientDomainDbFactory.php b/lib/includes/Rdbms/ClientDomainDbFactory.php
@@ -11,15 +11,12 @@
  */
 class ClientDomainDbFactory {
 
-	/**
-	 * @var ILBFactory
-	 */
-	private $lbFactory;
+	private ILBFactory $lbFactory;
 
 	/**
 	 * @var string[]
 	 */
-	private $loadGroups;
+	private array $loadGroups;
 
 	public function __construct( ILBFactory $lbFactory, array $loadGroups = [] ) {
 		$this->lbFactory = $lbFactory;

diff --git a/lib/includes/Rdbms/DomainDb.php b/lib/includes/Rdbms/DomainDb.php
@@ -25,35 +25,17 @@ abstract class DomainDb {
 	public const LOAD_GROUP_FROM_CLIENT = 'from-client';
 	public const LOAD_GROUP_FROM_REPO = 'from-repo';
 
-	/**
-	 * @var ILBFactory
-	 */
-	private $lbFactory;
-
-	/**
-	 * @var string
-	 */
-	private $domainId;
-
-	/**
-	 * @var ReplicationWaiter
-	 */
-	private $replicationWaiter;
+	private ILBFactory $lbFactory;
+	private string $domainId;
+	private ReplicationWaiter $replicationWaiter;
 
 	/**
 	 * @var string[]
 	 */
-	private $loadGroups;
+	private array $loadGroups;
 
-	/**
-	 * @var ?SessionConsistentConnectionManager
-	 */
-	private $sessionConsistentConnectionManager = null;
-
-	/**
-	 * @var ?ConnectionManager
-	 */
-	private $connectionManager = null;
+	private ?SessionConsistentConnectionManager $sessionConsistentConnectionManager = null;
+	private ?ConnectionManager $connectionManager = null;
 
 	public function __construct( ILBFactory $lbFactory, string $domainId, array $loadGroups = [] ) {
 		$this->lbFactory = $lbFactory;
@@ -83,7 +65,7 @@ public function sessionConsistentConnections(): SessionConsistentConnectionManag
 
 	/**
 	 * WARNING: Do _not_ override the load-groups in individual method calls on ConnectionManager!
-	 * Instead add them to the factory method!
+	 * Instead, add them to the factory method!
 	 */
 	public function connections(): ConnectionManager {
 		if ( $this->connectionManager === null ) {

diff --git a/lib/includes/Rdbms/ReplicationWaiter.php b/lib/includes/Rdbms/ReplicationWaiter.php
@@ -12,15 +12,8 @@
  */
 class ReplicationWaiter {
 
-	/**
-	 * @var ILBFactory
-	 */
-	private $lbFactory;
-
-	/**
-	 * @var string
-	 */
-	private $domainId;
+	private ILBFactory $lbFactory;
+	private string $domainId;
 
 	public function __construct(
 		ILBFactory $lbFactory,

diff --git a/lib/includes/Rdbms/RepoDomainDbFactory.php b/lib/includes/Rdbms/RepoDomainDbFactory.php
@@ -5,36 +5,26 @@
 namespace Wikibase\Lib\Rdbms;
 
 use Wikibase\DataAccess\DatabaseEntitySource;
-use Wikimedia\Assert\Assert;
 use Wikimedia\Rdbms\ILBFactory;
 
 /**
  * @license GPL-2.0-or-later
  */
 class RepoDomainDbFactory {
 
-	/**
-	 * @var string
-	 */
-	private $repoDomain;
-
-	/**
-	 * @var ILBFactory
-	 */
-	private $lbFactory;
+	private string $repoDomain;
+	private ILBFactory $lbFactory;
 
 	/**
 	 * @var string[]
 	 */
-	private $loadGroups;
+	private array $loadGroups;
 
 	public function __construct(
 		ILBFactory $lbFactory,
-		$repoDomain,
+		string $repoDomain,
 		array $loadGroups = []
 	) {
-		// Make sure callers are not passing `false`. Can be replaced with a typehint once all callers have strict_types enabled.
-		Assert::parameterType( 'string', $repoDomain, '$repoDomain' );
 		$this->lbFactory = $lbFactory;
 		$this->repoDomain = $repoDomain;
 		$this->loadGroups = $loadGroups;

diff --git a/lib/tests/phpunit/Rdbms/RepoDomainDbFactoryTest.php b/lib/tests/phpunit/Rdbms/RepoDomainDbFactoryTest.php
@@ -8,7 +8,6 @@
 use Wikibase\DataAccess\DatabaseEntitySource;
 use Wikibase\Lib\Rdbms\DomainDb;
 use Wikibase\Lib\Rdbms\RepoDomainDbFactory;
-use Wikimedia\Assert\ParameterTypeException;
 use Wikimedia\Rdbms\ILBFactory;
 
 /**
@@ -25,10 +24,7 @@ class RepoDomainDbFactoryTest extends \PHPUnit\Framework\TestCase {
 	 */
 	private $lbFactory;
 
-	/**
-	 * @var string
-	 */
-	private $repoDomainId;
+	private string $repoDomainId;
 
 	protected function setUp(): void {
 		parent::setUp();
@@ -65,14 +61,6 @@ public function testNewForEntitySource() {
 		$this->assertSame( $expectedDbName, $db->domain() );
 	}
 
-	public function testDomainMustNotBeEmpty() {
-		$this->repoDomainId = false;
-
-		$this->expectException( ParameterTypeException::class );
-
-		$this->newFactory();
-	}
-
 	private function newFactory() {
 		return new RepoDomainDbFactory(
 			$this->lbFactory,