RabbitMQ Asynchronous RPC with

Slide 1

Slide 1 text

Slide 2

Slide 2 text

World without queues

Slide 3

Slide 3 text

Execution time Confirm payment Assign paid feature

Slide 4

Slide 4 text

Execution time Confirm payment Add to stats Assign paid feature

Slide 5

Slide 5 text

Execution time Create invoice Confirm payment Add to stats Assign paid feature Some users leave page

Slide 6

Slide 6 text

Execution time Create invoice Confirm payment Refresh user wallet Add to stats Assign paid feature Some users leave page

Slide 7

Slide 7 text

Execution time Send confirmation email Create invoice Confirm payment Refresh user wallet Add to stats Assign paid feature Some users leave page Many users leave page

Slide 8

Slide 8 text

Execution time Send confirmation email Send invoice via email Send printed invoice Create invoice Confirm payment Refresh user wallet Add to stats Assign paid feature Some users leave page Many users leave page

Slide 9

Slide 9 text

Slide 10

Slide 10 text

Problems Multiple page refresh Data consistency problems Increase system load Require support for broken/retried processes Whole atomic transaction is very heavy, and when part of it fail, everything need to be retried After outage, all data is gone.

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

Execution time Send confirmation email Send invoice via email Send printed invoice Create invoice Confirm payment Refresh user wallet Add to stats Assign paid feature queue queue queue queue

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

Producer Producing task Consumer MySql Database queue (MySql table) Producer write rows to mysql table with tasks definition Task Task Task id:1 id:2 id:3 Task id:4

Slide 15

Slide 15 text

Producer Consuming task Consumer MySql Database queue (MySql table) Task Task Task id:2 id:3 id:4 Task id:1 Consumer executes select query to retrieve tasks to process

Slide 16

Slide 16 text

Database queue (MySql table) Consumer 2 Consumer 1 Task Task Task Task modulo 2 id:1 id:2 id:3 id:4

Slide 17

Slide 17 text

Database queue (MySql table) Consumer 2 Consumer 1 Task Task Task Task modulo 3 id:1 id:2 id:3 id:4 Scaling problem need to restart all workers Consumer 3

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

Producer Consuming task Consumer redis Producer executes RPUSH to put tasks on end of queue under specified queue name Task Task Task id:1 id:2 id:3 Task id:4 Redis queue

Slide 20

Slide 20 text

Producer Consuming task Consumer redis Database queue (MySql table) Task Task Task id:2 id:3 id:4 Task id:1 Consumer executes LRANGE to retrieve entries from the beginning of queue and LTRIM to remove them after processed

Slide 21

Slide 21 text

Redis queue Consumer Task Task Task Task id:1 id:2 id:3 id:4 queue.task

Slide 22

Slide 22 text

Redis queue Consumer 2 Consumer 1 Task Task Task Task id:1 id:3 id:5 id:7 Task Task Task Task id:2 id:4 id:6 id:8 queue.task.1 queue.task.2

Slide 23

Slide 23 text

Redis queue Consumer 1 Task Task Task Task id:1 id:2 id:3 id:8 Task Task Task Task id:4 id:5 id:6 id:7 queue.task processing.queue.task Consumer 2 C1 C1 C2 C2

Slide 24

Slide 24 text

Redis queue Consumer 1 Task Task Task Task id:1 id:2 id:3 id:8 Task Task Task Task id:4 id:5 id:6 id:7 queue.task processing.queue.task Consumer 2 C1 C1 C2 C2 Lost task requeue

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

RabbitMQ Consumer 1 Task Task Task Task id:1 id:2 id:3 id:4 queue.task

Slide 27

Slide 27 text

RabbitMQ Consumer 1 Task Task Task Task id:1 id:2 id:3 id:4 queue.task Consumer 2

Slide 28

Slide 28 text

RabbitMQ Consumer 1 Task Task Task Task id:1 id:2 id:3 id:4 queue.task Consumer 2 Consumer 3 Consumer 4 Consumer 5 Consumer 6 Consumer 7 Consumer 9 Consumer 10 Consumer 11 Consumer 12

Slide 29

Slide 29 text

Acknowledge

Slide 30

Slide 30 text

Creates rabbitmq server instance with management plugin enabled http://localhost:15672 Management panel http://localhost:5672 AMQP API > docker run -d --hostname localhost --name rabbitmq-server -p 15672:15672 -p 5672:5672 rabbitmq:3-management

Slide 31

Slide 31 text

$messageQueue = $container->get( 'messaging.rpc.producer' ); $task = new SendAdExpiredMail(); $task->setAdId($ad[AdFields::FIELD_ID]); $messageQueue->send($task); Producer Publishing new task RabbitMQ

Slide 32

Slide 32 text

Producer Publishing new task RabbitMQ class SendAdExpiredMail extends AbstractMessage { public function setAdId(int $adId) { $this->payload['adId'] = $adId; } public function getAdId(): int { return $this->payload['adId']; } public function getQueueName(): string { return QueueName::MAILER_AD_EXPIRED; } }

Slide 33

Slide 33 text

Producer Task json payload RabbitMQ { "payload": { "adId": 1 }, "metadata": { "className": "SendAdExpiredMail" } }

Slide 34

Slide 34 text

$mailer = new MailHandler(); $queueMapper = new QueueMapper(); $queueMapper->addMapping( new QueueMapping('AdExpired', [$mailer, 'sendAdExpiredEmail'] ) ); Producer Consuming task - listener Consumer RabbitMQ

Slide 35

Slide 35 text

Producer Consuming task - listener Consumer RabbitMQ $messageExecutor = $container->get( 'messaging.rpc.executor' ); $messageExecutor->runOnVhostWithMap( 'mailing', $queueMapper );

Slide 36

Slide 36 text

Producer Consuming task - handler Consumer RabbitMQ class MailHandler { public function sendAdExpiredEmail (SendAdExpiredMail $task): bool { (...) } }

Slide 37

Slide 37 text

No content

Slide 38

Slide 38 text

class MessageQueue { private $writer; private $serializer; public function __construct( MessageQueueWriterInterface $writer, MessageSerializerInterface $serializer ) { $this->writer = $writer; $this->serializer = $serializer; } public function send(MessageInterface $message) { $this->writer->write( $message->getQueueName(), $this->serializer->serialize($message) ); } } Queuing class Write model High abstraction level

Slide 39

Slide 39 text

class RabbitMqMessageQueueWriter implements MessageQueueWriterInterface { public function __construct(RabbitMqConnection $connection) { $this->connection = $connection; } public function write(string $queueName, string $payload) { $this->connection->setVHost($this->getVHostFromName($queueName)); $this->connection->connect(); $channel = $this->connection->openChannel(); $channel->publish( new AMQPMessage($payload), $this->getExchangeFromName($queueName), $this->getRoutingKeyFromName($queueName) ); $channel->close(); $this->connection->disconnect(); } } Write model implementation

Slide 40

Slide 40 text

class RabbitMqChannel { public function publish( AMQPMessage $message, string $exchangeName, string $routingKey ) { $this->channel->exchange_declare( $exchangeName, 'topic', false, // passive true, // durable false // auto_delete ); $this->channel->basic_publish( $message, $exchangeName, $routingKey ); } } Queuing class Write model Low abstraction level

Slide 41

Slide 41 text

class JsonMessageSerializer implements MessageSerializerInterface { const FIELD_PAYLOAD = 'payload'; const FIELD_METADATA = 'metadata'; public function serialize(MessageInterface $message): string { $unserialized = [ self::FIELD_PAYLOAD => $message->getPayload(), self::FIELD_METADATA => $message->getMetadata() ]; return json_encode($unserialized); } public function unserialize(string $serializedMessage): MessageInterface { $unserialized = json_decode($serializedMessage, true); $payload = $unserialized[self::FIELD_PAYLOAD]; $metadata = $unserialized[self::FIELD_METADATA]; $messageType = $metadata['className']; $message = new $messageType(); $message->setPayload($payload); $message->setMetadata($metadata); return $message; } } Task serializer

Slide 42

Slide 42 text

Task abstraction abstract class AbstractMessage implements MessageInterface{ public function getQueueName(): string{ return $this->queueName; } public function getPayload(): array { return $this->payload; } public function getMetadata(): array { return array_merge($this->metadata, ['className' => static::class]); } public function setMetadata(array $metadata) { $this->metadata = $metadata; } public function setPayload(array $payload) { $this->payload = $payload; } }

Slide 43

Slide 43 text

class MessageQueueRPCExecutor { private $connection; public function __construct(RabbitMqConnection $connection) { $this->connection = $connection; } public function runOnVhostWithMap( string $vhost, QueueMapper $queueMapper) { $this->connection->setVHost($vhost); $messageExecutor = new MessageQueueExecutor( new RabbitMqMessageQueueExecutor( $this->connection ), new JsonMessageSerializer(), $queueMapper ); $messageExecutor->run(); } } Read model - executor

Slide 44

Slide 44 text

class RabbitMqMessageQueueExecutor implements MessageQueueExecutorInterface { public function __construct(RabbitMqConnection $connection) { $this->connection = $connection; } public function run() { $channel = $this->connection->openChannel(); foreach ($this->mapping as $queueName => $executor) {a $channel->bindQueueToExecutor($queueName, $executor); } $channel->listen(); $channel->close(); } public function mapQueueToExecutor(string $queueName, callable $executor) { $this->mapping[$queueName] = $this->getCallbackWrapper($executor); } Read model - executor

Slide 45

Slide 45 text

private function getCallbackWrapper(callable $executor) { return function (AMQPMessage $message) use ($executor) { $success = $executor(new RabbitMqMessage($message)); if ($success) { $message->delivery_info['channel']->basic_ack( $message->delivery_info['delivery_tag'] ); } else { $message->delivery_info['channel']->basic_nack( $message->delivery_info['delivery_tag'], false, true ); } return $success; }; } Low level processing

Slide 46

Slide 46 text

class RabbitMqChannel { public function publish( AMQPMessage $message, string $exchangeName, string $routingKey ) { $this->channel->exchange_declare($exchangeName, 'topic', false, true, false); $this->channel->basic_publish($message, $exchangeName, $routingKey); } public function bindQueueToExecutor(string $queueName, callable $executor) { $this->channel->queue_declare($queueName, false, true, false, false); $this->channel->basic_consume($queueName, '', false, false, false, false, $executor); } public function listen() { while(count($this->channel->callbacks)) { $this->channel->wait(); } } } Low level read

Slide 47

Slide 47 text

Producer Connect Open channel Declare exchange Basic publish Write flow

Slide 48

Slide 48 text

Connect Open channel Declare queue Basic consume Consumer Read flow

Slide 49

Slide 49 text

Consumer Producer Exchange Queue Application RabbitMQ Routing binding

Slide 50

Slide 50 text

AdExpired AdModerated AdExpired AdModerated mailing_olxpl mailing_olxpt vhost

Slide 51

Slide 51 text

Exchange types direct topic fanout header Exchange Queue A Queue B mailer.ad.expired mailer.ad.moderated mailer.ad.expired

Slide 52

Slide 52 text

No content

Slide 53

Slide 53 text

Exchange types direct topic fanout headers Exchange Queue A Queue B mailer.ad.expired mailer.ad.* mailer.user.*

Slide 54

Slide 54 text

Exchange types direct topic fanout headers Exchange Mailer queue Stats queue mailer.ad.expired mailer.ad.* mailer.#

Slide 55

Slide 55 text

Exchange types direct topic fanout headers Exchange Mailer queue Mail stats queue mailer.ad.expired

Slide 56

Slide 56 text

Exchange types direct topic fanout headers Exchange Mailer queue Mail stats queue param1:1 param2:2

Slide 57

Slide 57 text

Exchange Mailer queue Mail stats queue mailer.ad.expired Delayed delivery Exchange Exchange to exchange binding rabbitmq-plugins enable rabbitmq_delayed_message_exchange

Slide 58

Slide 58 text

Delaying message delivery $channel->exchange_declare('delayed_exchange', 'x-delayed-message', false, true, false, false, false, new AMQPTable(array( "x-delayed-type" => "direct" ))); $hdrs = new AMQPTable(array("x-delay" => 300)); $msg = new AMQPMessage('5 minute delayed task', array('delivery_mode' => 2) ); $msg->set('application_headers', $hdrs); $channel->basic_publish($msg, 'delayed_exchange', 'routing_key');

Slide 59

Slide 59 text

Exchange Mailer queue Mail stats queue mailer.ad.expired Delayed delivery Exchange Exchange to exchange binding Delayed retries Producer Consumer Failed task execution

Slide 60

Slide 60 text

Handling failed tasks Ignore repetition { "payload": { "adId": 1 }, "metadata": { "className": "SendAdExpiredMail", "retryStrategy": "ignore" } }

Slide 61

Slide 61 text

Handling failed tasks Controlled repetition { "payload": { "adId": 1 }, "metadata": { "className": "SendAdExpiredMail", "retryStrategy": "repeat", "retryLimit": "5", "retryCount": "0", } }

Slide 62

Slide 62 text

Handling failed tasks Controlled repetition with declared intervals { "payload": { "adId": 1 }, "metadata": { "className": "SendAdExpiredMail", "retryStrategy": "repeat", "retryLimit": "5", "retryCount": "0", "retryInterval": [15, 30, 60, 300, 86400], } }

Slide 63

Slide 63 text

Fire and Forget

Slide 64

Slide 64 text

Producer Consumer Asynchronous RPC call

Slide 65

Slide 65 text

Producer Consumer Asynchronous RPC call Asynchronous RPC response

Slide 66

Slide 66 text

Send task Wait for response Create response hash Open response queue Continue processing

Slide 67

Slide 67 text

interface ResponseRPC { public function getResponseQueueName(): string; } class GetUserFriends extends AbstractMessage implements ResponseRPC { public function getResponseQueueName(): string { if (!isset($this->metadata['response_queue'])) { $this->metadata['response_queue'] = 'user-friends-' . $this->payload['user_id'] . '_' . uniqid('', true); } return $this->metadata['response_queue']; }

Slide 68

Slide 68 text

$messageQueue = $this->container->get('messaging.rpc.producer.responding'); $task = new GetUserFriends(); $task->setId($user[UserFields::FIELD_ID]); $messageQueue->send($task); /* do some processing */ $userFriends = $messageQueue->getAsyncResponse();

Slide 69

Slide 69 text

class RespondingMessageQueue extends MessageQueue { public function __construct( MessageQueue $writer, MessageQueueExecutorInterface $executor) { $this->writer = $writer; $this->executor = $executor; } public function send(MessageInterface $message) { if ($message instanceof ResponseRPC){ $this->openResponseQueue($message); } $this->writer->send($message); } public function getAsyncResponse(): MessageInterface { $this->executor->runSingle(10); return $this->response; } private function openResponseQueue(ResponseRPC $message) { $message->getResponseQueueName(); $this->executor->mapQueueToExecutor( $message->getResponseQueueName(),[$this, 'catchResponse']); } private function catchResponse(MessageInterface $message) { $this->response = $message; } }

Slide 70

Slide 70 text

Producer Consumer Asynchronous RPC calls Asynchronous RPC responses

Slide 71

Slide 71 text

user(id:27192) { active_ads observed_ads recommendations messages } GraphQL Sample request

Slide 72

Slide 72 text

getActiveAds getObservedAds getRecommendations getMessages Request Response

Slide 73

Slide 73 text

getActiveAds getObservedAds getRecommendations getMessages Request Response

Slide 74

Slide 74 text

$messageQueue = $this->container->get('messaging.rpc.producer.responding'); $getActiveAds = new GetActiveAds(); $getActiveAds->setUserId($user[UserFields::FIELD_ID]); $getObservedAds = new GetObservedAds(); $getObservedAds->setUserId($user[UserFields::FIELD_ID]); $getRecommendations = new GetRecommendations(); $getRecommendations->setUserId($user[UserFields::FIELD_ID]); $getMessages = new GetMessages(); $getMessages->setUserId($user[UserFields::FIELD_ID]); $messageQueue->sendMultiple( [$getActiveAds, $getObservedAds, $getRecommendations, $getMessages] ); /* do some processing */ $userAggregateData = $messageQueue->getAsyncResponses();

Slide 75

Slide 75 text

● more consumers ● faster consumers ● higher prefetch count

Slide 76

Slide 76 text

Useful links http://tryrabbitmq.com/ https://github.com/php-amqplib/php-amqplib https://www.cloudamqp.com/

Slide 77

Slide 77 text

RabbitMQ Asynchronous RPC with Dawid Mazurek PHP DEV at