Merge pull request #2068 from nextcloud/ci/noid/rector

CI: Add rector and update phpunit to 10

.gitignore

@@ -60,6 +60,7 @@ nbproject
 /tests/Unit/coverage*
 /tests/Unit/clover.xml
 /tests/Unit/js/node_modules
+/tests/Unit/.phpunit.cache
 /tests/Unit/.phpunit.result.cache
 /.php-cs-fixer.cache
 

composer.json

@@ -40,6 +40,8 @@
 		"psalm:update-baseline": "psalm --threads=1 --update-baseline",
 		"psalm:clear": "psalm --clear-cache && psalm --clear-global-cache",
 		"psalm:fix": "psalm --alter --issues=InvalidReturnType,InvalidNullableReturnType,MissingParamType,InvalidFalsableReturnType",
+		"rector:check": "rector --dry-run --clear-cache",
+		"rector:fix": "rector",
 		"test:unit": "phpunit --color -c tests/Unit/phpunit.xml",
 		"test:integration": "cd tests/Integration && ./run.sh"
 	}

lib/BackgroundJob/GenerateUserSettings.php

@@ -18,25 +18,14 @@
 use OCP\IUserManager;
 
 class GenerateUserSettings extends TimedJob {
-	/** @var IDBConnection */
-	private $connection;
-	/** @var IUserManager */
-	private $userManager;
-	/** @var SettingsMapper */
-	private $settingsMapper;
-
 	public function __construct(
 		ITimeFactory $time,
-		IDBConnection $connection,
-		IUserManager $userManager,
-		SettingsMapper $settingsMapper,
+		private IDBConnection $connection,
+		private IUserManager $userManager,
+		private SettingsMapper $settingsMapper,
 	) {
 		parent::__construct($time);
 
-		$this->connection = $connection;
-		$this->userManager = $userManager;
-		$this->settingsMapper = $settingsMapper;
-
 		// run every day
 		$this->setInterval(24 * 60 * 60);
 	}
@@ -52,14 +41,14 @@ protected function run($argument): void {
 		$maxId = (int)$result->fetchOne();
 		$result->closeCursor();
 
-		$this->userManager->callForSeenUsers(function (IUser $user) use ($maxId) {
+		$this->userManager->callForSeenUsers(function (IUser $user) use ($maxId): void {
 			if ($user->isEnabled()) {
 				return;
 			}
 
 			try {
 				$this->settingsMapper->getSettingsByUser($user->getUID());
-			} catch (DoesNotExistException $e) {
+			} catch (DoesNotExistException) {
 				$settings = new Settings();
 				$settings->setUserId($user->getUID());
 				$settings->setNextSendTime(1);

lib/BackgroundJob/SendNotificationMails.php

@@ -13,18 +13,12 @@
 use OCP\BackgroundJob\TimedJob;
 
 class SendNotificationMails extends TimedJob {
-	/** @var MailNotifications */
-	protected $mailNotifications;
-	/** @var bool */
-	protected $isCLI;
-
-	public function __construct(ITimeFactory $timeFactory,
-		MailNotifications $mailNotifications,
-		bool $isCLI) {
+	public function __construct(
+		ITimeFactory $timeFactory,
+		private MailNotifications $mailNotifications,
+		private bool $isCLI,
+	) {
 		parent::__construct($timeFactory);
-
-		$this->mailNotifications = $mailNotifications;
-		$this->isCLI = $isCLI;
 	}
 
 	protected function run($argument): void {

lib/Command/Generate.php

@@ -186,7 +186,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			}
 
 			$this->notificationManager->notify($notification);
-		} catch (\InvalidArgumentException $e) {
+		} catch (\InvalidArgumentException) {
 			$output->writeln('Error while sending the notification');
 			return 1;
 		}

lib/Command/TestPush.php

@@ -21,26 +21,13 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class TestPush extends Command {
-	/** @var ITimeFactory */
-	protected $timeFactory;
-	/** @var IUserManager */
-	protected $userManager;
-	/** @var IManager */
-	protected $notificationManager;
-	/** @var App */
-	protected $app;
-
 	public function __construct(
-		ITimeFactory $timeFactory,
-		IUserManager $userManager,
-		IManager $notificationManager,
-		App $app) {
+		protected ITimeFactory $timeFactory,
+		protected IUserManager $userManager,
+		protected IManager $notificationManager,
+		protected App $app,
+	) {
 		parent::__construct();
-
-		$this->timeFactory = $timeFactory;
-		$this->userManager = $userManager;
-		$this->notificationManager = $notificationManager;
-		$this->app = $app;
 	}
 
 	protected function configure(): void {
@@ -96,7 +83,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
 			$this->app->setOutput($output);
 			$this->notificationManager->notify($notification);
-		} catch (\InvalidArgumentException $e) {
+		} catch (\InvalidArgumentException) {
 			$output->writeln('Error while sending the notification');
 			return 1;
 		}

lib/Controller/EndpointController.php

@@ -145,7 +145,7 @@ public function getNotification(string $apiVersion, int $id): DataResponse {
 
 		try {
 			$notification = $this->handler->getById($id, $this->getCurrentUser());
-		} catch (NotificationNotFoundException $e) {
+		} catch (NotificationNotFoundException) {
 			return new DataResponse(null, Http::STATUS_NOT_FOUND);
 		}
 
@@ -231,7 +231,7 @@ public function deleteNotification(int $id): DataResponse {
 			if ($deleted) {
 				$this->push->pushDeleteToDevice($this->getCurrentUser(), [$id], $notification->getApp());
 			}
-		} catch (NotificationNotFoundException $e) {
+		} catch (NotificationNotFoundException) {
 		}
 
 		return new DataResponse();

lib/Controller/PushController.php

@@ -70,7 +70,7 @@ public function registerDevice(string $pushTokenHash, string $devicePublicKey, s
 		}
 
 		if (
-			strpos($devicePublicKey, '-----BEGIN PUBLIC KEY-----' . "\n") !== 0 ||
+			!str_starts_with($devicePublicKey, '-----BEGIN PUBLIC KEY-----' . "\n") ||
 			((\strlen($devicePublicKey) !== 450 || strpos($devicePublicKey, "\n" . '-----END PUBLIC KEY-----') !== 425) &&
 				(\strlen($devicePublicKey) !== 451 || strpos($devicePublicKey, "\n" . '-----END PUBLIC KEY-----' . "\n") !== 425))
 		) {
@@ -91,7 +91,7 @@ public function registerDevice(string $pushTokenHash, string $devicePublicKey, s
 		}
 		try {
 			$token = $this->tokenProvider->getTokenById($tokenId);
-		} catch (InvalidTokenException $e) {
+		} catch (InvalidTokenException) {
 			return new DataResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST);
 		}
 
@@ -149,7 +149,7 @@ public function removeDevice(): DataResponse {
 		$tokenId = (int)$this->session->get('token-id');
 		try {
 			$token = $this->tokenProvider->getTokenById($tokenId);
-		} catch (InvalidTokenException $e) {
+		} catch (InvalidTokenException) {
 			return new DataResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST);
 		}
 

lib/FakeUser.php

@@ -11,10 +11,9 @@
 use OCP\IUser;
 
 class FakeUser implements IUser {
-	protected string $userId;
-
-	public function __construct(string $userId) {
-		$this->userId = $userId;
+	public function __construct(
+		protected string $userId,
+	) {
 	}
 
 	public function getUID(): string {

lib/Handler.php

@@ -18,23 +18,14 @@
 use OCP\Notification\INotification;
 
 class Handler {
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var IManager */
-	protected $manager;
-
-	public function __construct(IDBConnection $connection,
-		IManager $manager) {
-		$this->connection = $connection;
-		$this->manager = $manager;
+	public function __construct(
+		protected IDBConnection $connection,
+		protected IManager $manager,
+	) {
 	}
 
 	/**
 	 * Add a new notification to the database
-	 *
-	 * @param INotification $notification
-	 * @return int
 	 */
 	public function add(INotification $notification): int {
 		$sql = $this->connection->getQueryBuilder();
@@ -47,9 +38,6 @@ public function add(INotification $notification): int {
 
 	/**
 	 * Count the notifications matching the given Notification
-	 *
-	 * @param INotification $notification
-	 * @return int
 	 */
 	public function count(INotification $notification): int {
 		$sql = $this->connection->getQueryBuilder();
@@ -68,7 +56,6 @@ public function count(INotification $notification): int {
 	/**
 	 * Delete the notifications matching the given Notification
 	 *
-	 * @param INotification $notification
 	 * @return array A Map with all deleted notifications [user => [notifications]]
 	 */
 	public function delete(INotification $notification): array {
@@ -125,15 +112,12 @@ public function delete(INotification $notification): array {
 
 	/**
 	 * Delete the notification of a given user
-	 *
-	 * @param string $user
-	 * @return bool
 	 */
 	public function deleteByUser(string $user): bool {
 		$notification = $this->manager->createNotification();
 		try {
 			$notification->setUser($user);
-		} catch (\InvalidArgumentException $e) {
+		} catch (\InvalidArgumentException) {
 			return false;
 		}
 		return !empty($this->delete($notification));
@@ -142,10 +126,6 @@ public function deleteByUser(string $user): bool {
 	/**
 	 * Delete the notification matching the given id
 	 *
-	 * @param int $id
-	 * @param string $user
-	 * @param INotification|null $notification
-	 * @return bool
 	 * @throws NotificationNotFoundException
 	 */
 	public function deleteById(int $id, string $user, ?INotification $notification = null): bool {
@@ -177,9 +157,6 @@ public function deleteIds(array $ids): void {
 	/**
 	 * Get the notification matching the given id
 	 *
-	 * @param int $id
-	 * @param string $user
-	 * @return INotification
 	 * @throws NotificationNotFoundException
 	 */
 	public function getById(int $id, string $user): INotification {
@@ -198,15 +175,14 @@ public function getById(int $id, string $user): INotification {
 
 		try {
 			return $this->notificationFromRow($row);
-		} catch (\InvalidArgumentException $e) {
+		} catch (\InvalidArgumentException) {
 			throw new NotificationNotFoundException('Could not create notification from database row');
 		}
 	}
 
 	/**
 	 * Confirm that the notification ids still exist for the user
 	 *
-	 * @param string $user
 	 * @param int[] $ids
 	 * @return int[]
 	 */
@@ -230,9 +206,6 @@ public function confirmIdsForUser(string $user, array $ids): array {
 	/**
 	 * Get the notifications after (and excluding) the given id
 	 *
-	 * @param int $startAfterId
-	 * @param string $userId
-	 * @param int $limit
 	 * @return array<int, INotification> [notification_id => INotification]
 	 */
 	public function getAfterId(int $startAfterId, string $userId, int $limit = 25): array {
@@ -249,7 +222,7 @@ public function getAfterId(int $startAfterId, string $userId, int $limit = 25):
 		while ($row = $statement->fetch()) {
 			try {
 				$notifications[(int)$row['notification_id']] = $this->notificationFromRow($row);
-			} catch (\InvalidArgumentException $e) {
+			} catch (\InvalidArgumentException) {
 				continue;
 			}
 		}
@@ -261,11 +234,9 @@ public function getAfterId(int $startAfterId, string $userId, int $limit = 25):
 	/**
 	 * Return the notifications matching the given Notification
 	 *
-	 * @param INotification $notification
-	 * @param int $limit
 	 * @return array [notification_id => INotification]
 	 */
-	public function get(INotification $notification, $limit = 25): array {
+	public function get(INotification $notification, int $limit = 25): array {
 		$sql = $this->connection->getQueryBuilder();
 		$sql->select('*')
 			->from('notifications')
@@ -279,7 +250,7 @@ public function get(INotification $notification, $limit = 25): array {
 		while ($row = $statement->fetch()) {
 			try {
 				$notifications[(int)$row['notification_id']] = $this->notificationFromRow($row);
-			} catch (\InvalidArgumentException $e) {
+			} catch (\InvalidArgumentException) {
 				continue;
 			}
 		}
@@ -290,9 +261,6 @@ public function get(INotification $notification, $limit = 25): array {
 
 	/**
 	 * Add where statements to a query builder matching the given notification
-	 *
-	 * @param IQueryBuilder $sql
-	 * @param INotification $notification
 	 */
 	protected function sqlWhere(IQueryBuilder $sql, INotification $notification) {
 		if ($notification->getApp() !== '') {
@@ -327,9 +295,6 @@ protected function sqlWhere(IQueryBuilder $sql, INotification $notification) {
 
 	/**
 	 * Turn a notification into an input statement
-	 *
-	 * @param IQueryBuilder $sql
-	 * @param INotification $notification
 	 */
 	protected function sqlInsert(IQueryBuilder $sql, INotification $notification) {
 		$actions = [];
@@ -359,9 +324,6 @@ protected function sqlInsert(IQueryBuilder $sql, INotification $notification) {
 
 	/**
 	 * Turn a database row into a INotification
-	 *
-	 * @param array $row
-	 * @return INotification
 	 * @throws \InvalidArgumentException
 	 */
 	protected function notificationFromRow(array $row): INotification {

lib/Listener/BeforeTemplateRenderedListener.php

@@ -25,19 +25,12 @@
  * @template-implements IEventListener<Event|BeforeTemplateRenderedEvent>
  */
 class BeforeTemplateRenderedListener implements IEventListener {
-	protected IConfig $config;
-	protected IUserSession $userSession;
-	protected IInitialState $initialState;
-	protected IManager $notificationManager;
-
-	public function __construct(IConfig $config,
-		IUserSession $userSession,
-		IInitialState $initialState,
-		IManager $notificationManager) {
-		$this->config = $config;
-		$this->userSession = $userSession;
-		$this->initialState = $initialState;
-		$this->notificationManager = $notificationManager;
+	public function __construct(
+		protected IConfig $config,
+		protected IUserSession $userSession,
+		protected IInitialState $initialState,
+		protected IManager $notificationManager,
+	) {
 	}
 
 	public function handle(Event $event): void {