From 97a768612af003ccad7545106533a270e9da2f30 Mon Sep 17 00:00:00 2001
From: Christian Kuhn <lolli@schwarzbu.ch>
Date: Sat, 8 Oct 2022 17:33:23 +0200
Subject: [PATCH] [TASK] Optionally suppress cookie debug output

Similar to WebDriver->setCookie(), methods seeCookie(),
dontSeeCookie(), resetCookie() and loadSessionSnapshot()
have an additional optional argument to suppress debug
output of cookie operations.

Closes: #110
---
 src/Codeception/Module/WebDriver.php | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

diff --git a/src/Codeception/Module/WebDriver.php b/src/Codeception/Module/WebDriver.php
index 0266bb4..0bd1f2e 100644
--- a/src/Codeception/Module/WebDriver.php
+++ b/src/Codeception/Module/WebDriver.php
@@ -989,25 +989,29 @@ private function debugCookies(): void
         $this->debugSection('Cookies', json_encode($result, JSON_THROW_ON_ERROR));
     }
 
-    public function seeCookie($cookie, array $params = []): void
+    public function seeCookie($cookie, array $params = [], bool $showDebug = true): void
     {
         $cookies = $this->filterCookies($this->webDriver->manage()->getCookies(), $params);
         $cookies = array_map(
             fn($c) => $c['name'],
             $cookies
         );
-        $this->debugCookies();
+        if ($showDebug) {
+            $this->debugCookies();
+        }
         $this->assertContains($cookie, $cookies);
     }
 
-    public function dontSeeCookie($cookie, array $params = []): void
+    public function dontSeeCookie($cookie, array $params = [], bool $showDebug = true): void
     {
         $cookies = $this->filterCookies($this->webDriver->manage()->getCookies(), $params);
         $cookies = array_map(
             fn($c) => $c['name'],
             $cookies
         );
-        $this->debugCookies();
+        if ($showDebug) {
+            $this->debugCookies();
+        }
         $this->assertNotContains($cookie, $cookies);
     }
 
@@ -1038,10 +1042,12 @@ public function setCookie($name, $value, array $params = [], $showDebug = true):
         }
     }
 
-    public function resetCookie($cookie, array $params = []): void
+    public function resetCookie($cookie, array $params = [], bool $showDebug = true): void
     {
         $this->webDriver->manage()->deleteCookieNamed($cookie);
-        $this->debugCookies();
+        if ($showDebug) {
+            $this->debugCookies();
+        }
     }
 
     public function grabCookie($cookie, array $params = []): mixed
@@ -3398,7 +3404,7 @@ public function saveSessionSnapshot($name)
         $this->debugSection('Snapshot', sprintf('Saved "%s" session snapshot', $name));
     }
 
-    public function loadSessionSnapshot($name): bool
+    public function loadSessionSnapshot($name, bool $showDebug = true): bool
     {
         if (!isset($this->sessionSnapshots[$name])) {
             return false;
@@ -3416,7 +3422,9 @@ public function loadSessionSnapshot($name): bool
             $this->setCookie($cookie['name'], $cookie['value'], (array)$cookie, false);
         }
 
-        $this->debugCookies();
+        if ($showDebug) {
+            $this->debugCookies();
+        }
         $this->debugSection('Snapshot', sprintf('Restored "%s" session snapshot', $name));
         return true;
     }