Apply language migrations from PHP 7.4 to 8.1

Author: jeromegamez

CHANGELOG.md

@@ -2,7 +2,12 @@
 
 ## Unreleased
 
-* Dropped support for PHP version <8.1
+The most notable change is that you need PHP 8.1/8.2 to use the new version. The language migration to
+PHP 8.1 introduces potentially breaking changes concerning the strictness of parameter types - 
+however, this should not affect your project in most cases (unless you have used internal classes 
+directly or by extension).
+
+Please see [UPGRADE-4.0.md](UPGRADE-4.0.md) for detailed information.
 
 ## 3.0.3 - 2022-08-22
 

UPGRADE-4.0.md

@@ -0,0 +1,21 @@
+# Upgrade from 3.x to 4.0
+
+## Introduction
+
+The list of breaking changes below should not be an issue if you've been using the library as intended and documented.
+
+## Complete list of breaking changes
+
+The following list has been generated with [roave/backward-compatibility-check](https://github.com/Roave/BackwardCompatibilityCheck).
+
+```
+[BC] CHANGED: The parameter $value of Kreait\Firebase\JWT\Value\Duration::make() changed from no type to a non-contravariant self|DateInterval|int|string
+[BC] CHANGED: The parameter $other of Kreait\Firebase\JWT\Value\Duration#isLargerThan() changed from no type to a non-contravariant self|DateInterval|int|string
+[BC] CHANGED: The parameter $other of Kreait\Firebase\JWT\Value\Duration#equals() changed from no type to a non-contravariant self|DateInterval|int|string
+[BC] CHANGED: The parameter $other of Kreait\Firebase\JWT\Value\Duration#isSmallerThan() changed from no type to a non-contravariant self|DateInterval|int|string
+[BC] CHANGED: The parameter $other of Kreait\Firebase\JWT\Value\Duration#compareTo() changed from no type to a non-contravariant self|DateInterval|int|string
+[BC] CHANGED: The parameter $duration of Kreait\Firebase\JWT\Action\FetchGooglePublicKeys#ifKeysDoNotExpireCacheFor() changed from no type to a non-contravariant Kreait\Firebase\JWT\Value\Duration|DateInterval|string|int
+[BC] CHANGED: The parameter $ttl of Kreait\Firebase\JWT\Action\CreateCustomToken#withTimeToLive() changed from no type to a non-contravariant Kreait\Firebase\JWT\Value\Duration|DateInterval|string|int
+[BC] CHANGED: The parameter $timeToLive of Kreait\Firebase\JWT\CustomTokenGenerator#createCustomToken() changed from no type to a non-contravariant Kreait\Firebase\JWT\Value\Duration|DateInterval|string|int|null
+[BC] REMOVED: Class Kreait\Firebase\JWT\Error\DiscoveryFailed has been deleted
+```

src/JWT/Action/CreateCustomToken.php

@@ -13,16 +13,14 @@ final class CreateCustomToken
     public const MINIMUM_TTL = 'PT1S';
     public const MAXIMUM_TTL = 'PT1H';
     public const DEFAULT_TTL = self::MAXIMUM_TTL;
-    private string $uid;
     private ?string $tenantId = null;
 
     /** @var array<string, mixed> */
     private array $customClaims = [];
     private Duration $ttl;
 
-    private function __construct(string $uid)
+    private function __construct(private string $uid)
     {
-        $this->uid = $uid;
         $this->ttl = Duration::fromDateIntervalSpec(self::DEFAULT_TTL);
     }
 
@@ -47,10 +45,7 @@ public function withChangedUid(string $uid): self
         return $action;
     }
 
-    /**
-     * @param mixed $value
-     */
-    public function withCustomClaim(string $name, $value): self
+    public function withCustomClaim(string $name, mixed $value): self
     {
         $action = clone $this;
         $action->customClaims[$name] = $value;
@@ -75,15 +70,12 @@ public function withCustomClaims(array $claims): self
     public function withAddedCustomClaims(array $claims): self
     {
         $action = clone $this;
-        $action->customClaims = array_merge($action->customClaims, $claims);
+        $action->customClaims = [...$action->customClaims, ...$claims];
 
         return $action;
     }
 
-    /**
-     * @param Duration|DateInterval|string|int $ttl
-     */
-    public function withTimeToLive($ttl): self
+    public function withTimeToLive(Duration|DateInterval|string|int $ttl): self
     {
         $ttl = Duration::make($ttl);
 

src/JWT/Action/CreateCustomToken/WithLcobucciJWT.php

@@ -20,17 +20,15 @@
  */
 final class WithLcobucciJWT implements Handler
 {
-    private string $clientEmail;
-    private ClockInterface $clock;
-    private Configuration $config;
+    private readonly ClockInterface $clock;
+    private readonly Configuration $config;
 
     /**
      * @param non-empty-string $clientEmail
      * @param non-empty-string $privateKey
      */
-    public function __construct(string $clientEmail, string $privateKey, ClockInterface $clock)
+    public function __construct(private readonly string $clientEmail, string $privateKey, ClockInterface $clock)
     {
-        $this->clientEmail = $clientEmail;
         $this->clock = $clock;
 
         $this->config = Configuration::forSymmetricSigner(

src/JWT/Action/FetchGooglePublicKeys.php

@@ -17,16 +17,14 @@ final class FetchGooglePublicKeys
     public const DEFAULT_FALLBACK_CACHE_DURATION = 'PT1H';
 
     /** @var array<int, string> */
-    private array $urls;
-    private Duration $fallbackCacheDuration;
+    private readonly array $urls;
 
     /**
      * @param array<array-key, string> $urls
      */
-    private function __construct(array $urls, Duration $fallbackCacheDuration)
+    private function __construct(array $urls, private Duration $fallbackCacheDuration)
     {
         $this->urls = array_values($urls);
-        $this->fallbackCacheDuration = $fallbackCacheDuration;
     }
 
     public static function fromGoogle(): self
@@ -45,10 +43,8 @@ public static function fromUrl(string $url): self
     /**
      * A response from the Google APIs should have a cache control header that determines when the keys expire.
      * If it doesn't have one, fall back to this value.
-     *
-     * @param Duration|DateInterval|string|int $duration
      */
-    public function ifKeysDoNotExpireCacheFor($duration): self
+    public function ifKeysDoNotExpireCacheFor(Duration|DateInterval|string|int $duration): self
     {
         $duration = Duration::make($duration);
 

src/JWT/Action/FetchGooglePublicKeys/WithGuzzle.php

@@ -21,8 +21,8 @@
  */
 final class WithGuzzle implements Handler
 {
-    private ClientInterface $client;
-    private ClockInterface $clock;
+    private readonly ClientInterface $client;
+    private readonly ClockInterface $clock;
 
     public function __construct(ClientInterface $client, ClockInterface $clock)
     {

src/JWT/Action/FetchGooglePublicKeys/WithPsr6Cache.php

@@ -11,20 +11,16 @@
 use Psr\Cache\CacheItemPoolInterface;
 use StellaMaris\Clock\ClockInterface;
 
-use function get_class;
-
 /**
  * @internal
  */
 final class WithPsr6Cache implements Handler
 {
-    private Handler $handler;
-    private CacheItemPoolInterface $cache;
-    private ClockInterface $clock;
+    private readonly CacheItemPoolInterface $cache;
+    private readonly ClockInterface $clock;
 
-    public function __construct(Handler $handler, CacheItemPoolInterface $cache, ClockInterface $clock)
+    public function __construct(private readonly Handler $handler, CacheItemPoolInterface $cache, ClockInterface $clock)
     {
-        $this->handler = $handler;
         $this->cache = $cache;
         $this->clock = $clock;
     }
@@ -61,7 +57,7 @@ public function handle(FetchGooglePublicKeys $action): Keys
             $reason = sprintf(
                 'The inner handler of %s (%s) failed in fetching keys: %s',
                 self::class,
-                get_class($this->handler),
+                $this->handler::class,
                 $e->getMessage(),
             );
 

src/JWT/Action/VerifyIdToken/WithLcobucciJWT.php

@@ -39,17 +39,13 @@
  */
 final class WithLcobucciJWT implements Handler
 {
-    private string $projectId;
-    private Keys $keys;
-    private ClockInterface $clock;
-    private Parser $parser;
+    private readonly ClockInterface $clock;
+    private readonly Parser $parser;
     private Signer $signer;
-    private Validator $validator;
+    private readonly Validator $validator;
 
-    public function __construct(string $projectId, Keys $keys, ClockInterface $clock)
+    public function __construct(private readonly string $projectId, private readonly Keys $keys, ClockInterface $clock)
     {
-        $this->projectId = $projectId;
-        $this->keys = $keys;
         $this->clock = $clock;
         $this->parser = new Parser(new JoseEncoder());
 

src/JWT/Action/VerifySessionCookie/WithLcobucciJWT.php

@@ -39,17 +39,13 @@
  */
 final class WithLcobucciJWT implements Handler
 {
-    private string $projectId;
-    private Keys $keys;
-    private ClockInterface $clock;
-    private Parser $parser;
+    private readonly ClockInterface $clock;
+    private readonly Parser $parser;
     private Signer $signer;
-    private Validator $validator;
+    private readonly Validator $validator;
 
-    public function __construct(string $projectId, Keys $keys, ClockInterface $clock)
+    public function __construct(private readonly string $projectId, private readonly Keys $keys, ClockInterface $clock)
     {
-        $this->projectId = $projectId;
-        $this->keys = $keys;
         $this->clock = $clock;
         $this->parser = new Parser(new JoseEncoder());
 

src/JWT/CustomTokenGenerator.php

@@ -15,12 +15,10 @@
 
 final class CustomTokenGenerator
 {
-    private Handler $handler;
     private ?string $tenantId = null;
 
-    public function __construct(Handler $handler)
+    public function __construct(private readonly Handler $handler)
     {
-        $this->handler = $handler;
     }
 
     /**
@@ -53,11 +51,10 @@ public function execute(CreateCustomToken $action): Token
 
     /**
      * @param array<string, mixed> $claims
-     * @param Duration|DateInterval|string|int $timeToLive
      *
      * @throws CustomTokenCreationFailed
      */
-    public function createCustomToken(string $uid, ?array $claims = null, $timeToLive = null): Token
+    public function createCustomToken(string $uid, ?array $claims = null, Duration|DateInterval|string|int $timeToLive = null): Token
     {
         $action = CreateCustomToken::forUid($uid);