expose/tests/Feature/Client/DashboardTest.php

<?php

namespace Tests\Feature\Client;

use App\Client\Factory;
use App\Client\Http\HttpClient;
use App\Logger\LoggedRequest;
use App\Logger\RequestLogger;
use Clue\React\Buzz\Browser;
use Clue\React\Buzz\Message\ResponseException;
use GuzzleHttp\Psr7\Request;
use function GuzzleHttp\Psr7\str;
use Mockery as m;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Tests\Feature\TestCase;

class DashboardTest extends TestCase
{
    /** @var Browser */
    protected $browser;

    /** @var Factory */
    protected $dashboardFactory;

    /** @var RequestLogger */
    protected $requestLogger;

    public function setUp(): void
    {
        parent::setUp();

        $this->browser = new Browser($this->loop);
        $this->requestLogger = $this->app->make(RequestLogger::class);
    }

    public function tearDown(): void
    {
        parent::tearDown();

        $this->dashboardFactory->getApp()->close();
    }

    /** @test */
    public function accessing_the_dashboard_works()
    {
        $this->startDashboard();

        /** @var ResponseInterface $response */
        $response = $this->await($this->browser->get('http://127.0.0.1:4040'));

        $this->assertSame(200, $response->getStatusCode());
    }

    /** @test */
    public function it_can_replay_requests()
    {
        $request = new Request('GET', '/example', [
            'X-Expose-Request-ID' => 'request-one',
        ]);

        $httpClient = m::mock(HttpClient::class);
        $httpClient->shouldReceive('performRequest')
            ->once()
            ->with(str($request));

        app()->instance(HttpClient::class, $httpClient);

        $this->startDashboard();

        $this->logRequest($request);

        $this->assertSame(200,
            $this->await($this->browser->get('http://127.0.0.1:4040/api/replay/request-one'))
                ->getStatusCode()
        );
    }

    /** @test */
    public function it_returns_404_for_non_existing_replay_logs()
    {
        $this->startDashboard();

        $this->expectException(ResponseException::class);
        $this->expectExceptionMessage(404);

        $this->await($this->browser->get('http://127.0.0.1:4040/api/replay/invalid-request'));
    }

    /** @test */
    public function it_can_clear_logs()
    {
        $this->startDashboard();

        $this->logRequest(new Request('GET', '/foo'));
        $this->logRequest(new Request('POST', '/bar'));
        $this->logRequest(new Request('DELETE', '/baz'));

        $this->assertCount(3, $this->requestLogger->getData());

        $this->await($this->browser->get('http://127.0.0.1:4040/api/logs/clear'));
        $this->assertCount(0, $this->requestLogger->getData());
    }

    /** @test */
    public function it_can_attach_additional_data_to_requests()
    {
        $this->startDashboard();

        $loggedRequest = $this->logRequest(new Request('GET', '/foo'));

        $this->await($this->browser->post("http://127.0.0.1:4040/api/logs/{$loggedRequest->id()}/data", [
            'Content-Type' => 'application/json',
        ], json_encode([
            'data' => [
                'foo' => 'bar',
            ],
        ])));

        $this->assertSame([
            'foo' => 'bar',
        ], $this->requestLogger->findLoggedRequest($loggedRequest->id())->getAdditionalData());
    }

    protected function logRequest(RequestInterface $request): LoggedRequest
    {
        return $this->requestLogger->logRequest(str($request), \Laminas\Http\Request::fromString(str($request)));
    }

    protected function startDashboard()
    {
        $this->dashboardFactory = (new Factory())
            ->setLoop($this->loop)
            ->createHttpServer();
    }
}