Add orderingKey support (#70)

Co-authored-by: Ali Özkan <[email protected]>

Author: aliozkan

src/PubSubQueue.php

@@ -93,7 +93,13 @@ public function size($queue = null)
      */
     public function push($job, $data = '', $queue = null)
     {
-        return $this->pushRaw($this->createPayload($job, $this->getQueue($queue), $data), $queue);
+        $options = [];
+
+        if (isset($job->orderingKey)) {
+            $options['orderingKey'] = $job->orderingKey;
+        }
+
+        return $this->pushRaw($this->createPayload($job, $this->getQueue($queue), $data), $queue, $options);
     }
 
     /**
@@ -114,8 +120,11 @@ public function pushRaw($payload, $queue = null, array $options = [])
 
         if (! empty($options)) {
             $publish['attributes'] = $this->validateMessageAttributes($options);
-        }
 
+            if (isset($options['orderingKey'])) {
+                $publish['orderingKey'] = $options['orderingKey'];
+            }
+        }
         $topic->publish($publish);
 
         $decoded_payload = json_decode($payload, true);
@@ -195,7 +204,7 @@ public function bulk($jobs, $data = '', $queue = null)
 
         foreach ((array) $jobs as $job) {
             $payload = $this->createPayload($job, $this->getQueue($queue), $data);
-            $payloads[] = ['data' => base64_encode($payload)];
+            $payloads[] = ['data' => base64_encode($payload)] + (isset($job->orderingKey) ? ['orderingKey' => $job->orderingKey] : []);
         }
 
         $topic = $this->getTopic($this->getQueue($queue), $this->topicAutoCreation);

src/Traits/HasOrderingKey.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Kainxspirits\PubSubQueue\Traits;
+
+trait HasOrderingKey
+{
+    public $orderingKey;
+
+    public function setOrderingKey(string $orderingKey): self
+    {
+        $this->orderingKey = $orderingKey;
+
+        return $this;
+    }
+}