simplesoftwareio / simple-sqs-extended-client
Simple SQS Extended Client is a SQS driver for Laravel that supports extended payloads beyond 256kb.
Installs: 190 908
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 3
Forks: 9
Open Issues: 1
Requires
- php: >=8.0
- aws/aws-sdk-php: ^3.189.0
- illuminate/container: ~9|~10
- illuminate/contracts: ~9|~10
- illuminate/filesystem: ~9|~10
- illuminate/queue: ~9|~10
- illuminate/support: ~9|~10
- league/flysystem: ~3
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.2
- mockery/mockery: ~1
- phpunit/phpunit: ~10
Suggests
- laravel/vapor-core: Allows SQS disk based storage while using Laravel Vapor.
README
The package has been moved to https://github.com/DefectiveCode/laravel-sqs-extended. Please read the migration guide and update your project accordingly.
Introduction
Simple SQS Extended Client is a Laravel queue driver that was designed to work around the AWS SQS 256KB payload size limits. This queue driver will automatically serialize large payloads to a disk (typically S3) and then unserialize them at run time.
Support
You may request professional support by emailing support@simplesoftware.io. All requests for support require a $200 / hour fee. All other support will be provided by the open source community.
Install
- First create a disk that will hold all of your large SQS payloads.
We highly recommend you use a private bucket when storing SQS payloads. Payloads can contain sensitive information and should never be shared publicly.
-
Run
composer require simplesoftwareio/simple-sqs-extended-client "~1"
to install the queue driver. -
Then, add the following default queue settings to your
queue.php
file.
Laravel Vapor users must set the connection name set to
sqs
. Thesqs
connection is looked for within Vapor Core and this library will not work as expected if you use a different connection name.
/*
|--------------------------------------------------------------------------
| SQS Disk Queue Configuration
|--------------------------------------------------------------------------
|
| Here you may configure the SQS disk queue driver. It shares all of the same
| configuration options from the built in Laravel SQS queue driver. The only added
| option is `disk_options` which are explained below.
|
| always_store: Determines if all payloads should be stored on a disk regardless if they are over SQS's 256KB limit.
| cleanup: Determines if the payload files should be removed from the disk once the job is processed. Leaveing the
| files behind can be useful to replay the queue jobs later for debugging reasons.
| disk: The disk to save SQS payloads to. This disk should be configured in your Laravel filesystems.php config file.
| prefix The prefix (folder) to store the payloads with. This is useful if you are sharing a disk with other SQS queues.
| Using a prefix allows for the queue:clear command to destroy the files separately from other sqs-disk backed queues
| sharing the same disk.
|
*/
'sqs' => [
'driver' => 'sqs-disk',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'prefix' => env('SQS_PREFIX', 'https://sqs.us-east-1.amazonaws.com/your-account-id'),
'queue' => env('SQS_QUEUE', 'default'),
'suffix' => env('SQS_SUFFIX'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
'after_commit' => false,
'disk_options' => [
'always_store' => false,
'cleanup' => false,
'disk' => env('SQS_DISK'),
'prefix' => 'bucket-prefix',
],
],
- Boot up your queues and profit without having to worry about SQS's 256KB limit :)