refactor: Fix psalm issues

- Add typing for most of the services, controllers and mappers
- Add api doc for mappers
- Use vendor-bin for psalm
- Use attributes for controllers
- Fix upload of attachments

Signed-off-by: Carl Schwan <[email protected]>

Author: CarlSchwan

composer.json

@@ -9,31 +9,35 @@
 		}
 	],
 	"require": {
-		"justinrainbow/json-schema": "^6.0"
+		"justinrainbow/json-schema": "^6.0",
+		"bamarni/composer-bin-plugin": "^1.8"
 	},
 	"require-dev": {
 		"roave/security-advisories": "dev-master",
 		"phpunit/phpunit": "^9",
 		"nextcloud/coding-standard": "^1.1",
-		"nextcloud/ocp": "dev-master",
-		"psalm/phar": "^5.13"
+		"nextcloud/ocp": "dev-master"
 	},
 	"config": {
 		"optimize-autoloader": true,
 		"allow-plugins": {
-			"composer/package-versions-deprecated": true
+			"composer/package-versions-deprecated": true,
+			"bamarni/composer-bin-plugin": true
 		},
 		"platform": {
 			"php": "8.1"
 		}
 	},
 	"scripts": {
+		"post-install-cmd": [
+			"@composer bin all install --ansi"
+		],
 		"lint": "find . -name \\*.php -not -path './vendor/*' -print0 | xargs -0 -n1 php -l",
 		"cs:check": "php-cs-fixer fix --dry-run --diff",
 		"cs:fix": "php-cs-fixer fix",
-		"psalm": "psalm.phar",
-		"psalm:update-baseline": "psalm.phar --update-baseline",
-		"psalm:fix": "psalm.phar --alter --issues=InvalidReturnType,InvalidNullableReturnType,MismatchingDocblockParamType,MismatchingDocblockReturnType,MissingParamType,InvalidFalsableReturnType",
+		"psalm": "psalm",
+		"psalm:update-baseline": "psalm --threads=$(nproc) --no-cache --update-baseline",
+		"psalm:fix": "psalm --alter --issues=InvalidReturnType,InvalidNullableReturnType,MismatchingDocblockParamType,MismatchingDocblockReturnType,MissingParamType,InvalidFalsableReturnType",
 		"test": [
 			"@test:unit",
 			"@test:integration"

composer.lock

@@ -516,7 +516,7 @@ private function findDetailsForStack($stackId) {
 		];
 	}
 
-	private function findDetailsForCard($cardId, $subject = null) {
+	private function findDetailsForCard(int $cardId, ?string $subject = null): array {
 		$card = $this->cardMapper->find($cardId);
 		$stack = $this->stackMapper->find($card->getStackId());
 		$board = $this->boardMapper->find($stack->getBoardId());

lib/Activity/ActivityManager.php

@@ -7,6 +7,9 @@
 
 namespace OCA\Deck\Activity;
 
+/**
+ * @psalm-api SettingComment
+ */
 class SettingComment extends SettingBase {
 
 	/**

lib/Activity/SettingComment.php

@@ -6,9 +6,13 @@
  */
 namespace OCA\Deck\Controller;
 
+use OCA\Deck\Db\Attachment;
 use OCA\Deck\Service\AttachmentService;
 use OCP\AppFramework\ApiController;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\CORS;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\IRequest;
 
@@ -21,72 +25,52 @@ public function __construct(
 		parent::__construct($appName, $request);
 	}
 
-	/**
-	 * @NoAdminRequired
-	 * @CORS
-	 * @NoCSRFRequired
-	 *
-	 */
-	public function getAll($apiVersion) {
+	#[NoAdminRequired]
+	#[CORS]
+	#[NoCSRFRequired]
+	public function getAll(string $apiVersion): DataResponse {
 		$attachment = $this->attachmentService->findAll($this->request->getParam('cardId'), true);
 		if ($apiVersion === '1.0') {
-			$attachment = array_filter($attachment, function ($attachment) {
-				return $attachment->getType() === 'deck_file';
-			});
+			$attachment = array_filter($attachment, fn (Attachment $attachment): bool => $attachment->getType() === 'deck_file');
 		}
 		return new DataResponse($attachment, HTTP::STATUS_OK);
 	}
 
-	/**
-	 * @NoAdminRequired
-	 * @CORS
-	 * @NoCSRFRequired
-	 *
-	 */
-	public function display($cardId, $attachmentId, $type = 'deck_file') {
+	#[NoAdminRequired]
+	#[CORS]
+	#[NoCSRFRequired]
+	public function display(int $cardId, int $attachmentId, string $type = 'deck_file') {
 		return $this->attachmentService->display($cardId, $attachmentId, $type);
 	}
 
-	/**
-	 * @NoAdminRequired
-	 * @CORS
-	 * @NoCSRFRequired
-	 *
-	 */
-	public function create($cardId, $type, $data) {
+	#[NoAdminRequired]
+	#[CORS]
+	#[NoCSRFRequired]
+	public function create(int $cardId, string $type, string $data): DataResponse {
 		$attachment = $this->attachmentService->create($cardId, $type, $data);
 		return new DataResponse($attachment, HTTP::STATUS_OK);
 	}
 
-	/**
-	 * @NoAdminRequired
-	 * @CORS
-	 * @NoCSRFRequired
-	 *
-	 */
-	public function update($cardId, $attachmentId, $data, $type = 'deck_file') {
+	#[NoAdminRequired]
+	#[CORS]
+	#[NoCSRFRequired]
+	public function update(int $cardId, int $attachmentId, string $data, string $type = 'deck_file'): DataResponse {
 		$attachment = $this->attachmentService->update($cardId, $attachmentId, $data, $type);
 		return new DataResponse($attachment, HTTP::STATUS_OK);
 	}
 
-	/**
-	 * @NoAdminRequired
-	 * @CORS
-	 * @NoCSRFRequired
-	 *
-	 */
-	public function delete($cardId, $attachmentId, $type = 'deck_file') {
+	#[NoAdminRequired]
+	#[CORS]
+	#[NoCSRFRequired]
+	public function delete(int $cardId, int $attachmentId, string $type = 'deck_file'): DataResponse {
 		$attachment = $this->attachmentService->delete($cardId, $attachmentId, $type);
 		return new DataResponse($attachment, HTTP::STATUS_OK);
 	}
 
-	/**
-	 * @NoAdminRequired
-	 * @CORS
-	 * @NoCSRFRequired
-	 *
-	 */
-	public function restore($cardId, $attachmentId, $type = 'deck_file') {
+	#[NoAdminRequired]
+	#[CORS]
+	#[NoCSRFRequired]
+	public function restore(int $cardId, int $attachmentId, string $type = 'deck_file'): DataResponse {
 		$attachment = $this->attachmentService->restore($cardId, $attachmentId, $type);
 		return new DataResponse($attachment, HTTP::STATUS_OK);
 	}