GuzzleSenderTest.php

<?php

declare(strict_types=1);

use GuzzleHttp\Utils;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Uri;
use Illuminate\Support\Arr;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Psr7\Response;
use Saloon\Http\Senders\GuzzleSender;
use Psr\Http\Message\RequestInterface;
use GuzzleHttp\Promise\FulfilledPromise;
use Saloon\Tests\Fixtures\Requests\UserRequest;
use Saloon\Tests\Fixtures\Connectors\TestConnector;

test('the guzzle sender will send to the right url using the correct method', function () {
    $connector = new TestConnector;
    $request = new UserRequest;
    $sender = $connector->sender();

    $pendingRequest = $connector->createPendingRequest($request);

    $sender->addMiddleware(function (callable $handler) use ($pendingRequest) {
        return function (RequestInterface $request, array $options) use ($handler, $pendingRequest) {
            expect($request->getMethod())->toEqual($pendingRequest->getMethod()->value);

            $uri = $request->getUri();
            $saloonUri = new Uri($pendingRequest->getUrl());

            expect($uri)->toEqual($saloonUri);

            // Return fulfilled promise to fake response

            return new FulfilledPromise(new Response());
        };
    });

    $connector->send($request);
});

test('the guzzle sender will send all headers, query parameters and config', function () {
    $connector = connector();
    $request = new UserRequest;

    $request->config()->add('timeout', 120);
    $request->config()->add('debug', true);
    $request->query()->add('shanty', 'yes');
    $request->query()->add('sing', 'yes');
    $request->headers()->add('X-Bound-For', 'South-Australia');
    $request->headers()->add('X-Fancy', ['keyOne' => 'valOne', 'keyTwo' => 'valTwo']);

    $sender = $connector->sender();

    $sender->addMiddleware(function (callable $handler) {
        return function (RequestInterface $request, array $options) use ($handler) {
            expect($options['timeout'])->toEqual(120);
            expect($options['debug'])->toBeTrue();
            expect($request->getUri()->getQuery())->toEqual('shanty=yes&sing=yes');
            expect($request->getHeaderLine('X-Bound-For'))->toEqual('South-Australia');
            expect($request->getHeaderLine('X-Fancy'))->toEqual('valOne, valTwo');

            // Return fulfilled promise to fake response

            return new FulfilledPromise(new Response());
        };
    });

    $connector->send($request);
});

test('the guzzle sender has the default handler stack configured by default', function () {
    $connector = new TestConnector;
    $sender = $connector->sender();

    expect($sender)->toBeInstanceOf(GuzzleSender::class);

    $handlerStack = $sender->getHandlerStack();

    $saloonStack = invade($handlerStack)->stack;
    $defaultStack = invade(HandlerStack::create())->stack;

    expect($saloonStack)->toHaveSameSize($defaultStack)->toHaveCount(4);

    expect($saloonStack[0][1])->toBe($defaultStack[0][1]);
    expect($saloonStack[1][1])->toBe($defaultStack[1][1]);
    expect($saloonStack[2][1])->toBe($defaultStack[2][1]);
    expect($saloonStack[3][1])->toBe($defaultStack[3][1]);

    expect($saloonStack[0][0])->toBeCallable();
    expect($saloonStack[1][0])->toBeCallable();
    expect($saloonStack[2][0])->toBeCallable();
    expect($saloonStack[3][0])->toBeCallable();
});

test('the guzzle sender has default options configured', function () {
    $connector = new TestConnector;
    $sender = $connector->sender();

    expect($sender)->toBeInstanceOf(GuzzleSender::class);

    $client = $sender->getGuzzleClient();

    $freshClient = new Client([
        'connect_timeout' => 10,
        'timeout' => 30,
        'http_errors' => true,
        'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT,
    ]);

    $saloonConfig = $client->getConfig();
    $defaultConfig = $freshClient->getConfig();

    expect(Arr::except($saloonConfig, 'handler'))->toEqual(Arr::except($defaultConfig, 'handler'));

    $saloonStack = invade($saloonConfig['handler'])->stack;
    $defaultStack = invade($defaultConfig['handler'])->stack;

    expect($saloonStack)->toHaveSameSize($defaultStack)->toHaveCount(4);
});

test('you can set a custom handler stack on the guzzle sender', function () {
    $connector = new TestConnector;
    $sender = $connector->sender();

    $handlerStack = new HandlerStack(Utils::chooseHandler());

    $sender->setHandlerStack($handlerStack);

    expect($sender->getHandlerStack())->toBe($handlerStack);
});