Respect MockClient::shouldBypassResponseCache()

.github/workflows/php-cs-fixer.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.2'
+          php-version: '8.3'
 
       - name: Install Dependencies
         run: |

.github/workflows/tests.yml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ ubuntu-latest, windows-latest ]
-        php: [ 8.2, 8.3, 8.4 ]
+        php: [ 8.3, 8.4 ]
         stability: [ prefer-lowest, prefer-stable ]
 
     name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}

composer.json

@@ -17,8 +17,8 @@
     ],
     "minimum-stability": "stable",
     "require": {
-        "php": "^8.2",
-        "saloonphp/saloon": "^3.0 || ^4.0"
+        "php": "^8.3",
+        "saloonphp/saloon": "^4.1.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.13",

src/Http/Middleware/CacheMiddleware.php

@@ -34,6 +34,10 @@ public function __construct(
      */
     public function __invoke(PendingRequest $pendingRequest): ?FakeResponse
     {
+        if ($pendingRequest->getMockClient()?->shouldBypassResponseCache() === true) {
+            return null;
+        }
+
         $driver = $this->driver;
         $cacheKey = hash('sha256', $this->cacheKey ?? CacheKeyHelper::create($pendingRequest));
 

tests/Feature/ResponseCacheMockFixtureTest.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+use League\Flysystem\Filesystem;
+use Saloon\Http\Faking\MockClient;
+use Saloon\Http\Faking\MockResponse;
+use League\Flysystem\Local\LocalFilesystemAdapter;
+use Saloon\CachePlugin\Tests\Fixtures\Connectors\TestConnector;
+use Saloon\CachePlugin\Tests\Fixtures\Requests\CachedUserRequest;
+
+$filesystem = new Filesystem(new LocalFilesystemAdapter(cachePath()));
+
+beforeEach(function () use ($filesystem): void {
+    $filesystem->deleteDirectory('/');
+});
+
+function cachedUserRequestFixtureAbsolutePath(): string
+{
+    $dir = getcwd().'/tests/Fixtures/Saloon';
+
+    if (! is_dir($dir)) {
+        mkdir($dir, 0755, true);
+    }
+
+    return $dir.'/cached-user-request.json';
+}
+
+function writeCachedUserRequestFixture(int $version): void
+{
+    $payload = [
+        'statusCode' => 200,
+        'headers' => ['Content-Type' => ['application/json']],
+        'data' => json_encode(['version' => $version]),
+        'context' => [],
+    ];
+
+    file_put_contents(
+        cachedUserRequestFixtureAbsolutePath(),
+        json_encode($payload, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT)
+    );
+}
+
+test('response cache can return a stale body when mocks use fixtures and withoutCache is not used', function (): void {
+    writeCachedUserRequestFixture(1);
+
+    $mockClient = new MockClient([
+        CachedUserRequest::class => MockResponse::fixture('cached-user-request'),
+    ]);
+
+    $connector = TestConnector::make();
+
+    expect($connector->send(new CachedUserRequest, $mockClient)->json('version'))->toBe(1);
+
+    writeCachedUserRequestFixture(2);
+
+    expect($connector->send(new CachedUserRequest, $mockClient)->json('version'))->toBe(1);
+});
+
+test('withoutCache on the mock client skips response cache so updated fixture files are used', function (): void {
+    writeCachedUserRequestFixture(1);
+
+    $mockClient = (new MockClient([
+        CachedUserRequest::class => MockResponse::fixture('cached-user-request'),
+    ]))->withoutCache();
+
+    $connector = TestConnector::make();
+
+    expect($connector->send(new CachedUserRequest, $mockClient)->json('version'))->toBe(1);
+
+    writeCachedUserRequestFixture(2);
+
+    expect($connector->send(new CachedUserRequest, $mockClient)->json('version'))->toBe(2);
+});

tests/Fixtures/Saloon/cached-user-request.json

@@ -0,0 +1,10 @@
+{
+    "statusCode": 200,
+    "headers": {
+        "Content-Type": [
+            "application\/json"
+        ]
+    },
+    "data": "{\"version\":2}",
+    "context": []
+}