chore: clean up code for better readability

Author: SamMousa

src/Codeception/Lib/Connector/Yii2.php

@@ -15,6 +15,7 @@
 use Symfony\Component\BrowserKit\CookieJar;
 use Symfony\Component\BrowserKit\History;
 use Symfony\Component\BrowserKit\Request as BrowserkitRequest;
+use yii\web\Request as YiiRequest;
 use Symfony\Component\BrowserKit\Response;
 use Yii;
 use yii\base\Component;
@@ -123,11 +124,11 @@ protected function getApplication(): \yii\base\Application
         return Yii::$app ?? throw new \RuntimeException('Failed to create Yii2 application');
     }
 
-    private function getWebRequest(): Request
+    private function getWebRequest(): YiiRequest
     {
         $request = $this->getApplication()->request;
-        if (!$request instanceof Request) {
-            throw new \RuntimeException('Request component is not of type ' . Request::class);
+        if (!$request instanceof YiiRequest) {
+            throw new \RuntimeException('Request component is not of type ' . YiiRequest::class);
         }
         return $request;
     }
@@ -181,15 +182,11 @@ public function findAndLoginUser(int|string|IdentityInterface $user): void
      */
     public function hashCookieData(string $name, string $value): string
     {
-        $app = $this->getApplication();
-        $request = $app->getRequest();
-        if (!$request instanceof Request) {
-            throw new \RuntimeException("Can't do cookie operations on non-web requests");
-        }
+        $request = $this->getWebRequest();
         if (!$request->enableCookieValidation) {
             return $value;
         }
-        return $app->security->hashData(serialize([$name, $value]), $request->cookieValidationKey);
+        return $this->getApplication()->security->hashData(serialize([$name, $value]), $request->cookieValidationKey);
     }
 
     /**
@@ -367,9 +364,9 @@ public function doRequest(object $request): Response
              * Sending the response is problematic because it tries to send headers.
              */
             $app->trigger($app::EVENT_BEFORE_REQUEST);
-            $response = $app->handleRequest($yiiRequest);
+            $yiiResponse = $app->handleRequest($yiiRequest);
             $app->trigger($app::EVENT_AFTER_REQUEST);
-            $response->send();
+            $yiiResponse->send();
         } catch (\Exception $e) {
             if ($e instanceof UserException) {
                 // Don't discard output and pass exception handling to Yii to be able
@@ -383,20 +380,20 @@ public function doRequest(object $request): Response
             $response = $app->response;
         }
 
-        $this->encodeCookies($response, $yiiRequest, $app->security);
+        $this->encodeCookies($yiiResponse, $yiiRequest, $app->security);
 
-        if ($response->isRedirection) {
-            Debug::debug("[Redirect with headers]" . print_r($response->getHeaders()->toArray(), true));
+        if ($yiiResponse->isRedirection) {
+            Debug::debug("[Redirect with headers]" . print_r($yiiResponse->getHeaders()->toArray(), true));
         }
 
         $content = ob_get_clean();
-        if (empty($content) && !empty($response->content) && !isset($response->stream)) {
+        if (empty($content) && !empty($yiiResponse->content) && !isset($yiiResponse->stream)) {
             throw new \Exception('No content was sent from Yii application');
         } elseif ($content === false) {
             throw new \Exception('Failed to get output buffer');
         }
 
-        return new Response($content, $response->statusCode, $response->getHeaders()->toArray());
+        return new Response($content, $yiiResponse->statusCode, $yiiResponse->getHeaders()->toArray());
     }
 
     /**
@@ -405,7 +402,7 @@ public function doRequest(object $request): Response
      */
     protected function encodeCookies(
         YiiResponse $response,
-        Request $request,
+        YiiRequest $request,
         Security $security
     ): void {
         if ($request->enableCookieValidation) {
@@ -520,7 +517,7 @@ public function setContext(array $context): void
      */
     public function closeSession(): void
     {
-        $app = \Yii::$app;
+        $app = $this->getApplication();
         if ($app instanceof \yii\web\Application && $app->has('session', true)) {
             $app->session->close();
         }

src/Codeception/Module/Yii2.php

@@ -22,6 +22,7 @@
 use Symfony\Component\BrowserKit\History;
 use Yii;
 use yii\base\Security;
+use yii\web\Application as WebApplication;
 use yii\db\ActiveQueryInterface;
 use yii\db\ActiveRecordInterface;
 use yii\helpers\Url;
@@ -749,27 +750,6 @@ public function amOnRoute(string $route, array $params = []): void
         $this->amOnPage(Url::to($params));
     }
 
-    /**
-     * Gets a component from the Yii container. Throws an exception if the
-     * component is not available
-     *
-     * ```php
-     * <?php
-     * $mailer = $I->grabComponent('mailer');
-     * ```
-     *
-     * @throws \Codeception\Exception\ModuleException
-     * @deprecated in your tests you can use \Yii::$app directly.
-     */
-    public function grabComponent(string $component): null|object
-    {
-        try {
-            return $this->getClient()->getComponent($component);
-        } catch (ConfigurationException $e) {
-            throw new ModuleException($this, $e->getMessage());
-        }
-    }
-
     /**
      * Checks that an email is sent.
      *
@@ -913,7 +893,7 @@ public function _initializeSession(): void
      */
     public function _backupSession(): array
     {
-        if (Yii::$app instanceof Application && Yii::$app->has('session', true) && Yii::$app->session->useCustomStorage) {
+        if (Yii::$app instanceof WebApplication && Yii::$app->has('session', true) && Yii::$app->session->useCustomStorage) {
             throw new ModuleException($this, "Yii2 MultiSession only supports the default session backend.");
         }
         return [