222 lines
5.6 KiB
PHP
Executable file
222 lines
5.6 KiB
PHP
Executable file
<?php
|
|
|
|
namespace Illuminate\Queue;
|
|
|
|
use Aws\Sqs\SqsClient;
|
|
use Illuminate\Contracts\Queue\ClearableQueue;
|
|
use Illuminate\Contracts\Queue\Queue as QueueContract;
|
|
use Illuminate\Queue\Jobs\SqsJob;
|
|
use Illuminate\Support\Str;
|
|
|
|
class SqsQueue extends Queue implements QueueContract, ClearableQueue
|
|
{
|
|
/**
|
|
* The Amazon SQS instance.
|
|
*
|
|
* @var \Aws\Sqs\SqsClient
|
|
*/
|
|
protected $sqs;
|
|
|
|
/**
|
|
* The name of the default queue.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $default;
|
|
|
|
/**
|
|
* The queue URL prefix.
|
|
*
|
|
* @var string
|
|
*/
|
|
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
|
|
* @param bool $dispatchAfterCommit
|
|
* @return void
|
|
*/
|
|
public function __construct(SqsClient $sqs,
|
|
$default,
|
|
$prefix = '',
|
|
$suffix = '',
|
|
$dispatchAfterCommit = false)
|
|
{
|
|
$this->sqs = $sqs;
|
|
$this->prefix = $prefix;
|
|
$this->default = $default;
|
|
$this->suffix = $suffix;
|
|
$this->dispatchAfterCommit = $dispatchAfterCommit;
|
|
}
|
|
|
|
/**
|
|
* Get the size of the queue.
|
|
*
|
|
* @param string|null $queue
|
|
* @return int
|
|
*/
|
|
public function size($queue = null)
|
|
{
|
|
$response = $this->sqs->getQueueAttributes([
|
|
'QueueUrl' => $this->getQueue($queue),
|
|
'AttributeNames' => ['ApproximateNumberOfMessages'],
|
|
]);
|
|
|
|
$attributes = $response->get('Attributes');
|
|
|
|
return (int) $attributes['ApproximateNumberOfMessages'];
|
|
}
|
|
|
|
/**
|
|
* Push a new job onto the queue.
|
|
*
|
|
* @param string $job
|
|
* @param mixed $data
|
|
* @param string|null $queue
|
|
* @return mixed
|
|
*/
|
|
public function push($job, $data = '', $queue = null)
|
|
{
|
|
return $this->enqueueUsing(
|
|
$job,
|
|
$this->createPayload($job, $queue ?: $this->default, $data),
|
|
$queue,
|
|
null,
|
|
function ($payload, $queue) {
|
|
return $this->pushRaw($payload, $queue);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Push a raw payload onto the queue.
|
|
*
|
|
* @param string $payload
|
|
* @param string|null $queue
|
|
* @param array $options
|
|
* @return mixed
|
|
*/
|
|
public function pushRaw($payload, $queue = null, array $options = [])
|
|
{
|
|
return $this->sqs->sendMessage([
|
|
'QueueUrl' => $this->getQueue($queue), 'MessageBody' => $payload,
|
|
])->get('MessageId');
|
|
}
|
|
|
|
/**
|
|
* Push a new job onto the queue after a delay.
|
|
*
|
|
* @param \DateTimeInterface|\DateInterval|int $delay
|
|
* @param string $job
|
|
* @param mixed $data
|
|
* @param string|null $queue
|
|
* @return mixed
|
|
*/
|
|
public function later($delay, $job, $data = '', $queue = null)
|
|
{
|
|
return $this->enqueueUsing(
|
|
$job,
|
|
$this->createPayload($job, $queue ?: $this->default, $data),
|
|
$queue,
|
|
$delay,
|
|
function ($payload, $queue, $delay) {
|
|
return $this->sqs->sendMessage([
|
|
'QueueUrl' => $this->getQueue($queue),
|
|
'MessageBody' => $payload,
|
|
'DelaySeconds' => $this->secondsUntil($delay),
|
|
])->get('MessageId');
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Pop the next job off of the queue.
|
|
*
|
|
* @param string|null $queue
|
|
* @return \Illuminate\Contracts\Queue\Job|null
|
|
*/
|
|
public function pop($queue = null)
|
|
{
|
|
$response = $this->sqs->receiveMessage([
|
|
'QueueUrl' => $queue = $this->getQueue($queue),
|
|
'AttributeNames' => ['ApproximateReceiveCount'],
|
|
]);
|
|
|
|
if (! is_null($response['Messages']) && count($response['Messages']) > 0) {
|
|
return new SqsJob(
|
|
$this->container, $this->sqs, $response['Messages'][0],
|
|
$this->connectionName, $queue
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete all of the jobs from the queue.
|
|
*
|
|
* @param string $queue
|
|
* @return int
|
|
*/
|
|
public function clear($queue)
|
|
{
|
|
return tap($this->size($queue), function () use ($queue) {
|
|
$this->sqs->purgeQueue([
|
|
'QueueUrl' => $this->getQueue($queue),
|
|
]);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get the queue or return the default.
|
|
*
|
|
* @param string|null $queue
|
|
* @return string
|
|
*/
|
|
public function getQueue($queue)
|
|
{
|
|
$queue = $queue ?: $this->default;
|
|
|
|
return filter_var($queue, FILTER_VALIDATE_URL) === false
|
|
? $this->suffixQueue($queue, $this->suffix)
|
|
: $queue;
|
|
}
|
|
|
|
/**
|
|
* Add the given suffix to the given queue name.
|
|
*
|
|
* @param string $queue
|
|
* @param string $suffix
|
|
* @return string
|
|
*/
|
|
protected function suffixQueue($queue, $suffix = '')
|
|
{
|
|
if (Str::endsWith($queue, '.fifo')) {
|
|
$queue = Str::beforeLast($queue, '.fifo');
|
|
|
|
return rtrim($this->prefix, '/').'/'.Str::finish($queue, $suffix).'.fifo';
|
|
}
|
|
|
|
return rtrim($this->prefix, '/').'/'.Str::finish($queue, $this->suffix);
|
|
}
|
|
|
|
/**
|
|
* Get the underlying SQS instance.
|
|
*
|
|
* @return \Aws\Sqs\SqsClient
|
|
*/
|
|
public function getSqs()
|
|
{
|
|
return $this->sqs;
|
|
}
|
|
}
|