Adding support for Saloon v3

Sammyjo20 · Sammyjo20 · commit de8df64cce4f · 2023-09-17T15:36:14.000+01:00
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
@@ -5,6 +5,7 @@ on:
     branches:
       - 'v1'
       - 'v2'
+      - 'v3'
   pull_request:
     branches:
       - '*'
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -5,6 +5,7 @@ on:
     branches:
       - 'v1'
       - 'v2'
+      - 'v3'
   pull_request:
     branches:
       - '*'
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -41,4 +41,8 @@
     'blank_line_after_opening_tag' => true,
     'single_import_per_statement' => true,
     'mb_str_functions' => true,
+    'no_superfluous_phpdoc_tags' => true,
+    'no_blank_lines_after_phpdoc' => true,
+    'no_empty_phpdoc' => true,
+    'phpdoc_trim' => true,
 ])->setFinder($finder);
diff --git a/composer.json b/composer.json
@@ -18,7 +18,7 @@
     "minimum-stability": "stable",
     "require": {
         "php": "^8.1",
-        "saloonphp/saloon": "^2.0"
+        "saloonphp/saloon": "^3.0.0-beta.4"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.13",
diff --git a/src/Contracts/Cacheable.php b/src/Contracts/Cacheable.php
@@ -8,15 +8,11 @@ interface Cacheable
 {
     /**
      * Resolve the driver responsible for caching
-     *
-     * @return \Saloon\CachePlugin\Contracts\Driver
      */
     public function resolveCacheDriver(): Driver;
 
     /**
      * Define the cache expiry in seconds
-     *
-     * @return int
      */
     public function cacheExpiryInSeconds(): int;
 }
diff --git a/src/Contracts/Driver.php b/src/Contracts/Driver.php
@@ -11,26 +11,18 @@ interface Driver
 {
     /**
      * Store the cached response on the driver.
-     *
-     * @param string $key
-     * @param CachedResponse $cachedResponse
-     * @return void
      */
     public function set(string $key, CachedResponse $cachedResponse): void;
 
     /**
      * Get the cached response from the driver.
      *
-     * @param string $cacheKey
      * @return RecordedResponse|null
      */
     public function get(string $cacheKey): ?CachedResponse;
 
     /**
      * Delete the cached response.
-     *
-     * @param string $cacheKey
-     * @return void
      */
     public function delete(string $cacheKey): void;
 }
diff --git a/src/Data/CachedResponse.php b/src/Data/CachedResponse.php
@@ -6,17 +6,13 @@
 
 use DateTimeImmutable;
 use Saloon\Data\RecordedResponse;
-use Saloon\Http\Faking\SimulatedResponsePayload;
-use Saloon\Contracts\SimulatedResponsePayload as SimulatedResponsePayloadContract;
+use Saloon\Http\Faking\FakeResponse;
+use Saloon\Contracts\FakeResponse as FakeResponseContract;
 
 class CachedResponse
 {
     /**
      * Constructor
-     *
-     * @param \Saloon\Data\RecordedResponse $recordedResponse
-     * @param \DateTimeImmutable $expiresAt
-     * @param int $ttl
      */
     public function __construct(
         readonly public RecordedResponse  $recordedResponse,
@@ -28,8 +24,6 @@ public function __construct(
 
     /**
      * Check if the response has expired.
-     *
-     * @return bool
      */
     public function hasExpired(): bool
     {
@@ -38,24 +32,20 @@ public function hasExpired(): bool
 
     /**
      * Check if the response has not expired.
-     *
-     * @return bool
      */
     public function hasNotExpired(): bool
     {
         return ! $this->hasExpired();
     }
 
     /**
-     * Create a simulated response payload
-     *
-     * @return \Saloon\Contracts\SimulatedResponsePayload
+     * Create a fake response
      */
-    public function getSimulatedResponsePayload(): SimulatedResponsePayloadContract
+    public function getFakeResponse(): FakeResponseContract
     {
         $response = $this->recordedResponse;
 
-        return new SimulatedResponsePayload(
+        return new FakeResponse(
             body: $response->data,
             status: $response->statusCode,
             headers: $response->headers
diff --git a/src/Drivers/FlysystemDriver.php b/src/Drivers/FlysystemDriver.php
@@ -13,8 +13,6 @@ class FlysystemDriver implements Driver
 {
     /**
      * Constructor
-     *
-     * @param \League\Flysystem\Filesystem $store
      */
     public function __construct(
         protected Filesystem $store,
@@ -25,9 +23,6 @@ public function __construct(
     /**
      * Store the cached response on the driver.
      *
-     * @param string $key
-     * @param \Saloon\CachePlugin\Data\CachedResponse $cachedResponse
-     * @return void
      * @throws \League\Flysystem\FilesystemException
      */
     public function set(string $key, CachedResponse $cachedResponse): void
@@ -38,8 +33,6 @@ public function set(string $key, CachedResponse $cachedResponse): void
     /**
      * Get the cached response from the driver.
      *
-     * @param string $cacheKey
-     * @return \Saloon\CachePlugin\Data\CachedResponse|null
      * @throws \League\Flysystem\FilesystemException
      */
     public function get(string $cacheKey): ?CachedResponse
@@ -60,8 +53,6 @@ public function get(string $cacheKey): ?CachedResponse
     /**
      * Delete the cached response
      *
-     * @param string $cacheKey
-     * @return void
      * @throws \League\Flysystem\FilesystemException
      */
     public function delete(string $cacheKey): void
diff --git a/src/Drivers/LaravelCacheDriver.php b/src/Drivers/LaravelCacheDriver.php
@@ -12,8 +12,6 @@ class LaravelCacheDriver implements Driver
 {
     /**
      * Constructor
-     *
-     * @param \Illuminate\Contracts\Cache\Repository $store
      */
     public function __construct(
         protected Repository $store,
@@ -24,9 +22,6 @@ public function __construct(
     /**
      * Store the cached response on the driver.
      *
-     * @param string $key
-     * @param \Saloon\CachePlugin\Data\CachedResponse $cachedResponse
-     * @return void
      * @throws \Psr\SimpleCache\InvalidArgumentException
      */
     public function set(string $key, CachedResponse $cachedResponse): void
@@ -37,8 +32,6 @@ public function set(string $key, CachedResponse $cachedResponse): void
     /**
      * Get the cached response from the driver.
      *
-     * @param string $cacheKey
-     * @return \Saloon\CachePlugin\Data\CachedResponse|null
      * @throws \Psr\SimpleCache\InvalidArgumentException
      */
     public function get(string $cacheKey): ?CachedResponse
@@ -55,8 +48,6 @@ public function get(string $cacheKey): ?CachedResponse
     /**
      * Delete the cached response.
      *
-     * @param string $cacheKey
-     * @return void
      * @throws \Psr\SimpleCache\InvalidArgumentException
      */
     public function delete(string $cacheKey): void
diff --git a/src/Drivers/PsrCacheDriver.php b/src/Drivers/PsrCacheDriver.php
@@ -15,8 +15,6 @@ class PsrCacheDriver implements Driver
 {
     /**
      * Constructor
-     *
-     * @param CacheInterface $store
      */
     public function __construct(
         protected CacheInterface $store,
@@ -27,9 +25,6 @@ public function __construct(
     /**
      * Store the cached response on the driver.
      *
-     * @param string $key
-     * @param \Saloon\CachePlugin\Data\CachedResponse $cachedResponse
-     * @return void
      * @throws \Psr\SimpleCache\InvalidArgumentException
      */
     public function set(string $key, CachedResponse $cachedResponse): void
@@ -40,8 +35,6 @@ public function set(string $key, CachedResponse $cachedResponse): void
     /**
      * Get the cached response from the driver.
      *
-     * @param string $cacheKey
-     * @return CachedResponse|null
      * @throws \Psr\SimpleCache\InvalidArgumentException
      */
     public function get(string $cacheKey): ?CachedResponse
@@ -58,8 +51,6 @@ public function get(string $cacheKey): ?CachedResponse
     /**
      * Delete the cached response.
      *
-     * @param string $cacheKey
-     * @return void
      * @throws \Psr\SimpleCache\InvalidArgumentException
      */
     public function delete(string $cacheKey): void
diff --git a/src/Helpers/CacheKeyHelper.php b/src/Helpers/CacheKeyHelper.php
@@ -4,15 +4,13 @@
 
 namespace Saloon\CachePlugin\Helpers;
 
-use Saloon\Contracts\PendingRequest;
+use Saloon\Http\PendingRequest;
 
 class CacheKeyHelper
 {
     /**
      * Create a cache key from the request class name, URL, query and headers
      *
-     * @param \Saloon\Contracts\PendingRequest $pendingRequest
-     * @return string
      * @throws \JsonException
      */
     public static function create(PendingRequest $pendingRequest): string
diff --git a/src/Http/Middleware/CacheMiddleware.php b/src/Http/Middleware/CacheMiddleware.php
@@ -4,23 +4,19 @@
 
 namespace Saloon\CachePlugin\Http\Middleware;
 
-use Saloon\Contracts\Response;
-use Saloon\Contracts\PendingRequest;
+use Saloon\Http\Response;
+use Saloon\Enums\PipeOrder;
+use Saloon\Http\PendingRequest;
+use Saloon\Contracts\FakeResponse;
 use Saloon\Contracts\RequestMiddleware;
 use Saloon\CachePlugin\Contracts\Driver;
 use Saloon\CachePlugin\Data\CachedResponse;
 use Saloon\CachePlugin\Helpers\CacheKeyHelper;
-use Saloon\Contracts\SimulatedResponsePayload;
 
 class CacheMiddleware implements RequestMiddleware
 {
     /**
      * Constructor
-     *
-     * @param \Saloon\CachePlugin\Contracts\Driver $driver
-     * @param int $ttl
-     * @param string|null $cacheKey
-     * @param bool $invalidate
      */
     public function __construct(
         protected Driver  $driver,
@@ -34,11 +30,9 @@ public function __construct(
     /**
      * Handle the middleware
      *
-     * @param \Saloon\Contracts\PendingRequest $pendingRequest
-     * @return \Saloon\Contracts\SimulatedResponsePayload|null
      * @throws \JsonException
      */
-    public function __invoke(PendingRequest $pendingRequest): ?SimulatedResponsePayload
+    public function __invoke(PendingRequest $pendingRequest): ?FakeResponse
     {
         $driver = $this->driver;
         $cacheKey = hash('sha256', $this->cacheKey ?? CacheKeyHelper::create($pendingRequest));
@@ -53,9 +47,9 @@ public function __invoke(PendingRequest $pendingRequest): ?SimulatedResponsePayl
             // the SimulatedResponsePayload here.
 
             if ($this->invalidate === false && $cachedResponse->hasNotExpired()) {
-                $pendingRequest->middleware()->onResponse(fn (Response $response) => $response->setCached(true), true);
+                $pendingRequest->middleware()->onResponse(fn (Response $response) => $response->setCached(true), order: PipeOrder::FIRST);
 
-                return $cachedResponse->getSimulatedResponsePayload();
+                return $cachedResponse->getFakeResponse();
             }
 
             // However if it has expired we will delete it and register
@@ -70,7 +64,7 @@ public function __invoke(PendingRequest $pendingRequest): ?SimulatedResponsePayl
 
         $pendingRequest->middleware()->onResponse(
             callable: new CacheRecorderMiddleware($driver, $this->ttl, $cacheKey),
-            prepend: true,
+            order: PipeOrder::FIRST
         );
 
         return null;
diff --git a/src/Http/Middleware/CacheRecorderMiddleware.php b/src/Http/Middleware/CacheRecorderMiddleware.php
@@ -4,9 +4,9 @@
 
 namespace Saloon\CachePlugin\Http\Middleware;
 
-use Saloon\Helpers\Date;
-use Saloon\Contracts\Response;
-use Saloon\Helpers\ResponseRecorder;
+use DateTimeImmutable;
+use Saloon\Http\Response;
+use Saloon\Data\RecordedResponse;
 use Saloon\CachePlugin\Contracts\Driver;
 use Saloon\Contracts\ResponseMiddleware;
 use Saloon\CachePlugin\Data\CachedResponse;
@@ -15,10 +15,6 @@ class CacheRecorderMiddleware implements ResponseMiddleware
 {
     /**
      * Constructor
-     *
-     * @param \Saloon\CachePlugin\Contracts\Driver $driver
-     * @param int $ttl
-     * @param string $cacheKey
      */
     public function __construct(
         protected Driver $driver,
@@ -31,20 +27,19 @@ public function __construct(
     /**
      * Register a response middleware
      *
-     * @param \Saloon\Contracts\Response $response
-     * @return void
+     * @throws \Exception
      */
     public function __invoke(Response $response): void
     {
         if ($response->failed()) {
             return;
         }
 
-        $expiresAt = Date::now()->addSeconds($this->ttl)->toDateTime();
+        $expiresAt = new DateTimeImmutable('+' . $this->ttl .' seconds');
 
         $this->driver->set(
             key: $this->cacheKey,
-            cachedResponse: new CachedResponse(ResponseRecorder::record($response), $expiresAt, $this->ttl)
+            cachedResponse: new CachedResponse(RecordedResponse::fromResponse($response), $expiresAt, $this->ttl)
         );
     }
 }
diff --git a/src/Traits/HasCaching.php b/src/Traits/HasCaching.php
diff --git a/tests/Feature/CacheTest.php b/tests/Feature/CacheTest.php
diff --git a/tests/Fixtures/Requests/BodyCacheKeyRequest.php b/tests/Fixtures/Requests/BodyCacheKeyRequest.php
diff --git a/tests/Fixtures/Requests/CachedUserRequest.php b/tests/Fixtures/Requests/CachedUserRequest.php
diff --git a/tests/Fixtures/Requests/CachedUserRequestWithoutCacheable.php b/tests/Fixtures/Requests/CachedUserRequestWithoutCacheable.php
diff --git a/tests/Fixtures/Requests/CustomKeyCachedUserRequest.php b/tests/Fixtures/Requests/CustomKeyCachedUserRequest.php
