Skip to content

fix: handle drained response streams in api decoding #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tharropoulos merged 2 commits into from
Apr 23, 2026
Merged

fix: handle drained response streams in api decoding #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b9ac2f
test: cover drained response bodies without retrying
tharropoulos Apr 23, 2026
e0b240c
fix(api-call): read full response bodies before decoding
tharropoulos Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/ApiCall.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,7 @@ private function makeRequest(string $method, string $endPoint, bool $asJson, arr
$this->setNodeHealthCheck($node, true);
}

$responseContents = $response->getBody()
->getContents();
$responseContents = (string) $response->getBody();

if (!(200 <= $statusCode && $statusCode < 300)) {
try {
Expand Down
85 changes: 55 additions & 30 deletions tests/Feature/ApiCallRetryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@

class ApiCallRetryTest extends TestCase
{
private function createJsonResponseMock(string $json, int $statusCode = 200): ResponseInterface
{
$stream = $this->createMock(StreamInterface::class);
$stream->method('__toString')->willReturn($json);
$stream->method('getContents')->willReturn($json);

$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn($statusCode);
$response->method('getBody')->willReturn($stream);

return $response;
}

public function testRetriesOnHttpExceptionWithNon408Status(): void
{
$callCount = 0;
Expand All @@ -33,12 +46,7 @@ public function testRetriesOnHttpExceptionWithNon408Status(): void
$response->method('getStatusCode')->willReturn(500);
throw new HttpException('Server error', $this->createMock(RequestInterface::class), $response);
} else {
$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);
$stream = $this->createMock(StreamInterface::class);
$stream->method('getContents')->willReturn('{"success": true}');
$response->method('getBody')->willReturn($stream);
return $response;
return $this->createJsonResponseMock('{"success": true}');
}
});

Expand Down Expand Up @@ -109,12 +117,7 @@ public function testRetriesOnTypesenseClientError(): void
if ($callCount < $expectedCalls) {
throw new RequestMalformed('Bad request');
} else {
$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);
$stream = $this->createMock(StreamInterface::class);
$stream->method('getContents')->willReturn('{"success": true}');
$response->method('getBody')->willReturn($stream);
return $response;
return $this->createJsonResponseMock('{"success": true}');
}
});

Expand Down Expand Up @@ -152,12 +155,7 @@ public function testRetriesOnHttpClientException(): void
if ($callCount < $expectedCalls) {
throw new TransferException('Connection error');
} else {
$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);
$stream = $this->createMock(StreamInterface::class);
$stream->method('getContents')->willReturn('{"success": true}');
$response->method('getBody')->willReturn($stream);
return $response;
return $this->createJsonResponseMock('{"success": true}');
}
});

Expand Down Expand Up @@ -198,12 +196,7 @@ public function testSkips408TimeoutErrorsAndContinuesRetrying(): void
$response->method('getStatusCode')->willReturn(500);
throw new HttpException('Server error', $this->createMock(RequestInterface::class), $response);
} else {
$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);
$stream = $this->createMock(StreamInterface::class);
$stream->method('getContents')->willReturn('{"success": true}');
$response->method('getBody')->willReturn($stream);
return $response;
return $this->createJsonResponseMock('{"success": true}');
}
});

Expand Down Expand Up @@ -384,12 +377,7 @@ public function test408ErrorsAreSkippedAndRetryingContinues(): void
$response->method('getStatusCode')->willReturn(408);
throw new HttpException('Request timeout', $this->createMock(RequestInterface::class), $response);
} else {
$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);
$stream = $this->createMock(StreamInterface::class);
$stream->method('getContents')->willReturn('{"success": true}');
$response->method('getBody')->willReturn($stream);
return $response;
return $this->createJsonResponseMock('{"success": true}');
}
});

Expand Down Expand Up @@ -475,6 +463,7 @@ public function testThrowsTypesenseClientErrorWhenSuccessResponseContainsInvalid
$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);
$stream = $this->createMock(StreamInterface::class);
$stream->method('__toString')->willReturn('{invalid json');
$stream->method('getContents')->willReturn('{invalid json');
$response->method('getBody')->willReturn($stream);
return $response;
Expand All @@ -500,4 +489,40 @@ public function testThrowsTypesenseClientErrorWhenSuccessResponseContainsInvalid
$this->assertInstanceOf(JsonException::class, $exception->getPrevious());
}
}

public function testDrainedResponseBodyStillDecodesWithoutRetrying(): void
{
$callCount = 0;

$stream = $this->createMock(StreamInterface::class);
$stream->method('__toString')->willReturn('{"ok": true}');
$stream->method('getContents')->willReturn('');

$response = $this->createMock(ResponseInterface::class);
$response->method('getStatusCode')->willReturn(200);
$response->method('getBody')->willReturn($stream);

$httpClient = $this->createMock(ClientInterface::class);
$httpClient->method('sendRequest')
->willReturnCallback(function() use (&$callCount, $response) {
$callCount++;

return $response;
});

$config = new Configuration([
'api_key' => 'test-key',
'nodes' => [
['host' => 'node1', 'port' => 8108, 'protocol' => 'http']
],
'client' => $httpClient
]);

$apiCall = new ApiCall($config);

$result = $apiCall->get('/health', []);

$this->assertSame(['ok' => true], $result);
$this->assertSame(1, $callCount);
}
}
Loading