[Yii2] Allow to preserve session with recreateApplication enabled (#5630)

Author: Slamdunk

src/Codeception/Lib/Connector/Yii2.php

@@ -80,6 +80,11 @@ class Yii2 extends Client
      */
     public $recreateApplication = false;
 
+    /**
+     * @var bool whether to close the session in between requests inside a single test, if recreateApplication is set to true
+     */
+    public $closeSessionOnRecreateApplication = true;
+
 
     private $emails = [];
 
@@ -96,10 +101,15 @@ public function getApplication()
         return Yii::$app;
     }
 
-    public function resetApplication()
+    /**
+     * @param bool $closeSession
+     */
+    public function resetApplication($closeSession = true)
     {
         codecept_debug('Destroying application');
-        $this->closeSession();
+        if (true === $closeSession) {
+            $this->closeSession();
+        }
         Yii::$app = null;
         \yii\web\UploadedFile::reset();
         if (method_exists(\yii\base\Event::className(), 'offAll')) {
@@ -542,7 +552,7 @@ protected function resetRequest(Application $app)
     protected function beforeRequest()
     {
         if ($this->recreateApplication) {
-            $this->resetApplication();
+            $this->resetApplication($this->closeSessionOnRecreateApplication);
             return;
         }
 

src/Codeception/Module/Yii2.php

@@ -46,8 +46,9 @@
  * * `recreateComponents` - (default: []) Some components change their state making them unsuitable for processing multiple requests. In production this is usually
  * not a problem since web apps tend to die and start over after each request. This allows you to list application components that need to be recreated before each request.
  * As a consequence, any components specified here should not be changed inside a test since those changes will get regarded.
- * You can use this module by setting params in your functional.suite.yml:
  * * `recreateApplication` - (default: false) whether to recreate the whole application before each request
+ * * `closeSessionOnRecreateApplication` - (default: true) whether to close the session in between requests inside a single test,
+ * * if recreateApplication is set to true
  * You can use this module by setting params in your functional.suite.yml:
  * ```yaml
  * actor: FunctionalTester
@@ -162,7 +163,8 @@ class Yii2 extends Framework implements ActiveRecord, PartedModule
         'responseCleanMethod' => Yii2Connector::CLEAN_CLEAR,
         'requestCleanMethod' => Yii2Connector::CLEAN_RECREATE,
         'recreateComponents' => [],
-        'recreateApplication' => false
+        'recreateApplication' => false,
+        'closeSessionOnRecreateApplication' => true,
     ];
 
     protected $requiredFields = ['configFile'];