Create custom InvalidSessionAttributeException

Author: TavoNiievez

.jules/palette_dx.md

@@ -0,0 +1,3 @@
+## 2024-05-18 - Improve Error Clarity with Custom Exceptions
+**Learning:** The `SessionAssertionsTrait::seeSessionHasValues` method throws a generic `InvalidArgumentException` when an invalid attribute name type is provided. Creating a custom domain exception like `InvalidSessionAttributeException` improves clarity in testing environments, clearly communicating the failure context.
+**Action:** Create a custom exception in `src/Codeception/Exception/` and use it instead of generic exceptions to reduce cognitive load.

src/Codeception/Exception/InvalidSessionAttributeException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codeception\Exception;
+
+use InvalidArgumentException;
+
+class InvalidSessionAttributeException extends InvalidArgumentException
+{
+}

src/Codeception/Module/Symfony/SessionAssertionsTrait.php

@@ -4,7 +4,7 @@
 
 namespace Codeception\Module\Symfony;
 
-use InvalidArgumentException;
+use Codeception\Exception\InvalidSessionAttributeException;
 use Symfony\Component\BrowserKit\Cookie;
 use Symfony\Component\HttpFoundation\Session\SessionFactoryInterface;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
@@ -174,7 +174,7 @@ public function seeSessionHasValues(array $bindings): void
                 continue;
             }
             if (!is_string($expectedAttr)) {
-                throw new InvalidArgumentException(sprintf('Attribute name must be string, %s given.', get_debug_type($expectedAttr)));
+                throw new InvalidSessionAttributeException(sprintf('Attribute name must be string, %s given.', get_debug_type($expectedAttr)));
             }
             $this->assertTrue($session->has($expectedAttr), "No session attribute with name '{$expectedAttr}'");
         }