PhpStorm warns about unhandled GuzzleException #2184

gugglegum · 2018-10-31T09:32:45Z

Q	A
Bug?	no
New Feature?	no
Version	6.3.3

Not a bug, just inconvenience in development. The PhpStorm IDE has built-in code analysis and it warns on my code which uses (new GuzzleHttp())->send() method without catching GuzzleException exeption. But I'm catching ClientException and RequestException instead and I think this should be enough. Here's my code:

    /**
     * @param Request $request
     * @return Response
     */
    protected function executeRequest(Request $request): Response
    {
        $this->lastRequest = $request;
        try {
            $this->lastResponse = (new GuzzleHttp())->send($request, $this->getRequestOptions());
        } catch (ClientException $e) {
            $this->lastResponse = $e->getResponse();
            throw new FatalException($this->getExceptionMessage($e));
        } catch (RequestException $e) {
            $this->lastResponse = $e->getResponse();
            throw new Exception($this->getExceptionMessage($e));
        }
        return $this->lastResponse;
    }

PhpStorm wants me to add yet another catch section with GuzzleException (which is not exception actually, just interface) or to add:

     * @throws \GuzzleHttp\Exception\GuzzleException

in PhpDoc of my method.

The problem is going from ClientInterface where PhpDoc describes that it @throws GuzzleException:

    /**
     * Send an HTTP request.
     *
     * @param RequestInterface $request Request to send
     * @param array            $options Request options to apply to the given
     *                                  request and to the transfer.
     *
     * @return ResponseInterface
     * @throws GuzzleException
     */
    public function send(RequestInterface $request, array $options = []);

and concrete implementation Client doesn't have PhpDoc at all:


    public function send(RequestInterface $request, array $options = [])
    {
        $options[RequestOptions::SYNCHRONOUS] = true;
        return $this->sendAsync($request, $options)->wait();
    }

This is why PhpStorm takes throwing exceptions from interface. Please add PhpDoc to Client::send() method. This will override @throws tag in the interface and fix the problem.

I think that declaring in PhpDoc @throws tag the class which is not descendant of \Exception class is anti-pattern and bad practice. It forces developers to catch this exception which is not exception. Make GuzzleException abstract class extending from \RuntimeException and inherit from it all other classes if needed or not use it in @throws tags.

Actually you don't need to declare @throws tags since all your exceptions are inherited from \RuntimeException. This kind of exceptions that can happen almost anywhere and you can but don't have to catch it everywhere. This is why you don't need to add it in PhpDoc. This logic is taken from Java. In the Java only RuntimeException can be not catched. Otherwise the code will not compile.

The text was updated successfully, but these errors were encountered:

Jalle19 · 2018-11-07T12:14:29Z

Big +1 on this. Since it's not possible to throw anything that isn't a \Throwable it's simply wrong to say you throw a random interface.

filipp-kucheriavenko · 2018-11-20T17:31:07Z

+1
\GuzzleHttp\Exception\GuzzleException should extend \Throwable

koderoff · 2019-01-13T23:00:52Z

+1

GrahamCampbell · 2019-01-14T00:41:50Z

Can't extend throwable because guzzle needs to support php 5 still.

Jalle19 · 2019-01-15T09:07:53Z

It would probably be enough to extend \Exception

likemute · 2019-01-30T11:36:37Z

+1

JohJohan · 2019-02-21T11:21:57Z

+1

nickdnk · 2019-02-28T01:35:51Z

+1 - so tired of "Unhandled exception" warnings and @throws \Throwable

gabi77 · 2019-05-06T07:33:26Z

+1 Warning: include(Throwable.php): failed to open stream: No such file or directory

Version php 5.6.
Throwable extension is only for php7
it would be necessary to test the php version or the existence of the class Throwable for used Throwable

karser · 2019-05-31T22:33:45Z

Can't extend throwable because guzzle needs to support php 5 still.

According to the packagist 2019.1 PHP Versions Stats, PHP 5 usage across all versions is now around 10%.

JohJohan · 2019-06-01T06:51:18Z

Cant we lock a version for PHP 5.6 support and then drop support and extended \Exception?

panvid · 2019-07-17T08:46:03Z

+1

There is already a fix, that prevents the problem with PHP 5.x (if you use this version, you are not a PHP developer, dude):

Ticket: #2184
With the commit: e21a982

Now keep focus on this ticket.

FunTimeCoding · 2019-07-31T18:59:24Z

+1

numediaweb · 2019-08-20T14:54:21Z

+1

VincentLanglet · 2019-11-27T12:13:02Z

Extending Throwable is not enough.
We still need to catch both \Exception and GuzzleException.

GuzzleException should have been a class extending \Exception instead of an interface extending \Throwable

stale · 2020-09-25T15:54:32Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed after 2 weeks if no further activity occurs. Thank you for your contributions.

gdespaux · 2021-03-17T03:03:54Z

What's the status of this? Searches show nothing helpful and this is still happening for me in PhpStorm 2020.3.2

Did I miss the fix somewhere, have I done something wrong?

gmponos mentioned this issue Nov 13, 2018

GuzzleException should extend Throwable #2196

Closed

nickdnk mentioned this issue Aug 26, 2019

Modernize exceptions stripe/stripe-php#709

Merged

stale bot added the lifecycle/stale No activity for a long time label Sep 25, 2020

stale bot closed this as completed Oct 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PhpStorm warns about unhandled GuzzleException #2184

PhpStorm warns about unhandled GuzzleException #2184

gugglegum commented Oct 31, 2018

Jalle19 commented Nov 7, 2018

filipp-kucheriavenko commented Nov 20, 2018 •

edited

Loading

koderoff commented Jan 13, 2019

GrahamCampbell commented Jan 14, 2019

Jalle19 commented Jan 15, 2019

likemute commented Jan 30, 2019

JohJohan commented Feb 21, 2019

nickdnk commented Feb 28, 2019

gabi77 commented May 6, 2019

karser commented May 31, 2019

JohJohan commented Jun 1, 2019

panvid commented Jul 17, 2019 •

edited

Loading

FunTimeCoding commented Jul 31, 2019

numediaweb commented Aug 20, 2019

VincentLanglet commented Nov 27, 2019

stale bot commented Sep 25, 2020

gdespaux commented Mar 17, 2021

PhpStorm warns about unhandled GuzzleException #2184

PhpStorm warns about unhandled GuzzleException #2184

Comments

gugglegum commented Oct 31, 2018

Jalle19 commented Nov 7, 2018

filipp-kucheriavenko commented Nov 20, 2018 • edited Loading

koderoff commented Jan 13, 2019

GrahamCampbell commented Jan 14, 2019

Jalle19 commented Jan 15, 2019

likemute commented Jan 30, 2019

JohJohan commented Feb 21, 2019

nickdnk commented Feb 28, 2019

gabi77 commented May 6, 2019

karser commented May 31, 2019

JohJohan commented Jun 1, 2019

panvid commented Jul 17, 2019 • edited Loading

FunTimeCoding commented Jul 31, 2019

numediaweb commented Aug 20, 2019

VincentLanglet commented Nov 27, 2019

stale bot commented Sep 25, 2020

gdespaux commented Mar 17, 2021

filipp-kucheriavenko commented Nov 20, 2018 •

edited

Loading

panvid commented Jul 17, 2019 •

edited

Loading