Migrate missing index database check to new API

Signed-off-by: Côme Chilliet <[email protected]>

apps/settings/composer/composer/autoload_classmap.php

@@ -76,6 +76,7 @@
     'OCA\\Settings\\SetupChecks\\BruteForceThrottler' => $baseDir . '/../lib/SetupChecks/BruteForceThrottler.php',
     'OCA\\Settings\\SetupChecks\\CheckUserCertificates' => $baseDir . '/../lib/SetupChecks/CheckUserCertificates.php',
     'OCA\\Settings\\SetupChecks\\DatabaseHasMissingColumns' => $baseDir . '/../lib/SetupChecks/DatabaseHasMissingColumns.php',
+    'OCA\\Settings\\SetupChecks\\DatabaseHasMissingIndices' => $baseDir . '/../lib/SetupChecks/DatabaseHasMissingIndices.php',
     'OCA\\Settings\\SetupChecks\\DefaultPhoneRegionSet' => $baseDir . '/../lib/SetupChecks/DefaultPhoneRegionSet.php',
     'OCA\\Settings\\SetupChecks\\EmailTestSuccessful' => $baseDir . '/../lib/SetupChecks/EmailTestSuccessful.php',
     'OCA\\Settings\\SetupChecks\\FileLocking' => $baseDir . '/../lib/SetupChecks/FileLocking.php',

apps/settings/composer/composer/autoload_static.php

@@ -91,6 +91,7 @@ class ComposerStaticInitSettings
         'OCA\\Settings\\SetupChecks\\BruteForceThrottler' => __DIR__ . '/..' . '/../lib/SetupChecks/BruteForceThrottler.php',
         'OCA\\Settings\\SetupChecks\\CheckUserCertificates' => __DIR__ . '/..' . '/../lib/SetupChecks/CheckUserCertificates.php',
         'OCA\\Settings\\SetupChecks\\DatabaseHasMissingColumns' => __DIR__ . '/..' . '/../lib/SetupChecks/DatabaseHasMissingColumns.php',
+        'OCA\\Settings\\SetupChecks\\DatabaseHasMissingIndices' => __DIR__ . '/..' . '/../lib/SetupChecks/DatabaseHasMissingIndices.php',
         'OCA\\Settings\\SetupChecks\\DefaultPhoneRegionSet' => __DIR__ . '/..' . '/../lib/SetupChecks/DefaultPhoneRegionSet.php',
         'OCA\\Settings\\SetupChecks\\EmailTestSuccessful' => __DIR__ . '/..' . '/../lib/SetupChecks/EmailTestSuccessful.php',
         'OCA\\Settings\\SetupChecks\\FileLocking' => __DIR__ . '/..' . '/../lib/SetupChecks/FileLocking.php',

apps/settings/lib/AppInfo/Application.php

@@ -51,6 +51,7 @@
 use OCA\Settings\SetupChecks\BruteForceThrottler;
 use OCA\Settings\SetupChecks\CheckUserCertificates;
 use OCA\Settings\SetupChecks\DatabaseHasMissingColumns;
+use OCA\Settings\SetupChecks\DatabaseHasMissingIndices;
 use OCA\Settings\SetupChecks\DefaultPhoneRegionSet;
 use OCA\Settings\SetupChecks\EmailTestSuccessful;
 use OCA\Settings\SetupChecks\FileLocking;
@@ -162,6 +163,7 @@ public function register(IRegistrationContext $context): void {
 		$context->registerSetupCheck(BruteForceThrottler::class);
 		$context->registerSetupCheck(CheckUserCertificates::class);
 		$context->registerSetupCheck(DatabaseHasMissingColumns::class);
+		$context->registerSetupCheck(DatabaseHasMissingIndices::class);
 		$context->registerSetupCheck(DefaultPhoneRegionSet::class);
 		$context->registerSetupCheck(EmailTestSuccessful::class);
 		$context->registerSetupCheck(FileLocking::class);

apps/settings/lib/Controller/CheckSetupController.php

@@ -51,7 +51,6 @@
 use OC;
 use OC\AppFramework\Http;
 use OC\DB\Connection;
-use OC\DB\MissingIndexInformation;
 use OC\DB\MissingPrimaryKeyInformation;
 use OC\DB\SchemaWrapper;
 use OC\IntegrityCheck\Checker;
@@ -61,7 +60,6 @@
 use OCP\AppFramework\Http\DataDisplayResponse;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\RedirectResponse;
-use OCP\DB\Events\AddMissingIndicesEvent;
 use OCP\DB\Events\AddMissingPrimaryKeyEvent;
 use OCP\DB\Types;
 use OCP\EventDispatcher\IEventDispatcher;
@@ -417,29 +415,6 @@ protected function getOpcacheSetupRecommendations(): array {
 		return $recommendations;
 	}
 
-	protected function hasMissingIndexes(): array {
-		$indexInfo = new MissingIndexInformation();
-
-		// Dispatch event so apps can also hint for pending index updates if needed
-		$event = new AddMissingIndicesEvent();
-		$this->dispatcher->dispatchTyped($event);
-		$missingIndices = $event->getMissingIndices();
-
-		if ($missingIndices !== []) {
-			$schema = new SchemaWrapper(\OCP\Server::get(Connection::class));
-			foreach ($missingIndices as $missingIndex) {
-				if ($schema->hasTable($missingIndex['tableName'])) {
-					$table = $schema->getTable($missingIndex['tableName']);
-					if (!$table->hasIndex($missingIndex['indexName'])) {
-						$indexInfo->addHintForMissingSubject($missingIndex['tableName'], $missingIndex['indexName']);
-					}
-				}
-			}
-		}
-
-		return $indexInfo->getListOfMissingIndexes();
-	}
-
 	protected function hasMissingPrimaryKeys(): array {
 		$info = new MissingPrimaryKeyInformation();
 		// Dispatch event so apps can also hint for pending key updates if needed
@@ -679,7 +654,6 @@ public function check() {
 				'OpcacheSetupRecommendations' => $this->getOpcacheSetupRecommendations(),
 				'isSettimelimitAvailable' => $this->isSettimelimitAvailable(),
 				'missingPrimaryKeys' => $this->hasMissingPrimaryKeys(),
-				'missingIndexes' => $this->hasMissingIndexes(),
 				'isSqliteUsed' => $this->isSqliteUsed(),
 				'databaseConversionDocumentation' => $this->urlGenerator->linkToDocs('admin-db-conversion'),
 				'appDirsWithDifferentOwner' => $this->getAppDirsWithDifferentOwner(),

apps/settings/lib/SetupChecks/DatabaseHasMissingIndices.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Côme Chilliet <[email protected]>
+ *
+ * @author Côme Chilliet <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\Settings\SetupChecks;
+
+use OC\DB\Connection;
+use OC\DB\MissingIndexInformation;
+use OC\DB\SchemaWrapper;
+use OCP\DB\Events\AddMissingIndicesEvent;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IL10N;
+use OCP\SetupCheck\ISetupCheck;
+use OCP\SetupCheck\SetupResult;
+
+class DatabaseHasMissingIndices implements ISetupCheck {
+	public function __construct(
+		private IL10N $l10n,
+		private Connection $connection,
+		private IEventDispatcher $dispatcher,
+	) {
+	}
+
+	public function getCategory(): string {
+		return 'database';
+	}
+
+	public function getName(): string {
+		return $this->l10n->t('Database missing indices');
+	}
+
+	private function getMissingIndices(): array {
+		$indexInfo = new MissingIndexInformation();
+		// Dispatch event so apps can also hint for pending index updates if needed
+		$event = new AddMissingIndicesEvent();
+		$this->dispatcher->dispatchTyped($event);
+		$missingIndices = $event->getMissingIndices();
+
+		if (!empty($missingIndices)) {
+			$schema = new SchemaWrapper($this->connection);
+			foreach ($missingIndices as $missingIndex) {
+				if ($schema->hasTable($missingIndex['tableName'])) {
+					$table = $schema->getTable($missingIndex['tableName']);
+					if (!$table->hasIndex($missingIndex['indexName'])) {
+						$indexInfo->addHintForMissingIndex($missingIndex['tableName'], $missingIndex['indexName']);
+					}
+				}
+			}
+		}
+
+		return $indexInfo->getListOfMissingIndices();
+	}
+
+	public function run(): SetupResult {
+		$missingIndices = $this->getMissingIndices();
+		if (empty($missingIndices)) {
+			return SetupResult::success('None');
+		} else {
+			$list = '';
+			foreach ($missingIndices as $missingIndex) {
+				$list .= "\n".$this->l10n->t('Missing optional index "%s" in table "%s".', [$missingIndex['indexName'], $missingIndex['tableName']]);
+			}
+			return SetupResult::info(
+				$this->l10n->t('The database is missing some indexes. Due to the fact that adding indexes on big tables could take some time they were not added automatically. By running "occ db:add-missing-indices" those missing indexes could be added manually while the instance keeps running. Once the indexes are added queries to those tables are usually much faster.').$list
+			);
+		}
+	}
+}

apps/settings/tests/Controller/CheckSetupControllerTest.php

@@ -178,7 +178,6 @@ protected function setUp(): void {
 				'getCurlVersion',
 				'isPhpOutdated',
 				'getOpcacheSetupRecommendations',
-				'hasMissingIndexes',
 				'hasMissingPrimaryKeys',
 				'isSqliteUsed',
 				'isPHPMailerUsed',
@@ -229,9 +228,6 @@ public function testCheck() {
 			->expects($this->once())
 			->method('getOpcacheSetupRecommendations')
 			->willReturn(['recommendation1', 'recommendation2']);
-		$this->checkSetupController
-			->method('hasMissingIndexes')
-			->willReturn([]);
 		$this->checkSetupController
 			->method('hasMissingPrimaryKeys')
 			->willReturn([]);

core/js/setupchecks.js

@@ -258,18 +258,6 @@
 							type: OC.SetupChecks.MESSAGE_TYPE_WARNING
 						});
 					}
-					if (data.missingIndexes.length > 0) {
-						var listOfMissingIndexes = "";
-						data.missingIndexes.forEach(function(element){
-							listOfMissingIndexes += '<li>';
-							listOfMissingIndexes += t('core', 'Missing index "{indexName}" in table "{tableName}".', element);
-							listOfMissingIndexes += '</li>';
-						});
-						messages.push({
-							msg: t('core', 'The database is missing some indexes. Due to the fact that adding indexes on big tables could take some time they were not added automatically. By running "occ db:add-missing-indices" those missing indexes could be added manually while the instance keeps running. Once the indexes are added queries to those tables are usually much faster.') + '<ul>' + listOfMissingIndexes + '</ul>',
-							type: OC.SetupChecks.MESSAGE_TYPE_INFO
-						})
-					}
 					if (data.missingPrimaryKeys.length > 0) {
 						var listOfMissingPrimaryKeys = "";
 						data.missingPrimaryKeys.forEach(function(element){

core/js/tests/specs/setupchecksSpec.js

@@ -229,7 +229,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -281,7 +280,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -333,7 +331,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -385,7 +382,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -435,7 +431,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -488,7 +483,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: false,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -539,7 +533,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -621,7 +614,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -678,7 +670,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: ['recommendation1', 'recommendation2'],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -728,7 +719,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -782,7 +772,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -833,7 +822,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -881,7 +869,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -932,7 +919,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -983,7 +969,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -1033,7 +1018,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {
@@ -1090,7 +1074,6 @@ describe('OC.SetupChecks tests', function() {
 					hasPassedCodeIntegrityCheck: true,
 					OpcacheSetupRecommendations: [],
 					isSettimelimitAvailable: true,
-					missingIndexes: [],
 					missingPrimaryKeys: [],
 					cronErrors: [],
 					cronInfo: {

lib/private/DB/MissingIndexInformation.php

@@ -27,16 +27,16 @@
 namespace OC\DB;
 
 class MissingIndexInformation {
-	private $listOfMissingIndexes = [];
+	private array $listOfMissingIndices = [];
 
-	public function addHintForMissingSubject(string $tableName, string $indexName) {
-		$this->listOfMissingIndexes[] = [
+	public function addHintForMissingIndex(string $tableName, string $indexName): void {
+		$this->listOfMissingIndices[] = [
 			'tableName' => $tableName,
 			'indexName' => $indexName
 		];
 	}
 
-	public function getListOfMissingIndexes(): array {
-		return $this->listOfMissingIndexes;
+	public function getListOfMissingIndices(): array {
+		return $this->listOfMissingIndices;
 	}
 }