Adding service providers for the laravel packages (#572)

* Adding service providers for the laravel packages * Fix for DynamoDb * Updated baseline * minor * Fixes * Added cache docs * cs * baseline * Added support for more config * Added link in readle * Bugfix * wording * CI fix * Added links on README * Added test to serialize * Remove laravel 7 feature * added docs * More doxs
async-aws · May 9, 2020 · af10009 · af10009
1 parent fb0179f
commit af10009
Show file tree

Hide file tree

Showing 11 changed files with 501 additions and 12 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,16 +20,12 @@ jobs:
         uses: shivammathur/[email protected]
         with:
           php-version: ${{ matrix.php }}
-          coverage: xdebug
-          ini-values: xdebug.overload_var_dump=1
-          tools: prestissimo
+          coverage: none
+          tools: flex
 
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Initialize tests
-        run: make initialize
-
       - name: Download dependencies
         run: |
           composer config minimum-stability dev

diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ composer require async-aws/illuminate-queue
 
 ## Documentation
 
-See https://async-aws.com/ for documentation.
+See https://async-aws.com/integration/laravel.html for documentation.
 
 ## Contribute
 

diff --git a/composer.json b/composer.json
@@ -13,12 +13,18 @@
     "license": "MIT",
     "require": {
         "php": "^7.2.5",
-        "async-aws/sqs": "^1.0",
-        "illuminate/queue": "^6.18.11 || ^7.10"
+        "async-aws/sqs": "^1.1",
+        "illuminate/queue": "^6.18.11 || ^7.10",
+        "illuminate/support": "^6.18.13 || ^7.10"
     },
     "extra": {
         "branch-alias": {
             "dev-master": "0.1-dev"
+        },
+        "laravel": {
+            "providers": [
+                "AsyncAws\\Illuminate\\Queue\\ServiceProvider"
+            ]
         }
     },
     "autoload": {

diff --git a/src/AsyncAwsSqsQueue.php b/src/AsyncAwsSqsQueue.php
@@ -3,6 +3,7 @@
 namespace AsyncAws\Illuminate\Queue;
 
 use AsyncAws\Illuminate\Queue\Job\AsyncAwsSqsJob;
+use AsyncAws\Sqs\Enum\MessageSystemAttributeName;
 use AsyncAws\Sqs\Enum\QueueAttributeName;
 use AsyncAws\Sqs\SqsClient;
 use Illuminate\Contracts\Queue\Job;
@@ -138,7 +139,7 @@ public function pop($queue = null)
     {
         $response = $this->sqs->receiveMessage([
             'QueueUrl' => $queue = $this->getQueue($queue),
-            'AttributeNames' => ['ApproximateReceiveCount'],
+            'AttributeNames' => [MessageSystemAttributeName::APPROXIMATE_RECEIVE_COUNT],
         ]);
 
         foreach ($response->getMessages() as $message) {
@@ -161,7 +162,7 @@ public function pop($queue = null)
      *
      * @return string
      */
-    public function getQueue($queue)
+    public function getQueue($queue = null)
     {
         $queue = $queue ?: $this->default;
 

diff --git a/src/Connector/AsyncAwsSqsConnector.php b/src/Connector/AsyncAwsSqsConnector.php
@@ -18,12 +18,16 @@ class AsyncAwsSqsConnector implements ConnectorInterface
     public function connect(array $config)
     {
         $clientConfig = [];
-        if ($config['key'] && $config['secret']) {
+        if (isset($config['key']) && isset($config['secret'])) {
             $clientConfig['accessKeyId'] = $config['key'] ?? null;
             $clientConfig['accessKeySecret'] = $config['secret'] ?? null;
             $clientConfig['sessionToken'] = $config['token'] ?? null;
         }
 
+        if (!empty($config['region'])) {
+            $clientConfig['region'] = $config['region'];
+        }
+
         return new AsyncAwsSqsQueue(
             new SqsClient($clientConfig, null, HttpClient::create(['timeout' => 30])),
             $config['queue'],

diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AsyncAws\Illuminate\Queue;
+
+use AsyncAws\Illuminate\Queue\Connector\AsyncAwsSqsConnector;
+use Illuminate\Queue\QueueManager;
+use Illuminate\Support\ServiceProvider as AbstractServiceProvider;
+
+class ServiceProvider extends AbstractServiceProvider
+{
+    public function boot()
+    {
+        /** @var QueueManager $manager */
+        $manager = $this->app['queue'];
+
+        $manager->addConnector('async-aws-sqs', \Closure::fromCallable([$this, 'createConnector']));
+    }
+
+    public function createConnector(): AsyncAwsSqsConnector
+    {
+        return new AsyncAwsSqsConnector();
+    }
+}
diff --git a/tests/Resource/CreateUser.php b/tests/Resource/CreateUser.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AsyncAws\Illuminate\Queue\Tests\Resource;
+
+class CreateUser
+{
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var string
+     */
+    private $email;
+
+    public function __construct(string $name, string $email)
+    {
+        $this->name = $name;
+        $this->email = $email;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getEmail(): string
+    {
+        return $this->email;
+    }
+}
diff --git a/tests/Unit/AsyncAwsSqsQueueTest.php b/tests/Unit/AsyncAwsSqsQueueTest.php
@@ -0,0 +1,218 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AsyncAws\Illuminate\Queue\Tests\Unit;
+
+use AsyncAws\Core\Test\ResultMockFactory;
+use AsyncAws\Illuminate\Queue\AsyncAwsSqsQueue;
+use AsyncAws\Illuminate\Queue\Job\AsyncAwsSqsJob;
+use AsyncAws\Illuminate\Queue\Tests\Resource\CreateUser;
+use AsyncAws\Sqs\Enum\MessageSystemAttributeName;
+use AsyncAws\Sqs\Enum\QueueAttributeName;
+use AsyncAws\Sqs\Result\GetQueueAttributesResult;
+use AsyncAws\Sqs\Result\ReceiveMessageResult;
+use AsyncAws\Sqs\Result\SendMessageResult;
+use AsyncAws\Sqs\SqsClient;
+use AsyncAws\Sqs\ValueObject\Message;
+use Illuminate\Container\Container;
+use PHPUnit\Framework\TestCase;
+
+class AsyncAwsSqsQueueTest extends TestCase
+{
+    private $queue = 'https://sqs.us-east-2.amazonaws.com/123456789012/invoice';
+
+    public function testSize()
+    {
+        $result = ResultMockFactory::create(GetQueueAttributesResult::class, [
+            'Attributes' => [QueueAttributeName::APPROXIMATE_NUMBER_OF_MESSAGES => 4],
+        ]);
+
+        $sqs = $this->getMockBuilder(SqsClient::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['getQueueAttributes'])
+            ->getMock();
+
+        $sqs->expects(self::once())
+            ->method('getQueueAttributes')
+            ->with(self::callback(function (array $input) {
+                if ($input['QueueUrl'] !== $this->queue) {
+                    return false;
+                }
+
+                if (!isset($input['AttributeNames'])) {
+                    return false;
+                }
+
+                if ([QueueAttributeName::APPROXIMATE_NUMBER_OF_MESSAGES] !== $input['AttributeNames']) {
+                    return false;
+                }
+
+                return true;
+            }))
+            ->willReturn($result);
+
+        $queue = new AsyncAwsSqsQueue($sqs, $this->queue);
+        self::assertEquals(4, $queue->size());
+    }
+
+    public function testPush()
+    {
+        $result = ResultMockFactory::create(SendMessageResult::class, [
+            'MessageId' => 'my-id',
+        ]);
+
+        $sqs = $this->getMockBuilder(SqsClient::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['sendMessage'])
+            ->getMock();
+
+        $sqs->expects(self::once())
+            ->method('sendMessage')
+            ->with(self::callback(function (array $input) {
+                if ($input['QueueUrl'] !== $this->queue) {
+                    return false;
+                }
+
+                if (!isset($input['MessageBody'])) {
+                    return false;
+                }
+
+                // verify that body is serialized.
+                $body = json_decode($input['MessageBody'], true);
+                $this->assertArrayHasKey('displayName', $body);
+                $this->assertArrayHasKey('job', $body);
+                $this->assertArrayHasKey('data', $body);
+
+                if (CreateUser::class !== $body['displayName']) {
+                    return false;
+                }
+
+                return true;
+            }))
+            ->willReturn($result);
+
+        $queue = new AsyncAwsSqsQueue($sqs, $this->queue);
+        $output = $queue->push(new CreateUser('Alic', '[email protected]'));
+        self::assertEquals('my-id', $output);
+    }
+
+    public function testPushRaw()
+    {
+        $result = ResultMockFactory::create(SendMessageResult::class, [
+            'MessageId' => 'my-id',
+        ]);
+
+        $sqs = $this->getMockBuilder(SqsClient::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['sendMessage'])
+            ->getMock();
+
+        $sqs->expects(self::once())
+            ->method('sendMessage')
+            ->with(self::callback(function (array $input) {
+                if ($input['QueueUrl'] !== $this->queue) {
+                    return false;
+                }
+
+                if (!isset($input['MessageBody'])) {
+                    return false;
+                }
+
+                if ('payload' !== $input['MessageBody']) {
+                    return false;
+                }
+
+                return true;
+            }))
+            ->willReturn($result);
+
+        $queue = new AsyncAwsSqsQueue($sqs, $this->queue);
+        self::assertEquals('my-id', $queue->pushRaw('payload'));
+    }
+
+    public function testLater()
+    {
+        $result = ResultMockFactory::create(SendMessageResult::class, [
+            'MessageId' => 'my-id',
+        ]);
+
+        $sqs = $this->getMockBuilder(SqsClient::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['sendMessage'])
+            ->getMock();
+
+        $sqs->expects(self::once())
+            ->method('sendMessage')
+            ->with(self::callback(function (array $input) {
+                if ($input['QueueUrl'] !== $this->queue) {
+                    return false;
+                }
+
+                if (47 !== $input['DelaySeconds']) {
+                    return false;
+                }
+
+                if (!isset($input['MessageBody'])) {
+                    return false;
+                }
+
+                if (false === strpos($input['MessageBody'], 'my-custom-payload')) {
+                    return false;
+                }
+
+                return true;
+            }))
+            ->willReturn($result);
+
+        $queue = new AsyncAwsSqsQueue($sqs, $this->queue);
+        self::assertEquals('my-id', $queue->later(47, 'my-custom-payload'));
+    }
+
+    public function testPop()
+    {
+        $data = [
+            'Body' => '{"uuid":"401eddde-fd9e-4dcd-83f3-d1ffe2ec4259","displayName":"AsyncAws\\\Illuminate\\\Queue\\\Tests\\\Resource\\\CreateUser","job":"Illuminate\\\Queue\\\CallQueuedHandler@call","maxTries":null,"maxExceptions":null,"delay":null,"timeout":null,"timeoutAt":null,"data":{"commandName":"AsyncAws\\\Illuminate\\\Queue\\\Tests\\\Resource\\\CreateUser","command":"O:51:\"AsyncAws\\\Illuminate\\\Queue\\\Tests\\\Resource\\\CreateUser\":2:{s:57:\"\u0000AsyncAws\\\Illuminate\\\Queue\\\Tests\\\Resource\\\CreateUser\u0000name\";s:4:\"Alic\";s:58:\"\u0000AsyncAws\\\Illuminate\\\Queue\\\Tests\\\Resource\\\CreateUser\u0000email\";s:17:\"[email protected]\";}"}}',
+            'MessageId' => 'message-id-example',
+            'Attributes' => ['ApproximateReceiveCount' => '3'],
+            'ReceiptHandle' => '123',
+        ];
+        $message = new Message($data);
+
+        $result = ResultMockFactory::create(ReceiveMessageResult::class, [
+            'Messages' => [$message],
+        ]);
+
+        $sqs = $this->getMockBuilder(SqsClient::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['receiveMessage'])
+            ->getMock();
+
+        $sqs->expects(self::once())
+            ->method('receiveMessage')
+            ->with(self::callback(function (array $input) {
+                if ($input['QueueUrl'] !== $this->queue) {
+                    return false;
+                }
+
+                if (!isset($input['AttributeNames'])) {
+                    return false;
+                }
+
+                if ([MessageSystemAttributeName::APPROXIMATE_RECEIVE_COUNT] !== $input['AttributeNames']) {
+                    return false;
+                }
+
+                return true;
+            }))
+            ->willReturn($result);
+
+        $queue = new AsyncAwsSqsQueue($sqs, $this->queue);
+        $queue->setContainer(new Container());
+        $queue->setConnectionName('connection-name');
+        $job = $queue->pop();
+
+        self::assertInstanceOf(AsyncAwsSqsJob::class, $job);
+        self::assertEquals($data, $job->getSqsJob());
+    }
+}