Implemented alternate strategies for clearing response / request objects (#4915)

* Implemented alternate strategies for clearing response / request objects

* Fixed nitpick CS

* Removed constant visibility, which is not supported in older PHP versions

Author: SamMousa

src/Codeception/Lib/Connector/Yii2.php

@@ -10,6 +10,8 @@
 use Yii;
 use yii\base\ExitException;
 use yii\base\Security;
+use yii\web\Application;
+use yii\web\ErrorHandler;
 use yii\web\HttpException;
 use yii\web\Request;
 use yii\web\Response as YiiResponse;
@@ -18,11 +20,50 @@ class Yii2 extends Client
 {
     use Shared\PhpSuperGlobalsConverter;
 
+    const CLEAN_METHODS = [
+        self::CLEAN_RECREATE,
+        self::CLEAN_CLEAR,
+        self::CLEAN_FORCE_RECREATE,
+        self::CLEAN_MANUAL
+    ];
+    /**
+     * Clean the response object by recreating it.
+     * This might lose behaviors / event handlers / other changes that are done in the application bootstrap phase.
+     */
+    const CLEAN_RECREATE = 'recreate';
+    /**
+     * Same as recreate but will not warn when behaviors / event handlers are lost.
+     */
+    const CLEAN_FORCE_RECREATE = 'force_recreate';
+    /**
+     * Clean the response object by resetting specific properties via its' `clear()` method.
+     * This will keep behaviors / event handlers, but could inadvertently leave some changes intact.
+     * @see \Yii\web\Response::clear()
+     */
+    const CLEAN_CLEAR = 'clear';
+
+    /**
+     * Do not clean the response, instead the test writer will be responsible for manually resetting the response in
+     * between requests during one test
+     */
+    const CLEAN_MANUAL = 'manual';
+
+
     /**
      * @var string application config file
      */
     public $configFile;
 
+    /**
+     * @var string method for cleaning the response object before each request
+     */
+    public $responseCleanMethod;
+
+    /**
+     * @var string method for cleaning the request object before each request
+     */
+    public $requestCleanMethod;
+
     /**
      * @return \yii\web\Application
      */
@@ -99,7 +140,9 @@ public function doRequest($request)
          * @todo Implement some kind of check to see if someone tried to change the objects' properties and expects
          * those changes to be reflected in the reponse.
          */
-        $app->set('response', $app->getComponents()['response']);
+        $this->resetResponse($app);
+
+
 
         // disabling logging. Logs are slowing test execution down
         foreach ($app->log->targets as $target) {
@@ -114,7 +157,7 @@ public function doRequest($request)
          * @todo Implement some kind of check to see if someone tried to change the objects' properties and expects
          * those changes to be reflected in the reponse.
          */
-        $app->set('request', $app->getComponents()['request']);
+        $this->resetRequest($app);
 
         $yiiRequest = $app->getRequest();
         if ($request->getContent() !== null) {
@@ -134,7 +177,6 @@ public function doRequest($request)
             $app->trigger($app::EVENT_BEFORE_REQUEST);
             $response = $app->handleRequest($yiiRequest);
             $app->trigger($app::EVENT_AFTER_REQUEST);
-            codecept_debug($response->isSent);
             $response->send();
         } catch (\Exception $e) {
             if ($e instanceof HttpException) {
@@ -259,4 +301,83 @@ public function restart()
         parent::restart();
         $this->resetApplication();
     }
+
+    /**
+     * Resets the applications' response object.
+     * The method used depends on the module configuration.
+     */
+    protected function resetResponse(Application $app)
+    {
+        $method = $this->responseCleanMethod;
+        // First check the current response object.
+        if (($app->response->hasEventHandlers(\yii\web\Response::EVENT_BEFORE_SEND)
+                || $app->response->hasEventHandlers(\yii\web\Response::EVENT_AFTER_SEND)
+                || $app->response->hasEventHandlers(\yii\web\Response::EVENT_AFTER_PREPARE)
+                || count($app->response->getBehaviors()) > 0
+            ) && $method === self::CLEAN_RECREATE
+        ) {
+            Debug::debug(<<<TEXT
+[WARNING] You are attaching event handlers or behaviors to the response object. But the Yii2 module is configured to recreate
+the response object, this means any behaviors or events that are not attached in the component config will be lost.
+We will fall back to clearing the response. If you are certain you want to recreate it, please configure 
+responseCleanMethod = 'force_recreate' in the module.  
+TEXT
+            );
+            $method = self::CLEAN_CLEAR;
+        }
+
+        switch ($method) {
+            case self::CLEAN_FORCE_RECREATE:
+            case self::CLEAN_RECREATE:
+                $app->set('response', $app->getComponents()['response']);
+                break;
+            case self::CLEAN_CLEAR:
+                $app->response->clear();
+                break;
+            case self::CLEAN_MANUAL:
+                break;
+        }
+    }
+
+    protected function resetRequest(Application $app)
+    {
+        $method = $this->requestCleanMethod;
+        $request = $app->request;
+
+        // First check the current request object.
+        if (count($request->getBehaviors()) > 0 && $method === self::CLEAN_RECREATE) {
+            Debug::debug(<<<TEXT
+[WARNING] You are attaching event handlers or behaviors to the request object. But the Yii2 module is configured to recreate
+the request object, this means any behaviors or events that are not attached in the component config will be lost.
+We will fall back to clearing the request. If you are certain you want to recreate it, please configure 
+requestCleanMethod = 'force_recreate' in the module.  
+TEXT
+            );
+            $method = self::CLEAN_CLEAR;
+        }
+
+        switch ($method) {
+            case self::CLEAN_FORCE_RECREATE:
+            case self::CLEAN_RECREATE:
+                $app->set('request', $app->getComponents()['request']);
+                break;
+            case self::CLEAN_CLEAR:
+                $request->getHeaders()->removeAll();
+                $request->getCookies()->removeAll();
+                $request->setBaseUrl(null);
+                $request->setHostInfo(null);
+                $request->setPathInfo(null);
+                $request->setScriptFile(null);
+                $request->setScriptUrl(null);
+                $request->setUrl(null);
+                $request->setPort(null);
+                $request->setSecurePort(null);
+                $request->setAcceptableContentTypes(null);
+                $request->setAcceptableLanguages(null);
+
+                break;
+            case self::CLEAN_MANUAL:
+                break;
+        }
+    }
 }

src/Codeception/Module/Yii2.php

@@ -37,7 +37,10 @@
  * * `cleanup` - (default: true) cleanup fixtures after the test
  * * `ignoreCollidingDSN` - (default: false) When 2 database connections use the same DSN but different settings an exception will be thrown, set this to true to disable this behavior.
  * * `fixturesMethod` - (default: _fixtures) Name of the method used for creating fixtures.
- *
+ * * `responseCleanMethod` - (default: clear) Method for cleaning the response object. Note that this is only for multiple requests inside a single test case.
+ * Between test casesthe whole application is always recreated
+ * * `requestCleanMethod` - (default: clear) Method for cleaning the request object. Note that this is only for multiple requests inside a single test case.
+ * Between test cases the whole application is always recreated
  * You can use this module by setting params in your functional.suite.yml:
  *
  * ```yaml
@@ -150,6 +153,8 @@ class Yii2 extends Framework implements ActiveRecord, PartedModule
         'transaction' => null,
         'entryScript' => '',
         'entryUrl'    => 'http://localhost/index-test.php',
+        'responseCleanMethod' => Yii2Connector::CLEAN_CLEAR,
+        'requestCleanMethod' => Yii2Connector::CLEAN_RECREATE
     ];
 
     protected $requiredFields = ['configFile'];
@@ -178,6 +183,7 @@ class Yii2 extends Framework implements ActiveRecord, PartedModule
      * It MUST not be used anywhere else.
      */
     private $server;
+
     public function _initialize()
     {
         if ($this->config['transaction'] === null) {
@@ -232,6 +238,20 @@ protected function validateConfig()
                 "The application config file does not exist: " . Configuration::projectDir() . $this->config['configFile']
             );
         }
+
+        if (!in_array($this->config['responseCleanMethod'], Yii2Connector::CLEAN_METHODS)) {
+            throw new ModuleConfigException(
+                __CLASS__,
+                "The response clean method must be one of: " . implode(", ", Yii2Connector::CLEAN_METHODS)
+            );
+        }
+
+        if (!in_array($this->config['requestCleanMethod'], Yii2Connector::CLEAN_METHODS)) {
+            throw new ModuleConfigException(
+                __CLASS__,
+                "The response clean method must be one of: " . implode(", ", Yii2Connector::CLEAN_METHODS)
+            );
+        }
     }
 
 
@@ -250,6 +270,7 @@ public function _before(TestInterface $test)
         ]);
 
         $this->client->configFile = Configuration::projectDir() . $this->config['configFile'];
+        $this->client->responseCleanMethod = $this->config['responseCleanMethod'];
 
         $this->client->resetApplication();
         $app = $this->client->getApplication();
@@ -352,6 +373,7 @@ protected function startTransactions()
                         && $this->dsnCache[$connection->dsn] !== $key
                         && !$this->config['ignoreCollidingDSN']
                     ) {
+
                         $this->debugSection('WARNING', <<<TEXT
 You use multiple connections to the same DSN ({$connection->dsn}) with different configuration.
 These connections will not see the same database state since we cannot share a transaction between different PDO