Refactor CookieSetter to optimize browser navigation

Rafikooo · Rafikooo · commit c8d08033fb75 · 2025-10-29T11:51:17.000+01:00
Improved the cookie setter logic to avoid unnecessary page navigations:
- Extract driver start logic into ensureDriverStarted() method
- Unify page load detection for Selenium2Driver and ChromeDriver
- Skip base_url visit when page is already loaded (about:blank, data:,)
- Move prepareMinkSessionIfNeeded() after SymfonyDriver early return
- Add readonly modifier to class and type declarations to methods
- Simplify shouldMinkSessionBePrepared() logic with early returns
diff --git a/src/Sylius/Behat/Service/Setter/CookieSetter.php b/src/Sylius/Behat/Service/Setter/CookieSetter.php
@@ -20,25 +20,19 @@
 use FriendsOfBehat\SymfonyExtension\Driver\SymfonyDriver;
 use Symfony\Component\BrowserKit\Cookie;
 
-final class CookieSetter implements CookieSetterInterface
+final readonly class CookieSetter implements CookieSetterInterface
 {
     public function __construct(
         private Session $minkSession,
         private \ArrayAccess $minkParameters,
     ) {
     }
 
-    public function setCookie($name, $value)
+    public function setCookie(string $name, string $value): void
     {
         $driver = $this->minkSession->getDriver();
 
-        if ($driver instanceof ChromeDriver || $driver instanceof PantherDriver) {
-            if (!$driver->isStarted()) {
-                $driver->start();
-            }
-        }
-
-        $this->prepareMinkSessionIfNeeded($this->minkSession);
+        $this->ensureDriverStarted($driver);
 
         if ($driver instanceof SymfonyDriver) {
             $driver->getClient()->getCookieJar()->set(
@@ -48,9 +42,17 @@ public function setCookie($name, $value)
             return;
         }
 
+        $this->prepareMinkSessionIfNeeded($this->minkSession);
         $this->minkSession->setCookie($name, $value);
     }
 
+    private function ensureDriverStarted(mixed $driver): void
+    {
+        if (($driver instanceof ChromeDriver || $driver instanceof PantherDriver) && !$driver->isStarted()) {
+            $driver->start();
+        }
+    }
+
     private function prepareMinkSessionIfNeeded(Session $session): void
     {
         if ($this->shouldMinkSessionBePrepared($session)) {
@@ -66,18 +68,19 @@ private function shouldMinkSessionBePrepared(Session $session): bool
             return false;
         }
 
-        if ($driver instanceof Selenium2Driver && $driver->getWebDriverSession() === null) {
-            return true;
+        if ($driver instanceof Selenium2Driver) {
+            return $driver->getWebDriverSession() === null || $this->isPageNotLoaded($session->getCurrentUrl());
         }
 
         if ($driver instanceof ChromeDriver) {
-            return true;
+            return $this->isPageNotLoaded($session->getCurrentUrl());
         }
 
-        if (str_contains($session->getCurrentUrl(), $this->minkParameters['base_url'])) {
-            return false;
-        }
+        return !str_contains($session->getCurrentUrl(), $this->minkParameters['base_url']);
+    }
 
-        return true;
+    private function isPageNotLoaded(string $url): bool
+    {
+        return in_array($url, ['', 'about:blank', 'data:,'], true);
     }
 }
diff --git a/src/Sylius/Behat/Service/Setter/CookieSetterInterface.php b/src/Sylius/Behat/Service/Setter/CookieSetterInterface.php
@@ -15,9 +15,5 @@
 
 interface CookieSetterInterface
 {
-    /**
-     * @param string $name
-     * @param string $value
-     */
-    public function setCookie($name, $value);
+    public function setCookie(string $name, string $value): void;
 }

Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,5 @@`
`15`	`15`
`16`	`16`	`interface CookieSetterInterface`
`17`	`17`	`{`
`18`		`- /**`
`19`		`- * @param string $name`
`20`		`- * @param string $value`
`21`		`- */`
`22`		`- public function setCookie($name, $value);`
	`18`	`+ public function setCookie(string $name, string $value): void;`
`23`	`19`	`}`