Skip to content

Fixed losing message priority for dbal driver #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 12, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion pkg/dbal/Client/DbalDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ class DbalDriver implements DriverInterface
*/
private $queueMetaRegistry;

/**
* @var array
*/
private static $priorityMap = [
MessagePriority::VERY_LOW => 0,
MessagePriority::LOW => 1,
MessagePriority::NORMAL => 2,
MessagePriority::HIGH => 3,
MessagePriority::VERY_HIGH => 4,
];

/**
* @param DbalContext $context
* @param Config $config
Expand Down Expand Up @@ -63,6 +74,9 @@ public function createTransportMessage(Message $message)
$transportMessage->setDelay($message->getDelay());
$transportMessage->setReplyTo($message->getReplyTo());
$transportMessage->setCorrelationId($message->getCorrelationId());
if (array_key_exists($message->getPriority(), self::$priorityMap)) {
$transportMessage->setPriority(self::$priorityMap[$message->getPriority()]);
}

return $transportMessage;
}
Expand All @@ -83,11 +97,16 @@ public function createClientMessage(PsrMessage $message)
$clientMessage->setContentType($message->getHeader('content_type'));
$clientMessage->setMessageId($message->getMessageId());
$clientMessage->setTimestamp($message->getTimestamp());
$clientMessage->setPriority(MessagePriority::NORMAL);
$clientMessage->setDelay($message->getDelay());
$clientMessage->setReplyTo($message->getReplyTo());
$clientMessage->setCorrelationId($message->getCorrelationId());

$priorityMap = array_flip(self::$priorityMap);
$priority = array_key_exists($message->getPriority(), $priorityMap) ?
$priorityMap[$message->getPriority()] :
MessagePriority::NORMAL;
$clientMessage->setPriority($priority);

return $clientMessage;
}

Expand Down Expand Up @@ -156,4 +175,12 @@ public function getConfig()
{
return $this->config;
}

/**
* @return array
*/
public static function getPriorityMap()
{
return self::$priorityMap;
}
}
2 changes: 1 addition & 1 deletion pkg/dbal/DbalConsumer.php
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ protected function receiveMessage()
->where('queue = :queue')
->andWhere('(delayed_until IS NULL OR delayed_until <= :delayedUntil)')
->orderBy('priority', 'desc')
->orderBy('id', 'asc')
->addOrderBy('id', 'asc')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should be desc. gonna fix it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

->setMaxResults(1)
;

Expand Down
1 change: 1 addition & 0 deletions pkg/dbal/Tests/Client/DbalDriverTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ public function testShouldConvertTransportMessageToClientMessage()
$transportMessage->setHeader('content_type', 'ContentType');
$transportMessage->setMessageId('MessageId');
$transportMessage->setTimestamp(1000);
$transportMessage->setPriority(2);
$transportMessage->setDelay(12345);

$driver = new DbalDriver(
Expand Down
21 changes: 18 additions & 3 deletions pkg/dbal/Tests/DbalConsumerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,15 @@ public function testShouldReceiveMessage()
->will($this->returnSelf())
;
$queryBuilder
->expects($this->exactly(2))
->expects($this->exactly(1))
->method('orderBy')
->will($this->returnSelf())
;
$queryBuilder
->expects($this->exactly(1))
->method('addOrderBy')
->will($this->returnSelf())
;

$platform = $this->createPlatformMock();

Expand Down Expand Up @@ -264,10 +269,15 @@ public function testShouldReturnNullIfThereIsNoNewMessage()
->will($this->returnSelf())
;
$queryBuilder
->expects($this->exactly(2))
->expects($this->exactly(1))
->method('orderBy')
->will($this->returnSelf())
;
$queryBuilder
->expects($this->exactly(1))
->method('addOrderBy')
->will($this->returnSelf())
;

$platform = $this->createPlatformMock();

Expand Down Expand Up @@ -352,10 +362,15 @@ public function testShouldThrowIfMessageWasNotRemoved()
->will($this->returnSelf())
;
$queryBuilder
->expects($this->exactly(2))
->expects($this->exactly(1))
->method('orderBy')
->will($this->returnSelf())
;
$queryBuilder
->expects($this->exactly(1))
->method('addOrderBy')
->will($this->returnSelf())
;

$platform = $this->createPlatformMock();

Expand Down
91 changes: 91 additions & 0 deletions pkg/dbal/Tests/DbalSendPriorityMessagesTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<?php

namespace Enqueue\Dbal\Tests;

use Enqueue\Dbal\DbalConnectionFactory;
use Enqueue\Dbal\DbalContext;
use Enqueue\Dbal\DbalMessage;
use Interop\Queue\PsrContext;
use Interop\Queue\PsrMessage;
use PHPUnit\Framework\TestCase;

/**
* @group functional
*/
class DbalSendPriorityMessagesTest extends TestCase
{
public function test()
{
$context = $this->createContext();
$queue = $this->createQueue($context, 'default');
$consumer = $context->createConsumer($queue);

// guard
$this->assertNull($consumer->receiveNoWait());

$messagePriorities = [1, 0, 3];
$producer = $context->createProducer();
foreach ($messagePriorities as $priority) {
$producer->send($queue, $this->createMessage($context, $priority));
}

sort($messagePriorities);
foreach (array_reverse($messagePriorities) as $priority) {
$message = $consumer->receive(8000); // 8 sec

$this->assertInstanceOf(PsrMessage::class, $message);
$consumer->acknowledge($message);
$this->assertSame('priority'.$priority, $message->getBody());
}
}

/**
* @return PsrContext
*/
protected function createContext()
{
$factory = new DbalConnectionFactory(
[
'lazy' => true,
'connection' => [
'dbname' => getenv('SYMFONY__DB__NAME'),
'user' => getenv('SYMFONY__DB__USER'),
'password' => getenv('SYMFONY__DB__PASSWORD'),
'host' => getenv('SYMFONY__DB__HOST'),
'port' => getenv('SYMFONY__DB__PORT'),
'driver' => getenv('SYMFONY__DB__DRIVER'),
],
]
);

return $factory->createContext();
}

/**
* {@inheritdoc}
*
* @param DbalContext $context
*/
protected function createQueue(PsrContext $context, $queueName)
{
$queue = $context->createQueue($queueName);
$context->createDataBaseTable();

return $queue;
}

/**
* @param PsrContext $context
* @param int $priority
*
* @return DbalMessage
*/
protected function createMessage(PsrContext $context, $priority)
{
/** @var DbalMessage $message */
$message = $context->createMessage('priority'.$priority);
$message->setPriority($priority);

return $message;
}
}