Merge pull request #282 from saloonphp/feature/prevent-stray-requests

Feature | V2 Prevent Stray Requests

src/Exceptions/StrayRequestException.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Saloon\Exceptions;
+
+class StrayRequestException extends SaloonException
+{
+    public function __construct()
+    {
+        parent::__construct('Attempted to make a real API request! Make sure to use a mock response or fixture.');
+    }
+}

src/Helpers/Config.php

@@ -5,7 +5,9 @@
 namespace Saloon\Helpers;
 
 use Saloon\Contracts\Sender;
+use Saloon\Contracts\PendingRequest;
 use Saloon\Http\Senders\GuzzleSender;
+use Saloon\Exceptions\StrayRequestException;
 use Saloon\Contracts\MiddlewarePipeline as MiddlewarePipelineContract;
 
 final class Config
@@ -101,4 +103,18 @@ public static function resetDefaultSender(): void
     {
         self::$defaultSender = self::DEFAULT_SENDER;
     }
+
+    /**
+     * Throw an exception if a request without a MockClient is made.
+     *
+     * @return void
+     */
+    public static function preventStrayRequests(): void
+    {
+        self::middleware()->onRequest(static function (PendingRequest $pendingRequest) {
+            if (! $pendingRequest->hasMockClient()) {
+                throw new StrayRequestException;
+            }
+        });
+    }
 }

tests/Unit/ConfigTest.php

@@ -8,6 +8,7 @@
 use Saloon\Http\Faking\MockClient;
 use Saloon\Http\Faking\MockResponse;
 use Saloon\Http\Senders\GuzzleSender;
+use Saloon\Exceptions\StrayRequestException;
 use Saloon\Tests\Fixtures\Senders\ArraySender;
 use Saloon\Tests\Fixtures\Requests\UserRequest;
 use Saloon\Tests\Fixtures\Connectors\TestConnector;
@@ -68,3 +69,14 @@
 
     expect($sender)->toBeInstanceOf(GuzzleSender::class);
 });
+
+test('you can prevent stray api requests', function () {
+    Config::preventStrayRequests();
+
+    $this->expectException(StrayRequestException::class);
+    $this->expectExceptionMessage('Attempted to make a real API request! Make sure to use a mock response or fixture.');
+
+    TestConnector::make()->send(new UserRequest);
+
+    Config::resetMiddleware();
+});