feat: add support for Guzzle 8

Signed-off-by: Graham Campbell <hello@gjcampbell.co.uk>

Author: GrahamCampbell

composer.json

@@ -13,8 +13,8 @@
         "google/apiclient-services": "~0.350",
         "firebase/php-jwt": "^6.0||^7.0",
         "monolog/monolog": "^2.9||^3.0",
-        "guzzlehttp/guzzle": "^7.4.5",
-        "guzzlehttp/psr7": "^2.6"
+        "guzzlehttp/guzzle": "^7.8.2||^8.0",
+        "guzzlehttp/psr7": "^2.6.3||^3.0"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.8",

phpstan.neon.dist

@@ -3,3 +3,11 @@ parameters:
     level: 5
     paths:
     - src
+    ignoreErrors:
+        # On Guzzle 7 the base RequestException has getResponse(), so the
+        # method_exists() guard is statically true; it stays for the Guzzle 8
+        # code path, where the response lives only on the ResponseException
+        # subclass.
+        -
+            message: '#^Call to function method_exists\(\) with GuzzleHttp\\Exception\\RequestException and ''getResponse'' will always evaluate to true\.$#'
+            path: src/Http/REST.php

src/AuthHandler/AuthHandlerFactory.php

@@ -30,17 +30,9 @@ class AuthHandlerFactory
      */
     public static function build($cache = null, array $cacheConfig = [])
     {
-        $guzzleVersion = null;
-        if (defined('\GuzzleHttp\ClientInterface::MAJOR_VERSION')) {
-            $guzzleVersion = ClientInterface::MAJOR_VERSION;
-        } elseif (defined('\GuzzleHttp\ClientInterface::VERSION')) {
-            $guzzleVersion = (int) substr(ClientInterface::VERSION, 0, 1);
-        }
-
-        switch ($guzzleVersion) {
-            case 6:
-                return new Guzzle6AuthHandler($cache, $cacheConfig);
+        switch (ClientInterface::MAJOR_VERSION) {
             case 7:
+            case 8:
                 return new Guzzle7AuthHandler($cache, $cacheConfig);
             default:
                 throw new Exception('Version not supported');

src/AuthHandler/Guzzle6AuthHandler.php

@@ -13,7 +13,7 @@
 use Psr\Cache\CacheItemPoolInterface;
 
 /**
- * This supports Guzzle 6
+ * @deprecated Guzzle 6 is no longer supported; use Guzzle7AuthHandler.
  */
 class Guzzle6AuthHandler
 {

src/Client.php

@@ -35,7 +35,6 @@
 use Google\Http\REST;
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\ClientInterface;
-use GuzzleHttp\Ring\Client\StreamHandler;
 use InvalidArgumentException;
 use LogicException;
 use Monolog\Handler\StreamHandler as MonologStreamHandler;
@@ -1239,34 +1238,10 @@ public function setApiFormatV2($value)
 
     protected function createDefaultHttpClient()
     {
-        $guzzleVersion = null;
-        if (defined('\GuzzleHttp\ClientInterface::MAJOR_VERSION')) {
-            $guzzleVersion = ClientInterface::MAJOR_VERSION;
-        } elseif (defined('\GuzzleHttp\ClientInterface::VERSION')) {
-            $guzzleVersion = (int)substr(ClientInterface::VERSION, 0, 1);
-        }
-
-        if (5 === $guzzleVersion) {
-            $options = [
-                'base_url' => $this->config['base_path'],
-                'defaults' => ['exceptions' => false],
-            ];
-            if ($this->isAppEngine()) {
-                if (class_exists(StreamHandler::class)) {
-                    // set StreamHandler on AppEngine by default
-                    $options['handler'] = new StreamHandler();
-                    $options['defaults']['verify'] = '/etc/ca-certificates.crt';
-                }
-            }
-        } elseif (6 === $guzzleVersion || 7 === $guzzleVersion) {
-            // guzzle 6 or 7
-            $options = [
-                'base_uri' => $this->config['base_path'],
-                'http_errors' => false,
-            ];
-        } else {
-            throw new LogicException('Could not find supported version of Guzzle.');
-        }
+        $options = [
+            'base_uri' => $this->config['base_path'],
+            'http_errors' => false,
+        ];
 
         return new GuzzleClient($options);
     }

src/Http/REST.php

@@ -84,11 +84,12 @@ public static function doExecute(ClientInterface $client, RequestInterface $requ
             $response = $httpHandler($request);
         } catch (RequestException $e) {
             // if Guzzle throws an exception, catch it and handle the response
-            if (!$e->hasResponse()) {
+            // (on Guzzle 7 the response is on RequestException, but on Guzzle 8
+            // it is only on its ResponseException subclass)
+            $response = method_exists($e, 'getResponse') ? $e->getResponse() : null;
+            if (null === $response) {
                 throw $e;
             }
-
-            $response = $e->getResponse();
         }
 
         return self::decodeHttpResponse($response, $request, $expectedClass);

tests/Google/ClientTest.php

@@ -68,12 +68,13 @@ private function checkAuthHandler($http, $className)
         $property = $class->getProperty('stack');
         $property->setAccessible(true);
         $middlewares = $property->getValue($stack);
-        $middleware = array_pop($middlewares);
 
         if (null === $className) {
             // only the default middlewares have been added
-            $this->assertCount(3, $middlewares);
+            $defaultStack = (new GuzzleClient())->getConfig('handler');
+            $this->assertCount(count($property->getValue($defaultStack)), $middlewares);
         } else {
+            $middleware = array_pop($middlewares);
             $authClass = sprintf('Google\Auth\Middleware\%sMiddleware', $className);
             $this->assertInstanceOf($authClass, $middleware[0]);
         }
@@ -904,7 +905,7 @@ public function testCredentialsOptionWithFetchAuthTokenInterface()
                 $callable(new Request('GET', '/fake-uri'), ['auth' => 'google_auth']);
             });
 
-        $httpClient = $this->prophesize('GuzzleHttp\ClientInterface');
+        $httpClient = $this->prophesize('GuzzleHttp\Client');
         $httpClient->getConfig()
             ->shouldBeCalled()
             ->willReturn(['handler' => $handler->reveal()]);

tests/Google/Http/RESTTest.php

@@ -21,9 +21,12 @@
 use Google\Service\Exception as ServiceException;
 use Google\Tests\BaseTest;
 use GuzzleHttp\Client as GuzzleClient;
+use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\Psr7;
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
+use Prophecy\Argument;
 
 class RESTTest extends BaseTest
 {
@@ -86,6 +89,37 @@ public function testExceptionResponse()
         $response = $this->rest->doExecute($http, $request);
     }
 
+    public function testRequestExceptionWithResponseIsHandled()
+    {
+        $this->expectException(ServiceException::class);
+        $this->expectExceptionCode(400);
+
+        $request = new Request('GET', 'http://www.example.com');
+        $response = new Response(400, [], Psr7\Utils::streamFor('{"error": "bad request"}'));
+
+        $http = $this->prophesize('GuzzleHttp\ClientInterface');
+        $http->send(Argument::type('Psr\Http\Message\RequestInterface'), [])
+            ->shouldBeCalledTimes(1)
+            ->willThrow(new ClientException('Bad Request', $request, $response));
+
+        $this->rest->doExecute($http->reveal(), $request);
+    }
+
+    public function testRequestExceptionWithoutResponseIsRethrown()
+    {
+        $this->expectException(RequestException::class);
+        $this->expectExceptionMessage('Request failed');
+
+        $request = new Request('GET', 'http://www.example.com');
+
+        $http = $this->prophesize('GuzzleHttp\ClientInterface');
+        $http->send(Argument::type('Psr\Http\Message\RequestInterface'), [])
+            ->shouldBeCalledTimes(1)
+            ->willThrow(new RequestException('Request failed', $request));
+
+        $this->rest->doExecute($http->reveal(), $request);
+    }
+
     public function testDecodeEmptyResponse()
     {
         $stream = Psr7\Utils::streamFor('{}');