bref/symfony-messenger-sqs

This package is abandoned and no longer maintained. The author suggests using the bref/symfony-messenger package instead.

Symfony Messenger bridge to run with SQS on AWS Lambda with Bref

0.2.0 2019-12-05 11:06 UTC

Requires

• php: ^7.3
• ext-json: *
• aws/aws-sdk-php: ^3.127
• symfony/config: ^4.3|^5.0
• symfony/dependency-injection: ^4.3|^5.0
• symfony/http-kernel: ^4.3|^5.0
• symfony/messenger: ^4.3|^5.0
• symfony/yaml: ^4.3|^5.0

Requires (Dev)

• mnapoli/hard-mode: ^0.2.0
• phpstan/phpstan: ^0.12.0
• phpunit/phpunit: ^8.0
• symfony/framework-bundle: ^4.3|^5.0

MIT

• symfony
• aws
• sqs
• Messenger
• bref
• aws-lambda

README

This package is deprecated in favor of the more generic bref/symfony-messenger.

Bridge to use Symfony Messenger with SQS on AWS Lambda with Bref.

Installation

This guide assumes that:

• Symfony is installed
• Symfony Messenger is installed
• Bref is installed and configured to deploy Symfony
• a SQS queue has already been created

First, install this package:

composer require bref/symfony-messenger-sqs

Next, register the bundle in config/bundles.php:

return [
    ...
    Bref\Messenger\BrefMessengerBundle::class => ['all' => true],
];

Next, configure Symfony Messenger to dispatch a message via SQS:

# config/packages/messenger.yaml

framework:
    messenger:
        transports:
            async: '%env(MESSENGER_TRANSPORT_DSN)%'
        routing:
             'App\Message\MyMessage': async

Here, the MyMessage class will be dispatch to the async transport. We can now configure the async transport to use our SQS queue.

To do that, let's configure the MESSENGER_TRANSPORT_DSN environment variable to contain the URL of the queue:

MESSENGER_TRANSPORT_DSN=https://sqs.us-east-1.amazonaws.com/123456789101/my-queue

Sending messages

Now that Messenger is configured with SQS, we can send messages using the MessageBusInterface. For example, in a controller:

class DefaultController extends AbstractController
{
    public function index()
    {
        $this->dispatchMessage(new App\Message\MyMessage());
    }
}

Read the Symfony documentation to learn more.

Processing message

Messages are sent to SQS, we now need to process those messages asynchronously.

We can create a Lambda to do that in serverless.yml:

functions:
    worker:
        handler: consumer.php
        timeout: 120 # in seconds
        reservedConcurrency: 5 # max. 5 messages processed in parallel
        layers:
            - ${bref:layer.php-73}
        events:
            -   sqs:
                    arn: arn:aws:sqs:us-east-1:123456789101:my-queue
                    # Only 1 item at a time to simplify error handling
                    batchSize: 1

The Lambda handler will be consumer.php, a file we must create:

<?php declare(strict_types=1);

use Bref\Messenger\Sqs\SqsConsumer;

require __DIR__ . '/config/bootstrap.php';

lambda(function ($event) {
    $kernel = new \App\Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
    $kernel->boot();

    $sqsConsumer = $kernel->getContainer()->get(SqsConsumer::class);
    $sqsConsumer->consumeLambdaEvent($event);
});

Finally, we must configure the SqsConsumer service in config/services.yaml (this configuration relies on autowiring being enabled by default):

services:
    ...

    Bref\Messenger\Sqs\SqsConsumer:
        arguments:
            # Inject the transport name used in config/packages/messenger.yaml 
            $transportName: 'async'
        public: true