chore: Merge branch 'master' into remove-multi-session

Author: SamMousa

.github/workflows/release.yml

@@ -62,9 +62,9 @@ jobs:
           -p "@semantic-release/release-notes-generator"
           -p conventional-changelog-conventionalcommits
           -p semantic-release
-          -- semantic-release
+          -- semantic-release --dry-run
         env:
-          GITHUB_TOKEN: ${{ secrets.COLLECTHOR_FINE_GRAINED_RELEASE }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 permissions:
   packages: write
   contents: write

composer.json

@@ -29,7 +29,6 @@
         "codeception/module-asserts": ">= 3.0",
         "codeception/module-filesystem": "> 3.0",
         "phpstan/phpstan": "^2",
-        "rector/rector": "^2",
         "symplify/easy-coding-standard": "^12.5"
     },
     "autoload":{

ecs.php

@@ -12,7 +12,7 @@
 use PhpCsFixer\Fixer\Phpdoc\NoBlankLinesAfterPhpdocFixer;
 use PhpCsFixer\Fixer\Phpdoc\NoEmptyPhpdocFixer;
 use PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer;
-use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocIndentFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
 
@@ -27,31 +27,33 @@
     ]);
 
     // A. full sets
-    $ecsConfig->sets([SetList::PSR_12, SetList::SPACES]);
+    $ecsConfig->sets([SetList::PSR_12, SetList::SPACES, SetList::STRICT, SetList::DOCBLOCK]);
 
     $ecsConfig->rule(NotOperatorWithSuccessorSpaceFixer::class);
     $ecsConfig->rule(ArraySyntaxFixer::class);
     $ecsConfig->ruleWithConfiguration(GeneralPhpdocAnnotationRemoveFixer::class, [
-        'annotations' => ['author', 'inheritdoc']
+        'annotations' => ['author', 'inheritdoc', 'package']
     ]);
     $ecsConfig->rule(NoBlankLinesAfterPhpdocFixer::class);
     $ecsConfig->ruleWithConfiguration(NoSuperfluousPhpdocTagsFixer::class, [
         'allow_mixed' => true
     ]);
     $ecsConfig->rule(NoEmptyPhpdocFixer::class);
     $ecsConfig->rule(NoUnusedImportsFixer::class);
-    $ecsConfig->rule(DeclareStrictTypesFixer::class);
     $ecsConfig->ruleWithConfiguration(FinalInternalClassFixer::class, [
         'annotation_exclude' => ['@not-fix', '@internal'],
         'annotation_include' => [],
-        'consider_absent_docblock_as_internal_class' => \true
+        'consider_absent_docblock_as_internal_class' => true
     ]);
     $ecsConfig->ruleWithConfiguration(ForbiddenFunctionsSniff::class, [
         'forbiddenFunctions' => [
             'passthru' => null,
             'var_dump' => null,
         ]
     ]);
+    $ecsConfig->rule(PhpdocIndentFixer::class);
+    $ecsConfig->rule(\PhpCsFixer\Fixer\Phpdoc\AlignMultilineCommentFixer::class);
+
     $ecsConfig->skip([
         ForbiddenFunctionsSniff::class => [
             'tests/**',

phpstan.neon

@@ -17,6 +17,9 @@ parameters:
     checkMaybeUndefinedVariables: true
     treatPhpDocTypesAsCertain: false
     ignoreErrors:
+        - identifier: return.type
+          path: tests/_support/_generated/FunctionalTesterActions.php
+          message: "# but returns mixed.$#"
         # If you want to ignore missing generics errors in the future, you can add:
         # - identifier: missingType.generics
     stubFiles:

src/Codeception/Lib/Connector/Yii2.php

@@ -17,21 +17,20 @@
 use Symfony\Component\BrowserKit\Request as BrowserkitRequest;
 use Symfony\Component\BrowserKit\Response;
 use Yii;
-use yii\base\Component;
 use yii\base\Event;
 use yii\base\ExitException;
 use yii\base\Security;
 use yii\base\UserException;
 use yii\mail\BaseMessage;
 use yii\web\Application;
 use yii\web\IdentityInterface;
-use yii\web\Request;
 use yii\web\Request as YiiRequest;
 use yii\web\Response as YiiResponse;
 use yii\web\User;
 
 /**
  * @extends Client<BrowserkitRequest, Response>
+ * @internal This class is not part of the public API
  */
 final class Yii2 extends Client
 {
@@ -202,8 +201,8 @@ public function getInternalDomains(): array
         if ($urlManager->enablePrettyUrl) {
             foreach ($urlManager->rules as $rule) {
                 /**
- * @var \yii\web\UrlRule $rule
-*/
+                 * @var \yii\web\UrlRule $rule
+                 */
                 if ($rule->host !== null) {
                     $domains[] = $this->getDomainRegex($rule->host);
                 }
@@ -404,8 +403,8 @@ protected function encodeCookies(
 
         foreach ($response->getCookies() as $cookie) {
             /**
- * @var \yii\web\Cookie $cookie
-*/
+             * @var \yii\web\Cookie $cookie
+             */
             $value = $cookie->value;
             // Expire = 1 means we're removing the cookie
             if ($cookie->expire !== 1 && isset($validationKey)) {

src/Codeception/Lib/Connector/Yii2/ConnectionWatcher.php

@@ -11,7 +11,6 @@
 use yii\db\Connection;
 
 /**
- * Class ConnectionWatcher
  * This class will watch for new database connection and store a reference to the connection object.
  * @internal
  */

src/Codeception/Lib/Connector/Yii2/FixturesStore.php

@@ -13,8 +13,6 @@ final class FixturesStore
 
     /**
      * Expects fixtures config
-     *
-     * FixturesStore constructor.
      */
     public function __construct(
         protected mixed $data

src/Codeception/Lib/Connector/Yii2/TransactionForcer.php

@@ -9,10 +9,7 @@
 use yii\db\Transaction;
 
 /**
- * Class TransactionForcer
  * This class adds support for forcing transactions as well as reusing PDO objects.
- *
- * @package Codeception\Lib\Connector\Yii2
  */
 final class TransactionForcer extends ConnectionWatcher
 {
@@ -91,8 +88,8 @@ protected function connectionOpened(Connection $connection): void
     public function rollbackAll(): void
     {
         /**
- * @var Transaction $transaction
-*/
+         * @var Transaction $transaction
+         */
         foreach ($this->transactions as $transaction) {
             if ($transaction->db->isActive) {
                 $transaction->rollBack();

src/Codeception/Module/Yii2.php

@@ -15,6 +15,7 @@
 use Codeception\Lib\Interfaces\ActiveRecord;
 use Codeception\Lib\Interfaces\PartedModule;
 use Codeception\TestInterface;
+use PHPUnit\Framework\Assert;
 use ReflectionClass;
 use RuntimeException;
 use Yii;
@@ -25,7 +26,7 @@
 use yii\mail\BaseMessage;
 use yii\mail\MessageInterface;
 use yii\test\Fixture;
-use yii\web\Application;
+use yii\web\Application as WebApplication;
 use yii\web\IdentityInterface;
 
 /**
@@ -252,7 +253,7 @@ final class Yii2 extends Framework implements ActiveRecord, PartedModule
     private TransactionForcer $transactionForcer;
 
     /**
-     * @var array<mixed> The contents of $_SERVER upon initialization of this object.
+     * @var array<mixed> The contents of upon initialization of this object.
      * This is only used to restore it upon object destruction.
      * It MUST not be used anywhere else.
      */
@@ -625,34 +626,34 @@ public function grabFixture(string $name, null|string $index = null): Fixture|\y
      *
      * ``` php
      * <?php
-     * $user_id = $I->haveRecord('app\models\User', array('name' => 'Davert'));
+     * $user_id = $I->haveRecord(model: User::class, attributes: ['name' => 'Davert']);
      * ?>
      * ```
      *
      * @template T of \yii\db\ActiveRecord
      * @param    class-string<T>      $model
-     * @param    array<string, mixed> $attributes
+     * @param                   array<string, mixed> $attributes
      * @part     orm
+     * @return int|string|array<string, int|string> The primary key
      */
-    public function haveRecord(string $model, $attributes = []): mixed
+    public function haveRecord(string $model, $attributes = []): int|string|array
     {
         /**
- * @var T $record
-*/
+         * @var T $record
+         */
         $record = \Yii::createObject($model);
         $record->setAttributes($attributes, false);
-        $res = $record->save(false);
-        if (! $res) {
-            $this->fail("Record $model was not saved: " . \yii\helpers\Json::encode($record->errors));
+        if (! $record->save(false)) {
+            Assert::fail("Record $model was not saved: " . \yii\helpers\Json::encode($record->errors));
         }
-        return $record->primaryKey;
+        return $record->getPrimaryKey();
     }
 
     /**
      * Checks that a record exists in the database.
      *
      * ```php
-     * $I->seeRecord('app\models\User', array('name' => 'davert'));
+     * $I->seeRecord(model: User::class, attributes: ['name' => 'davert']);
      * ```
      *
      * @param class-string<\yii\db\ActiveRecord> $model
@@ -663,7 +664,7 @@ public function seeRecord(string $model, array $attributes = []): void
     {
         $record = $this->findRecord($model, $attributes);
         if (! $record) {
-            $this->fail("Couldn't find $model with " . json_encode($attributes));
+            Assert::fail("Couldn't find $model with " . json_encode($attributes));
         }
         $this->debugSection($model, json_encode($record));
     }
@@ -672,7 +673,7 @@ public function seeRecord(string $model, array $attributes = []): void
      * Checks that a record does not exist in the database.
      *
      * ```php
-     * $I->dontSeeRecord('app\models\User', array('name' => 'davert'));
+     * $I->dontSeeRecord(User::class, attributes: ['name' => 'davert']);
      * ```
      *
      * @param class-string<\yii\db\ActiveRecord> $model
@@ -684,15 +685,15 @@ public function dontSeeRecord(string $model, array $attributes = []): void
         $record = $this->findRecord($model, $attributes);
         $this->debugSection($model, json_encode($record));
         if ($record) {
-            $this->fail("Unexpectedly managed to find $model with " . json_encode($attributes));
+            Assert::fail("Unexpectedly managed to find $model with " . json_encode($attributes));
         }
     }
 
     /**
      * Retrieves a record from the database
      *
      * ```php
-     * $category = $I->grabRecord('app\models\User', array('name' => 'davert'));
+     * $category = $I->grabRecord(User::class, attributes: ['name' => 'davert']);
      * ```
      *
      * @param  class-string<\yii\db\ActiveRecord> $model

tests/Yii.stub

@@ -17,6 +17,27 @@ namespace yii {
 namespace yii\base {
 
     class Application {}
+
+    class Model {}
+}
+
+namespace yii\db {
+    class BaseActiveRecord extends \yii\base\Model {
+        /**
+         * @param bool $asArray
+         * @return int|string|array<string, int|string>|null
+         */
+        public function getPrimaryKey($asArray = false) {}
+
+        /**
+         * @return bool
+         * @param bool $runValidation
+         * @param null|list<string> $attributeNames
+         * @phpstan-assert-if-true (int|string|array<string, int|string>) $this->getPrimaryKey()
+         */
+        public function save($runValidation = true, $attributeNames = null) {}
+
+    }
 }
 
 namespace yii\web {