Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitef2613f

Browse files
committed
minor#19997 [HttpClient] Explain how to mockTransportExceptions that occur before headers are received (mpdude)
This PR was squashed before being merged into the 6.4 branch.Discussion----------[HttpClient] Explain how to mock `TransportExceptions` that occur before headers are receivedThe `error` option value was previously undocumented.Seesymfony/symfony#57081 (comment) for the discussion leading to this.PR based on 6.4 since the section was not yet present in 5.4 docs.Commits-------6fde4e0 [HttpClient] Explain how to mock `TransportExceptions` that occur before headers are received
2 parents9256f12 +6fde4e0 commitef2613f

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

‎http_client.rst‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2282,7 +2282,26 @@ when making HTTP requests you might face errors at transport level.
22822282

22832283
That's why it's useful to test how your application behaves in case of a transport
22842284
error.:class:`Symfony\\Component\\HttpClient\\Response\\MockResponse` allows
2285-
you to do so, by yielding the exception from its body::
2285+
you to do so in multiple ways.
2286+
2287+
In order to test errors that occur before headers have been received,
2288+
set the ``error`` option value when creating the ``MockResponse``.
2289+
Transport errors of this kind occur, for example, when a host name
2290+
cannot be resolved or the host was unreachable. The
2291+
``TransportException`` will be thrown as soon as a method like
2292+
``getStatusCode()`` or ``getHeaders()`` is called.
2293+
2294+
In order to test errors that occur while a response is being streamed
2295+
(that is, after the headers have already been received), provide the
2296+
exception to ``MockResponse`` as part of the ``body``
2297+
parameter. You can either use an exception directly, or yield the
2298+
exception from a callback. For exceptions of this kind,
2299+
``getStatusCode()`` may indicate a success (200), but accessing
2300+
``getContent()`` fails.
2301+
2302+
The following example code illustrates all three options.
2303+
2304+
body::
22862305

22872306
// ExternalArticleServiceTest.php
22882307
use PHPUnit\Framework\TestCase;
@@ -2297,10 +2316,16 @@ you to do so, by yielding the exception from its body::
22972316
{
22982317
$requestData = ['title' => 'Testing with Symfony HTTP Client'];
22992318
$httpClient = new MockHttpClient([
2300-
// You can create the exception directly in the body...
2319+
// Mock a transport level error at a time before
2320+
// headers have been received (e. g. host unreachable)
2321+
new MockResponse(info: ['error' => 'host unreachable']),
2322+
2323+
// Mock a response with headers indicating
2324+
// success, but a failure while retrieving the body by
2325+
// creating the exception directly in the body...
23012326
new MockResponse([new \RuntimeException('Error at transport level')]),
23022327

2303-
// ... oryou can yield the exceptionfrom a callback
2328+
// ... orby yielding itfrom a callback.
23042329
new MockResponse((static function (): \Generator {
23052330
yield new TransportException('Error at transport level');
23062331
})()),

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp