Merge SQlite warning to existing SupportedDatabase setup check

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
nextcloud · Jan 15, 2024 · ca63726 · ca63726
1 parent 004d3c4
commit ca63726
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 25 deletions.
diff --git a/apps/settings/lib/Controller/CheckSetupController.php b/apps/settings/lib/Controller/CheckSetupController.php
@@ -401,10 +401,6 @@ protected function getOpcacheSetupRecommendations(): array {
 		return $recommendations;
 	}
 
-	protected function isSqliteUsed() {
-		return str_contains($this->config->getSystemValue('dbtype'), 'sqlite');
-	}
-
 	protected function getSuggestedOverwriteCliURL(): string {
 		$currentOverwriteCliUrl = $this->config->getSystemValue('overwrite.cli.url', '');
 		$suggestedOverwriteCliUrl = $this->request->getServerProtocol() . '://' . $this->request->getInsecureServerHost() . \OC::$WEBROOT;
@@ -574,8 +570,6 @@ public function check() {
 				'codeIntegrityCheckerDocumentation' => $this->urlGenerator->linkToDocs('admin-code-integrity'),
 				'OpcacheSetupRecommendations' => $this->getOpcacheSetupRecommendations(),
 				'isSettimelimitAvailable' => $this->isSettimelimitAvailable(),
-				'isSqliteUsed' => $this->isSqliteUsed(),
-				'databaseConversionDocumentation' => $this->urlGenerator->linkToDocs('admin-db-conversion'),
 				'appDirsWithDifferentOwner' => $this->getAppDirsWithDifferentOwner(),
 				'isImagickEnabled' => $this->isImagickEnabled(),
 				'areWebauthnExtensionsEnabled' => $this->areWebauthnExtensionsEnabled(),

diff --git a/apps/settings/lib/SetupChecks/SupportedDatabase.php b/apps/settings/lib/SetupChecks/SupportedDatabase.php
@@ -33,12 +33,14 @@
 use Doctrine\DBAL\Platforms\SqlitePlatform;
 use OCP\IDBConnection;
 use OCP\IL10N;
+use OCP\IURLGenerator;
 use OCP\SetupCheck\ISetupCheck;
 use OCP\SetupCheck\SetupResult;
 
 class SupportedDatabase implements ISetupCheck {
 	public function __construct(
 		private IL10N $l10n,
+		private IURLGenerator $urlGenerator,
 		private IDBConnection $connection,
 	) {
 	}
@@ -81,7 +83,10 @@ public function run(): SetupResult {
 		} elseif ($databasePlatform instanceof OraclePlatform) {
 			$version = 'Oracle';
 		} elseif ($databasePlatform instanceof SqlitePlatform) {
-			$version = 'Sqlite';
+			return SetupResult::warning(
+				$this->l10n->t('SQLite is currently being used as the backend database. For larger installations we recommend that you switch to a different database backend. This is particularly recommended when using the desktop client for file synchronisation. To migrate to another database use the command line tool: "occ db:convert-type".'),
+				$this->urlGenerator->linkToDocs('admin-db-conversion')
+			);
 		} else {
 			return SetupResult::error($this->l10n->t('Unknown database platform'));
 		}

diff --git a/apps/settings/tests/Controller/CheckSetupControllerTest.php b/apps/settings/tests/Controller/CheckSetupControllerTest.php
@@ -165,7 +165,6 @@ protected function setUp(): void {
 				'getCurlVersion',
 				'isPhpOutdated',
 				'getOpcacheSetupRecommendations',
-				'isSqliteUsed',
 				'isPHPMailerUsed',
 				'getAppDirsWithDifferentOwner',
 				'isImagickEnabled',
@@ -213,9 +212,6 @@ public function testCheck() {
 			->expects($this->once())
 			->method('getOpcacheSetupRecommendations')
 			->willReturn(['recommendation1', 'recommendation2']);
-		$this->checkSetupController
-			->method('isSqliteUsed')
-			->willReturn(false);
 		$this->checkSetupController
 			->expects($this->once())
 			->method('getSuggestedOverwriteCliURL')
@@ -305,8 +301,6 @@ public function testCheck() {
 				'codeIntegrityCheckerDocumentation' => 'http://docs.example.org/server/go.php?to=admin-code-integrity',
 				'OpcacheSetupRecommendations' => ['recommendation1', 'recommendation2'],
 				'isSettimelimitAvailable' => true,
-				'isSqliteUsed' => false,
-				'databaseConversionDocumentation' => 'http://docs.example.org/server/go.php?to=admin-db-conversion',
 				'appDirsWithDifferentOwner' => [],
 				'isImagickEnabled' => false,
 				'areWebauthnExtensionsEnabled' => false,

diff --git a/apps/settings/tests/SetupChecks/SupportedDatabaseTest.php b/apps/settings/tests/SetupChecks/SupportedDatabaseTest.php
@@ -25,18 +25,45 @@
  */
 namespace OCA\Settings\Tests;
 
+use Doctrine\DBAL\Platforms\SqlitePlatform;
 use OCA\Settings\SetupChecks\SupportedDatabase;
+use OCP\IDBConnection;
 use OCP\IL10N;
+use OCP\IUrlGenerator;
 use OCP\SetupCheck\SetupResult;
 use Test\TestCase;
 
 /**
  * @group DB
  */
 class SupportedDatabaseTest extends TestCase {
+	private IL10N $l10n;
+	private IUrlGenerator $urlGenerator;
+	private IDBConnection $connection;
+
+	private SupportedDatabase $check;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$this->l10n = $this->getMockBuilder(IL10N::class)->getMock();
+		$this->urlGenerator = $this->getMockBuilder(IUrlGenerator::class)->getMock();
+		$this->connection = \OCP\Server::get(IDBConnection::class);
+
+		$this->check = new SupportedDatabase(
+			$this->l10n,
+			$this->urlGenerator,
+			\OCP\Server::get(IDBConnection::class)
+		);
+	}
+
 	public function testPass(): void {
-		$l10n = $this->getMockBuilder(IL10N::class)->getMock();
-		$check = new SupportedDatabase($l10n, \OC::$server->getDatabaseConnection());
-		$this->assertEquals(SetupResult::SUCCESS, $check->run()->getSeverity());
+		$platform = $this->connection->getDatabasePlatform();
+		if ($platform instanceof SqlitePlatform) {
+			/** SQlite always gets a warning */
+			$this->assertEquals(SetupResult::WARNING, $this->check->run()->getSeverity());
+		} else {
+			$this->assertEquals(SetupResult::SUCCESS, $this->check->run()->getSeverity());
+		}
 	}
 }
diff --git a/core/js/setupchecks.js b/core/js/setupchecks.js
@@ -282,15 +282,6 @@
 							type: OC.SetupChecks.MESSAGE_TYPE_INFO
 						})
 					}
-					if (data.isSqliteUsed) {
-						messages.push({
-							msg: t('core', 'SQLite is currently being used as the backend database. For larger installations we recommend that you switch to a different database backend.') + ' ' + t('core', 'This is particularly recommended when using the desktop client for file synchronisation.') + ' ' +
-							t('core', 'To migrate to another database use the command line tool: "occ db:convert-type", or see the {linkstart}documentation ↗{linkend}.')
-								.replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.databaseConversionDocumentation + '">')
-								.replace('{linkend}', '</a>'),
-							type: OC.SetupChecks.MESSAGE_TYPE_WARNING
-						})
-					}
 
 					if(data.appDirsWithDifferentOwner && data.appDirsWithDifferentOwner.length > 0) {
 						var appDirsWithDifferentOwner = data.appDirsWithDifferentOwner.reduce(