feat: add support php8.4 (#7)

Author: algoyounes

.github/workflows/unit-tests.yml

@@ -8,13 +8,13 @@ on:
 
 jobs:
   unit-tests:
-    name: Run Unit Tests
+    name: PHP ${{ matrix.php }}
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: true
       matrix:
-        php: [8.2]
+        php: [8.2, 8.3, 8.4]
         dependency-version: [prefer-stable]
 
     steps:
@@ -27,7 +27,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: dom, mbstring, zip
+          extensions: dom, mbstring, zip, sodium
           coverage: pcov
 
       # Determine the Composer cache directory

composer.json

@@ -52,8 +52,8 @@
         "laravel/pint": "^1.13.7",
         "orchestra/testbench": "^9.0",
         "pestphp/pest": "^2.28.1",
-        "phpstan/phpstan": "1.10.56",
-        "rector/rector": "0.19.5"
+        "phpstan/phpstan": "^2.1",
+        "rector/rector": "^2.0"
     },
     "scripts": {
         "refactor": "rector",

phpstan.neon.dist

@@ -4,4 +4,3 @@ parameters:
         - src
 
     reportUnmatchedIgnoredErrors: true
-    checkGenericClassInNonGenericObjectType: false

rector.php

@@ -4,7 +4,6 @@
 
 use Rector\Config\RectorConfig;
 use Rector\Php82\Rector\Class_\ReadOnlyClassRector;
-use Rector\Privatization\Rector\Class_\FinalizeClassesWithoutChildrenRector;
 use Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector;
 use Rector\Privatization\Rector\MethodCall\PrivatizeLocalGetterToPropertyRector;
 use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
@@ -24,7 +23,6 @@
 
     $rectorConfig->skip(
         [
-            FinalizeClassesWithoutChildrenRector::class,
             PrivatizeLocalGetterToPropertyRector::class,
             ReadOnlyClassRector::class,
         ]

src/Attributes/AbstractAttributes.php

@@ -4,11 +4,22 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @template TKey of array-key
+ * @template TValue
+ *
+ * @implements Arrayable<TKey, TValue>
+ */
 abstract class AbstractAttributes implements Arrayable
 {
-    /** @return array<string, mixed> */
+    /**
+     * @return array<TKey, TValue>
+     */
     abstract protected function getAttributes(): array;
 
+    /**
+     * @return array<TKey, TValue>
+     */
     public function toArray(): array
     {
         return $this->getAttributes();

src/Attributes/IdempotencyAttributes.php

@@ -8,6 +8,9 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 
+/**
+ * @extends AbstractAttributes<string, array<string, mixed>>
+ */
 class IdempotencyAttributes extends AbstractAttributes
 {
     private IdempotentRequest $request;

src/Config/IdempotencyConfig.php

@@ -4,24 +4,15 @@
 
 final class IdempotencyConfig
 {
-    // Idempotency config keys
-    public const ENABLED_KEY = 'enabled';
-    public const IDEMPOTENCY_HEADER_KEY = 'idempotency_header';
-    public const RELAYED_HEADER_KEY = 'idempotency_relayed_header';
-    public const ENFORCED_VERBS_KEY = 'enforced_verbs';
-    public const DUPLICATE_HANDLING_KEY = 'duplicate_handling';
-    public const MAX_LOCK_WAIT_TIME_KEY = 'max_lock_wait_time';
-    public const USER_ID_RESOLVER_KEY = 'user_id_resolver';
-    public const UNAUTHENTICATED_USER_ID_KEY = 'unauthenticated_user_id';
-
-    // Cache config keys
-    public const CACHE_TTL_KEY = 'cache.ttl';
-    public const CACHE_STORE_KEY = 'cache.store';
-
     // Default values
     private const DEFAULT_MAX_LOCK_WAIT_TIME = 10; // 10 seconds
     private const DEFAULT_CACHE_TTL = 86400; // 24 hours
     public const DEFAULT_CACHE_STORE = 'default';
+    public const DEFAULT_IDEMPOTENCY_HEADER = 'Idempotency-Key';
+    public const DEFAULT_RELAYED_HEADER = 'Idempotency-Relayed';
+    public const DEFAULT_ENFORCED_VERBS = ['POST', 'PUT', 'PATCH', 'DELETE'];
+    public const DEFAULT_DUPLICATE_HANDLING = 'exception';
+    public const DEFAULT_UNAUTHENTICATED_USER_ID = 'guest';
 
     /**
      * @param  array<string>  $enforcedVerbs
@@ -40,22 +31,32 @@ private function __construct(
         private readonly string $cacheStore
     ) {}
 
-    // @phpstan-ignore-next-line
+    /**
+     * @param array{
+     *     enabled?: bool,
+     *     idempotency_header?: string,
+     *     idempotency_relayed_header?: string,
+     *     enforced_verbs?: string[],
+     *     duplicate_handling?: string,
+     *     max_lock_wait_time?: int,
+     *     user_id_resolver?: class-string|null,
+     *     unauthenticated_user_id?: string,
+     *     cache?: array{ttl?: int, store?: string}
+     * } $attributes
+     */
     public static function createFromArray(array $attributes): self
     {
-        $get = static fn (string $key, int|bool|string|array|null $default = null) => $attributes[$key] ?? $default;
-
         return new self(
-            $get(self::ENABLED_KEY, false),
-            $get(self::IDEMPOTENCY_HEADER_KEY),
-            $get(self::RELAYED_HEADER_KEY),
-            $get(self::ENFORCED_VERBS_KEY),
-            $get(self::DUPLICATE_HANDLING_KEY),
-            $get(self::MAX_LOCK_WAIT_TIME_KEY, self::DEFAULT_MAX_LOCK_WAIT_TIME),
-            $get(self::USER_ID_RESOLVER_KEY, null),
-            $get(self::UNAUTHENTICATED_USER_ID_KEY),
-            $get(self::CACHE_TTL_KEY, self::DEFAULT_CACHE_TTL),
-            $get(self::CACHE_STORE_KEY, self::DEFAULT_CACHE_STORE)
+            enabled: $attributes['enabled'] ?? false,
+            idempotencyHeader: $attributes['idempotency_header'] ?? self::DEFAULT_IDEMPOTENCY_HEADER,
+            relayedHeader: $attributes['idempotency_relayed_header'] ?? self::DEFAULT_RELAYED_HEADER,
+            enforcedVerbs: $attributes['enforced_verbs'] ?? self::DEFAULT_ENFORCED_VERBS,
+            duplicateHandling: $attributes['duplicate_handling'] ?? self::DEFAULT_DUPLICATE_HANDLING,
+            maxLockWaitTime: $attributes['max_lock_wait_time'] ?? self::DEFAULT_MAX_LOCK_WAIT_TIME,
+            userIdResolver: $attributes['user_id_resolver'] ?? null,
+            unauthenticatedUserId: $attributes['unauthenticated_user_id'] ?? self::DEFAULT_UNAUTHENTICATED_USER_ID,
+            cacheTtl: $attributes['cache']['ttl'] ?? self::DEFAULT_CACHE_TTL,
+            cacheStore: $attributes['cache']['store'] ?? self::DEFAULT_CACHE_STORE,
         );
     }
 
@@ -117,7 +118,7 @@ public function getUnauthenticatedUserId(): string
 
     public function getCacheTtl(int $default = self::DEFAULT_CACHE_TTL): int
     {
-        return $this->cacheTtl ?? $default;
+        return $this->cacheTtl > 0 ? $this->cacheTtl : $default;
     }
 
     public function getCacheStore(): string

src/Entities/IdempotentRequest.php

@@ -8,7 +8,7 @@
 final class IdempotentRequest
 {
     /**
-     * @param  array<string, list<string|null>>  $body
+     * @param  array<string|int, list<string|null>|mixed>  $body
      * @param  array<string, list<string|null>>  $headers
      */
     public function __construct(
@@ -19,7 +19,12 @@ public function __construct(
     ) {}
 
     /**
-     * @param  array{body: array<string, list<string|null>>, headers: array<string, list<string|null>>, path: string, checksum: Checksum}  $attributes
+     * @param  array{
+     *     body: array<string|int, list<string|null>|mixed>,
+     *     headers: array<string, list<string|null>>,
+     *     path: string,
+     *     checksum: Checksum
+     * }  $attributes
      */
     public static function createFromArray(array $attributes): self
     {
@@ -45,7 +50,7 @@ public static function createFromRequest(Request $request): self
     }
 
     /**
-     * @return array<string, list<string|null>>
+     * @return array<string|int, list<string|null>|mixed>
      */
     public function getBody(): array
     {
@@ -76,7 +81,12 @@ public function getChecksum(): Checksum
     }
 
     /**
-     * @return array{body: array<string, list<string|null>>, headers: array<string, list<string|null>>, path: string, checksum: Checksum}
+     * @return array{
+     *     body: array<string|int,
+     *     list<string|null>|mixed>,
+     *     headers: array<string, list<string|null>>,
+     *     path: string, checksum: Checksum
+     * }
      */
     public function toArray(): array
     {

src/Middleware/IdempotencyMiddleware.php

@@ -32,11 +32,13 @@ public function __construct(
     public function handle(Request $request, Closure $next): Response|JsonResponse
     {
         if ($this->config->isNotEnabled() && $this->isEnforcedVerb($request) === false) {
+            // @phpstan-ignore-next-line
             return $next($request);
         }
 
         $idempotencyKey = $this->getIdempotencyKey($request);
         if (! $idempotencyKey) {
+            // @phpstan-ignore-next-line
             return $next($request);
         }
 

src/Providers/IdempotencyServiceProvider.php

@@ -77,6 +77,7 @@ function (Application $app): IdempotencyConfig {
                 $configRepository = $app->make(ConfigRepository::class);
                 $config = (array) $configRepository->get('idempotency', []);
 
+                // @phpstan-ignore-next-line
                 return IdempotencyConfig::createFromArray($config);
             }
         );