Merge pull request #168 from Sammyjo20/fix/allow-constructed-pending-requests-to-be-authenticated

Fix | Authenticate a PendingRequest after being constructed

Author: Sammyjo20

composer.json

@@ -33,8 +33,7 @@
         "pestphp/pest": "^1.21",
         "phpstan/phpstan": "^1.9",
         "spatie/ray": "^1.33",
-        "symfony/dom-crawler": "^6.0",
-        "symfony/stopwatch": "^6.2"
+        "symfony/dom-crawler": "^6.0"
     },
     "suggest": {
         "illuminate/collections": "Required for the response collect() method.",

src/Http/PendingRequest.php

@@ -16,6 +16,7 @@
 use Saloon\Traits\Conditionable;
 use Saloon\Traits\HasMockClient;
 use Saloon\Contracts\Body\HasBody;
+use Saloon\Contracts\Authenticator;
 use Saloon\Helpers\ReflectionHelper;
 use GuzzleHttp\Promise\PromiseInterface;
 use Saloon\Contracts\Body\BodyRepository;
@@ -93,6 +94,13 @@ class PendingRequest implements PendingRequestContract
      */
     protected bool $asynchronous = false;
 
+    /**
+     * Determines if the PendingRequest is ready to be sent
+     *
+     * @var bool
+     */
+    protected bool $ready = false;
+
     /**
      * Build up the request payload.
      *
@@ -134,10 +142,14 @@ public function __construct(Connector $connector, Request $request, MockClient $
 
         $this->registerDefaultMiddleware();
 
-        // Finally, we will execute the request middleware pipeline which will
+        // Next, we will execute the request middleware pipeline which will
         // process any middleware added on the connector or the request.
 
         $this->executeRequestPipeline();
+
+        // Finally, we'll mark our PendingRequest as ready.
+
+        $this->ready = true;
     }
 
     /**
@@ -504,4 +516,26 @@ public function isAsynchronous(): bool
     {
         return $this->asynchronous;
     }
+
+    /**
+     * Authenticate the PendingRequest
+     *
+     * @param \Saloon\Contracts\Authenticator $authenticator
+     * @return $this
+     */
+    public function authenticate(Authenticator $authenticator): static
+    {
+        $this->authenticator = $authenticator;
+
+        // If the PendingRequest has already been constructed, it would be nice
+        // for someone to be able to run the "authenticate" method after. This
+        // will allow us to do this. With future versions of Saloon we will
+        // likely remove this method.
+
+        if ($this->ready === true) {
+            $this->authenticator->set($this);
+        }
+
+        return $this;
+    }
 }

tests/Feature/RetryRequestTest.php

@@ -5,7 +5,7 @@
 use Saloon\Http\PendingRequest;
 use Saloon\Http\Faking\MockClient;
 use Saloon\Http\Faking\MockResponse;
-use Symfony\Component\Stopwatch\Stopwatch;
+use Saloon\Http\Auth\TokenAuthenticator;
 use Saloon\Exceptions\Request\RequestException;
 use Saloon\Tests\Fixtures\Requests\UserRequest;
 use Saloon\Tests\Fixtures\Connectors\TestConnector;
@@ -98,17 +98,14 @@
     $connector = new TestConnector;
     $connector->withMockClient($mockClient);
 
-    $stopwatch = new Stopwatch();
-    $stopwatch->start('sendAndRetry');
+    $start = microtime(true);
 
     $connector->sendAndRetry(new UserRequest, 3, 1000);
 
-    $duration = $stopwatch->stop('sendAndRetry')->getDuration();
-
     // It should be a duration of 2000ms (2 seconds) because the there are two requests
     // after the first.
 
-    expect(floor($duration / 1000) * 1000)->toBeGreaterThanOrEqual(2000);
+    expect(round(microtime(true) - $start))->toBeGreaterThanOrEqual(2);
 });
 
 test('an exception other than a request exception will not be retried', function () {
@@ -263,3 +260,23 @@
 
     $connector->sendAndRetry(new UserRequest, 0);
 });
+
+test('you can authenticate the pending request inside the retry handler', function () {
+    $mockClient = new MockClient([
+        MockResponse::make(['name' => 'Sam'], 401),
+        MockResponse::make(['name' => 'Gareth'], 200),
+    ]);
+
+    $connector = new TestConnector;
+    $connector->withMockClient($mockClient);
+
+    $response = $connector->sendAndRetry(new UserRequest, 2, 0, function (Exception $exception, PendingRequest $pendingRequest) {
+        $pendingRequest->authenticate(new TokenAuthenticator('newToken'));
+
+        return true;
+    });
+
+    expect($response->status())->toBe(200);
+    expect($response->json())->toEqual(['name' => 'Gareth']);
+    expect($response->getPendingRequest()->headers()->get('Authorization'))->toEqual('Bearer newToken');
+});

tests/Unit/AuthenticatorTest.php

@@ -7,6 +7,7 @@
 use Saloon\Http\Faking\MockResponse;
 use Saloon\Http\Auth\TokenAuthenticator;
 use Saloon\Tests\Fixtures\Requests\UserRequest;
+use Saloon\Tests\Fixtures\Connectors\TestConnector;
 use Saloon\Exceptions\MissingAuthenticatorException;
 use Saloon\Tests\Fixtures\Requests\RequiresAuthRequest;
 use Saloon\Tests\Fixtures\Authenticators\PizzaAuthenticator;
@@ -139,3 +140,19 @@
 
     expect($pendingRequest->headers()->get('Authorization'))->toEqual('Bearer yee-haw-request');
 });
+
+test('if you use the authenticate method on a fully constructed pending request it will authenticate right away', function () {
+    $connector = new TestConnector();
+    $pendingRequest = $connector->createPendingRequest(new UserRequest);
+
+    expect($pendingRequest->headers()->all())->toEqual([
+        'Accept' => 'application/json',
+    ]);
+
+    $pendingRequest->authenticate(new TokenAuthenticator('yee-haw-request'));
+
+    expect($pendingRequest->headers()->all())->toEqual([
+        'Accept' => 'application/json',
+        'Authorization' => 'Bearer yee-haw-request',
+    ]);
+});