Repository navigation
Expand file tree
/
Copy pathSqsQueue.php
More file actions
executable file
·725 lines (630 loc) · 20.6 KB
/
Copy pathSqsQueue.php
File metadata and controls
executable file
·725 lines (630 loc) · 20.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
<?php
namespace Illuminate\Queue;
use Aws\Command;
use Aws\Sqs\Exception\SqsException;
use Aws\Sqs\SqsClient;
use Illuminate\Contracts\Queue\ClearableQueue;
use Illuminate\Contracts\Queue\Queue as QueueContract;
use Illuminate\Queue\Attributes\Delay;
use Illuminate\Queue\Jobs\SqsJob;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use function Illuminate\Support\enum_value;
class SqsQueue extends Queue implements QueueContract, ClearableQueue
{
/**
* The maximum SQS payload size in bytes (1 MB).
*
* @var int
*/
const MAX_SQS_PAYLOAD_SIZE = 1048576;
/**
* The maximum number of messages allowed per SendMessageBatch request.
*
* @var int
*/
const MAX_MESSAGES_PER_BATCH = 10;
/**
* The cache key prefix for extended SQS payloads.
*
* @var string
*/
const EXTENDED_PAYLOAD_CACHE_PREFIX = 'laravel:sqs-payloads:';
/**
* 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
*/
protected $suffix;
/**
* The overflow storage options for large payload offloading.
*
* @var array
*/
protected $overflowStorage = [];
/**
* Create a new Amazon SQS queue instance.
*
* @param \Aws\Sqs\SqsClient $sqs
* @param string $default
* @param string $prefix
* @param string $suffix
* @param bool $dispatchAfterCommit
* @param array $overflowStorage
*/
public function __construct(
SqsClient $sqs,
$default,
$prefix = '',
$suffix = '',
$dispatchAfterCommit = false,
array $overflowStorage = [],
) {
$this->sqs = $sqs;
$this->prefix = $prefix;
$this->default = $default;
$this->suffix = $suffix;
$this->dispatchAfterCommit = $dispatchAfterCommit;
$this->overflowStorage = $overflowStorage;
}
/**
* Get the size of the queue.
*
* @param \UnitEnum|string|null $queue
* @return int
*/
public function size($queue = null)
{
$response = $this->sqs->getQueueAttributes([
'QueueUrl' => $this->getQueue($queue),
'AttributeNames' => [
'ApproximateNumberOfMessages',
'ApproximateNumberOfMessagesDelayed',
'ApproximateNumberOfMessagesNotVisible',
],
]);
$a = $response['Attributes'];
return (int) $a['ApproximateNumberOfMessages']
+ (int) $a['ApproximateNumberOfMessagesDelayed']
+ (int) $a['ApproximateNumberOfMessagesNotVisible'];
}
/**
* Get the number of pending jobs.
*
* @param \UnitEnum|string|null $queue
* @return int
*/
public function pendingSize($queue = null)
{
$response = $this->sqs->getQueueAttributes([
'QueueUrl' => $this->getQueue($queue),
'AttributeNames' => ['ApproximateNumberOfMessages'],
]);
return (int) ($response['Attributes']['ApproximateNumberOfMessages'] ?? 0);
}
/**
* Get the number of delayed jobs.
*
* @param \UnitEnum|string|null $queue
* @return int
*/
public function delayedSize($queue = null)
{
$response = $this->sqs->getQueueAttributes([
'QueueUrl' => $this->getQueue($queue),
'AttributeNames' => ['ApproximateNumberOfMessagesDelayed'],
]);
return (int) ($response['Attributes']['ApproximateNumberOfMessagesDelayed'] ?? 0);
}
/**
* Get the number of reserved jobs.
*
* @param \UnitEnum|string|null $queue
* @return int
*/
public function reservedSize($queue = null)
{
$response = $this->sqs->getQueueAttributes([
'QueueUrl' => $this->getQueue($queue),
'AttributeNames' => ['ApproximateNumberOfMessagesNotVisible'],
]);
return (int) ($response['Attributes']['ApproximateNumberOfMessagesNotVisible'] ?? 0);
}
/**
* Get the number of jobs across every queue.
*
* @return int
*/
public function totalSize()
{
return 0;
}
/**
* Get the number of pending jobs across every queue.
*
* @return int
*/
public function totalPendingSize()
{
return 0;
}
/**
* Get the number of delayed jobs across every queue.
*
* @return int
*/
public function totalDelayedSize()
{
return 0;
}
/**
* Get the number of reserved jobs across every queue.
*
* @return int
*/
public function totalReservedSize()
{
return 0;
}
/**
* Get the pending jobs for the given queue.
*
* @param \UnitEnum|string|null $queue
* @return \Illuminate\Support\Collection
*/
public function pendingJobs($queue = null): Collection
{
return new Collection;
}
/**
* Get the delayed jobs for the given queue.
*
* @param \UnitEnum|string|null $queue
* @return \Illuminate\Support\Collection
*/
public function delayedJobs($queue = null): Collection
{
return new Collection;
}
/**
* Get the reserved jobs for the given queue.
*
* @param \UnitEnum|string|null $queue
* @return \Illuminate\Support\Collection
*/
public function reservedJobs($queue = null): Collection
{
return new Collection;
}
/**
* Get all pending jobs across every queue.
*
* @return \Illuminate\Support\Collection
*/
public function allPendingJobs(): Collection
{
return new Collection;
}
/**
* Get all delayed jobs across every queue.
*
* @return \Illuminate\Support\Collection
*/
public function allDelayedJobs(): Collection
{
return new Collection;
}
/**
* Get all reserved jobs across every queue.
*
* @return \Illuminate\Support\Collection
*/
public function allReservedJobs(): Collection
{
return new Collection;
}
/**
* Get the creation timestamp of the oldest pending job, excluding delayed jobs.
*
* Not supported by SQS, returns null.
*
* @param \UnitEnum|string|null $queue
* @return int|null
*/
public function creationTimeOfOldestPendingJob($queue = null)
{
// Not supported by SQS...
return null;
}
/**
* Push a new job onto the queue.
*
* @param string $job
* @param mixed $data
* @param \UnitEnum|string|null $queue
* @return mixed
*/
public function push($job, $data = '', $queue = null)
{
return $this->enqueueUsing(
$job,
$this->createPayload($job, enum_value($queue) ?: $this->default, $data),
$queue,
null,
function ($payload, $queue) use ($job) {
return $this->pushRaw($payload, $queue, $this->getQueueableOptions($job, $queue, $payload));
}
);
}
/**
* Push a raw payload onto the queue.
*
* @param string $payload
* @param \UnitEnum|string|null $queue
* @param array $options
* @return mixed
*/
public function pushRaw($payload, $queue = null, array $options = [])
{
if ($this->willOverflow($payload)) {
$payload = $this->overflow($payload);
}
return $this->sqs->sendMessage([
'QueueUrl' => $this->getQueue($queue), 'MessageBody' => $payload, ...$options,
])->get('MessageId');
}
/**
* Push a new job onto the queue after (n) seconds.
*
* @param \DateTimeInterface|\DateInterval|int $delay
* @param string $job
* @param mixed $data
* @param \UnitEnum|string|null $queue
* @return mixed
*/
public function later($delay, $job, $data = '', $queue = null)
{
return $this->enqueueUsing(
$job,
$this->createPayload($job, enum_value($queue) ?: $this->default, $data, $delay),
$queue,
$delay,
function ($payload, $queue, $delay) use ($job) {
return $this->pushRaw($payload, $queue, $this->getQueueableOptions($job, $queue, $payload, $delay));
}
);
}
/**
* Push an array of jobs onto the queue using the SendMessageBatch API.
*
* @param array $jobs
* @param mixed $data
* @param \UnitEnum|string|null $queue
* @return void
*/
public function bulk($jobs, $data = '', $queue = null)
{
$queue = enum_value($queue);
$jobs = array_values((array) $jobs);
if (empty($jobs)) {
return;
}
[$afterCommit, $immediate] = $this->partitionJobsByAfterCommit($jobs);
if (! empty($immediate)) {
$this->sendBatchedMessages($this->prepareBatchMessages($immediate, $data, $queue), $queue);
}
if (! empty($afterCommit)) {
foreach ($afterCommit as $job) {
$this->registerRollbackCallbacksForJobsThatDispatchAfterCommit($job);
}
$messages = $this->prepareBatchMessages($afterCommit, $data, $queue);
$this->container->make('db.transactions')->addCallback(
fn () => $this->sendBatchedMessages($messages, $queue),
);
}
}
/**
* Create the payload for each of the given jobs.
*
* Payloads are created at dispatch time, even for jobs deferred until after the transaction commits.
*
* @param array $jobs
* @param mixed $data
* @param string|null $queue
* @return array<int, array{job: mixed, delay: mixed, payload: string}>
*/
protected function prepareBatchMessages(array $jobs, $data, $queue)
{
return (new Collection($jobs))
->map(function ($job) use ($data, $queue) {
$delay = is_object($job) ? $this->getAttributeValue($job, Delay::class, 'delay') : null;
return [
'job' => $job,
'delay' => $delay,
'payload' => $this->createPayload($job, enum_value($queue) ?: $this->default, $data, $delay),
];
})
->all();
}
/**
* Build entries, raise queueing events, dispatch chunks, and raise queued events with SQS message IDs.
*
* @param array $messages
* @param string|null $queue
* @return void
*
* @throws \Aws\Sqs\Exception\SqsException
* @throws \Throwable
*/
protected function sendBatchedMessages(array $messages, $queue)
{
$entries = [];
foreach ($messages as $id => $message) {
$this->raiseJobQueueingEvent($queue, $message['job'], $message['payload'], $message['delay']);
$entries[$id] = $this->prepareSendMessageBatchEntry($id, $message, $queue);
}
$queueUrl = $this->getQueue($queue);
// Dispatch chunks and stop at the first failure so later messages cannot arrive ahead of unsent ones...
foreach ($this->chunkBatchEntries($entries) as $chunk) {
$result = $this->sqs->sendMessageBatch([
'QueueUrl' => $queueUrl,
'Entries' => $chunk,
]);
foreach ($result['Successful'] ?? [] as $success) {
if (! isset($messages[$success['Id']])) {
continue;
}
$message = $messages[$success['Id']];
$this->raiseJobQueuedEvent(
$queue, $success['MessageId'], $message['job'], $message['payload'], $message['delay']
);
}
// A batch can return HTTP 200 while rejecting entries, so surface those failures as an SqsException...
if (! empty($result['Failed'])) {
$failure = $result['Failed'][0];
throw new SqsException(
sprintf(
'SQS SendMessageBatch rejected [%d] of [%d] messages. First failure [%s]: %s',
count($result['Failed']),
count($chunk),
$failure['Code'] ?? 'Unknown',
$failure['Message'] ?? '',
),
new Command('SendMessageBatch', ['QueueUrl' => $queueUrl, 'Entries' => $chunk]),
[
'code' => $failure['Code'] ?? null,
'message' => $failure['Message'] ?? null,
'result' => $result,
],
);
}
}
}
/**
* Build the SendMessageBatch entry for a single prepared message.
*
* The entry Id maps each Successful or Failed result returned by SQS back to its job.
*
* @param int $id
* @param array{job: mixed, delay: mixed, payload: string} $message
* @param string|null $queue
* @return array
*/
protected function prepareSendMessageBatchEntry($id, array $message, $queue)
{
['job' => $job, 'delay' => $delay, 'payload' => $payload] = $message;
return [
'Id' => (string) $id,
'MessageBody' => $this->willOverflow($payload) ? $this->overflow($payload) : $payload,
...$this->getQueueableOptions($job, $queue, $payload, $delay),
];
}
/**
* Chunk batch entries respecting both the 10-message and cumulative payload-size limits enforced by SendMessageBatch.
*
* @param array $entries
* @return array
*/
protected function chunkBatchEntries(array $entries)
{
[$chunks, $currentChunk, $currentBytes] = [[], [], 0];
foreach ($entries as $item) {
$bytes = strlen($item['MessageBody']);
$wouldExceedCount = count($currentChunk) >= static::MAX_MESSAGES_PER_BATCH;
$wouldExceedBytes = $currentBytes + $bytes > static::MAX_SQS_PAYLOAD_SIZE;
if (! empty($currentChunk) && ($wouldExceedCount || $wouldExceedBytes)) {
$chunks[] = $currentChunk;
$currentChunk = [];
$currentBytes = 0;
}
$currentChunk[] = $item;
$currentBytes += $bytes;
}
if (! empty($currentChunk)) {
$chunks[] = $currentChunk;
}
return $chunks;
}
/**
* Determine if the payload should be stored in cache.
*
* @param string $payload
* @return bool
*/
protected function willOverflow($payload)
{
if (! Arr::get($this->overflowStorage, 'enabled', false)) {
return false;
}
return Arr::get($this->overflowStorage, 'always', false)
|| strlen($payload) >= static::MAX_SQS_PAYLOAD_SIZE;
}
/**
* Store the payload in cache and return a pointer payload.
*
* @param string $payload
* @return string
*/
protected function overflow($payload)
{
$decoded = json_decode($payload);
$uuid = is_object($decoded) && isset($decoded->uuid)
? $decoded->uuid
: (string) Str::uuid();
$this->container->make('cache')->store(
Arr::get($this->overflowStorage, 'store')
)->put(
$path = static::EXTENDED_PAYLOAD_CACHE_PREFIX.$uuid, $payload
);
return json_encode(['@pointer' => $path]);
}
/**
* Get the queueable options from the job.
*
* @param mixed $job
* @param string|null $queue
* @param string $payload
* @param \DateTimeInterface|\DateInterval|int|null $delay
* @return array{DelaySeconds?: int, MessageGroupId?: string, MessageDeduplicationId?: string}
*/
public function getQueueableOptions($job, $queue, $payload, $delay = null): array
{
// Make sure we have a queue name to properly determine if it's a FIFO queue...
$queue = $this->resolveQueue(enum_value($queue) ?? $this->default);
$isObject = is_object($job);
$isFifo = str_ends_with((string) $queue, '.fifo');
$options = [];
// DelaySeconds cannot be used with FIFO queues. AWS will return an error...
if (! empty($delay) && ! $isFifo) {
$options['DelaySeconds'] = $this->secondsUntil($delay);
}
// If the job is a string job on a standard queue, there are no more options...
if (! $isObject && ! $isFifo) {
return $options;
}
$transformToString = fn ($value) => (string) $value;
// The message group ID is required for FIFO queues and is optional for
// standard queues. Job objects contain a group ID. With string jobs
// sent to FIFO queues, assign these to the same message group ID.
$messageGroupId = null;
if ($isObject) {
$messageGroupId = transform($job->messageGroup ?? (method_exists($job, 'messageGroup') ? $job->messageGroup() : null), $transformToString);
}
if ($isFifo && is_null($messageGroupId)) {
$messageGroupId = transform($queue, $transformToString);
}
$options['MessageGroupId'] = $messageGroupId;
// The message deduplication ID is only valid for FIFO queues. Every job
// without the method will be considered unique. To use content-based
// deduplication enable it in AWS and have the method return empty.
$messageDeduplicationId = null;
if ($isFifo) {
$messageDeduplicationId = match (true) {
$isObject && isset($job->deduplicator) && is_callable($job->deduplicator) => transform(
call_user_func($job->deduplicator, $payload, $queue), $transformToString
),
$isObject && method_exists($job, 'deduplicationId') => transform(
$job->deduplicationId($payload, $queue), $transformToString
),
default => (string) Str::orderedUuid(),
};
}
$options['MessageDeduplicationId'] = $messageDeduplicationId;
return array_filter($options);
}
/**
* Pop the next job off of the queue.
*
* @param \UnitEnum|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, $this->overflowStorage
);
}
}
/**
* Delete all of the jobs from the queue.
*
* @param string|null $queue
* @return int
*/
public function clear($queue = null)
{
return tap($this->size($queue), function () use ($queue) {
$this->sqs->purgeQueue([
'QueueUrl' => $this->getQueue($queue),
]);
if (Arr::get($this->overflowStorage, 'enabled')
&& Arr::get($this->overflowStorage, 'flush_on_clear')) {
$this->container->make('cache')->store(
Arr::get($this->overflowStorage, 'store')
)->flush();
}
});
}
/**
* Get the queue or return the default.
*
* @param \UnitEnum|string|null $queue
* @return string
*/
public function getQueue($queue)
{
$queue = $this->resolveQueue(enum_value($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_ends_with($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;
}
}