-
Notifications
You must be signed in to change notification settings - Fork 54
/
IronMqProvider.php
executable file
·406 lines (343 loc) · 11.2 KB
/
IronMqProvider.php
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
<?php
/**
* Copyright 2014 Underground Elephant
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @package qpush-bundle
* @copyright Underground Elephant 2014
* @license Apache License, Version 2.0
*/
namespace Uecode\Bundle\QPushBundle\Provider;
use IronMQ\IronMQ;
use Doctrine\Common\Cache\Cache;
use Monolog\Logger;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Uecode\Bundle\QPushBundle\Event\Events;
use Uecode\Bundle\QPushBundle\Event\MessageEvent;
use Uecode\Bundle\QPushBundle\Event\NotificationEvent;
use Uecode\Bundle\QPushBundle\Message\Message;
/**
* @author Keith Kirk <[email protected]>
*/
class IronMqProvider extends AbstractProvider
{
/**
* IronMQ Client
*
* @var IronMQ
*/
private $ironmq;
/**
* IronMQ Queue
*
* @var object
*/
private $queue;
/**
* @var Message[]
*/
private $reservedMessages = [];
public function __construct($name, array $options, $client, Cache $cache, Logger $logger)
{
$this->name = $name;
$this->options = $options;
$this->ironmq = $client;
$this->cache = $cache;
$this->logger = $logger;
}
public function getProvider()
{
return "IronMQ";
}
/**
* {@inheritDoc}
*/
public function create()
{
if ($this->options['push_notifications']) {
$params = [
'type' => $this->options['push_type'],
'push' => [
'rate_limit' => $this->options['rate_limit'],
'retries' => $this->options['notification_retries'],
'retries_delay' => $this->options['notification_retries_delay'],
'subscribers' => []
]
];
foreach ($this->options['subscribers'] as $subscriber) {
if ($subscriber['protocol'] == "email") {
throw new \InvalidArgumentException(
'IronMQ only supports `http` or `https` subscribers!'
);
}
$params['push']['subscribers'][] = ['url' => $subscriber['endpoint']];
}
} else {
$params = ['type' => 'pull'];
}
$queueName = $this->getNameWithPrefix();
$this->queue = $this->ironmq->createQueue($queueName, $params);
$this->cache->save($queueName, json_encode($this->queue));
$this->log(200, "Queue has been created.", $params);
return true;
}
/**
* {@inheritDoc}
*/
public function destroy()
{
// Catch `queue not found` exceptions, throw the rest.
$queueName = $this->getNameWithPrefix();
try {
$this->ironmq->deleteQueue($queueName);
$this->queue = null;
} catch ( \Exception $e) {
if (false !== strpos($e->getMessage(), "Queue not found")) {
$this->log(400, "Queue did not exist");
} else {
throw $e;
}
}
$this->cache->delete($queueName);
$this->log(200, "Queue has been destroyed.");
return true;
}
/**
* {@inheritDoc}
*
* @return int
*/
public function publish(array $message, array $options = [])
{
$options = $this->mergeOptions($options);
$publishStart = microtime(true);
if (!$this->queueExists()) {
$this->create();
}
$result = $this->ironmq->postMessage(
$this->getNameWithPrefix(),
json_encode($message + ['_qpush_queue' => $this->name]),
[
'timeout' => $options['message_timeout'],
'delay' => $options['message_delay'],
'expires_in' => $options['message_expiration']
]
);
$context = [
'message_id' => $result->id,
'publish_time' => microtime(true) - $publishStart
];
$this->log(200, "Message has been published.", $context);
return (int) $result->id;
}
/**
* {@inheritDoc}
*/
public function receive(array $options = [])
{
$options = $this->mergeOptions($options);
if (!$this->queueExists()) {
$this->create();
}
$messages = $this->ironmq->reserveMessages(
$this->getNameWithPrefix(),
$options['messages_to_receive'],
$options['message_timeout'],
$options['receive_wait_time']
);
if (!is_array($messages)) {
$this->log(200, "No messages found in queue.");
return [];
}
// Convert to Message Class
foreach ($messages as &$message) {
$id = $message->id;
$body = json_decode($message->body, true);
$metadata = [
'reserved_count' => $message->reserved_count,
'reservation_id' => $message->reservation_id
];
unset($body['_qpush_queue']);
$message = new Message($id, json_encode($body), $metadata);
$this->log(200, "Message has been received.", ['message_id' => $id]);
}
$this->reservedMessages = array_combine(array_values(array_map(function (Message $message) {
return $message->getId();
}, $messages)), $messages);
return $messages;
}
/**
* {@inheritDoc}
*/
public function delete($id)
{
$reservationId = $this->getReservationId($id);
try {
$this->ironmq->deleteMessage($this->getNameWithPrefix(), $id, $reservationId);
$this->log(200, "Message deleted.", ['message_id' => $id]);
} catch ( \Exception $e) {
if (false !== strpos($e->getMessage(), "Queue not found")) {
$this->log(400, "Queue did not exist");
} else {
throw $e;
}
}
return true;
}
/**
* Checks whether or not the Queue exists
*
* This method relies on in-memory cache and the Cache provider
* to reduce the need to needlessly call the create method on an existing
* Queue.
* @return bool
* @throws \Exception
*/
public function queueExists()
{
if (isset($this->queue)) {
return true;
}
$queueName = $this->getNameWithPrefix();
if ($this->cache->contains($queueName)) {
$this->queue = json_decode($this->cache->fetch($queueName));
return true;
}
try {
$this->queue = $this->ironmq->getQueue($queueName);
$this->cache->save($queueName, json_encode($this->queue));
} catch (\Exception $e) {
if (false !== strpos($e->getMessage(), "Queue not found")) {
$this->log(400, "Queue did not exist");
} else {
throw $e;
}
}
return false;
}
/**
* Polls the Queue on Notification from IronMQ
*
* Dispatches the `{queue}.message_received` event
*
* @param NotificationEvent $event The Notification Event
* @param string $eventName Name of the event
* @param EventDispatcherInterface $dispatcher
* @return void
*/
public function onNotification(NotificationEvent $event, $eventName, EventDispatcherInterface $dispatcher)
{
$message = new Message(
$event->getNotification()->getId(),
$event->getNotification()->getBody(),
$event->getNotification()->getMetadata()->toArray()
);
$this->log(
200,
"Message has been received from Push Notification.",
['message_id' => $event->getNotification()->getId()]
);
$messageEvent = new MessageEvent($this->name, $message);
$dispatcher->dispatch(
Events::Message($this->name),
$messageEvent
);
}
/**
* Removes the message from queue after all other listeners have fired
*
* If an earlier listener has failed or stopped propagation, this method
* will not fire and the Queued Message should become visible in queue again.
*
* Stops Event Propagation after removing the Message
*
* @param MessageEvent $event The SQS Message Event
* @return void
*/
public function onMessageReceived(MessageEvent $event)
{
$metadata = $event->getMessage()->getMetadata();
if (!$metadata->containsKey('iron-subscriber-message-id')) {
$id = $event->getMessage()->getId();
$this->delete($id);
}
$event->stopPropagation();
}
/**
* Get queue info
*
* This allows to get queue size. Allowing to know if processing is finished or not
*
* @return mixed
*/
public function queueInfo()
{
if ($this->queueExists()) {
$queueName = $this->getNameWithPrefix();
$this->queue = $this->ironmq->getQueue($queueName);
return $this->queue;
}
return null;
}
/**
* Publishes multiple message at once
*
* @param array $messages
* @param array $options
*
* @return array
*/
public function publishMessages(array $messages, array $options = [])
{
$options = $this->mergeOptions($options);
$publishStart = microtime(true);
if (!$this->queueExists()) {
$this->create();
}
$encodedMessages = [];
foreach ($messages as $message) {
$encodedMessages[] = json_encode($message + ['_qpush_queue' => $this->name]);
}
$result = $this->ironmq->postMessages(
$this->getNameWithPrefix(),
$encodedMessages,
[
'timeout' => $options['message_timeout'],
'delay' => $options['message_delay'],
'expires_in' => $options['message_expiration']
]
);
$context = [
'message_ids' => $result->ids,
'publish_time' => microtime(true) - $publishStart
];
$this->log(200, "Messages have been published.", $context);
return $result->ids;
}
/**
* @param $id
* @return string|null
*/
private function getReservationId($id)
{
if (!array_key_exists($id, $this->reservedMessages)) {
return null;
}
$messageToDelete = $this->reservedMessages[$id];
if (!$messageToDelete->getMetadata()->containsKey('reservation_id')) {
return null;
}
return $messageToDelete->getMetadata()->get('reservation_id');
}
}