Migrate to use DatabaseVirtualDomains (#92)

miraheze · Nov 19, 2024 · cb84173 · cb84173
1 parent 092074e
commit cb84173
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 33 deletions.
diff --git a/.phan/config.php b/.phan/config.php
@@ -3,8 +3,9 @@
 $cfg = require __DIR__ . '/../vendor/mediawiki/mediawiki-phan-config/src/config.php';
 
 $cfg['suppress_issue_types'] = [
+	'PhanAccessMethodInternal',
+	'PhanPluginMixedKeyNoKey',
 	'SecurityCheck-LikelyFalsePositive',
-	'PhanPluginMixedKeyNoKey'
 ];
 
 return $cfg;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 ## ChangeLog for IncidentReporting
 
+
+### 1.3.0 (19-11-2024)
+* Require MediaWiki 1.42.0
+* Add support for virtual database domains
+* Remove support for $wgIncidentReportingDatabase
+
 ### 1.2.0 (01-01-2024)
 * Add configuration variable, $wgIncidentReportingInactiveServices
 

diff --git a/extension.json b/extension.json
@@ -5,12 +5,12 @@
 		"Universal Omega"
 	],
 	"url": "https://github.com/miraheze/IncidentReporting",
-	"version": "1.2.0",
+	"version": "1.3.0",
 	"descriptionmsg": "incidentreporting-desc",
 	"license-name": "GPL-3.0-or-later",
 	"type": "specialpage",
 	"requires": {
-		"MediaWiki": ">= 1.38.0"
+		"MediaWiki": ">= 1.42.0"
 	},
 	"AvailableRights": [
 		"viewincidents",
@@ -43,14 +43,12 @@
 	"ResourceModules": {
 		"ext.incidentreporting.oouiform": {
 			"scripts": "ext.incidentreporting.oouiform.ooui.js",
-			"targets": [ "desktop", "mobile" ],
 			"dependencies": [
 				"mediawiki.storage",
 				"oojs-ui-widgets"
 			]
 		},
 		"ext.incidentreporting.oouiform.styles": {
-			"targets": [ "desktop", "mobile" ],
 			"styles": "ext.incidentreporting.oouiform.ooui.less"
 		}
 	},
@@ -59,11 +57,6 @@
 		"remoteExtPath": "IncidentReporting/modules"
 	},
 	"config": {
-		"IncidentReportingDatabase": {
-			"description": "Database name where all data is stored.",
-			"public": true,
-			"value": false
-		},
 		"IncidentReportingServices": {
 			"description": "Human readable list of service components with page URLs. Set to false for no link. Format: 'name' => 'url'.",
 			"public": true,
@@ -88,5 +81,8 @@
 	"ConfigRegistry": {
 		"incidentreporting": "GlobalVarConfig::newInstance"
 	},
+	"DatabaseVirtualDomains": [
+		"virtual-incidentreporting"
+	],
 	"manifest_version": 2
 }
diff --git a/includes/IncidentReportingFormFactory.php b/includes/IncidentReportingFormFactory.php
@@ -3,7 +3,7 @@
 use MediaWiki\Html\Html;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Permissions\PermissionManager;
-use Wikimedia\Rdbms\DBConnRef;
+use Wikimedia\Rdbms\IDatabase;
 
 class IncidentReportingFormFactory {
 	/** @var Config */
@@ -18,7 +18,7 @@ public function __construct() {
 	}
 
 	public function getFormDescriptor(
-		DBConnRef $dbw,
+		IDatabase $dbw,
 		int $id,
 		bool $edit,
 		IContextSource $context
@@ -482,7 +482,7 @@ public function getFormDescriptor(
 	public function getForm(
 		int $id,
 		bool $edit,
-		DBConnRef $dbw,
+		IDatabase $dbw,
 		IContextSource $context,
 		$formClass = IncidentReportingOOUIForm::class
 	) {
@@ -529,7 +529,7 @@ protected function submitForm(
 		array $formData,
 		HTMLForm $form,
 		int $id,
-		DBConnRef $dbw,
+		IDatabase $dbw,
 		IContextSource $context
 	) {
 		if ( isset( $formData['view'] ) && $formData['view'] ) {

diff --git a/includes/IncidentReportingHooks.php b/includes/IncidentReportingHooks.php
@@ -1,14 +1,30 @@
 <?php
 
 class IncidentReportingHooks {
+
 	public static function onLoadExtensionSchemaUpdates( DatabaseUpdater $updater ) {
-		$updater->addExtensionTable( 'incidents',
-			__DIR__ . '/../sql/incidents.sql' );
+		$updater->addExtensionUpdateOnVirtualDomain( [
+			'virtual-incidentreporting',
+			'addTable',
+			'incidents',
+			__DIR__ . '/../sql/incidents.sql',
+			true,
+		] );
 
-		$updater->addExtensionTable( 'incidents_log',
-			__DIR__ . '/../sql/incidents_log.sql' );
+		$updater->addExtensionUpdateOnVirtualDomain( [
+			'virtual-incidentreporting',
+			'addTable',
+			'incidents_log',
+			__DIR__ . '/../sql/incidents_log.sql',
+			true,
+		] );
 
-		$updater->addExtensionTable( 'incidents_reviewer',
-			__DIR__ . '/../sql/incidents_reviewer.sql' );
+		$updater->addExtensionUpdateOnVirtualDomain( [
+			'virtual-incidentreporting',
+			'addTable',
+			'incidents_reviewer',
+			__DIR__ . '/../sql/incidents_reviewer.sql',
+			true,
+		] );
 	}
 }
diff --git a/includes/IncidentReportingPager.php b/includes/IncidentReportingPager.php
@@ -15,18 +15,13 @@ class IncidentReportingPager extends TablePager {
 	/** @var string */
 	private $type;
 
-	/** @var Config */
-	private $config;
-
 	public function __construct( $type, $component, $services ) {
 		parent::__construct( $this->getContext() );
 		$this->type = $type;
 		$this->component = $component;
-		$this->config = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'incidentreporting' );
 
-		$this->mDb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()
-			->getMainLB( $this->config->get( 'IncidentReportingDatabase' ) )
-			->getMaintenanceConnectionRef( DB_REPLICA, [], $this->config->get( 'IncidentReportingDatabase' ) );
+		$this->mDb = MediaWikiServices::getInstance()->getConnectionProvider()
+			->getReplicaDatabase( 'virtual-incidentreporting' );
 
 		$irServices = [];
 		foreach ( $services as $service => $url ) {

diff --git a/includes/SpecialIncidentReports.php b/includes/SpecialIncidentReports.php
@@ -2,7 +2,7 @@
 
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Permissions\PermissionManager;
-use Wikimedia\Rdbms\DBConnRef;
+use Wikimedia\Rdbms\IDatabase;
 
 class SpecialIncidentReports extends SpecialPage {
 	/** @var Config */
@@ -23,9 +23,8 @@ public function execute( $par ) {
 
 		$par = explode( '/', $par );
 
-		$dbw = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()
-			->getMainLB( $this->config->get( 'IncidentReportingDatabase' ) )
-			->getMaintenanceConnectionRef( DB_PRIMARY, [], $this->config->get( 'IncidentReportingDatabase' ) );
+		$dbw = MediaWikiServices::getInstance()->getConnectionProvider()
+			->getPrimaryDatabase( 'virtual-incidentreporting' );
 
 		$inc = $dbw->selectRow(
 			'incidents',
@@ -48,7 +47,7 @@ public function execute( $par ) {
 	public function showForm(
 		int $id,
 		bool $edit,
-		DBConnRef $dbw,
+		IDatabase $dbw,
 		bool $isPublished
 	) {
 		if ( !$isPublished && !$this->permissionManager->userHasRight( $this->getContext()->getUser(), 'editincidents' ) ) {
@@ -72,7 +71,7 @@ public function showForm(
 		$htmlForm->show();
 	}
 
-	public function showLanding( DBConnRef $dbw ) {
+	public function showLanding( IDatabase $dbw ) {
 		$type = $this->getRequest()->getText( 'type' );
 		$component = $this->getRequest()->getText( 'component' );
 		$published = $this->getRequest()->getText( 'published' );