MAKS\AmqpAgent\RPC\ServerEndpoint

Complexity

Total Complexity

7

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	callback()	0	3	1
A	onRequest()	0	33	2
A	respond()	0	42	3
A	serve()	0	3	1

<?php
/**
 * @author Marwan Al-Soltany <MarwanAlsoltany@gmail.com>
 * @copyright Marwan Al-Soltany 2020
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace MAKS\AmqpAgent\RPC;

use PhpAmqpLib\Message\AMQPMessage;
use MAKS\AmqpAgent\Helper\ClassProxy;
use MAKS\AmqpAgent\RPC\AbstractEndpoint;
use MAKS\AmqpAgent\RPC\ServerEndpointInterface;
use MAKS\AmqpAgent\Exception\RPCEndpointException;

/**
 * A class specialized in responding. Implementing only the methods needed for a server.
 *
 * Example:
 * ```
 * $serverEndpoint = new ServerEndpoint();
 * $serverEndpoint->on('some.event', function () { ... });
 * $serverEndpoint->connect();
 * $serverEndpoint->respond('Namespace\SomeClass::someMethod', 'queue.name');
 * $serverEndpoint->disconnect();
 * ```
 *
 * @since 2.0.0
 * @api
 */
class ServerEndpoint extends AbstractEndpoint implements ServerEndpointInterface
{
    /**
     * The callback to use when processing the requests.
     * @var array
     */
    protected $callback;


    /**
     * Listens on requests coming via the passed queue and processes them with the passed callback.
     * @param callable|null $callback [optional] The callback to process the request. This callback will be passed an `AMQPMessage` and must return a string.
     * @param string|null $queueName [optional] The name of the queue to listen on.
     * @return string The last processed request.
     * @throws RPCEndpointException If the server is not connected yet or if the passed callback didn't return a string.
     */
    public function respond(?callable $callback = null, ?string $queueName = null): string
    {
        $this->callback = $callback ?? [$this, 'callback'];

It seems like $callback ?? array($this, 'callback') can also be of type callable. However, the property $callback is declared as type array. Maybe add an additional type check?

        $this->queueName = $queueName ?? $this->queueName;

It seems like $queueName ?? $this->queueName can also be of type string. However, the property $queueName is declared as type array. Maybe add an additional type check?

        if ($this->isConnected()) {
            $this->requestQueue = $this->queueName;

It seems like $this->queueName can also be of type array. However, the property $requestQueue is declared as type string. Maybe add an additional type check?

            $this->channel->queue_declare(
                $this->requestQueue,

It seems like $this->requestQueue can also be of type array; however, parameter $queue of PhpAmqpLib\Channel\AMQPChannel::queue_declare() does only seem to accept string, maybe add an additional type check?

                false,
                false,
                false,
                false
            );

            $this->channel->basic_qos(
                null,
                1,
                null
            );

            $this->channel->basic_consume(
                $this->requestQueue,

It seems like $this->requestQueue can also be of type array; however, parameter $queue of PhpAmqpLib\Channel\AMQPChannel::basic_consume() does only seem to accept string, maybe add an additional type check?

                null,
                false,
                false,
                false,
                false,
                function ($message) {
                    ClassProxy::call($this, 'onRequest', $message);
                }
            );

            while ($this->channel->is_consuming()) {
                $this->channel->wait();
            }

            return $this->request;
        }

        throw new RPCEndpointException('Server is not connected yet!');
    }

    /**
     * Listens on requests coming via the passed queue and processes them with the passed callback.
     * Alias for `self::respond()`.
     * @param callable|null $callback [optional] The callback to process the request. This callback will be passed an `AMQPMessage` and must return a string.
     * @param string|null $queueName [optional] The queue to listen on.
     * @return string The last processed request.
     * @throws RPCEndpointException If the server is not connected yet or if the passed callback didn't return a string.
     */
    public function serve(?callable $callback = null, ?string $queueName = null): string
    {
        return $this->respond($callback, $queueName);
    }

    /**
     * Replies to the client.
     * @param AMQPMessage $request
     * @return void
     */
    protected function onRequest(AMQPMessage $request): void
    {
        $this->trigger('request.on.get', [$request]);

        $this->request = $request->body;
        $this->response = call_user_func($this->callback, $request);
        $this->responseQueue = $request->get('reply_to');

It seems like $request->get('reply_to') can also be of type PhpAmqpLib\Channel\AMQPChannel. However, the property $responseQueue is declared as type string. Maybe add an additional type check?

        $this->correlationId = $request->get('correlation_id');

It seems like $request->get('correlation_id') can also be of type PhpAmqpLib\Channel\AMQPChannel. However, the property $correlationId is declared as type string. Maybe add an additional type check?

        if (!is_string($this->response)) {
            throw new RPCEndpointException(
                sprintf(
                    'The passed processing callback must return a string, instead it returned (data-type: %s)!',
                    gettype($this->response)
                )
            );
        }

        $message = new AMQPMessage($this->response);
        $message->set('correlation_id', $this->correlationId);
        $message->set('timestamp', time());

        $this->trigger('response.before.send', [$message]);

        $request->getChannel()->basic_publish(
            $message,
            null,
            $this->responseQueue

It seems like $this->responseQueue can also be of type PhpAmqpLib\Channel\AMQPChannel; however, parameter $routing_key of PhpAmqpLib\Channel\AMQPChannel::basic_publish() does only seem to accept string, maybe add an additional type check?

        );

        $request->ack();

        $this->trigger('response.after.send', [$message]);
    }

    /**
     * Returns the final request body. This method will be ignored if a callback in `self::respond()` is specified.
     * @return string
     */
    protected function callback(AMQPMessage $message): string
    {
        return $message->body;
    }
}