From: Côme Chilliet Date: Tue, 14 Nov 2023 14:14:14 +0000 (+0100) Subject: Migrate missing column database check to new API X-Git-Tag: v29.0.0beta1~770^2~5 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=2cb1c0f2dc0a5678de142c2791fde25475eb1632;p=nextcloud-server.git Migrate missing column database check to new API Signed-off-by: Côme Chilliet --- diff --git a/apps/settings/composer/composer/autoload_classmap.php b/apps/settings/composer/composer/autoload_classmap.php index e6d1f3ff83f..c3ce8650443 100644 --- a/apps/settings/composer/composer/autoload_classmap.php +++ b/apps/settings/composer/composer/autoload_classmap.php @@ -75,6 +75,7 @@ return array( 'OCA\\Settings\\Settings\\Personal\\ServerDevNotice' => $baseDir . '/../lib/Settings/Personal/ServerDevNotice.php', '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\\DefaultPhoneRegionSet' => $baseDir . '/../lib/SetupChecks/DefaultPhoneRegionSet.php', 'OCA\\Settings\\SetupChecks\\EmailTestSuccessful' => $baseDir . '/../lib/SetupChecks/EmailTestSuccessful.php', 'OCA\\Settings\\SetupChecks\\FileLocking' => $baseDir . '/../lib/SetupChecks/FileLocking.php', diff --git a/apps/settings/composer/composer/autoload_static.php b/apps/settings/composer/composer/autoload_static.php index 1a95f65119a..fe123d74d81 100644 --- a/apps/settings/composer/composer/autoload_static.php +++ b/apps/settings/composer/composer/autoload_static.php @@ -90,6 +90,7 @@ class ComposerStaticInitSettings 'OCA\\Settings\\Settings\\Personal\\ServerDevNotice' => __DIR__ . '/..' . '/../lib/Settings/Personal/ServerDevNotice.php', '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\\DefaultPhoneRegionSet' => __DIR__ . '/..' . '/../lib/SetupChecks/DefaultPhoneRegionSet.php', 'OCA\\Settings\\SetupChecks\\EmailTestSuccessful' => __DIR__ . '/..' . '/../lib/SetupChecks/EmailTestSuccessful.php', 'OCA\\Settings\\SetupChecks\\FileLocking' => __DIR__ . '/..' . '/../lib/SetupChecks/FileLocking.php', diff --git a/apps/settings/lib/AppInfo/Application.php b/apps/settings/lib/AppInfo/Application.php index d694e650b48..d73961968f8 100644 --- a/apps/settings/lib/AppInfo/Application.php +++ b/apps/settings/lib/AppInfo/Application.php @@ -50,6 +50,7 @@ use OCA\Settings\Search\SectionSearch; use OCA\Settings\Search\UserSearch; use OCA\Settings\SetupChecks\BruteForceThrottler; use OCA\Settings\SetupChecks\CheckUserCertificates; +use OCA\Settings\SetupChecks\DatabaseHasMissingColumns; use OCA\Settings\SetupChecks\DefaultPhoneRegionSet; use OCA\Settings\SetupChecks\EmailTestSuccessful; use OCA\Settings\SetupChecks\FileLocking; @@ -160,6 +161,7 @@ class Application extends App implements IBootstrap { }); $context->registerSetupCheck(BruteForceThrottler::class); $context->registerSetupCheck(CheckUserCertificates::class); + $context->registerSetupCheck(DatabaseHasMissingColumns::class); $context->registerSetupCheck(DefaultPhoneRegionSet::class); $context->registerSetupCheck(EmailTestSuccessful::class); $context->registerSetupCheck(FileLocking::class); diff --git a/apps/settings/lib/Controller/CheckSetupController.php b/apps/settings/lib/Controller/CheckSetupController.php index 13e54063d8a..1fa6a658878 100644 --- a/apps/settings/lib/Controller/CheckSetupController.php +++ b/apps/settings/lib/Controller/CheckSetupController.php @@ -51,7 +51,6 @@ use GuzzleHttp\Exception\ClientException; use OC; use OC\AppFramework\Http; use OC\DB\Connection; -use OC\DB\MissingColumnInformation; use OC\DB\MissingIndexInformation; use OC\DB\MissingPrimaryKeyInformation; use OC\DB\SchemaWrapper; @@ -62,7 +61,6 @@ use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; use OCP\AppFramework\Http\DataDisplayResponse; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\RedirectResponse; -use OCP\DB\Events\AddMissingColumnsEvent; use OCP\DB\Events\AddMissingIndicesEvent; use OCP\DB\Events\AddMissingPrimaryKeyEvent; use OCP\DB\Types; @@ -464,28 +462,6 @@ Raw output return $info->getListOfMissingPrimaryKeys(); } - protected function hasMissingColumns(): array { - $columnInfo = new MissingColumnInformation(); - // Dispatch event so apps can also hint for pending column updates if needed - $event = new AddMissingColumnsEvent(); - $this->dispatcher->dispatchTyped($event); - $missingColumns = $event->getMissingColumns(); - - if (!empty($missingColumns)) { - $schema = new SchemaWrapper(\OCP\Server::get(Connection::class)); - foreach ($missingColumns as $missingColumn) { - if ($schema->hasTable($missingColumn['tableName'])) { - $table = $schema->getTable($missingColumn['tableName']); - if (!$table->hasColumn($missingColumn['columnName'])) { - $columnInfo->addHintForMissingColumn($missingColumn['tableName'], $missingColumn['columnName']); - } - } - } - } - - return $columnInfo->getListOfMissingColumns(); - } - protected function isSqliteUsed() { return str_contains($this->config->getSystemValue('dbtype'), 'sqlite'); } @@ -704,7 +680,6 @@ Raw output 'isSettimelimitAvailable' => $this->isSettimelimitAvailable(), 'missingPrimaryKeys' => $this->hasMissingPrimaryKeys(), 'missingIndexes' => $this->hasMissingIndexes(), - 'missingColumns' => $this->hasMissingColumns(), 'isSqliteUsed' => $this->isSqliteUsed(), 'databaseConversionDocumentation' => $this->urlGenerator->linkToDocs('admin-db-conversion'), 'appDirsWithDifferentOwner' => $this->getAppDirsWithDifferentOwner(), diff --git a/apps/settings/lib/SetupChecks/DatabaseHasMissingColumns.php b/apps/settings/lib/SetupChecks/DatabaseHasMissingColumns.php new file mode 100644 index 00000000000..946f357a04b --- /dev/null +++ b/apps/settings/lib/SetupChecks/DatabaseHasMissingColumns.php @@ -0,0 +1,89 @@ + + * + * @author Côme Chilliet + * + * @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 . + * + */ +namespace OCA\Settings\SetupChecks; + +use OC\DB\Connection; +use OC\DB\MissingColumnInformation; +use OC\DB\SchemaWrapper; +use OCP\DB\Events\AddMissingColumnsEvent; +use OCP\EventDispatcher\IEventDispatcher; +use OCP\IL10N; +use OCP\SetupCheck\ISetupCheck; +use OCP\SetupCheck\SetupResult; + +class DatabaseHasMissingColumns 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 columns'); + } + + private function getMissingColumns(): array { + $columnInfo = new MissingColumnInformation(); + // Dispatch event so apps can also hint for pending column updates if needed + $event = new AddMissingColumnsEvent(); + $this->dispatcher->dispatchTyped($event); + $missingColumns = $event->getMissingColumns(); + + if (!empty($missingColumns)) { + $schema = new SchemaWrapper($this->connection); + foreach ($missingColumns as $missingColumn) { + if ($schema->hasTable($missingColumn['tableName'])) { + $table = $schema->getTable($missingColumn['tableName']); + if (!$table->hasColumn($missingColumn['columnName'])) { + $columnInfo->addHintForMissingColumn($missingColumn['tableName'], $missingColumn['columnName']); + } + } + } + } + + return $columnInfo->getListOfMissingColumns(); + } + + public function run(): SetupResult { + $missingColumns = $this->getMissingColumns(); + if (empty($missingColumns)) { + return SetupResult::success('None'); + } else { + $list = ''; + foreach ($missingColumns as $missingColumn) { + $list .= "\n".$this->l10n->t('Missing optional column "%s" in table "%s".', [$missingColumn['columnName'], $missingColumn['tableName']]); + } + return SetupResult::info( + $this->l10n->t('The database is missing some optional columns. Due to the fact that adding columns on big tables could take some time they were not added automatically when they can be optional. By running "occ db:add-missing-columns" those missing columns could be added manually while the instance keeps running. Once the columns are added some features might improve responsiveness or usability.').$list + ); + } + } +} diff --git a/apps/settings/tests/Controller/CheckSetupControllerTest.php b/apps/settings/tests/Controller/CheckSetupControllerTest.php index fb2aa1a975d..e5db2d52e3c 100644 --- a/apps/settings/tests/Controller/CheckSetupControllerTest.php +++ b/apps/settings/tests/Controller/CheckSetupControllerTest.php @@ -339,7 +339,6 @@ class CheckSetupControllerTest extends TestCase { 'databaseConversionDocumentation' => 'http://docs.example.org/server/go.php?to=admin-db-conversion', 'missingIndexes' => [], 'missingPrimaryKeys' => [], - 'missingColumns' => [], 'appDirsWithDifferentOwner' => [], 'isImagickEnabled' => false, 'areWebauthnExtensionsEnabled' => false, diff --git a/core/js/setupchecks.js b/core/js/setupchecks.js index 1d64acf01ea..5cd2cadaa2d 100644 --- a/core/js/setupchecks.js +++ b/core/js/setupchecks.js @@ -282,18 +282,6 @@ type: OC.SetupChecks.MESSAGE_TYPE_INFO }) } - if (data.missingColumns.length > 0) { - var listOfMissingColumns = ""; - data.missingColumns.forEach(function(element){ - listOfMissingColumns += '
  • '; - listOfMissingColumns += t('core', 'Missing optional column "{columnName}" in table "{tableName}".', element); - listOfMissingColumns += '
    • '; - }); - messages.push({ - msg: t('core', 'The database is missing some optional columns. Due to the fact that adding columns on big tables could take some time they were not added automatically when they can be optional. By running "occ db:add-missing-columns" those missing columns could be added manually while the instance keeps running. Once the columns are added some features might improve responsiveness or usability.') + '
      ' + listOfMissingColumns + '
    ', - type: OC.SetupChecks.MESSAGE_TYPE_INFO - }) - } if (!data.isImagickEnabled) { messages.push({ msg: t( diff --git a/core/js/tests/specs/setupchecksSpec.js b/core/js/tests/specs/setupchecksSpec.js index d9124cfc84d..9cba013bb87 100644 --- a/core/js/tests/specs/setupchecksSpec.js +++ b/core/js/tests/specs/setupchecksSpec.js @@ -231,7 +231,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -284,7 +283,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -337,7 +335,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -390,7 +387,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -441,7 +437,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -495,7 +490,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: false, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -547,7 +541,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -630,7 +623,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -688,7 +680,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -739,7 +730,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -794,7 +784,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -846,7 +835,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -895,7 +883,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -947,7 +934,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -999,7 +985,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -1050,7 +1035,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 @@ -1108,7 +1092,6 @@ describe('OC.SetupChecks tests', function() { isSettimelimitAvailable: true, missingIndexes: [], missingPrimaryKeys: [], - missingColumns: [], cronErrors: [], cronInfo: { diffInSeconds: 0 diff --git a/lib/private/DB/MissingColumnInformation.php b/lib/private/DB/MissingColumnInformation.php index f651546b4b3..919f8923a26 100644 --- a/lib/private/DB/MissingColumnInformation.php +++ b/lib/private/DB/MissingColumnInformation.php @@ -26,7 +26,7 @@ declare(strict_types=1); namespace OC\DB; class MissingColumnInformation { - private $listOfMissingColumns = []; + private array $listOfMissingColumns = []; public function addHintForMissingColumn(string $tableName, string $columnName): void { $this->listOfMissingColumns[] = [