fix(mock-server): fix mock response handling for 204 and 201 status codes

Author: Fahl-Design

data/openapi.yaml

@@ -41,6 +41,42 @@ paths:
               example:
                 id: 1
                 name: Alice
+  /users/{id}/tasks:
+    post:
+      summary: Create a task for a user (async)
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/TaskInput'
+      responses:
+        '202':
+          description: Task accepted for processing
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TaskAccepted'
+              example:
+                taskId: abc-123
+                status: pending
+    delete:
+      summary: Delete all tasks for a user
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        '204':
+          description: Tasks deleted successfully
 components:
   schemas:
     User:
@@ -50,3 +86,17 @@ components:
           type: integer
         name:
           type: string
+    TaskInput:
+      type: object
+      properties:
+        title:
+          type: string
+      required:
+        - title
+    TaskAccepted:
+      type: object
+      properties:
+        taskId:
+          type: string
+        status:
+          type: string

src/Middleware/MockMiddleware/Faker/OpenAPIFaker.php

@@ -165,6 +165,20 @@ public function setOptions(array $options): self
         return $this;
     }
 
+    public function hasResponse(
+        string $path,
+        string $method,
+        string $statusCode = '200',
+    ): bool {
+        try {
+            $operation = $this->findOperation($path, HttpMethod::fromString($method));
+        } catch (NoPath) {
+            return false;
+        }
+
+        return $operation->responses !== null && $operation->responses->hasResponse($statusCode);
+    }
+
     /**
      * @return list<string>
      */

src/Middleware/MockMiddleware/Request/RequestHandler.php

@@ -5,21 +5,26 @@
 namespace WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Request;
 
 use cebe\openapi\spec\OpenApi;
-use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Exception\RoutingException;
-use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Exception\SecurityException;
-use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Exception\ValidationException;
-use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Response\ResponseFaker;
-use Exception;
-use InvalidArgumentException;
 use League\OpenAPIValidation\PSR7\Exception\NoOperation;
 use League\OpenAPIValidation\PSR7\Exception\NoPath;
 use League\OpenAPIValidation\PSR7\Exception\NoResponseCode;
 use League\OpenAPIValidation\PSR7\Exception\Validation\InvalidSecurity;
 use League\OpenAPIValidation\PSR7\Exception\ValidationFailed;
 use League\OpenAPIValidation\PSR7\OperationAddress;
+use League\OpenAPIValidation\PSR7\SpecFinder;
 use Psr\Http\Message\ResponseInterface;
 use Throwable;
+use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Exception\RoutingException;
+use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Exception\SecurityException;
+use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Exception\ValidationException;
 use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Faker\Exception\NoPath as FakerNoPath;
+use WebProject\PhpOpenApiMockServer\Middleware\MockMiddleware\Response\ResponseFaker;
+
+use function array_keys;
+use function preg_match;
+use function sort;
+
+use InvalidArgumentException;
 
 class RequestHandler
 {
@@ -39,7 +44,13 @@ public function handleValidRequest(
         ?string $statusCode = null,
         ?string $exampleName = null
     ): ResponseInterface {
-        return $this->responseFaker->mock($openApi, $operationAddress, $statusCode ?? ['200', '201'], $acceptedContentTypes, $exampleName);
+        return $this->responseFaker->mock(
+            $openApi,
+            $operationAddress,
+            $statusCode ?? $this->getSuccessStatusCodes($openApi, $operationAddress),
+            $acceptedContentTypes,
+            $exampleName
+        );
     }
 
     /**
@@ -133,4 +144,45 @@ public function handleValidationFailedRequest(
             return $this->responseFaker->handleException(ValidationException::forUnprocessableEntity($throwable), $acceptedContentTypes[0] ?? 'application/json');
         }
     }
+
+    /**
+     * Extract all 2xx status codes defined in the spec for the given operation,
+     * sorted ascending. Falls back to ['200', '201'] if none are found.
+     *
+     * @return list<string>
+     */
+    private function getSuccessStatusCodes(OpenApi $openApi, OperationAddress $operationAddress): array
+    {
+        try {
+            $operation = (new SpecFinder($openApi))
+                ->findOperationSpec($operationAddress);
+        } catch (Throwable) {
+            return ['200', '201'];
+        }
+
+        if ($operation->responses === null) {
+            return ['200', '201'];
+        }
+
+        $codes = [];
+        foreach (array_keys($operation->responses->getResponses()) as $code) {
+            $code = (string) $code;
+            if (preg_match('/^2\d{2}$/', $code) === 1) {
+                $codes[] = $code;
+            }
+        }
+
+        sort($codes);
+
+        if ($codes === []) {
+            // No 2xx codes defined, check for 'default' response
+            if ($operation->responses->hasResponse('default')) {
+                return ['default'];
+            }
+
+            return ['200', '201'];
+        }
+
+        return $codes;
+    }
 }

src/Middleware/MockMiddleware/Response/ResponseFaker.php

@@ -112,6 +112,10 @@ private function mockResponse(
         $path   = $operationAddress->path();
         $method = $operationAddress->method();
 
+        if ($this->isNoContentResponse($openAPIFaker, $path, $method, $statusCode)) {
+            return $this->responseFactory->createResponse((int) $statusCode);
+        }
+
         $contentType = $this->negotiateContentType($openAPIFaker, $path, $method, $statusCode, $acceptedContentTypes);
 
         $fakeData = null !== $exampleName
@@ -154,6 +158,22 @@ private function negotiateContentType(
         return $availableTypes[0];
     }
 
+    /**
+     * Check if the response exists in the spec but defines no content (e.g. 204 No Content).
+     */
+    private function isNoContentResponse(
+        OpenAPIFaker $openAPIFaker,
+        string $path,
+        string $method,
+        string $statusCode,
+    ): bool {
+        if (! $openAPIFaker->hasResponse($path, $method, $statusCode)) {
+            return false;
+        }
+
+        return $openAPIFaker->getAvailableResponseContentTypes($path, $method, $statusCode) === [];
+    }
+
     private function createFaker(OpenApi $openApi): OpenAPIFaker
     {
         if ($this->openAPIFaker instanceof OpenAPIFaker) {

tests/Acceptance/MockServerCest.php

@@ -48,6 +48,23 @@ public function testNotFoundInSpecButExistsInMezzio(AcceptanceTester $acceptance
         $acceptanceTester->seeResponseContainsJson(['message' => 'OpenAPI Mock Server is running!']);
     }
 
+    public function testPostReturns202Accepted(AcceptanceTester $acceptanceTester): void
+    {
+        $acceptanceTester->haveHttpHeader('Content-Type', 'application/json');
+        $acceptanceTester->sendPost('/users/1/tasks', ['title' => 'My Task']);
+        $acceptanceTester->seeResponseCodeIs(202);
+        $acceptanceTester->seeResponseIsJson();
+
+        $response = json_decode($acceptanceTester->grabResponse(), true);
+        $acceptanceTester->assertIsArray($response);
+    }
+
+    public function testDeleteReturns204NoContent(AcceptanceTester $acceptanceTester): void
+    {
+        $acceptanceTester->sendDelete('/users/1/tasks');
+        $acceptanceTester->seeResponseCodeIs(204);
+    }
+
     public function testDisableMockViaHeader(AcceptanceTester $acceptanceTester): void
     {
         // If we explicitly set it to false, it should fall through to Mezzio's root handler