feature #6 Add support for PHP 8.4 (sstok)

sstok · web-flow · commit 73099af440db · 2025-05-08T20:48:55.000+02:00
This PR was merged into the 1.0-dev branch. Discussion ---------- | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Fixed tickets | | License | MIT No functional changes, but implicit `null` arguments are deprecated. Commits ------- 82d76b6 Add support for PHP 8.4
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -60,7 +60,7 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - '8.2'
+                    - '8.3'
 
         steps:
             -
@@ -103,20 +103,21 @@ jobs:
         strategy:
             matrix:
                 include:
-                    -
-                        php-version: '8.2'
-                        composer-options: '--prefer-stable'
-                        symfony-version: '6.3'
                     -
                         php-version: '8.2'
                         composer-options: '--prefer-stable'
                         symfony-version: '^6.4'
 
                     -
-                        php-version: '8.2'
+                        php-version: '8.3'
                         composer-options: '--prefer-stable'
                         symfony-version: '^7.0'
 
+                    -
+                        php-version: '8.4'
+                        composer-options: '--prefer-stable'
+                        symfony-version: '^7.2'
+
         steps:
             -
                 name: 'Check out'
diff --git a/composer.json b/composer.json
@@ -17,15 +17,15 @@
     "homepage": "https://rollerworks.github.io",
     "require": {
         "php": ">=8.2",
-        "paragonie/constant_time_encoding": "^2.6",
+        "paragonie/constant_time_encoding": "^2.6 || ^3.0",
         "paragonie/hidden-string": "^2.0",
         "psr/clock": "^1.0"
     },
     "require-dev": {
         "doctrine/instantiator": "^2.0",
         "phpunit/phpunit": "^10.4",
         "rollerscapes/standards": "^1.0",
-        "symfony/clock": "^6.3"
+        "symfony/clock": "^6.3 || ^7.2"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
diff --git a/src/AbstractSplitTokenFactory.php b/src/AbstractSplitTokenFactory.php
@@ -18,7 +18,7 @@ abstract class AbstractSplitTokenFactory implements SplitTokenFactory
     private ?\DateInterval $defaultLifeTime = null;
     private ?ClockInterface $clock;
 
-    public function __construct(\DateInterval | string $defaultLifeTime = null)
+    public function __construct(\DateInterval | string | null $defaultLifeTime = null)
     {
         if (\is_string($defaultLifeTime)) {
             $defaultLifeTime = new \DateInterval($defaultLifeTime);
@@ -33,7 +33,7 @@ public function setClock(ClockInterface $clock): void
         $this->clock = $clock;
     }
 
-    final protected function getExpirationTimestamp(\DateTimeImmutable | \DateInterval $expiration = null): ?\DateTimeImmutable
+    final protected function getExpirationTimestamp(\DateTimeImmutable | \DateInterval | null $expiration = null): ?\DateTimeImmutable
     {
         if ($expiration instanceof \DateTimeImmutable) {
             return $expiration;
diff --git a/src/Argon2SplitTokenFactory.php b/src/Argon2SplitTokenFactory.php
@@ -24,12 +24,12 @@
 final class Argon2SplitTokenFactory extends AbstractSplitTokenFactory
 {
     /** @param array<string, int> $config */
-    public function __construct(private array $config = [], \DateInterval | string $defaultLifeTime = null)
+    public function __construct(private array $config = [], \DateInterval | string | null $defaultLifeTime = null)
     {
         parent::__construct($defaultLifeTime);
     }
 
-    public function generate(\DateTimeImmutable | \DateInterval $expiresAt = null): SplitToken
+    public function generate(\DateTimeImmutable | \DateInterval | null $expiresAt = null): SplitToken
     {
         $splitToken = Argon2SplitToken::create(
             // DO NOT ENCODE HERE (always provide as raw binary)!
diff --git a/src/FakeSplitTokenFactory.php b/src/FakeSplitTokenFactory.php
@@ -30,14 +30,14 @@ public static function randomInstance(): self
         return new self(random_bytes(FakeSplitToken::TOKEN_DATA_LENGTH));
     }
 
-    public function __construct(string $randomValue = null, \DateInterval | string $defaultLifeTime = null)
+    public function __construct(?string $randomValue = null, \DateInterval | string | null $defaultLifeTime = null)
     {
         parent::__construct($defaultLifeTime);
 
         $this->randomValue = $randomValue ?? ((string) hex2bin('d7351e5d4bebe0b2b298034107f6cb12a88fe463ebf8f85afce47a38e9d5d68f15cbfad6843a3128d22d'));
     }
 
-    public function generate(\DateTimeImmutable | \DateInterval $expiresAt = null): SplitToken
+    public function generate(\DateTimeImmutable | \DateInterval | null $expiresAt = null): SplitToken
     {
         return FakeSplitToken::create(new HiddenString($this->randomValue, false, true))
             ->expireAt($this->getExpirationTimestamp($expiresAt));
diff --git a/src/SplitToken.php b/src/SplitToken.php
@@ -119,7 +119,7 @@ public static function create(HiddenString $randomBytes, array $config = []): st
 
         if (Binary::safeStrlen($bytesString) !== self::TOKEN_DATA_LENGTH) {
             // Don't zero memory as the value is invalid.
-            throw new \RuntimeException(sprintf('Invalid token-data provided, expected exactly %s bytes.', self::TOKEN_DATA_LENGTH));
+            throw new \RuntimeException(\sprintf('Invalid token-data provided, expected exactly %s bytes.', self::TOKEN_DATA_LENGTH));
         }
 
         $selector = Base64UrlSafe::encode(Binary::safeSubstr($bytesString, 0, self::SELECTOR_BYTES));
@@ -137,7 +137,7 @@ public static function create(HiddenString $randomBytes, array $config = []): st
         return $instance;
     }
 
-    public function expireAt(\DateTimeImmutable $expiresAt = null): static
+    public function expireAt(?\DateTimeImmutable $expiresAt = null): static
     {
         $instance = clone $this;
         $instance->expiresAt = $expiresAt;
diff --git a/src/SplitTokenFactory.php b/src/SplitTokenFactory.php
@@ -34,7 +34,7 @@ public function setClock(ClockInterface $clock): void;
      *
      * @see HiddenString
      */
-    public function generate(\DateTimeImmutable | \DateInterval $expiresAt = null): SplitToken;
+    public function generate(\DateTimeImmutable | \DateInterval | null $expiresAt = null): SplitToken;
 
     /**
      * Recreates a SplitToken object from a token-string
diff --git a/src/SplitTokenValueHolder.php b/src/SplitTokenValueHolder.php
@@ -31,10 +31,10 @@ final class SplitTokenValueHolder
     private ?string $verifierHash = null;
     private ?\DateTimeImmutable $expiresAt = null;
     /** @var array<string, scalar> */
-    private array $metadata = [];
+    private ?array $metadata = [];
 
     /** @param array<string, scalar> $metadata */
-    public function __construct(string $selector, string $verifierHash, \DateTimeImmutable $expiresAt = null, array $metadata = [])
+    public function __construct(string $selector, string $verifierHash, ?\DateTimeImmutable $expiresAt = null, array $metadata = [])
     {
         $this->selector = $selector;
         $this->verifierHash = $verifierHash;
@@ -100,7 +100,7 @@ public function metadata(): array
         return $this->metadata ?? [];
     }
 
-    public function isExpired(\DateTimeImmutable $now = null): bool
+    public function isExpired(?\DateTimeImmutable $now = null): bool
     {
         if ($this->expiresAt === null) {
             return false;
diff --git a/tests/Argon2SplitTokenFactoryTest.php b/tests/Argon2SplitTokenFactoryTest.php
@@ -93,7 +93,9 @@ public function it_creates_from_stringable_object(): void
         $splitToken = $factory->generate();
 
         $stringObj = new class($splitToken->token()->getString()) implements \Stringable {
-            public function __construct(private string $value) {}
+            public function __construct(private string $value)
+            {
+            }
 
             public function __toString(): string
             {
diff --git a/tests/FakeSplitTokenFactoryTest.php b/tests/FakeSplitTokenFactoryTest.php
@@ -8,6 +8,8 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
+namespace Rollerworks\Component\SplitToken\Tests;
+
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 use Rollerworks\Component\SplitToken\FakeSplitTokenFactory;
@@ -120,8 +122,9 @@ public function it_creates_from_stringable_object(): void
         $stringObj = new class($splitToken->token()->getString()) implements \Stringable {
             public function __construct(
                 #[\SensitiveParameter]
-                private string $value
-            ) {}
+                private string $value,
+            ) {
+            }
 
             public function __toString(): string
             {

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ abstract class AbstractSplitTokenFactory implements SplitTokenFactory`
`18`	`18`	`private ?\DateInterval $defaultLifeTime = null;`
`19`	`19`	`private ?ClockInterface $clock;`
`20`	`20`
`21`		`- public function __construct(\DateInterval \| string $defaultLifeTime = null)`
	`21`	`+ public function __construct(\DateInterval \| string \| null $defaultLifeTime = null)`
`22`	`22`	`{`
`23`	`23`	`if (\is_string($defaultLifeTime)) {`
`24`	`24`	`$defaultLifeTime = new \DateInterval($defaultLifeTime);`
`@@ -33,7 +33,7 @@ public function setClock(ClockInterface $clock): void`
`33`	`33`	`$this->clock = $clock;`
`34`	`34`	`}`
`35`	`35`
`36`		`- final protected function getExpirationTimestamp(\DateTimeImmutable \| \DateInterval $expiration = null): ?\DateTimeImmutable`
	`36`	`+ final protected function getExpirationTimestamp(\DateTimeImmutable \| \DateInterval \| null $expiration = null): ?\DateTimeImmutable`
`37`	`37`	`{`
`38`	`38`	`if ($expiration instanceof \DateTimeImmutable) {`
`39`	`39`	`return $expiration;`
Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,12 @@`
`24`	`24`	`final class Argon2SplitTokenFactory extends AbstractSplitTokenFactory`
`25`	`25`	`{`
`26`	`26`	`/** @param array<string, int> $config */`
`27`		`- public function __construct(private array $config = [], \DateInterval \| string $defaultLifeTime = null)`
	`27`	`+ public function __construct(private array $config = [], \DateInterval \| string \| null $defaultLifeTime = null)`
`28`	`28`	`{`
`29`	`29`	`parent::__construct($defaultLifeTime);`
`30`	`30`	`}`
`31`	`31`
`32`		`- public function generate(\DateTimeImmutable \| \DateInterval $expiresAt = null): SplitToken`
	`32`	`+ public function generate(\DateTimeImmutable \| \DateInterval \| null $expiresAt = null): SplitToken`
`33`	`33`	`{`
`34`	`34`	`$splitToken = Argon2SplitToken::create(`
`35`	`35`	`// DO NOT ENCODE HERE (always provide as raw binary)!`
Original file line number	Diff line number	Diff line change
`@@ -30,14 +30,14 @@ public static function randomInstance(): self`
`30`	`30`	`return new self(random_bytes(FakeSplitToken::TOKEN_DATA_LENGTH));`
`31`	`31`	`}`
`32`	`32`
`33`		`- public function __construct(string $randomValue = null, \DateInterval \| string $defaultLifeTime = null)`
	`33`	`+ public function __construct(?string $randomValue = null, \DateInterval \| string \| null $defaultLifeTime = null)`
`34`	`34`	`{`
`35`	`35`	`parent::__construct($defaultLifeTime);`
`36`	`36`
`37`	`37`	`$this->randomValue = $randomValue ?? ((string) hex2bin('d7351e5d4bebe0b2b298034107f6cb12a88fe463ebf8f85afce47a38e9d5d68f15cbfad6843a3128d22d'));`
`38`	`38`	`}`
`39`	`39`
`40`		`- public function generate(\DateTimeImmutable \| \DateInterval $expiresAt = null): SplitToken`
	`40`	`+ public function generate(\DateTimeImmutable \| \DateInterval \| null $expiresAt = null): SplitToken`
`41`	`41`	`{`
`42`	`42`	`return FakeSplitToken::create(new HiddenString($this->randomValue, false, true))`
`43`	`43`	`->expireAt($this->getExpirationTimestamp($expiresAt));`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ public static function create(HiddenString $randomBytes, array $config = []): st`
`119`	`119`
`120`	`120`	`if (Binary::safeStrlen($bytesString) !== self::TOKEN_DATA_LENGTH) {`
`121`	`121`	`// Don't zero memory as the value is invalid.`
`122`		`- throw new \RuntimeException(sprintf('Invalid token-data provided, expected exactly %s bytes.', self::TOKEN_DATA_LENGTH));`
	`122`	`+ throw new \RuntimeException(\sprintf('Invalid token-data provided, expected exactly %s bytes.', self::TOKEN_DATA_LENGTH));`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`$selector = Base64UrlSafe::encode(Binary::safeSubstr($bytesString, 0, self::SELECTOR_BYTES));`
`@@ -137,7 +137,7 @@ public static function create(HiddenString $randomBytes, array $config = []): st`
`137`	`137`	`return $instance;`
`138`	`138`	`}`
`139`	`139`
`140`		`- public function expireAt(\DateTimeImmutable $expiresAt = null): static`
	`140`	`+ public function expireAt(?\DateTimeImmutable $expiresAt = null): static`
`141`	`141`	`{`
`142`	`142`	`$instance = clone $this;`
`143`	`143`	`$instance->expiresAt = $expiresAt;`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function setClock(ClockInterface $clock): void;`
`34`	`34`	`*`
`35`	`35`	`* @see HiddenString`
`36`	`36`	`*/`
`37`		`- public function generate(\DateTimeImmutable \| \DateInterval $expiresAt = null): SplitToken;`
	`37`	`+ public function generate(\DateTimeImmutable \| \DateInterval \| null $expiresAt = null): SplitToken;`
`38`	`38`
`39`	`39`	`/**`
`40`	`40`	`* Recreates a SplitToken object from a token-string`
Original file line number	Diff line number	Diff line change
`@@ -31,10 +31,10 @@ final class SplitTokenValueHolder`
`31`	`31`	`private ?string $verifierHash = null;`
`32`	`32`	`private ?\DateTimeImmutable $expiresAt = null;`
`33`	`33`	`/** @var array<string, scalar> */`
`34`		`- private array $metadata = [];`
	`34`	`+ private ?array $metadata = [];`
`35`	`35`
`36`	`36`	`/** @param array<string, scalar> $metadata */`
`37`		`- public function __construct(string $selector, string $verifierHash, \DateTimeImmutable $expiresAt = null, array $metadata = [])`
	`37`	`+ public function __construct(string $selector, string $verifierHash, ?\DateTimeImmutable $expiresAt = null, array $metadata = [])`
`38`	`38`	`{`
`39`	`39`	`$this->selector = $selector;`
`40`	`40`	`$this->verifierHash = $verifierHash;`
`@@ -100,7 +100,7 @@ public function metadata(): array`
`100`	`100`	`return $this->metadata ?? [];`
`101`	`101`	`}`
`102`	`102`
`103`		`- public function isExpired(\DateTimeImmutable $now = null): bool`
	`103`	`+ public function isExpired(?\DateTimeImmutable $now = null): bool`
`104`	`104`	`{`
`105`	`105`	`if ($this->expiresAt === null) {`
`106`	`106`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,9 @@ public function it_creates_from_stringable_object(): void`
`93`	`93`	`$splitToken = $factory->generate();`
`94`	`94`
`95`	`95`	`$stringObj = new class($splitToken->token()->getString()) implements \Stringable {`
`96`		`- public function __construct(private string $value) {}`
	`96`	`+ public function __construct(private string $value)`
	`97`	`+ {`
	`98`	`+ }`
`97`	`99`
`98`	`100`	`public function __toString(): string`
`99`	`101`	`{`