Merge pull request #55396 from nextcloud/carl/dashboard-appconfig

refactor: Port dashboard app to IAppConfig

Author: come-nc

apps/dashboard/lib/Controller/DashboardApiController.php

@@ -17,6 +17,7 @@
 use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
+use OCP\AppFramework\Services\IAppConfig;
 use OCP\Dashboard\IAPIWidget;
 use OCP\Dashboard\IAPIWidgetV2;
 use OCP\Dashboard\IButtonWidget;
@@ -43,6 +44,7 @@ public function __construct(
 		string $appName,
 		IRequest $request,
 		private IManager $dashboardManager,
+		private IAppConfig $appConfig,
 		private IConfig $config,
 		private ?string $userId,
 		private DashboardService $service,
@@ -56,7 +58,7 @@ public function __construct(
 	 */
 	private function getShownWidgets(array $widgetIds): array {
 		if (empty($widgetIds)) {
-			$systemDefault = $this->config->getAppValue('dashboard', 'layout', 'recommendations,spreed,mail,calendar');
+			$systemDefault = $this->appConfig->getAppValueString('layout', 'recommendations,spreed,mail,calendar');
 			$widgetIds = explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault));
 		}
 

apps/dashboard/lib/Service/DashboardService.php

@@ -11,12 +11,14 @@
 use JsonException;
 use OCP\Accounts\IAccountManager;
 use OCP\Accounts\PropertyDoesNotExistException;
+use OCP\AppFramework\Services\IAppConfig;
 use OCP\IConfig;
 use OCP\IUserManager;
 
 class DashboardService {
 	public function __construct(
 		private IConfig $config,
+		private IAppConfig $appConfig,
 		private ?string $userId,
 		private IUserManager $userManager,
 		private IAccountManager $accountManager,
@@ -28,7 +30,7 @@ public function __construct(
 	 * @return list<string>
 	 */
 	public function getLayout(): array {
-		$systemDefault = $this->config->getAppValue('dashboard', 'layout', 'recommendations,spreed,mail,calendar');
+		$systemDefault = $this->appConfig->getAppValueString('layout', 'recommendations,spreed,mail,calendar');
 		return array_values(array_filter(explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault)), fn (string $value) => $value !== ''));
 	}
 

apps/dashboard/tests/DashboardServiceTest.php

@@ -12,6 +12,7 @@
 use OC\Accounts\Account;
 use OCA\Dashboard\Service\DashboardService;
 use OCP\Accounts\IAccountManager;
+use OCP\AppFramework\Services\IAppConfig;
 use OCP\IConfig;
 use OCP\IUser;
 use OCP\IUserManager;
@@ -21,6 +22,7 @@
 class DashboardServiceTest extends TestCase {
 
 	private IConfig&MockObject $config;
+	private IAppConfig&MockObject $appConfig;
 	private IUserManager&MockObject $userManager;
 	private IAccountManager&MockObject $accountManager;
 	private DashboardService $service;
@@ -29,11 +31,13 @@ protected function setUp(): void {
 		parent::setUp();
 
 		$this->config = $this->createMock(IConfig::class);
+		$this->appConfig = $this->createMock(IAppConfig::class);
 		$this->userManager = $this->createMock(IUserManager::class);
 		$this->accountManager = $this->createMock(IAccountManager::class);
 
 		$this->service = new DashboardService(
 			$this->config,
+			$this->appConfig,
 			'alice',
 			$this->userManager,
 			$this->accountManager,
@@ -87,6 +91,7 @@ public function testGetBirthdateUserNotFound(): void {
 	public function testGetBirthdateNoUserId(): void {
 		$service = new DashboardService(
 			$this->config,
+			$this->appConfig,
 			null,
 			$this->userManager,
 			$this->accountManager,

build/psalm-baseline.xml

@@ -113,16 +113,6 @@
       <code><![CDATA[$this->path]]></code>
     </DeprecatedProperty>
   </file>
-  <file src="apps/dashboard/lib/Controller/DashboardApiController.php">
-    <DeprecatedMethod>
-      <code><![CDATA[getAppValue]]></code>
-    </DeprecatedMethod>
-  </file>
-  <file src="apps/dashboard/lib/Service/DashboardService.php">
-    <DeprecatedMethod>
-      <code><![CDATA[getAppValue]]></code>
-    </DeprecatedMethod>
-  </file>
   <file src="apps/dav/appinfo/v1/caldav.php">
     <DeprecatedMethod>
       <code><![CDATA[exec]]></code>