feat(setupchecks): add row format setup check for MySQL databases

Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>

diff --git a/apps/settings/composer/composer/autoload_classmap.php b/apps/settings/composer/composer/autoload_classmap.php
index 1b3c4c25552af14b7ba55fc7c0f17da1c235ba68..56f67d031cbfab55b02ba228ef739d4ad6a4741a 100644 (file)
--- a/apps/settings/composer/composer/autoload_classmap.php
+++ b/apps/settings/composer/composer/autoload_classmap.php
@@ -104,6 +104,7 @@ return array(
     'OCA\\Settings\\SetupChecks\\MaintenanceWindowStart' => $baseDir . '/../lib/SetupChecks/MaintenanceWindowStart.php',
     'OCA\\Settings\\SetupChecks\\MemcacheConfigured' => $baseDir . '/../lib/SetupChecks/MemcacheConfigured.php',
     'OCA\\Settings\\SetupChecks\\MimeTypeMigrationAvailable' => $baseDir . '/../lib/SetupChecks/MimeTypeMigrationAvailable.php',
+    'OCA\\Settings\\SetupChecks\\MysqlRowFormat' => $baseDir . '/../lib/SetupChecks/MysqlRowFormat.php',
     'OCA\\Settings\\SetupChecks\\MysqlUnicodeSupport' => $baseDir . '/../lib/SetupChecks/MysqlUnicodeSupport.php',
     'OCA\\Settings\\SetupChecks\\OcxProviders' => $baseDir . '/../lib/SetupChecks/OcxProviders.php',
     'OCA\\Settings\\SetupChecks\\OverwriteCliUrl' => $baseDir . '/../lib/SetupChecks/OverwriteCliUrl.php',

diff --git a/apps/settings/composer/composer/autoload_static.php b/apps/settings/composer/composer/autoload_static.php
index 5de0bb31fd6b4d9d35a309951017fcf195af7a6d..4481a8c2142b86ca20485b4fa9a66a0d1427427e 100644 (file)
--- a/apps/settings/composer/composer/autoload_static.php
+++ b/apps/settings/composer/composer/autoload_static.php
@@ -119,6 +119,7 @@ class ComposerStaticInitSettings
         'OCA\\Settings\\SetupChecks\\MaintenanceWindowStart' => __DIR__ . '/..' . '/../lib/SetupChecks/MaintenanceWindowStart.php',
         'OCA\\Settings\\SetupChecks\\MemcacheConfigured' => __DIR__ . '/..' . '/../lib/SetupChecks/MemcacheConfigured.php',
         'OCA\\Settings\\SetupChecks\\MimeTypeMigrationAvailable' => __DIR__ . '/..' . '/../lib/SetupChecks/MimeTypeMigrationAvailable.php',
+        'OCA\\Settings\\SetupChecks\\MysqlRowFormat' => __DIR__ . '/..' . '/../lib/SetupChecks/MysqlRowFormat.php',
         'OCA\\Settings\\SetupChecks\\MysqlUnicodeSupport' => __DIR__ . '/..' . '/../lib/SetupChecks/MysqlUnicodeSupport.php',
         'OCA\\Settings\\SetupChecks\\OcxProviders' => __DIR__ . '/..' . '/../lib/SetupChecks/OcxProviders.php',
         'OCA\\Settings\\SetupChecks\\OverwriteCliUrl' => __DIR__ . '/..' . '/../lib/SetupChecks/OverwriteCliUrl.php',

diff --git a/apps/settings/lib/AppInfo/Application.php b/apps/settings/lib/AppInfo/Application.php
index a9b1a5c1d6741d1b862e1860a4535b3e73c95776..bd06483fa6319060bfc368eb8b598d84a434343d 100644 (file)
--- a/apps/settings/lib/AppInfo/Application.php
+++ b/apps/settings/lib/AppInfo/Application.php
@@ -47,6 +47,7 @@ use OCA\Settings\SetupChecks\LegacySSEKeyFormat;
 use OCA\Settings\SetupChecks\MaintenanceWindowStart;
 use OCA\Settings\SetupChecks\MemcacheConfigured;
 use OCA\Settings\SetupChecks\MimeTypeMigrationAvailable;
+use OCA\Settings\SetupChecks\MysqlRowFormat;
 use OCA\Settings\SetupChecks\MysqlUnicodeSupport;
 use OCA\Settings\SetupChecks\OcxProviders;
 use OCA\Settings\SetupChecks\OverwriteCliUrl;
@@ -181,6 +182,7 @@ class Application extends App implements IBootstrap {
                $context->registerSetupCheck(MaintenanceWindowStart::class);
                $context->registerSetupCheck(MemcacheConfigured::class);
                $context->registerSetupCheck(MimeTypeMigrationAvailable::class);
+               $context->registerSetupCheck(MysqlRowFormat::class);
                $context->registerSetupCheck(MysqlUnicodeSupport::class);
                $context->registerSetupCheck(OcxProviders::class);
                $context->registerSetupCheck(OverwriteCliUrl::class);

diff --git a/apps/settings/lib/SetupChecks/MysqlRowFormat.php b/apps/settings/lib/SetupChecks/MysqlRowFormat.php
new file mode 100644 (file)
index 0000000..c7746cd
--- /dev/null
+++ b/apps/settings/lib/SetupChecks/MysqlRowFormat.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Settings\SetupChecks;
+
+use Doctrine\DBAL\Platforms\MySQLPlatform;
+use OC\DB\Connection;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\SetupCheck\ISetupCheck;
+use OCP\SetupCheck\SetupResult;
+
+class MysqlRowFormat implements ISetupCheck {
+       public function __construct(
+               private IL10N $l10n,
+               private IConfig $config,
+               private Connection $connection,
+               private IURLGenerator $urlGenerator,
+       ) {
+       }
+
+       public function getName(): string {
+               return $this->l10n->t('MySQL row format');
+       }
+
+       public function getCategory(): string {
+               return 'database';
+       }
+
+       public function run(): SetupResult {
+               if (!$this->connection->getDatabasePlatform() instanceof MySQLPlatform) {
+                       return SetupResult::success($this->l10n->t('You are not using MySQL'));
+               }
+
+               $wrongRowFormatTables = $this->getRowNotDynamicTables();
+               if (empty($wrongRowFormatTables)) {
+                       return SetupResult::success($this->l10n->t('None of your table use ROW_FORMAT=Compressed'));
+               }
+
+               return SetupResult::warning(
+                       $this->l10n->n(
+                               'Table %s is not using ROW_FORMAT=Dynamic. This format offers the best database performances for Nextcloud. Please change the row format to Dynamic.',
+                               'Some tables are not using ROW_FORMAT=Dynamic. This format offers the best database performances for Nextcloud. Please change the row format to Dynamic on the following tables: %s.',
+                               count($wrongRowFormatTables),
+                               [implode(', ', $wrongRowFormatTables)],
+                       ),
+                       'https://dev.mysql.com/doc/refman/en/innodb-row-format.html',
+               );
+       }
+
+       /**
+        * @return string[]
+        */
+       private function getRowNotDynamicTables(): array {
+               $sql = 'SELECT table_name
+                       FROM information_schema.tables
+                       WHERE table_schema = ?
+                         AND table_name LIKE "*PREFIX*%"
+                         AND row_format != "Dynamic";';
+
+               return $this->connection->executeQuery(
+                       $sql,
+                       [$this->config->getSystemValueString('dbname')],
+               )->fetchFirstColumn();
+       }
+}