feat(Core): add RequestHandler and supporting classes

Core/src/GrpcRequestWrapper.php

@@ -20,21 +20,16 @@
 use Google\Auth\HttpHandler\HttpHandlerFactory;
 use Google\Cloud\Core\Exception;
 use Google\ApiCore\ApiException;
-use Google\ApiCore\OperationResponse;
-use Google\ApiCore\PagedListResponse;
 use Google\ApiCore\Serializer;
-use Google\ApiCore\ServerStream;
-use Google\Protobuf\Internal\Message;
-use Google\Rpc\BadRequest;
 use Google\Rpc\Code;
-use Google\Rpc\RetryInfo;
 
 /**
  * The GrpcRequestWrapper is responsible for delivering gRPC requests.
  */
 class GrpcRequestWrapper
 {
     use RequestWrapperTrait;
+    use RequestProcessorTrait;
 
     /**
      * @var callable A handler used to deliver Psr7 requests specifically for
@@ -63,14 +58,6 @@ class GrpcRequestWrapper
         Code::DATA_LOSS
     ];
 
-    /**
-     * @var array Map of error metadata types to RPC wrappers.
-     */
-    private $metadataTypes = [
-        'google.rpc.retryinfo-bin' => RetryInfo::class,
-        'google.rpc.badrequest-bin' => BadRequest::class
-    ];
-
     /**
      * @param array $config [optional] {
      *     Configuration options. Please see
@@ -154,112 +141,4 @@ public function send(callable $request, array $args, array $options = [])
             throw $ex;
         }
     }
-
-    /**
-     * Serializes a gRPC response.
-     *
-     * @param mixed $response
-     * @return \Generator|OperationResponse|array|null
-     */
-    private function handleResponse($response)
-    {
-        if ($response instanceof PagedListResponse) {
-            $response = $response->getPage()->getResponseObject();
-        }
-
-        if ($response instanceof Message) {
-            return $this->serializer->encodeMessage($response);
-        }
-
-        if ($response instanceof OperationResponse) {
-            return $response;
-        }
-
-        if ($response instanceof ServerStream) {
-            return $this->handleStream($response);
-        }
-
-        return null;
-    }
-
-    /**
-     * Handles a streaming response.
-     *
-     * @param ServerStream $response
-     * @return \Generator|array|null
-     * @throws Exception\ServiceException
-     */
-    private function handleStream($response)
-    {
-        try {
-            foreach ($response->readAll() as $count => $result) {
-                $res = $this->serializer->encodeMessage($result);
-                yield $res;
-            }
-        } catch (\Exception $ex) {
-            throw $this->convertToGoogleException($ex);
-        }
-    }
-
-    /**
-     * Convert a ApiCore exception to a Google Exception.
-     *
-     * @param \Exception $ex
-     * @return Exception\ServiceException
-     */
-    private function convertToGoogleException($ex)
-    {
-        switch ($ex->getCode()) {
-            case Code::INVALID_ARGUMENT:
-                $exception = Exception\BadRequestException::class;
-                break;
-
-            case Code::NOT_FOUND:
-            case Code::UNIMPLEMENTED:
-                $exception = Exception\NotFoundException::class;
-                break;
-
-            case Code::ALREADY_EXISTS:
-                $exception = Exception\ConflictException::class;
-                break;
-
-            case Code::FAILED_PRECONDITION:
-                $exception = Exception\FailedPreconditionException::class;
-                break;
-
-            case Code::UNKNOWN:
-                $exception = Exception\ServerException::class;
-                break;
-
-            case Code::INTERNAL:
-                $exception = Exception\ServerException::class;
-                break;
-
-            case Code::ABORTED:
-                $exception = Exception\AbortedException::class;
-                break;
-
-            case Code::DEADLINE_EXCEEDED:
-                $exception = Exception\DeadlineExceededException::class;
-                break;
-
-            default:
-                $exception = Exception\ServiceException::class;
-                break;
-        }
-
-        $metadata = [];
-        if ($ex->getMetadata()) {
-            foreach ($ex->getMetadata() as $type => $binaryValue) {
-                if (!isset($this->metadataTypes[$type])) {
-                    continue;
-                }
-                $metadataElement = new $this->metadataTypes[$type];
-                $metadataElement->mergeFromString($binaryValue[0]);
-                $metadata[] = $this->serializer->encodeMessage($metadataElement);
-            }
-        }
-
-        return new $exception($ex->getMessage(), $ex->getCode(), $ex, $metadata);
-    }
 }

Core/src/RequestHandler.php

@@ -24,13 +24,8 @@
 use Google\Cloud\Core\TimeTrait;
 use Google\Cloud\Core\WhitelistTrait;
 use \Google\Protobuf\Internal\Message;
-use Google\ApiCore\ServerStream;
-use Google\Rpc\BadRequest;
-use Google\Rpc\Code;
-use Google\Rpc\RetryInfo;
 use Google\ApiCore\ApiException;
 use Google\ApiCore\OperationResponse;
-use Google\ApiCore\PagedListResponse;
 
 /**
  * @internal
@@ -43,20 +38,13 @@ class RequestHandler
     use ArrayTrait;
     use TimeTrait;
     use WhitelistTrait;
+    use RequestProcessorTrait;
 
     /**
      * @var Serializer
      */
     private Serializer $serializer;
 
-    /**
-     * @var array Map of error metadata types to RPC wrappers.
-     */
-    private array $metadataTypes = [
-        'google.rpc.retryinfo-bin' => RetryInfo::class,
-        'google.rpc.badrequest-bin' => BadRequest::class
-    ];
-
     private array $clients;
 
     /**
@@ -77,7 +65,6 @@ public function __construct(
         // gccl needs to be present for handwritten clients
         $clientConfig += [
             'libName' => 'gccl',
-            'transport' => $this->getDefaultTransport(),
             'emulatorHost' => null
         ];
 
@@ -142,114 +129,6 @@ public function sendRequest(
         }
     }
 
-    /**
-     * Serializes a gRPC response.
-     *
-     * @param mixed $response
-     * @return \Generator|OperationResponse|array|null
-     */
-    private function handleResponse($response)
-    {
-        if ($response instanceof PagedListResponse) {
-            $response = $response->getPage()->getResponseObject();
-        }
-
-        if ($response instanceof Message) {
-            return $this->serializer->encodeMessage($response);
-        }
-
-        if ($response instanceof OperationResponse) {
-            return $response;
-        }
-
-        if ($response instanceof ServerStream) {
-            return $this->handleStream($response);
-        }
-
-        return null;
-    }
-
-    /**
-     * Handles a streaming response.
-     *
-     * @param ServerStream $response
-     * @return \Generator|array|null
-     * @throws Exception\ServiceException
-     */
-    private function handleStream(ServerStream $response)
-    {
-        try {
-            foreach ($response->readAll() as $count => $result) {
-                $res = $this->serializer->encodeMessage($result);
-                yield $res;
-            }
-        } catch (\Exception $ex) {
-            throw $this->convertToGoogleException($ex);
-        }
-    }
-
-    /**
-     * Convert a ApiCore exception to a Google Exception.
-     *
-     * @param \Exception $ex
-     * @return ServiceException
-     */
-    private function convertToGoogleException(\Exception $ex): ServiceException
-    {
-        switch ($ex->getCode()) {
-            case Code::INVALID_ARGUMENT:
-                $exception = Exception\BadRequestException::class;
-                break;
-
-            case Code::NOT_FOUND:
-            case Code::UNIMPLEMENTED:
-                $exception = Exception\NotFoundException::class;
-                break;
-
-            case Code::ALREADY_EXISTS:
-                $exception = Exception\ConflictException::class;
-                break;
-
-            case Code::FAILED_PRECONDITION:
-                $exception = Exception\FailedPreconditionException::class;
-                break;
-
-            case Code::UNKNOWN:
-                $exception = Exception\ServerException::class;
-                break;
-
-            case Code::INTERNAL:
-                $exception = Exception\ServerException::class;
-                break;
-
-            case Code::ABORTED:
-                $exception = Exception\AbortedException::class;
-                break;
-
-            case Code::DEADLINE_EXCEEDED:
-                $exception = Exception\DeadlineExceededException::class;
-                break;
-
-            default:
-                $exception = Exception\ServiceException::class;
-                break;
-        }
-
-        $metadata = [];
-        if (method_exists($ex, 'getMetadata') && $ex->getMetadata()) {
-            foreach ($ex->getMetadata() as $type => $binaryValue) {
-                if (!isset($this->metadataTypes[$type])) {
-                    continue;
-                }
-                $metadataElement = new $this->metadataTypes[$type];
-                $metadataElement->mergeFromString($binaryValue[0]);
-                $metadata[] = $this->serializer->encodeMessage($metadataElement);
-            }
-        }
-
-        return new $exception($ex->getMessage(), $ex->getCode(), $ex, $metadata);
-    }
-
     /**
      * Helper function that returns a client object stored in memory
      * using the client class as key.
@@ -260,16 +139,4 @@ private function getClientObject(string $clientClass)
     {
         return $this->clients[$clientClass] ?? null;
     }
-
-    private function getDefaultTransport() : string
-    {
-        $isGrpcExtensionLoaded = $this->isGrpcLoaded();
-        $defaultTransport = $isGrpcExtensionLoaded ? 'grpc' : 'rest';
-        return $defaultTransport;
-    }
-
-    private function isGrpcLoaded() : bool
-    {
-        return extension_loaded('grpc');
-    }
 }