[6.x] Added queue suffix for SQS driver (#31784)

When using multiple queues and environments it is hard to use different
queues per environment (especially when using laravel vapor).

This PR allows suffixing the queue names by optionally adding a suffix
entry to the SQS config in queue.php.

Author: scrubmx

src/Illuminate/Queue/Connectors/SqsConnector.php

@@ -23,7 +23,7 @@ public function connect(array $config)
         }
 
         return new SqsQueue(
-            new SqsClient($config), $config['queue'], $config['prefix'] ?? ''
+            new SqsClient($config), $config['queue'], $config['prefix'] ?? '', $config['suffix'] ?? ''
         );
     }
 

src/Illuminate/Queue/SqsQueue.php

@@ -29,19 +29,28 @@ class SqsQueue extends Queue implements QueueContract
      */
     protected $prefix;
 
+    /**
+     * The queue name suffix.
+     *
+     * @var string
+     */
+    private $suffix;
+
     /**
      * Create a new Amazon SQS queue instance.
      *
      * @param  \Aws\Sqs\SqsClient  $sqs
      * @param  string  $default
      * @param  string  $prefix
+     * @param  string  $suffix
      * @return void
      */
-    public function __construct(SqsClient $sqs, $default, $prefix = '')
+    public function __construct(SqsClient $sqs, $default, $prefix = '', $suffix = '')
     {
         $this->sqs = $sqs;
         $this->prefix = $prefix;
         $this->default = $default;
+        $this->suffix = $suffix;
     }
 
     /**
@@ -140,7 +149,8 @@ public function getQueue($queue)
         $queue = $queue ?: $this->default;
 
         return filter_var($queue, FILTER_VALIDATE_URL) === false
-                        ? rtrim($this->prefix, '/').'/'.$queue : $queue;
+            ? rtrim($this->prefix, '/').'/'.$queue.$this->suffix
+            : $queue;
     }
 
     /**

tests/Queue/QueueSqsQueueTest.php

@@ -145,4 +145,12 @@ public function testGetQueueProperlyResolvesUrlWithoutPrefix()
         $queueUrl = $this->baseUrl.'/'.$this->account.'/test';
         $this->assertEquals($queueUrl, $queue->getQueue($queueUrl));
     }
+
+    public function testGetQueueProperlyResolvesUrlWithSuffix()
+    {
+        $queue = new SqsQueue($this->sqs, $this->queueName, $this->prefix, $suffix = '-staging');
+        $this->assertEquals($this->queueUrl.$suffix, $queue->getQueue(null));
+        $queueUrl = $this->baseUrl.'/'.$this->account.'/test'.$suffix;
+        $this->assertEquals($queueUrl, $queue->getQueue('test'));
+    }
 }