Merge pull request #1431 from nextcloud/carl/modern-event

Improve psalm for DAV

Author: marcelklehr

composer.json

@@ -13,11 +13,6 @@
             "OCA\\Recognize\\": "lib/"
         }
     },
-    "require-dev": {
-        "nextcloud/ocp": "dev-master",
-        "symfony/console": "^6.4",
-        "symfony/process": "^6.4"
-    },
     "scripts": {
         "lint": "find . -name \\*.php -not -path './vendor/*' -print0 | xargs -0 -n1 php -l",
         "cs:check": "php-cs-fixer fix --dry-run --diff",

lib/AppInfo/Application.php

@@ -8,6 +8,7 @@
 namespace OCA\Recognize\AppInfo;
 
 use OCA\DAV\Connector\Sabre\Principal;
+use OCA\DAV\Events\SabrePluginAddEvent;
 use OCA\Recognize\Dav\Faces\PropFindPlugin;
 use OCA\Recognize\Hooks\FileListener;
 use OCP\AppFramework\App;
@@ -22,7 +23,6 @@
 use OCP\Files\Events\Node\NodeDeletedEvent;
 use OCP\Files\Events\Node\NodeRenamedEvent;
 use OCP\Files\Events\NodeRemovedFromCache;
-use OCP\SabrePluginEvent;
 
 final class Application extends App implements IBootstrap {
 	public const APP_ID = 'recognize';
@@ -60,15 +60,13 @@ public function register(IRegistrationContext $context): void {
 	 */
 	public function boot(IBootContext $context): void {
 		$eventDispatcher = \OCP\Server::get(IEventDispatcher::class);
-		$eventDispatcher->addListener('OCA\DAV\Connector\Sabre::addPlugin', function (SabrePluginEvent $event): void {
+		$eventDispatcher->addListener(SabrePluginAddEvent::class, function (SabrePluginAddEvent $event): void {
 			$server = $event->getServer();
 
-			if ($server !== null) {
-				// We have to register the PropFindPlugin here and not info.xml,
-				// because info.xml plugins are loaded, after the
-				// beforeMethod:* hook has already been emitted.
-				$server->addPlugin($this->getContainer()->get(PropFindPlugin::class));
-			}
+			// We have to register the PropFindPlugin here and not info.xml,
+			// because info.xml plugins are loaded, after the
+			// beforeMethod:* hook has already been emitted.
+			$server->addPlugin($this->getContainer()->get(PropFindPlugin::class));
 		});
 	}
 }

lib/BackgroundJobs/ClassifierJob.php

@@ -7,6 +7,7 @@
 declare(strict_types=1);
 namespace OCA\Recognize\BackgroundJobs;
 
+use OCA\Recognize\Db\QueueFile;
 use OCA\Recognize\Service\QueueService;
 use OCA\Recognize\Service\SettingsService;
 use OCP\AppFramework\Utility\ITimeFactory;
@@ -33,16 +34,16 @@ public function __construct(
 		$this->setAllowParallelRuns($settingsService->getSetting('concurrency.enabled') === 'true');
 	}
 
+	/**
+	 * @param array{storageId: int, rootId: int} $argument
+	 */
 	protected function runClassifier(string $model, array $argument): void {
 		sleep(10);
 		if ($this->settingsService->getSetting('concurrency.enabled') !== 'true' && $this->anyOtherClassifierJobsRunning()) {
 			$this->logger->debug('Stalling job '.static::class.' with argument ' . var_export($argument, true) . ' because other classifiers are already reserved');
 			return;
 		}
 
-		/**
-		 * @var int $storageId
-		 */
 		$storageId = $argument['storageId'];
 		$rootId = $argument['rootId'];
 		if ($this->settingsService->getSetting($model.'.enabled') !== 'true') {
@@ -100,22 +101,15 @@ protected function runClassifier(string $model, array $argument): void {
 		}
 	}
 
-	/**
-	 * @return int
-	 */
 	abstract protected function getBatchSize(): int;
 
 	/**
-	 * @param list<OCA\Recognize\Db\QueueFile> $files
-	 * @return void
+	 * @param list<QueueFile> $files
 	 * @throws \RuntimeException|\ErrorException
 	 */
 	abstract protected function classify(array $files) : void;
 
-	/**
-	 * @return bool
-	 */
-	private function anyOtherClassifierJobsRunning() {
+	private function anyOtherClassifierJobsRunning(): bool {
 		foreach ([
 			ClassifyFacesJob::class,
 			ClassifyImagenetJob::class,

lib/BackgroundJobs/ClassifyFacesJob.php

@@ -28,7 +28,7 @@ public function __construct(ITimeFactory $time, Logger $logger, QueueService $qu
 	}
 
 	/**
-	 * @inheritDoc
+	 * @param array{storageId: int, rootId: int} $argument
 	 */
 	protected function run($argument): void {
 		$this->runClassifier(self::MODEL_NAME, $argument);

lib/BackgroundJobs/ClassifyImagenetJob.php

@@ -28,7 +28,7 @@ public function __construct(ITimeFactory $time, Logger $logger, QueueService $qu
 	}
 
 	/**
-	 * @inheritDoc
+	 * @param array{storageId: int, rootId: int} $argument
 	 */
 	protected function run($argument): void {
 		$this->runClassifier(self::MODEL_NAME, $argument);

lib/BackgroundJobs/ClassifyLandmarksJob.php

@@ -8,6 +8,7 @@
 namespace OCA\Recognize\BackgroundJobs;
 
 use OCA\Recognize\Classifiers\Images\LandmarksClassifier;
+use OCA\Recognize\Db\QueueFile;
 use OCA\Recognize\Service\Logger;
 use OCA\Recognize\Service\QueueService;
 use OCA\Recognize\Service\SettingsService;
@@ -28,14 +29,14 @@ public function __construct(ITimeFactory $time, Logger $logger, QueueService $qu
 	}
 
 	/**
-	 * @inheritDoc
+	 * @param array{storageId: int, rootId: int} $argument
 	 */
 	protected function run($argument): void {
 		$this->runClassifier(self::MODEL_NAME, $argument);
 	}
 
 	/**
-	 * @param list<\OCA\Recognize\Db\QueueFile> $files
+	 * @param list<QueueFile> $files
 	 * @return void
 	 */
 	protected function classify(array $files) : void {

lib/BackgroundJobs/ClassifyMovinetJob.php

@@ -28,9 +28,9 @@ public function __construct(ITimeFactory $time, Logger $logger, QueueService $qu
 	}
 
 	/**
-	 * @inheritDoc
+	 * @param array{storageId: int, rootId: int} $argument
 	 */
-	protected function run($argument):void {
+	protected function run($argument): void {
 		$this->runClassifier(self::MODEL_NAME, $argument);
 	}
 

lib/BackgroundJobs/ClassifyMusicnnJob.php

@@ -28,11 +28,9 @@ public function __construct(ITimeFactory $time, Logger $logger, QueueService $qu
 	}
 
 	/**
-	 * @inheritDoc
-	 *
-	 * @return void
+	 * @param array{storageId: int, rootId: int} $argument
 	 */
-	protected function run($argument) {
+	protected function run($argument): void {
 		$this->runClassifier(self::MODEL_NAME, $argument);
 	}
 

lib/BackgroundJobs/ClusterFacesJob.php

@@ -31,12 +31,10 @@ public function __construct(ITimeFactory $time, Logger $logger, IJobList $jobLis
 	}
 
 	/**
-	 * @inheritDoc
-	 *
-	 * @return void
+	 * @param array{storageId: int, rootId: int, userId: string} $argument
 	 */
-	protected function run($argument) {
-		$userId = (string) $argument['userId'];
+	protected function run($argument): void {
+		$userId = $argument['userId'];
 		try {
 			$this->clusterAnalyzer->calculateClusters($userId, self::BATCH_SIZE);
 		} catch (\Throwable $e) {

lib/BackgroundJobs/MaintenanceJob.php

@@ -28,10 +28,9 @@ public function __construct(
 	}
 
 	/**
-	 * @param mixed $argument
-	 * @return void
+	 * @param array{storageId: int, rootId: int} $argument
 	 */
-	protected function run($argument) {
+	protected function run($argument): void {
 		// Trigger clustering in case it's stuck
 		try {
 			$users = $this->faceDetectionMapper->getUsersForUnclustered();