zackyjack/laravel-sqs-sns

A simple Laravel service provider which adds a new queue connector to handle SNS subscription queues.

AWS SQS SNS Subscription Queue

A simple extension to the Illuminate/Queue queue system used in Laravel and Lumen., _(*1)

Using this connector allows SQS messages originating from a SNS subscription to be worked on with Illuminate\Queue\Jobs\SqsJob., _(*2)

This is especially useful in a miroservice architecture where multiple services subscribe to a common topic with their queues., _(*3)

Understand that this package will not handle publishing to SNS, please use the AWS SDK to publish an event to SNS., _(*4)

Requirements

• Laravel (tested with version 5.3)
• or Lumen (tested with version 5.3)

Usage

Add the LaravelSqsSnsSubscriptionQueue ServiceProvider to your application., _(*5)

Laravel

Registering Service Providers in Laravel, _(*6)

'providers' => [
    // ...
    Joblocal\LaravelSqsSnsSubscriptionQueue\SqsSnsServiceProvider::class,
],

Lumen

Registering Service Providers in Lumen, _(*7)

$app->register(Joblocal\LaravelSqsSnsSubscriptionQueue\SqsSnsServiceProvider::class);

Configuration

You'll need to configure the queue connection in your config/queue.php, _(*8)

'connections' => [
  'sqs-sns' => [
    'driver' => 'sqs-sns',
    'key'    => env('AWS_ACCESS_KEY', 'your-public-key'),
    'secret' => env('AWS_SECRET_ACCESS_KEY', 'your-secret-key'),
    'queue'  => env('QUEUE_URL', 'your-queue-url'),
    'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
    'routes' => [
        // you can use the "Subject" field
        'Subject' => 'App\\Jobs\\YourJob',
        // or the "TopicArn" of your SQS message
        'TopicArn:123' => 'App\\Jobs\\YourJob',
        // to specify which job class should handle the job
    ],
  ],
],

Once the sqs-sns queue connector is configured you can start using it by setting queue driver to 'sqs-sns' in your .env file., _(*9)

Job class example

use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;

/**
 * Example Job class
 */
class Job implements ShouldQueue
{
  use InteractsWithQueue, Queueable, SerializesModels;

  /**
   * @param string  $subject   SNS Subject
   * @param array   $payload   JSON decoded 'Message'
   */
  public function __construct(string $subject, array $payload)
  {
  }
}

Message transformation

When SNS publishes to SQS queues the received message signature is as follows:, _(*10)

{
  "Type" : "Notification",
  "MessageId" : "63a3f6b6-d533-4a47-aef9-fcf5cf758c76",
  "TopicArn" : "arn:aws:sns:us-west-2:123456789012:MyTopic",
  "Subject" : "Testing publish to subscribed queues",
  "Message" : "Hello world!",
  "Timestamp" : "2017-03-29T05:12:16.901Z",
  "SignatureVersion" : "1",
  "Signature" : "...",
  "SigningCertURL" : "...",
  "UnsubscribeURL" : "..."
} 

Illuminate\Queue\Jobs\SqsJob requires the following signature:, _(*11)

{
  "job": "Illuminate\\Queue\\CallQueuedHandler@call",
  "data": {
    "commandName": "App\\Jobs\\YourJob",
    "command": "...",
  }
}

Installation

The best way to install laravel-sqs-sns-subscription is by using Composer., _(*12)

To install the most recent version:, _(*13)

php composer.phar require joblocal/laravel-sqs-sns-subscription-queue