feat: introduce UnexpectedResponse exception

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Introduce UnexpectedResponse exception
+
 ## v0.34.0
 
 ### Changed

src/Error/UnexpectedResponse.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types=1);
+
+namespace Spawnia\Sailor\Error;
+
+use Psr\Http\Message\ResponseInterface;
+
+class UnexpectedResponse extends \Exception
+{
+    public int $statusCode = 0;
+
+    public string $responseBody = '';
+
+    /** @var array<string, list<string>> */
+    public array $responseHeaders;
+
+    public static function statusCode(
+        ResponseInterface $response
+    ): self {
+        $statusCode = $response->getStatusCode();
+        $responseBody = $response->getBody()->__toString();
+
+        $jsonEncodedHeaders = \Safe\json_encode($response->getHeaders(), JSON_PRETTY_PRINT);
+
+        $self = new self(
+            \Safe\sprintf(
+                "Unexpected HTTP status code received: %d. Reason: \n%s\nHeaders:\n"
+                . $jsonEncodedHeaders,
+                $statusCode,
+                $responseBody,
+            ),
+        );
+        $self->statusCode = $statusCode;
+        /** @phpstan-ignore assign.propertyType */
+        $self->responseHeaders = $response->getHeaders();
+        $self->responseBody = $responseBody;
+
+        return $self;
+    }
+}

src/Response.php

@@ -6,6 +6,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Safe\Exceptions\JsonException;
 use Spawnia\Sailor\Error\InvalidDataException;
+use Spawnia\Sailor\Error\UnexpectedResponse;
 
 /**
  * Represents a response sent by a GraphQL server.
@@ -29,10 +30,11 @@ class Response
     /** This entry, if set, must have a map as its value. */
     public ?\stdClass $extensions;
 
+    /** @throws UnexpectedResponse */
     public static function fromResponseInterface(ResponseInterface $response): self
     {
         if ($response->getStatusCode() !== 200) {
-            throw new InvalidDataException("Response must have status code 200, got: {$response->getStatusCode()}");
+            throw UnexpectedResponse::statusCode($response);
         }
 
         return self::fromJson(

tests/Unit/ResponseTest.php

@@ -6,6 +6,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 use Spawnia\Sailor\Error\InvalidDataException;
+use Spawnia\Sailor\Error\UnexpectedResponse;
 use Spawnia\Sailor\Response;
 use Spawnia\Sailor\Tests\TestCase;
 
@@ -33,10 +34,14 @@ public function testFromResponseInterfaceNon200(): void
     {
         /** @var MockObject&ResponseInterface $httpResponse */
         $httpResponse = self::createMock(ResponseInterface::class);
+        $httpResponse->method('getHeaders')
+            ->willReturn([]);
+        $httpResponse->method('getBody')
+            ->willReturn(self::createMock(StreamInterface::class));
         $httpResponse->method('getStatusCode')
             ->willReturn(500);
 
-        self::expectException(InvalidDataException::class);
+        self::expectException(UnexpectedResponse::class);
         Response::fromResponseInterface($httpResponse);
     }
 

tests/generate-and-approve-examples.php

@@ -12,5 +12,5 @@
     shell_exec("rm -rf {$expectedPath}");
 
     $generatedPath = Examples::generatedPath($example);
-    shell_exec("cp --recursive {$generatedPath} {$expectedPath}");
+    shell_exec("cp -R {$generatedPath} {$expectedPath}");
 }