File Manager

Editing: OperationResponseTrait.php

<?php
/**
 * Copyright 2016 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Google\Cloud\Core\LongRunning;

use Google\ApiCore\OperationResponse;
use Google\ApiCore\Serializer;
use Google\GAX\OperationResponse as GaxOperationResponse;

/**
 * Serializes and deserializes ApiCore LRO Response objects.
 *
 * This trait should be used in a gRPC Connection class to normalize responses.
 */
trait OperationResponseTrait
{
    /**
     * Convert a ApiCore OperationResponse object to an array.
     *
     * @param OperationResponse|GaxOperationResponse $operation The operation response
     * @param Serializer|GaxSerializer $serializer The serializer to use for gRPC serialization/deserialization.
     * @param array $lroMappers A list of mappers for deserializing operation results.
     * @return array
     */
    private function operationToArray($operation, $serializer, array $lroMappers)
    {
        $response = $operation->getLastProtoResponse();
        if (is_null($response)) {
            return null;
        }

$response = $serializer->encodeMessage($response);

$result = null;
        if ($operation->isDone() && isset($response['response']['typeUrl'])) {
            $type = $response['response']['typeUrl'];
            $result = $this->deserializeResult($operation, $type, $serializer, $lroMappers);
        }

$metaType = $response['metadata']['typeUrl'];
        $metaResult = $this->deserializeMetadata($operation, $metaType, $serializer, $lroMappers);
        /** @see LongRunningOperation#reload() */
        $metaResult += ['typeUrl' => $metaType];

$error = $operation->getError();
        if (!is_null($error)) {
            $error = $serializer->encodeMessage($error);
        }

$response['response'] = $result;
        $response['metadata'] = $metaResult;
        $response['error'] = $error;

return $response;
    }

/**
     * Fetch an OperationResponse object from a gapic client.
     *
     * @param mixed $client A generated client with a `resumeOperation` method.
     * @param string $name The Operation name.
     * @param string|null $method The method name.
     * @return OperationResponse
     */
    private function getOperationByName($client, $name, $method = null)
    {
        return $client->resumeOperation($name, $method);
    }

/**
     * Convert an operation response to an array
     *
     * @param OperationResponse|GaxOperationResponse $operation The operation to
     *        serialize.
     * @param string $type The Operation type. The type should correspond to a
     *        member of $mappers.typeUrl.
     * @param Serializer|GaxSerializer $serializer The gRPC serializer to use
     *        for the deserialization.
     * @param array $mappers A list of mappers.
     * @return array|null
     */
    private function deserializeResult($operation, $type, $serializer, array $mappers)
    {
        $mappers = array_filter($mappers, function ($mapper) use ($type) {
            return $mapper['typeUrl'] === $type;
        });

if (count($mappers) === 0) {
            throw new \RuntimeException(sprintf('No mapper exists for operation response type %s.', $type));
        }

$mapper = current($mappers);
        $message = $mapper['message'];

$response = new $message();
        $anyResponse = $operation->getLastProtoResponse()->getResponse();
        if (is_null($anyResponse)) {
            return null;
        }

$response->mergeFromString($anyResponse->getValue());

return $serializer->encodeMessage($response);
    }

/**
     * Convert an operation metadata to an array
     *
     * @param OperationResponse|GaxOperationResponse $operation The operation to
     *        serialize.
     * @param string $type The Operation type. The type should correspond to a
     *        member of $mappers.typeUrl.
     * @param Serializer|GaxSerializer $serializer The gRPC serializer to use
     *        for the deserialization.
     * @param array $mappers A list of mappers.
     * @return array|null
     */

private function deserializeMetadata($operation, $type, $serializer, array $mappers)
    {
        $mappers = array_filter($mappers, function ($mapper) use ($type) {
            return $mapper['typeUrl'] === $type;
        });
        if (count($mappers) === 0) {
            throw new \RuntimeException(sprintf('No mapper exists for operation metadata type %s.', $type));
        }

$mapper = current($mappers);
        $message = $mapper['message'];

$response = new $message();
        $anyResponse = $operation->getLastProtoResponse()->getMetadata();
        if (is_null($anyResponse)) {
            return null;
        }

$response->mergeFromString($anyResponse->getValue());

return $serializer->encodeMessage($response);
    }
}

⬅ Back