fix: Fix incorrect typing of 'same_site' cookie option

The 'same_site' value was always expected to be a bool, even though it would always be 'string', 'lax', 'none' or null
sprout-laravel · Dec 23, 2024 · ae345be · ae345be
1 parent e8e89e0
commit ae345be
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/src/Overrides/CookieOverride.php b/src/Overrides/CookieOverride.php
@@ -48,7 +48,7 @@ public function setup(Tenancy $tenancy, Tenant $tenant): void
         $path     = settings()->getUrlPath(config('session.path') ?? '/');             // @phpstan-ignore-line
         $domain   = settings()->getUrlDomain(config('session.domain'));                // @phpstan-ignore-line
         $secure   = settings()->shouldCookieBeSecure(config('session.secure', false)); // @phpstan-ignore-line
-        $sameSite = settings()->shouldCookeBeSameSite(config('session.same_site'));    // @phpstan-ignore-line
+        $sameSite = settings()->getCookieSameSite(config('session.same_site'));        // @phpstan-ignore-line
 
         /**
          * This is here to make PHPStan quiet down

diff --git a/src/Overrides/SessionOverride.php b/src/Overrides/SessionOverride.php
@@ -110,7 +110,7 @@ public function setup(Tenancy $tenancy, Tenant $tenant): void
         }
 
         if ($settings->has(Settings::COOKIE_SAME_SITE)) {
-            $config->set('session.same_site', $settings->shouldCookeBeSameSite());
+            $config->set('session.same_site', $settings->getCookieSameSite());
         }
 
         $config->set('session.cookie', $this->getCookieName($tenancy, $tenant));

diff --git a/src/Support/SettingsRepository.php b/src/Support/SettingsRepository.php
@@ -49,14 +49,22 @@ public function shouldCookieBeSecure(?bool $default = null): bool
         return $this->boolean(Settings::COOKIE_SECURE, $default);
     }
 
-    public function setCookieSameSite(bool $sameSite): void
+    public function setCookieSameSite(?string $sameSite): void
     {
         $this->set(Settings::COOKIE_SAME_SITE, $sameSite);
     }
 
-    public function shouldCookeBeSameSite(?bool $default = null): bool
+    public function getCookieSameSite(?string $default = null): ?string
     {
-        return $this->boolean(Settings::COOKIE_SAME_SITE, $default);
+        /**
+         * This is only here because the config repository has terrible support
+         * for typing, as you'd expect.
+         *
+         * @var string|null $sameSite
+         */
+        $sameSite = $this->get(Settings::COOKIE_SAME_SITE, $default);
+
+        return $sameSite;
     }
 
     public function doNotOverrideTheDatabase(): void