Migrate mongodb transport.

Author: makasim

MongodbConnectionFactory.php

@@ -3,6 +3,7 @@
 namespace Enqueue\Mongodb;
 
 use Interop\Queue\PsrConnectionFactory;
+use Interop\Queue\PsrContext;
 use MongoDB\Client;
 
 class MongodbConnectionFactory implements PsrConnectionFactory
@@ -48,14 +49,17 @@ public function __construct($config = 'mongodb:')
         $this->config = $config;
     }
 
-    public function createContext()
+    /**
+     * @return MongodbContext
+     */
+    public function createContext(): PsrContext
     {
         $client = new Client($this->config['dsn']);
 
         return new MongodbContext($client, $this->config);
     }
 
-    public static function parseDsn($dsn)
+    public static function parseDsn(string $dsn): array
     {
         $parsedUrl = parse_url($dsn);
         if (false === $parsedUrl) {

MongodbConsumer.php

@@ -5,6 +5,7 @@
 use Interop\Queue\InvalidMessageException;
 use Interop\Queue\PsrConsumer;
 use Interop\Queue\PsrMessage;
+use Interop\Queue\PsrQueue;
 
 class MongodbConsumer implements PsrConsumer
 {
@@ -21,54 +22,44 @@ class MongodbConsumer implements PsrConsumer
     /**
      * @var int microseconds
      */
-    private $pollingInterval = 1000000;
+    private $pollingInterval;
 
-    /**
-     * @param MongodbContext     $context
-     * @param MongodbDestination $queue
-     */
     public function __construct(MongodbContext $context, MongodbDestination $queue)
     {
         $this->context = $context;
         $this->queue = $queue;
+
+        $this->pollingInterval = 1000;
     }
 
     /**
      * Set polling interval in milliseconds.
-     *
-     * @param int $msec
      */
-    public function setPollingInterval($msec)
+    public function setPollingInterval(int $msec): void
     {
-        $this->pollingInterval = $msec * 1000;
+        $this->pollingInterval = $msec;
     }
 
     /**
      * Get polling interval in milliseconds.
-     *
-     * @return int
      */
-    public function getPollingInterval()
+    public function getPollingInterval(): int
     {
-        return (int) $this->pollingInterval / 1000;
+        return $this->pollingInterval;
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @return MongodbDestination
      */
-    public function getQueue()
+    public function getQueue(): PsrQueue
     {
         return $this->queue;
     }
 
     /**
-     * {@inheritdoc}
-     *
-     * @return MongodbMessage|null
+     * @return MongodbMessage
      */
-    public function receive($timeout = 0)
+    public function receive(int $timeout = 0): ?PsrMessage
     {
         $timeout /= 1000;
         $startAt = microtime(true);
@@ -81,43 +72,37 @@ public function receive($timeout = 0)
             }
 
             if ($timeout && (microtime(true) - $startAt) >= $timeout) {
-                return;
+                return null;
             }
 
-            usleep($this->pollingInterval);
+            usleep($this->pollingInterval * 1000);
 
             if ($timeout && (microtime(true) - $startAt) >= $timeout) {
-                return;
+                return null;
             }
         }
     }
 
     /**
-     * {@inheritdoc}
-     *
-     * @return MongodbMessage|null
+     * @return MongodbMessage
      */
-    public function receiveNoWait()
+    public function receiveNoWait(): ?PsrMessage
     {
         return $this->receiveMessage();
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @param MongodbMessage $message
      */
-    public function acknowledge(PsrMessage $message)
+    public function acknowledge(PsrMessage $message): void
     {
         // does nothing
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @param MongodbMessage $message
      */
-    public function reject(PsrMessage $message, $requeue = false)
+    public function reject(PsrMessage $message, bool $requeue = false): void
     {
         InvalidMessageException::assertMessageInstanceOf($message, MongodbMessage::class);
 
@@ -128,10 +113,7 @@ public function reject(PsrMessage $message, $requeue = false)
         }
     }
 
-    /**
-     * @return MongodbMessage|null
-     */
-    protected function receiveMessage()
+    protected function receiveMessage(): ?MongodbMessage
     {
         $now = time();
         $collection = $this->context->getCollection();
@@ -155,14 +137,11 @@ protected function receiveMessage()
         if (empty($message['time_to_live']) || $message['time_to_live'] > time()) {
             return $this->convertMessage($message);
         }
+
+        return null;
     }
 
-    /**
-     * @param array $dbalMessage
-     *
-     * @return MongodbMessage
-     */
-    protected function convertMessage(array $mongodbMessage)
+    protected function convertMessage(array $mongodbMessage): MongodbMessage
     {
         $properties = JSON::decode($mongodbMessage['properties']);
         $headers = JSON::decode($mongodbMessage['headers']);

MongodbContext.php

@@ -3,9 +3,18 @@
 namespace Enqueue\Mongodb;
 
 use Interop\Queue\InvalidDestinationException;
+use Interop\Queue\PsrConsumer;
 use Interop\Queue\PsrContext;
 use Interop\Queue\PsrDestination;
+use Interop\Queue\PsrMessage;
+use Interop\Queue\PsrProducer;
+use Interop\Queue\PsrQueue;
+use Interop\Queue\PsrSubscriptionConsumer;
+use Interop\Queue\PsrTopic;
+use Interop\Queue\SubscriptionConsumerNotSupportedException;
+use Interop\Queue\TemporaryQueueNotSupportedException;
 use MongoDB\Client;
+use MongoDB\Collection;
 
 class MongodbContext implements PsrContext
 {
@@ -30,7 +39,10 @@ public function __construct($client, array $config = [])
         $this->client = $client;
     }
 
-    public function createMessage($body = '', array $properties = [], array $headers = [])
+    /**
+     * @return MongodbMessage
+     */
+    public function createMessage(string $body = '', array $properties = [], array $headers = []): PsrMessage
     {
         $message = new MongodbMessage();
         $message->setBody($body);
@@ -40,27 +52,41 @@ public function createMessage($body = '', array $properties = [], array $headers
         return $message;
     }
 
-    public function createTopic($name)
+    /**
+     * @return MongodbDestination
+     */
+    public function createTopic(string $name): PsrTopic
     {
         return new MongodbDestination($name);
     }
 
-    public function createQueue($queueName)
+    /**
+     * @return MongodbDestination
+     */
+    public function createQueue(string $queueName): PsrQueue
     {
         return new MongodbDestination($queueName);
     }
 
-    public function createTemporaryQueue()
+    public function createTemporaryQueue(): PsrQueue
     {
-        throw new \BadMethodCallException('Mongodb transport does not support temporary queues');
+        throw TemporaryQueueNotSupportedException::providerDoestNotSupportIt();
     }
 
-    public function createProducer()
+    /**
+     * @return MongodbProducer
+     */
+    public function createProducer(): PsrProducer
     {
         return new MongodbProducer($this);
     }
 
-    public function createConsumer(PsrDestination $destination)
+    /**
+     * @param MongodbDestination $destination
+     *
+     * @return MongodbConsumer
+     */
+    public function createConsumer(PsrDestination $destination): PsrConsumer
     {
         InvalidDestinationException::assertDestinationInstanceOf($destination, MongodbDestination::class);
 
@@ -73,35 +99,43 @@ public function createConsumer(PsrDestination $destination)
         return $consumer;
     }
 
-    public function close()
+    public function close(): void
+    {
+    }
+
+    public function createSubscriptionConsumer(): PsrSubscriptionConsumer
     {
-        // TODO: Implement close() method.
+        throw SubscriptionConsumerNotSupportedException::providerDoestNotSupportIt();
     }
 
-    public function getCollection()
+    /**
+     * @param MongodbDestination $queue
+     */
+    public function purgeQueue(PsrQueue $queue): void
+    {
+        $this->getCollection()->deleteMany([
+            'queue' => $queue->getQueueName(),
+        ]);
+    }
+
+    public function getCollection(): Collection
     {
         return $this->client
             ->selectDatabase($this->config['dbname'])
             ->selectCollection($this->config['collection_name']);
     }
 
-    /**
-     * @return Client
-     */
-    public function getClient()
+    public function getClient(): Client
     {
         return $this->client;
     }
 
-    /**
-     * @return array
-     */
-    public function getConfig()
+    public function getConfig(): array
     {
         return $this->config;
     }
 
-    public function createCollection()
+    public function createCollection(): void
     {
         $collection = $this->getCollection();
         $collection->createIndex(['priority' => -1, 'published_at' => 1], ['name' => 'enqueue_priority']);

MongodbDestination.php

@@ -12,35 +12,22 @@ class MongodbDestination implements PsrTopic, PsrQueue
      */
     private $destinationName;
 
-    /**
-     * @param string $name
-     */
-    public function __construct($name)
+    public function __construct(string $name)
     {
         $this->destinationName = $name;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getQueueName()
+    public function getQueueName(): string
     {
         return $this->destinationName;
     }
 
-    /**
-     * Alias for getQueueName()
-     * {@inheritdoc}
-     */
-    public function getName()
+    public function getTopicName(): string
     {
-        return $this->getQueueName();
+        return $this->destinationName;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getTopicName()
+    public function getName(): string
     {
         return $this->destinationName;
     }