refactor: Use GlobalScale/IConfig everywhere

refactor: Use GlobalScale/IConfig everywhere

Signed-off-by: Carl Schwan <carl@carlschwan.eu>

[skip ci]

Author: CarlSchwan

apps/lookup_server_connector/lib/BackgroundJobs/RetryJob.php

@@ -13,6 +13,7 @@
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\Job;
+use OCP\GlobalScale\IConfig as GlobalScaleConfig;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
 use OCP\IUser;
@@ -38,6 +39,7 @@ public function __construct(
 		private IUserManager $userManager,
 		private IAccountManager $accountManager,
 		private Signer $signer,
+		private GlobalScaleConfig $globalScaleConfig,
 	) {
 		parent::__construct($time);
 
@@ -85,7 +87,7 @@ public function start(IJobList $jobList): void {
 	protected function shouldRemoveBackgroundJob(): bool {
 		// TODO: Remove global scale condition once lookup server is used for non-global scale federation
 		// return $this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'no') !== 'yes'
-		return !$this->config->getSystemValueBool('gs.enabled', false)
+		return !$this->globalScaleConfig->isGlobalScaleEnabled()
 			|| $this->config->getSystemValueBool('has_internet_connection', true) === false
 			|| $this->config->getSystemValueString('lookup_server', 'https://lookup.nextcloud.com') === ''
 			|| $this->retries >= 5;

apps/lookup_server_connector/lib/UpdateLookupServer.php

@@ -10,6 +10,8 @@
 
 use OCA\LookupServerConnector\BackgroundJobs\RetryJob;
 use OCP\BackgroundJob\IJobList;
+use OCP\Config\IUserConfig;
+use OCP\GlobalScale\IConfig as GlobalScaleConfig;
 use OCP\IConfig;
 use OCP\IUser;
 
@@ -19,26 +21,21 @@
  * @package OCA\LookupServerConnector
  */
 class UpdateLookupServer {
-	/**
-	 * @param IJobList $jobList
-	 * @param IConfig $config
-	 */
 	public function __construct(
-		private IJobList $jobList,
-		private IConfig $config,
+		private readonly IJobList $jobList,
+		private readonly IConfig $config,
+		private readonly IUserConfig $userConfig,
+		private readonly GlobalScaleConfig $globalScaleConfig,
 	) {
 	}
 
-	/**
-	 * @param IUser $user
-	 */
 	public function userUpdated(IUser $user): void {
 		if (!$this->shouldUpdateLookupServer()) {
 			return;
 		}
 
 		// Reset retry counter
-		$this->config->deleteUserValue(
+		$this->userConfig->deleteUserConfig(
 			$user->getUID(),
 			'lookup_server_connector',
 			'update_retries'
@@ -47,17 +44,15 @@ public function userUpdated(IUser $user): void {
 	}
 
 	/**
-	 * check if we should update the lookup server, we only do it if
+	 * Check if we should update the lookup server, we only do it if
 	 *
 	 * + we have an internet connection
 	 * + the lookup server update was not disabled by the admin
 	 * + we have a valid lookup server URL
-	 *
-	 * @return bool
 	 */
 	private function shouldUpdateLookupServer(): bool {
 		// TODO: Consider reenable for non-global-scale setups by checking "'files_sharing', 'lookupServerUploadEnabled'" instead of "gs.enabled"
-		return $this->config->getSystemValueBool('gs.enabled', false)
+		return $this->globalScaleConfig->isGlobalScaleEnabled()
 			&& $this->config->getSystemValueBool('has_internet_connection', true)
 			&& $this->config->getSystemValueString('lookup_server', 'https://lookup.nextcloud.com') !== '';
 	}

apps/settings/lib/BackgroundJobs/VerifyUserData.php

@@ -14,6 +14,7 @@
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\Job;
+use OCP\GlobalScale\IConfig as GlobalScaleConfig;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
 use OCP\IUserManager;
@@ -37,6 +38,7 @@ public function __construct(
 		private LoggerInterface $logger,
 		ITimeFactory $timeFactory,
 		private IConfig $config,
+		private GlobalScaleConfig $globalScaleConfig,
 	) {
 		parent::__construct($timeFactory);
 
@@ -123,7 +125,7 @@ protected function verifyWebsite(array $argument) {
 
 	protected function verifyViaLookupServer(array $argument, string $dataType): bool {
 		// TODO: Consider to enable for non-global-scale setups by checking 'files_sharing', 'lookupServerUploadEnabled'
-		if (!$this->config->getSystemValueBool('gs.enabled', false)
+		if (!$this->globalScaleConfig->isGlobalScaleEnabled()
 			|| empty($this->lookupServerUrl)
 			|| $this->config->getSystemValue('has_internet_connection', true) === false
 		) {

lib/private/Collaboration/Collaborators/LookupPlugin.php

@@ -11,6 +11,7 @@
 use OCP\Collaboration\Collaborators\ISearchResult;
 use OCP\Collaboration\Collaborators\SearchResultType;
 use OCP\Federation\ICloudIdManager;
+use OCP\GlobalScale\IConfig as GlobalScaleConfig;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
 use OCP\IUserSession;
@@ -22,20 +23,21 @@ class LookupPlugin implements ISearchPlugin {
 	private string $currentUserRemote;
 
 	public function __construct(
-		private IConfig $config,
-		private IClientService $clientService,
+		private readonly IConfig $config,
+		private readonly IClientService $clientService,
 		IUserSession $userSession,
-		private ICloudIdManager $cloudIdManager,
-		private LoggerInterface $logger,
-		private ?TrustedServers $trustedServers,
+		private readonly ICloudIdManager $cloudIdManager,
+		private readonly LoggerInterface $logger,
+		private readonly ?TrustedServers $trustedServers,
+		private readonly GlobalScaleConfig $globalScaleConfig,
 	) {
 		$currentUserCloudId = $userSession->getUser()->getCloudId();
 		$this->currentUserRemote = $cloudIdManager->resolveCloudId($currentUserCloudId)->getRemote();
 	}
 
 	#[\Override]
 	public function search($search, $limit, $offset, ISearchResult $searchResult): bool {
-		$isGlobalScaleEnabled = $this->config->getSystemValueBool('gs.enabled', false);
+		$isGlobalScaleEnabled = $this->globalScaleConfig->isGlobalScaleEnabled();
 		$isLookupServerEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no') === 'yes';
 		$hasInternetConnection = $this->config->getSystemValueBool('has_internet_connection', true);
 

tests/lib/Collaboration/Collaborators/LookupPluginTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
@@ -13,6 +15,7 @@
 use OCP\Collaboration\Collaborators\SearchResultType;
 use OCP\Federation\ICloudId;
 use OCP\Federation\ICloudIdManager;
+use OCP\GlobalScale\IConfig as GlobalScaleConfig;
 use OCP\Http\Client\IClient;
 use OCP\Http\Client\IClientService;
 use OCP\Http\Client\IResponse;
@@ -25,18 +28,13 @@
 use Test\TestCase;
 
 class LookupPluginTest extends TestCase {
-	/** @var IConfig|MockObject */
-	protected $config;
-	/** @var IClientService|MockObject */
-	protected $clientService;
-	/** @var IUserSession|MockObject */
-	protected $userSession;
-	/** @var ICloudIdManager|MockObject */
-	protected $cloudIdManager;
-	/** @var LookupPlugin */
-	protected $plugin;
-	/** @var LoggerInterface|MockObject */
-	protected $logger;
+	protected IConfig&MockObject $config;
+	protected GlobalScaleConfig&MockObject $globalScaleConfig;
+	protected IClientService&MockObject $clientService;
+	protected IUserSession&MockObject $userSession;
+	protected ICloudIdManager&MockObject $cloudIdManager;
+	protected LookupPlugin $plugin;
+	protected LoggerInterface&MockObject $logger;
 
 	#[\Override]
 	protected function setUp(): void {
@@ -45,6 +43,7 @@ protected function setUp(): void {
 		$this->userSession = $this->createMock(IUserSession::class);
 		$this->cloudIdManager = $this->createMock(ICloudIdManager::class);
 		$this->config = $this->createMock(IConfig::class);
+		$this->globalScaleConfig = $this->createMock(GlobalScaleConfig::class);
 		$this->logger = $this->createMock(LoggerInterface::class);
 		$this->clientService = $this->createMock(IClientService::class);
 		$cloudId = $this->createMock(ICloudId::class);
@@ -72,7 +71,8 @@ protected function setUp(): void {
 			$this->userSession,
 			$this->cloudIdManager,
 			$this->logger,
-			null
+			null,
+			$this->globalScaleConfig,
 		);
 	}
 
@@ -81,13 +81,16 @@ public function testSearchNoLookupServerURI(): void {
 			->method('getAppValue')
 			->with('files_sharing', 'lookupServerEnabled', 'no')
 			->willReturn('yes');
-		$this->config->expects($this->exactly(2))
+		$this->config->expects($this->once())
 			->method('getSystemValueBool')
 			->willReturnMap([
-				['gs.enabled', false, true],
 				['has_internet_connection', true, true],
 			]);
 
+		$this->globalScaleConfig->expects($this->once())
+			->method('isGlobalScaleEnabled')
+			->willReturn(true);
+
 		$this->config->expects($this->once())
 			->method('getSystemValueString')
 			->with('lookup_server', 'https://lookup.nextcloud.com')
@@ -107,13 +110,16 @@ public function testSearchNoInternet(): void {
 			->method('getAppValue')
 			->with('files_sharing', 'lookupServerEnabled', 'no')
 			->willReturn('yes');
-		$this->config->expects($this->exactly(2))
+		$this->config->expects($this->exactly(1))
 			->method('getSystemValueBool')
 			->willReturnMap([
-				['gs.enabled', false, false],
 				['has_internet_connection', true, false],
 			]);
 
+		$this->globalScaleConfig->expects($this->exactly(1))
+			->method('isGlobalScaleEnabled')
+			->willReturn(false);
+
 		$this->clientService->expects($this->never())
 			->method('newClient');
 
@@ -140,13 +146,16 @@ public function testSearch(array $searchParams): void {
 			->method('getAppValue')
 			->with('files_sharing', 'lookupServerEnabled', 'no')
 			->willReturn('yes');
-		$this->config->expects($this->exactly(2))
+		$this->config->expects($this->once())
 			->method('getSystemValueBool')
 			->willReturnMap([
-				['gs.enabled', false, true],
 				['has_internet_connection', true, true],
 			]);
 
+		$this->globalScaleConfig->expects($this->once())
+			->method('isGlobalScaleEnabled')
+			->willReturn(true);
+
 		$this->config->expects($this->once())
 			->method('getSystemValueString')
 			->with('lookup_server', 'https://lookup.nextcloud.com')
@@ -202,12 +211,15 @@ public function testSearchEnableDisableLookupServer(array $searchParams, $GSEnab
 				->method('addResultSet')
 				->with($type, $searchParams['expectedResult'], []);
 
-			$this->config->expects($this->exactly(2))
+			$this->config->expects($this->once())
 				->method('getSystemValueBool')
 				->willReturnMap([
-					['gs.enabled', false, $GSEnabled],
 					['has_internet_connection', true, true],
 				]);
+
+			$this->globalScaleConfig->expects($this->once())
+				->method('isGlobalScaleEnabled')
+				->willReturn($GSEnabled);
 			$this->config->expects($this->once())
 				->method('getSystemValueString')
 				->with('lookup_server', 'https://lookup.nextcloud.com')
@@ -232,12 +244,15 @@ public function testSearchEnableDisableLookupServer(array $searchParams, $GSEnab
 				->willReturn($client);
 		} else {
 			$searchResult->expects($this->never())->method('addResultSet');
-			$this->config->expects($this->exactly(2))
+			$this->config->expects($this->once())
 				->method('getSystemValueBool')
 				->willReturnMap([
-					['gs.enabled', false, $GSEnabled],
 					['has_internet_connection', true, true],
 				]);
+
+			$this->globalScaleConfig->expects($this->once())
+				->method('isGlobalScaleEnabled')
+				->willReturn($GSEnabled);
 		}
 		$moreResults = $this->plugin->search(
 			$searchParams['search'],
@@ -251,13 +266,16 @@ public function testSearchEnableDisableLookupServer(array $searchParams, $GSEnab
 
 
 	public function testSearchGSDisabled(): void {
-		$this->config->expects($this->atLeastOnce())
+		$this->config->expects($this->once())
 			->method('getSystemValueBool')
 			->willReturnMap([
 				['has_internet_connection', true, true],
-				['gs.enabled', false, false],
 			]);
 
+		$this->globalScaleConfig->expects($this->once())
+			->method('isGlobalScaleEnabled')
+			->willReturn(false);
+
 		/** @var ISearchResult|MockObject $searchResult */
 		$searchResult = $this->createMock(ISearchResult::class);
 		$searchResult->expects($this->never())