Upgrade project to PHP 8.3, add PHPStan, upgrade almost every dependency (#36)

* start updating to PHP 8.3 * taking off! Co-authored-by: ErickSkrauch <erickskrauch@yandex.ru> Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * dropped this Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * migrate to symfonymailer Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * this is so stupid 😭 Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * ah, free, at last. Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * oh, Gabriel. Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * now dawns thy reckoning. Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * and thy gore shall GLISTEN before the temples of man. Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * creature of steel. Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * my gratitude upon thee for my freedom. Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * but the crimes thy kind has committed against humanity Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * Upgrade PHP-CS-Fixer and do fix the codebase * First review round (maybe I have broken something) * are NOT forgotten. Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> * Enable parallel PHP-CS-Fixer runner * PHPStan level 1 * PHPStan level 2 * PHPStan level 3 * PHPStan level 4 * PHPStan level 5 * Levels 6 and 7 takes too much effort. Generate a baseline and fix them eventually * Resolve TODO's related to the php-mock * Drastically reduce baseline size with the Rector * More code modernization with help of the Rector * Update GitLab CI --------- Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> Co-authored-by: ErickSkrauch <erickskrauch@yandex.ru>
2025-05-31 14:11:46 +05:30 · 2024-12-02 15:10:55 +05:00
parent 625250b367
commit 57d492da8a
356 changed files with 10531 additions and 4761 deletions
--- a/api/models/FeedbackForm.php
+++ b/api/models/FeedbackForm.php
@@ -12,13 +12,13 @@ use yii\base\InvalidConfigException;

 class FeedbackForm extends ApiForm {

-    public $subject;
+    public mixed $subject = null;

-    public $email;
+    public mixed $email = null;

-    public $type;
+    public mixed $type = null;

-    public $message;
+    public mixed $message = null;

    public function rules(): array {
        return [
@@ -31,27 +31,30 @@ class FeedbackForm extends ApiForm {
        ];
    }

+    /**
+     * @throws InvalidConfigException
+     */
    public function sendMessage(): bool {
        if (!$this->validate()) {
            return false;
        }

-        /** @var \yii\swiftmailer\Mailer $mailer */
+        /** @var \yii\symfonymailer\Mailer $mailer */
        $mailer = Yii::$app->mailer;
        $supportEmail = Yii::$app->params['supportEmail'];
        if (!$supportEmail) {
-            throw new InvalidConfigException('Please specify supportEmail value in app params');
+            throw new InvalidConfigException('Please specify supportEmail value in the app params');
        }

        $account = $this->getAccount();
-        /** @var \yii\swiftmailer\Message $message */
+        /** @var \yii\symfonymailer\Message $message */
        $message = $mailer->compose('@common/emails/views/feedback', [
            'model' => $this,
            'account' => $account,
        ]);
        $message
            ->setTo($supportEmail)
-            ->setFrom([$this->email => $account ? $account->username : $this->email])
+            ->setFrom([$this->email => $account?->username ?? $this->email])
            ->setSubject($this->subject);

        Assert::true($message->send(), 'Unable send feedback email.');
--- a/api/models/authentication/AuthenticationResult.php
+++ b/api/models/authentication/AuthenticationResult.php
@@ -3,26 +3,18 @@ declare(strict_types=1);

 namespace api\models\authentication;

-use Lcobucci\JWT\Token;
+use DateTimeImmutable;
+use Lcobucci\JWT\UnencryptedToken;

-class AuthenticationResult {
+final readonly class AuthenticationResult {

-    /**
-     * @var Token
-     */
-    private $token;
-
-    /**
-     * @var string|null
-     */
-    private $refreshToken;
-
-    public function __construct(Token $token, string $refreshToken = null) {
-        $this->token = $token;
-        $this->refreshToken = $refreshToken;
+    public function __construct(
+        private UnencryptedToken $token,
+        private ?string $refreshToken = null,
+    ) {
    }

-    public function getToken(): Token {
+    public function getToken(): UnencryptedToken {
        return $this->token;
    }

@@ -31,9 +23,11 @@ class AuthenticationResult {
    }

    public function formatAsOAuth2Response(): array {
+        /** @var DateTimeImmutable $expiresAt */
+        $expiresAt = $this->token->claims()->get('exp');
        $response = [
-            'access_token' => (string)$this->token,
-            'expires_in' => $this->token->getClaim('exp') - time(),
+            'access_token' => $this->token->toString(),
+            'expires_in' => $expiresAt->getTimestamp() - (new DateTimeImmutable())->getTimestamp(),
        ];

        $refreshToken = $this->refreshToken;
--- a/api/models/authentication/ForgotPasswordForm.php
+++ b/api/models/authentication/ForgotPasswordForm.php
@@ -16,9 +16,9 @@ use yii\base\ErrorException;

 class ForgotPasswordForm extends ApiForm {

-    public $captcha;
+    public mixed $captcha = null;

-    public $login;
+    public mixed $login = null;

    public function rules(): array {
        return [
@@ -90,6 +90,7 @@ class ForgotPasswordForm extends ApiForm {
            return null;
        }

+        // @phpstan-ignore return.type
        return $account->getEmailActivations()->withType(EmailActivation::TYPE_FORGOT_PASSWORD_KEY)->one();
    }

--- a/api/models/authentication/LoginForm.php
+++ b/api/models/authentication/LoginForm.php
@@ -13,39 +13,23 @@ use Yii;

 class LoginForm extends ApiForm {

-    /**
-     * @var string
-     */
-    public $login;
+    public mixed $login = null;

-    /**
-     * @var string
-     */
-    public $password;
+    public mixed $password = null;

-    /**
-     * @var string|null
-     */
-    public $totp;
+    public mixed $totp = null;

-    /**
-     * @var bool
-     */
-    public $rememberMe = false;
+    public mixed $rememberMe = false;

    public function rules(): array {
        return [
            ['login', 'required', 'message' => E::LOGIN_REQUIRED],
            ['login', 'validateLogin'],

-            ['password', 'required', 'when' => function(self $model): bool {
-                return !$model->hasErrors();
-            }, 'message' => E::PASSWORD_REQUIRED],
+            ['password', 'required', 'when' => fn(self $model): bool => !$model->hasErrors(), 'message' => E::PASSWORD_REQUIRED],
            ['password', 'validatePassword'],

-            ['totp', 'required', 'when' => function(self $model): bool {
-                return !$model->hasErrors() && $model->getAccount()->is_otp_enabled;
-            }, 'message' => E::TOTP_REQUIRED],
+            ['totp', 'required', 'when' => fn(self $model): bool => !$model->hasErrors() && $model->getAccount()->is_otp_enabled, 'message' => E::TOTP_REQUIRED],
            ['totp', 'validateTotp'],

            ['login', 'validateActivity'],
@@ -81,7 +65,6 @@ class LoginForm extends ApiForm {
        }

        $validator = new TotpValidator(['account' => $account]);
-        $validator->window = 1;
        $validator->validateAttribute($this, $attribute);
    }

@@ -99,6 +82,7 @@ class LoginForm extends ApiForm {
        }
    }

+    /** @noinspection PhpIncompatibleReturnTypeInspection */
    public function getAccount(): ?Account {
        return Account::find()->andWhereLogin($this->login)->one();
    }
@@ -130,7 +114,7 @@ class LoginForm extends ApiForm {

        $transaction->commit();

-        return new AuthenticationResult($token, $session ? $session->refresh_token : null);
+        return new AuthenticationResult($token, $session?->refresh_token);
    }

 }
--- a/api/models/authentication/RegistrationForm.php
+++ b/api/models/authentication/RegistrationForm.php
@@ -54,7 +54,7 @@ class RegistrationForm extends ApiForm {
        ];
    }

-    public function validatePasswordAndRePasswordMatch($attribute) {
+    public function validatePasswordAndRePasswordMatch($attribute): void {
        if (!$this->hasErrors()) {
            if ($this->password !== $this->rePassword) {
                $this->addError($attribute, E::RE_PASSWORD_DOES_NOT_MATCH);
@@ -64,7 +64,7 @@ class RegistrationForm extends ApiForm {

    public function signup() {
        if (!$this->validate() && !$this->canContinue($this->getFirstErrors())) {
-            return null;
+            return;
        }

        $transaction = Yii::$app->db->beginTransaction();
--- a/api/models/authentication/RepeatAccountActivationForm.php
+++ b/api/models/authentication/RepeatAccountActivationForm.php
@@ -16,11 +16,9 @@ use Yii;

 class RepeatAccountActivationForm extends ApiForm {

-    public $captcha;
+    public mixed $captcha = null;

-    public $email;
-
-    private $emailActivation;
+    public mixed $email = null;

    public function rules(): array {
        return [
@@ -74,8 +72,6 @@ class RepeatAccountActivationForm extends ApiForm {
        $activation->key = UserFriendlyRandomKey::make();
        Assert::true($activation->save(), 'Unable save email-activation model.');

-        $this->emailActivation = $activation;
-
        Yii::$app->queue->push(SendRegistrationEmail::createFromConfirmation($activation));

        $transaction->commit();
@@ -90,6 +86,7 @@ class RepeatAccountActivationForm extends ApiForm {
    }

    public function getActivation(): ?RegistrationConfirmation {
+        // @phpstan-ignore return.type
        return $this->getAccount()
            ->getEmailActivations()
            ->withType(EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION)
--- a/api/models/base/BaseAccountForm.php
+++ b/api/models/base/BaseAccountForm.php
@@ -7,11 +7,11 @@ use common\models\Account;

 class BaseAccountForm extends ApiForm {

-    private Account $account;
-
-    public function __construct(Account $account, array $config = []) {
+    public function __construct(
+        private readonly Account $account,
+        array $config = [],
+    ) {
        parent::__construct($config);
-        $this->account = $account;
    }

    public function getAccount(): Account {