-
-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathSQSAdapter.php
More file actions
255 lines (220 loc) · 5.96 KB
/
Copy pathSQSAdapter.php
File metadata and controls
255 lines (220 loc) · 5.96 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
<?php
declare(strict_types=1);
namespace Bow\Queue\Adapters;
use Aws\Exception\AwsException;
use Aws\Sqs\SqsClient;
use Bow\Queue\QueueTask;
use RuntimeException;
use Throwable;
class SQSAdapter extends QueueAdapter
{
/**
* Default wait time for long polling (in seconds)
*/
private const WAIT_TIME_SECONDS = 20;
/**
* The SQS client instance
*
* @var SqsClient
*/
private SqsClient $sqs;
/**
* The adapter configuration
*
* @var array
*/
private array $config = [];
/**
* Configure the SQS queue adapter
*
* @param array $config
* @return SQSAdapter
*/
public function configure(array $config): SQSAdapter
{
if (!class_exists(SqsClient::class)) {
throw new RuntimeException(
"Please install the aws/aws-sdk-php package"
);
}
$this->config = $config;
$this->sqs = new SqsClient($config);
return $this;
}
/**
* Push a task onto the queue
*
* @param QueueTask $task
* @return bool
*/
public function push(QueueTask $task): bool
{
$task->setId($this->generateId());
$params = [
"DelaySeconds" => $task->getDelay(),
"MessageAttributes" => $this->buildMessageAttributes($task),
"MessageBody" => base64_encode($this->serializeProducer($task)),
"QueueUrl" => $this->getQueueUrl(),
];
try {
$this->sqs->sendMessage($params);
return true;
} catch (AwsException $e) {
$this->logError($e);
return false;
}
}
/**
* Build message attributes for SQS
*
* @param QueueTask $task
* @return array
*/
private function buildMessageAttributes(QueueTask $task): array
{
return [
"Title" => [
"DataType" => "String",
"StringValue" => get_class($task),
],
"Id" => [
"DataType" => "String",
"StringValue" => $task->getId(),
],
];
}
/**
* Get the size of the queue
*
* @param string|null $queue
* @return int
*/
public function size(?string $queue = null): int
{
$response = $this->sqs->getQueueAttributes([
"QueueUrl" => $this->getQueue($queue),
"AttributeNames" => ["ApproximateNumberOfMessages"],
]);
$attributes = $response->get("Attributes");
return (int) $attributes["ApproximateNumberOfMessages"];
}
/**
* Process the next task on the queue
*
* @param string|null $queue
* @return void
*/
public function run(?string $queue = null): void
{
$this->sleep($this->sleep);
$message = $this->receiveMessage();
if (is_null($message)) {
$this->sleep(1);
return;
}
$this->processMessage($message);
}
/**
* Receive a message from the queue
*
* @return array|null
*/
private function receiveMessage(): ?array
{
$result = $this->sqs->receiveMessage([
"AttributeNames" => ["SentTimestamp"],
"MaxNumberOfMessages" => 1,
"MessageAttributeNames" => ["All"],
"QueueUrl" => $this->getQueueUrl(),
"WaitTimeSeconds" => self::WAIT_TIME_SECONDS,
]);
$messages = $result->get("Messages");
return empty($messages) ? null : $messages[0];
}
/**
* Process a single message from the queue
*
* @param array $message
* @return void
*/
private function processMessage(array $message): void
{
$task = null;
try {
$task = $this->unserializeProducer(base64_decode($message["Body"]));
$this->logProcessingTask($task);
$task->process();
$this->logProcessedTask($task);
$this->deleteMessage($message);
} catch (Throwable $e) {
$this->handleMessageFailure($message, $task, $e);
}
}
/**
* Handle message processing failure
*
* @param array $message
* @param QueueTask|null $task
* @param Throwable $exception
* @return void
*/
private function handleMessageFailure(array $message, ?QueueTask $task, Throwable $exception): void
{
$this->logError($exception);
cache("task:failed:" . $message["ReceiptHandle"], $message["Body"]);
$this->logFailedTask($task, $exception);
if (is_null($task)) {
$this->sleep(1);
return;
}
$task->onException($exception);
if ($task->taskShouldBeDelete()) {
$this->deleteMessage($message);
} else {
$this->changeMessageVisibility($message, $task);
}
$this->sleep(1);
}
/**
* Delete a message from the queue
*
* @param array $message
* @return void
*/
private function deleteMessage(array $message): void
{
$this->sqs->deleteMessage([
"QueueUrl" => $this->getQueueUrl(),
"ReceiptHandle" => $message["ReceiptHandle"],
]);
}
/**
* Change message visibility for retry
*
* @param array $message
* @param QueueTask $task
* @return void
*/
private function changeMessageVisibility(array $message, QueueTask $task): void
{
$this->sqs->changeMessageVisibilityBatch([
"QueueUrl" => $this->getQueueUrl(),
"Entries" => [
[
"Id" => $task->getId(),
"ReceiptHandle" => $message["ReceiptHandle"],
"VisibilityTimeout" => $task->getDelay(),
],
],
]);
}
/**
* Get the queue URL from configuration
*
* @return string
*/
private function getQueueUrl(): string
{
return $this->config["url"];
}
}