Skip to content

Commit 6a521b8

Browse files
committed
[sqs] Migrate SQS transport.
1 parent 7a629c5 commit 6a521b8

6 files changed

Lines changed: 144 additions & 310 deletions

File tree

‎pkg/sqs/SqsConnectionFactory.php‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use Aws\Sqs\SqsClient;
66
use Interop\Queue\PsrConnectionFactory;
7+
use Interop\Queue\PsrContext;
78

89
class SqsConnectionFactory implements PsrConnectionFactory
910
{
@@ -62,11 +63,9 @@ public function __construct($config = 'sqs:')
6263
}
6364

6465
/**
65-
* {@inheritdoc}
66-
*
6766
* @return SqsContext
6867
*/
69-
public function createContext()
68+
public function createContext(): PsrContext
7069
{
7170
if ($this->config['lazy']) {
7271
return new SqsContext(function () {
@@ -77,17 +76,7 @@ public function createContext()
7776
return new SqsContext($this->establishConnection());
7877
}
7978

80-
/**
81-
* {@inheritdoc}
82-
*/
83-
public function close()
84-
{
85-
}
86-
87-
/**
88-
* @return SqsClient
89-
*/
90-
private function establishConnection()
79+
private function establishConnection(): SqsClient
9180
{
9281
if ($this->client) {
9382
return $this->client;
@@ -119,12 +108,7 @@ private function establishConnection()
119108
return $this->client;
120109
}
121110

122-
/**
123-
* @param string $dsn
124-
*
125-
* @return array
126-
*/
127-
private function parseDsn($dsn)
111+
private function parseDsn(string $dsn): array
128112
{
129113
if (false === strpos($dsn, 'sqs:')) {
130114
throw new \LogicException(sprintf('The given DSN "%s" is not supported. Must start with "sqs:".', $dsn));
@@ -148,10 +132,7 @@ private function parseDsn($dsn)
148132
return $config;
149133
}
150134

151-
/**
152-
* @return array
153-
*/
154-
private function defaultConfig()
135+
private function defaultConfig(): array
155136
{
156137
return [
157138
'key' => null,

‎pkg/sqs/SqsConsumer.php‎

Lines changed: 18 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
use Interop\Queue\InvalidMessageException;
66
use Interop\Queue\PsrConsumer;
77
use Interop\Queue\PsrMessage;
8+
use Interop\Queue\PsrQueue;
89

910
class SqsConsumer implements PsrConsumer
1011
{
@@ -33,10 +34,6 @@ class SqsConsumer implements PsrConsumer
3334
*/
3435
private $messages;
3536

36-
/**
37-
* @param SqsContext $context
38-
* @param SqsDestination $queue
39-
*/
4037
public function __construct(SqsContext $context, SqsDestination $queue)
4138
{
4239
$this->context = $context;
@@ -45,58 +42,46 @@ public function __construct(SqsContext $context, SqsDestination $queue)
4542
$this->maxNumberOfMessages = 1;
4643
}
4744

48-
/**
49-
* @return int|null
50-
*/
51-
public function getVisibilityTimeout()
45+
public function getVisibilityTimeout(): ?int
5246
{
5347
return $this->visibilityTimeout;
5448
}
5549

5650
/**
5751
* The duration (in seconds) that the received messages are hidden from subsequent retrieve
5852
* requests after being retrieved by a ReceiveMessage request.
59-
*
60-
* @param int|null $visibilityTimeout
6153
*/
62-
public function setVisibilityTimeout($visibilityTimeout)
54+
public function setVisibilityTimeout(int $visibilityTimeout = null): void
6355
{
64-
$this->visibilityTimeout = null === $visibilityTimeout ? null : (int) $visibilityTimeout;
56+
$this->visibilityTimeout = $visibilityTimeout;
6557
}
6658

67-
/**
68-
* @return int
69-
*/
70-
public function getMaxNumberOfMessages()
59+
public function getMaxNumberOfMessages(): int
7160
{
7261
return $this->maxNumberOfMessages;
7362
}
7463

7564
/**
7665
* The maximum number of messages to return. Amazon SQS never returns more messages than this value
7766
* (however, fewer messages might be returned). Valid values are 1 to 10. Default is 1.
78-
*
79-
* @param int $maxNumberOfMessages
8067
*/
81-
public function setMaxNumberOfMessages($maxNumberOfMessages)
68+
public function setMaxNumberOfMessages(int $maxNumberOfMessages): void
8269
{
83-
$this->maxNumberOfMessages = (int) $maxNumberOfMessages;
70+
$this->maxNumberOfMessages = $maxNumberOfMessages;
8471
}
8572

8673
/**
87-
* {@inheritdoc}
88-
*
8974
* @return SqsDestination
9075
*/
91-
public function getQueue()
76+
public function getQueue(): PsrQueue
9277
{
9378
return $this->queue;
9479
}
9580

9681
/**
97-
* {@inheritdoc}
82+
* @return SqsMessage
9883
*/
99-
public function receive($timeout = 0)
84+
public function receive(int $timeout = 0): ?PsrMessage
10085
{
10186
$maxLongPollingTime = 20; // 20 is max allowed long polling value
10287

@@ -118,19 +103,17 @@ public function receive($timeout = 0)
118103
}
119104

120105
/**
121-
* {@inheritdoc}
106+
* @return SqsMessage
122107
*/
123-
public function receiveNoWait()
108+
public function receiveNoWait(): ?PsrMessage
124109
{
125110
return $this->receiveMessage(0);
126111
}
127112

128113
/**
129-
* {@inheritdoc}
130-
*
131114
* @param SqsMessage $message
132115
*/
133-
public function acknowledge(PsrMessage $message)
116+
public function acknowledge(PsrMessage $message): void
134117
{
135118
InvalidMessageException::assertMessageInstanceOf($message, SqsMessage::class);
136119

@@ -141,11 +124,9 @@ public function acknowledge(PsrMessage $message)
141124
}
142125

143126
/**
144-
* {@inheritdoc}
145-
*
146127
* @param SqsMessage $message
147128
*/
148-
public function reject(PsrMessage $message, $requeue = false)
129+
public function reject(PsrMessage $message, bool $requeue = false): void
149130
{
150131
InvalidMessageException::assertMessageInstanceOf($message, SqsMessage::class);
151132

@@ -159,12 +140,7 @@ public function reject(PsrMessage $message, $requeue = false)
159140
}
160141
}
161142

162-
/**
163-
* @param int $timeoutSeconds
164-
*
165-
* @return SqsMessage|null
166-
*/
167-
protected function receiveMessage($timeoutSeconds)
143+
protected function receiveMessage(int $timeoutSeconds): ?SqsMessage
168144
{
169145
if ($message = array_pop($this->messages)) {
170146
return $this->convertMessage($message);
@@ -191,14 +167,11 @@ protected function receiveMessage($timeoutSeconds)
191167
if ($message = array_pop($this->messages)) {
192168
return $this->convertMessage($message);
193169
}
170+
171+
return null;
194172
}
195173

196-
/**
197-
* @param array $sqsMessage
198-
*
199-
* @return SqsMessage
200-
*/
201-
protected function convertMessage(array $sqsMessage)
174+
protected function convertMessage(array $sqsMessage): SqsMessage
202175
{
203176
$message = $this->context->createMessage();
204177

‎pkg/sqs/SqsContext.php‎

Lines changed: 35 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,16 @@
44

55
use Aws\Sqs\SqsClient;
66
use Interop\Queue\InvalidDestinationException;
7+
use Interop\Queue\PsrConsumer;
78
use Interop\Queue\PsrContext;
89
use Interop\Queue\PsrDestination;
10+
use Interop\Queue\PsrMessage;
11+
use Interop\Queue\PsrProducer;
12+
use Interop\Queue\PsrQueue;
13+
use Interop\Queue\PsrSubscriptionConsumer;
14+
use Interop\Queue\PsrTopic;
15+
use Interop\Queue\SubscriptionConsumerNotSupportedException;
16+
use Interop\Queue\TemporaryQueueNotSupportedException;
917

1018
class SqsContext implements PsrContext
1119
{
@@ -45,78 +53,76 @@ public function __construct($client)
4553
}
4654

4755
/**
48-
* {@inheritdoc}
49-
*
5056
* @return SqsMessage
5157
*/
52-
public function createMessage($body = '', array $properties = [], array $headers = [])
58+
public function createMessage(string $body = '', array $properties = [], array $headers = []): PsrMessage
5359
{
5460
return new SqsMessage($body, $properties, $headers);
5561
}
5662

5763
/**
58-
* {@inheritdoc}
59-
*
6064
* @return SqsDestination
6165
*/
62-
public function createTopic($topicName)
66+
public function createTopic(string $topicName): PsrTopic
6367
{
6468
return new SqsDestination($topicName);
6569
}
6670

6771
/**
68-
* {@inheritdoc}
69-
*
7072
* @return SqsDestination
7173
*/
72-
public function createQueue($queueName)
74+
public function createQueue(string $queueName): PsrQueue
7375
{
7476
return new SqsDestination($queueName);
7577
}
7678

77-
/**
78-
* {@inheritdoc}
79-
*/
80-
public function createTemporaryQueue()
79+
public function createTemporaryQueue(): PsrQueue
8180
{
82-
throw new \BadMethodCallException('SQS transport does not support temporary queues');
81+
throw TemporaryQueueNotSupportedException::providerDoestNotSupportIt();
8382
}
8483

8584
/**
86-
* {@inheritdoc}
87-
*
8885
* @return SqsProducer
8986
*/
90-
public function createProducer()
87+
public function createProducer(): PsrProducer
9188
{
9289
return new SqsProducer($this);
9390
}
9491

9592
/**
96-
* {@inheritdoc}
97-
*
9893
* @param SqsDestination $destination
9994
*
10095
* @return SqsConsumer
10196
*/
102-
public function createConsumer(PsrDestination $destination)
97+
public function createConsumer(PsrDestination $destination): PsrConsumer
10398
{
10499
InvalidDestinationException::assertDestinationInstanceOf($destination, SqsDestination::class);
105100

106101
return new SqsConsumer($this, $destination);
107102
}
108103

109-
/**
110-
* {@inheritdoc}
111-
*/
112-
public function close()
104+
public function close(): void
113105
{
114106
}
115107

116108
/**
117-
* @return SqsClient
109+
* @param SqsDestination $queue
118110
*/
119-
public function getClient()
111+
public function purgeQueue(PsrQueue $queue): void
112+
{
113+
InvalidDestinationException::assertDestinationInstanceOf($queue, SqsDestination::class);
114+
115+
$this->getClient()->purgeQueue([
116+
'QueueUrl' => $this->getQueueUrl($queue),
117+
]);
118+
}
119+
120+
public function createSubscriptionConsumer(): PsrSubscriptionConsumer
121+
{
122+
throw SubscriptionConsumerNotSupportedException::providerDoestNotSupportIt();
123+
}
124+
125+
public function getClient(): SqsClient
120126
{
121127
if (false == $this->client) {
122128
$client = call_user_func($this->clientFactory);
@@ -134,12 +140,7 @@ public function getClient()
134140
return $this->client;
135141
}
136142

137-
/**
138-
* @param SqsDestination $destination
139-
*
140-
* @return string
141-
*/
142-
public function getQueueUrl(SqsDestination $destination)
143+
public function getQueueUrl(SqsDestination $destination): string
143144
{
144145
if (isset($this->queueUrls[$destination->getQueueName()])) {
145146
return $this->queueUrls[$destination->getQueueName()];
@@ -156,10 +157,7 @@ public function getQueueUrl(SqsDestination $destination)
156157
return $this->queueUrls[$destination->getQueueName()] = $result->get('QueueUrl');
157158
}
158159

159-
/**
160-
* @param SqsDestination $dest
161-
*/
162-
public function declareQueue(SqsDestination $dest)
160+
public function declareQueue(SqsDestination $dest): void
163161
{
164162
$result = $this->getClient()->createQueue([
165163
'Attributes' => $dest->getAttributes(),
@@ -173,25 +171,12 @@ public function declareQueue(SqsDestination $dest)
173171
$this->queueUrls[$dest->getQueueName()] = $result->get('QueueUrl');
174172
}
175173

176-
/**
177-
* @param SqsDestination $dest
178-
*/
179-
public function deleteQueue(SqsDestination $dest)
174+
public function deleteQueue(SqsDestination $dest): void
180175
{
181176
$this->getClient()->deleteQueue([
182177
'QueueUrl' => $this->getQueueUrl($dest),
183178
]);
184179

185180
unset($this->queueUrls[$dest->getQueueName()]);
186181
}
187-
188-
/**
189-
* @param SqsDestination $destination
190-
*/
191-
public function purgeQueue(SqsDestination $destination)
192-
{
193-
$this->getClient()->purgeQueue([
194-
'QueueUrl' => $this->getQueueUrl($destination),
195-
]);
196-
}
197182
}

0 commit comments

Comments
 (0)