Upgrade the RabbitMQ module

Last updated:
Edit on GitHub

Upgrading from version 0.* to version 1.*

Version 1 of the RabbitMq module

Configuration

The configuration codes have moved from RabbitMqDependencyProvider to RabbitMqConfiguration.

RabbitMqOption TransferObject

  • RabbitMqOption transfer has changed: bindingQueue property has changed to bindingQueueCollection
  • RabbitMqOption transfer has changed: routingKey property with string type has changed to routingKeys with array type.
Sample configuration code in RabbitMqConfiguration 
namespace Pyz\Client\RabbitMq;

use ArrayObject;
use Generated\Shared\Transfer\RabbitMqOptionTransfer;
use Spryker\Client\RabbitMq\Model\Connection\Connection;
use Spryker\Client\RabbitMq\RabbitMqConfig as SprykerRabbitMqConfig;
use Spryker\Shared\Event\EventConstants;

class RabbitMqConfig extends SprykerRabbitMqConfig
{

    /**
     * @return \ArrayObject
     */
    protected function getQueueOptions()
    {
        $queueOptionCollection = new ArrayObject();
        $queueOptionCollection->append($this->createQueueOption(EventConstants::EVENT_QUEUE, EventConstants::EVENT_QUEUE_ERROR));

        return $queueOptionCollection;
    }

    /**
    * @param string $queueName
    * @param string $errorQueueName
    * @param string $routingKey
    *
    * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer
    */
    protected function createQueueOption($queueName, $errorQueueName, $routingKey = 'error')
    {
        $queueOption = new RabbitMqOptionTransfer();
        $queueOption
            ->setQueueName($queueName)
            ->setDurable(true)
            ->setType('direct')
            ->setDeclarationType(Connection::RABBIT_MQ_EXCHANGE)
            ->addBindingQueueItem($this->createQueueBinding($queueName))
            ->addBindingQueueItem($this->createErrorQueueBinding($errorQueueName, $routingKey));

        return $queueOption;
    }

    /**
    * @param string $queueName
    *
    * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer
    */
    protected function createQueueBinding($queueName)
    {
        $queueOption = new RabbitMqOptionTransfer();
        $queueOption
            ->setQueueName($queueName)
            ->setDurable(true)
            ->addRoutingKey('');

        return $queueOption;
    }

    /**
    * @param string $errorQueueName
    * @param string $routingKey
    *
    * @return \Generated\Shared\Transfer\RabbitMqOptionTransfer
    */
    protected function createErrorQueueBinding($errorQueueName, $routingKey)
    {
        $queueOption = new RabbitMqOptionTransfer();
        $queueOption
            ->setQueueName($errorQueueName)
            ->setDurable(true)
            ->addRoutingKey($routingKey);

        return $queueOption;
    }

}

Upgrading from version 1.* to version 2.*

Version 2 of the RabbitMq module

Configuration

The configuration parameters have been changed, Now the rabbitMQ configurations are stored in a numeric array under the RabbitMqEnv::RABBITMQ_CONNECTIONS key. The structure of a rabbit MQ definition is default_config.php

$config[RabbitMqEnv::RABBITMQ_CONNECTIONS] = [
RabbitMqEnv::RABBITMQ_CONNECTION_NAME => 'DE-connection',
RabbitMqEnv::RABBITMQ_HOST => 'localhost',
RabbitMqEnv::RABBITMQ_PORT => '5672',
RabbitMqEnv::RABBITMQ_PASSWORD => 'guest',
RabbitMqEnv::RABBITMQ_USERNAME => 'guest',
RabbitMqEnv::RABBITMQ_VIRTUAL_HOST => '/',
RabbitMqEnv::RABBITMQ_STORE_NAMES => ['DE', 'US', 'AT'],
RabbitMqEnv::RABBITMQ_DEFAULT_CONNECTION => true,
]

The API RabbitMQ configurations are unchanged! RabbitMqConstants::RABBITMQ_VIRTUAL_HOST is replaced by RabbitMqEnv::RABBITMQ_API_VIRTUAL_HOST.