README

Description

Yii3 Queue Adapter for AWS SQS is new adapter in Yii3 Queue Adapters family.

Implementation of adapter is based on enqueue/sqs library.

Requirements

PHP 8.2 or higher.

Installation

The package could be installed with composer:

composer require g41797/queue-sqs

General usage

As part of Yii3 Queue Framework
Stand-alone

Configuration

Default configuration:

[
     'key' => null,                 // AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
     'secret' => null,              // AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
     'token' => null,               // AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
     'region' => us-east-1,         // (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
     'retries' => 3,                // (int, default=int(3)) Configures the maximum number of allowed retries for a client (pass 0 to disable retries).
     'version' => 'latest',         // (string, required) The version of the webservice to utilize
     'profile' => null,             // (string, default=null) The name of an AWS profile to used, if provided the SDK will attempt to read associated credentials from the ~/.aws/credentials file.
     'queue_owner_aws_account_id'   // The AWS account ID of the account that created the queue.
]

Yandex Message Queue

According to Yandex blog:

"...we decided not to invent a unique interface for Yandex Message Queue,
but implement support for the AWS SQS API, and very carefully."

It means that queue-sqs supports Yandex Message Queue, but this use case was not tested.

LocalStack usage

LocalStack allows "...develop and test your AWS applications locally to reduce development time...".

Development and testing of queue-sqs were done using LocalStack.

Credentials

LocalStack does not require AWS credentials. Functional tests use following credentials:

[
    'key' => 'anyKey',
    'secret' => 'noSecrets',
]

Endpoint

AWS SDK for PHP automatically builds required SQS endpoint.

Under LocalStack "hard-coded" endpoint is saved in phpunit configuration file:

    <php>
        <ini name="error_reporting" value="-1"/>
        <env name="ENDPOINT" value="http://localhost.localstack.cloud:4566" force="true" />
    </php>

queue-sqs checks existence of ENDPOINT and initiates AWS library accordingly.

Auth Token

Auth Token is used for authentication and to retrieve your LocalStack license.

You can see example in startup script

export LOCALSTACK_AUTH_TOKEN="ls-KESiVaLi-4697-7857-MEna-ziqIXeSaf962"

Replace this token with your one.

Limitations

Job Status

// Push a job into the queue and get a message ID.
$id = $queue->push(new SomeJob());

// Get job status.
$status = $queue->status($id);

is not supported.

SQS limitations

A lot of information you can find in Amazon SQS FAQs

Channel Name

Length limited to 75 chars
Contains only alphanumeric characters, hyphens (-), and underscores (_)

Cross region/account communication

Cross region/account communications are not supported.

Long polling

Worker uses polling timeout for retrieving messages(jobs) from SQS. Because customer pays for every receive, it's recommended to use long value for this timeout. Maximal value is 20 sec, this value is used also for zero timeout.

More information see Amazon SQS short and long polling

License

Yii3 Queue Adapter for AWS SQS is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

g41797 / queue-sqs

Maintainers

Details