Enabler: Full refactoring [BC break!]

Author: jakubboucek

composer.json

@@ -41,7 +41,7 @@
         "nette/tester": "^2.4"
     },
     "scripts": {
-        "phpstan": "phpstan analyze src --level 8",
+        "phpstan": "phpstan analyze src -c phpstan.neon --level 8",
         "tester": "tester tests"
     }
 }

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    ignoreErrors:
+        -
+            message: '#Parameter \#3 \$options of function setcookie expects .+#'
+            path: src/Enabler.php
+            count: 2

src/Detector.php

@@ -8,9 +8,6 @@
 
 namespace Redbitcz\DebugMode;
 
-use InvalidArgumentException;
-use LogicException;
-
 class Detector
 {
     /** Name of Environment variable used to detect Debug mode */
@@ -52,7 +49,7 @@ class Detector
     public function __construct(int $mode = self::MODE_SIMPLE, ?Enabler $enabler = null)
     {
         if ($enabler === null && $mode & self::MODE_ENABLER) {
-            throw new InvalidArgumentException('Enabler mode requires Enabler instance in constructor');
+            throw new MissingEnablerException('Enabler mode requires the Enabler instance in constructor');
         }
 
         $this->enabler = $enabler;
@@ -62,7 +59,7 @@ public function __construct(int $mode = self::MODE_SIMPLE, ?Enabler $enabler = n
     public function getEnabler(): Enabler
     {
         if ($this->enabler === null) {
-            throw new LogicException('Detector constructed without Enabler');
+            throw new MissingEnablerException('Unable to get Enabler because Detector constructed without it');
         }
 
         return $this->enabler;
@@ -184,7 +181,7 @@ public static function detect(
         ?bool $default = false
     ): ?bool {
         if ($tempDir === null && $mode & self::MODE_ENABLER) {
-            throw new InvalidArgumentException('Enabler mode requires `tempDir` argument');
+            throw new MissingEnablerException('Enabler mode requires \'tempDir\' argument');
         }
 
         $enabler = $tempDir === null ? null : new Enabler($tempDir);

src/Enabler.php

@@ -9,6 +9,7 @@
 namespace Redbitcz\DebugMode;
 
 use Nette\IOException;
+use Nette\Utils\DateTime as NetteDateTime;
 use Nette\Utils\FileSystem;
 use Nette\Utils\Json;
 use Nette\Utils\JsonException;
@@ -20,40 +21,63 @@ class Enabler
     private const DEBUG_COOKIE_NAME = 'app-debug-token';
     private const TOKEN_LENGTH = 30;
     private const ID_LENGTH = 15;
-    private const TTL = 3600;
-    // TODO: Make configurable TLS requirements
-    private const REQUIRE_HTTPS = false;
+    private const DEFAULT_TTL = '1 hour';
 
-    /** @var string */
-    private $tempDir;
+    private string $tempDir;
+    private ?bool $override;
 
-    /** @var bool|null */
-    private $override;
+    /** @var array<string, string|bool> */
+    private array $cookieOptions = [
+        'path' => '/',
+        'domain' => '',
+        'secure' => true,
+        'httponly' => true,
+        'samesite' => 'Strict',
+    ];
 
     public function __construct(string $tempDir)
     {
         $this->tempDir = $tempDir;
     }
 
-    public function activate(bool $isDebug): void
+    /** @return static */
+    public function setSecure(bool $secure = true): self
+    {
+        $this->cookieOptions['secure'] = $secure;
+        return $this;
+    }
+
+    /**
+     * @return $this
+     * @see setcookie()
+     */
+    public function setCookieOptions(
+        ?string $path = null,
+        ?string $domain = null,
+        ?bool $secure = null,
+        ?bool $httponly = null,
+        ?string $samesite = null
+    ): self {
+        $this->cookieOptions = [
+            'path' => $path ?? $this->cookieOptions['path'],
+            'domain' => $domain ?? $this->cookieOptions['domain'],
+            'secure' => $secure ?? $this->cookieOptions['secure'],
+            'httponly' => $httponly ?? $this->cookieOptions['httponly'],
+            'samesite' => $samesite ?? $this->cookieOptions['samesite'],
+        ];
+        return $this;
+    }
+
+    public function activate(bool $isDebug, ?string $time = self::DEFAULT_TTL): void
     {
         if ($tokenName = $this->getTokenName()) {
             $this->destroyToken($tokenName);
         }
 
-        $tokenName = $this->createToken($isDebug);
-        setcookie(
-            self::DEBUG_COOKIE_NAME,
-            $tokenName,
-            [
-                'expires' => time() + self::TTL,
-                'path' => '/',
-                'domain' => '',
-                'secure' => self::REQUIRE_HTTPS,
-                'httponly' => true,
-                'samesite' => 'Strict',
-            ]
-        );
+        $tokenExpires = (int)NetteDateTime::from($time ?? self::DEFAULT_TTL)->format('U');
+        $cookieExpires = $time === null ? 0 : $tokenExpires;
+        $tokenName = $this->createToken($isDebug, $tokenExpires);
+        setcookie(self::DEBUG_COOKIE_NAME, $tokenName, ['expires' => $cookieExpires] + $this->cookieOptions);
 
         $this->override = $isDebug;
     }
@@ -65,19 +89,7 @@ public function deactivate(): void
             $this->destroyToken($tokenName);
         }
 
-        setcookie(
-            self::DEBUG_COOKIE_NAME,
-            '',
-            [
-                'expires' => 0,
-                'path' => '/',
-                'domain' => '',
-                'secure' => self::REQUIRE_HTTPS,
-                'httponly' => true,
-                'samesite' => 'Strict',
-            ]
-        );
-
+        setcookie(self::DEBUG_COOKIE_NAME, '', ['expires' => time()] + $this->cookieOptions);
         $this->override = null;
     }
 
@@ -117,10 +129,10 @@ private function checkToken(string $name): ?bool
         return $this->getListTokenValue($name, $list);
     }
 
-    private function createToken(bool $value): string
+    private function createToken(bool $value, int $expires): string
     {
         $list = $this->loadList();
-        $name = $this->addListToken($value, $list);
+        $name = $this->addListToken($value, $expires, $list);
         $this->saveList($list);
 
         return $name;
@@ -144,22 +156,18 @@ private function loadList(): array
     }
 
     /**
-     * @param bool $value
      * @param array<int, array> $list
-     * @return string
      */
-    private function addListToken(bool $value, array &$list): string
+    private function addListToken(bool $value, int $expires, array &$list): string
     {
         /** @var string $name */
-        [$name, $token] = $this->generateToken($value);
+        [$name, $token] = $this->generateToken($value, $expires);
         $list[] = $token;
         return $name;
     }
 
     /**
-     * @param string $name
      * @param array<int, array> $list
-     * @return bool|null
      */
     private function getListTokenValue(string $name, array $list): ?bool
     {
@@ -175,7 +183,6 @@ private function getListTokenValue(string $name, array $list): ?bool
 
 
     /**
-     * @param string $name
      * @param array<int, array> $list
      */
     private function dropListToken(string $name, array &$list): void
@@ -209,8 +216,6 @@ function ($token) {
 
     /**
      * @param array<string, string|bool|int> $token
-     * @param string|null $name
-     * @return bool
      */
     private function isTokenValid(array $token, ?string $name = null): bool
     {
@@ -233,16 +238,15 @@ private function isTokenValid(array $token, ?string $name = null): bool
     }
 
     /**
-     * @param bool $value
      * @return array<int, string|array>
      */
-    private function generateToken(bool $value): array
+    private function generateToken(bool $value, int $expires): array
     {
         $name = $this->generateTokenName();
         $token = [
             'id' => $this->getIdByName($name),
             'hash' => $this->getHashByName($name),
-            'expire' => time() + self::TTL,
+            'expire' => $expires,
             'value' => $value
         ];
 

src/MissingEnablerException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Redbitcz\DebugMode;
+
+class MissingEnablerException extends \LogicException
+{
+}

tests/DetectorTest.php

@@ -6,6 +6,7 @@
 
 use Redbitcz\DebugMode\Detector;
 use Redbitcz\DebugMode\Enabler;
+use Redbitcz\DebugMode\MissingEnablerException;
 use Tester\Assert;
 use Tester\Helpers;
 use Tester\TestCase;
@@ -189,6 +190,28 @@ public function testEnabler($testValue): void
         $detector->getEnabler()->override($testValue);
         Assert::equal($testValue, $detector->isDebugModeByEnabler());
     }
+
+    public function testMissingEnablerMode(): void
+    {
+        Assert::exception(function () {
+            $detector = new Detector(Detector::MODE_FULL);
+        }, MissingEnablerException::class);
+    }
+
+    public function testMissingEnabler(): void
+    {
+        Assert::exception(function () {
+            $detector = new Detector(Detector::MODE_SIMPLE);
+            $detector->getEnabler();
+        }, MissingEnablerException::class);
+    }
+
+    public function testMissingEnablerShortcut(): void
+    {
+        Assert::exception(function () {
+            Detector::detect(Detector::MODE_FULL);
+        }, MissingEnablerException::class);
+    }
 }
 
 (new DetectorTest())->run();